1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
#!/usr/bin/env python3
# Copyright 2019 The ChromiumOS Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Unit tests for retrieving the LLVM hash."""
import contextlib
from pathlib import Path
import shutil
import subprocess
import tempfile
import textwrap
import unittest
from unittest import mock
import get_llvm_hash
import llvm_next
import subprocess_helpers
# We grab protected stuff from get_llvm_hash. That's OK.
# pylint: disable=protected-access
def mock_run_results(returncode: int, stderr: bytes) -> mock.MagicMock:
m = mock.MagicMock()
m.returncode = returncode
m.stderr = stderr
return m
class TestGetLLVMHash(unittest.TestCase):
"""The LLVMHash test class."""
def make_tempdir(self):
d = Path(tempfile.mkdtemp(prefix="get_llvm_hash_unittest_"))
self.addCleanup(shutil.rmtree, d)
return d
def setUp(self):
# We mock out quite a bit. Ensure every test is self-contained.
get_llvm_hash.GetLLVMMajorVersion.cache_clear()
@mock.patch.object(subprocess, "run")
def testCloneRepoSucceedsWhenGitSucceeds(self, run_mock):
run_mock.return_value = mock_run_results(returncode=0, stderr=b"")
llvm_hash = get_llvm_hash.LLVMHash()
into_tempdir = "/tmp/tmpTest"
llvm_hash.CloneLLVMRepo(into_tempdir)
run_mock.assert_called_with(
["git", "clone", get_llvm_hash._LLVM_GIT_URL, into_tempdir],
check=False,
stderr=subprocess.PIPE,
)
@mock.patch.object(subprocess, "run")
def testCloneRepoFailsWhenGitFails(self, run_mock):
run_mock.return_value = mock_run_results(
returncode=1, stderr=b"some stderr"
)
with self.assertRaisesRegex(ValueError, "Failed to clone.*some stderr"):
get_llvm_hash.LLVMHash().CloneLLVMRepo("/tmp/tmp1")
@mock.patch.object(get_llvm_hash, "GetGitHashFrom")
def testGetGitHashWorks(self, mock_get_git_hash):
mock_get_git_hash.return_value = "a13testhash2"
self.assertEqual(
get_llvm_hash.GetGitHashFrom("/tmp/tmpTest", 100), "a13testhash2"
)
mock_get_git_hash.assert_called_once()
@mock.patch.object(get_llvm_hash.LLVMHash, "GetLLVMHash")
@mock.patch.object(get_llvm_hash, "GetGoogle3LLVMVersion")
def testReturnGoogle3LLVMHash(
self, mock_google3_llvm_version, mock_get_llvm_hash
):
mock_get_llvm_hash.return_value = "a13testhash3"
mock_google3_llvm_version.return_value = 1000
self.assertEqual(
get_llvm_hash.LLVMHash().GetGoogle3LLVMHash(), "a13testhash3"
)
mock_get_llvm_hash.assert_called_once_with(1000)
@mock.patch.object(get_llvm_hash.LLVMHash, "GetLLVMHash")
@mock.patch.object(get_llvm_hash, "GetGoogle3LLVMVersion")
def testReturnGoogle3UnstableLLVMHash(
self, mock_google3_llvm_version, mock_get_llvm_hash
):
mock_get_llvm_hash.return_value = "a13testhash3"
mock_google3_llvm_version.return_value = 1000
self.assertEqual(
get_llvm_hash.LLVMHash().GetGoogle3UnstableLLVMHash(),
"a13testhash3",
)
mock_get_llvm_hash.assert_called_once_with(1000)
@mock.patch.object(subprocess, "check_output")
def testSuccessfullyGetGitHashFromToTOfLLVM(self, mock_check_output):
mock_check_output.return_value = "a123testhash1 path/to/main\n"
self.assertEqual(
get_llvm_hash.LLVMHash().GetTopOfTrunkGitHash(), "a123testhash1"
)
mock_check_output.assert_called_once()
@mock.patch.object(subprocess, "Popen")
def testCheckoutBranch(self, mock_popen):
mock_popen.return_value = contextlib.nullcontext(
mock.MagicMock(communicate=lambda: (None, None), returncode=0)
)
get_llvm_hash.CheckoutBranch("fake/src_dir", "fake_branch")
self.assertEqual(
mock_popen.call_args_list[0][0],
(["git", "-C", "fake/src_dir", "checkout", "fake_branch"],),
)
self.assertEqual(
mock_popen.call_args_list[1][0],
(["git", "-C", "fake/src_dir", "pull"],),
)
def testParseLLVMMajorVersion(self):
cmakelist_42 = (
"set(CMAKE_BUILD_WITH_INSTALL_NAME_DIR ON)\n"
"if(NOT DEFINED LLVM_VERSION_MAJOR)\n"
" set(LLVM_VERSION_MAJOR 42)\n"
"endif()"
)
self.assertEqual(
get_llvm_hash.ParseLLVMMajorVersion(cmakelist_42), "42"
)
def testParseLLVMMajorVersionInvalid(self):
invalid_cmakelist = "invalid cmakelist.txt contents"
self.assertIsNone(
get_llvm_hash.ParseLLVMMajorVersion(invalid_cmakelist)
)
@mock.patch.object(get_llvm_hash, "GetAndUpdateLLVMProjectInLLVMTools")
@mock.patch.object(subprocess_helpers, "CheckCommand")
def testGetLLVMMajorVersionWithOldPath(
self,
_mock_check_command,
mock_update_project,
):
src_dir = self.make_tempdir()
mock_update_project.return_value = str(src_dir)
cmakelists = Path(src_dir) / "llvm" / "CMakeLists.txt"
cmakelists.parent.mkdir(parents=True)
cmakelists.write_text(
textwrap.dedent(
"""
if(NOT DEFINED LLVM_VERSION_MAJOR)
set(LLVM_VERSION_MAJOR 12345)
endif()
"""
),
encoding="utf-8",
)
self.assertEqual(get_llvm_hash.GetLLVMMajorVersion(), "12345")
@mock.patch.object(get_llvm_hash, "GetAndUpdateLLVMProjectInLLVMTools")
@mock.patch.object(subprocess_helpers, "CheckCommand")
def testGetLLVMMajorVersionWithNewPath(
self,
_mock_check_command,
mock_update_project,
):
src_dir = self.make_tempdir()
mock_update_project.return_value = str(src_dir)
old_cmakelists = Path(src_dir) / "llvm" / "CMakeLists.txt"
old_cmakelists.parent.mkdir(parents=True)
old_cmakelists.write_text(
textwrap.dedent(
"""
Some text
that has
nothing to do with
LLVM_VERSION_MAJOR
"""
),
encoding="utf-8",
)
new_cmakelists = (
Path(src_dir) / "cmake" / "Modules" / "LLVMVersion.cmake"
)
new_cmakelists.parent.mkdir(parents=True)
new_cmakelists.write_text(
textwrap.dedent(
"""
if(NOT DEFINED LLVM_VERSION_MAJOR)
set(LLVM_VERSION_MAJOR 5432)
endif()
"""
),
encoding="utf-8",
)
self.assertEqual(get_llvm_hash.GetLLVMMajorVersion(), "5432")
def testGetLLVMNextHash(self):
self.assertEqual(
get_llvm_hash.LLVMHash().GetCrOSLLVMNextHash(),
llvm_next.LLVM_NEXT_HASH,
)
if __name__ == "__main__":
unittest.main()
|
