On Tue, 25 Jul 2023 at 00:30, Rae Moar rmoar@google.com wrote:

Add the basic structure of the test attribute API to KUnit, which can be used to save and access test associated data.

Add attributes.c and attributes.h to hold associated structs and functions for the API.

Create a struct that holds a variety of associated helper functions for each test attribute. These helper functions will be used to get the attribute value, convert the value to a string, and filter based on the value. This struct is flexible by design to allow for attributes of numerous types and contexts.

Add a method to print test attributes in the format of "# [<test_name if not suite>.]<attribute_name>: <attribute_value>".

Example for a suite: "# speed: slow"

Example for a test case: "# test_case.speed: very_slow"

Use this method to report attributes in the KTAP output (KTAP spec: https://docs.kernel.org/dev-tools/ktap.html) and _list_tests output when kernel's new kunit.action=list_attr option is used. Note this is derivative of the kunit.action=list option.

In test.h, add fields and associated helper functions to test cases and suites to hold user-inputted test attributes.

Signed-off-by: Rae Moar rmoar@google.com

Looks good to me.

Reviewed-by: David Gow davidgow@google.com

Cheers, -- David

Changes since v1:

• No major changes

Changes since RFC v2:

• No major changes

Changes since RFC v1:

• Add list_attr option to only include attribute in the _list_tests output when this module param is set
• Add printing options for attributes to print always, print only for suites, or print never.

include/kunit/attributes.h | 19 +++++++++ include/kunit/test.h | 33 ++++++++++++++++ lib/kunit/Makefile | 3 +- lib/kunit/attributes.c | 80 ++++++++++++++++++++++++++++++++++++++ lib/kunit/executor.c | 21 ++++++++-- lib/kunit/test.c | 17 ++++---- 6 files changed, 161 insertions(+), 12 deletions(-) create mode 100644 include/kunit/attributes.h create mode 100644 lib/kunit/attributes.c

diff --git a/include/kunit/attributes.h b/include/kunit/attributes.h new file mode 100644 index 000000000000..9fcd184cce36 --- /dev/null +++ b/include/kunit/attributes.h @@ -0,0 +1,19 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/*

• • KUnit API to save and access test attributes
• • Copyright (C) 2023, Google LLC.
• • Author: Rae Moar rmoar@google.com
• */

+#ifndef _KUNIT_ATTRIBUTES_H +#define _KUNIT_ATTRIBUTES_H

+/*

• • Print all test attributes for a test case or suite.
• • Output format for test cases: "# <test_name>.<attribute>: <value>"
• • Output format for test suites: "# <attribute>: <value>"
• */

+void kunit_print_attr(void *test_or_suite, bool is_test, unsigned int test_level);

+#endif /* _KUNIT_ATTRIBUTES_H */ diff --git a/include/kunit/test.h b/include/kunit/test.h index 23120d50499e..1fc9155988e9 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -63,12 +63,16 @@ enum kunit_status { KUNIT_SKIPPED, };

+/* Holds attributes for each test case and suite */ +struct kunit_attributes {};

/**

• struct kunit_case - represents an individual test case.
• @run_case: the function representing the actual test case.
• @name: the name of the test case.
• @generate_params: the generator function for parameterized tests.

• • @attr: the attributes associated with the test
  • A test case is a function with the signature,
  • ``void (*)(struct kunit *)``

@@ -104,6 +108,7 @@ struct kunit_case { void (*run_case)(struct kunit *test); const char *name; const void* (*generate_params)(const void *prev, char *desc);

•   struct kunit_attributes attr;
  
    /* private: internal use only. */
    enum kunit_status status;
  

@@ -133,6 +138,18 @@ static inline char *kunit_status_to_ok_not_ok(enum kunit_status status) */ #define KUNIT_CASE(test_name) { .run_case = test_name, .name = #test_name }

+/**

• • KUNIT_CASE_ATTR - A helper for creating a &struct kunit_case
• • with attributes
• • @test_name: a reference to a test case function.
• • @attributes: a reference to a struct kunit_attributes object containing
• • test attributes
• */

+#define KUNIT_CASE_ATTR(test_name, attributes) \

•           { .run_case = test_name, .name = #test_name,    \
  

•             .attr = attributes }
  

/**

• KUNIT_CASE_PARAM - A helper for creation a parameterized &struct kunit_case

@@ -154,6 +171,20 @@ static inline char *kunit_status_to_ok_not_ok(enum kunit_status status) { .run_case = test_name, .name = #test_name, \ .generate_params = gen_params }

+/**

• • KUNIT_CASE_PARAM_ATTR - A helper for creating a parameterized &struct
• • kunit_case with attributes
• • @test_name: a reference to a test case function.
• • @gen_params: a reference to a parameter generator function.
• • @attributes: a reference to a struct kunit_attributes object containing
• • test attributes
• */

+#define KUNIT_CASE_PARAM_ATTR(test_name, gen_params, attributes) \

•           { .run_case = test_name, .name = #test_name,    \
  

•             .generate_params = gen_params,                                \
  

•             .attr = attributes }
  

/**

• struct kunit_suite - describes a related collection of &struct kunit_case

@@ -163,6 +194,7 @@ static inline char *kunit_status_to_ok_not_ok(enum kunit_status status)

• @init: called before every test case.
• @exit: called after every test case.
• @test_cases: a null terminated array of test cases.

• • @attr: the attributes associated with the test suite
  • A kunit_suite is a collection of related &struct kunit_case s, such that
  • @init is called before every test case and @exit is called after every

@@ -182,6 +214,7 @@ struct kunit_suite { int (*init)(struct kunit *test); void (*exit)(struct kunit *test); struct kunit_case *test_cases;

•   struct kunit_attributes attr;
  
    /* private: internal use only */
    char status_comment[KUNIT_STATUS_COMMENT_SIZE];
  

diff --git a/lib/kunit/Makefile b/lib/kunit/Makefile index cb417f504996..46f75f23dfe4 100644 --- a/lib/kunit/Makefile +++ b/lib/kunit/Makefile @@ -6,7 +6,8 @@ kunit-objs += test.o \ string-stream.o \ assert.o \ try-catch.o \

•                                   executor.o
  

•                                   executor.o \
  

•                                   attributes.o
  
  

ifeq ($(CONFIG_KUNIT_DEBUGFS),y) kunit-objs += debugfs.o diff --git a/lib/kunit/attributes.c b/lib/kunit/attributes.c new file mode 100644 index 000000000000..9bda5a5f4030 --- /dev/null +++ b/lib/kunit/attributes.c @@ -0,0 +1,80 @@ +// SPDX-License-Identifier: GPL-2.0 +/*

• • KUnit API to save and access test attributes
• • Copyright (C) 2023, Google LLC.
• • Author: Rae Moar rmoar@google.com
• */

+#include <kunit/test.h> +#include <kunit/attributes.h>

+/* Options for printing attributes:

• • PRINT_ALWAYS - attribute is printed for every test case and suite if set
• • PRINT_SUITE - attribute is printed for every suite if set but not for test cases
• • PRINT_NEVER - attribute is never printed
• */

+enum print_ops {

•   PRINT_ALWAYS,
  

•   PRINT_SUITE,
  

•   PRINT_NEVER,
  

+};

+/**

• • struct kunit_attr - represents a test attribute and holds flexible
• • helper functions to interact with attribute.
• • @name: name of test attribute, eg. speed
• • @get_attr: function to return attribute value given a test
• • @to_string: function to return string representation of given
• • attribute value
• • @filter: function to indicate whether a given attribute value passes a
• • filter
• */

+struct kunit_attr {

•   const char *name;
  

•   void *(*get_attr)(void *test_or_suite, bool is_test);
  

•   const char *(*to_string)(void *attr, bool *to_free);
  

•   int (*filter)(void *attr, const char *input, int *err);
  

•   void *attr_default;
  

•   enum print_ops print;
  

+};

+/* List of all Test Attributes */

+static struct kunit_attr kunit_attr_list[] = {};

+/* Helper Functions to Access Attributes */

+void kunit_print_attr(void *test_or_suite, bool is_test, unsigned int test_level) +{

•   int i;
  

•   bool to_free;
  

•   void *attr;
  

•   const char *attr_name, *attr_str;
  

•   struct kunit_suite *suite = is_test ? NULL : test_or_suite;
  

•   struct kunit_case *test = is_test ? test_or_suite : NULL;
  

•   for (i = 0; i < ARRAY_SIZE(kunit_attr_list); i++) {
  

•           if (kunit_attr_list[i].print == PRINT_NEVER ||
  

•                           (test && kunit_attr_list[i].print == PRINT_SUITE))
  

•                   continue;
  

•           attr = kunit_attr_list[i].get_attr(test_or_suite, is_test);
  

•           if (attr) {
  

•                   attr_name = kunit_attr_list[i].name;
  

•                   attr_str = kunit_attr_list[i].to_string(attr, &to_free);
  

•                   if (test) {
  

•                           kunit_log(KERN_INFO, test, "%*s# %s.%s: %s",
  

•                                   KUNIT_INDENT_LEN * test_level, "", test->name,
  

•                                   attr_name, attr_str);
  

•                   } else {
  

•                           kunit_log(KERN_INFO, suite, "%*s# %s: %s",
  

•                                   KUNIT_INDENT_LEN * test_level, "", attr_name, attr_str);
  

•                   }
  

•                   /* Free to_string of attribute if needed */
  

•                   if (to_free)
  

•                           kfree(attr_str);
  

•           }
  

•   }
  

+} diff --git a/lib/kunit/executor.c b/lib/kunit/executor.c index 74982b83707c..12e38a48a5cc 100644 --- a/lib/kunit/executor.c +++ b/lib/kunit/executor.c @@ -2,6 +2,7 @@

#include <linux/reboot.h> #include <kunit/test.h> +#include <kunit/attributes.h> #include <linux/glob.h> #include <linux/moduleparam.h>

@@ -24,7 +25,8 @@ module_param_named(action, action_param, charp, 0); MODULE_PARM_DESC(action, "Changes KUnit executor behavior, valid values are:\n" "<none>: run the tests like normal\n"

•            "'list' to list test names instead of running them.\n");
  

•            "'list' to list test names instead of running them.\n"
  

•            "'list_attr' to list test names and attributes instead of running them.\n");
  
  

