kselftest: add fixture parameters
Subsystems (7)
Jakub Kicinski
maintainerv5 cover kselftest: add fixture parameters
Hi!
Shuah please consider applying to the kselftest tree.
This set is an attempt to make running tests for different sets of data easier. The direct motivation is the tls test which we'd like to run for TLS 1.2 and TLS 1.3, but currently there is no easy way to invoke the same tests with different parameters.
Tested all users of kselftest_harness.h.
v2:
- don't run tests by fixture
- don't pass params as an explicit argument
v3:
- go back to the orginal implementation with an extra parameter, and running by fixture (Kees);
- add LIST_APPEND helper (Kees);
- add a dot between fixture and param name (Kees);
- rename the params to variants (Tim);
v4:
- whitespace fixes.
v5 (Kees):
- move a comment;
- remove a temporary variable;
- reword the commit message on patch 4.
v1: https://lore.kernel.org/netdev/[email protected]/
v2: https://lore.kernel.org/netdev/[email protected]/
v3: https://lore.kernel.org/netdev/[email protected]/
v4: https://lore.kernel.org/netdev/[email protected]/
Jakub Kicinski (5):
kselftest: factor out list manipulation to a helper
kselftest: create fixture objects
kselftest: run tests by fixture
kselftest: add fixture variants
selftests: tls: run all tests for TLS 1.2 and TLS 1.3
Documentation/dev-tools/kselftest.rst | 3 +- tools/testing/selftests/kselftest_harness.h | 234 +++++++++++++++----- tools/testing/selftests/net/tls.c | 93 ++------ 3 files changed, 202 insertions(+), 128 deletions(-)
Signature · 1 line
2.25.1
Jakub Kicinski
maintainerPATCH v5 1/5 kselftest: factor out list manipulation to a helper
Kees suggest to factor out the list append code to a macro, since following commits need it, which leads to code duplication.
--- tools/testing/selftests/kselftest_harness.h | 42 ++++++++++++--------- 1 file changed, 24 insertions(+), 18 deletions(-)
tools/testing/selftests/kselftest_harness.h +24 -18
@@ -631,6 +631,29 @@ } \ }while (0 );OPTIONAL_HANDLER (_assert) +/* List helpers */ +#define __LIST_APPEND(head, item) \ +{ \ +/* Circular linked list where only prev is circular. */ \ +if (head ==NULL ) { \ + head = item; \ + item->next =NULL ; \ + item->prev = item; \ +return ; \ + } \ +if (__constructor_order == _CONSTRUCTOR_ORDER_FORWARD) { \ + item->next =NULL ; \ + item->prev = head->prev; \ + item->prev->next = item; \ + head->prev = item; \ + }else { \ + item->next = head; \ + item->next->prev = item; \ + item->prev = item; \ + head = item; \ + } \ +} +/* Contains all the information for test execution and status checking. */ struct __test_metadata {const char *name;
@@ -665,24 +688,7 @@ static int __constructor_order;static inline void __register_test (struct __test_metadata *t) { __test_count++; -/* Circular linked list where only prev is circular. */ -if (__test_list ==NULL ) { - __test_list = t; - t->next =NULL ; - t->prev = t; -return ; - } -if (__constructor_order == _CONSTRUCTOR_ORDER_FORWARD) { - t->next =NULL ; - t->prev = __test_list->prev; - t->prev->next = t; - __test_list->prev = t; - }else { - t->next = __test_list; - t->next->prev = t; - t->prev = t; - __test_list = t; - } +__LIST_APPEND (__test_list, t); }static inline int __bail (int for_realz,bool no_print,__u8 step)
Signature · 1 line
2.25.1
Jakub Kicinski
maintainerPATCH v5 4/5 kselftest: add fixture variants
In reply to Jakub KicinskiAllow users to build parameterized variants of fixtures.
If fixtures want variants, they call FIXTURE_VARIANT() to declare the structure to fill for each variant. Each fixture will be re-run for each of the variants defined by calling FIXTURE_VARIANT_ADD() with the differing parameters initializing the structure.
Since tests are being re-run, additional initialization (steps, no_print) is also added.
--
v3:
- separate variant name out with a dot;
- count variants as "cases" in the opening print.
v4:
- realign and break lines after s/params/variant/
v5:
- reword the commit message;
Kees also notes after his series for timeouts is merged the new "timed_out" field will need to be initialized in __run_test().
--- Documentation/dev-tools/kselftest.rst | 3 +- tools/testing/selftests/kselftest_harness.h | 148 ++++++++++++++++---- 2 files changed, 124 insertions(+), 27 deletions(-)
Documentation/dev-tools/kselftest.rst +2 -1
@@ -301,7 +301,8 @@ Helpers .. kernel-doc:: tools/testing/selftests/kselftest_harness.h :functions: TH_LOG TEST TEST_SIGNAL FIXTURE FIXTURE_DATA FIXTURE_SETUP - FIXTURE_TEARDOWN TEST_F TEST_HARNESS_MAIN + FIXTURE_TEARDOWN TEST_F TEST_HARNESS_MAIN FIXTURE_VARIANT + FIXTURE_VARIANT_ADD Operators ---------
tools/testing/selftests/kselftest_harness.h +122 -26
275 lines not on this page · raw message
Signature · 1 line
2.25.1
Jakub Kicinski
maintainerPATCH v5 5/5 selftests: tls: run all tests for TLS 1.2 and TLS 1.3
In reply to Jakub KicinskiTLS 1.2 and TLS 1.3 differ in the implementation. Use fixture parameters to run all tests for both versions, and remove the one-off TLS 1.2 test.
--- tools/testing/selftests/net/tls.c | 93 ++++++------------------------- 1 file changed, 17 insertions(+), 76 deletions(-)
tools/testing/selftests/net/tls.c +17 -76
@@ -101,6 +101,21 @@ FIXTURE(tls)bool notls; }; +FIXTURE_VARIANT (tls) +{ +unsigned int tls_version; +}; + +FIXTURE_VARIANT_ADD (tls,12 ) +{ + .tls_version =TLS_1_2_VERSION , +}; + +FIXTURE_VARIANT_ADD (tls,13 ) +{ + .tls_version = TLS_1_3_VERSION, +}; +FIXTURE_SETUP (tls) {struct tls12_crypto_info_aes_gcm_128 tls12;
@@ -112,7 +127,7 @@ FIXTURE_SETUP(tls) len =sizeof (addr);memset (&tls12,0 ,sizeof (tls12)); - tls12.info.version =TLS_1_3_VERSION ; + tls12.info.version = variant->tls_version; tls12.info.cipher_type =TLS_CIPHER_AES_GCM_128 ; addr.sin_family =AF_INET ;
@@ -733,7 +748,7 @@ TEST_F(tls, bidir)struct tls12_crypto_info_aes_gcm_128 tls12;memset (&tls12,0 ,sizeof (tls12)); - tls12.info.version =TLS_1_3_VERSION ; + tls12.info.version = variant->tls_version; tls12.info.cipher_type =TLS_CIPHER_AES_GCM_128 ; ret = setsockopt(self->fd, SOL_TLS, TLS_RX, &tls12,
@@ -1258,78 +1273,4 @@ TEST(keysizes) {close (cfd); } -TEST (tls12) { -int fd, cfd; -bool notls; - -struct tls12_crypto_info_aes_gcm_128 tls12; -struct sockaddr_in addr; -socklen_t len; -int sfd, ret; - - notls = false; - len =sizeof (addr); - -memset (&tls12,0 ,sizeof (tls12)); - tls12.info.version =TLS_1_2_VERSION ; - tls12.info.cipher_type =TLS_CIPHER_AES_GCM_128 ; - - addr.sin_family =AF_INET ; - addr.sin_addr.s_addr =htonl (INADDR_ANY ); - addr.sin_port =0 ; - - fd =socket (AF_INET ,SOCK_STREAM ,0 ); - sfd =socket (AF_INET ,SOCK_STREAM ,0 ); - - ret =bind (sfd, &addr,sizeof (addr)); -ASSERT_EQ (ret,0 ); - ret =listen (sfd,10 ); -ASSERT_EQ (ret,0 ); - - ret =getsockname (sfd, &addr, &len); -ASSERT_EQ (ret,0 ); - - ret =connect (fd, &addr,sizeof (addr)); -ASSERT_EQ (ret,0 ); - - ret =setsockopt (fd,IPPROTO_TCP ,TCP_ULP ,"tls" ,sizeof ("tls" )); -if (ret !=0 ) { - notls = true; -printf ("Failure setting TCP_ULP, testing without tls\n" ); - } - -if (!notls) { - ret =setsockopt (fd,SOL_TLS ,TLS_TX , &tls12, -sizeof (tls12)); -ASSERT_EQ (ret,0 ); - } - - cfd =accept (sfd, &addr, &len); -ASSERT_GE (cfd,0 ); - -if (!notls) { - ret =setsockopt (cfd,IPPROTO_TCP ,TCP_ULP ,"tls" , -sizeof ("tls" )); -ASSERT_EQ (ret,0 ); - - ret =setsockopt (cfd,SOL_TLS ,TLS_RX , &tls12, -sizeof (tls12)); -ASSERT_EQ (ret,0 ); - } - -close (sfd); - -char const *test_str ="test_read" ; -int send_len =10 ; -char buf[10 ]; - - send_len =strlen (test_str) +1 ; -EXPECT_EQ (send (fd, test_str, send_len,0 ), send_len); -EXPECT_NE (recv (cfd, buf, send_len,0 ),-1 ); -EXPECT_EQ (memcmp (buf, test_str, send_len),0 ); - -close (fd); -close (cfd); -} -TEST_HARNESS_MAIN
Signature · 1 line
2.25.1
Jakub Kicinski
maintainerPATCH v5 3/5 kselftest: run tests by fixture
In reply to Jakub KicinskiNow that all tests have a fixture object move from a global list of tests to a list of tests per fixture.
Order of tests may change as we will now group and run test fixture by fixture, rather than in declaration order.
---
v5 (Kees):
- move a comment;
- remove temporary variable.
--- tools/testing/selftests/kselftest_harness.h | 23 +++++++++++++-------- 1 file changed, 14 insertions(+), 9 deletions(-)
tools/testing/selftests/kselftest_harness.h +14 -9
@@ -659,9 +659,12 @@ } \ } +struct __test_metadata ; +/* Contains all the information about a fixture. */ struct __fixture_metadata {const char *name; +struct __test_metadata *tests;struct __fixture_metadata *prev, *next; } _fixture_global __attribute__((unused)) = { .name = "global",
@@ -696,7 +699,6 @@ struct __test_metadata { };/* Storage for the (global) tests to be run. */ -static struct __test_metadata *__test_list;static unsigned int __test_count;/*
@@ -711,7 +713,7 @@ static unsigned int __test_count;static inline void __register_test (struct __test_metadata *t) { __test_count++; -__LIST_APPEND (__test_list, t); +__LIST_APPEND (t->fixture->tests, t); }static inline int __bail (int for_realz,bool no_print,__u8 step)
@@ -789,6 +791,7 @@ void __run_test(struct __fixture_metadata *f,static int test_harness_run (int __attribute__((unused)) argc,char __attribute__((unused)) **argv) { +struct __fixture_metadata *f;struct __test_metadata *t;int ret =0 ;unsigned int count =0 ;
@@ -797,13 +800,15 @@ static int test_harness_run(int __attribute__((unused)) argc,/* TODO(wad) add optional arguments similar to gtest. */ printf ("[==========] Running %u tests from %u test cases.\n" , __test_count, __fixture_count +1 ); -for (t = __test_list; t; t = t->next) { - count++; -__run_test (t->fixture, t); -if (t->passed) - pass_count++; -else - ret =1 ; +for (f = __fixture_list; f; f = f->next) { +for (t = f->tests; t; t = t->next) { + count++; +__run_test (f, t); +if (t->passed) + pass_count++; +else + ret =1 ; + } }printf ("[==========] %u / %u tests passed.\n" , pass_count, count);printf ("[ %s ]\n" , (ret ?"FAILED" :"PASSED" ));
Signature · 1 line
2.25.1
Jakub Kicinski
maintainerPATCH v5 2/5 kselftest: create fixture objects
In reply to Jakub KicinskiGrouping tests by fixture will allow us to parametrize test runs. Create full objects for fixtures.
Add a "global" fixture for tests without a fixture.
---
v5:
- pass fixture as argument to __run_test() right away, previously this change was made in the next patch.
--- tools/testing/selftests/kselftest_harness.h | 51 +++++++++++++++------ 1 file changed, 38 insertions(+), 13 deletions(-)
tools/testing/selftests/kselftest_harness.h +38 -13
@@ -169,8 +169,10 @@#define __TEST_IMPL (test_name, _signal) \ static void test_name(struct __test_metadata *_metadata); \ static struct __test_metadata _##test_name##_object = \ - { .name = "global." #test_name, \ - .fn = &test_name, .termsig = _signal, \ + { .name = #test_name, \ + .fn = &test_name, \ + .fixture = &_fixture_global, \ + .termsig = _signal, \ .timeout = TEST_TIMEOUT_DEFAULT, }; \ static void __attribute__((constructor)) _register_##test_name(void) \ { \
@@ -212,10 +214,12 @@* populated and cleaned up using FIXTURE_SETUP() and FIXTURE_TEARDOWN(). */ #define FIXTURE (fixture_name) \ + static struct __fixture_metadata _##fixture_name##_fixture_object = \ + { .name = #fixture_name, }; \ static void __attribute__((constructor)) \ _register_##fixture_name##_data(void) \ { \ - __fixture_count++; \ + __register_fixture(&_##fixture_name##_fixture_object); \ } \ FIXTURE_DATA(fixture_name)
@@ -309,8 +313,9 @@ } \ static struct __test_metadata \ _##fixture_name##_##test_name##_object = { \ - .name = #fixture_name "." #test_name, \ + .name = #test_name, \ .fn = &wrapper_##fixture_name##_##test_name, \ + .fixture = &_##fixture_name##_fixture_object, \ .termsig = signal, \ .timeout = tmout, \ }; \
@@ -654,10 +659,33 @@ } \ } +/* Contains all the information about a fixture. */ +struct __fixture_metadata { +const char *name; +struct __fixture_metadata *prev, *next; +} _fixture_global __attribute__((unused)) = { + .name = "global", + .prev = &_fixture_global, +}; + +static struct __fixture_metadata *__fixture_list = &_fixture_global; +static unsigned int __fixture_count; +static int __constructor_order; + +#define _CONSTRUCTOR_ORDER_FORWARD 1 +#define _CONSTRUCTOR_ORDER_BACKWARD -1 + +static inline void __register_fixture (struct __fixture_metadata *f) +{ + __fixture_count++; +__LIST_APPEND (__fixture_list, f); +} +/* Contains all the information for test execution and status checking. */ struct __test_metadata {const char *name;void (*fn)(struct __test_metadata *); +struct __fixture_metadata *fixture;int termsig;int passed;int trigger;/* extra handler after the evaluation */
@@ -670,11 +698,6 @@ struct __test_metadata {/* Storage for the (global) tests to be run. */ static struct __test_metadata *__test_list;static unsigned int __test_count; -static unsigned int __fixture_count; -static int __constructor_order; - -#define _CONSTRUCTOR_ORDER_FORWARD 1 -#define _CONSTRUCTOR_ORDER_BACKWARD -1/* * Since constructors are called in reverse order, reverse the test
@@ -701,14 +724,15 @@ static inline int __bail(int for_realz, bool no_print, __u8 step)return 0 ; } -void __run_test (struct __test_metadata *t) +void __run_test (struct __fixture_metadata *f, +struct __test_metadata *t) {pid_t child_pid;int status; t->passed =1 ; t->trigger =0 ; -printf ("[ RUN ] %s\n" , t->name); +printf ("[ RUN ] %s.%s\n" , f->name, t->name);alarm (t->timeout); child_pid =fork ();if (child_pid <0 ) {
@@ -757,7 +781,8 @@ void __run_test(struct __test_metadata *t) status); } } -printf ("[ %4s ] %s\n" , (t->passed ?"OK" :"FAIL" ), t->name); +printf ("[ %4s ] %s.%s\n" , (t->passed ?"OK" :"FAIL" ), + f->name, t->name);alarm (0 ); }
@@ -774,7 +799,7 @@ static int test_harness_run(int __attribute__((unused)) argc, __test_count, __fixture_count + 1);for (t = __test_list; t; t = t->next) { count++; -__run_test (t); +__run_test (t->fixture, t);if (t->passed) pass_count++;else
Signature · 1 line
2.25.1
Quoted 1 line · Jakub Kicinski
Shuah please consider applying to the kselftest tree.
Just to confirm: yes please. Shuah, I'd love to see this land.
-Kees
Quoted 48 lines
This set is an attempt to make running tests for different sets of data easier. The direct motivation is the tls test which we'd like to run for TLS 1.2 and TLS 1.3, but currently there is no easy way to invoke the same tests with different parameters.
Tested all users of
kselftest_harness.h.v2:
- don't run tests by fixture
- don't pass params as an explicit argumentv3:
- go back to the orginal implementation with an extra parameter, and running by fixture (Kees);
- addLIST_APPENDhelper (Kees);
- add a dot between fixture and param name (Kees);
- rename the params to variants (Tim);v4:
- whitespace fixes.v5 (Kees):
- move a comment;
- remove a temporary variable;
- reword the commit message on patch 4.v1: https://lore.kernel.org/netdev/[email protected]/
v2: https://lore.kernel.org/netdev/[email protected]/
v3: https://lore.kernel.org/netdev/[email protected]/
v4: https://lore.kernel.org/netdev/[email protected]/Jakub Kicinski (5):
kselftest: factor out list manipulation to a helper
kselftest: create fixture objects
kselftest: run tests by fixture
kselftest: add fixture variants
selftests: tls: run all tests for TLS 1.2 and TLS 1.3Documentation/dev-tools/kselftest.rst | 3 +- tools/testing/selftests/kselftest_harness.h | 234 +++++++++++++++----- tools/testing/selftests/net/tls.c | 93 ++------ 3 files changed, 202 insertions(+), 128 deletions(-)Signature · 1 line
2.25.1
Signature · 1 line
Kees Cook
Jakub Kicinski
maintainerQuoted 11 lines · On Tue, 17 Mar 2020 18:01:48 -0700 Jakub Kicinski wrote:
Hi!
Shuah please consider applying to the kselftest tree.
This set is an attempt to make running tests for different sets of data easier. The direct motivation is the tls test which we'd like to run for TLS 1.2 and TLS 1.3, but currently there is no easy way to invoke the same tests with different parameters.
Tested all users of
kselftest_harness.h.
Hi Shuah!
Were these applied anywhere? I'm happy to take them via the networking tree if that's easier.
Quoted 11 lines · Jakub Kicinski
Quoted 10 lines · On Tue, 17 Mar 2020 18:01:48 -0700 Jakub Kicinski wrote:
Hi!
Shuah please consider applying to the kselftest tree.
This set is an attempt to make running tests for different sets of data easier. The direct motivation is the tls test which we'd like to run for TLS 1.2 and TLS 1.3, but currently there is no easy way to invoke the same tests with different parameters.
Quoted 6 lines
Quoted 1 line
Tested all users of
kselftest_harness.h.Hi Shuah!
Were these applied anywhere? I'm happy to take them via the networking tree if that's easier.
Shuah, with -rc1 out the door, would now be a good time to take this series?
Thanks!
-Kees
Signature · 1 line
Kees Cook