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