/* glob_match() needs NULL terminated strings, so we need a copy of filter_glob_param. */ struct kunit_test_filter { @@ -172,7 +174,7 @@ static void kunit_exec_run_tests(struct suite_set *suite_set) __kunit_test_suites_init(suite_set->start, num_suites); }

-static void kunit_exec_list_tests(struct suite_set *suite_set) +static void kunit_exec_list_tests(struct suite_set *suite_set, bool include_attr) { struct kunit_suite * const *suites; struct kunit_case *test_case; @@ -180,10 +182,19 @@ static void kunit_exec_list_tests(struct suite_set *suite_set) /* Hack: print a ktap header so kunit.py can find the start of KUnit output. */ pr_info("KTAP version 1\n");

•   for (suites = suite_set->start; suites < suite_set->end; suites++)
  

•   for (suites = suite_set->start; suites < suite_set->end; suites++) {
  

•           /* Print suite name and suite attributes */
  

•           pr_info("%s\n", (*suites)->name);
  

•           if (include_attr)
  

•                   kunit_print_attr((void *)(*suites), false, 0);
  

•           /* Print test case name and attributes in suite */
            kunit_suite_for_each_test_case((*suites), test_case) {
                    pr_info("%s.%s\n", (*suites)->name, test_case->name);
  

•                   if (include_attr)
  

•                           kunit_print_attr((void *)test_case, true, 0);
            }
  

•   }
  

}

int kunit_run_all_tests(void) @@ -206,7 +217,9 @@ int kunit_run_all_tests(void) if (!action_param) kunit_exec_run_tests(&suite_set); else if (strcmp(action_param, "list") == 0)

•           kunit_exec_list_tests(&suite_set);
  

•           kunit_exec_list_tests(&suite_set, false);
  

•   else if (strcmp(action_param, "list_attr") == 0)
  

•           kunit_exec_list_tests(&suite_set, true);
    else
            pr_err("kunit executor: unknown action '%s'\n", action_param);
  
  

diff --git a/lib/kunit/test.c b/lib/kunit/test.c index 84e4666555c9..9ee55139ecd1 100644 --- a/lib/kunit/test.c +++ b/lib/kunit/test.c @@ -9,6 +9,7 @@ #include <kunit/resource.h> #include <kunit/test.h> #include <kunit/test-bug.h> +#include <kunit/attributes.h> #include <linux/kernel.h> #include <linux/module.h> #include <linux/moduleparam.h> @@ -168,6 +169,13 @@ size_t kunit_suite_num_test_cases(struct kunit_suite *suite) } EXPORT_SYMBOL_GPL(kunit_suite_num_test_cases);

+/* Currently supported test levels */ +enum {

•   KUNIT_LEVEL_SUITE = 0,
  

•   KUNIT_LEVEL_CASE,
  

•   KUNIT_LEVEL_CASE_PARAM,
  

+};

static void kunit_print_suite_start(struct kunit_suite *suite) { /* @@ -181,17 +189,11 @@ static void kunit_print_suite_start(struct kunit_suite *suite) pr_info(KUNIT_SUBTEST_INDENT "KTAP version 1\n"); pr_info(KUNIT_SUBTEST_INDENT "# Subtest: %s\n", suite->name);

•   kunit_print_attr((void *)suite, false, KUNIT_LEVEL_CASE);
    pr_info(KUNIT_SUBTEST_INDENT "1..%zd\n",
              kunit_suite_num_test_cases(suite));
  

}

-/* Currently supported test levels */ -enum {

•   KUNIT_LEVEL_SUITE = 0,
  

•   KUNIT_LEVEL_CASE,
  

•   KUNIT_LEVEL_CASE_PARAM,
  

-};

static void kunit_print_ok_not_ok(struct kunit *test, unsigned int test_level, enum kunit_status status, @@ -651,6 +653,7 @@ int kunit_run_tests(struct kunit_suite *suite) } }

•           kunit_print_attr((void *)test_case, true, KUNIT_LEVEL_CASE);
  
            kunit_print_test_stats(&test, param_stats);
  
  

-- 2.41.0.487.g6d72f3e995-goog

On Tue, 25 Jul 2023 at 00:30, Rae Moar rmoar@google.com wrote:

Add filtering of test attributes. Users can filter tests using the module_param called "filter".

Filters are imputed in the format: <attribute_name><operation><value>

Example: kunit.filter="speed>slow"

Operations include: >, <, >=, <=, !=, and =. These operations will act the same for attributes of the same type but may not between types.

Note multiple filters can be inputted by separating them with a comma. Example: kunit.filter="speed=slow, module!=example"

Since both suites and test cases can have attributes, there may be conflicts. The process of filtering follows these rules:

• Filtering always operates at a per-test level.
• If a test has an attribute set, then the test's value is filtered on.
• Otherwise, the value falls back to the suite's value.
• If neither are set, the attribute has a global "default" value, which is used.

Filtered tests will not be run or show in output. The tests can instead be skipped using the configurable option "kunit.filter_action=skip".

Note the default settings for running tests remains unfiltered.

Finally, add "filter" methods for the speed and module attributes to parse and compare attribute values.

Note this filtering functionality will be added to kunit.py in the next patch.

Signed-off-by: Rae Moar rmoar@google.com

Looks good. One super-minor formatting nitpick below.

Reviewed-by: David Gow davidgow@google.com

