Re: [PATCH] lib: Convert UUID runtime test to KUnit

9 Jun 2021

Às 22:02 de 07/06/21, Daniel Latypov escreveu:
...
On Sat, Jun 5, 2021 at 2:52 PM André Almeida andrealmeid@collabora.com wrote:
...
Remove custom functions for testing and use KUnit framework. Test cases
and test data remains the same.
Signed-off-by: André Almeida andrealmeid@collabora.com
lib/Kconfig.debug |  13 +++--
 lib/Makefile      |   2 +-
 lib/test_uuid.c   | 131 ++++++++++++++++++----------------------------
 3 files changed, 62 insertions(+), 84 deletions(-)

diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug
index 678c13967580..e8bd574d7a67 100644
--- a/lib/Kconfig.debug
+++ b/lib/Kconfig.debug
@@ -2188,9 +2188,6 @@ config TEST_BITMAP
      If unsure, say N.


-config TEST_UUID

  tristate "Test functions located in the uuid module at runtime"




config TEST_XARRAY
        tristate "Test the XArray code at runtime"
@@ -2429,6 +2426,16 @@ config BITS_TEST
      If unsure, say N.


+config TEST_UUID

  tristate "Unit test for UUID" if !KUNIT_ALL_TESTS


  depends on KUNIT


  default KUNIT_ALL_TESTS


  help


    This builds the UUID unit test.


    Tests parsing functions for UUID/GUID strings.



    If unsure, say N.




Random question: this moves the config option down.
Is the intent to keep all the KUnit-based tests together?
Yes.
...
I personally think it would be fine to leave it where it was, makes
`git blame` a bit more useful.
No problem for me, I'll change that for v2.
...
...
config TEST_UDELAY
        tristate "udelay test driver"
        help
diff --git a/lib/Makefile b/lib/Makefile
index 2cc359ec1fdd..6ef3c614409d 100644
--- a/lib/Makefile
+++ b/lib/Makefile
@@ -85,7 +85,6 @@ obj-$(CONFIG_TEST_STATIC_KEYS) += test_static_key_base.o
 obj-$(CONFIG_TEST_PRINTF) += test_printf.o
 obj-$(CONFIG_TEST_BITMAP) += test_bitmap.o
 obj-$(CONFIG_TEST_STRSCPY) += test_strscpy.o
-obj-$(CONFIG_TEST_UUID) += test_uuid.o
 obj-$(CONFIG_TEST_XARRAY) += test_xarray.o
 obj-$(CONFIG_TEST_PARMAN) += test_parman.o
 obj-$(CONFIG_TEST_KMOD) += test_kmod.o
@@ -354,5 +353,6 @@ obj-$(CONFIG_LIST_KUNIT_TEST) += list-test.o
 obj-$(CONFIG_LINEAR_RANGES_TEST) += test_linear_ranges.o
 obj-$(CONFIG_BITS_TEST) += test_bits.o
 obj-$(CONFIG_CMDLINE_KUNIT_TEST) += cmdline_kunit.o
+obj-$(CONFIG_TEST_UUID) += test_uuid.o
obj-$(CONFIG_GENERIC_LIB_DEVMEM_IS_ALLOWED) += devmem_is_allowed.o
diff --git a/lib/test_uuid.c b/lib/test_uuid.c
index cd819c397dc7..45c919b0d724 100644
--- a/lib/test_uuid.c
+++ b/lib/test_uuid.c
@@ -1,21 +1,20 @@
+// SPDX-License-Identifier: (GPL-2.0-or-later OR BSD-2-Clause)
 /*


Test cases for lib/uuid.c module.





Unit tests for lib/uuid.c module.







Copyright 2016 Andy Shevchenko andriy.shevchenko@linux.intel.com



Copyright 2021 André Almeida andrealmeid@riseup.net

*/

-#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt



