1#!/usr/bin/env python3 2# SPDX-License-Identifier: GPL-2.0 3# 4# A collection of tests for tools/testing/kunit/kunit.py 5# 6# Copyright (C) 2019, Google LLC. 7# Author: Brendan Higgins <brendanhiggins@google.com> 8 9import unittest 10from unittest import mock 11 12import tempfile, shutil # Handling test_tmpdir 13 14import itertools 15import json 16import os 17import signal 18import subprocess 19from typing import Iterable 20 21import kunit_config 22import kunit_parser 23import kunit_kernel 24import kunit_json 25import kunit 26 27test_tmpdir = '' 28abs_test_data_dir = '' 29 30def setUpModule(): 31 global test_tmpdir, abs_test_data_dir 32 test_tmpdir = tempfile.mkdtemp() 33 abs_test_data_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), 'test_data')) 34 35def tearDownModule(): 36 shutil.rmtree(test_tmpdir) 37 38def test_data_path(path): 39 return os.path.join(abs_test_data_dir, path) 40 41class KconfigTest(unittest.TestCase): 42 43 def test_is_subset_of(self): 44 kconfig0 = kunit_config.Kconfig() 45 self.assertTrue(kconfig0.is_subset_of(kconfig0)) 46 47 kconfig1 = kunit_config.Kconfig() 48 kconfig1.add_entry('TEST', 'y') 49 self.assertTrue(kconfig1.is_subset_of(kconfig1)) 50 self.assertTrue(kconfig0.is_subset_of(kconfig1)) 51 self.assertFalse(kconfig1.is_subset_of(kconfig0)) 52 53 def test_read_from_file(self): 54 kconfig_path = test_data_path('test_read_from_file.kconfig') 55 56 kconfig = kunit_config.parse_file(kconfig_path) 57 58 expected_kconfig = kunit_config.Kconfig() 59 expected_kconfig.add_entry('UML', 'y') 60 expected_kconfig.add_entry('MMU', 'y') 61 expected_kconfig.add_entry('TEST', 'y') 62 expected_kconfig.add_entry('EXAMPLE_TEST', 'y') 63 expected_kconfig.add_entry('MK8', 'n') 64 65 self.assertEqual(kconfig, expected_kconfig) 66 67 def test_write_to_file(self): 68 kconfig_path = os.path.join(test_tmpdir, '.config') 69 70 expected_kconfig = kunit_config.Kconfig() 71 expected_kconfig.add_entry('UML', 'y') 72 expected_kconfig.add_entry('MMU', 'y') 73 expected_kconfig.add_entry('TEST', 'y') 74 expected_kconfig.add_entry('EXAMPLE_TEST', 'y') 75 expected_kconfig.add_entry('MK8', 'n') 76 77 expected_kconfig.write_to_file(kconfig_path) 78 79 actual_kconfig = kunit_config.parse_file(kconfig_path) 80 self.assertEqual(actual_kconfig, expected_kconfig) 81 82class KUnitParserTest(unittest.TestCase): 83 def setUp(self): 84 self.print_mock = mock.patch('kunit_printer.Printer.print').start() 85 self.addCleanup(mock.patch.stopall) 86 87 def assertContains(self, needle: str, haystack: kunit_parser.LineStream): 88 # Clone the iterator so we can print the contents on failure. 89 copy, backup = itertools.tee(haystack) 90 for line in copy: 91 if needle in line: 92 return 93 raise AssertionError(f'"{needle}" not found in {list(backup)}!') 94 95 def test_output_isolated_correctly(self): 96 log_path = test_data_path('test_output_isolated_correctly.log') 97 with open(log_path) as file: 98 result = kunit_parser.extract_tap_lines(file.readlines()) 99 self.assertContains('TAP version 14', result) 100 self.assertContains('# Subtest: example', result) 101 self.assertContains('1..2', result) 102 self.assertContains('ok 1 - example_simple_test', result) 103 self.assertContains('ok 2 - example_mock_test', result) 104 self.assertContains('ok 1 - example', result) 105 106 def test_output_with_prefix_isolated_correctly(self): 107 log_path = test_data_path('test_pound_sign.log') 108 with open(log_path) as file: 109 result = kunit_parser.extract_tap_lines(file.readlines()) 110 self.assertContains('TAP version 14', result) 111 self.assertContains('# Subtest: kunit-resource-test', result) 112 self.assertContains('1..5', result) 113 self.assertContains('ok 1 - kunit_resource_test_init_resources', result) 114 self.assertContains('ok 2 - kunit_resource_test_alloc_resource', result) 115 self.assertContains('ok 3 - kunit_resource_test_destroy_resource', result) 116 self.assertContains('foo bar #', result) 117 self.assertContains('ok 4 - kunit_resource_test_cleanup_resources', result) 118 self.assertContains('ok 5 - kunit_resource_test_proper_free_ordering', result) 119 self.assertContains('ok 1 - kunit-resource-test', result) 120 self.assertContains('foo bar # non-kunit output', result) 121 self.assertContains('# Subtest: kunit-try-catch-test', result) 122 self.assertContains('1..2', result) 123 self.assertContains('ok 1 - kunit_test_try_catch_successful_try_no_catch', 124 result) 125 self.assertContains('ok 2 - kunit_test_try_catch_unsuccessful_try_does_catch', 126 result) 127 self.assertContains('ok 2 - kunit-try-catch-test', result) 128 self.assertContains('# Subtest: string-stream-test', result) 129 self.assertContains('1..3', result) 130 self.assertContains('ok 1 - string_stream_test_empty_on_creation', result) 131 self.assertContains('ok 2 - string_stream_test_not_empty_after_add', result) 132 self.assertContains('ok 3 - string_stream_test_get_string', result) 133 self.assertContains('ok 3 - string-stream-test', result) 134 135 def test_parse_successful_test_log(self): 136 all_passed_log = test_data_path('test_is_test_passed-all_passed.log') 137 with open(all_passed_log) as file: 138 result = kunit_parser.parse_run_tests(file.readlines()) 139 self.assertEqual(kunit_parser.TestStatus.SUCCESS, result.status) 140 self.assertEqual(result.counts.errors, 0) 141 142 def test_parse_successful_nested_tests_log(self): 143 all_passed_log = test_data_path('test_is_test_passed-all_passed_nested.log') 144 with open(all_passed_log) as file: 145 result = kunit_parser.parse_run_tests(file.readlines()) 146 self.assertEqual(kunit_parser.TestStatus.SUCCESS, result.status) 147 self.assertEqual(result.counts.errors, 0) 148 149 def test_kselftest_nested(self): 150 kselftest_log = test_data_path('test_is_test_passed-kselftest.log') 151 with open(kselftest_log) as file: 152 result = kunit_parser.parse_run_tests(file.readlines()) 153 self.assertEqual(kunit_parser.TestStatus.SUCCESS, result.status) 154 self.assertEqual(result.counts.errors, 0) 155 156 def test_parse_failed_test_log(self): 157 failed_log = test_data_path('test_is_test_passed-failure.log') 158 with open(failed_log) as file: 159 result = kunit_parser.parse_run_tests(file.readlines()) 160 self.assertEqual(kunit_parser.TestStatus.FAILURE, result.status) 161 self.assertEqual(result.counts.errors, 0) 162 163 def test_no_header(self): 164 empty_log = test_data_path('test_is_test_passed-no_tests_run_no_header.log') 165 with open(empty_log) as file: 166 result = kunit_parser.parse_run_tests( 167 kunit_parser.extract_tap_lines(file.readlines())) 168 self.assertEqual(0, len(result.subtests)) 169 self.assertEqual(kunit_parser.TestStatus.FAILURE_TO_PARSE_TESTS, result.status) 170 self.assertEqual(result.counts.errors, 1) 171 172 def test_missing_test_plan(self): 173 missing_plan_log = test_data_path('test_is_test_passed-' 174 'missing_plan.log') 175 with open(missing_plan_log) as file: 176 result = kunit_parser.parse_run_tests( 177 kunit_parser.extract_tap_lines( 178 file.readlines())) 179 # A missing test plan is not an error. 180 self.assertEqual(result.counts, kunit_parser.TestCounts(passed=10, errors=0)) 181 self.assertEqual(kunit_parser.TestStatus.SUCCESS, result.status) 182 183 def test_no_tests(self): 184 header_log = test_data_path('test_is_test_passed-no_tests_run_with_header.log') 185 with open(header_log) as file: 186 result = kunit_parser.parse_run_tests( 187 kunit_parser.extract_tap_lines(file.readlines())) 188 self.assertEqual(0, len(result.subtests)) 189 self.assertEqual(kunit_parser.TestStatus.NO_TESTS, result.status) 190 self.assertEqual(result.counts.errors, 1) 191 192 def test_no_tests_no_plan(self): 193 no_plan_log = test_data_path('test_is_test_passed-no_tests_no_plan.log') 194 with open(no_plan_log) as file: 195 result = kunit_parser.parse_run_tests( 196 kunit_parser.extract_tap_lines(file.readlines())) 197 self.assertEqual(0, len(result.subtests[0].subtests[0].subtests)) 198 self.assertEqual( 199 kunit_parser.TestStatus.NO_TESTS, 200 result.subtests[0].subtests[0].status) 201 self.assertEqual(result.counts, kunit_parser.TestCounts(passed=1, errors=1)) 202 203 204 def test_no_kunit_output(self): 205 crash_log = test_data_path('test_insufficient_memory.log') 206 print_mock = mock.patch('kunit_printer.Printer.print').start() 207 with open(crash_log) as file: 208 result = kunit_parser.parse_run_tests( 209 kunit_parser.extract_tap_lines(file.readlines())) 210 print_mock.assert_any_call(StrContains('Could not find any KTAP output.')) 211 print_mock.stop() 212 self.assertEqual(0, len(result.subtests)) 213 self.assertEqual(result.counts.errors, 1) 214 215 def test_skipped_test(self): 216 skipped_log = test_data_path('test_skip_tests.log') 217 with open(skipped_log) as file: 218 result = kunit_parser.parse_run_tests(file.readlines()) 219 220 # A skipped test does not fail the whole suite. 221 self.assertEqual(kunit_parser.TestStatus.SUCCESS, result.status) 222 self.assertEqual(result.counts, kunit_parser.TestCounts(passed=4, skipped=1)) 223 224 def test_skipped_all_tests(self): 225 skipped_log = test_data_path('test_skip_all_tests.log') 226 with open(skipped_log) as file: 227 result = kunit_parser.parse_run_tests(file.readlines()) 228 229 self.assertEqual(kunit_parser.TestStatus.SKIPPED, result.status) 230 self.assertEqual(result.counts, kunit_parser.TestCounts(skipped=5)) 231 232 def test_ignores_hyphen(self): 233 hyphen_log = test_data_path('test_strip_hyphen.log') 234 with open(hyphen_log) as file: 235 result = kunit_parser.parse_run_tests(file.readlines()) 236 237 # A skipped test does not fail the whole suite. 238 self.assertEqual(kunit_parser.TestStatus.SUCCESS, result.status) 239 self.assertEqual( 240 "sysctl_test", 241 result.subtests[0].name) 242 self.assertEqual( 243 "example", 244 result.subtests[1].name) 245 246 def test_ignores_prefix_printk_time(self): 247 prefix_log = test_data_path('test_config_printk_time.log') 248 with open(prefix_log) as file: 249 result = kunit_parser.parse_run_tests(file.readlines()) 250 self.assertEqual(kunit_parser.TestStatus.SUCCESS, result.status) 251 self.assertEqual('kunit-resource-test', result.subtests[0].name) 252 self.assertEqual(result.counts.errors, 0) 253 254 def test_ignores_multiple_prefixes(self): 255 prefix_log = test_data_path('test_multiple_prefixes.log') 256 with open(prefix_log) as file: 257 result = kunit_parser.parse_run_tests(file.readlines()) 258 self.assertEqual(kunit_parser.TestStatus.SUCCESS, result.status) 259 self.assertEqual('kunit-resource-test', result.subtests[0].name) 260 self.assertEqual(result.counts.errors, 0) 261 262 def test_prefix_mixed_kernel_output(self): 263 mixed_prefix_log = test_data_path('test_interrupted_tap_output.log') 264 with open(mixed_prefix_log) as file: 265 result = kunit_parser.parse_run_tests(file.readlines()) 266 self.assertEqual(kunit_parser.TestStatus.SUCCESS, result.status) 267 self.assertEqual('kunit-resource-test', result.subtests[0].name) 268 self.assertEqual(result.counts.errors, 0) 269 270 def test_prefix_poundsign(self): 271 pound_log = test_data_path('test_pound_sign.log') 272 with open(pound_log) as file: 273 result = kunit_parser.parse_run_tests(file.readlines()) 274 self.assertEqual(kunit_parser.TestStatus.SUCCESS, result.status) 275 self.assertEqual('kunit-resource-test', result.subtests[0].name) 276 self.assertEqual(result.counts.errors, 0) 277 278 def test_kernel_panic_end(self): 279 panic_log = test_data_path('test_kernel_panic_interrupt.log') 280 with open(panic_log) as file: 281 result = kunit_parser.parse_run_tests(file.readlines()) 282 self.assertEqual(kunit_parser.TestStatus.TEST_CRASHED, result.status) 283 self.assertEqual('kunit-resource-test', result.subtests[0].name) 284 self.assertGreaterEqual(result.counts.errors, 1) 285 286 def test_pound_no_prefix(self): 287 pound_log = test_data_path('test_pound_no_prefix.log') 288 with open(pound_log) as file: 289 result = kunit_parser.parse_run_tests(file.readlines()) 290 self.assertEqual(kunit_parser.TestStatus.SUCCESS, result.status) 291 self.assertEqual('kunit-resource-test', result.subtests[0].name) 292 self.assertEqual(result.counts.errors, 0) 293 294 def test_summarize_failures(self): 295 output = """ 296 KTAP version 1 297 1..2 298 # Subtest: all_failed_suite 299 1..2 300 not ok 1 - test1 301 not ok 2 - test2 302 not ok 1 - all_failed_suite 303 # Subtest: some_failed_suite 304 1..2 305 ok 1 - test1 306 not ok 2 - test2 307 not ok 1 - some_failed_suite 308 """ 309 result = kunit_parser.parse_run_tests(output.splitlines()) 310 self.assertEqual(kunit_parser.TestStatus.FAILURE, result.status) 311 312 self.assertEqual(kunit_parser._summarize_failed_tests(result), 313 'Failures: all_failed_suite, some_failed_suite.test2') 314 315 def test_ktap_format(self): 316 ktap_log = test_data_path('test_parse_ktap_output.log') 317 with open(ktap_log) as file: 318 result = kunit_parser.parse_run_tests(file.readlines()) 319 self.assertEqual(result.counts, kunit_parser.TestCounts(passed=3)) 320 self.assertEqual('suite', result.subtests[0].name) 321 self.assertEqual('case_1', result.subtests[0].subtests[0].name) 322 self.assertEqual('case_2', result.subtests[0].subtests[1].name) 323 324 def test_parse_subtest_header(self): 325 ktap_log = test_data_path('test_parse_subtest_header.log') 326 with open(ktap_log) as file: 327 result = kunit_parser.parse_run_tests(file.readlines()) 328 self.print_mock.assert_any_call(StrContains('suite (1 subtest)')) 329 330def line_stream_from_strs(strs: Iterable[str]) -> kunit_parser.LineStream: 331 return kunit_parser.LineStream(enumerate(strs, start=1)) 332 333class LineStreamTest(unittest.TestCase): 334 335 def test_basic(self): 336 stream = line_stream_from_strs(['hello', 'world']) 337 338 self.assertTrue(stream, msg='Should be more input') 339 self.assertEqual(stream.line_number(), 1) 340 self.assertEqual(stream.peek(), 'hello') 341 self.assertEqual(stream.pop(), 'hello') 342 343 self.assertTrue(stream, msg='Should be more input') 344 self.assertEqual(stream.line_number(), 2) 345 self.assertEqual(stream.peek(), 'world') 346 self.assertEqual(stream.pop(), 'world') 347 348 self.assertFalse(stream, msg='Should be no more input') 349 with self.assertRaisesRegex(ValueError, 'LineStream: going past EOF'): 350 stream.pop() 351 352 def test_is_lazy(self): 353 called_times = 0 354 def generator(): 355 nonlocal called_times 356 for _ in range(1,5): 357 called_times += 1 358 yield called_times, str(called_times) 359 360 stream = kunit_parser.LineStream(generator()) 361 self.assertEqual(called_times, 0) 362 363 self.assertEqual(stream.pop(), '1') 364 self.assertEqual(called_times, 1) 365 366 self.assertEqual(stream.pop(), '2') 367 self.assertEqual(called_times, 2) 368 369class LinuxSourceTreeTest(unittest.TestCase): 370 371 def setUp(self): 372 mock.patch.object(signal, 'signal').start() 373 self.addCleanup(mock.patch.stopall) 374 375 def test_invalid_kunitconfig(self): 376 with self.assertRaisesRegex(kunit_kernel.ConfigError, 'nonexistent.* does not exist'): 377 kunit_kernel.LinuxSourceTree('', kunitconfig_paths=['/nonexistent_file']) 378 379 def test_valid_kunitconfig(self): 380 with tempfile.NamedTemporaryFile('wt') as kunitconfig: 381 kunit_kernel.LinuxSourceTree('', kunitconfig_paths=[kunitconfig.name]) 382 383 def test_dir_kunitconfig(self): 384 with tempfile.TemporaryDirectory('') as dir: 385 with open(os.path.join(dir, '.kunitconfig'), 'w'): 386 pass 387 kunit_kernel.LinuxSourceTree('', kunitconfig_paths=[dir]) 388 389 def test_multiple_kunitconfig(self): 390 want_kconfig = kunit_config.Kconfig() 391 want_kconfig.add_entry('KUNIT', 'y') 392 want_kconfig.add_entry('KUNIT_TEST', 'm') 393 394 with tempfile.TemporaryDirectory('') as dir: 395 other = os.path.join(dir, 'otherkunitconfig') 396 with open(os.path.join(dir, '.kunitconfig'), 'w') as f: 397 f.write('CONFIG_KUNIT=y') 398 with open(other, 'w') as f: 399 f.write('CONFIG_KUNIT_TEST=m') 400 pass 401 402 tree = kunit_kernel.LinuxSourceTree('', kunitconfig_paths=[dir, other]) 403 self.assertTrue(want_kconfig.is_subset_of(tree._kconfig), msg=tree._kconfig) 404 405 406 def test_multiple_kunitconfig_invalid(self): 407 with tempfile.TemporaryDirectory('') as dir: 408 other = os.path.join(dir, 'otherkunitconfig') 409 with open(os.path.join(dir, '.kunitconfig'), 'w') as f: 410 f.write('CONFIG_KUNIT=y') 411 with open(other, 'w') as f: 412 f.write('CONFIG_KUNIT=m') 413 414 with self.assertRaisesRegex(kunit_kernel.ConfigError, '(?s)Multiple values.*CONFIG_KUNIT'): 415 kunit_kernel.LinuxSourceTree('', kunitconfig_paths=[dir, other]) 416 417 418 def test_kconfig_add(self): 419 want_kconfig = kunit_config.Kconfig() 420 want_kconfig.add_entry('NOT_REAL', 'y') 421 422 tree = kunit_kernel.LinuxSourceTree('', kconfig_add=['CONFIG_NOT_REAL=y']) 423 self.assertTrue(want_kconfig.is_subset_of(tree._kconfig), msg=tree._kconfig) 424 425 def test_invalid_arch(self): 426 with self.assertRaisesRegex(kunit_kernel.ConfigError, 'not a valid arch, options are.*x86_64'): 427 kunit_kernel.LinuxSourceTree('', arch='invalid') 428 429 def test_run_kernel_hits_exception(self): 430 def fake_start(unused_args, unused_build_dir): 431 return subprocess.Popen(['echo "hi\nbye"'], shell=True, text=True, stdout=subprocess.PIPE) 432 433 with tempfile.TemporaryDirectory('') as build_dir: 434 tree = kunit_kernel.LinuxSourceTree(build_dir) 435 mock.patch.object(tree._ops, 'start', side_effect=fake_start).start() 436 437 with self.assertRaises(ValueError): 438 for line in tree.run_kernel(build_dir=build_dir): 439 self.assertEqual(line, 'hi\n') 440 raise ValueError('uh oh, did not read all output') 441 442 with open(kunit_kernel.get_outfile_path(build_dir), 'rt') as outfile: 443 self.assertEqual(outfile.read(), 'hi\nbye\n', msg='Missing some output') 444 445 def test_build_reconfig_no_config(self): 446 with tempfile.TemporaryDirectory('') as build_dir: 447 with open(kunit_kernel.get_kunitconfig_path(build_dir), 'w') as f: 448 f.write('CONFIG_KUNIT=y') 449 450 tree = kunit_kernel.LinuxSourceTree(build_dir) 451 # Stub out the source tree operations, so we don't have 452 # the defaults for any given architecture get in the 453 # way. 454 tree._ops = kunit_kernel.LinuxSourceTreeOperations('none', None) 455 mock_build_config = mock.patch.object(tree, 'build_config').start() 456 457 # Should generate the .config 458 self.assertTrue(tree.build_reconfig(build_dir, make_options=[])) 459 mock_build_config.assert_called_once_with(build_dir, []) 460 461 def test_build_reconfig_existing_config(self): 462 with tempfile.TemporaryDirectory('') as build_dir: 463 # Existing .config is a superset, should not touch it 464 with open(kunit_kernel.get_kunitconfig_path(build_dir), 'w') as f: 465 f.write('CONFIG_KUNIT=y') 466 with open(kunit_kernel.get_old_kunitconfig_path(build_dir), 'w') as f: 467 f.write('CONFIG_KUNIT=y') 468 with open(kunit_kernel.get_kconfig_path(build_dir), 'w') as f: 469 f.write('CONFIG_KUNIT=y\nCONFIG_KUNIT_TEST=y') 470 471 tree = kunit_kernel.LinuxSourceTree(build_dir) 472 # Stub out the source tree operations, so we don't have 473 # the defaults for any given architecture get in the 474 # way. 475 tree._ops = kunit_kernel.LinuxSourceTreeOperations('none', None) 476 mock_build_config = mock.patch.object(tree, 'build_config').start() 477 478 self.assertTrue(tree.build_reconfig(build_dir, make_options=[])) 479 self.assertEqual(mock_build_config.call_count, 0) 480 481 def test_build_reconfig_remove_option(self): 482 with tempfile.TemporaryDirectory('') as build_dir: 483 # We removed CONFIG_KUNIT_TEST=y from our .kunitconfig... 484 with open(kunit_kernel.get_kunitconfig_path(build_dir), 'w') as f: 485 f.write('CONFIG_KUNIT=y') 486 with open(kunit_kernel.get_old_kunitconfig_path(build_dir), 'w') as f: 487 f.write('CONFIG_KUNIT=y\nCONFIG_KUNIT_TEST=y') 488 with open(kunit_kernel.get_kconfig_path(build_dir), 'w') as f: 489 f.write('CONFIG_KUNIT=y\nCONFIG_KUNIT_TEST=y') 490 491 tree = kunit_kernel.LinuxSourceTree(build_dir) 492 # Stub out the source tree operations, so we don't have 493 # the defaults for any given architecture get in the 494 # way. 495 tree._ops = kunit_kernel.LinuxSourceTreeOperations('none', None) 496 mock_build_config = mock.patch.object(tree, 'build_config').start() 497 498 # ... so we should trigger a call to build_config() 499 self.assertTrue(tree.build_reconfig(build_dir, make_options=[])) 500 mock_build_config.assert_called_once_with(build_dir, []) 501 502 # TODO: add more test cases. 503 504 505class KUnitJsonTest(unittest.TestCase): 506 def setUp(self): 507 self.print_mock = mock.patch('kunit_printer.Printer.print').start() 508 self.addCleanup(mock.patch.stopall) 509 510 def _json_for(self, log_file): 511 with open(test_data_path(log_file)) as file: 512 test_result = kunit_parser.parse_run_tests(file) 513 json_obj = kunit_json.get_json_result( 514 test=test_result, 515 metadata=kunit_json.Metadata()) 516 return json.loads(json_obj) 517 518 def test_failed_test_json(self): 519 result = self._json_for('test_is_test_passed-failure.log') 520 self.assertEqual( 521 {'name': 'example_simple_test', 'status': 'FAIL'}, 522 result["sub_groups"][1]["test_cases"][0]) 523 524 def test_crashed_test_json(self): 525 result = self._json_for('test_kernel_panic_interrupt.log') 526 self.assertEqual( 527 {'name': '', 'status': 'ERROR'}, 528 result["sub_groups"][2]["test_cases"][1]) 529 530 def test_skipped_test_json(self): 531 result = self._json_for('test_skip_tests.log') 532 self.assertEqual( 533 {'name': 'example_skip_test', 'status': 'SKIP'}, 534 result["sub_groups"][1]["test_cases"][1]) 535 536 def test_no_tests_json(self): 537 result = self._json_for('test_is_test_passed-no_tests_run_with_header.log') 538 self.assertEqual(0, len(result['sub_groups'])) 539 540 def test_nested_json(self): 541 result = self._json_for('test_is_test_passed-all_passed_nested.log') 542 self.assertEqual( 543 {'name': 'example_simple_test', 'status': 'PASS'}, 544 result["sub_groups"][0]["sub_groups"][0]["test_cases"][0]) 545 546class StrContains(str): 547 def __eq__(self, other): 548 return self in other 549 550class KUnitMainTest(unittest.TestCase): 551 def setUp(self): 552 path = test_data_path('test_is_test_passed-all_passed.log') 553 with open(path) as file: 554 all_passed_log = file.readlines() 555 556 self.print_mock = mock.patch('kunit_printer.Printer.print').start() 557 self.addCleanup(mock.patch.stopall) 558 559 self.mock_linux_init = mock.patch.object(kunit_kernel, 'LinuxSourceTree').start() 560 self.linux_source_mock = self.mock_linux_init.return_value 561 self.linux_source_mock.build_reconfig.return_value = True 562 self.linux_source_mock.build_kernel.return_value = True 563 self.linux_source_mock.run_kernel.return_value = all_passed_log 564 565 def test_config_passes_args_pass(self): 566 kunit.main(['config', '--build_dir=.kunit']) 567 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1) 568 self.assertEqual(self.linux_source_mock.run_kernel.call_count, 0) 569 570 def test_build_passes_args_pass(self): 571 kunit.main(['build']) 572 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1) 573 self.linux_source_mock.build_kernel.assert_called_once_with(kunit.get_default_jobs(), '.kunit', None) 574 self.assertEqual(self.linux_source_mock.run_kernel.call_count, 0) 575 576 def test_exec_passes_args_pass(self): 577 kunit.main(['exec']) 578 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 0) 579 self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1) 580 self.linux_source_mock.run_kernel.assert_called_once_with( 581 args=None, build_dir='.kunit', filter_glob='', timeout=300) 582 self.print_mock.assert_any_call(StrContains('Testing complete.')) 583 584 def test_run_passes_args_pass(self): 585 kunit.main(['run']) 586 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1) 587 self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1) 588 self.linux_source_mock.run_kernel.assert_called_once_with( 589 args=None, build_dir='.kunit', filter_glob='', timeout=300) 590 self.print_mock.assert_any_call(StrContains('Testing complete.')) 591 592 def test_exec_passes_args_fail(self): 593 self.linux_source_mock.run_kernel = mock.Mock(return_value=[]) 594 with self.assertRaises(SystemExit) as e: 595 kunit.main(['exec']) 596 self.assertEqual(e.exception.code, 1) 597 598 def test_run_passes_args_fail(self): 599 self.linux_source_mock.run_kernel = mock.Mock(return_value=[]) 600 with self.assertRaises(SystemExit) as e: 601 kunit.main(['run']) 602 self.assertEqual(e.exception.code, 1) 603 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1) 604 self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1) 605 self.print_mock.assert_any_call(StrContains('Could not find any KTAP output.')) 606 607 def test_exec_no_tests(self): 608 self.linux_source_mock.run_kernel = mock.Mock(return_value=['TAP version 14', '1..0']) 609 with self.assertRaises(SystemExit) as e: 610 kunit.main(['run']) 611 self.assertEqual(e.exception.code, 1) 612 self.linux_source_mock.run_kernel.assert_called_once_with( 613 args=None, build_dir='.kunit', filter_glob='', timeout=300) 614 self.print_mock.assert_any_call(StrContains(' 0 tests run!')) 615 616 def test_exec_raw_output(self): 617 self.linux_source_mock.run_kernel = mock.Mock(return_value=[]) 618 kunit.main(['exec', '--raw_output']) 619 self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1) 620 for call in self.print_mock.call_args_list: 621 self.assertNotEqual(call, mock.call(StrContains('Testing complete.'))) 622 self.assertNotEqual(call, mock.call(StrContains(' 0 tests run!'))) 623 624 def test_run_raw_output(self): 625 self.linux_source_mock.run_kernel = mock.Mock(return_value=[]) 626 kunit.main(['run', '--raw_output']) 627 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1) 628 self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1) 629 for call in self.print_mock.call_args_list: 630 self.assertNotEqual(call, mock.call(StrContains('Testing complete.'))) 631 self.assertNotEqual(call, mock.call(StrContains(' 0 tests run!'))) 632 633 def test_run_raw_output_kunit(self): 634 self.linux_source_mock.run_kernel = mock.Mock(return_value=[]) 635 kunit.main(['run', '--raw_output=kunit']) 636 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1) 637 self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1) 638 for call in self.print_mock.call_args_list: 639 self.assertNotEqual(call, mock.call(StrContains('Testing complete.'))) 640 self.assertNotEqual(call, mock.call(StrContains(' 0 tests run'))) 641 642 def test_run_raw_output_invalid(self): 643 self.linux_source_mock.run_kernel = mock.Mock(return_value=[]) 644 with self.assertRaises(SystemExit) as e: 645 kunit.main(['run', '--raw_output=invalid']) 646 self.assertNotEqual(e.exception.code, 0) 647 648 def test_run_raw_output_does_not_take_positional_args(self): 649 # --raw_output is a string flag, but we don't want it to consume 650 # any positional arguments, only ones after an '=' 651 self.linux_source_mock.run_kernel = mock.Mock(return_value=[]) 652 kunit.main(['run', '--raw_output', 'filter_glob']) 653 self.linux_source_mock.run_kernel.assert_called_once_with( 654 args=None, build_dir='.kunit', filter_glob='filter_glob', timeout=300) 655 656 def test_exec_timeout(self): 657 timeout = 3453 658 kunit.main(['exec', '--timeout', str(timeout)]) 659 self.linux_source_mock.run_kernel.assert_called_once_with( 660 args=None, build_dir='.kunit', filter_glob='', timeout=timeout) 661 self.print_mock.assert_any_call(StrContains('Testing complete.')) 662 663 def test_run_timeout(self): 664 timeout = 3453 665 kunit.main(['run', '--timeout', str(timeout)]) 666 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1) 667 self.linux_source_mock.run_kernel.assert_called_once_with( 668 args=None, build_dir='.kunit', filter_glob='', timeout=timeout) 669 self.print_mock.assert_any_call(StrContains('Testing complete.')) 670 671 def test_run_builddir(self): 672 build_dir = '.kunit' 673 kunit.main(['run', '--build_dir=.kunit']) 674 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1) 675 self.linux_source_mock.run_kernel.assert_called_once_with( 676 args=None, build_dir=build_dir, filter_glob='', timeout=300) 677 self.print_mock.assert_any_call(StrContains('Testing complete.')) 678 679 def test_config_builddir(self): 680 build_dir = '.kunit' 681 kunit.main(['config', '--build_dir', build_dir]) 682 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1) 683 684 def test_build_builddir(self): 685 build_dir = '.kunit' 686 jobs = kunit.get_default_jobs() 687 kunit.main(['build', '--build_dir', build_dir]) 688 self.linux_source_mock.build_kernel.assert_called_once_with(jobs, build_dir, None) 689 690 def test_exec_builddir(self): 691 build_dir = '.kunit' 692 kunit.main(['exec', '--build_dir', build_dir]) 693 self.linux_source_mock.run_kernel.assert_called_once_with( 694 args=None, build_dir=build_dir, filter_glob='', timeout=300) 695 self.print_mock.assert_any_call(StrContains('Testing complete.')) 696 697 def test_run_kunitconfig(self): 698 kunit.main(['run', '--kunitconfig=mykunitconfig']) 699 # Just verify that we parsed and initialized it correctly here. 700 self.mock_linux_init.assert_called_once_with('.kunit', 701 kunitconfig_paths=['mykunitconfig'], 702 kconfig_add=None, 703 arch='um', 704 cross_compile=None, 705 qemu_config_path=None, 706 extra_qemu_args=[]) 707 708 def test_config_kunitconfig(self): 709 kunit.main(['config', '--kunitconfig=mykunitconfig']) 710 # Just verify that we parsed and initialized it correctly here. 711 self.mock_linux_init.assert_called_once_with('.kunit', 712 kunitconfig_paths=['mykunitconfig'], 713 kconfig_add=None, 714 arch='um', 715 cross_compile=None, 716 qemu_config_path=None, 717 extra_qemu_args=[]) 718 719 def test_config_alltests(self): 720 kunit.main(['config', '--kunitconfig=mykunitconfig', '--alltests']) 721 # Just verify that we parsed and initialized it correctly here. 722 self.mock_linux_init.assert_called_once_with('.kunit', 723 kunitconfig_paths=[kunit_kernel.ALL_TESTS_CONFIG_PATH, 'mykunitconfig'], 724 kconfig_add=None, 725 arch='um', 726 cross_compile=None, 727 qemu_config_path=None, 728 extra_qemu_args=[]) 729 730 731 @mock.patch.object(kunit_kernel, 'LinuxSourceTree') 732 def test_run_multiple_kunitconfig(self, mock_linux_init): 733 mock_linux_init.return_value = self.linux_source_mock 734 kunit.main(['run', '--kunitconfig=mykunitconfig', '--kunitconfig=other']) 735 # Just verify that we parsed and initialized it correctly here. 736 mock_linux_init.assert_called_once_with('.kunit', 737 kunitconfig_paths=['mykunitconfig', 'other'], 738 kconfig_add=None, 739 arch='um', 740 cross_compile=None, 741 qemu_config_path=None, 742 extra_qemu_args=[]) 743 744 def test_run_kconfig_add(self): 745 kunit.main(['run', '--kconfig_add=CONFIG_KASAN=y', '--kconfig_add=CONFIG_KCSAN=y']) 746 # Just verify that we parsed and initialized it correctly here. 747 self.mock_linux_init.assert_called_once_with('.kunit', 748 kunitconfig_paths=[], 749 kconfig_add=['CONFIG_KASAN=y', 'CONFIG_KCSAN=y'], 750 arch='um', 751 cross_compile=None, 752 qemu_config_path=None, 753 extra_qemu_args=[]) 754 755 def test_run_qemu_args(self): 756 kunit.main(['run', '--arch=x86_64', '--qemu_args', '-m 2048']) 757 # Just verify that we parsed and initialized it correctly here. 758 self.mock_linux_init.assert_called_once_with('.kunit', 759 kunitconfig_paths=[], 760 kconfig_add=None, 761 arch='x86_64', 762 cross_compile=None, 763 qemu_config_path=None, 764 extra_qemu_args=['-m', '2048']) 765 766 def test_run_kernel_args(self): 767 kunit.main(['run', '--kernel_args=a=1', '--kernel_args=b=2']) 768 self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1) 769 self.linux_source_mock.run_kernel.assert_called_once_with( 770 args=['a=1','b=2'], build_dir='.kunit', filter_glob='', timeout=300) 771 self.print_mock.assert_any_call(StrContains('Testing complete.')) 772 773 def test_list_tests(self): 774 want = ['suite.test1', 'suite.test2', 'suite2.test1'] 775 self.linux_source_mock.run_kernel.return_value = ['TAP version 14', 'init: random output'] + want 776 777 got = kunit._list_tests(self.linux_source_mock, 778 kunit.KunitExecRequest(None, None, '.kunit', 300, 'suite*', None, 'suite')) 779 780 self.assertEqual(got, want) 781 # Should respect the user's filter glob when listing tests. 782 self.linux_source_mock.run_kernel.assert_called_once_with( 783 args=['kunit.action=list'], build_dir='.kunit', filter_glob='suite*', timeout=300) 784 785 786 @mock.patch.object(kunit, '_list_tests') 787 def test_run_isolated_by_suite(self, mock_tests): 788 mock_tests.return_value = ['suite.test1', 'suite.test2', 'suite2.test1'] 789 kunit.main(['exec', '--run_isolated=suite', 'suite*.test*']) 790 791 # Should respect the user's filter glob when listing tests. 792 mock_tests.assert_called_once_with(mock.ANY, 793 kunit.KunitExecRequest(None, None, '.kunit', 300, 'suite*.test*', None, 'suite')) 794 self.linux_source_mock.run_kernel.assert_has_calls([ 795 mock.call(args=None, build_dir='.kunit', filter_glob='suite.test*', timeout=300), 796 mock.call(args=None, build_dir='.kunit', filter_glob='suite2.test*', timeout=300), 797 ]) 798 799 @mock.patch.object(kunit, '_list_tests') 800 def test_run_isolated_by_test(self, mock_tests): 801 mock_tests.return_value = ['suite.test1', 'suite.test2', 'suite2.test1'] 802 kunit.main(['exec', '--run_isolated=test', 'suite*']) 803 804 # Should respect the user's filter glob when listing tests. 805 mock_tests.assert_called_once_with(mock.ANY, 806 kunit.KunitExecRequest(None, None, '.kunit', 300, 'suite*', None, 'test')) 807 self.linux_source_mock.run_kernel.assert_has_calls([ 808 mock.call(args=None, build_dir='.kunit', filter_glob='suite.test1', timeout=300), 809 mock.call(args=None, build_dir='.kunit', filter_glob='suite.test2', timeout=300), 810 mock.call(args=None, build_dir='.kunit', filter_glob='suite2.test1', timeout=300), 811 ]) 812 813 814if __name__ == '__main__': 815 unittest.main() 816