Cheers, -- David

Changes since v1:

• Fix compile warning of use of uninitialized variable

Changes since RFC v2:

• Change to output only one error before exiting.

Changes since RFC v1:

• Change method for inputting filters to allow for spaces in filtering values
• Add option to skip filtered tests instead of not run or show them with the filter_action=skip flag

include/kunit/attributes.h | 31 +++++ lib/kunit/attributes.c | 271 +++++++++++++++++++++++++++++++++++++ lib/kunit/executor.c | 94 ++++++++++--- lib/kunit/executor_test.c | 12 +- lib/kunit/test.c | 10 +- 5 files changed, 390 insertions(+), 28 deletions(-)

diff --git a/include/kunit/attributes.h b/include/kunit/attributes.h index 9fcd184cce36..bc76a0b786d2 100644 --- a/include/kunit/attributes.h +++ b/include/kunit/attributes.h @@ -9,6 +9,20 @@ #ifndef _KUNIT_ATTRIBUTES_H #define _KUNIT_ATTRIBUTES_H

+/*

• • struct kunit_attr_filter - representation of attributes filter with the
• • attribute object and string input
• */

+struct kunit_attr_filter {

•   struct kunit_attr *attr;
  

•   char *input;
  

+};

+/*

• • Returns the name of the filter's attribute.
• */

+const char *kunit_attr_filter_name(struct kunit_attr_filter filter);

/*

• Print all test attributes for a test case or suite.
• Output format for test cases: "# <test_name>.<attribute>: <value>"

@@ -16,4 +30,21 @@ */ void kunit_print_attr(void *test_or_suite, bool is_test, unsigned int test_level);

+/*

• • Returns the number of fitlers in input.
• */

+int kunit_get_filter_count(char *input);

+/*

• • Parse attributes filter input and return an objects containing the
• • attribute object and the string input of the next filter.
• */

+struct kunit_attr_filter kunit_next_attr_filter(char **filters, int *err);

+/*

• • Returns a copy of the suite containing only tests that pass the filter.
• */

+struct kunit_suite *kunit_filter_attr_tests(const struct kunit_suite *const suite,

•           struct kunit_attr_filter filter, char *action, int *err);
  

#endif /* _KUNIT_ATTRIBUTES_H */ diff --git a/lib/kunit/attributes.c b/lib/kunit/attributes.c index 9dce4f4d726c..d37c40c0ce4f 100644 --- a/lib/kunit/attributes.c +++ b/lib/kunit/attributes.c @@ -67,6 +67,104 @@ static const char *attr_string_to_string(void *attr, bool *to_free) return (char *) attr; }

+/* Filter Methods */

+static const char op_list[] = "<>!=";

+/*

• • Returns whether the inputted integer value matches the filter given
• • by the operation string and inputted integer.
• */

+static int int_filter(long val, const char *op, int input, int *err) +{

•   if (!strncmp(op, "<=", 2))
  

•           return (val <= input);
  

•   else if (!strncmp(op, ">=", 2))
  

•           return (val >= input);
  

•   else if (!strncmp(op, "!=", 2))
  

•           return (val != input);
  

•   else if (!strncmp(op, ">", 1))
  

•           return (val > input);
  

•   else if (!strncmp(op, "<", 1))
  

•           return (val < input);
  

•   else if (!strncmp(op, "=", 1))
  

•           return (val == input);
  

•   *err = -EINVAL;
  

•   pr_err("kunit executor: invalid filter operation: %s\n", op);
  

•   return false;
  

+}

+/*

• • Returns whether the inputted enum value "attr" matches the filter given
• • by the input string. Note: the str_list includes the corresponding string
• • list to the enum values.
• */

+static int attr_enum_filter(void *attr, const char *input, int *err,

•           const char * const str_list[], int max)
  

+{

•   int i, j, input_int;
  

•   long test_val = (long)attr;
  

•   const char *input_val = NULL;
  

•   for (i = 0; input[i]; i++) {
  

•           if (!strchr(op_list, input[i])) {
  

•                   input_val = input + i;
  

•                   break;
  

•           }
  

•   }
  

•   if (!input_val) {
  

•           *err = -EINVAL;
  

•           pr_err("kunit executor: filter value not found: %s\n", input);
  

•           return false;
  

•   }
  

•   for (j = 0; j <= max; j++) {
  

•           if (!strcmp(input_val, str_list[j]))
  

•                   input_int = j;
  

•   }
  

•   if (!input_int) {
  

•           *err = -EINVAL;
  

•           pr_err("kunit executor: invalid filter input: %s\n", input);
  

•           return false;
  

•   }
  

•   return int_filter(test_val, input, input_int, err);
  

+}

+static int attr_speed_filter(void *attr, const char *input, int *err) +{

•   return attr_enum_filter(attr, input, err, speed_str_list, KUNIT_SPEED_MAX);
  

+}

+/*

• • Returns whether the inputted string value (attr) matches the filter given
• • by the input string.
• */

+static int attr_string_filter(void *attr, const char *input, int *err) +{

•   char *str = attr;
  

•   if (!strncmp(input, "<", 1)) {
  

•           *err = -EINVAL;
  

•           pr_err("kunit executor: invalid filter input: %s\n", input);
  

•           return false;
  

•   } else if (!strncmp(input, ">", 1)) {
  

•           *err = -EINVAL;
  

•           pr_err("kunit executor: invalid filter input: %s\n", input);
  

•           return false;
  

•   } else if (!strncmp(input, "!=", 2)) {
  

•           return (strcmp(input + 2, str) != 0);
  

•   } else if (!strncmp(input, "=", 1)) {
  

•           return (strcmp(input + 1, str) == 0);
  

•   }
  

•   *err = -EINVAL;
  

•   pr_err("kunit executor: invalid filter operation: %s\n", input);
  

•   return false;
  

+}

/* Get Attribute Methods */

static void *attr_speed_get(void *test_or_suite, bool is_test) @@ -99,6 +197,7 @@ static struct kunit_attr kunit_attr_list[] = { .name = "speed", .get_attr = attr_speed_get, .to_string = attr_speed_to_string,

•           .filter = attr_speed_filter,
            .attr_default = (void *)KUNIT_SPEED_NORMAL,
            .print = PRINT_ALWAYS,
    },
  

@@ -106,6 +205,7 @@ static struct kunit_attr kunit_attr_list[] = { .name = "module", .get_attr = attr_module_get, .to_string = attr_string_to_string,

•           .filter = attr_string_filter,
            .attr_default = (void *)"",
            .print = PRINT_SUITE,
    }
  

@@ -113,6 +213,11 @@ static struct kunit_attr kunit_attr_list[] = {

/* Helper Functions to Access Attributes */

+const char *kunit_attr_filter_name(struct kunit_attr_filter filter) +{

•   return filter.attr->name;
  

+}

void kunit_print_attr(void *test_or_suite, bool is_test, unsigned int test_level) { int i; @@ -145,3 +250,169 @@ void kunit_print_attr(void *test_or_suite, bool is_test, unsigned int test_level } } }

+/* Helper Functions to Filter Attributes */

+int kunit_get_filter_count(char *input) +{

•   int i, comma_index, count = 0;
  

•   for (i = 0; input[i]; i++) {
  

•           if (input[i] == ',') {
  

•                   if ((i - comma_index) > 1)
  

•                           count++;
  

•                   comma_index = i;
  

•           }
  

•   }
  

•   if ((i - comma_index) > 0)
  

•           count++;
  

•   return count;
  

+}

