kunit_tool_test.py 30 KB

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