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