+struct kunit_attr_filter kunit_next_attr_filter(char **filters, int *err) +{

•   struct kunit_attr_filter filter = {};
  

•   int i, j, comma_index, new_start_index;
  

•   int op_index = -1, attr_index = -1;
  

•   char op;
  

•   char *input = *filters;
  

•   /* Parse input until operation */
  

•   for (i = 0; input[i]; i++) {
  

•           if (op_index < 0 && strchr(op_list, input[i])) {
  

•                   op_index = i;
  

•           } else if (!comma_index && input[i] == ',') {
  

•                   comma_index = i;
  

•           } else if (comma_index && input[i] != ' ') {
  

•                   new_start_index = i;
  

•                   break;
  

•           }
  

•   }
  

•   if (op_index <= 0) {
  

•           *err = -EINVAL;
  

•           pr_err("kunit executor: filter operation not found: %s\n", input);
  

•           return filter;
  

•   }
  

•   /* Temporarily set operator to \0 character. */
  

•   op = input[op_index];
  

•   input[op_index] = '\0';
  

•   /* Find associated kunit_attr object */
  

•   for (j = 0; j < ARRAY_SIZE(kunit_attr_list); j++) {
  

•           if (!strcmp(input, kunit_attr_list[j].name)) {
  

•                   attr_index = j;
  

•                   break;
  

•           }
  

•   }
  

•   input[op_index] = op;
  

•   if (attr_index < 0) {
  

•           *err = -EINVAL;
  

•           pr_err("kunit executor: attribute not found: %s\n", input);
  

•   } else {
  

•           filter.attr = &kunit_attr_list[attr_index];
  

•   }
  

•   if (comma_index) {
  

•           input[comma_index] = '\0';
  

•           filter.input = input + op_index;
  

•           input = input + new_start_index;
  

•   } else {
  

•           filter.input = input + op_index;
  

•           input = NULL;
  

•   }
  

•   *filters = input;
  

•   return filter;
  

+}

+struct kunit_suite *kunit_filter_attr_tests(const struct kunit_suite *const suite,

•           struct kunit_attr_filter filter, char *action, int *err)
  

+{

•   int n = 0;
  

•   struct kunit_case *filtered, *test_case;
  

•   struct kunit_suite *copy;
  

•   void *suite_val, *test_val;
  

•   bool suite_result, test_result, default_result, result;
  

•   /* Allocate memory for new copy of suite and list of test cases */
  

•   copy = kmemdup(suite, sizeof(*copy), GFP_KERNEL);
  

•   if (!copy)
  

•           return ERR_PTR(-ENOMEM);
  

•   kunit_suite_for_each_test_case(suite, test_case) { n++; }
  

•   filtered = kcalloc(n + 1, sizeof(*filtered), GFP_KERNEL);
  

•   if (!filtered) {
  

•           kfree(copy);
  

•           return ERR_PTR(-ENOMEM);
  

•   }
  

•   n = 0;
  

•   /* Save filtering result on default value */
  

•   default_result = filter.attr->filter(filter.attr->attr_default, filter.input, err);
  

•   if (*err) {
  

•           kfree(copy);
  

•           kfree(filtered);
  

•           return NULL;
  

•   }
  

•   /* Save suite attribute value and filtering result on that value */
  

•   suite_val = filter.attr->get_attr((void *)suite, false);
  

•   suite_result = filter.attr->filter(suite_val, filter.input, err);
  

•   if (*err) {
  

•           kfree(copy);
  

•           kfree(filtered);
  

•           return NULL;
  

•   }
  

•   /* For each test case, save test case if passes filtering. */
  

•   kunit_suite_for_each_test_case(suite, test_case) {
  

•           test_val = filter.attr->get_attr((void *) test_case, true);
  

•           test_result = filter.attr->filter(filter.attr->get_attr(test_case, true),
  

•                           filter.input, err);
  

•           if (*err) {
  

•                   kfree(copy);
  

•                   kfree(filtered);
  

•                   return NULL;
  

•           }
  

•           /*
  

•            * If attribute value of test case is set, filter on that value.
  

•            * If not, filter on suite value if set. If not, filter on
  

•            * default value.
  

•            */
  

•           result = false;
  

•           if (test_val) {
  

•                   if (test_result)
  

•                           result = true;
  

•           } else if (suite_val) {
  

•                   if (suite_result)
  

•                           result = true;
  

•           } else if (default_result) {
  

•                   result = true;
  

•           }
  

•           if (result) {
  

•                   filtered[n++] = *test_case;
  

•           } else if (action && strcmp(action, "skip") == 0) {
  

•                   test_case->status = KUNIT_SKIPPED;
  

•                   filtered[n++] = *test_case;
  

•           }
  

•   }
  

•   if (n == 0) {
  

•           kfree(copy);
  

•           kfree(filtered);
  

•           return NULL;
  

•   }
  

•   copy->test_cases = filtered;
  

•   return copy;
  

+} diff --git a/lib/kunit/executor.c b/lib/kunit/executor.c index 12e38a48a5cc..c286ae47435a 100644 --- a/lib/kunit/executor.c +++ b/lib/kunit/executor.c @@ -17,6 +17,9 @@ extern struct kunit_suite * const __kunit_suites_end[];

static char *filter_glob_param; static char *action_param; +static char *filter_param; +static char *filter_action_param;

Nit: do we need this extra newline here?

