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