2020-11-23 17:15:33 +03:00
#!/usr/bin/env python3
2019-09-23 12:02:43 +03:00
# SPDX-License-Identifier: GPL-2.0
#
# A collection of tests for tools/testing/kunit/kunit.py
#
# Copyright (C) 2019, Google LLC.
# Author: Brendan Higgins <brendanhiggins@google.com>
import unittest
from unittest import mock
import tempfile , shutil # Handling test_tmpdir
2021-05-26 11:22:17 +03:00
import itertools
2020-08-12 00:27:56 +03:00
import json
2021-10-08 00:14:17 +03:00
import os
2021-02-01 23:55:14 +03:00
import signal
2021-10-05 04:13:40 +03:00
import subprocess
2021-10-08 00:14:17 +03:00
from typing import Iterable
2019-09-23 12:02:43 +03:00
import kunit_config
import kunit_parser
import kunit_kernel
2020-08-12 00:27:56 +03:00
import kunit_json
2019-09-23 12:02:43 +03:00
import kunit
test_tmpdir = ' '
2020-12-02 22:08:24 +03:00
abs_test_data_dir = ' '
2019-09-23 12:02:43 +03:00
def setUpModule ( ) :
2020-12-02 22:08:24 +03:00
global test_tmpdir , abs_test_data_dir
2019-09-23 12:02:43 +03:00
test_tmpdir = tempfile . mkdtemp ( )
2020-12-02 22:08:24 +03:00
abs_test_data_dir = os . path . abspath ( os . path . join ( os . path . dirname ( __file__ ) , ' test_data ' ) )
2019-09-23 12:02:43 +03:00
def tearDownModule ( ) :
shutil . rmtree ( test_tmpdir )
2020-12-02 22:08:24 +03:00
def test_data_path ( path ) :
return os . path . join ( abs_test_data_dir , path )
2019-09-23 12:02:43 +03:00
class KconfigTest ( unittest . TestCase ) :
def test_is_subset_of ( self ) :
kconfig0 = kunit_config . Kconfig ( )
self . assertTrue ( kconfig0 . is_subset_of ( kconfig0 ) )
kconfig1 = kunit_config . Kconfig ( )
2020-03-24 05:43:33 +03:00
kconfig1 . add_entry ( kunit_config . KconfigEntry ( ' TEST ' , ' y ' ) )
2019-09-23 12:02:43 +03:00
self . assertTrue ( kconfig1 . is_subset_of ( kconfig1 ) )
self . assertTrue ( kconfig0 . is_subset_of ( kconfig1 ) )
self . assertFalse ( kconfig1 . is_subset_of ( kconfig0 ) )
def test_read_from_file ( self ) :
2020-12-02 22:08:24 +03:00
kconfig_path = test_data_path ( ' test_read_from_file.kconfig ' )
2019-09-23 12:02:43 +03:00
2021-11-06 04:30:57 +03:00
kconfig = kunit_config . parse_file ( kconfig_path )
2019-09-23 12:02:43 +03:00
expected_kconfig = kunit_config . Kconfig ( )
expected_kconfig . add_entry (
2020-03-24 05:43:33 +03:00
kunit_config . KconfigEntry ( ' UML ' , ' y ' ) )
2019-09-23 12:02:43 +03:00
expected_kconfig . add_entry (
2020-03-24 05:43:33 +03:00
kunit_config . KconfigEntry ( ' MMU ' , ' y ' ) )
2019-09-23 12:02:43 +03:00
expected_kconfig . add_entry (
2020-03-24 05:43:33 +03:00
kunit_config . KconfigEntry ( ' TEST ' , ' y ' ) )
2019-09-23 12:02:43 +03:00
expected_kconfig . add_entry (
2020-03-24 05:43:33 +03:00
kunit_config . KconfigEntry ( ' EXAMPLE_TEST ' , ' y ' ) )
2019-09-23 12:02:43 +03:00
expected_kconfig . add_entry (
2020-03-24 05:43:33 +03:00
kunit_config . KconfigEntry ( ' MK8 ' , ' n ' ) )
2019-09-23 12:02:43 +03:00
self . assertEqual ( kconfig . entries ( ) , expected_kconfig . entries ( ) )
def test_write_to_file ( self ) :
kconfig_path = os . path . join ( test_tmpdir , ' .config ' )
expected_kconfig = kunit_config . Kconfig ( )
expected_kconfig . add_entry (
2020-03-24 05:43:33 +03:00
kunit_config . KconfigEntry ( ' UML ' , ' y ' ) )
2019-09-23 12:02:43 +03:00
expected_kconfig . add_entry (
2020-03-24 05:43:33 +03:00
kunit_config . KconfigEntry ( ' MMU ' , ' y ' ) )
2019-09-23 12:02:43 +03:00
expected_kconfig . add_entry (
2020-03-24 05:43:33 +03:00
kunit_config . KconfigEntry ( ' TEST ' , ' y ' ) )
2019-09-23 12:02:43 +03:00
expected_kconfig . add_entry (
2020-03-24 05:43:33 +03:00
kunit_config . KconfigEntry ( ' EXAMPLE_TEST ' , ' y ' ) )
2019-09-23 12:02:43 +03:00
expected_kconfig . add_entry (
2020-03-24 05:43:33 +03:00
kunit_config . KconfigEntry ( ' MK8 ' , ' n ' ) )
2019-09-23 12:02:43 +03:00
expected_kconfig . write_to_file ( kconfig_path )
2021-11-06 04:30:57 +03:00
actual_kconfig = kunit_config . parse_file ( kconfig_path )
2019-09-23 12:02:43 +03:00
self . assertEqual ( actual_kconfig . entries ( ) ,
expected_kconfig . entries ( ) )
class KUnitParserTest ( unittest . TestCase ) :
2021-05-26 11:22:17 +03:00
def assertContains ( self , needle : str , haystack : kunit_parser . LineStream ) :
# Clone the iterator so we can print the contents on failure.
copy , backup = itertools . tee ( haystack )
for line in copy :
2019-09-23 12:02:43 +03:00
if needle in line :
return
2021-05-26 11:22:17 +03:00
raise AssertionError ( f ' " { needle } " not found in { list ( backup ) } ! ' )
2019-09-23 12:02:43 +03:00
def test_output_isolated_correctly ( self ) :
2020-12-02 22:08:24 +03:00
log_path = test_data_path ( ' test_output_isolated_correctly.log ' )
2020-12-02 22:08:23 +03:00
with open ( log_path ) as file :
2021-05-26 11:22:17 +03:00
result = kunit_parser . extract_tap_lines ( file . readlines ( ) )
2020-10-31 01:38:53 +03:00
self . assertContains ( ' TAP version 14 ' , result )
2021-10-12 00:50:37 +03:00
self . assertContains ( ' # Subtest: example ' , result )
self . assertContains ( ' 1..2 ' , result )
self . assertContains ( ' ok 1 - example_simple_test ' , result )
self . assertContains ( ' ok 2 - example_mock_test ' , result )
2019-09-23 12:02:43 +03:00
self . assertContains ( ' ok 1 - example ' , result )
2020-03-16 23:21:24 +03:00
def test_output_with_prefix_isolated_correctly ( self ) :
2020-12-02 22:08:24 +03:00
log_path = test_data_path ( ' test_pound_sign.log ' )
2020-03-16 23:21:24 +03:00
with open ( log_path ) as file :
2021-05-26 11:22:17 +03:00
result = kunit_parser . extract_tap_lines ( file . readlines ( ) )
2020-10-31 01:38:53 +03:00
self . assertContains ( ' TAP version 14 ' , result )
2021-10-12 00:50:37 +03:00
self . assertContains ( ' # Subtest: kunit-resource-test ' , result )
self . assertContains ( ' 1..5 ' , result )
self . assertContains ( ' ok 1 - kunit_resource_test_init_resources ' , result )
self . assertContains ( ' ok 2 - kunit_resource_test_alloc_resource ' , result )
self . assertContains ( ' ok 3 - kunit_resource_test_destroy_resource ' , result )
self . assertContains ( ' foo bar # ' , result )
self . assertContains ( ' ok 4 - kunit_resource_test_cleanup_resources ' , result )
self . assertContains ( ' ok 5 - kunit_resource_test_proper_free_ordering ' , result )
2020-03-16 23:21:24 +03:00
self . assertContains ( ' ok 1 - kunit-resource-test ' , result )
2021-10-12 00:50:37 +03:00
self . assertContains ( ' foo bar # non-kunit output ' , result )
self . assertContains ( ' # Subtest: kunit-try-catch-test ' , result )
self . assertContains ( ' 1..2 ' , result )
self . assertContains ( ' ok 1 - kunit_test_try_catch_successful_try_no_catch ' ,
2020-03-16 23:21:24 +03:00
result )
2021-10-12 00:50:37 +03:00
self . assertContains ( ' ok 2 - kunit_test_try_catch_unsuccessful_try_does_catch ' ,
2020-03-16 23:21:24 +03:00
result )
self . assertContains ( ' ok 2 - kunit-try-catch-test ' , result )
2021-10-12 00:50:37 +03:00
self . assertContains ( ' # Subtest: string-stream-test ' , result )
self . assertContains ( ' 1..3 ' , result )
self . assertContains ( ' ok 1 - string_stream_test_empty_on_creation ' , result )
self . assertContains ( ' ok 2 - string_stream_test_not_empty_after_add ' , result )
self . assertContains ( ' ok 3 - string_stream_test_get_string ' , result )
2020-03-16 23:21:24 +03:00
self . assertContains ( ' ok 3 - string-stream-test ' , result )
2019-09-23 12:02:43 +03:00
def test_parse_successful_test_log ( self ) :
2020-12-02 22:08:24 +03:00
all_passed_log = test_data_path ( ' test_is_test_passed-all_passed.log ' )
2020-12-02 22:08:23 +03:00
with open ( all_passed_log ) as file :
result = kunit_parser . parse_run_tests ( file . readlines ( ) )
2019-09-23 12:02:43 +03:00
self . assertEqual (
kunit_parser . TestStatus . SUCCESS ,
result . status )
2021-10-12 00:50:37 +03:00
def test_parse_successful_nested_tests_log ( self ) :
all_passed_log = test_data_path ( ' test_is_test_passed-all_passed_nested.log ' )
with open ( all_passed_log ) as file :
result = kunit_parser . parse_run_tests ( file . readlines ( ) )
self . assertEqual (
kunit_parser . TestStatus . SUCCESS ,
result . status )
def test_kselftest_nested ( self ) :
kselftest_log = test_data_path ( ' test_is_test_passed-kselftest.log ' )
with open ( kselftest_log ) as file :
result = kunit_parser . parse_run_tests ( file . readlines ( ) )
self . assertEqual (
kunit_parser . TestStatus . SUCCESS ,
result . status )
2019-09-23 12:02:43 +03:00
def test_parse_failed_test_log ( self ) :
2020-12-02 22:08:24 +03:00
failed_log = test_data_path ( ' test_is_test_passed-failure.log ' )
2020-12-02 22:08:23 +03:00
with open ( failed_log ) as file :
result = kunit_parser . parse_run_tests ( file . readlines ( ) )
2019-09-23 12:02:43 +03:00
self . assertEqual (
kunit_parser . TestStatus . FAILURE ,
result . status )
2021-07-01 20:52:31 +03:00
def test_no_header ( self ) :
empty_log = test_data_path ( ' test_is_test_passed-no_tests_run_no_header.log ' )
with open ( empty_log ) as file :
result = kunit_parser . parse_run_tests (
kunit_parser . extract_tap_lines ( file . readlines ( ) ) )
2021-12-14 22:26:12 +03:00
self . assertEqual ( 0 , len ( result . subtests ) )
2021-07-01 20:52:31 +03:00
self . assertEqual (
kunit_parser . TestStatus . FAILURE_TO_PARSE_TESTS ,
result . status )
2021-10-12 00:50:37 +03:00
def test_missing_test_plan ( self ) :
missing_plan_log = test_data_path ( ' test_is_test_passed- '
' missing_plan.log ' )
with open ( missing_plan_log ) as file :
result = kunit_parser . parse_run_tests (
kunit_parser . extract_tap_lines (
file . readlines ( ) ) )
2021-11-02 10:30:11 +03:00
# A missing test plan is not an error.
2021-12-14 22:26:12 +03:00
self . assertEqual ( 0 , result . counts . errors )
2021-11-02 10:30:11 +03:00
# All tests should be accounted for.
2021-12-14 22:26:12 +03:00
self . assertEqual ( 10 , result . counts . total ( ) )
2021-10-12 00:50:37 +03:00
self . assertEqual (
kunit_parser . TestStatus . SUCCESS ,
result . status )
2019-09-23 12:02:43 +03:00
def test_no_tests ( self ) :
2021-10-12 00:50:37 +03:00
header_log = test_data_path ( ' test_is_test_passed-no_tests_run_with_header.log ' )
with open ( header_log ) as file :
2020-12-02 22:08:23 +03:00
result = kunit_parser . parse_run_tests (
2021-05-26 11:22:17 +03:00
kunit_parser . extract_tap_lines ( file . readlines ( ) ) )
2021-12-14 22:26:12 +03:00
self . assertEqual ( 0 , len ( result . subtests ) )
2019-09-23 12:02:43 +03:00
self . assertEqual (
kunit_parser . TestStatus . NO_TESTS ,
result . status )
2021-11-02 10:30:12 +03:00
def test_no_tests_no_plan ( self ) :
no_plan_log = test_data_path ( ' test_is_test_passed-no_tests_no_plan.log ' )
with open ( no_plan_log ) as file :
result = kunit_parser . parse_run_tests (
kunit_parser . extract_tap_lines ( file . readlines ( ) ) )
2021-12-14 22:26:12 +03:00
self . assertEqual ( 0 , len ( result . subtests [ 0 ] . subtests [ 0 ] . subtests ) )
2021-11-02 10:30:12 +03:00
self . assertEqual (
kunit_parser . TestStatus . NO_TESTS ,
2021-12-14 22:26:12 +03:00
result . subtests [ 0 ] . subtests [ 0 ] . status )
self . assertEqual ( 1 , result . counts . errors )
2021-11-02 10:30:12 +03:00
2020-06-12 00:05:45 +03:00
def test_no_kunit_output ( self ) :
2020-12-02 22:08:24 +03:00
crash_log = test_data_path ( ' test_insufficient_memory.log ' )
2020-06-12 00:05:45 +03:00
print_mock = mock . patch ( ' builtins.print ' ) . start ( )
2020-12-02 22:08:23 +03:00
with open ( crash_log ) as file :
result = kunit_parser . parse_run_tests (
2021-05-26 11:22:17 +03:00
kunit_parser . extract_tap_lines ( file . readlines ( ) ) )
2021-10-12 00:50:37 +03:00
print_mock . assert_any_call ( StrContains ( ' invalid KTAP input! ' ) )
2020-06-12 00:05:45 +03:00
print_mock . stop ( )
2021-12-14 22:26:12 +03:00
self . assertEqual ( 0 , len ( result . subtests ) )
2020-06-12 00:05:45 +03:00
2019-09-23 12:02:43 +03:00
def test_crashed_test ( self ) :
2020-12-02 22:08:24 +03:00
crashed_log = test_data_path ( ' test_is_test_passed-crash.log ' )
2020-12-02 22:08:23 +03:00
with open ( crashed_log ) as file :
2021-10-12 00:50:37 +03:00
result = kunit_parser . parse_run_tests (
file . readlines ( ) )
2019-09-23 12:02:43 +03:00
self . assertEqual (
kunit_parser . TestStatus . TEST_CRASHED ,
result . status )
2021-06-25 09:58:13 +03:00
def test_skipped_test ( self ) :
skipped_log = test_data_path ( ' test_skip_tests.log ' )
2021-09-29 01:11:11 +03:00
with open ( skipped_log ) as file :
result = kunit_parser . parse_run_tests ( file . readlines ( ) )
2021-06-25 09:58:13 +03:00
# A skipped test does not fail the whole suite.
self . assertEqual (
kunit_parser . TestStatus . SUCCESS ,
result . status )
def test_skipped_all_tests ( self ) :
skipped_log = test_data_path ( ' test_skip_all_tests.log ' )
2021-09-29 01:11:11 +03:00
with open ( skipped_log ) as file :
result = kunit_parser . parse_run_tests ( file . readlines ( ) )
2021-06-25 09:58:13 +03:00
self . assertEqual (
kunit_parser . TestStatus . SKIPPED ,
result . status )
2021-10-12 00:50:37 +03:00
def test_ignores_hyphen ( self ) :
hyphen_log = test_data_path ( ' test_strip_hyphen.log ' )
file = open ( hyphen_log )
result = kunit_parser . parse_run_tests ( file . readlines ( ) )
# A skipped test does not fail the whole suite.
self . assertEqual (
kunit_parser . TestStatus . SUCCESS ,
result . status )
self . assertEqual (
" sysctl_test " ,
2021-12-14 22:26:12 +03:00
result . subtests [ 0 ] . name )
2021-10-12 00:50:37 +03:00
self . assertEqual (
" example " ,
2021-12-14 22:26:12 +03:00
result . subtests [ 1 ] . name )
2021-10-12 00:50:37 +03:00
file . close ( )
2021-06-25 09:58:13 +03:00
2020-03-16 23:21:24 +03:00
def test_ignores_prefix_printk_time ( self ) :
2020-12-02 22:08:24 +03:00
prefix_log = test_data_path ( ' test_config_printk_time.log ' )
2020-03-16 23:21:24 +03:00
with open ( prefix_log ) as file :
result = kunit_parser . parse_run_tests ( file . readlines ( ) )
2020-10-21 23:39:14 +03:00
self . assertEqual (
kunit_parser . TestStatus . SUCCESS ,
result . status )
2021-12-14 22:26:12 +03:00
self . assertEqual ( ' kunit-resource-test ' , result . subtests [ 0 ] . name )
2020-03-16 23:21:24 +03:00
def test_ignores_multiple_prefixes ( self ) :
2020-12-02 22:08:24 +03:00
prefix_log = test_data_path ( ' test_multiple_prefixes.log ' )
2020-03-16 23:21:24 +03:00
with open ( prefix_log ) as file :
result = kunit_parser . parse_run_tests ( file . readlines ( ) )
2020-10-21 23:39:14 +03:00
self . assertEqual (
kunit_parser . TestStatus . SUCCESS ,
result . status )
2021-12-14 22:26:12 +03:00
self . assertEqual ( ' kunit-resource-test ' , result . subtests [ 0 ] . name )
2020-03-16 23:21:24 +03:00
def test_prefix_mixed_kernel_output ( self ) :
2020-12-02 22:08:24 +03:00
mixed_prefix_log = test_data_path ( ' test_interrupted_tap_output.log ' )
2020-03-16 23:21:24 +03:00
with open ( mixed_prefix_log ) as file :
result = kunit_parser . parse_run_tests ( file . readlines ( ) )
2020-10-21 23:39:14 +03:00
self . assertEqual (
kunit_parser . TestStatus . SUCCESS ,
result . status )
2021-12-14 22:26:12 +03:00
self . assertEqual ( ' kunit-resource-test ' , result . subtests [ 0 ] . name )
2020-03-16 23:21:24 +03:00
def test_prefix_poundsign ( self ) :
2020-12-02 22:08:24 +03:00
pound_log = test_data_path ( ' test_pound_sign.log ' )
2020-03-16 23:21:24 +03:00
with open ( pound_log ) as file :
result = kunit_parser . parse_run_tests ( file . readlines ( ) )
2020-10-21 23:39:14 +03:00
self . assertEqual (
kunit_parser . TestStatus . SUCCESS ,
result . status )
2021-12-14 22:26:12 +03:00
self . assertEqual ( ' kunit-resource-test ' , result . subtests [ 0 ] . name )
2020-03-16 23:21:24 +03:00
def test_kernel_panic_end ( self ) :
2020-12-02 22:08:24 +03:00
panic_log = test_data_path ( ' test_kernel_panic_interrupt.log ' )
2020-03-16 23:21:24 +03:00
with open ( panic_log ) as file :
result = kunit_parser . parse_run_tests ( file . readlines ( ) )
2020-10-21 23:39:14 +03:00
self . assertEqual (
kunit_parser . TestStatus . TEST_CRASHED ,
result . status )
2021-12-14 22:26:12 +03:00
self . assertEqual ( ' kunit-resource-test ' , result . subtests [ 0 ] . name )
2020-03-16 23:21:24 +03:00
def test_pound_no_prefix ( self ) :
2020-12-02 22:08:24 +03:00
pound_log = test_data_path ( ' test_pound_no_prefix.log ' )
2020-03-16 23:21:24 +03:00
with open ( pound_log ) as file :
result = kunit_parser . parse_run_tests ( file . readlines ( ) )
2020-10-21 23:39:14 +03:00
self . assertEqual (
kunit_parser . TestStatus . SUCCESS ,
result . status )
2021-12-14 22:26:12 +03:00
self . assertEqual ( ' kunit-resource-test ' , result . subtests [ 0 ] . name )
2020-03-16 23:21:24 +03:00
2021-10-08 00:14:17 +03:00
def line_stream_from_strs ( strs : Iterable [ str ] ) - > kunit_parser . LineStream :
return kunit_parser . LineStream ( enumerate ( strs , start = 1 ) )
class LineStreamTest ( unittest . TestCase ) :
def test_basic ( self ) :
stream = line_stream_from_strs ( [ ' hello ' , ' world ' ] )
self . assertTrue ( stream , msg = ' Should be more input ' )
self . assertEqual ( stream . line_number ( ) , 1 )
self . assertEqual ( stream . peek ( ) , ' hello ' )
self . assertEqual ( stream . pop ( ) , ' hello ' )
self . assertTrue ( stream , msg = ' Should be more input ' )
self . assertEqual ( stream . line_number ( ) , 2 )
self . assertEqual ( stream . peek ( ) , ' world ' )
self . assertEqual ( stream . pop ( ) , ' world ' )
self . assertFalse ( stream , msg = ' Should be no more input ' )
with self . assertRaisesRegex ( ValueError , ' LineStream: going past EOF ' ) :
stream . pop ( )
def test_is_lazy ( self ) :
called_times = 0
def generator ( ) :
nonlocal called_times
for i in range ( 1 , 5 ) :
called_times + = 1
yield called_times , str ( called_times )
stream = kunit_parser . LineStream ( generator ( ) )
self . assertEqual ( called_times , 0 )
self . assertEqual ( stream . pop ( ) , ' 1 ' )
self . assertEqual ( called_times , 1 )
self . assertEqual ( stream . pop ( ) , ' 2 ' )
self . assertEqual ( called_times , 2 )
2021-02-01 23:55:14 +03:00
class LinuxSourceTreeTest ( unittest . TestCase ) :
def setUp ( self ) :
mock . patch . object ( signal , ' signal ' ) . start ( )
self . addCleanup ( mock . patch . stopall )
def test_invalid_kunitconfig ( self ) :
with self . assertRaisesRegex ( kunit_kernel . ConfigError , ' nonexistent.* does not exist ' ) :
kunit_kernel . LinuxSourceTree ( ' ' , kunitconfig_path = ' /nonexistent_file ' )
def test_valid_kunitconfig ( self ) :
with tempfile . NamedTemporaryFile ( ' wt ' ) as kunitconfig :
2021-09-29 01:11:11 +03:00
kunit_kernel . LinuxSourceTree ( ' ' , kunitconfig_path = kunitconfig . name )
2021-02-01 23:55:14 +03:00
2021-02-23 01:52:41 +03:00
def test_dir_kunitconfig ( self ) :
with tempfile . TemporaryDirectory ( ' ' ) as dir :
2021-09-29 01:11:11 +03:00
with open ( os . path . join ( dir , ' .kunitconfig ' ) , ' w ' ) :
2021-02-23 01:52:41 +03:00
pass
2021-09-29 01:11:11 +03:00
kunit_kernel . LinuxSourceTree ( ' ' , kunitconfig_path = dir )
2021-02-23 01:52:41 +03:00
2021-11-06 04:30:58 +03:00
def test_kconfig_add ( self ) :
tree = kunit_kernel . LinuxSourceTree ( ' ' , kconfig_add = [ ' CONFIG_NOT_REAL=y ' ] )
self . assertIn ( kunit_config . KconfigEntry ( ' NOT_REAL ' , ' y ' ) , tree . _kconfig . entries ( ) )
kunit: tool: show list of valid --arch options when invalid
Consider this attempt to run KUnit in QEMU:
$ ./tools/testing/kunit/kunit.py run --arch=x86
Before you'd get this error message:
kunit_kernel.ConfigError: x86 is not a valid arch
After:
kunit_kernel.ConfigError: x86 is not a valid arch, options are ['alpha', 'arm', 'arm64', 'i386', 'powerpc', 'riscv', 's390', 'sparc', 'x86_64']
This should make it a bit easier for people to notice when they make
typos, etc. Currently, one would have to dive into the python code to
figure out what the valid set is.
Signed-off-by: Daniel Latypov <dlatypov@google.com>
Reviewed-by: David Gow <davidgow@google.com>
Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
2021-09-30 02:25:34 +03:00
def test_invalid_arch ( self ) :
with self . assertRaisesRegex ( kunit_kernel . ConfigError , ' not a valid arch, options are.*x86_64 ' ) :
kunit_kernel . LinuxSourceTree ( ' ' , arch = ' invalid ' )
2021-10-05 04:13:40 +03:00
def test_run_kernel_hits_exception ( self ) :
def fake_start ( unused_args , unused_build_dir ) :
return subprocess . Popen ( [ ' echo " hi \n bye " ' ] , shell = True , text = True , stdout = subprocess . PIPE )
with tempfile . TemporaryDirectory ( ' ' ) as build_dir :
tree = kunit_kernel . LinuxSourceTree ( build_dir , load_config = False )
mock . patch . object ( tree . _ops , ' start ' , side_effect = fake_start ) . start ( )
with self . assertRaises ( ValueError ) :
for line in tree . run_kernel ( build_dir = build_dir ) :
self . assertEqual ( line , ' hi \n ' )
raise ValueError ( ' uh oh, did not read all output ' )
with open ( kunit_kernel . get_outfile_path ( build_dir ) , ' rt ' ) as outfile :
self . assertEqual ( outfile . read ( ) , ' hi \n bye \n ' , msg = ' Missing some output ' )
2021-11-20 02:23:16 +03:00
def test_build_reconfig_no_config ( self ) :
with tempfile . TemporaryDirectory ( ' ' ) as build_dir :
with open ( kunit_kernel . get_kunitconfig_path ( build_dir ) , ' w ' ) as f :
f . write ( ' CONFIG_KUNIT=y ' )
tree = kunit_kernel . LinuxSourceTree ( build_dir )
mock_build_config = mock . patch . object ( tree , ' build_config ' ) . start ( )
# Should generate the .config
self . assertTrue ( tree . build_reconfig ( build_dir , make_options = [ ] ) )
mock_build_config . assert_called_once_with ( build_dir , [ ] )
def test_build_reconfig_existing_config ( self ) :
with tempfile . TemporaryDirectory ( ' ' ) as build_dir :
# Existing .config is a superset, should not touch it
with open ( kunit_kernel . get_kunitconfig_path ( build_dir ) , ' w ' ) as f :
f . write ( ' CONFIG_KUNIT=y ' )
with open ( kunit_kernel . get_old_kunitconfig_path ( build_dir ) , ' w ' ) as f :
f . write ( ' CONFIG_KUNIT=y ' )
with open ( kunit_kernel . get_kconfig_path ( build_dir ) , ' w ' ) as f :
f . write ( ' CONFIG_KUNIT=y \n CONFIG_KUNIT_TEST=y ' )
tree = kunit_kernel . LinuxSourceTree ( build_dir )
mock_build_config = mock . patch . object ( tree , ' build_config ' ) . start ( )
self . assertTrue ( tree . build_reconfig ( build_dir , make_options = [ ] ) )
self . assertEqual ( mock_build_config . call_count , 0 )
def test_build_reconfig_remove_option ( self ) :
with tempfile . TemporaryDirectory ( ' ' ) as build_dir :
# We removed CONFIG_KUNIT_TEST=y from our .kunitconfig...
with open ( kunit_kernel . get_kunitconfig_path ( build_dir ) , ' w ' ) as f :
f . write ( ' CONFIG_KUNIT=y ' )
with open ( kunit_kernel . get_old_kunitconfig_path ( build_dir ) , ' w ' ) as f :
f . write ( ' CONFIG_KUNIT=y \n CONFIG_KUNIT_TEST=y ' )
with open ( kunit_kernel . get_kconfig_path ( build_dir ) , ' w ' ) as f :
f . write ( ' CONFIG_KUNIT=y \n CONFIG_KUNIT_TEST=y ' )
tree = kunit_kernel . LinuxSourceTree ( build_dir )
mock_build_config = mock . patch . object ( tree , ' build_config ' ) . start ( )
# ... so we should trigger a call to build_config()
self . assertTrue ( tree . build_reconfig ( build_dir , make_options = [ ] ) )
mock_build_config . assert_called_once_with ( build_dir , [ ] )
2021-02-01 23:55:14 +03:00
# TODO: add more test cases.
2020-08-12 00:27:56 +03:00
class KUnitJsonTest ( unittest . TestCase ) :
def _json_for ( self , log_file ) :
2020-12-02 22:08:24 +03:00
with open ( test_data_path ( log_file ) ) as file :
2020-08-12 00:27:56 +03:00
test_result = kunit_parser . parse_run_tests ( file )
json_obj = kunit_json . get_json_result (
2021-12-14 22:26:12 +03:00
test = test_result ,
2020-08-12 00:27:56 +03:00
def_config = ' kunit_defconfig ' ,
build_dir = None ,
json_path = ' stdout ' )
return json . loads ( json_obj )
def test_failed_test_json ( self ) :
2020-12-02 22:08:24 +03:00
result = self . _json_for ( ' test_is_test_passed-failure.log ' )
2020-08-12 00:27:56 +03:00
self . assertEqual (
{ ' name ' : ' example_simple_test ' , ' status ' : ' FAIL ' } ,
result [ " sub_groups " ] [ 1 ] [ " test_cases " ] [ 0 ] )
def test_crashed_test_json ( self ) :
2020-12-02 22:08:24 +03:00
result = self . _json_for ( ' test_is_test_passed-crash.log ' )
2020-08-12 00:27:56 +03:00
self . assertEqual (
{ ' name ' : ' example_simple_test ' , ' status ' : ' ERROR ' } ,
result [ " sub_groups " ] [ 1 ] [ " test_cases " ] [ 0 ] )
2021-10-09 02:24:21 +03:00
def test_skipped_test_json ( self ) :
result = self . _json_for ( ' test_skip_tests.log ' )
self . assertEqual (
{ ' name ' : ' example_skip_test ' , ' status ' : ' SKIP ' } ,
result [ " sub_groups " ] [ 1 ] [ " test_cases " ] [ 1 ] )
2020-08-12 00:27:56 +03:00
def test_no_tests_json ( self ) :
2021-07-01 20:52:31 +03:00
result = self . _json_for ( ' test_is_test_passed-no_tests_run_with_header.log ' )
2020-08-12 00:27:56 +03:00
self . assertEqual ( 0 , len ( result [ ' sub_groups ' ] ) )
2021-10-12 00:50:37 +03:00
def test_nested_json ( self ) :
result = self . _json_for ( ' test_is_test_passed-all_passed_nested.log ' )
self . assertEqual (
{ ' name ' : ' example_simple_test ' , ' status ' : ' PASS ' } ,
result [ " sub_groups " ] [ 0 ] [ " sub_groups " ] [ 0 ] [ " test_cases " ] [ 0 ] )
2019-09-23 12:02:43 +03:00
class StrContains ( str ) :
def __eq__ ( self , other ) :
return self in other
class KUnitMainTest ( unittest . TestCase ) :
def setUp ( self ) :
2020-12-02 22:08:24 +03:00
path = test_data_path ( ' test_is_test_passed-all_passed.log ' )
2020-12-02 22:08:21 +03:00
with open ( path ) as file :
all_passed_log = file . readlines ( )
self . print_mock = mock . patch ( ' builtins.print ' ) . start ( )
self . addCleanup ( mock . patch . stopall )
2019-09-23 12:02:43 +03:00
self . linux_source_mock = mock . Mock ( )
self . linux_source_mock . build_reconfig = mock . Mock ( return_value = True )
2021-05-27 00:24:06 +03:00
self . linux_source_mock . build_kernel = mock . Mock ( return_value = True )
2019-09-23 12:02:43 +03:00
self . linux_source_mock . run_kernel = mock . Mock ( return_value = all_passed_log )
2020-05-01 07:27:01 +03:00
def test_config_passes_args_pass ( self ) :
2020-07-14 23:41:30 +03:00
kunit . main ( [ ' config ' , ' --build_dir=.kunit ' ] , self . linux_source_mock )
2020-12-02 22:08:22 +03:00
self . assertEqual ( self . linux_source_mock . build_reconfig . call_count , 1 )
self . assertEqual ( self . linux_source_mock . run_kernel . call_count , 0 )
2020-05-01 07:27:01 +03:00
def test_build_passes_args_pass ( self ) :
kunit . main ( [ ' build ' ] , self . linux_source_mock )
2021-12-14 22:30:10 +03:00
self . assertEqual ( self . linux_source_mock . build_reconfig . call_count , 1 )
2021-05-27 00:24:06 +03:00
self . linux_source_mock . build_kernel . assert_called_once_with ( False , 8 , ' .kunit ' , None )
2020-12-02 22:08:22 +03:00
self . assertEqual ( self . linux_source_mock . run_kernel . call_count , 0 )
2020-05-01 07:27:01 +03:00
def test_exec_passes_args_pass ( self ) :
kunit . main ( [ ' exec ' ] , self . linux_source_mock )
2020-12-02 22:08:22 +03:00
self . assertEqual ( self . linux_source_mock . build_reconfig . call_count , 0 )
self . assertEqual ( self . linux_source_mock . run_kernel . call_count , 1 )
2021-02-06 03:08:53 +03:00
self . linux_source_mock . run_kernel . assert_called_once_with (
2021-07-15 19:08:19 +03:00
args = None , build_dir = ' .kunit ' , filter_glob = ' ' , timeout = 300 )
2020-05-01 07:27:01 +03:00
self . print_mock . assert_any_call ( StrContains ( ' Testing complete. ' ) )
2019-09-23 12:02:43 +03:00
def test_run_passes_args_pass ( self ) :
kunit . main ( [ ' run ' ] , self . linux_source_mock )
2020-12-02 22:08:22 +03:00
self . assertEqual ( self . linux_source_mock . build_reconfig . call_count , 1 )
self . assertEqual ( self . linux_source_mock . run_kernel . call_count , 1 )
2020-03-16 23:21:25 +03:00
self . linux_source_mock . run_kernel . assert_called_once_with (
2021-07-15 19:08:19 +03:00
args = None , build_dir = ' .kunit ' , filter_glob = ' ' , timeout = 300 )
2019-09-23 12:02:43 +03:00
self . print_mock . assert_any_call ( StrContains ( ' Testing complete. ' ) )
2020-05-01 07:27:01 +03:00
def test_exec_passes_args_fail ( self ) :
self . linux_source_mock . run_kernel = mock . Mock ( return_value = [ ] )
with self . assertRaises ( SystemExit ) as e :
kunit . main ( [ ' exec ' ] , self . linux_source_mock )
2020-12-02 22:08:22 +03:00
self . assertEqual ( e . exception . code , 1 )
2020-05-01 07:27:01 +03:00
2019-09-23 12:02:43 +03:00
def test_run_passes_args_fail ( self ) :
self . linux_source_mock . run_kernel = mock . Mock ( return_value = [ ] )
with self . assertRaises ( SystemExit ) as e :
kunit . main ( [ ' run ' ] , self . linux_source_mock )
2020-12-02 22:08:22 +03:00
self . assertEqual ( e . exception . code , 1 )
self . assertEqual ( self . linux_source_mock . build_reconfig . call_count , 1 )
self . assertEqual ( self . linux_source_mock . run_kernel . call_count , 1 )
2021-10-12 00:50:37 +03:00
self . print_mock . assert_any_call ( StrContains ( ' invalid KTAP input! ' ) )
def test_exec_no_tests ( self ) :
self . linux_source_mock . run_kernel = mock . Mock ( return_value = [ ' TAP version 14 ' , ' 1..0 ' ] )
with self . assertRaises ( SystemExit ) as e :
kunit . main ( [ ' run ' ] , self . linux_source_mock )
self . linux_source_mock . run_kernel . assert_called_once_with (
args = None , build_dir = ' .kunit ' , filter_glob = ' ' , timeout = 300 )
self . print_mock . assert_any_call ( StrContains ( ' 0 tests run! ' ) )
2019-09-23 12:02:43 +03:00
2020-05-01 07:27:01 +03:00
def test_exec_raw_output ( self ) :
self . linux_source_mock . run_kernel = mock . Mock ( return_value = [ ] )
kunit . main ( [ ' exec ' , ' --raw_output ' ] , self . linux_source_mock )
2020-12-02 22:08:22 +03:00
self . assertEqual ( self . linux_source_mock . run_kernel . call_count , 1 )
for call in self . print_mock . call_args_list :
self . assertNotEqual ( call , mock . call ( StrContains ( ' Testing complete. ' ) ) )
2021-10-12 00:50:37 +03:00
self . assertNotEqual ( call , mock . call ( StrContains ( ' 0 tests run! ' ) ) )
2020-05-01 07:27:01 +03:00
2019-09-23 12:02:43 +03:00
def test_run_raw_output ( self ) :
self . linux_source_mock . run_kernel = mock . Mock ( return_value = [ ] )
2020-05-01 07:27:01 +03:00
kunit . main ( [ ' run ' , ' --raw_output ' ] , self . linux_source_mock )
2020-12-02 22:08:22 +03:00
self . assertEqual ( self . linux_source_mock . build_reconfig . call_count , 1 )
self . assertEqual ( self . linux_source_mock . run_kernel . call_count , 1 )
for call in self . print_mock . call_args_list :
self . assertNotEqual ( call , mock . call ( StrContains ( ' Testing complete. ' ) ) )
2021-10-12 00:50:37 +03:00
self . assertNotEqual ( call , mock . call ( StrContains ( ' 0 tests run! ' ) ) )
2020-05-01 07:27:01 +03:00
2021-08-06 02:51:44 +03:00
def test_run_raw_output_kunit ( self ) :
self . linux_source_mock . run_kernel = mock . Mock ( return_value = [ ] )
kunit . main ( [ ' run ' , ' --raw_output=kunit ' ] , self . linux_source_mock )
self . assertEqual ( self . linux_source_mock . build_reconfig . call_count , 1 )
self . assertEqual ( self . linux_source_mock . run_kernel . call_count , 1 )
for call in self . print_mock . call_args_list :
self . assertNotEqual ( call , mock . call ( StrContains ( ' Testing complete. ' ) ) )
self . assertNotEqual ( call , mock . call ( StrContains ( ' 0 tests run ' ) ) )
2021-09-22 19:39:21 +03:00
def test_run_raw_output_does_not_take_positional_args ( self ) :
# --raw_output is a string flag, but we don't want it to consume
# any positional arguments, only ones after an '='
self . linux_source_mock . run_kernel = mock . Mock ( return_value = [ ] )
kunit . main ( [ ' run ' , ' --raw_output ' , ' filter_glob ' ] , self . linux_source_mock )
self . linux_source_mock . run_kernel . assert_called_once_with (
args = None , build_dir = ' .kunit ' , filter_glob = ' filter_glob ' , timeout = 300 )
2020-05-01 07:27:01 +03:00
def test_exec_timeout ( self ) :
timeout = 3453
kunit . main ( [ ' exec ' , ' --timeout ' , str ( timeout ) ] , self . linux_source_mock )
2021-02-06 03:08:53 +03:00
self . linux_source_mock . run_kernel . assert_called_once_with (
2021-07-15 19:08:19 +03:00
args = None , build_dir = ' .kunit ' , filter_glob = ' ' , timeout = timeout )
2020-05-01 07:27:01 +03:00
self . print_mock . assert_any_call ( StrContains ( ' Testing complete. ' ) )
2019-09-23 12:02:43 +03:00
def test_run_timeout ( self ) :
timeout = 3453
kunit . main ( [ ' run ' , ' --timeout ' , str ( timeout ) ] , self . linux_source_mock )
2020-12-02 22:08:22 +03:00
self . assertEqual ( self . linux_source_mock . build_reconfig . call_count , 1 )
2020-03-16 23:21:25 +03:00
self . linux_source_mock . run_kernel . assert_called_once_with (
2021-07-15 19:08:19 +03:00
args = None , build_dir = ' .kunit ' , filter_glob = ' ' , timeout = timeout )
2019-09-23 12:02:43 +03:00
self . print_mock . assert_any_call ( StrContains ( ' Testing complete. ' ) )
2019-12-20 08:14:08 +03:00
def test_run_builddir ( self ) :
build_dir = ' .kunit '
2020-07-14 23:41:30 +03:00
kunit . main ( [ ' run ' , ' --build_dir=.kunit ' ] , self . linux_source_mock )
2020-12-02 22:08:22 +03:00
self . assertEqual ( self . linux_source_mock . build_reconfig . call_count , 1 )
2020-03-16 23:21:25 +03:00
self . linux_source_mock . run_kernel . assert_called_once_with (
2021-07-15 19:08:19 +03:00
args = None , build_dir = build_dir , filter_glob = ' ' , timeout = 300 )
2019-12-20 08:14:08 +03:00
self . print_mock . assert_any_call ( StrContains ( ' Testing complete. ' ) )
2020-05-01 07:27:01 +03:00
def test_config_builddir ( self ) :
build_dir = ' .kunit '
kunit . main ( [ ' config ' , ' --build_dir ' , build_dir ] , self . linux_source_mock )
2020-12-02 22:08:22 +03:00
self . assertEqual ( self . linux_source_mock . build_reconfig . call_count , 1 )
2020-05-01 07:27:01 +03:00
def test_build_builddir ( self ) :
build_dir = ' .kunit '
kunit . main ( [ ' build ' , ' --build_dir ' , build_dir ] , self . linux_source_mock )
2021-05-27 00:24:06 +03:00
self . linux_source_mock . build_kernel . assert_called_once_with ( False , 8 , build_dir , None )
2020-05-01 07:27:01 +03:00
def test_exec_builddir ( self ) :
build_dir = ' .kunit '
kunit . main ( [ ' exec ' , ' --build_dir ' , build_dir ] , self . linux_source_mock )
2021-02-06 03:08:53 +03:00
self . linux_source_mock . run_kernel . assert_called_once_with (
2021-07-15 19:08:19 +03:00
args = None , build_dir = build_dir , filter_glob = ' ' , timeout = 300 )
2020-05-01 07:27:01 +03:00
self . print_mock . assert_any_call ( StrContains ( ' Testing complete. ' ) )
2021-02-01 23:55:14 +03:00
@mock.patch.object ( kunit_kernel , ' LinuxSourceTree ' )
def test_run_kunitconfig ( self , mock_linux_init ) :
mock_linux_init . return_value = self . linux_source_mock
kunit . main ( [ ' run ' , ' --kunitconfig=mykunitconfig ' ] )
# Just verify that we parsed and initialized it correctly here.
2021-05-27 00:24:06 +03:00
mock_linux_init . assert_called_once_with ( ' .kunit ' ,
kunitconfig_path = ' mykunitconfig ' ,
2021-11-06 04:30:58 +03:00
kconfig_add = None ,
2021-05-27 00:24:06 +03:00
arch = ' um ' ,
cross_compile = None ,
qemu_config_path = None )
2021-02-01 23:55:14 +03:00
@mock.patch.object ( kunit_kernel , ' LinuxSourceTree ' )
def test_config_kunitconfig ( self , mock_linux_init ) :
mock_linux_init . return_value = self . linux_source_mock
kunit . main ( [ ' config ' , ' --kunitconfig=mykunitconfig ' ] )
# Just verify that we parsed and initialized it correctly here.
2021-05-27 00:24:06 +03:00
mock_linux_init . assert_called_once_with ( ' .kunit ' ,
kunitconfig_path = ' mykunitconfig ' ,
2021-11-06 04:30:58 +03:00
kconfig_add = None ,
arch = ' um ' ,
cross_compile = None ,
qemu_config_path = None )
@mock.patch.object ( kunit_kernel , ' LinuxSourceTree ' )
def test_run_kconfig_add ( self , mock_linux_init ) :
mock_linux_init . return_value = self . linux_source_mock
kunit . main ( [ ' run ' , ' --kconfig_add=CONFIG_KASAN=y ' , ' --kconfig_add=CONFIG_KCSAN=y ' ] )
# Just verify that we parsed and initialized it correctly here.
mock_linux_init . assert_called_once_with ( ' .kunit ' ,
kunitconfig_path = None ,
kconfig_add = [ ' CONFIG_KASAN=y ' , ' CONFIG_KCSAN=y ' ] ,
2021-05-27 00:24:06 +03:00
arch = ' um ' ,
cross_compile = None ,
qemu_config_path = None )
2021-02-01 23:55:14 +03:00
2021-07-15 19:08:19 +03:00
def test_run_kernel_args ( self ) :
kunit . main ( [ ' run ' , ' --kernel_args=a=1 ' , ' --kernel_args=b=2 ' ] , self . linux_source_mock )
self . assertEqual ( self . linux_source_mock . build_reconfig . call_count , 1 )
self . linux_source_mock . run_kernel . assert_called_once_with (
args = [ ' a=1 ' , ' b=2 ' ] , build_dir = ' .kunit ' , filter_glob = ' ' , timeout = 300 )
self . print_mock . assert_any_call ( StrContains ( ' Testing complete. ' ) )
kunit: tool: support running each suite/test separately
The new --run_isolated flag makes the tool boot the kernel once per
suite or test, preventing leftover state from one suite to impact the
other. This can be useful as a starting point to debugging test
hermeticity issues.
Note: it takes a lot longer, so people should not use it normally.
Consider the following very simplified example:
bool disable_something_for_test = false;
void function_being_tested() {
...
if (disable_something_for_test) return;
...
}
static void test_before(struct kunit *test)
{
disable_something_for_test = true;
function_being_tested();
/* oops, we forgot to reset it back to false */
}
static void test_after(struct kunit *test)
{
/* oops, now "fixing" test_before can cause test_after to fail! */
function_being_tested();
}
Presented like this, the issues are obvious, but it gets a lot more
complicated to track down as the amount of test setup and helper
functions increases.
Another use case is memory corruption. It might not be surfaced as a
failure/crash in the test case or suite that caused it. I've noticed in
kunit's own unit tests, the 3rd suite after might be the one to finally
crash after an out-of-bounds write, for example.
Example usage:
Per suite:
$ ./tools/testing/kunit/kunit.py run --kunitconfig=lib/kunit --run_isolated=suite
...
Starting KUnit Kernel (1/7)...
============================================================
======== [PASSED] kunit_executor_test ========
....
Testing complete. 5 tests run. 0 failed. 0 crashed. 0 skipped.
Starting KUnit Kernel (2/7)...
============================================================
======== [PASSED] kunit-try-catch-test ========
...
Per test:
$ ./tools/testing/kunit/kunit.py run --kunitconfig=lib/kunit --run_isolated=test
Starting KUnit Kernel (1/23)...
============================================================
======== [PASSED] kunit_executor_test ========
[PASSED] parse_filter_test
============================================================
Testing complete. 1 tests run. 0 failed. 0 crashed. 0 skipped.
Starting KUnit Kernel (2/23)...
============================================================
======== [PASSED] kunit_executor_test ========
[PASSED] filter_subsuite_test
...
It works with filters as well:
$ ./tools/testing/kunit/kunit.py run --kunitconfig=lib/kunit --run_isolated=suite example
...
Starting KUnit Kernel (1/1)...
============================================================
======== [PASSED] example ========
...
It also handles test filters, '*.*skip*' runs these 3 tests:
kunit_status.kunit_status_mark_skipped_test
example.example_skip_test
example.example_mark_skipped_test
Fixed up merge conflict between:
d8c23ead708b ("kunit: tool: better handling of quasi-bool args (--json, --raw_output)") and
6710951ee039 ("kunit: tool: support running each suite/test separately")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Shuah Khan <skhan@linuxfoundation.org>
Signed-off-by: Daniel Latypov <dlatypov@google.com>
Reviewed-by: David Gow <davidgow@google.com>
Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
2021-10-01 01:20:48 +03:00
def test_list_tests ( self ) :
want = [ ' suite.test1 ' , ' suite.test2 ' , ' suite2.test1 ' ]
self . linux_source_mock . run_kernel . return_value = [ ' TAP version 14 ' , ' init: random output ' ] + want
got = kunit . _list_tests ( self . linux_source_mock ,
2021-12-14 22:26:11 +03:00
kunit . KunitExecRequest ( None , ' .kunit ' , None , 300 , False , ' suite* ' , None , ' suite ' ) )
kunit: tool: support running each suite/test separately
The new --run_isolated flag makes the tool boot the kernel once per
suite or test, preventing leftover state from one suite to impact the
other. This can be useful as a starting point to debugging test
hermeticity issues.
Note: it takes a lot longer, so people should not use it normally.
Consider the following very simplified example:
bool disable_something_for_test = false;
void function_being_tested() {
...
if (disable_something_for_test) return;
...
}
static void test_before(struct kunit *test)
{
disable_something_for_test = true;
function_being_tested();
/* oops, we forgot to reset it back to false */
}
static void test_after(struct kunit *test)
{
/* oops, now "fixing" test_before can cause test_after to fail! */
function_being_tested();
}
Presented like this, the issues are obvious, but it gets a lot more
complicated to track down as the amount of test setup and helper
functions increases.
Another use case is memory corruption. It might not be surfaced as a
failure/crash in the test case or suite that caused it. I've noticed in
kunit's own unit tests, the 3rd suite after might be the one to finally
crash after an out-of-bounds write, for example.
Example usage:
Per suite:
$ ./tools/testing/kunit/kunit.py run --kunitconfig=lib/kunit --run_isolated=suite
...
Starting KUnit Kernel (1/7)...
============================================================
======== [PASSED] kunit_executor_test ========
....
Testing complete. 5 tests run. 0 failed. 0 crashed. 0 skipped.
Starting KUnit Kernel (2/7)...
============================================================
======== [PASSED] kunit-try-catch-test ========
...
Per test:
$ ./tools/testing/kunit/kunit.py run --kunitconfig=lib/kunit --run_isolated=test
Starting KUnit Kernel (1/23)...
============================================================
======== [PASSED] kunit_executor_test ========
[PASSED] parse_filter_test
============================================================
Testing complete. 1 tests run. 0 failed. 0 crashed. 0 skipped.
Starting KUnit Kernel (2/23)...
============================================================
======== [PASSED] kunit_executor_test ========
[PASSED] filter_subsuite_test
...
It works with filters as well:
$ ./tools/testing/kunit/kunit.py run --kunitconfig=lib/kunit --run_isolated=suite example
...
Starting KUnit Kernel (1/1)...
============================================================
======== [PASSED] example ========
...
It also handles test filters, '*.*skip*' runs these 3 tests:
kunit_status.kunit_status_mark_skipped_test
example.example_skip_test
example.example_mark_skipped_test
Fixed up merge conflict between:
d8c23ead708b ("kunit: tool: better handling of quasi-bool args (--json, --raw_output)") and
6710951ee039 ("kunit: tool: support running each suite/test separately")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Shuah Khan <skhan@linuxfoundation.org>
Signed-off-by: Daniel Latypov <dlatypov@google.com>
Reviewed-by: David Gow <davidgow@google.com>
Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
2021-10-01 01:20:48 +03:00
self . assertEqual ( got , want )
# Should respect the user's filter glob when listing tests.
self . linux_source_mock . run_kernel . assert_called_once_with (
args = [ ' kunit.action=list ' ] , build_dir = ' .kunit ' , filter_glob = ' suite* ' , timeout = 300 )
@mock.patch.object ( kunit , ' _list_tests ' )
def test_run_isolated_by_suite ( self , mock_tests ) :
mock_tests . return_value = [ ' suite.test1 ' , ' suite.test2 ' , ' suite2.test1 ' ]
kunit . main ( [ ' exec ' , ' --run_isolated=suite ' , ' suite*.test* ' ] , self . linux_source_mock )
# Should respect the user's filter glob when listing tests.
mock_tests . assert_called_once_with ( mock . ANY ,
2021-12-14 22:26:11 +03:00
kunit . KunitExecRequest ( None , ' .kunit ' , None , 300 , False , ' suite*.test* ' , None , ' suite ' ) )
kunit: tool: support running each suite/test separately
The new --run_isolated flag makes the tool boot the kernel once per
suite or test, preventing leftover state from one suite to impact the
other. This can be useful as a starting point to debugging test
hermeticity issues.
Note: it takes a lot longer, so people should not use it normally.
Consider the following very simplified example:
bool disable_something_for_test = false;
void function_being_tested() {
...
if (disable_something_for_test) return;
...
}
static void test_before(struct kunit *test)
{
disable_something_for_test = true;
function_being_tested();
/* oops, we forgot to reset it back to false */
}
static void test_after(struct kunit *test)
{
/* oops, now "fixing" test_before can cause test_after to fail! */
function_being_tested();
}
Presented like this, the issues are obvious, but it gets a lot more
complicated to track down as the amount of test setup and helper
functions increases.
Another use case is memory corruption. It might not be surfaced as a
failure/crash in the test case or suite that caused it. I've noticed in
kunit's own unit tests, the 3rd suite after might be the one to finally
crash after an out-of-bounds write, for example.
Example usage:
Per suite:
$ ./tools/testing/kunit/kunit.py run --kunitconfig=lib/kunit --run_isolated=suite
...
Starting KUnit Kernel (1/7)...
============================================================
======== [PASSED] kunit_executor_test ========
....
Testing complete. 5 tests run. 0 failed. 0 crashed. 0 skipped.
Starting KUnit Kernel (2/7)...
============================================================
======== [PASSED] kunit-try-catch-test ========
...
Per test:
$ ./tools/testing/kunit/kunit.py run --kunitconfig=lib/kunit --run_isolated=test
Starting KUnit Kernel (1/23)...
============================================================
======== [PASSED] kunit_executor_test ========
[PASSED] parse_filter_test
============================================================
Testing complete. 1 tests run. 0 failed. 0 crashed. 0 skipped.
Starting KUnit Kernel (2/23)...
============================================================
======== [PASSED] kunit_executor_test ========
[PASSED] filter_subsuite_test
...
It works with filters as well:
$ ./tools/testing/kunit/kunit.py run --kunitconfig=lib/kunit --run_isolated=suite example
...
Starting KUnit Kernel (1/1)...
============================================================
======== [PASSED] example ========
...
It also handles test filters, '*.*skip*' runs these 3 tests:
kunit_status.kunit_status_mark_skipped_test
example.example_skip_test
example.example_mark_skipped_test
Fixed up merge conflict between:
d8c23ead708b ("kunit: tool: better handling of quasi-bool args (--json, --raw_output)") and
6710951ee039 ("kunit: tool: support running each suite/test separately")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Shuah Khan <skhan@linuxfoundation.org>
Signed-off-by: Daniel Latypov <dlatypov@google.com>
Reviewed-by: David Gow <davidgow@google.com>
Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
2021-10-01 01:20:48 +03:00
self . linux_source_mock . run_kernel . assert_has_calls ( [
mock . call ( args = None , build_dir = ' .kunit ' , filter_glob = ' suite.test* ' , timeout = 300 ) ,
mock . call ( args = None , build_dir = ' .kunit ' , filter_glob = ' suite2.test* ' , timeout = 300 ) ,
] )
@mock.patch.object ( kunit , ' _list_tests ' )
def test_run_isolated_by_test ( self , mock_tests ) :
mock_tests . return_value = [ ' suite.test1 ' , ' suite.test2 ' , ' suite2.test1 ' ]
kunit . main ( [ ' exec ' , ' --run_isolated=test ' , ' suite* ' ] , self . linux_source_mock )
# Should respect the user's filter glob when listing tests.
mock_tests . assert_called_once_with ( mock . ANY ,
2021-12-14 22:26:11 +03:00
kunit . KunitExecRequest ( None , ' .kunit ' , None , 300 , False , ' suite* ' , None , ' test ' ) )
kunit: tool: support running each suite/test separately
The new --run_isolated flag makes the tool boot the kernel once per
suite or test, preventing leftover state from one suite to impact the
other. This can be useful as a starting point to debugging test
hermeticity issues.
Note: it takes a lot longer, so people should not use it normally.
Consider the following very simplified example:
bool disable_something_for_test = false;
void function_being_tested() {
...
if (disable_something_for_test) return;
...
}
static void test_before(struct kunit *test)
{
disable_something_for_test = true;
function_being_tested();
/* oops, we forgot to reset it back to false */
}
static void test_after(struct kunit *test)
{
/* oops, now "fixing" test_before can cause test_after to fail! */
function_being_tested();
}
Presented like this, the issues are obvious, but it gets a lot more
complicated to track down as the amount of test setup and helper
functions increases.
Another use case is memory corruption. It might not be surfaced as a
failure/crash in the test case or suite that caused it. I've noticed in
kunit's own unit tests, the 3rd suite after might be the one to finally
crash after an out-of-bounds write, for example.
Example usage:
Per suite:
$ ./tools/testing/kunit/kunit.py run --kunitconfig=lib/kunit --run_isolated=suite
...
Starting KUnit Kernel (1/7)...
============================================================
======== [PASSED] kunit_executor_test ========
....
Testing complete. 5 tests run. 0 failed. 0 crashed. 0 skipped.
Starting KUnit Kernel (2/7)...
============================================================
======== [PASSED] kunit-try-catch-test ========
...
Per test:
$ ./tools/testing/kunit/kunit.py run --kunitconfig=lib/kunit --run_isolated=test
Starting KUnit Kernel (1/23)...
============================================================
======== [PASSED] kunit_executor_test ========
[PASSED] parse_filter_test
============================================================
Testing complete. 1 tests run. 0 failed. 0 crashed. 0 skipped.
Starting KUnit Kernel (2/23)...
============================================================
======== [PASSED] kunit_executor_test ========
[PASSED] filter_subsuite_test
...
It works with filters as well:
$ ./tools/testing/kunit/kunit.py run --kunitconfig=lib/kunit --run_isolated=suite example
...
Starting KUnit Kernel (1/1)...
============================================================
======== [PASSED] example ========
...
It also handles test filters, '*.*skip*' runs these 3 tests:
kunit_status.kunit_status_mark_skipped_test
example.example_skip_test
example.example_mark_skipped_test
Fixed up merge conflict between:
d8c23ead708b ("kunit: tool: better handling of quasi-bool args (--json, --raw_output)") and
6710951ee039 ("kunit: tool: support running each suite/test separately")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Shuah Khan <skhan@linuxfoundation.org>
Signed-off-by: Daniel Latypov <dlatypov@google.com>
Reviewed-by: David Gow <davidgow@google.com>
Reviewed-by: Brendan Higgins <brendanhiggins@google.com>
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
2021-10-01 01:20:48 +03:00
self . linux_source_mock . run_kernel . assert_has_calls ( [
mock . call ( args = None , build_dir = ' .kunit ' , filter_glob = ' suite.test1 ' , timeout = 300 ) ,
mock . call ( args = None , build_dir = ' .kunit ' , filter_glob = ' suite.test2 ' , timeout = 300 ) ,
mock . call ( args = None , build_dir = ' .kunit ' , filter_glob = ' suite2.test1 ' , timeout = 300 ) ,
] )
2021-07-15 19:08:19 +03:00
2019-09-23 12:02:43 +03:00
if __name__ == ' __main__ ' :
unittest . main ( )