module_param_named(filter_glob, filter_glob_param, charp, 0); MODULE_PARM_DESC(filter_glob, @@ -27,15 +30,23 @@ MODULE_PARM_DESC(action, "<none>: run the tests like normal\n" "'list' to list test names instead of running them.\n" "'list_attr' to list test names and attributes instead of running them.\n"); +module_param_named(filter, filter_param, charp, 0); +MODULE_PARM_DESC(filter,

•           "Filter which KUnit test suites/tests run at boot-time using attributes, e.g. speed>slow");
  

+module_param_named(filter_action, filter_action_param, charp, 0); +MODULE_PARM_DESC(filter_action,

•           "Changes behavior of filtered tests using attributes, valid values are:\n"
  

•           "<none>: do not run filtered tests as normal\n"
  

•           "'skip': skip all filtered tests instead so tests will appear in output\n");
  
  

/* glob_match() needs NULL terminated strings, so we need a copy of filter_glob_param. */ -struct kunit_test_filter { +struct kunit_glob_filter { char *suite_glob; char *test_glob; };

/* Split "suite_glob.test_glob" into two. Assumes filter_glob is not empty. */ -static void kunit_parse_filter_glob(struct kunit_test_filter *parsed, +static void kunit_parse_glob_filter(struct kunit_glob_filter *parsed, const char *filter_glob) { const int len = strlen(filter_glob); @@ -57,7 +68,7 @@ static void kunit_parse_filter_glob(struct kunit_test_filter *parsed,

/* Create a copy of suite with only tests that match test_glob. */ static struct kunit_suite * -kunit_filter_tests(const struct kunit_suite *const suite, const char *test_glob) +kunit_filter_glob_tests(const struct kunit_suite *const suite, const char *test_glob) { int n = 0; struct kunit_case *filtered, *test_case; @@ -111,12 +122,15 @@ static void kunit_free_suite_set(struct suite_set suite_set)

static struct suite_set kunit_filter_suites(const struct suite_set *suite_set, const char *filter_glob,

•                                           char *filters,
  

•                                           char *filter_action,
                                        int *err)
  

{

•   int i;
  

•   struct kunit_suite **copy, *filtered_suite;
  

•   int i, j, k, filter_count;
  

•   struct kunit_suite **copy, *filtered_suite, *new_filtered_suite;
    struct suite_set filtered;
  

•   struct kunit_test_filter filter;
  

•   struct kunit_glob_filter parsed_glob;
  

•   struct kunit_attr_filter *parsed_filters;
  
    const size_t max = suite_set->end - suite_set->start;
  
  

@@ -127,17 +141,52 @@ static struct suite_set kunit_filter_suites(const struct suite_set *suite_set, return filtered; }

•   kunit_parse_filter_glob(&filter, filter_glob);
  

•   for (i = 0; &suite_set->start[i] != suite_set->end; i++) {
  

•           if (!glob_match(filter.suite_glob, suite_set->start[i]->name))
  

•                   continue;
  

•   if (filter_glob)
  

•           kunit_parse_glob_filter(&parsed_glob, filter_glob);
  
  

•           filtered_suite = kunit_filter_tests(suite_set->start[i], filter.test_glob);
  

•           if (IS_ERR(filtered_suite)) {
  

•                   *err = PTR_ERR(filtered_suite);
  

•   /* Parse attribute filters */
  

•   if (filters) {
  

•           filter_count = kunit_get_filter_count(filters);
  

•           parsed_filters = kcalloc(filter_count + 1, sizeof(*parsed_filters), GFP_KERNEL);
  

•           for (j = 0; j < filter_count; j++)
  

•                   parsed_filters[j] = kunit_next_attr_filter(&filters, err);
  

•           if (*err)
                    return filtered;
  

•   }
  

•   for (i = 0; &suite_set->start[i] != suite_set->end; i++) {
  

•           filtered_suite = suite_set->start[i];
  

•           if (filter_glob) {
  

•                   if (!glob_match(parsed_glob.suite_glob, filtered_suite->name))
  

•                           continue;
  

•                   filtered_suite = kunit_filter_glob_tests(filtered_suite,
  

•                                   parsed_glob.test_glob);
  

•                   if (IS_ERR(filtered_suite)) {
  

•                           *err = PTR_ERR(filtered_suite);
  

•                           return filtered;
  

•                   }
  

•           }
  

•           if (filter_count) {
  

•                   for (k = 0; k < filter_count; k++) {
  

•                           new_filtered_suite = kunit_filter_attr_tests(filtered_suite,
  

•                                           parsed_filters[k], filter_action, err);
  

•                           /* Free previous copy of suite */
  

•                           if (k > 0 || filter_glob)
  

•                                   kfree(filtered_suite);
  

•                           filtered_suite = new_filtered_suite;
  

•                           if (*err)
  

•                                   return filtered;
  

•                           if (IS_ERR(filtered_suite)) {
  

•                                   *err = PTR_ERR(filtered_suite);
  

•                                   return filtered;
  

•                           }
  

•                           if (!filtered_suite)
  

•                                   break;
  

•                   }
            }
  

•           if (!filtered_suite)
                    continue;
  
  

@@ -145,8 +194,14 @@ static struct suite_set kunit_filter_suites(const struct suite_set *suite_set, } filtered.end = copy;

•   kfree(filter.suite_glob);
  

•   kfree(filter.test_glob);
  

•   if (filter_glob) {
  

•           kfree(parsed_glob.suite_glob);
  

•           kfree(parsed_glob.test_glob);
  

•   }
  

•   if (filter_count)
  

•           kfree(parsed_filters);
  

•   return filtered;
  

}

@@ -206,8 +261,9 @@ int kunit_run_all_tests(void) goto out; }

•   if (filter_glob_param) {
  

•           suite_set = kunit_filter_suites(&suite_set, filter_glob_param, &err);
  

•   if (filter_glob_param || filter_param) {
  

•           suite_set = kunit_filter_suites(&suite_set, filter_glob_param,
  

•                           filter_param, filter_action_param, &err);
            if (err) {
                    pr_err("kunit executor: error filtering suites: %d\n", err);
                    goto out;
  

@@ -223,7 +279,7 @@ int kunit_run_all_tests(void) else pr_err("kunit executor: unknown action '%s'\n", action_param);

•   if (filter_glob_param) { /* a copy was made of each suite */
  

•   if (filter_glob_param || filter_param) { /* a copy was made of each suite */
            kunit_free_suite_set(suite_set);
    }
  
  

diff --git a/lib/kunit/executor_test.c b/lib/kunit/executor_test.c index ce6749af374d..d7ab069324b5 100644 --- a/lib/kunit/executor_test.c +++ b/lib/kunit/executor_test.c @@ -24,15 +24,15 @@ static struct kunit_case dummy_test_cases[] = {

static void parse_filter_test(struct kunit *test) {

•   struct kunit_test_filter filter = {NULL, NULL};
  

•   struct kunit_glob_filter filter = {NULL, NULL};
  
  

•   kunit_parse_filter_glob(&filter, "suite");
  

•   kunit_parse_glob_filter(&filter, "suite");
    KUNIT_EXPECT_STREQ(test, filter.suite_glob, "suite");
    KUNIT_EXPECT_FALSE(test, filter.test_glob);
    kfree(filter.suite_glob);
    kfree(filter.test_glob);
  
  

•   kunit_parse_filter_glob(&filter, "suite.test");
  

•   kunit_parse_glob_filter(&filter, "suite.test");
    KUNIT_EXPECT_STREQ(test, filter.suite_glob, "suite");
    KUNIT_EXPECT_STREQ(test, filter.test_glob, "test");
    kfree(filter.suite_glob);
  

@@ -50,7 +50,7 @@ static void filter_suites_test(struct kunit *test) subsuite[1] = alloc_fake_suite(test, "suite2", dummy_test_cases);

    /* Want: suite1, suite2, NULL -> suite2, NULL */

•   got = kunit_filter_suites(&suite_set, "suite2", &err);
  

•   got = kunit_filter_suites(&suite_set, "suite2", NULL, NULL, &err);
    KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start);
    KUNIT_ASSERT_EQ(test, err, 0);
    kfree_at_end(test, got.start);
  

@@ -74,7 +74,7 @@ static void filter_suites_test_glob_test(struct kunit *test) subsuite[1] = alloc_fake_suite(test, "suite2", dummy_test_cases);

    /* Want: suite1, suite2, NULL -> suite2 (just test1), NULL */

•   got = kunit_filter_suites(&suite_set, "suite2.test2", &err);
  

•   got = kunit_filter_suites(&suite_set, "suite2.test2", NULL, NULL, &err);
    KUNIT_ASSERT_NOT_ERR_OR_NULL(test, got.start);
    KUNIT_ASSERT_EQ(test, err, 0);
    kfree_at_end(test, got.start);
  

@@ -100,7 +100,7 @@ static void filter_suites_to_empty_test(struct kunit *test) subsuite[0] = alloc_fake_suite(test, "suite1", dummy_test_cases); subsuite[1] = alloc_fake_suite(test, "suite2", dummy_test_cases);

•   got = kunit_filter_suites(&suite_set, "not_found", &err);
  

•   got = kunit_filter_suites(&suite_set, "not_found", NULL, NULL, &err);
    KUNIT_ASSERT_EQ(test, err, 0);
    kfree_at_end(test, got.start); /* just in case */
  
  

diff --git a/lib/kunit/test.c b/lib/kunit/test.c index 9ee55139ecd1..cb9797fa6303 100644 --- a/lib/kunit/test.c +++ b/lib/kunit/test.c @@ -613,18 +613,22 @@ 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 }; struct kunit_result_stats param_stats = { 0 };

•           test_case->status = KUNIT_SKIPPED;
  
            kunit_init_test(&test, test_case->name, test_case->log);
  

•           if (!test_case->generate_params) {
  

•           if (test_case->status == KUNIT_SKIPPED) {
  

•                   /* Test marked as skip */
  

•                   test.status = KUNIT_SKIPPED;
  

•                   kunit_update_stats(&param_stats, test.status);
  

•           } else if (!test_case->generate_params) {
                    /* Non-parameterised test. */
  

•                   test_case->status = KUNIT_SKIPPED;
                    kunit_run_case_catch_errors(suite, test_case, &test);
                    kunit_update_stats(&param_stats, test.status);
            } else {
                    /* Get initial param. */
                    param_desc[0] = '\0';
                    test.param_value = test_case->generate_params(NULL, param_desc);
  

•                   test_case->status = KUNIT_SKIPPED;
                    kunit_log(KERN_INFO, &test, KUNIT_SUBTEST_INDENT KUNIT_SUBTEST_INDENT
                              "KTAP version 1\n");
                    kunit_log(KERN_INFO, &test, KUNIT_SUBTEST_INDENT KUNIT_SUBTEST_INDENT
  

-- 2.41.0.487.g6d72f3e995-goog

On Tue, 25 Jul 2023 at 00:30, Rae Moar rmoar@google.com wrote:

Add ability to kunit.py to filter attributes and report a list of tests including attributes without running tests.

Add flag "--filter" to input filters on test attributes. Tests will be filtered out if they do not match all inputted filters.

Example: --filter speed=slow (This filter would run only the tests that are marked as slow)

Filters have operations: <, >, <=, >=, !=, and =. But note that the characters < and > are often interpreted by the shell, so they may need to be quoted or escaped.

Example: --filter "speed>slow" or --filter speed>slow (This filter would run only the tests that have the speed faster than slow.

Additionally, multiple filters can be used.

Example: --filter "speed=slow, module!=example" (This filter would run only the tests that have the speed slow and are not in the "example" module)

Note if the user wants to skip filtered tests instead of not running/showing them use the "--filter_action=skip" flag.

Expose the output of kunit.action=list option with flag "--list_tests" to output a list of tests. Additionally, add flag "--list_tests_attr" to output a list of tests and their attributes. These flags are useful to see tests and test attributes without needing to run tests.

Example of the output of "--list_tests_attr": example example.test_1 example.test_2 # example.test_2.speed: slow

This output includes a suite, example, with two test cases, test_1 and test_2. And in this instance test_2 has been marked as slow.

Signed-off-by: Rae Moar rmoar@google.com

Looks good, working well here.

Reviewed-by: David Gow davidgow@google.com

-- David

Changes since v1:

• No major changes

Changes since RFC v2:

• Remove --filter_skip flag and replace with –-filter_action
• Make KUnit executor errors visible in kunit.py and raw_output
• Fix up help comments

Changes since RFC v1:

• Change method for inputting filters to allow for spaces in filtering values
• Add option to skip filtered tests instead of not run or show them with the -–filter_skip flag
• Separate the new feature to list tests and their attributes into both –-list_tests (lists just tests) and –-list_tests_attr (lists all)

tools/testing/kunit/kunit.py | 70 ++++++++++++++++++++++++-- tools/testing/kunit/kunit_kernel.py | 8 ++- tools/testing/kunit/kunit_parser.py | 11 +++- tools/testing/kunit/kunit_tool_test.py | 39 +++++++------- 4 files changed, 99 insertions(+), 29 deletions(-)

diff --git a/tools/testing/kunit/kunit.py b/tools/testing/kunit/kunit.py index 3905c43369c3..bc74088c458a 100755 --- a/tools/testing/kunit/kunit.py +++ b/tools/testing/kunit/kunit.py @@ -55,8 +55,12 @@ class KunitExecRequest(KunitParseRequest): build_dir: str timeout: int filter_glob: str

•   filter: str
  

•   filter_action: Optional[str]
    kernel_args: Optional[List[str]]
    run_isolated: Optional[str]
  

•   list_tests: bool
  

•   list_tests_attr: bool
  
  

@dataclass class KunitRequest(KunitExecRequest, KunitBuildRequest): @@ -102,19 +106,41 @@ def config_and_build_tests(linux: kunit_kernel.LinuxSourceTree,

def _list_tests(linux: kunit_kernel.LinuxSourceTree, request: KunitExecRequest) -> List[str]: args = ['kunit.action=list']

•   if request.kernel_args:
  

•           args.extend(request.kernel_args)
  

•   output = linux.run_kernel(args=args,
  

•                      timeout=request.timeout,
  

•                      filter_glob=request.filter_glob,
  

•                      filter=request.filter,
  

•                      filter_action=request.filter_action,
  

•                      build_dir=request.build_dir)
  

•   lines = kunit_parser.extract_tap_lines(output)
  

•   # Hack! Drop the dummy TAP version header that the executor prints out.
  

•   lines.pop()
  

•   # Filter out any extraneous non-test output that might have gotten mixed in.
  

•   return [l for l in output if re.match(r'^[^\s.]+\.[^\s.]+$', l)]
  

+def _list_tests_attr(linux: kunit_kernel.LinuxSourceTree, request: KunitExecRequest) -> Iterable[str]:

•   args = ['kunit.action=list_attr']
  

•   if request.kernel_args:
            args.extend(request.kernel_args)
  
    output = linux.run_kernel(args=args,
                       timeout=request.timeout,
                       filter_glob=request.filter_glob,
  

•                      filter=request.filter,
  

•                      filter_action=request.filter_action,
                       build_dir=request.build_dir)
    lines = kunit_parser.extract_tap_lines(output)
    # Hack! Drop the dummy TAP version header that the executor prints out.
    lines.pop()
  
    # Filter out any extraneous non-test output that might have gotten mixed in.
  

•   return [l for l in lines if re.match(r'^[^\s.]+\.[^\s.]+$', l)]
  

•   return lines
  
  

def _suites_from_test_list(tests: List[str]) -> List[str]: """Extracts all the suites from an ordered list of tests.""" @@ -128,10 +154,18 @@ def _suites_from_test_list(tests: List[str]) -> List[str]: suites.append(suite) return suites

def exec_tests(linux: kunit_kernel.LinuxSourceTree, request: KunitExecRequest) -> KunitResult: filter_globs = [request.filter_glob]

•   if request.list_tests:
  

•           output = _list_tests(linux, request)
  

•           for line in output:
  

•                   print(line.rstrip())
  

•           return KunitResult(status=KunitStatus.SUCCESS, elapsed_time=0.0)
  

•   if request.list_tests_attr:
  

•           attr_output = _list_tests_attr(linux, request)
  

•           for line in attr_output:
  

•                   print(line.rstrip())
  

•           return KunitResult(status=KunitStatus.SUCCESS, elapsed_time=0.0)
    if request.run_isolated:
            tests = _list_tests(linux, request)
            if request.run_isolated == 'test':
  

@@ -155,6 +189,8 @@ def exec_tests(linux: kunit_kernel.LinuxSourceTree, request: KunitExecRequest) - args=request.kernel_args, timeout=request.timeout, filter_glob=filter_glob,

•                   filter=request.filter,
  

•                   filter_action=request.filter_action,
                    build_dir=request.build_dir)
  
            _, test_result = parse_tests(request, metadata, run_result)
  

@@ -341,6 +377,16 @@ def add_exec_opts(parser: argparse.ArgumentParser) -> None: nargs='?', default='', metavar='filter_glob')

•   parser.add_argument('--filter',
  

•                       help='Filter KUnit tests with attributes, '
  

•                       'e.g. module=example or speed>slow',
  

•                       type=str,
  

•                           default='')
  

•   parser.add_argument('--filter_action',
  

•                       help='If set to skip, filtered tests will be skipped, '
  

•                           'e.g. --filter_action=skip. Otherwise they will not run.',
  

•                       type=str,
  

•                           choices=['skip'])
    parser.add_argument('--kernel_args',
                        help='Kernel command-line parameters. Maybe be repeated',
                         action='append', metavar='')
  

@@ -350,6 +396,12 @@ def add_exec_opts(parser: argparse.ArgumentParser) -> None: 'what ran before it.', type=str, choices=['suite', 'test'])

•   parser.add_argument('--list_tests', help='If set, list all tests that will be '
  

•                       'run.',
  

•                       action='store_true')
  

•   parser.add_argument('--list_tests_attr', help='If set, list all tests and test '
  

•                       'attributes.',
  

•                       action='store_true')
  
  

def add_parse_opts(parser: argparse.ArgumentParser) -> None: parser.add_argument('--raw_output', help='If set don't parse output from kernel. ' @@ -398,8 +450,12 @@ def run_handler(cli_args: argparse.Namespace) -> None: json=cli_args.json, timeout=cli_args.timeout, filter_glob=cli_args.filter_glob,

•                                   filter=cli_args.filter,
  

•                                   filter_action=cli_args.filter_action,
                                    kernel_args=cli_args.kernel_args,
  

•                                   run_isolated=cli_args.run_isolated)
  

•                                   run_isolated=cli_args.run_isolated,
  

•                                   list_tests=cli_args.list_tests,
  

•                                   list_tests_attr=cli_args.list_tests_attr)
    result = run_tests(linux, request)
    if result.status != KunitStatus.SUCCESS:
            sys.exit(1)
  

@@ -441,8 +497,12 @@ def exec_handler(cli_args: argparse.Namespace) -> None: json=cli_args.json, timeout=cli_args.timeout, filter_glob=cli_args.filter_glob,

•                                   filter=cli_args.filter,
  

•                                   filter_action=cli_args.filter_action,
                                    kernel_args=cli_args.kernel_args,
  

•                                   run_isolated=cli_args.run_isolated)
  

•                                   run_isolated=cli_args.run_isolated,
  

•                                   list_tests=cli_args.list_tests,
  

•                                   list_tests_attr=cli_args.list_tests_attr)
    result = exec_tests(linux, exec_request)
    stdout.print_with_timestamp((
            'Elapsed time: %.3fs\n') % (result.elapsed_time))
  

diff --git a/tools/testing/kunit/kunit_kernel.py b/tools/testing/kunit/kunit_kernel.py index 7f648802caf6..0b6488efed47 100644 --- a/tools/testing/kunit/kunit_kernel.py +++ b/tools/testing/kunit/kunit_kernel.py @@ -330,11 +330,15 @@ class LinuxSourceTree: return False return self.validate_config(build_dir)

•   def run_kernel(self, args: Optional[List[str]]=None, build_dir: str='', filter_glob: str='', timeout: Optional[int]=None) -> Iterator[str]:
  

•   def run_kernel(self, args: Optional[List[str]]=None, build_dir: str='', filter_glob: str='', filter: str='', filter_action: Optional[str]=None, timeout: Optional[int]=None) -> Iterator[str]:
            if not args:
                    args = []
            if filter_glob:
  

•                   args.append('kunit.filter_glob='+filter_glob)
  

•                   args.append('kunit.filter_glob=' + filter_glob)
  

•           if filter:
  

•                   args.append('kunit.filter="' + filter + '"')
  

•           if filter_action:
  

•                   args.append('kunit.filter_action=' + filter_action)
            args.append('kunit.enable=1')
  
            process = self._ops.start(args, build_dir)
  

diff --git a/tools/testing/kunit/kunit_parser.py b/tools/testing/kunit/kunit_parser.py index fbc094f0567e..79d8832c862a 100644 --- a/tools/testing/kunit/kunit_parser.py +++ b/tools/testing/kunit/kunit_parser.py @@ -212,6 +212,7 @@ KTAP_START = re.compile(r'\s*KTAP version ([0-9]+)$') TAP_START = re.compile(r'\s*TAP version ([0-9]+)$') KTAP_END = re.compile(r'\s*(List of all partitions:|' 'Kernel panic - not syncing: VFS:|reboot: System halted)') +EXECUTOR_ERROR = re.compile(r'\s*kunit executor: (.*)$')

def extract_tap_lines(kernel_output: Iterable[str]) -> LineStream: """Extracts KTAP lines from the kernel output.""" @@ -242,6 +243,8 @@ def extract_tap_lines(kernel_output: Iterable[str]) -> LineStream: # remove the prefix, if any. line = line[prefix_len:] yield line_num, line

•                   elif EXECUTOR_ERROR.search(line):
  

•                           yield line_num, line
    return LineStream(lines=isolate_ktap_output(kernel_output))
  
  

KTAP_VERSIONS = [1] @@ -447,7 +450,7 @@ def parse_diagnostic(lines: LineStream) -> List[str]: Log of diagnostic lines """ log = [] # type: List[str]

•   non_diagnostic_lines = [TEST_RESULT, TEST_HEADER, KTAP_START]
  

•   non_diagnostic_lines = [TEST_RESULT, TEST_HEADER, KTAP_START, TAP_START]
    while lines and not any(re.match(lines.peek())
                    for re in non_diagnostic_lines):
            log.append(lines.pop())
  

@@ -713,6 +716,11 @@ def parse_test(lines: LineStream, expected_num: int, log: List[str], is_subtest: """ test = Test() test.log.extend(log)

•   # Parse any errors prior to parsing tests
  

•   err_log = parse_diagnostic(lines)
  

•   test.log.extend(err_log)
  

•   if not is_subtest:
            # If parsing the main/top-level test, parse KTAP version line and
            # test plan
  

@@ -774,6 +782,7 @@ def parse_test(lines: LineStream, expected_num: int, log: List[str], is_subtest: # Don't override a bad status if this test had one reported. # Assumption: no subtests means CRASHED is from Test.__init__() if test.status in (TestStatus.TEST_CRASHED, TestStatus.SUCCESS):

•                   print_log(test.log)
                    test.status = TestStatus.NO_TESTS
                    test.add_error('0 tests run!')
  
  

diff --git a/tools/testing/kunit/kunit_tool_test.py b/tools/testing/kunit/kunit_tool_test.py index be35999bb84f..b28c1510be2e 100755 --- a/tools/testing/kunit/kunit_tool_test.py +++ b/tools/testing/kunit/kunit_tool_test.py @@ -597,7 +597,7 @@ class KUnitMainTest(unittest.TestCase): self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 0) self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1) self.linux_source_mock.run_kernel.assert_called_once_with(

•                   args=None, build_dir='.kunit', filter_glob='', timeout=300)
  

•                   args=None, build_dir='.kunit', filter_glob='', filter='', filter_action=None, timeout=300)
            self.print_mock.assert_any_call(StrContains('Testing complete.'))
  
    def test_run_passes_args_pass(self):
  

@@ -605,7 +605,7 @@ class KUnitMainTest(unittest.TestCase): self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1) self.assertEqual(self.linux_source_mock.run_kernel.call_count, 1) self.linux_source_mock.run_kernel.assert_called_once_with(

•                   args=None, build_dir='.kunit', filter_glob='', timeout=300)
  

•                   args=None, build_dir='.kunit', filter_glob='', filter='', filter_action=None, timeout=300)
            self.print_mock.assert_any_call(StrContains('Testing complete.'))
  
    def test_exec_passes_args_fail(self):
  

@@ -629,7 +629,7 @@ class KUnitMainTest(unittest.TestCase): kunit.main(['run']) self.assertEqual(e.exception.code, 1) self.linux_source_mock.run_kernel.assert_called_once_with(

•                   args=None, build_dir='.kunit', filter_glob='', timeout=300)
  

•                   args=None, build_dir='.kunit', filter_glob='', filter='', filter_action=None, timeout=300)
            self.print_mock.assert_any_call(StrContains(' 0 tests run!'))
  
    def test_exec_raw_output(self):
  

@@ -670,13 +670,13 @@ class KUnitMainTest(unittest.TestCase): self.linux_source_mock.run_kernel = mock.Mock(return_value=[]) kunit.main(['run', '--raw_output', 'filter_glob']) self.linux_source_mock.run_kernel.assert_called_once_with(

•                   args=None, build_dir='.kunit', filter_glob='filter_glob', timeout=300)
  

•                   args=None, build_dir='.kunit', filter_glob='filter_glob', filter='', filter_action=None, timeout=300)
  
    def test_exec_timeout(self):
            timeout = 3453
            kunit.main(['exec', '--timeout', str(timeout)])
            self.linux_source_mock.run_kernel.assert_called_once_with(
  

•                   args=None, build_dir='.kunit', filter_glob='', timeout=timeout)
  

•                   args=None, build_dir='.kunit', filter_glob='', filter='', filter_action=None, timeout=timeout)
            self.print_mock.assert_any_call(StrContains('Testing complete.'))
  
    def test_run_timeout(self):
  

@@ -684,7 +684,7 @@ class KUnitMainTest(unittest.TestCase): kunit.main(['run', '--timeout', str(timeout)]) self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1) self.linux_source_mock.run_kernel.assert_called_once_with(

•                   args=None, build_dir='.kunit', filter_glob='', timeout=timeout)
  

•                   args=None, build_dir='.kunit', filter_glob='', filter='', filter_action=None, timeout=timeout)
            self.print_mock.assert_any_call(StrContains('Testing complete.'))
  
    def test_run_builddir(self):
  

@@ -692,7 +692,7 @@ class KUnitMainTest(unittest.TestCase): kunit.main(['run', '--build_dir=.kunit']) self.assertEqual(self.linux_source_mock.build_reconfig.call_count, 1) self.linux_source_mock.run_kernel.assert_called_once_with(

•                   args=None, build_dir=build_dir, filter_glob='', timeout=300)
  

•                   args=None, build_dir=build_dir, filter_glob='', filter='', filter_action=None, timeout=300)
            self.print_mock.assert_any_call(StrContains('Testing complete.'))
  
    def test_config_builddir(self):
  

@@ -710,7 +710,7 @@ class KUnitMainTest(unittest.TestCase): build_dir = '.kunit' kunit.main(['exec', '--build_dir', build_dir]) self.linux_source_mock.run_kernel.assert_called_once_with(

•                   args=None, build_dir=build_dir, filter_glob='', timeout=300)
  

•                   args=None, build_dir=build_dir, filter_glob='', filter='', filter_action=None, timeout=300)
            self.print_mock.assert_any_call(StrContains('Testing complete.'))
  
    def test_run_kunitconfig(self):
  

