2021-05-28 11:22:12

by David Gow

[permalink] [raw]
Subject: [PATCH v2 1/4] kunit: Support skipped tests

The kunit_mark_skipped() macro marks the current test as "skipped", with
the provided reason. The kunit_skip() macro will mark the test as
skipped, and abort the test.

The TAP specification supports this "SKIP directive" as a comment after
the "ok" / "not ok" for a test. See the "Directives" section of the TAP
spec for details:
https://testanything.org/tap-specification.html#directives

The 'success' field for KUnit tests is replaced with a kunit_status
enum, which can be SUCCESS, FAILURE, or SKIPPED, combined with a
'status_comment' containing information on why a test was skipped.

A new 'kunit_status' test suite is added to test this.

Signed-off-by: David Gow <[email protected]>
Tested-by: Marco Elver <[email protected]>
Reviewed-by: Daniel Latypov <[email protected]>
---

Changes since v1:
https://lore.kernel.org/linux-kselftest/[email protected]/
- Renamed kunit_status_to_string() to kunit_status_to_ok_not_ok
- Fixed incorrect printing of status comments on non-skipped tests.

Not changes:
- Still using kunit_log(KERN_INFO,...) instead of kunit_info() as it
seems to be consistently used for printing results in the KUnit code.

include/kunit/test.h | 68 ++++++++++++++++++++++++++++++++++++++----
lib/kunit/kunit-test.c | 42 +++++++++++++++++++++++++-
lib/kunit/test.c | 51 ++++++++++++++++++-------------
3 files changed, 134 insertions(+), 27 deletions(-)

diff --git a/include/kunit/test.h b/include/kunit/test.h
index b68c61348121..1401c620ac5e 100644
--- a/include/kunit/test.h
+++ b/include/kunit/test.h
@@ -105,6 +105,18 @@ struct kunit;
#define KUNIT_SUBTEST_INDENT " "
#define KUNIT_SUBSUBTEST_INDENT " "

+/**
+ * enum kunit_status - Type of result for a test or test suite
+ * @KUNIT_SUCCESS: Denotes the test suite has not failed nor been skipped
+ * @KUNIT_FAILURE: Denotes the test has failed.
+ * @KUNIT_SKIPPED: Denotes the test has been skipped.
+ */
+enum kunit_status {
+ KUNIT_SUCCESS,
+ KUNIT_FAILURE,
+ KUNIT_SKIPPED,
+};
+
/**
* struct kunit_case - represents an individual test case.
*
@@ -148,13 +160,20 @@ struct kunit_case {
const void* (*generate_params)(const void *prev, char *desc);

/* private: internal use only. */
- bool success;
+ enum kunit_status status;
char *log;
};

-static inline char *kunit_status_to_string(bool status)
+static inline char *kunit_status_to_ok_not_ok(enum kunit_status status)
{
- return status ? "ok" : "not ok";
+ switch (status) {
+ case KUNIT_SKIPPED:
+ case KUNIT_SUCCESS:
+ return "ok";
+ case KUNIT_FAILURE:
+ return "not ok";
+ }
+ return "invalid";
}

/**
@@ -212,6 +231,7 @@ struct kunit_suite {
struct kunit_case *test_cases;

/* private: internal use only */
+ char status_comment[256];
struct dentry *debugfs;
char *log;
};
@@ -245,19 +265,21 @@ struct kunit {
* be read after the test case finishes once all threads associated
* with the test case have terminated.
*/
- bool success; /* Read only after test_case finishes! */
spinlock_t lock; /* Guards all mutable test state. */
+ enum kunit_status status; /* Read only after test_case finishes! */
/*
* Because resources is a list that may be updated multiple times (with
* new resources) from any thread associated with a test case, we must
* protect it with some type of lock.
*/
struct list_head resources; /* Protected by lock. */
+
+ char status_comment[256];
};

static inline void kunit_set_failure(struct kunit *test)
{
- WRITE_ONCE(test->success, false);
+ WRITE_ONCE(test->status, KUNIT_FAILURE);
}

void kunit_init_test(struct kunit *test, const char *name, char *log);
@@ -348,7 +370,7 @@ static inline int kunit_run_all_tests(void)
#define kunit_suite_for_each_test_case(suite, test_case) \
for (test_case = suite->test_cases; test_case->run_case; test_case++)

-bool kunit_suite_has_succeeded(struct kunit_suite *suite);
+enum kunit_status kunit_suite_has_succeeded(struct kunit_suite *suite);

/*
* Like kunit_alloc_resource() below, but returns the struct kunit_resource
@@ -612,6 +634,40 @@ void kunit_cleanup(struct kunit *test);

void kunit_log_append(char *log, const char *fmt, ...);

+/**
+ * kunit_mark_skipped() - Marks @test_or_suite as skipped
+ *
+ * @test_or_suite: The test context object.
+ * @fmt: A printk() style format string.
+ *
+ * Marks the test as skipped. @fmt is given output as the test status
+ * comment, typically the reason the test was skipped.
+ *
+ * Test execution continues after kunit_mark_skipped() is called.
+ */
+#define kunit_mark_skipped(test_or_suite, fmt, ...) \
+ do { \
+ WRITE_ONCE((test_or_suite)->status, KUNIT_SKIPPED); \
+ scnprintf((test_or_suite)->status_comment, 256, fmt, ##__VA_ARGS__); \
+ } while (0)
+
+/**
+ * kunit_skip() - Marks @test_or_suite as skipped
+ *
+ * @test_or_suite: The test context object.
+ * @fmt: A printk() style format string.
+ *
+ * Skips the test. @fmt is given output as the test status
+ * comment, typically the reason the test was skipped.
+ *
+ * Test execution is halted after kunit_skip() is called.
+ */
+#define kunit_skip(test_or_suite, fmt, ...) \
+ do { \
+ kunit_mark_skipped((test_or_suite), fmt, ##__VA_ARGS__);\
+ kunit_try_catch_throw(&((test_or_suite)->try_catch)); \
+ } while (0)
+
/*
* printk and log to per-test or per-suite log buffer. Logging only done
* if CONFIG_KUNIT_DEBUGFS is 'y'; if it is 'n', no log is allocated/used.
diff --git a/lib/kunit/kunit-test.c b/lib/kunit/kunit-test.c
index 69f902440a0e..d69efcbed624 100644
--- a/lib/kunit/kunit-test.c
+++ b/lib/kunit/kunit-test.c
@@ -437,7 +437,47 @@ static void kunit_log_test(struct kunit *test)
#endif
}

+static void kunit_status_set_failure_test(struct kunit *test)
+{
+ struct kunit fake;
+
+ kunit_init_test(&fake, "fake test", NULL);
+
+ KUNIT_EXPECT_EQ(test, fake.status, (enum kunit_status)KUNIT_SUCCESS);
+ kunit_set_failure(&fake);
+ KUNIT_EXPECT_EQ(test, fake.status, (enum kunit_status)KUNIT_FAILURE);
+}
+
+static void kunit_status_mark_skipped_test(struct kunit *test)
+{
+ struct kunit fake;
+
+ kunit_init_test(&fake, "fake test", NULL);
+
+ /* Before: Should be SUCCESS with no comment. */
+ KUNIT_EXPECT_EQ(test, fake.status, KUNIT_SUCCESS);
+ KUNIT_EXPECT_STREQ(test, fake.status_comment, "");
+
+ /* Mark the test as skipped. */
+ kunit_mark_skipped(&fake, "Accepts format string: %s", "YES");
+
+ /* After: Should be SKIPPED with our comment. */
+ KUNIT_EXPECT_EQ(test, fake.status, (enum kunit_status)KUNIT_SKIPPED);
+ KUNIT_EXPECT_STREQ(test, fake.status_comment, "Accepts format string: YES");
+}
+
+static struct kunit_case kunit_status_test_cases[] = {
+ KUNIT_CASE(kunit_status_set_failure_test),
+ KUNIT_CASE(kunit_status_mark_skipped_test),
+ {}
+};
+
+static struct kunit_suite kunit_status_test_suite = {
+ .name = "kunit_status",
+ .test_cases = kunit_status_test_cases,
+};
+
kunit_test_suites(&kunit_try_catch_test_suite, &kunit_resource_test_suite,
- &kunit_log_test_suite);
+ &kunit_log_test_suite, &kunit_status_test_suite);

