Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1#!/usr/bin/env python3
2# SPDX-License-Identifier: GPL-2.0
3
4"""Tests the `rust_is_available.sh` script.
5
6Some of the tests require the real programs to be available in `$PATH`
7under their canonical name (and with the expected versions).
8"""
9
10import enum
11import os
12import pathlib
13import stat
14import subprocess
15import tempfile
16import unittest
17
18class TestRustIsAvailable(unittest.TestCase):
19 @enum.unique
20 class Expected(enum.Enum):
21 SUCCESS = enum.auto()
22 SUCCESS_WITH_WARNINGS = enum.auto()
23 SUCCESS_WITH_EXTRA_OUTPUT = enum.auto()
24 FAILURE = enum.auto()
25
26 @classmethod
27 def generate_executable(cls, content):
28 path = pathlib.Path(cls.tempdir.name)
29 name = str(len(tuple(path.iterdir())))
30 path = path / name
31 with open(path, "w") as file_:
32 file_.write(content)
33 os.chmod(path, os.stat(path).st_mode | stat.S_IXUSR)
34 return path
35
36 @classmethod
37 def generate_clang(cls, stdout):
38 return cls.generate_executable(f"""#!/usr/bin/env python3
39import sys
40if "-E" in " ".join(sys.argv):
41 print({repr("Clang " + " ".join(cls.llvm_default_version.split(" ")))})
42else:
43 print({repr(stdout)})
44""")
45
46 @classmethod
47 def generate_rustc(cls, stdout):
48 return cls.generate_executable(f"""#!/usr/bin/env python3
49import sys
50if "--print sysroot" in " ".join(sys.argv):
51 print({repr(cls.rust_default_sysroot)})
52else:
53 print({repr(stdout)})
54""")
55
56 @classmethod
57 def generate_bindgen(cls, version_stdout, libclang_stderr):
58 if libclang_stderr is None:
59 libclang_case = f"raise SystemExit({cls.bindgen_default_bindgen_libclang_failure_exit_code})"
60 else:
61 libclang_case = f"print({repr(libclang_stderr)}, file=sys.stderr)"
62
63 return cls.generate_executable(f"""#!/usr/bin/env python3
64import sys
65if "rust_is_available_bindgen_libclang.h" in " ".join(sys.argv):
66 {libclang_case}
67else:
68 print({repr(version_stdout)})
69""")
70
71 @classmethod
72 def generate_bindgen_version(cls, stdout):
73 return cls.generate_bindgen(stdout, cls.bindgen_default_bindgen_libclang_stderr)
74
75 @classmethod
76 def generate_bindgen_libclang_failure(cls):
77 return cls.generate_bindgen(cls.bindgen_default_bindgen_version_stdout, None)
78
79 @classmethod
80 def generate_bindgen_libclang(cls, stderr):
81 return cls.generate_bindgen(cls.bindgen_default_bindgen_version_stdout, stderr)
82
83 @classmethod
84 def setUpClass(cls):
85 cls.tempdir = tempfile.TemporaryDirectory()
86
87 cls.missing = pathlib.Path(cls.tempdir.name) / "missing"
88
89 cls.nonexecutable = pathlib.Path(cls.tempdir.name) / "nonexecutable"
90 with open(cls.nonexecutable, "w") as file_:
91 file_.write("nonexecutable")
92
93 cls.unexpected_binary = "true"
94
95 cls.rustc_default_version = subprocess.check_output(("scripts/min-tool-version.sh", "rustc")).decode().strip()
96 cls.bindgen_default_version = subprocess.check_output(("scripts/min-tool-version.sh", "bindgen")).decode().strip()
97 cls.llvm_default_version = subprocess.check_output(("scripts/min-tool-version.sh", "llvm")).decode().strip()
98 cls.rust_default_sysroot = subprocess.check_output(("rustc", "--print", "sysroot")).decode().strip()
99
100 cls.bindgen_default_bindgen_version_stdout = f"bindgen {cls.bindgen_default_version}"
101 cls.bindgen_default_bindgen_libclang_failure_exit_code = 42
102 cls.bindgen_default_bindgen_libclang_stderr = f"scripts/rust_is_available_bindgen_libclang.h:2:9: warning: clang version {cls.llvm_default_version} [-W#pragma-messages], err: false"
103
104 cls.default_rustc = cls.generate_rustc(f"rustc {cls.rustc_default_version}")
105 cls.default_bindgen = cls.generate_bindgen(cls.bindgen_default_bindgen_version_stdout, cls.bindgen_default_bindgen_libclang_stderr)
106 cls.default_cc = cls.generate_clang(f"clang version {cls.llvm_default_version}")
107
108 def run_script(self, expected, override_env):
109 env = {
110 "RUSTC": self.default_rustc,
111 "BINDGEN": self.default_bindgen,
112 "CC": self.default_cc,
113 }
114
115 for key, value in override_env.items():
116 if value is None:
117 del env[key]
118 continue
119 env[key] = value
120
121 result = subprocess.run("scripts/rust_is_available.sh", env=env, capture_output=True)
122
123 # The script should never output anything to `stdout`.
124 self.assertEqual(result.stdout, b"")
125
126 if expected == self.Expected.SUCCESS:
127 # When expecting a success, the script should return 0
128 # and it should not output anything to `stderr`.
129 self.assertEqual(result.returncode, 0)
130 self.assertEqual(result.stderr, b"")
131 elif expected == self.Expected.SUCCESS_WITH_EXTRA_OUTPUT:
132 # When expecting a success with extra output (that is not warnings,
133 # which is the common case), the script should return 0 and it
134 # should output at least something to `stderr` (the output should
135 # be checked further by the test).
136 self.assertEqual(result.returncode, 0)
137 self.assertNotEqual(result.stderr, b"")
138 elif expected == self.Expected.SUCCESS_WITH_WARNINGS:
139 # When expecting a success with warnings, the script should return 0
140 # and it should output at least the instructions to `stderr`.
141 self.assertEqual(result.returncode, 0)
142 self.assertIn(b"Please see Documentation/rust/quick-start.rst for details", result.stderr)
143 else:
144 # When expecting a failure, the script should return non-0
145 # and it should output at least the instructions to `stderr`.
146 self.assertNotEqual(result.returncode, 0)
147 self.assertIn(b"Please see Documentation/rust/quick-start.rst for details", result.stderr)
148
149 # The output will generally be UTF-8 (i.e. unless the user has
150 # put strange values in the environment).
151 result.stderr = result.stderr.decode()
152
153 return result
154
155 def test_rustc_unset(self):
156 result = self.run_script(self.Expected.FAILURE, { "RUSTC": None })
157 self.assertIn("Environment variable 'RUSTC' is not set.", result.stderr)
158 self.assertIn("This script is intended to be called from Kbuild.", result.stderr)
159
160 def test_bindgen_unset(self):
161 result = self.run_script(self.Expected.FAILURE, { "BINDGEN": None })
162 self.assertIn("Environment variable 'BINDGEN' is not set.", result.stderr)
163 self.assertIn("This script is intended to be called from Kbuild.", result.stderr)
164
165 def test_cc_unset(self):
166 result = self.run_script(self.Expected.FAILURE, { "CC": None })
167 self.assertIn("Environment variable 'CC' is not set.", result.stderr)
168 self.assertIn("This script is intended to be called from Kbuild.", result.stderr)
169
170 def test_rustc_missing(self):
171 result = self.run_script(self.Expected.FAILURE, { "RUSTC": self.missing })
172 self.assertIn(f"Rust compiler '{self.missing}' could not be found.", result.stderr)
173
174 def test_bindgen_missing(self):
175 result = self.run_script(self.Expected.FAILURE, { "BINDGEN": self.missing })
176 self.assertIn(f"Rust bindings generator '{self.missing}' could not be found.", result.stderr)
177
178 def test_rustc_nonexecutable(self):
179 result = self.run_script(self.Expected.FAILURE, { "RUSTC": self.nonexecutable })
180 self.assertIn(f"Running '{self.nonexecutable}' to check the Rust compiler version failed with", result.stderr)
181
182 def test_rustc_unexpected_binary(self):
183 result = self.run_script(self.Expected.FAILURE, { "RUSTC": self.unexpected_binary })
184 self.assertIn(f"Running '{self.unexpected_binary}' to check the Rust compiler version did not return", result.stderr)
185
186 def test_rustc_unexpected_name(self):
187 rustc = self.generate_rustc(f"unexpected {self.rustc_default_version} (a8314ef7d 2022-06-27)")
188 result = self.run_script(self.Expected.FAILURE, { "RUSTC": rustc })
189 self.assertIn(f"Running '{rustc}' to check the Rust compiler version did not return", result.stderr)
190
191 def test_rustc_unexpected_version(self):
192 rustc = self.generate_rustc("rustc unexpected (a8314ef7d 2022-06-27)")
193 result = self.run_script(self.Expected.FAILURE, { "RUSTC": rustc })
194 self.assertIn(f"Running '{rustc}' to check the Rust compiler version did not return", result.stderr)
195
196 def test_rustc_no_minor(self):
197 rustc = self.generate_rustc(f"rustc {'.'.join(self.rustc_default_version.split('.')[:2])} (a8314ef7d 2022-06-27)")
198 result = self.run_script(self.Expected.FAILURE, { "RUSTC": rustc })
199 self.assertIn(f"Running '{rustc}' to check the Rust compiler version did not return", result.stderr)
200
201 def test_rustc_old_version(self):
202 rustc = self.generate_rustc("rustc 1.60.0 (a8314ef7d 2022-06-27)")
203 result = self.run_script(self.Expected.FAILURE, { "RUSTC": rustc })
204 self.assertIn(f"Rust compiler '{rustc}' is too old.", result.stderr)
205
206 def test_bindgen_nonexecutable(self):
207 result = self.run_script(self.Expected.FAILURE, { "BINDGEN": self.nonexecutable })
208 self.assertIn(f"Running '{self.nonexecutable}' to check the Rust bindings generator version failed with", result.stderr)
209
210 def test_bindgen_unexpected_binary(self):
211 result = self.run_script(self.Expected.FAILURE, { "BINDGEN": self.unexpected_binary })
212 self.assertIn(f"Running '{self.unexpected_binary}' to check the bindings generator version did not return", result.stderr)
213
214 def test_bindgen_unexpected_name(self):
215 bindgen = self.generate_bindgen_version(f"unexpected {self.bindgen_default_version}")
216 result = self.run_script(self.Expected.FAILURE, { "BINDGEN": bindgen })
217 self.assertIn(f"Running '{bindgen}' to check the bindings generator version did not return", result.stderr)
218
219 def test_bindgen_unexpected_version(self):
220 bindgen = self.generate_bindgen_version("bindgen unexpected")
221 result = self.run_script(self.Expected.FAILURE, { "BINDGEN": bindgen })
222 self.assertIn(f"Running '{bindgen}' to check the bindings generator version did not return", result.stderr)
223
224 def test_bindgen_no_minor(self):
225 bindgen = self.generate_bindgen_version(f"bindgen {'.'.join(self.bindgen_default_version.split('.')[:2])}")
226 result = self.run_script(self.Expected.FAILURE, { "BINDGEN": bindgen })
227 self.assertIn(f"Running '{bindgen}' to check the bindings generator version did not return", result.stderr)
228
229 def test_bindgen_old_version(self):
230 bindgen = self.generate_bindgen_version("bindgen 0.50.0")
231 result = self.run_script(self.Expected.FAILURE, { "BINDGEN": bindgen })
232 self.assertIn(f"Rust bindings generator '{bindgen}' is too old.", result.stderr)
233
234 def test_bindgen_libclang_failure(self):
235 bindgen = self.generate_bindgen_libclang_failure()
236 result = self.run_script(self.Expected.FAILURE, { "BINDGEN": bindgen })
237 self.assertIn(f"Running '{bindgen}' to check the libclang version (used by the Rust", result.stderr)
238 self.assertIn(f"bindings generator) failed with code {self.bindgen_default_bindgen_libclang_failure_exit_code}. This may be caused by", result.stderr)
239
240 def test_bindgen_libclang_unexpected_version(self):
241 bindgen = self.generate_bindgen_libclang("scripts/rust_is_available_bindgen_libclang.h:2:9: warning: clang version unexpected [-W#pragma-messages], err: false")
242 result = self.run_script(self.Expected.FAILURE, { "BINDGEN": bindgen })
243 self.assertIn(f"Running '{bindgen}' to check the libclang version (used by the Rust", result.stderr)
244 self.assertIn("bindings generator) did not return an expected output. See output", result.stderr)
245
246 def test_bindgen_libclang_old_version(self):
247 bindgen = self.generate_bindgen_libclang("scripts/rust_is_available_bindgen_libclang.h:2:9: warning: clang version 10.0.0 [-W#pragma-messages], err: false")
248 result = self.run_script(self.Expected.FAILURE, { "BINDGEN": bindgen })
249 self.assertIn(f"libclang (used by the Rust bindings generator '{bindgen}') is too old.", result.stderr)
250
251 def test_clang_matches_bindgen_libclang_different_bindgen(self):
252 bindgen = self.generate_bindgen_libclang("scripts/rust_is_available_bindgen_libclang.h:2:9: warning: clang version 999.0.0 [-W#pragma-messages], err: false")
253 result = self.run_script(self.Expected.SUCCESS_WITH_WARNINGS, { "BINDGEN": bindgen })
254 self.assertIn("version does not match Clang's. This may be a problem.", result.stderr)
255
256 def test_clang_matches_bindgen_libclang_different_clang(self):
257 cc = self.generate_clang("clang version 999.0.0")
258 result = self.run_script(self.Expected.SUCCESS_WITH_WARNINGS, { "CC": cc })
259 self.assertIn("version does not match Clang's. This may be a problem.", result.stderr)
260
261 def test_rustc_src_core_krustflags(self):
262 result = self.run_script(self.Expected.FAILURE, { "PATH": os.environ["PATH"], "RUSTC": "rustc", "KRUSTFLAGS": f"--sysroot={self.missing}" })
263 self.assertIn("Source code for the 'core' standard library could not be found", result.stderr)
264
265 def test_rustc_src_core_rustlibsrc(self):
266 result = self.run_script(self.Expected.FAILURE, { "RUST_LIB_SRC": self.missing })
267 self.assertIn("Source code for the 'core' standard library could not be found", result.stderr)
268
269 def test_success_cc_unknown(self):
270 result = self.run_script(self.Expected.SUCCESS_WITH_EXTRA_OUTPUT, { "CC": self.missing })
271 self.assertIn("unknown C compiler", result.stderr)
272
273 def test_success_cc_multiple_arguments_ccache(self):
274 clang = self.generate_clang(f"""Ubuntu clang version {self.llvm_default_version}-1ubuntu1
275Target: x86_64-pc-linux-gnu
276Thread model: posix
277InstalledDir: /usr/bin
278""")
279 result = self.run_script(self.Expected.SUCCESS, { "CC": f"{clang} clang" })
280
281 def test_success_rustc_version(self):
282 for rustc_stdout in (
283 f"rustc {self.rustc_default_version} (a8314ef7d 2022-06-27)",
284 f"rustc {self.rustc_default_version}-dev (a8314ef7d 2022-06-27)",
285 f"rustc {self.rustc_default_version}-1.60.0 (a8314ef7d 2022-06-27)",
286 ):
287 with self.subTest(rustc_stdout=rustc_stdout):
288 rustc = self.generate_rustc(rustc_stdout)
289 result = self.run_script(self.Expected.SUCCESS, { "RUSTC": rustc })
290
291 def test_success_bindgen_version(self):
292 for bindgen_stdout in (
293 f"bindgen {self.bindgen_default_version}",
294 f"bindgen {self.bindgen_default_version}-dev",
295 f"bindgen {self.bindgen_default_version}-0.999.0",
296 ):
297 with self.subTest(bindgen_stdout=bindgen_stdout):
298 bindgen = self.generate_bindgen_version(bindgen_stdout)
299 result = self.run_script(self.Expected.SUCCESS, { "BINDGEN": bindgen })
300
301 def test_success_bindgen_libclang(self):
302 for stderr in (
303 f"scripts/rust_is_available_bindgen_libclang.h:2:9: warning: clang version {self.llvm_default_version} (https://github.com/llvm/llvm-project.git 4a2c05b05ed07f1f620e94f6524a8b4b2760a0b1) [-W#pragma-messages], err: false",
304 f"/home/jd/Documents/dev/kernel-module-flake/linux-6.1/outputs/dev/lib/modules/6.1.0-development/source/scripts/rust_is_available_bindgen_libclang.h:2:9: warning: clang version {self.llvm_default_version} [-W#pragma-messages], err: false",
305 f"scripts/rust_is_available_bindgen_libclang.h:2:9: warning: clang version {self.llvm_default_version} (Fedora 13.0.0-3.fc35) [-W#pragma-messages], err: false",
306 f"""
307/nix/store/dsd5gz46hdbdk2rfdimqddhq6m8m8fqs-bash-5.1-p16/bin/bash: warning: setlocale: LC_ALL: cannot change locale (c)
308scripts/rust_is_available_bindgen_libclang.h:2:9: warning: clang version {self.llvm_default_version} [-W#pragma-messages], err: false
309""",
310 f"""
311/nix/store/dsd5gz46hdbdk2rfdimqddhq6m8m8fqs-bash-5.1.0-p16/bin/bash: warning: setlocale: LC_ALL: cannot change locale (c)
312/home/jd/Documents/dev/kernel-module-flake/linux-6.1/outputs/dev/lib/modules/6.1.0-development/source/scripts/rust_is_available_bindgen_libclang.h:2:9: warning: clang version {self.llvm_default_version} (Fedora 13.0.0-3.fc35) [-W#pragma-messages], err: false
313"""
314 ):
315 with self.subTest(stderr=stderr):
316 bindgen = self.generate_bindgen_libclang(stderr)
317 result = self.run_script(self.Expected.SUCCESS, { "BINDGEN": bindgen })
318
319 def test_success_clang_version(self):
320 for clang_stdout in (
321 f"clang version {self.llvm_default_version} (https://github.com/llvm/llvm-project.git 4a2c05b05ed07f1f620e94f6524a8b4b2760a0b1)",
322 f"clang version {self.llvm_default_version}-dev",
323 f"clang version {self.llvm_default_version}-2~ubuntu20.04.1",
324 f"Ubuntu clang version {self.llvm_default_version}-2~ubuntu20.04.1",
325 ):
326 with self.subTest(clang_stdout=clang_stdout):
327 clang = self.generate_clang(clang_stdout)
328 result = self.run_script(self.Expected.SUCCESS, { "CC": clang })
329
330 def test_success_real_programs(self):
331 for cc in ["gcc", "clang"]:
332 with self.subTest(cc=cc):
333 result = self.run_script(self.Expected.SUCCESS, {
334 "PATH": os.environ["PATH"],
335 "RUSTC": "rustc",
336 "BINDGEN": "bindgen",
337 "CC": cc,
338 })
339
340if __name__ == "__main__":
341 unittest.main()