@@ -786,7 +786,7 @@ class KUnitMainTest(unittest.TestCase): kunit.main(['run', '--kernel_args=a=1', '--kernel_args=b=2']) 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)
  

•                 args=['a=1','b=2'], build_dir='.kunit', filter_glob='', filter='', filter_action=None, timeout=300)
            self.print_mock.assert_any_call(StrContains('Testing complete.'))
  
    def test_list_tests(self):
  

@@ -794,13 +794,11 @@ class KUnitMainTest(unittest.TestCase): self.linux_source_mock.run_kernel.return_value = ['TAP version 14', 'init: random output'] + want

            got = kunit._list_tests(self.linux_source_mock,

•                                kunit.KunitExecRequest(None, None, '.kunit', 300, 'suite*', None, 'suite'))
  

•                                kunit.KunitExecRequest(None, None, '.kunit', 300, 'suite*', '', None, None, 'suite', False, False))
            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)
  

•                   args=['kunit.action=list'], build_dir='.kunit', filter_glob='suite*', filter='', filter_action=None, timeout=300)
  
    @mock.patch.object(kunit, '_list_tests')
    def test_run_isolated_by_suite(self, mock_tests):
  

@@ -809,10 +807,10 @@ class KUnitMainTest(unittest.TestCase):

            # Should respect the user's filter glob when listing tests.
            mock_tests.assert_called_once_with(mock.ANY,

•                                kunit.KunitExecRequest(None, None, '.kunit', 300, 'suite*.test*', None, 'suite'))
  