MODULE_LICENSE("GPL v2");
diff --git a/lib/kunit/test.c b/lib/kunit/test.c
index 2f6cc0123232..8ce0c8fddb96 100644
--- a/lib/kunit/test.c
+++ b/lib/kunit/test.c
@@ -98,12 +98,14 @@ static void kunit_print_subtest_start(struct kunit_suite *suite)

static void kunit_print_ok_not_ok(void *test_or_suite,
bool is_test,
- bool is_ok,
+ enum kunit_status status,
size_t test_number,
- const char *description)
+ const char *description,
+ const char *directive)
{
struct kunit_suite *suite = is_test ? NULL : test_or_suite;
struct kunit *test = is_test ? test_or_suite : NULL;
+ const char *directive_header = (status == KUNIT_SKIPPED) ? " # SKIP " : "";

/*
* We do not log the test suite results as doing so would
@@ -114,25 +116,31 @@ static void kunit_print_ok_not_ok(void *test_or_suite,
* representation.
*/
if (suite)
- pr_info("%s %zd - %s\n",
- kunit_status_to_string(is_ok),
- test_number, description);
+ pr_info("%s %zd - %s%s%s\n",
+ kunit_status_to_ok_not_ok(status),
+ test_number, description, directive_header,
+ (status == KUNIT_SKIPPED) ? directive : "");
else
- kunit_log(KERN_INFO, test, KUNIT_SUBTEST_INDENT "%s %zd - %s",
- kunit_status_to_string(is_ok),
- test_number, description);
+ kunit_log(KERN_INFO, test,
+ KUNIT_SUBTEST_INDENT "%s %zd - %s%s%s",
+ kunit_status_to_ok_not_ok(status),
+ test_number, description, directive_header,
+ (status == KUNIT_SKIPPED) ? directive : "");
}

-bool kunit_suite_has_succeeded(struct kunit_suite *suite)
+enum kunit_status kunit_suite_has_succeeded(struct kunit_suite *suite)
{
const struct kunit_case *test_case;
+ enum kunit_status status = KUNIT_SKIPPED;

kunit_suite_for_each_test_case(suite, test_case) {
- if (!test_case->success)
- return false;
+ if (test_case->status == KUNIT_FAILURE)
+ return KUNIT_FAILURE;
+ else if (test_case->status == KUNIT_SUCCESS)
+ status = KUNIT_SUCCESS;
}

- return true;
+ return status;
}
EXPORT_SYMBOL_GPL(kunit_suite_has_succeeded);

@@ -143,7 +151,8 @@ static void kunit_print_subtest_end(struct kunit_suite *suite)
kunit_print_ok_not_ok((void *)suite, false,
kunit_suite_has_succeeded(suite),
kunit_suite_counter++,
- suite->name);
+ suite->name,
+ suite->status_comment);
}

unsigned int kunit_test_case_num(struct kunit_suite *suite,
@@ -252,7 +261,8 @@ void kunit_init_test(struct kunit *test, const char *name, char *log)
test->log = log;
if (test->log)
test->log[0] = '\0';
- test->success = true;
+ test->status = KUNIT_SUCCESS;
+ test->status_comment[0] = '\0';
}
EXPORT_SYMBOL_GPL(kunit_init_test);

@@ -376,7 +386,8 @@ static void kunit_run_case_catch_errors(struct kunit_suite *suite,
context.test_case = test_case;
kunit_try_catch_run(try_catch, &context);

- test_case->success = test->success;
+ test_case->status = test->status;
+
}

int kunit_run_tests(struct kunit_suite *suite)
@@ -388,7 +399,6 @@ int kunit_run_tests(struct kunit_suite *suite)

