2 # SPDX-License-Identifier: GPL-2.0
4 # A collection of tests for tools/testing/kunit/kunit.py
6 # Copyright (C) 2019, Google LLC.
7 # Author: Brendan Higgins <brendanhiggins@google.com>
10 from unittest import mock
12 import tempfile, shutil # Handling test_tmpdir
25 abs_test_data_dir = ''
28 global test_tmpdir, abs_test_data_dir
29 test_tmpdir = tempfile.mkdtemp()
30 abs_test_data_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), 'test_data'))
33 shutil.rmtree(test_tmpdir)
35 def test_data_path(path):
36 return os.path.join(abs_test_data_dir, path)
38 class KconfigTest(unittest.TestCase):
40 def test_is_subset_of(self):
41 kconfig0 = kunit_config.Kconfig()
42 self.assertTrue(kconfig0.is_subset_of(kconfig0))
44 kconfig1 = kunit_config.Kconfig()
45 kconfig1.add_entry(kunit_config.KconfigEntry('TEST', 'y'))
46 self.assertTrue(kconfig1.is_subset_of(kconfig1))
47 self.assertTrue(kconfig0.is_subset_of(kconfig1))
48 self.assertFalse(kconfig1.is_subset_of(kconfig0))
50 def test_read_from_file(self):
51 kconfig = kunit_config.Kconfig()
52 kconfig_path = test_data_path('test_read_from_file.kconfig')
54 kconfig.read_from_file(kconfig_path)
56 expected_kconfig = kunit_config.Kconfig()
57 expected_kconfig.add_entry(
58 kunit_config.KconfigEntry('UML', 'y'))
59 expected_kconfig.add_entry(
60 kunit_config.KconfigEntry('MMU', 'y'))
61 expected_kconfig.add_entry(
62 kunit_config.KconfigEntry('TEST', 'y'))
63 expected_kconfig.add_entry(
64 kunit_config.KconfigEntry('EXAMPLE_TEST', 'y'))
65 expected_kconfig.add_entry(
66 kunit_config.KconfigEntry('MK8', 'n'))
68 self.assertEqual(kconfig.entries(), expected_kconfig.entries())
70 def test_write_to_file(self):
71 kconfig_path = os.path.join(test_tmpdir, '.config')
73 expected_kconfig = kunit_config.Kconfig()
74 expected_kconfig.add_entry(
75 kunit_config.KconfigEntry('UML', 'y'))
76 expected_kconfig.add_entry(
77 kunit_config.KconfigEntry('MMU', 'y'))
78 expected_kconfig.add_entry(
79 kunit_config.KconfigEntry('TEST', 'y'))
80 expected_kconfig.add_entry(
81 kunit_config.KconfigEntry('EXAMPLE_TEST', 'y'))
82 expected_kconfig.add_entry(
83 kunit_config.KconfigEntry('MK8', 'n'))
85 expected_kconfig.write_to_file(kconfig_path)
87 actual_kconfig = kunit_config.Kconfig()
88 actual_kconfig.read_from_file(kconfig_path)
90 self.assertEqual(actual_kconfig.entries(),
91 expected_kconfig.entries())
93 class KUnitParserTest(unittest.TestCase):
95 def assertContains(self, needle, haystack):
99 raise AssertionError('"' +
100 str(needle) + '" not found in "' + str(haystack) + '"!')
102 def test_output_isolated_correctly(self):
103 log_path = test_data_path('test_output_isolated_correctly.log')
104 with open(log_path) as file:
105 result = kunit_parser.isolate_kunit_output(file.readlines())
106 self.assertContains('TAP version 14', result)
107 self.assertContains(' # Subtest: example', result)
108 self.assertContains(' 1..2', result)
109 self.assertContains(' ok 1 - example_simple_test', result)
110 self.assertContains(' ok 2 - example_mock_test', result)
111 self.assertContains('ok 1 - example', result)
113 def test_output_with_prefix_isolated_correctly(self):
114 log_path = test_data_path('test_pound_sign.log')
115 with open(log_path) as file:
116 result = kunit_parser.isolate_kunit_output(file.readlines())
117 self.assertContains('TAP version 14', result)
118 self.assertContains(' # Subtest: kunit-resource-test', result)
119 self.assertContains(' 1..5', result)
120 self.assertContains(' ok 1 - kunit_resource_test_init_resources', result)
121 self.assertContains(' ok 2 - kunit_resource_test_alloc_resource', result)
122 self.assertContains(' ok 3 - kunit_resource_test_destroy_resource', result)
123 self.assertContains(' foo bar #', result)
124 self.assertContains(' ok 4 - kunit_resource_test_cleanup_resources', result)
125 self.assertContains(' ok 5 - kunit_resource_test_proper_free_ordering', result)
126 self.assertContains('ok 1 - kunit-resource-test', result)
127 self.assertContains(' foo bar # non-kunit output', result)
128 self.assertContains(' # Subtest: kunit-try-catch-test', result)
129 self.assertContains(' 1..2', result)
130 self.assertContains(' ok 1 - kunit_test_try_catch_successful_try_no_catch',
132 self.assertContains(' ok 2 - kunit_test_try_catch_unsuccessful_try_does_catch',
134 self.assertContains('ok 2 - kunit-try-catch-test', result)
135 self.assertContains(' # Subtest: string-stream-test', result)
136 self.assertContains(' 1..3', result)
137 self.assertContains(' ok 1 - string_stream_test_empty_on_creation', result)
138 self.assertContains(' ok 2 - string_stream_test_not_empty_after_add', result)
139 self.assertContains(' ok 3 - string_stream_test_get_string', result)
140 self.assertContains('ok 3 - string-stream-test', result)
142 def test_parse_successful_test_log(self):
143 all_passed_log = test_data_path('test_is_test_passed-all_passed.log')
144 with open(all_passed_log) as file:
145 result = kunit_parser.parse_run_tests(file.readlines())
147 kunit_parser.TestStatus.SUCCESS,
150 def test_parse_failed_test_log(self):
151 failed_log = test_data_path('test_is_test_passed-failure.log')
152 with open(failed_log) as file:
153 result = kunit_parser.parse_run_tests(file.readlines())
155 kunit_parser.TestStatus.FAILURE,
158 def test_no_tests(self):
159 empty_log = test_data_path('test_is_test_passed-no_tests_run.log')
160 with open(empty_log) as file:
161 result = kunit_parser.parse_run_tests(
162 kunit_parser.isolate_kunit_output(file.readlines()))
163 self.assertEqual(0, len(result.suites))
165 kunit_parser.TestStatus.NO_TESTS,
168 def test_no_kunit_output(self):
169 crash_log = test_data_path('test_insufficient_memory.log')
170 print_mock = mock.patch('builtins.print').start()
171 with open(crash_log) as file:
172 result = kunit_parser.parse_run_tests(
173 kunit_parser.isolate_kunit_output(file.readlines()))
174 print_mock.assert_any_call(StrContains('no tests run!'))
178 def test_crashed_test(self):
179 crashed_log = test_data_path('test_is_test_passed-crash.log')
180 with open(crashed_log) as file:
181 result = kunit_parser.parse_run_tests(file.readlines())
183 kunit_parser.TestStatus.TEST_CRASHED,
186 def test_ignores_prefix_printk_time(self):
187 prefix_log = test_data_path('test_config_printk_time.log')
188 with open(prefix_log) as file:
189 result = kunit_parser.parse_run_tests(file.readlines())
191 kunit_parser.TestStatus.SUCCESS,
193 self.assertEqual('kunit-resource-test', result.suites[0].name)
195 def test_ignores_multiple_prefixes(self):
196 prefix_log = test_data_path('test_multiple_prefixes.log')
197 with open(prefix_log) as file:
198 result = kunit_parser.parse_run_tests(file.readlines())
200 kunit_parser.TestStatus.SUCCESS,
202 self.assertEqual('kunit-resource-test', result.suites[0].name)
204 def test_prefix_mixed_kernel_output(self):
205 mixed_prefix_log = test_data_path('test_interrupted_tap_output.log')
206 with open(mixed_prefix_log) as file:
207 result = kunit_parser.parse_run_tests(file.readlines())
209 kunit_parser.TestStatus.SUCCESS,
211 self.assertEqual('kunit-resource-test', result.suites[0].name)
213 def test_prefix_poundsign(self):
214 pound_log = test_data_path('test_pound_sign.log')
215 with open(pound_log) as file:
216 result = kunit_parser.parse_run_tests(file.readlines())
218 kunit_parser.TestStatus.SUCCESS,
220 self.assertEqual('kunit-resource-test', result.suites[0].name)
222 def test_kernel_panic_end(self):
223 panic_log = test_data_path('test_kernel_panic_interrupt.log')
224 with open(panic_log) as file:
225 result = kunit_parser.parse_run_tests(file.readlines())
227 kunit_parser.TestStatus.TEST_CRASHED,
229 self.assertEqual('kunit-resource-test', result.suites[0].name)
231 def test_pound_no_prefix(self):
232 pound_log = test_data_path('test_pound_no_prefix.log')
233 with open(pound_log) as file:
234 result = kunit_parser.parse_run_tests(file.readlines())
236 kunit_parser.TestStatus.SUCCESS,
238 self.assertEqual('kunit-resource-test', result.suites[0].name)
240 class LinuxSourceTreeTest(unittest.TestCase):
243 mock.patch.object(signal, 'signal').start()
244 self.addCleanup(mock.patch.stopall)
246 def test_invalid_kunitconfig(self):
247 with self.assertRaisesRegex(kunit_kernel.ConfigError, 'nonexistent.* does not exist'):
248 kunit_kernel.LinuxSourceTree('', kunitconfig_path='/nonexistent_file')
250 def test_valid_kunitconfig(self):
251 with tempfile.NamedTemporaryFile('wt') as kunitconfig:
252 tree = kunit_kernel.LinuxSourceTree('', kunitconfig_path=kunitconfig.name)
254 # TODO: add more test cases.
257 class KUnitJsonTest(unittest.TestCase):
259 def _json_for(self, log_file):
260 with open(test_data_path(log_file)) as file:
261 test_result = kunit_parser.parse_run_tests(file)
262 json_obj = kunit_json.get_json_result(
263 test_result=test_result,
264 def_config='kunit_defconfig',
267 return json.loads(json_obj)
269 def test_failed_test_json(self):
270 result = self._json_for('test_is_test_passed-failure.log')
272 {'name': 'example_simple_test', 'status': 'FAIL'},
273 result["sub_groups"][1]["test_cases"][0])
275 def test_crashed_test_json(self):
276 result = self._json_for('test_is_test_passed-crash.log')
278 {'name': 'example_simple_test', 'status': 'ERROR'},
279 result["sub_groups"][1]["test_cases"][0])
281 def test_no_tests_json(self):
282 result = self._json_for('test_is_test_passed-no_tests_run.log')
283 self.assertEqual(0, len(result['sub_groups']))
285 class StrContains(str):
286 def __eq__(self, other):
289 class KUnitMainTest(unittest.TestCase):
291 path = test_data_path('test_is_test_passed-all_passed.log')
292 with open(path) as file:
293 all_passed_log = file.readlines()
295 self.print_mock = mock.patch('builtins.print').start()
296 self.addCleanup(mock.patch.stopall)
298 self.linux_source_mock = mock.Mock()
299 self.linux_source_mock.build_reconfig = mock.Mock(return_value=True)
300 self.linux_source_mock.build_um_kernel = mock.Mock(return_value=True)
301 self.linux_source_mock.run_kernel = mock.Mock(return_value=all_passed_log)
303 def test_config_passes_args_pass(self):
304 kunit.main(['config', '--build_dir=.kunit'], self.linux_source_mock)
305 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
306 self.assertEqual(self.linux_source_mock.run_kernel.call_count, 0)
308 def test_build_passes_args_pass(self):
309 kunit.main(['build'], self.linux_source_mock)
310 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 0)
311 self.linux_source_mock.build_um_kernel.assert_called_once_with(False, 8, '.kunit', None)
312 self.assertEqual(self.linux_source_mock.run_kernel.call_count, 0)
314 def test_exec_passes_args_pass(self):
315 kunit.main(['exec'], self.linux_source_mock)
316 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 0)
317 self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1)
318 self.linux_source_mock.run_kernel.assert_called_once_with(
319 build_dir='.kunit', filter_glob='', timeout=300)
320 self.print_mock.assert_any_call(StrContains('Testing complete.'))
322 def test_run_passes_args_pass(self):
323 kunit.main(['run'], self.linux_source_mock)
324 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
325 self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1)
326 self.linux_source_mock.run_kernel.assert_called_once_with(
327 build_dir='.kunit', filter_glob='', timeout=300)
328 self.print_mock.assert_any_call(StrContains('Testing complete.'))
330 def test_exec_passes_args_fail(self):
331 self.linux_source_mock.run_kernel = mock.Mock(return_value=[])
332 with self.assertRaises(SystemExit) as e:
333 kunit.main(['exec'], self.linux_source_mock)
334 self.assertEqual(e.exception.code, 1)
336 def test_run_passes_args_fail(self):
337 self.linux_source_mock.run_kernel = mock.Mock(return_value=[])
338 with self.assertRaises(SystemExit) as e:
339 kunit.main(['run'], self.linux_source_mock)
340 self.assertEqual(e.exception.code, 1)
341 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
342 self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1)
343 self.print_mock.assert_any_call(StrContains(' 0 tests run'))
345 def test_exec_raw_output(self):
346 self.linux_source_mock.run_kernel = mock.Mock(return_value=[])
347 kunit.main(['exec', '--raw_output'], self.linux_source_mock)
348 self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1)
349 for call in self.print_mock.call_args_list:
350 self.assertNotEqual(call, mock.call(StrContains('Testing complete.')))
351 self.assertNotEqual(call, mock.call(StrContains(' 0 tests run')))
353 def test_run_raw_output(self):
354 self.linux_source_mock.run_kernel = mock.Mock(return_value=[])
355 kunit.main(['run', '--raw_output'], self.linux_source_mock)
356 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
357 self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1)
358 for call in self.print_mock.call_args_list:
359 self.assertNotEqual(call, mock.call(StrContains('Testing complete.')))
360 self.assertNotEqual(call, mock.call(StrContains(' 0 tests run')))
362 def test_exec_timeout(self):
364 kunit.main(['exec', '--timeout', str(timeout)], self.linux_source_mock)
365 self.linux_source_mock.run_kernel.assert_called_once_with(
366 build_dir='.kunit', filter_glob='', timeout=timeout)
367 self.print_mock.assert_any_call(StrContains('Testing complete.'))
369 def test_run_timeout(self):
371 kunit.main(['run', '--timeout', str(timeout)], self.linux_source_mock)
372 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
373 self.linux_source_mock.run_kernel.assert_called_once_with(
374 build_dir='.kunit', filter_glob='', timeout=timeout)
375 self.print_mock.assert_any_call(StrContains('Testing complete.'))
377 def test_run_builddir(self):
379 kunit.main(['run', '--build_dir=.kunit'], self.linux_source_mock)
380 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
381 self.linux_source_mock.run_kernel.assert_called_once_with(
382 build_dir=build_dir, filter_glob='', timeout=300)
383 self.print_mock.assert_any_call(StrContains('Testing complete.'))
385 def test_config_builddir(self):
387 kunit.main(['config', '--build_dir', build_dir], self.linux_source_mock)
388 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
390 def test_build_builddir(self):
392 kunit.main(['build', '--build_dir', build_dir], self.linux_source_mock)
393 self.linux_source_mock.build_um_kernel.assert_called_once_with(False, 8, build_dir, None)
395 def test_exec_builddir(self):
397 kunit.main(['exec', '--build_dir', build_dir], self.linux_source_mock)
398 self.linux_source_mock.run_kernel.assert_called_once_with(
399 build_dir=build_dir, filter_glob='', timeout=300)
400 self.print_mock.assert_any_call(StrContains('Testing complete.'))
402 @mock.patch.object(kunit_kernel, 'LinuxSourceTree')
403 def test_run_kunitconfig(self, mock_linux_init):
404 mock_linux_init.return_value = self.linux_source_mock
405 kunit.main(['run', '--kunitconfig=mykunitconfig'])
406 # Just verify that we parsed and initialized it correctly here.
407 mock_linux_init.assert_called_once_with('.kunit', kunitconfig_path='mykunitconfig')
409 @mock.patch.object(kunit_kernel, 'LinuxSourceTree')
410 def test_config_kunitconfig(self, mock_linux_init):
411 mock_linux_init.return_value = self.linux_source_mock
412 kunit.main(['config', '--kunitconfig=mykunitconfig'])
413 # Just verify that we parsed and initialized it correctly here.
414 mock_linux_init.assert_called_once_with('.kunit', kunitconfig_path='mykunitconfig')
416 if __name__ == '__main__':