•                                kunit.KunitExecRequest(None, None, '.kunit', 300, 'suite*.test*', '', None, None, 'suite', False, False))
            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.call(args=None, build_dir='.kunit', filter_glob='suite.test*', filter='', filter_action=None, timeout=300),
  

•                   mock.call(args=None, build_dir='.kunit', filter_glob='suite2.test*', filter='', filter_action=None, timeout=300),
            ])
  
    @mock.patch.object(kunit, '_list_tests')
  

@@ -822,13 +820,12 @@ class KUnitMainTest(unittest.TestCase):

            # Should respect the user's filter glob when listing tests.
            mock_tests.assert_called_once_with(mock.ANY,

•                                kunit.KunitExecRequest(None, None, '.kunit', 300, 'suite*', None, 'test'))
  

•                                kunit.KunitExecRequest(None, None, '.kunit', 300, 'suite*', '', None, None, 'test', False, False))
            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),
  

•                   mock.call(args=None, build_dir='.kunit', filter_glob='suite.test1', filter='', filter_action=None, timeout=300),
  

•                   mock.call(args=None, build_dir='.kunit', filter_glob='suite.test2', filter='', filter_action=None, timeout=300),
  

•                   mock.call(args=None, build_dir='.kunit', filter_glob='suite2.test1', filter='', filter_action=None, timeout=300),
            ])
  
  