kunit_suite_for_each_test_case(suite, test_case) {
struct kunit test = { .param_value = NULL, .param_index = 0 };
- bool test_success = true;

if (test_case->generate_params) {
/* Get initial param. */
@@ -398,7 +408,6 @@ int kunit_run_tests(struct kunit_suite *suite)

do {
kunit_run_case_catch_errors(suite, test_case, &test);
- test_success &= test_case->success;

if (test_case->generate_params) {
if (param_desc[0] == '\0') {
@@ -410,7 +419,7 @@ int kunit_run_tests(struct kunit_suite *suite)
KUNIT_SUBTEST_INDENT
"# %s: %s %d - %s",
test_case->name,
- kunit_status_to_string(test.success),
+ kunit_status_to_ok_not_ok(test.status),
test.param_index + 1, param_desc);

/* Get next param. */
@@ -420,9 +429,10 @@ int kunit_run_tests(struct kunit_suite *suite)
}
} while (test.param_value);

- kunit_print_ok_not_ok(&test, true, test_success,
+ kunit_print_ok_not_ok(&test, true, test_case->status,
kunit_test_case_num(suite, test_case),
- test_case->name);
+ test_case->name,
+ test.status_comment);
}

kunit_print_subtest_end(suite);
@@ -434,6 +444,7 @@ EXPORT_SYMBOL_GPL(kunit_run_tests);
static void kunit_init_suite(struct kunit_suite *suite)
{
kunit_debugfs_create_suite(suite);
+ suite->status_comment[0] = '\0';
}

int __kunit_test_suites_init(struct kunit_suite * const * const suites)
--
2.32.0.rc0.204.g9fa02ecfa5-goog


2021-05-28 11:22:18

by David Gow

[permalink] [raw]
Subject: [PATCH v2 2/4] kunit: tool: Support skipped tests in kunit_tool

Add support for the SKIP directive to kunit_tool's TAP parser.

Skipped tests now show up as such in the printed summary. The number of
skipped tests is counted, and if all tests in a suite are skipped, the
suite is also marked as skipped. Otherwise, skipped tests do affect the
suite result.

Example output:
[00:22:34] ======== [SKIPPED] example_skip ========
[00:22:34] [SKIPPED] example_skip_test # SKIP this test should be skipped
[00:22:34] [SKIPPED] example_mark_skipped_test # SKIP this test should be skipped
[00:22:34] ============================================================
[00:22:34] Testing complete. 2 tests run. 0 failed. 0 crashed. 2 skipped.

Signed-off-by: David Gow <[email protected]>
---

Changes since v1:
https://lore.kernel.org/linux-kselftest/[email protected]/
- Include missing test logs for kunit_tool_test
- Encapsulate test counts in a class (Thanks Daniel Latypov)
- Fix a type hinting issue in the process

---
tools/testing/kunit/kunit_parser.py | 77 +++++++++++++------
tools/testing/kunit/kunit_tool_test.py | 22 ++++++
.../kunit/test_data/test_skip_all_tests.log | 15 ++++
.../kunit/test_data/test_skip_tests.log | 15 ++++
4 files changed, 105 insertions(+), 24 deletions(-)
create mode 100644 tools/testing/kunit/test_data/test_skip_all_tests.log
create mode 100644 tools/testing/kunit/test_data/test_skip_tests.log

diff --git a/tools/testing/kunit/kunit_parser.py b/tools/testing/kunit/kunit_parser.py
index e8bcc139702e..f07dce1d4146 100644
--- a/tools/testing/kunit/kunit_parser.py
+++ b/tools/testing/kunit/kunit_parser.py
@@ -43,6 +43,7 @@ class TestCase(object):
class TestStatus(Enum):
SUCCESS = auto()
FAILURE = auto()
+ SKIPPED = auto()
TEST_CRASHED = auto()
NO_TESTS = auto()
FAILURE_TO_PARSE_TESTS = auto()
@@ -108,6 +109,8 @@ def save_non_diagnostic(lines: List[str], test_case: TestCase) -> None:

OkNotOkResult = namedtuple('OkNotOkResult', ['is_ok','description', 'text'])

+OK_NOT_OK_SKIP = re.compile(r'^[\s]*(ok|not ok) [0-9]+ - (.*) # SKIP(.*)$')
+
OK_NOT_OK_SUBTEST = re.compile(r'^[\s]+(ok|not ok) [0-9]+ - (.*)$')

OK_NOT_OK_MODULE = re.compile(r'^(ok|not ok) ([0-9]+) - (.*)$')
@@ -125,6 +128,10 @@ def parse_ok_not_ok_test_case(lines: List[str], test_case: TestCase) -> bool:
if match:
test_case.log.append(lines.pop(0))
test_case.name = match.group(2)
+ skip_match = OK_NOT_OK_SKIP.match(line)
+ if skip_match:
+ test_case.status = TestStatus.SKIPPED
+ return True
if test_case.status == TestStatus.TEST_CRASHED:
return True
if match.group(1) == 'ok':
@@ -188,16 +195,16 @@ def parse_subtest_plan(lines: List[str]) -> Optional[int]:
return None

def max_status(left: TestStatus, right: TestStatus) -> TestStatus:
- if left == TestStatus.TEST_CRASHED or right == TestStatus.TEST_CRASHED:
+ if left == right:
+ return left
+ elif left == TestStatus.TEST_CRASHED or right == TestStatus.TEST_CRASHED:
return TestStatus.TEST_CRASHED
elif left == TestStatus.FAILURE or right == TestStatus.FAILURE:
return TestStatus.FAILURE
- elif left != TestStatus.SUCCESS:
- return left
- elif right != TestStatus.SUCCESS:
+ elif left == TestStatus.SKIPPED:
return right
else:
- return TestStatus.SUCCESS
+ return left

def parse_ok_not_ok_test_suite(lines: List[str],
test_suite: TestSuite,
@@ -214,6 +221,9 @@ def parse_ok_not_ok_test_suite(lines: List[str],
test_suite.status = TestStatus.SUCCESS
else:
test_suite.status = TestStatus.FAILURE
+ skip_match = OK_NOT_OK_SKIP.match(line)
+ if skip_match:
+ test_suite.status = TestStatus.SKIPPED
suite_index = int(match.group(2))
if suite_index != expected_suite_index:
print_with_timestamp(
@@ -224,8 +234,8 @@ def parse_ok_not_ok_test_suite(lines: List[str],
else:
return False

-def bubble_up_errors(statuses: Iterable[TestStatus]) -> TestStatus:
- return reduce(max_status, statuses, TestStatus.SUCCESS)
+def bubble_up_errors(status_list: Iterable[TestStatus]) -> TestStatus:
+ return reduce(max_status, status_list, TestStatus.SKIPPED)

def bubble_up_test_case_errors(test_suite: TestSuite) -> TestStatus:
max_test_case_status = bubble_up_errors(x.status for x in test_suite.cases)
@@ -311,49 +321,68 @@ def parse_test_result(lines: List[str]) -> TestResult:
else:
return TestResult(TestStatus.NO_TESTS, [], lines)

-def print_and_count_results(test_result: TestResult) -> Tuple[int, int, int]:
- total_tests = 0
- failed_tests = 0
- crashed_tests = 0
+class TestCounts:
+ passed: int
+ failed: int
+ crashed: int
+ skipped: int
+
+ def __init__(self):
+ self.passed = 0
+ self.failed = 0
+ self.crashed = 0
+ self.skipped = 0
+
+ def total(self) -> int:
+ return self.passed + self.failed + self.crashed + self.skipped
+
+def print_and_count_results(test_result: TestResult) -> TestCounts:
+ counts = TestCounts()
for test_suite in test_result.suites:
if test_suite.status == TestStatus.SUCCESS:
print_suite_divider(green('[PASSED] ') + test_suite.name)
+ elif test_suite.status == TestStatus.SKIPPED:
+ print_suite_divider(yellow('[SKIPPED] ') + test_suite.name)
elif test_suite.status == TestStatus.TEST_CRASHED:
print_suite_divider(red('[CRASHED] ' + test_suite.name))
else:
print_suite_divider(red('[FAILED] ') + test_suite.name)
for test_case in test_suite.cases:
- total_tests += 1
if test_case.status == TestStatus.SUCCESS:
+ counts.passed += 1
print_with_timestamp(green('[PASSED] ') + test_case.name)
+ elif test_case.status == TestStatus.SKIPPED:
+ counts.skipped += 1
+ print_with_timestamp(yellow('[SKIPPED] ') + test_case.name)
elif test_case.status == TestStatus.TEST_CRASHED:
- crashed_tests += 1
+ counts.crashed += 1
print_with_timestamp(red('[CRASHED] ' + test_case.name))
print_log(map(yellow, test_case.log))
print_with_timestamp('')
else:
- failed_tests += 1
+ counts.failed += 1
print_with_timestamp(red('[FAILED] ') + test_case.name)
print_log(map(yellow, test_case.log))
print_with_timestamp('')
- return total_tests, failed_tests, crashed_tests
+ return counts

def parse_run_tests(kernel_output) -> TestResult:
- total_tests = 0
- failed_tests = 0
- crashed_tests = 0
+ counts = TestCounts()
test_result = parse_test_result(list(isolate_kunit_output(kernel_output)))
if test_result.status == TestStatus.NO_TESTS:
print(red('[ERROR] ') + yellow('no tests run!'))
elif test_result.status == TestStatus.FAILURE_TO_PARSE_TESTS:
print(red('[ERROR] ') + yellow('could not parse test results!'))
else:
- (total_tests,
- failed_tests,
- crashed_tests) = print_and_count_results(test_result)
+ counts = print_and_count_results(test_result)
print_with_timestamp(DIVIDER)
- fmt = green if test_result.status == TestStatus.SUCCESS else red
+ if test_result.status == TestStatus.SUCCESS:
+ fmt = green
+ elif test_result.status == TestStatus.SKIPPED:
+ fmt = yellow
+ else:
+ fmt =red
print_with_timestamp(
- fmt('Testing complete. %d tests run. %d failed. %d crashed.' %
- (total_tests, failed_tests, crashed_tests)))
+ fmt('Testing complete. %d tests run. %d failed. %d crashed. %d skipped.' %
+ (counts.total(), counts.failed, counts.crashed, counts.skipped)))
return test_result
diff --git a/tools/testing/kunit/kunit_tool_test.py b/tools/testing/kunit/kunit_tool_test.py
index 2e809dd956a7..a51e70cafcc1 100755
--- a/tools/testing/kunit/kunit_tool_test.py
+++ b/tools/testing/kunit/kunit_tool_test.py
@@ -183,6 +183,28 @@ class KUnitParserTest(unittest.TestCase):
kunit_parser.TestStatus.TEST_CRASHED,
result.status)

+ def test_skipped_test(self):
+ skipped_log = test_data_path('test_skip_tests.log')
+ file = open(skipped_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)
+ file.close()
+
+ def test_skipped_all_tests(self):
+ skipped_log = test_data_path('test_skip_all_tests.log')
+ file = open(skipped_log)
+ result = kunit_parser.parse_run_tests(file.readlines())
+
+ self.assertEqual(
+ kunit_parser.TestStatus.SKIPPED,
+ result.status)
+ file.close()
+
+
def test_ignores_prefix_printk_time(self):
prefix_log = test_data_path('test_config_printk_time.log')
with open(prefix_log) as file:
diff --git a/tools/testing/kunit/test_data/test_skip_all_tests.log b/tools/testing/kunit/test_data/test_skip_all_tests.log
new file mode 100644
index 000000000000..2ea6e6d14fff
--- /dev/null
+++ b/tools/testing/kunit/test_data/test_skip_all_tests.log
@@ -0,0 +1,15 @@
+TAP version 14
+1..2
+ # Subtest: string-stream-test
+ 1..3
+ ok 1 - string_stream_test_empty_on_creation # SKIP all tests skipped
+ ok 2 - string_stream_test_not_empty_after_add # SKIP all tests skipped
+ ok 3 - string_stream_test_get_string # SKIP all tests skipped
+ok 1 - string-stream-test # SKIP
+ # Subtest: example
+ 1..2
+ # example_simple_test: initializing
+ ok 1 - example_simple_test # SKIP all tests skipped
+ # example_skip_test: initializing
+ ok 2 - example_skip_test # SKIP this test should be skipped
+ok 2 - example # SKIP
diff --git a/tools/testing/kunit/test_data/test_skip_tests.log b/tools/testing/kunit/test_data/test_skip_tests.log
new file mode 100644
index 000000000000..79b326e31274
--- /dev/null
+++ b/tools/testing/kunit/test_data/test_skip_tests.log
@@ -0,0 +1,15 @@
+TAP version 14
+1..2
+ # Subtest: string-stream-test
+ 1..3
+ ok 1 - string_stream_test_empty_on_creation
+ ok 2 - string_stream_test_not_empty_after_add
+ ok 3 - string_stream_test_get_string
+ok 1 - string-stream-test
+ # Subtest: example
+ 1..2
+ # example_simple_test: initializing
+ ok 1 - example_simple_test
+ # example_skip_test: initializing
+ ok 2 - example_skip_test # SKIP this test should be skipped
+ok 2 - example
--
2.32.0.rc0.204.g9fa02ecfa5-goog

2021-05-28 12:12:48

by kernel test robot

[permalink] [raw]
Subject: Re: [PATCH v2 1/4] kunit: Support skipped tests

Hi David,

I love your patch! Yet something to improve:

[auto build test ERROR on linus/master]
[also build test ERROR on v5.13-rc3 next-20210527]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url: https://github.com/0day-ci/linux/commits/David-Gow/kunit-Support-skipped-tests/20210528-160224
base: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git 97e5bf604b7a0d6e1b3e00fe31d5fd4b9bffeaae
config: x86_64-rhel-8.3 (attached as .config)
compiler: gcc-9 (Debian 9.3.0-22) 9.3.0
reproduce (this is a W=1 build):
# https://github.com/0day-ci/linux/commit/a464519206cd4484f64540020093cb45ef8e272e
git remote add linux-review https://github.com/0day-ci/linux
git fetch --no-tags linux-review David-Gow/kunit-Support-skipped-tests/20210528-160224
git checkout a464519206cd4484f64540020093cb45ef8e272e
# save the attached .config to linux build tree
make W=1 ARCH=x86_64

If you fix the issue, kindly add following tag as appropriate
Reported-by: kernel test robot <[email protected]>

All errors (new ones prefixed by >>):

In file included from include/linux/kernel.h:15,
from include/kunit/assert.h:13,
from include/kunit/test.h:12,
from lib/kunit/kunit-test.c:8:
lib/kunit/kunit-test.c: In function 'kunit_status_mark_skipped_test':
include/linux/minmax.h:20:28: warning: comparison of distinct pointer types lacks a cast
20 | (!!(sizeof((typeof(x) *)1 == (typeof(y) *)1)))
| ^~
include/kunit/test.h:834:9: note: in expansion of macro '__typecheck'
834 | ((void)__typecheck(__left, __right)); \
| ^~~~~~~~~~~
include/kunit/test.h:858:2: note: in expansion of macro 'KUNIT_BASE_BINARY_ASSERTION'
858 | KUNIT_BASE_BINARY_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:947:2: note: in expansion of macro 'KUNIT_BASE_EQ_MSG_ASSERTION'
947 | KUNIT_BASE_EQ_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:957:2: note: in expansion of macro 'KUNIT_BINARY_EQ_MSG_ASSERTION'
957 | KUNIT_BINARY_EQ_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1320:2: note: in expansion of macro 'KUNIT_BINARY_EQ_ASSERTION'
1320 | KUNIT_BINARY_EQ_ASSERTION(test, KUNIT_EXPECTATION, left, right)
| ^~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/kunit-test.c:458:2: note: in expansion of macro 'KUNIT_EXPECT_EQ'
458 | KUNIT_EXPECT_EQ(test, fake.status, KUNIT_SUCCESS);
| ^~~~~~~~~~~~~~~
In file included from lib/kunit/kunit-test.c:8:
>> include/kunit/test.h:1188:24: error: invalid initializer
1188 | typeof(left) __left = (left); \
| ^
include/kunit/test.h:1211:2: note: in expansion of macro 'KUNIT_BINARY_STR_ASSERTION'
1211 | KUNIT_BINARY_STR_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1218:2: note: in expansion of macro 'KUNIT_BINARY_STR_EQ_MSG_ASSERTION'
1218 | KUNIT_BINARY_STR_EQ_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1502:2: note: in expansion of macro 'KUNIT_BINARY_STR_EQ_ASSERTION'
1502 | KUNIT_BINARY_STR_EQ_ASSERTION(test, KUNIT_EXPECTATION, left, right)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/kunit-test.c:459:2: note: in expansion of macro 'KUNIT_EXPECT_STREQ'
459 | KUNIT_EXPECT_STREQ(test, fake.status_comment, "");
| ^~~~~~~~~~~~~~~~~~
>> include/kunit/test.h:1188:24: error: invalid initializer
1188 | typeof(left) __left = (left); \
| ^
include/kunit/test.h:1211:2: note: in expansion of macro 'KUNIT_BINARY_STR_ASSERTION'
1211 | KUNIT_BINARY_STR_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1218:2: note: in expansion of macro 'KUNIT_BINARY_STR_EQ_MSG_ASSERTION'
1218 | KUNIT_BINARY_STR_EQ_MSG_ASSERTION(test, \
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
include/kunit/test.h:1502:2: note: in expansion of macro 'KUNIT_BINARY_STR_EQ_ASSERTION'
1502 | KUNIT_BINARY_STR_EQ_ASSERTION(test, KUNIT_EXPECTATION, left, right)
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
lib/kunit/kunit-test.c:466:2: note: in expansion of macro 'KUNIT_EXPECT_STREQ'
466 | KUNIT_EXPECT_STREQ(test, fake.status_comment, "Accepts format string: YES");
| ^~~~~~~~~~~~~~~~~~


vim +1188 include/kunit/test.h

73cda7bb8bfb1d Brendan Higgins 2019-09-23 849
73cda7bb8bfb1d Brendan Higgins 2019-09-23 850 #define KUNIT_BASE_EQ_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 851 assert_class, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 852 ASSERT_CLASS_INIT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 853 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 854 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 855 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 856 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 857 ...) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 858 KUNIT_BASE_BINARY_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 859 assert_class, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 860 ASSERT_CLASS_INIT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 861 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 862 left, ==, right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 863 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 864 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 865
73cda7bb8bfb1d Brendan Higgins 2019-09-23 866 #define KUNIT_BASE_NE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 867 assert_class, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 868 ASSERT_CLASS_INIT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 869 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 870 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 871 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 872 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 873 ...) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 874 KUNIT_BASE_BINARY_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 875 assert_class, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 876 ASSERT_CLASS_INIT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 877 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 878 left, !=, right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 879 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 880 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 881
73cda7bb8bfb1d Brendan Higgins 2019-09-23 882 #define KUNIT_BASE_LT_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 883 assert_class, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 884 ASSERT_CLASS_INIT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 885 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 886 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 887 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 888 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 889 ...) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 890 KUNIT_BASE_BINARY_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 891 assert_class, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 892 ASSERT_CLASS_INIT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 893 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 894 left, <, right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 895 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 896 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 897
73cda7bb8bfb1d Brendan Higgins 2019-09-23 898 #define KUNIT_BASE_LE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 899 assert_class, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 900 ASSERT_CLASS_INIT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 901 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 902 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 903 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 904 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 905 ...) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 906 KUNIT_BASE_BINARY_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 907 assert_class, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 908 ASSERT_CLASS_INIT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 909 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 910 left, <=, right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 911 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 912 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 913
73cda7bb8bfb1d Brendan Higgins 2019-09-23 914 #define KUNIT_BASE_GT_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 915 assert_class, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 916 ASSERT_CLASS_INIT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 917 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 918 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 919 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 920 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 921 ...) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 922 KUNIT_BASE_BINARY_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 923 assert_class, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 924 ASSERT_CLASS_INIT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 925 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 926 left, >, right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 927 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 928 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 929
73cda7bb8bfb1d Brendan Higgins 2019-09-23 930 #define KUNIT_BASE_GE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 931 assert_class, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 932 ASSERT_CLASS_INIT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 933 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 934 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 935 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 936 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 937 ...) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 938 KUNIT_BASE_BINARY_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 939 assert_class, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 940 ASSERT_CLASS_INIT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 941 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 942 left, >=, right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 943 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 944 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 945
73cda7bb8bfb1d Brendan Higgins 2019-09-23 946 #define KUNIT_BINARY_EQ_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\
73cda7bb8bfb1d Brendan Higgins 2019-09-23 947 KUNIT_BASE_EQ_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 948 kunit_binary_assert, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 949 KUNIT_INIT_BINARY_ASSERT_STRUCT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 950 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 951 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 952 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 953 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 954 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 955
73cda7bb8bfb1d Brendan Higgins 2019-09-23 956 #define KUNIT_BINARY_EQ_ASSERTION(test, assert_type, left, right) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 957 KUNIT_BINARY_EQ_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 958 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 959 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 960 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 961 NULL)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 962
73cda7bb8bfb1d Brendan Higgins 2019-09-23 963 #define KUNIT_BINARY_PTR_EQ_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 964 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 965 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 966 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 967 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 968 ...) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 969 KUNIT_BASE_EQ_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 970 kunit_binary_ptr_assert, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 971 KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 972 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 973 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 974 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 975 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 976 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 977
73cda7bb8bfb1d Brendan Higgins 2019-09-23 978 #define KUNIT_BINARY_PTR_EQ_ASSERTION(test, assert_type, left, right) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 979 KUNIT_BINARY_PTR_EQ_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 980 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 981 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 982 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 983 NULL)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 984
73cda7bb8bfb1d Brendan Higgins 2019-09-23 985 #define KUNIT_BINARY_NE_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\
73cda7bb8bfb1d Brendan Higgins 2019-09-23 986 KUNIT_BASE_NE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 987 kunit_binary_assert, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 988 KUNIT_INIT_BINARY_ASSERT_STRUCT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 989 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 990 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 991 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 992 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 993 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 994
73cda7bb8bfb1d Brendan Higgins 2019-09-23 995 #define KUNIT_BINARY_NE_ASSERTION(test, assert_type, left, right) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 996 KUNIT_BINARY_NE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 997 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 998 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 999 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1000 NULL)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1001
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1002 #define KUNIT_BINARY_PTR_NE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1003 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1004 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1005 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1006 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1007 ...) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1008 KUNIT_BASE_NE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1009 kunit_binary_ptr_assert, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1010 KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1011 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1012 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1013 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1014 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1015 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1016
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1017 #define KUNIT_BINARY_PTR_NE_ASSERTION(test, assert_type, left, right) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1018 KUNIT_BINARY_PTR_NE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1019 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1020 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1021 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1022 NULL)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1023
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1024 #define KUNIT_BINARY_LT_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1025 KUNIT_BASE_LT_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1026 kunit_binary_assert, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1027 KUNIT_INIT_BINARY_ASSERT_STRUCT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1028 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1029 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1030 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1031 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1032 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1033
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1034 #define KUNIT_BINARY_LT_ASSERTION(test, assert_type, left, right) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1035 KUNIT_BINARY_LT_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1036 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1037 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1038 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1039 NULL)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1040
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1041 #define KUNIT_BINARY_PTR_LT_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1042 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1043 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1044 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1045 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1046 ...) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1047 KUNIT_BASE_LT_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1048 kunit_binary_ptr_assert, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1049 KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1050 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1051 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1052 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1053 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1054 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1055
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1056 #define KUNIT_BINARY_PTR_LT_ASSERTION(test, assert_type, left, right) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1057 KUNIT_BINARY_PTR_LT_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1058 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1059 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1060 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1061 NULL)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1062
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1063 #define KUNIT_BINARY_LE_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1064 KUNIT_BASE_LE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1065 kunit_binary_assert, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1066 KUNIT_INIT_BINARY_ASSERT_STRUCT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1067 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1068 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1069 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1070 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1071 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1072
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1073 #define KUNIT_BINARY_LE_ASSERTION(test, assert_type, left, right) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1074 KUNIT_BINARY_LE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1075 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1076 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1077 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1078 NULL)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1079
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1080 #define KUNIT_BINARY_PTR_LE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1081 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1082 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1083 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1084 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1085 ...) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1086 KUNIT_BASE_LE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1087 kunit_binary_ptr_assert, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1088 KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1089 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1090 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1091 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1092 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1093 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1094
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1095 #define KUNIT_BINARY_PTR_LE_ASSERTION(test, assert_type, left, right) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1096 KUNIT_BINARY_PTR_LE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1097 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1098 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1099 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1100 NULL)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1101
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1102 #define KUNIT_BINARY_GT_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1103 KUNIT_BASE_GT_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1104 kunit_binary_assert, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1105 KUNIT_INIT_BINARY_ASSERT_STRUCT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1106 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1107 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1108 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1109 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1110 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1111
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1112 #define KUNIT_BINARY_GT_ASSERTION(test, assert_type, left, right) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1113 KUNIT_BINARY_GT_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1114 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1115 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1116 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1117 NULL)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1118
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1119 #define KUNIT_BINARY_PTR_GT_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1120 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1121 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1122 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1123 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1124 ...) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1125 KUNIT_BASE_GT_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1126 kunit_binary_ptr_assert, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1127 KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1128 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1129 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1130 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1131 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1132 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1133
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1134 #define KUNIT_BINARY_PTR_GT_ASSERTION(test, assert_type, left, right) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1135 KUNIT_BINARY_PTR_GT_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1136 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1137 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1138 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1139 NULL)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1140
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1141 #define KUNIT_BINARY_GE_MSG_ASSERTION(test, assert_type, left, right, fmt, ...)\
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1142 KUNIT_BASE_GE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1143 kunit_binary_assert, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1144 KUNIT_INIT_BINARY_ASSERT_STRUCT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1145 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1146 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1147 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1148 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1149 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1150
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1151 #define KUNIT_BINARY_GE_ASSERTION(test, assert_type, left, right) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1152 KUNIT_BINARY_GE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1153 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1154 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1155 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1156 NULL)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1157
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1158 #define KUNIT_BINARY_PTR_GE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1159 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1160 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1161 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1162 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1163 ...) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1164 KUNIT_BASE_GE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1165 kunit_binary_ptr_assert, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1166 KUNIT_INIT_BINARY_PTR_ASSERT_STRUCT, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1167 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1168 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1169 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1170 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1171 ##__VA_ARGS__)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1172
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1173 #define KUNIT_BINARY_PTR_GE_ASSERTION(test, assert_type, left, right) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1174 KUNIT_BINARY_PTR_GE_MSG_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1175 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1176 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1177 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1178 NULL)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1179
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1180 #define KUNIT_BINARY_STR_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1181 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1182 left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1183 op, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1184 right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1185 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1186 ...) \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1187 do { \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 @1188 typeof(left) __left = (left); \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1189 typeof(right) __right = (right); \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1190 \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1191 KUNIT_ASSERTION(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1192 strcmp(__left, __right) op 0, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1193 kunit_binary_str_assert, \
3084db0e0d5076 Daniel Latypov 2020-11-02 1194 KUNIT_INIT_BINARY_STR_ASSERT_STRUCT(test, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1195 assert_type, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1196 #op, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1197 #left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1198 __left, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1199 #right, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1200 __right), \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1201 fmt, \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1202 ##__VA_ARGS__); \
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1203 } while (0)
73cda7bb8bfb1d Brendan Higgins 2019-09-23 1204

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/[email protected]


Attachments:
(No filename) (33.34 kB)
.config.gz (40.46 kB)
Download all attachments

2021-06-01 15:48:00

by Daniel Latypov

[permalink] [raw]
Subject: Re: [PATCH v2 2/4] kunit: tool: Support skipped tests in kunit_tool

On Fri, May 28, 2021 at 12:59 AM David Gow <[email protected]> wrote:
>
> Add support for the SKIP directive to kunit_tool's TAP parser.
>
> Skipped tests now show up as such in the printed summary. The number of
> skipped tests is counted, and if all tests in a suite are skipped, the
> suite is also marked as skipped. Otherwise, skipped tests do affect the
> suite result.
>
> Example output:
> [00:22:34] ======== [SKIPPED] example_skip ========
> [00:22:34] [SKIPPED] example_skip_test # SKIP this test should be skipped
> [00:22:34] [SKIPPED] example_mark_skipped_test # SKIP this test should be skipped
> [00:22:34] ============================================================
> [00:22:34] Testing complete. 2 tests run. 0 failed. 0 crashed. 2 skipped.
>
> Signed-off-by: David Gow <[email protected]>

Reviewed-by: Daniel Latypov <[email protected]>

Some minor remarks, but this looks good to me.

Though I'm surprised there has not been any bikeshedding done about
the color of the SKIPPED output.
So I'll throw an opinion out there.
I think yellow is fine, but I did somewhat recently change another
similar tool to go from yellow => cyan for SKIPPED. The motivation
there was to have a color for "flaky" tests that stood out, and the
most appropriate ANSI color seemed to be yellow (between green for
PASSED and red for FAILED).
And I don't know if KUnit tool will ever get to the point where we
automatically rerun tests on failure, as I can see an argument for
that logic living a layer above.

> ---
>
> Changes since v1:
> https://lore.kernel.org/linux-kselftest/[email protected]/
> - Include missing test logs for kunit_tool_test
> - Encapsulate test counts in a class (Thanks Daniel Latypov)
> - Fix a type hinting issue in the process
>
> ---
> tools/testing/kunit/kunit_parser.py | 77 +++++++++++++------
> tools/testing/kunit/kunit_tool_test.py | 22 ++++++
> .../kunit/test_data/test_skip_all_tests.log | 15 ++++
> .../kunit/test_data/test_skip_tests.log | 15 ++++
> 4 files changed, 105 insertions(+), 24 deletions(-)
> create mode 100644 tools/testing/kunit/test_data/test_skip_all_tests.log
> create mode 100644 tools/testing/kunit/test_data/test_skip_tests.log
>
> diff --git a/tools/testing/kunit/kunit_parser.py b/tools/testing/kunit/kunit_parser.py
> index e8bcc139702e..f07dce1d4146 100644
> --- a/tools/testing/kunit/kunit_parser.py
> +++ b/tools/testing/kunit/kunit_parser.py
> @@ -43,6 +43,7 @@ class TestCase(object):
> class TestStatus(Enum):
> SUCCESS = auto()
> FAILURE = auto()
> + SKIPPED = auto()
> TEST_CRASHED = auto()
> NO_TESTS = auto()
> FAILURE_TO_PARSE_TESTS = auto()
> @@ -108,6 +109,8 @@ def save_non_diagnostic(lines: List[str], test_case: TestCase) -> None:
>
> OkNotOkResult = namedtuple('OkNotOkResult', ['is_ok','description', 'text'])
>
> +OK_NOT_OK_SKIP = re.compile(r'^[\s]*(ok|not ok) [0-9]+ - (.*) # SKIP(.*)$')
> +
> OK_NOT_OK_SUBTEST = re.compile(r'^[\s]+(ok|not ok) [0-9]+ - (.*)$')
>
> OK_NOT_OK_MODULE = re.compile(r'^(ok|not ok) ([0-9]+) - (.*)$')
> @@ -125,6 +128,10 @@ def parse_ok_not_ok_test_case(lines: List[str], test_case: TestCase) -> bool:
> if match:
> test_case.log.append(lines.pop(0))
> test_case.name = match.group(2)
> + skip_match = OK_NOT_OK_SKIP.match(line)
> + if skip_match:
> + test_case.status = TestStatus.SKIPPED
> + return True
> if test_case.status == TestStatus.TEST_CRASHED:
> return True
> if match.group(1) == 'ok':
> @@ -188,16 +195,16 @@ def parse_subtest_plan(lines: List[str]) -> Optional[int]:
> return None
>
> def max_status(left: TestStatus, right: TestStatus) -> TestStatus:
> - if left == TestStatus.TEST_CRASHED or right == TestStatus.TEST_CRASHED:
> + if left == right:
> + return left
> + elif left == TestStatus.TEST_CRASHED or right == TestStatus.TEST_CRASHED:
> return TestStatus.TEST_CRASHED
> elif left == TestStatus.FAILURE or right == TestStatus.FAILURE:
> return TestStatus.FAILURE
> - elif left != TestStatus.SUCCESS:
> - return left
> - elif right != TestStatus.SUCCESS:
> + elif left == TestStatus.SKIPPED:
> return right
> else:
> - return TestStatus.SUCCESS
> + return left
>
> def parse_ok_not_ok_test_suite(lines: List[str],
> test_suite: TestSuite,
> @@ -214,6 +221,9 @@ def parse_ok_not_ok_test_suite(lines: List[str],
> test_suite.status = TestStatus.SUCCESS
> else:
> test_suite.status = TestStatus.FAILURE
> + skip_match = OK_NOT_OK_SKIP.match(line)
> + if skip_match:
> + test_suite.status = TestStatus.SKIPPED
> suite_index = int(match.group(2))
> if suite_index != expected_suite_index:
> print_with_timestamp(
> @@ -224,8 +234,8 @@ def parse_ok_not_ok_test_suite(lines: List[str],
> else:
> return False
>
> -def bubble_up_errors(statuses: Iterable[TestStatus]) -> TestStatus:
> - return reduce(max_status, statuses, TestStatus.SUCCESS)
> +def bubble_up_errors(status_list: Iterable[TestStatus]) -> TestStatus:
> + return reduce(max_status, status_list, TestStatus.SKIPPED)
>
> def bubble_up_test_case_errors(test_suite: TestSuite) -> TestStatus:
> max_test_case_status = bubble_up_errors(x.status for x in test_suite.cases)
> @@ -311,49 +321,68 @@ def parse_test_result(lines: List[str]) -> TestResult:
> else:
> return TestResult(TestStatus.NO_TESTS, [], lines)
>
> -def print_and_count_results(test_result: TestResult) -> Tuple[int, int, int]:
> - total_tests = 0
> - failed_tests = 0
> - crashed_tests = 0
> +class TestCounts:
> + passed: int
> + failed: int
> + crashed: int
> + skipped: int
> +
> + def __init__(self):
> + self.passed = 0
> + self.failed = 0
> + self.crashed = 0
> + self.skipped = 0
> +
> + def total(self) -> int:
> + return self.passed + self.failed + self.crashed + self.skipped
> +
> +def print_and_count_results(test_result: TestResult) -> TestCounts:
> + counts = TestCounts()
> for test_suite in test_result.suites:
> if test_suite.status == TestStatus.SUCCESS:
> print_suite_divider(green('[PASSED] ') + test_suite.name)
> + elif test_suite.status == TestStatus.SKIPPED:
> + print_suite_divider(yellow('[SKIPPED] ') + test_suite.name)
> elif test_suite.status == TestStatus.TEST_CRASHED:
> print_suite_divider(red('[CRASHED] ' + test_suite.name))
> else:
> print_suite_divider(red('[FAILED] ') + test_suite.name)
> for test_case in test_suite.cases:
> - total_tests += 1
> if test_case.status == TestStatus.SUCCESS:
> + counts.passed += 1
> print_with_timestamp(green('[PASSED] ') + test_case.name)
> + elif test_case.status == TestStatus.SKIPPED:
> + counts.skipped += 1
> + print_with_timestamp(yellow('[SKIPPED] ') + test_case.name)
> elif test_case.status == TestStatus.TEST_CRASHED:
> - crashed_tests += 1
> + counts.crashed += 1
> print_with_timestamp(red('[CRASHED] ' + test_case.name))
> print_log(map(yellow, test_case.log))
> print_with_timestamp('')
> else:
> - failed_tests += 1
> + counts.failed += 1
> print_with_timestamp(red('[FAILED] ') + test_case.name)
> print_log(map(yellow, test_case.log))
> print_with_timestamp('')
> - return total_tests, failed_tests, crashed_tests
> + return counts
>
> def parse_run_tests(kernel_output) -> TestResult:
> - total_tests = 0
> - failed_tests = 0
> - crashed_tests = 0
> + counts = TestCounts()
> test_result = parse_test_result(list(isolate_kunit_output(kernel_output)))
> if test_result.status == TestStatus.NO_TESTS:
> print(red('[ERROR] ') + yellow('no tests run!'))
> elif test_result.status == TestStatus.FAILURE_TO_PARSE_TESTS:
> print(red('[ERROR] ') + yellow('could not parse test results!'))
> else:
> - (total_tests,
> - failed_tests,
> - crashed_tests) = print_and_count_results(test_result)
> + counts = print_and_count_results(test_result)
> print_with_timestamp(DIVIDER)
> - fmt = green if test_result.status == TestStatus.SUCCESS else red
> + if test_result.status == TestStatus.SUCCESS:
> + fmt = green
> + elif test_result.status == TestStatus.SKIPPED:
> + fmt = yellow
> + else:
> + fmt =red
> print_with_timestamp(
> - fmt('Testing complete. %d tests run. %d failed. %d crashed.' %
> - (total_tests, failed_tests, crashed_tests)))
> + fmt('Testing complete. %d tests run. %d failed. %d crashed. %d skipped.' %
> + (counts.total(), counts.failed, counts.crashed, counts.skipped)))

This looks good to me, just want to comment that we'll probably want
to factor this into a helper in TestCounts the next time we add a
status.
I've written very similar code for other projects, and it can help to reduce
42 tests run. 0 failed. 0 crashed. 1 skipped.
to something like
42 tests run. 1 skipped.

But with just these, I think it's fine to leave them entirely as-is.
We can decide later if we want to tersen the output.

E.g. we might decide that we want to have
42 tests run. 2 timed out. 1 crashed.
in the future.

> return test_result
> diff --git a/tools/testing/kunit/kunit_tool_test.py b/tools/testing/kunit/kunit_tool_test.py
> index 2e809dd956a7..a51e70cafcc1 100755
> --- a/tools/testing/kunit/kunit_tool_test.py
> +++ b/tools/testing/kunit/kunit_tool_test.py
> @@ -183,6 +183,28 @@ class KUnitParserTest(unittest.TestCase):
> kunit_parser.TestStatus.TEST_CRASHED,
> result.status)
>
> + def test_skipped_test(self):
> + skipped_log = test_data_path('test_skip_tests.log')
> + file = open(skipped_log)
> + result = kunit_parser.parse_run_tests(file.readlines())

This would be slightly safer as

with open(skipped_log) as file:
result = kunit_parser.parse_run_tests(file.readlines())

As-is, the code will leak FDs if the test fails.

But you've stated a preference before for having tests like this, so I
don't care too much either way.
It's less confusing to someone thinking in a C mindset, since `result`
will more obviously be in scope.


> +
> + # A skipped test does not fail the whole suite.
> + self.assertEqual(
> + kunit_parser.TestStatus.SUCCESS,
> + result.status)
> + file.close()
> +
> + def test_skipped_all_tests(self):
> + skipped_log = test_data_path('test_skip_all_tests.log')
> + file = open(skipped_log)
> + result = kunit_parser.parse_run_tests(file.readlines())
> +
> + self.assertEqual(
> + kunit_parser.TestStatus.SKIPPED,
> + result.status)
> + file.close()
> +
> +
> def test_ignores_prefix_printk_time(self):
> prefix_log = test_data_path('test_config_printk_time.log')
> with open(prefix_log) as file:
> diff --git a/tools/testing/kunit/test_data/test_skip_all_tests.log b/tools/testing/kunit/test_data/test_skip_all_tests.log
> new file mode 100644
> index 000000000000..2ea6e6d14fff
> --- /dev/null
> +++ b/tools/testing/kunit/test_data/test_skip_all_tests.log
> @@ -0,0 +1,15 @@
> +TAP version 14
> +1..2
> + # Subtest: string-stream-test
> + 1..3
> + ok 1 - string_stream_test_empty_on_creation # SKIP all tests skipped
> + ok 2 - string_stream_test_not_empty_after_add # SKIP all tests skipped
> + ok 3 - string_stream_test_get_string # SKIP all tests skipped
> +ok 1 - string-stream-test # SKIP
> + # Subtest: example
> + 1..2
> + # example_simple_test: initializing
> + ok 1 - example_simple_test # SKIP all tests skipped
> + # example_skip_test: initializing
> + ok 2 - example_skip_test # SKIP this test should be skipped
> +ok 2 - example # SKIP
> diff --git a/tools/testing/kunit/test_data/test_skip_tests.log b/tools/testing/kunit/test_data/test_skip_tests.log
> new file mode 100644
> index 000000000000..79b326e31274
> --- /dev/null
> +++ b/tools/testing/kunit/test_data/test_skip_tests.log
> @@ -0,0 +1,15 @@
> +TAP version 14
> +1..2
> + # Subtest: string-stream-test
> + 1..3
> + ok 1 - string_stream_test_empty_on_creation
> + ok 2 - string_stream_test_not_empty_after_add
> + ok 3 - string_stream_test_get_string
> +ok 1 - string-stream-test
> + # Subtest: example
> + 1..2
> + # example_simple_test: initializing
> + ok 1 - example_simple_test
> + # example_skip_test: initializing
> + ok 2 - example_skip_test # SKIP this test should be skipped
> +ok 2 - example
> --
> 2.32.0.rc0.204.g9fa02ecfa5-goog
>

2021-06-04 21:06:14

by Brendan Higgins

[permalink] [raw]
Subject: Re: [PATCH v2 1/4] kunit: Support skipped tests

On Fri, May 28, 2021 at 12:59 AM David Gow <[email protected]> wrote:
>
> The kunit_mark_skipped() macro marks the current test as "skipped", with
> the provided reason. The kunit_skip() macro will mark the test as
> skipped, and abort the test.
>
> The TAP specification supports this "SKIP directive" as a comment after
> the "ok" / "not ok" for a test. See the "Directives" section of the TAP
> spec for details:
> https://testanything.org/tap-specification.html#directives
>
> The 'success' field for KUnit tests is replaced with a kunit_status
> enum, which can be SUCCESS, FAILURE, or SKIPPED, combined with a
> 'status_comment' containing information on why a test was skipped.
>
> A new 'kunit_status' test suite is added to test this.
>
> Signed-off-by: David Gow <[email protected]>
> Tested-by: Marco Elver <[email protected]>
> Reviewed-by: Daniel Latypov <[email protected]>

One fairly minor nit below. Other than that, looks great!

Reviewed-by: Brendan Higgins <[email protected]>

> ---

[...]

> diff --git a/include/kunit/test.h b/include/kunit/test.h
> index b68c61348121..1401c620ac5e 100644
> --- a/include/kunit/test.h
> +++ b/include/kunit/test.h
> @@ -105,6 +105,18 @@ struct kunit;
> #define KUNIT_SUBTEST_INDENT " "
> #define KUNIT_SUBSUBTEST_INDENT " "
>
> +/**
> + * enum kunit_status - Type of result for a test or test suite
> + * @KUNIT_SUCCESS: Denotes the test suite has not failed nor been skipped
> + * @KUNIT_FAILURE: Denotes the test has failed.
> + * @KUNIT_SKIPPED: Denotes the test has been skipped.
> + */
> +enum kunit_status {
> + KUNIT_SUCCESS,
> + KUNIT_FAILURE,
> + KUNIT_SKIPPED,
> +};
> +
> /**
> * struct kunit_case - represents an individual test case.
> *
> @@ -148,13 +160,20 @@ struct kunit_case {
> const void* (*generate_params)(const void *prev, char *desc);
>
> /* private: internal use only. */
> - bool success;
> + enum kunit_status status;
> char *log;
> };
>
> -static inline char *kunit_status_to_string(bool status)
> +static inline char *kunit_status_to_ok_not_ok(enum kunit_status status)
> {
> - return status ? "ok" : "not ok";
> + switch (status) {
> + case KUNIT_SKIPPED:
> + case KUNIT_SUCCESS:
> + return "ok";
> + case KUNIT_FAILURE:
> + return "not ok";
> + }
> + return "invalid";
> }
>
> /**
> @@ -212,6 +231,7 @@ struct kunit_suite {
> struct kunit_case *test_cases;
>
> /* private: internal use only */
> + char status_comment[256];

nit: How about we make the 256 a constant since you use it in a number
of places?

If not, at least when you reference the struct, you might want to use
ARRAY_SIZE(...).

> struct dentry *debugfs;
> char *log;
> };
[...]

2021-06-04 21:31:52

by Brendan Higgins

[permalink] [raw]
Subject: Re: [PATCH v2 2/4] kunit: tool: Support skipped tests in kunit_tool

On Tue, Jun 1, 2021 at 8:46 AM Daniel Latypov <[email protected]> wrote:
>
> On Fri, May 28, 2021 at 12:59 AM David Gow <[email protected]> wrote:
> >
> > Add support for the SKIP directive to kunit_tool's TAP parser.
> >
> > Skipped tests now show up as such in the printed summary. The number of
> > skipped tests is counted, and if all tests in a suite are skipped, the
> > suite is also marked as skipped. Otherwise, skipped tests do affect the
> > suite result.
> >
> > Example output:
> > [00:22:34] ======== [SKIPPED] example_skip ========
> > [00:22:34] [SKIPPED] example_skip_test # SKIP this test should be skipped
> > [00:22:34] [SKIPPED] example_mark_skipped_test # SKIP this test should be skipped
> > [00:22:34] ============================================================
> > [00:22:34] Testing complete. 2 tests run. 0 failed. 0 crashed. 2 skipped.
> >
> > Signed-off-by: David Gow <[email protected]>
>
> Reviewed-by: Daniel Latypov <[email protected]>
>
> Some minor remarks, but this looks good to me.
>
> Though I'm surprised there has not been any bikeshedding done about
> the color of the SKIPPED output.
> So I'll throw an opinion out there.
> I think yellow is fine, but I did somewhat recently change another
> similar tool to go from yellow => cyan for SKIPPED. The motivation
> there was to have a color for "flaky" tests that stood out, and the
> most appropriate ANSI color seemed to be yellow (between green for
> PASSED and red for FAILED).
> And I don't know if KUnit tool will ever get to the point where we
> automatically rerun tests on failure, as I can see an argument for
> that logic living a layer above.

I do have some sympathy for using a different color for each type of
message. I am not arguing against cyan, but I am also OK with yellow.
However, if we get to the point where we support flaky warnings, what
if we used orange for flaky?

2021-06-04 21:46:44

by Daniel Latypov

[permalink] [raw]
Subject: Re: [PATCH v2 2/4] kunit: tool: Support skipped tests in kunit_tool

On Fri, Jun 4, 2021 at 2:30 PM 'Brendan Higgins' via KUnit Development
<[email protected]> wrote:
>
> On Tue, Jun 1, 2021 at 8:46 AM Daniel Latypov <[email protected]> wrote:
> >
> > On Fri, May 28, 2021 at 12:59 AM David Gow <[email protected]> wrote:
> > >
> > > Add support for the SKIP directive to kunit_tool's TAP parser.
> > >
> > > Skipped tests now show up as such in the printed summary. The number of
> > > skipped tests is counted, and if all tests in a suite are skipped, the
> > > suite is also marked as skipped. Otherwise, skipped tests do affect the
> > > suite result.
> > >
> > > Example output:
> > > [00:22:34] ======== [SKIPPED] example_skip ========
> > > [00:22:34] [SKIPPED] example_skip_test # SKIP this test should be skipped
> > > [00:22:34] [SKIPPED] example_mark_skipped_test # SKIP this test should be skipped
> > > [00:22:34] ============================================================
> > > [00:22:34] Testing complete. 2 tests run. 0 failed. 0 crashed. 2 skipped.
> > >
> > > Signed-off-by: David Gow <[email protected]>
> >
> > Reviewed-by: Daniel Latypov <[email protected]>
> >
> > Some minor remarks, but this looks good to me.
> >
> > Though I'm surprised there has not been any bikeshedding done about
> > the color of the SKIPPED output.
> > So I'll throw an opinion out there.
> > I think yellow is fine, but I did somewhat recently change another
> > similar tool to go from yellow => cyan for SKIPPED. The motivation
> > there was to have a color for "flaky" tests that stood out, and the
> > most appropriate ANSI color seemed to be yellow (between green for
> > PASSED and red for FAILED).
> > And I don't know if KUnit tool will ever get to the point where we
> > automatically rerun tests on failure, as I can see an argument for
> > that logic living a layer above.
>
> I do have some sympathy for using a different color for each type of
> message. I am not arguing against cyan, but I am also OK with yellow.
> However, if we get to the point where we support flaky warnings, what
> if we used orange for flaky?

We can always change the colors later.
I don't seriously think this should hold up the patch.
I was partially just bemused that no one had chimed in about the
color, as that is the apocryphal thing to bikeshed. Was curious if
broaching the topic would elicit any response, but given the silence,
I think we can truly say that no one cares.

Also, orange only works if we're going to assume 256-color support,
which I'd be against*.

Given that, our options are:
Black, Red, Green, Yellow, Blue, Magenta, Cyan, White
(and the "bright" variations thereof)

So yellow is the closest we'd get, which is why I'd made the shift to
cyan for the aforementioned other projects.

>
> --
> You received this message because you are subscribed to the Google Groups "KUnit Development" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to [email protected].
> To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/CAFd5g44VS%3D%3D1yULMRS-JMxrArj9GFJRkuDCxoxnZHcj3PVbFHg%40mail.gmail.com.