-#include <linux/init.h>
-#include <linux/kernel.h>
-#include <linux/module.h>
-#include <linux/string.h>
+#include <kunit/test.h>
 #include <linux/uuid.h>
-struct test_uuid_data {
+struct test_data {
        const char *uuid;
        guid_t le;
        uuid_t be;
 };
-static const struct test_uuid_data test_uuid_test_data[] = {
+static const struct test_data correct_data[] = {
        {
                .uuid = "c33f4995-3701-450e-9fbf-206a2e98e576",
                .le = GUID_INIT(0xc33f4995, 0x3701, 0x450e, 0x9f, 0xbf, 0x20, 0x6a, 0x2e, 0x98, 0xe5, 0x76),
@@ -33,101 +32,73 @@ static const struct test_uuid_data test_uuid_test_data[] = {
        },
 };
-static const char * const test_uuid_wrong_data[] = {
+static const char * const wrong_data[] = {
        "c33f4995-3701-450e-9fbf206a2e98e576 ", /* no hyphen(s) */
        "64b4371c-77c1-48f9-8221-29f054XX023b", /* invalid character(s) */
        "0cb4ddff-a545-4401-9d06-688af53e",     /* not enough data */
 };
-static unsigned total_tests __initdata;
-static unsigned failed_tests __initdata;



-static void __init test_uuid_failed(const char *prefix, bool wrong, bool be,

                              const char *data, const char *actual)



+static void uuid_correct_le(struct kunit *test)
 {

  pr_err("%s test #%u %s %s data: '%s'\n",


         prefix,


         total_tests,


         wrong ? "passed on wrong" : "failed on",


         be ? "BE" : "LE",


         data);


  if (actual && *actual)


          pr_err("%s test #%u actual data: '%s'\n",


                 prefix,


                 total_tests,


                 actual);


  failed_tests++;




  guid_t le;


  const struct test_data *data = (const struct test_data *)(test->param_value);



  KUNIT_ASSERT_EQ(test, guid_parse(data->uuid, &le), 0);


  KUNIT_EXPECT_TRUE(test, guid_equal(&data->le, &le));



}
-static void __init test_uuid_test(const struct test_uuid_data *data)
+static void uuid_correct_be(struct kunit *test)
 {

  guid_t le;
  uuid_t be;


  char buf[48];



  /* LE */


  total_tests++;


  if (guid_parse(data->uuid, &le))


          test_uuid_failed("conversion", false, false, data->uuid, NULL);



  total_tests++;


  if (!guid_equal(&data->le, &le)) {


          sprintf(buf, "%pUl", &le);


          test_uuid_failed("cmp", false, false, data->uuid, buf);


  }



  /* BE */


  total_tests++;


  if (uuid_parse(data->uuid, &be))


          test_uuid_failed("conversion", false, true, data->uuid, NULL);



  total_tests++;


  if (!uuid_equal(&data->be, &be)) {


          sprintf(buf, "%pUb", &be);


          test_uuid_failed("cmp", false, true, data->uuid, buf);


  }




  const struct test_data *data = (const struct test_data *)(test->param_value);




...

  KUNIT_ASSERT_EQ(test, uuid_parse(data->uuid, &be), 0);


  KUNIT_EXPECT_TRUE(test, uuid_equal(&data->be, &be));



You could make use of the _MSG variants, fyi.
See https://www.kernel.org/doc/html/latest/dev-tools/kunit/tips.html#customizing...
I'd actually written up a version of this patch but never ended up
sending it out.
(I prefer how you've more properly split up the test cases and used
parameterized testing.)
Here's how I'd converted the test case using those _MSG variants:
        /* LE */
        KUNIT_EXPECT_FALSE_MSG(test, guid_parse(data->uuid, &le),
                               "LE: failed to parse '%s'", data->uuid);
    KUNIT_EXPECT_TRUE_MSG(test, guid_equal(&data->le, &le),
            "LE: '%s' should be equal to %pUl", data->uuid, &le);

    /* BE */
    KUNIT_EXPECT_FALSE_MSG(test, uuid_parse(data->uuid, &be),
                           "BE: failed to parse '%s'", data->uuid);

    KUNIT_EXPECT_TRUE_MSG(test, uuid_equal(&data->be, &be),
            "BE: '%s' should be equal to %pUl", data->uuid, &be);


Example failure output:
          # test_uuid: EXPECTATION FAILED at lib/test_uuid.c:77
          Expected uuid_equal(&data->be, &be) to be true, but is false
  BE: 'c33f4995-3701-450e-9fbf-206a2e98e576' should be equal to

95493fc3-0137-0e45-9fbf-206a2e98e576
          not ok 1 - test_uuid
Awesome, I really wasn't aware of those _MSG variants, I'll use them for
v2, thanks!
...
...
}
-static void __init test_uuid_wrong(const char *data)
+static void uuid_wrong_le(struct kunit *test)
 {
        guid_t le;

  uuid_t be;



  /* LE */


  total_tests++;


  if (!guid_parse(data, &le))


          test_uuid_failed("negative", true, false, data, NULL);




  const char *data = (const char *)(test->param_value);





  /* BE */


  total_tests++;


  if (!uuid_parse(data, &be))


          test_uuid_failed("negative", true, true, data, NULL);




  KUNIT_ASSERT_NE(test, guid_parse(data, &le), 0);



}
-static int __init test_uuid_init(void)
+static void uuid_wrong_be(struct kunit *test)
 {

  unsigned int i;



  for (i = 0; i < ARRAY_SIZE(test_uuid_test_data); i++)


          test_uuid_test(&test_uuid_test_data[i]);



  for (i = 0; i < ARRAY_SIZE(test_uuid_wrong_data); i++)


          test_uuid_wrong(test_uuid_wrong_data[i]);




  uuid_t be;


  const char *data = (const char *)(test->param_value);





  if (failed_tests == 0)


          pr_info("all %u tests passed\n", total_tests);


  else


          pr_err("failed %u out of %u tests\n", failed_tests, total_tests);




  KUNIT_ASSERT_NE(test, uuid_parse(data, &be), 0);



+}

  return failed_tests ? -EINVAL : 0;



+static void case_to_desc_correct(const struct test_data *t, char *desc)
+{

  strcpy(desc, t->uuid);



}
-module_init(test_uuid_init);
-static void __exit test_uuid_exit(void)
+KUNIT_ARRAY_PARAM(correct, correct_data, case_to_desc_correct);



+static void case_to_desc_wrong(const char * const *s, char *desc)
 {

  /* do nothing */




  strcpy(desc, *s);



}
-module_exit(test_uuid_exit);



+KUNIT_ARRAY_PARAM(wrong, wrong_data, case_to_desc_wrong);



+static struct kunit_case uuid_test_cases[] = {

  KUNIT_CASE_PARAM(uuid_correct_be, correct_gen_params),


  KUNIT_CASE_PARAM(uuid_correct_le, correct_gen_params),


  KUNIT_CASE_PARAM(uuid_wrong_be, wrong_gen_params),


  KUNIT_CASE_PARAM(uuid_wrong_le, wrong_gen_params),


  {}



+};



+static struct kunit_suite uuid_test_suite = {

  .name = "uuid-test",


  .test_cases = uuid_test_cases,



+};
+kunit_test_suite(uuid_test_suite);
MODULE_AUTHOR("Andy Shevchenko andriy.shevchenko@linux.intel.com");
 MODULE_LICENSE("Dual BSD/GPL");
--
2.31.1
--
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 kunit-dev+unsubscribe@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/20210605215215.171165-1-andrealm....

    

2024

2023

2022

2021

2020

2019

2018

2017

Re: [PATCH] lib: Convert UUID runtime test to KUnit

Signed-off-by: André Almeida andrealmeid@collabora.com