kunit_tool_test.py

  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.SUCCESS, result.status)
375		self.assertEqual(result.counts, kunit_parser.TestCounts(passed=1, errors=2))
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_run_kernel_args_not_mutated(self):
493		"""Verify run_kernel() copies args so callers can reuse them."""
494		start_calls = []
495
496		def fake_start(start_args, unused_build_dir):
497			start_calls.append(list(start_args))
498			return subprocess.Popen(['printf', 'KTAP version 1\n'],
499						text=True, stdout=subprocess.PIPE)
500
501		with tempfile.TemporaryDirectory('') as build_dir:
502			tree = kunit_kernel.LinuxSourceTree(build_dir,
503					kunitconfig_paths=[os.devnull])
504			with mock.patch.object(tree._ops, 'start', side_effect=fake_start), \
505			     mock.patch.object(kunit_kernel.subprocess, 'call'):
506				kernel_args = ['mem=1G']
507				for _ in tree.run_kernel(args=kernel_args, build_dir=build_dir,
508							 filter_glob='suite.test1'):
509					pass
510				for _ in tree.run_kernel(args=kernel_args, build_dir=build_dir,
511							 filter_glob='suite.test2'):
512					pass
513				self.assertEqual(kernel_args, ['mem=1G'],
514					'run_kernel() should not modify caller args')
515				self.assertIn('kunit.filter_glob=suite.test1', start_calls[0])
516				self.assertIn('kunit.filter_glob=suite.test2', start_calls[1])
517
518	def test_build_reconfig_no_config(self):
519		with tempfile.TemporaryDirectory('') as build_dir:
520			with open(kunit_kernel.get_kunitconfig_path(build_dir), 'w') as f:
521				f.write('CONFIG_KUNIT=y')
522
523			tree = kunit_kernel.LinuxSourceTree(build_dir)
524			# Stub out the source tree operations, so we don't have
525			# the defaults for any given architecture get in the
526			# way.
527			tree._ops = kunit_kernel.LinuxSourceTreeOperations('none', None)
528			mock_build_config = mock.patch.object(tree, 'build_config').start()
529
530			# Should generate the .config
531			self.assertTrue(tree.build_reconfig(build_dir, make_options=[]))
532			mock_build_config.assert_called_once_with(build_dir, [])
533
534	def test_build_reconfig_existing_config(self):
535		with tempfile.TemporaryDirectory('') as build_dir:
536			# Existing .config is a superset, should not touch it
537			with open(kunit_kernel.get_kunitconfig_path(build_dir), 'w') as f:
538				f.write('CONFIG_KUNIT=y')
539			with open(kunit_kernel.get_old_kunitconfig_path(build_dir), 'w') as f:
540				f.write('CONFIG_KUNIT=y')
541			with open(kunit_kernel.get_kconfig_path(build_dir), 'w') as f:
542				f.write('CONFIG_KUNIT=y\nCONFIG_KUNIT_TEST=y')
543
544			tree = kunit_kernel.LinuxSourceTree(build_dir)
545			# Stub out the source tree operations, so we don't have
546			# the defaults for any given architecture get in the
547			# way.
548			tree._ops = kunit_kernel.LinuxSourceTreeOperations('none', None)
549			mock_build_config = mock.patch.object(tree, 'build_config').start()
550
551			self.assertTrue(tree.build_reconfig(build_dir, make_options=[]))
552			self.assertEqual(mock_build_config.call_count, 0)
553
554	def test_build_reconfig_remove_option(self):
555		with tempfile.TemporaryDirectory('') as build_dir:
556			# We removed CONFIG_KUNIT_TEST=y from our .kunitconfig...
557			with open(kunit_kernel.get_kunitconfig_path(build_dir), 'w') as f:
558				f.write('CONFIG_KUNIT=y')
559			with open(kunit_kernel.get_old_kunitconfig_path(build_dir), 'w') as f:
560				f.write('CONFIG_KUNIT=y\nCONFIG_KUNIT_TEST=y')
561			with open(kunit_kernel.get_kconfig_path(build_dir), 'w') as f:
562				f.write('CONFIG_KUNIT=y\nCONFIG_KUNIT_TEST=y')
563
564			tree = kunit_kernel.LinuxSourceTree(build_dir)
565			# Stub out the source tree operations, so we don't have
566			# the defaults for any given architecture get in the
567			# way.
568			tree._ops = kunit_kernel.LinuxSourceTreeOperations('none', None)
569			mock_build_config = mock.patch.object(tree, 'build_config').start()
570
571			# ... so we should trigger a call to build_config()
572			self.assertTrue(tree.build_reconfig(build_dir, make_options=[]))
573			mock_build_config.assert_called_once_with(build_dir, [])
574
575	# TODO: add more test cases.
576
577
578class KUnitJsonTest(unittest.TestCase):
579	def setUp(self):
580		self.print_mock = mock.patch('kunit_printer.Printer.print').start()
581		self.addCleanup(mock.patch.stopall)
582
583	def _json_for(self, log_file):
584		with open(test_data_path(log_file)) as file:
585			test_result = kunit_parser.parse_run_tests(file, stdout)
586			json_obj = kunit_json.get_json_result(
587				test=test_result,
588				metadata=kunit_json.Metadata())
589		return json.loads(json_obj)
590
591	def test_failed_test_json(self):
592		result = self._json_for('test_is_test_passed-failure.log')
593		self.assertEqual(
594			{'name': 'example_simple_test', 'status': 'FAIL'},
595			result["sub_groups"][1]["test_cases"][0])
596
597	def test_crashed_test_json(self):
598		result = self._json_for('test_kernel_panic_interrupt.log')
599		self.assertEqual(
600			{'name': '', 'status': 'ERROR'},
601			result["sub_groups"][2]["test_cases"][1])
602
603	def test_skipped_test_json(self):
604		result = self._json_for('test_skip_tests.log')
605		self.assertEqual(
606			{'name': 'example_skip_test', 'status': 'SKIP'},
607			result["sub_groups"][1]["test_cases"][1])
608
609	def test_no_tests_json(self):
610		result = self._json_for('test_is_test_passed-no_tests_run_with_header.log')
611		self.assertEqual(0, len(result['sub_groups']))
612
613	def test_nested_json(self):
614		result = self._json_for('test_is_test_passed-all_passed_nested.log')
615		self.assertEqual(
616			{'name': 'example_simple_test', 'status': 'PASS'},
617			result["sub_groups"][0]["sub_groups"][0]["test_cases"][0])
618
619class StrContains(str):
620	def __eq__(self, other):
621		return self in other
622
623class KUnitMainTest(unittest.TestCase):
624	def setUp(self):
625		path = test_data_path('test_is_test_passed-all_passed.log')
626		with open(path) as file:
627			all_passed_log = file.readlines()
628
629		self.print_mock = mock.patch('kunit_printer.Printer.print').start()
630		self.addCleanup(mock.patch.stopall)
631
632		self.mock_linux_init = mock.patch.object(kunit_kernel, 'LinuxSourceTree').start()
633		self.linux_source_mock = self.mock_linux_init.return_value
634		self.linux_source_mock.build_reconfig.return_value = True
635		self.linux_source_mock.build_kernel.return_value = True
636		self.linux_source_mock.run_kernel.return_value = all_passed_log
637
638	def test_config_passes_args_pass(self):
639		kunit.main(['config', '--build_dir=.kunit'])
640		self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
641		self.assertEqual(self.linux_source_mock.run_kernel.call_count, 0)
642
643	def test_build_passes_args_pass(self):
644		kunit.main(['build'])
645		self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
646		self.linux_source_mock.build_kernel.assert_called_once_with(kunit.get_default_jobs(), '.kunit', None)
647		self.assertEqual(self.linux_source_mock.run_kernel.call_count, 0)
648
649	def test_exec_passes_args_pass(self):
650		kunit.main(['exec'])
651		self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 0)
652		self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1)
653		self.linux_source_mock.run_kernel.assert_called_once_with(
654			args=None, build_dir='.kunit', filter_glob='', filter='', filter_action=None, timeout=300)
655		self.print_mock.assert_any_call(StrContains('Testing complete.'))
656
657	def test_run_passes_args_pass(self):
658		kunit.main(['run'])
659		self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
660		self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1)
661		self.linux_source_mock.run_kernel.assert_called_once_with(
662			args=None, build_dir='.kunit', filter_glob='', filter='', filter_action=None, timeout=300)
663		self.print_mock.assert_any_call(StrContains('Testing complete.'))
664
665	def test_exec_passes_args_fail(self):
666		self.linux_source_mock.run_kernel = mock.Mock(return_value=[])
667		with self.assertRaises(SystemExit) as e:
668			kunit.main(['exec'])
669		self.assertEqual(e.exception.code, 1)
670
671	def test_run_passes_args_fail(self):
672		self.linux_source_mock.run_kernel = mock.Mock(return_value=[])
673		with self.assertRaises(SystemExit) as e:
674			kunit.main(['run'])
675		self.assertEqual(e.exception.code, 1)
676		self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
677		self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1)
678		self.print_mock.assert_any_call(StrContains('Could not find any KTAP output.'))
679
680	def test_exec_no_tests(self):
681		self.linux_source_mock.run_kernel = mock.Mock(return_value=['TAP version 14', '1..0'])
682		with self.assertRaises(SystemExit) as e:
683			kunit.main(['run'])
684		self.assertEqual(e.exception.code, 1)
685		self.linux_source_mock.run_kernel.assert_called_once_with(
686			args=None, build_dir='.kunit', filter_glob='', filter='', filter_action=None, timeout=300)
687		self.print_mock.assert_any_call(StrContains(' 0 tests run!'))
688
689	def test_exec_raw_output(self):
690		self.linux_source_mock.run_kernel = mock.Mock(return_value=[])
691		kunit.main(['exec', '--raw_output'])
692		self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1)
693		for call in self.print_mock.call_args_list:
694			self.assertNotEqual(call, mock.call(StrContains('Testing complete.')))
695			self.assertNotEqual(call, mock.call(StrContains(' 0 tests run!')))
696
697	def test_run_raw_output(self):
698		self.linux_source_mock.run_kernel = mock.Mock(return_value=[])
699		kunit.main(['run', '--raw_output'])
700		self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
701		self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1)
702		for call in self.print_mock.call_args_list:
703			self.assertNotEqual(call, mock.call(StrContains('Testing complete.')))
704			self.assertNotEqual(call, mock.call(StrContains(' 0 tests run!')))
705
706	def test_run_raw_output_kunit(self):
707		self.linux_source_mock.run_kernel = mock.Mock(return_value=[])
708		kunit.main(['run', '--raw_output=kunit'])
709		self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
710		self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1)
711		for call in self.print_mock.call_args_list:
712			self.assertNotEqual(call, mock.call(StrContains('Testing complete.')))
713			self.assertNotEqual(call, mock.call(StrContains(' 0 tests run')))
714
715	def test_run_raw_output_invalid(self):
716		self.linux_source_mock.run_kernel = mock.Mock(return_value=[])
717		with self.assertRaises(SystemExit) as e:
718			kunit.main(['run', '--raw_output=invalid'])
719		self.assertNotEqual(e.exception.code, 0)
720
721	def test_run_raw_output_does_not_take_positional_args(self):
722		# --raw_output is a string flag, but we don't want it to consume
723		# any positional arguments, only ones after an '='
724		self.linux_source_mock.run_kernel = mock.Mock(return_value=[])
725		kunit.main(['run', '--raw_output', 'filter_glob'])
726		self.linux_source_mock.run_kernel.assert_called_once_with(
727			args=None, build_dir='.kunit', filter_glob='filter_glob', filter='', filter_action=None, timeout=300)
728
729	def test_exec_timeout(self):
730		timeout = 3453
731		kunit.main(['exec', '--timeout', str(timeout)])
732		self.linux_source_mock.run_kernel.assert_called_once_with(
733			args=None, build_dir='.kunit', filter_glob='', filter='', filter_action=None, timeout=timeout)
734		self.print_mock.assert_any_call(StrContains('Testing complete.'))
735
736	def test_run_timeout(self):
737		timeout = 3453
738		kunit.main(['run', '--timeout', str(timeout)])
739		self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
740		self.linux_source_mock.run_kernel.assert_called_once_with(
741			args=None, build_dir='.kunit', filter_glob='', filter='', filter_action=None, timeout=timeout)
742		self.print_mock.assert_any_call(StrContains('Testing complete.'))
743
744	def test_run_builddir(self):
745		build_dir = '.kunit'
746		kunit.main(['run', '--build_dir=.kunit'])
747		self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
748		self.linux_source_mock.run_kernel.assert_called_once_with(
749			args=None, build_dir=build_dir, filter_glob='', filter='', filter_action=None, timeout=300)
750		self.print_mock.assert_any_call(StrContains('Testing complete.'))
751
752	def test_config_builddir(self):
753		build_dir = '.kunit'
754		kunit.main(['config', '--build_dir', build_dir])
755		self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
756
757	def test_build_builddir(self):
758		build_dir = '.kunit'
759		jobs = kunit.get_default_jobs()
760		kunit.main(['build', '--build_dir', build_dir])
761		self.linux_source_mock.build_kernel.assert_called_once_with(jobs, build_dir, None)
762
763	def test_exec_builddir(self):
764		build_dir = '.kunit'
765		kunit.main(['exec', '--build_dir', build_dir])
766		self.linux_source_mock.run_kernel.assert_called_once_with(
767			args=None, build_dir=build_dir, filter_glob='', filter='', filter_action=None, timeout=300)
768		self.print_mock.assert_any_call(StrContains('Testing complete.'))
769
770	def test_run_kunitconfig(self):
771		kunit.main(['run', '--kunitconfig=mykunitconfig'])
772		# Just verify that we parsed and initialized it correctly here.
773		self.mock_linux_init.assert_called_once_with('.kunit',
774						kunitconfig_paths=['mykunitconfig'],
775						kconfig_add=None,
776						arch='um',
777						cross_compile=None,
778						qemu_config_path=None,
779						extra_qemu_args=[])
780
781	def test_config_kunitconfig(self):
782		kunit.main(['config', '--kunitconfig=mykunitconfig'])
783		# Just verify that we parsed and initialized it correctly here.
784		self.mock_linux_init.assert_called_once_with('.kunit',
785						kunitconfig_paths=['mykunitconfig'],
786						kconfig_add=None,
787						arch='um',
788						cross_compile=None,
789						qemu_config_path=None,
790						extra_qemu_args=[])
791
792	def test_config_alltests(self):
793		kunit.main(['config', '--kunitconfig=mykunitconfig', '--alltests'])
794		# Just verify that we parsed and initialized it correctly here.
795		self.mock_linux_init.assert_called_once_with('.kunit',
796						kunitconfig_paths=[kunit_kernel.ALL_TESTS_CONFIG_PATH, 'mykunitconfig'],
797						kconfig_add=None,
798						arch='um',
799						cross_compile=None,
800						qemu_config_path=None,
801						extra_qemu_args=[])
802
803
804	@mock.patch.object(kunit_kernel, 'LinuxSourceTree')
805	def test_run_multiple_kunitconfig(self, mock_linux_init):
806		mock_linux_init.return_value = self.linux_source_mock
807		kunit.main(['run', '--kunitconfig=mykunitconfig', '--kunitconfig=other'])
808		# Just verify that we parsed and initialized it correctly here.
809		mock_linux_init.assert_called_once_with('.kunit',
810							kunitconfig_paths=['mykunitconfig', 'other'],
811							kconfig_add=None,
812							arch='um',
813							cross_compile=None,
814							qemu_config_path=None,
815							extra_qemu_args=[])
816
817	def test_run_kconfig_add(self):
818		kunit.main(['run', '--kconfig_add=CONFIG_KASAN=y', '--kconfig_add=CONFIG_KCSAN=y'])
819		# Just verify that we parsed and initialized it correctly here.
820		self.mock_linux_init.assert_called_once_with('.kunit',
821						kunitconfig_paths=[],
822						kconfig_add=['CONFIG_KASAN=y', 'CONFIG_KCSAN=y'],
823						arch='um',
824						cross_compile=None,
825						qemu_config_path=None,
826						extra_qemu_args=[])
827
828	def test_run_qemu_args(self):
829		kunit.main(['run', '--arch=x86_64', '--qemu_args', '-m 2048'])
830		# Just verify that we parsed and initialized it correctly here.
831		self.mock_linux_init.assert_called_once_with('.kunit',
832						kunitconfig_paths=[],
833						kconfig_add=None,
834						arch='x86_64',
835						cross_compile=None,
836						qemu_config_path=None,
837						extra_qemu_args=['-m', '2048'])
838
839	def test_run_kernel_args(self):
840		kunit.main(['run', '--kernel_args=a=1', '--kernel_args=b=2'])
841		self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1)
842		self.linux_source_mock.run_kernel.assert_called_once_with(
843		      args=['a=1','b=2'], build_dir='.kunit', filter_glob='', filter='', filter_action=None, timeout=300)
844		self.print_mock.assert_any_call(StrContains('Testing complete.'))
845
846	def test_list_tests(self):
847		want = ['suite.test1', 'suite.test2', 'suite2.test1']
848		self.linux_source_mock.run_kernel.return_value = ['TAP version 14', 'init: random output'] + want
849
850		got = kunit._list_tests(self.linux_source_mock,
851				     kunit.KunitExecRequest(None, None, False, False, '.kunit', 300, 'suite*', '', None, None, 'suite', False, False))
852		self.assertEqual(got, want)
853		# Should respect the user's filter glob when listing tests.
854		self.linux_source_mock.run_kernel.assert_called_once_with(
855			args=['kunit.action=list'], build_dir='.kunit', filter_glob='suite*', filter='', filter_action=None, timeout=300)
856
857	@mock.patch.object(kunit, '_list_tests')
858	def test_run_isolated_by_suite(self, mock_tests):
859		mock_tests.return_value = ['suite.test1', 'suite.test2', 'suite2.test1']
860		kunit.main(['exec', '--run_isolated=suite', 'suite*.test*'])
861
862		# Should respect the user's filter glob when listing tests.
863		mock_tests.assert_called_once_with(mock.ANY,
864				     kunit.KunitExecRequest(None, None, False, False, '.kunit', 300, 'suite*.test*', '', None, None, 'suite', False, False))
865		self.linux_source_mock.run_kernel.assert_has_calls([
866			mock.call(args=None, build_dir='.kunit', filter_glob='suite.test*', filter='', filter_action=None, timeout=300),
867			mock.call(args=None, build_dir='.kunit', filter_glob='suite2.test*', filter='', filter_action=None, timeout=300),
868		])
869
870	@mock.patch.object(kunit, '_list_tests')
871	def test_run_isolated_by_test(self, mock_tests):
872		mock_tests.return_value = ['suite.test1', 'suite.test2', 'suite2.test1']
873		kunit.main(['exec', '--run_isolated=test', 'suite*'])
874
875		# Should respect the user's filter glob when listing tests.
876		mock_tests.assert_called_once_with(mock.ANY,
877				     kunit.KunitExecRequest(None, None, False, False, '.kunit', 300, 'suite*', '', None, None, 'test', False, False))
878		self.linux_source_mock.run_kernel.assert_has_calls([
879			mock.call(args=None, build_dir='.kunit', filter_glob='suite.test1', filter='', filter_action=None, timeout=300),
880			mock.call(args=None, build_dir='.kunit', filter_glob='suite.test2', filter='', filter_action=None, timeout=300),
881			mock.call(args=None, build_dir='.kunit', filter_glob='suite2.test1', filter='', filter_action=None, timeout=300),
882		])
883
884if __name__ == '__main__':
885	unittest.main()