if __name__ == '__main__': unittest.main() -- 2.41.0.487.g6d72f3e995-goog

On Tue, 25 Jul 2023 at 00:30, Rae Moar rmoar@google.com wrote:

Mark slow memcpy KUnit tests using test attributes.

Tests marked as slow are as follows: memcpy_large_test, memmove_test, memmove_large_test, and memmove_overlap_test. These tests were the slowest of the memcpy tests and relatively slower to most other KUnit tests. Most of these tests are already skipped when CONFIG_MEMCPY_SLOW_KUNIT_TEST is not enabled.

These tests can now be filtered using the KUnit test attribute filtering feature. Example: --filter "speed>slow". This will run only the tests that have speeds faster than slow. The slow attribute will also be outputted in KTAP.

Note: This patch is intended to replace the use of CONFIG_MEMCPY_SLOW_KUNIT_TEST and to potentially deprecate this feature. This patch does not remove the config option but does add a note to the config definition commenting on this future shift.

Acked-by: Kees Cook keescook@chromium.org Signed-off-by: Rae Moar rmoar@google.com

---

Reviewed-by: David Gow davidgow@google.com

Thanks, -- David

Changes since v1:

• No changes.

Changes since RFC v2:

• No changes.

Changes since RFC v1:

• Added note under CONFIG_MEMCPY_SLOW_KUNIT_TEST.

lib/Kconfig.debug | 3 +++ lib/memcpy_kunit.c | 8 ++++---- 2 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug index 550cb967b668..1b3894e861f2 100644 --- a/lib/Kconfig.debug +++ b/lib/Kconfig.debug @@ -2701,6 +2701,9 @@ config MEMCPY_SLOW_KUNIT_TEST and bit ranges. These can be very slow, so they are split out as a separate config, in case they need to be disabled.

•     Note this config option will be replaced by the use of KUnit test
  

•     attributes.
  

config IS_SIGNED_TYPE_KUNIT_TEST tristate "Test is_signed_type() macro" if !KUNIT_ALL_TESTS depends on KUNIT diff --git a/lib/memcpy_kunit.c b/lib/memcpy_kunit.c index 887926f04731..440aee705ccc 100644 --- a/lib/memcpy_kunit.c +++ b/lib/memcpy_kunit.c @@ -551,10 +551,10 @@ static void strtomem_test(struct kunit *test) static struct kunit_case memcpy_test_cases[] = { KUNIT_CASE(memset_test), KUNIT_CASE(memcpy_test),

•   KUNIT_CASE(memcpy_large_test),
  

•   KUNIT_CASE(memmove_test),
  

•   KUNIT_CASE(memmove_large_test),
  

•   KUNIT_CASE(memmove_overlap_test),
  

•   KUNIT_CASE_SLOW(memcpy_large_test),
  

•   KUNIT_CASE_SLOW(memmove_test),
  

•   KUNIT_CASE_SLOW(memmove_large_test),
  

•   KUNIT_CASE_SLOW(memmove_overlap_test),
    KUNIT_CASE(strtomem_test),
    {}
  

};

2.41.0.487.g6d72f3e995-goog