[PATCH] lib: kunit: add test_min_heap test conversion to KUnit

[Vitor Massaru Iha]

This adds the conversion of the runtime tests of test_min_heap,
from `lib/test_min_heap.c` to KUnit tests.

Please apply this commit first (linux-kselftest/kunit-fixes):
3f37d14b8a3152441f36b6bc74000996679f0998 kunit: kunit_config: Fix parsing of CONFIG options with space

Signed-off-by: Vitor Massaru Iha <vi...@massaru.org>
---
lib/Kconfig.debug | 29 ++++--
lib/Makefile | 2 +-
lib/{test_min_heap.c => min_heap_kunit.c} | 117 ++++++++++++----------
3 files changed, 83 insertions(+), 65 deletions(-)
rename lib/{test_min_heap.c => min_heap_kunit.c} (60%)

diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug
index 9ad9210d70a1..46674fc4972c 100644
--- a/lib/Kconfig.debug
+++ b/lib/Kconfig.debug
@@ -1864,16 +1864,6 @@ config TEST_LIST_SORT

If unsure, say N.

-config TEST_MIN_HEAP
- tristate "Min heap test"
- depends on DEBUG_KERNEL || m
- help
- Enable this to turn on min heap function tests. This test is
- executed only once during system boot (so affects only boot time),
- or at module load time.
-
- If unsure, say N.
-
config TEST_SORT
tristate "Array-based sort test"
depends on DEBUG_KERNEL || m
@@ -2185,6 +2175,25 @@ config LINEAR_RANGES_TEST

If unsure, say N.

+config MIN_HEAP_KUNIT
+ tristate "KUnit test for Min heap"
+ depends on KUNIT
+ depends on DEBUG_KERNEL || m
+ help
+ Enable this to turn on min heap function tests. This test is
+ executed only once during system boot (so affects only boot time),
+ or at module load time.
+
+ KUnit tests run during boot and output the results to the debug log
+ in TAP format (http://testanything.org/). Only useful for kernel devs
+ running the KUnit test harness, and not intended for inclusion into a
+ production build.
+
+ For more information on KUnit and unit tests in general please refer
+ to the KUnit documentation in Documentation/dev-tools/kunit/.
+
+ If unsure, say N.
+
config TEST_UDELAY
tristate "udelay test driver"
help
diff --git a/lib/Makefile b/lib/Makefile
index b1c42c10073b..748f57063160 100644
--- a/lib/Makefile
+++ b/lib/Makefile
@@ -72,7 +72,6 @@ CFLAGS_test_ubsan.o += $(call cc-disable-warning, vla)
UBSAN_SANITIZE_test_ubsan.o := y
obj-$(CONFIG_TEST_KSTRTOX) += test-kstrtox.o
obj-$(CONFIG_TEST_LIST_SORT) += test_list_sort.o
-obj-$(CONFIG_TEST_MIN_HEAP) += test_min_heap.o
obj-$(CONFIG_TEST_LKM) += test_module.o
obj-$(CONFIG_TEST_VMALLOC) += test_vmalloc.o
obj-$(CONFIG_TEST_OVERFLOW) += test_overflow.o
@@ -318,3 +317,4 @@ obj-$(CONFIG_OBJAGG) += objagg.o
# KUnit tests
obj-$(CONFIG_LIST_KUNIT_TEST) += list-test.o
obj-$(CONFIG_LINEAR_RANGES_TEST) += test_linear_ranges.o
+obj-$(CONFIG_MIN_HEAP_KUNIT) += min_heap_kunit.o
diff --git a/lib/test_min_heap.c b/lib/min_heap_kunit.c
similarity index 60%
rename from lib/test_min_heap.c
rename to lib/min_heap_kunit.c
index d19c8080fd4d..398db1c63146 100644
--- a/lib/test_min_heap.c
+++ b/lib/min_heap_kunit.c
@@ -7,9 +7,8 @@

#include <linux/log2.h>
#include <linux/min_heap.h>
-#include <linux/module.h>
-#include <linux/printk.h>
#include <linux/random.h>
+#include <kunit/test.h>

static __init bool less_than(const void *lhs, const void *rhs)
{
@@ -29,37 +28,34 @@ static __init void swap_ints(void *lhs, void *rhs)
*(int *)rhs = temp;
}

-static __init int pop_verify_heap(bool min_heap,
+static __init void pop_verify_heap(struct kunit *context,
+ bool min_heap,
struct min_heap *heap,
const struct min_heap_callbacks *funcs)
{
int *values = heap->data;
- int err = 0;
int last;

last = values[0];
min_heap_pop(heap, funcs);
while (heap->nr > 0) {
if (min_heap) {
- if (last > values[0]) {
- pr_err("error: expected %d <= %d\n", last,
- values[0]);
- err++;
- }
+ KUNIT_EXPECT_FALSE_MSG(context,
+ last > values[0],
+ "expected %d <= %d\n",
+ last, values[0]);
} else {
- if (last < values[0]) {
- pr_err("error: expected %d >= %d\n", last,
- values[0]);
- err++;
- }
+ KUNIT_EXPECT_FALSE_MSG(context,
+ last < values[0],
+ "expected %d >= %d\n",
+ last, values[0]);
}
last = values[0];
min_heap_pop(heap, funcs);
}
- return err;
}

-static __init int test_heapify_all(bool min_heap)
+static __init void test_heapify_all(struct kunit *context, bool min_heap)
{
int values[] = { 3, 1, 2, 4, 0x8000000, 0x7FFFFFF, 0,
-3, -1, -2, -4, 0x8000000, 0x7FFFFFF };
@@ -73,12 +69,11 @@ static __init int test_heapify_all(bool min_heap)
.less = min_heap ? less_than : greater_than,
.swp = swap_ints,
};
- int i, err;
+ int i;

/* Test with known set of values. */
min_heapify_all(&heap, &funcs);
- err = pop_verify_heap(min_heap, &heap, &funcs);
-
+ pop_verify_heap(context, min_heap, &heap, &funcs);

/* Test with randomly generated values. */
heap.nr = ARRAY_SIZE(values);
@@ -86,12 +81,10 @@ static __init int test_heapify_all(bool min_heap)
values[i] = get_random_int();

min_heapify_all(&heap, &funcs);
- err += pop_verify_heap(min_heap, &heap, &funcs);
-
- return err;
+ pop_verify_heap(context, min_heap, &heap, &funcs);
}

-static __init int test_heap_push(bool min_heap)
+static __init void test_heap_push(struct kunit *context, bool min_heap)
{
const int data[] = { 3, 1, 2, 4, 0x80000000, 0x7FFFFFFF, 0,
-3, -1, -2, -4, 0x80000000, 0x7FFFFFFF };
@@ -106,25 +99,22 @@ static __init int test_heap_push(bool min_heap)
.less = min_heap ? less_than : greater_than,
.swp = swap_ints,
};
- int i, temp, err;
+ int i, temp;

/* Test with known set of values copied from data. */
for (i = 0; i < ARRAY_SIZE(data); i++)
min_heap_push(&heap, &data[i], &funcs);
-
- err = pop_verify_heap(min_heap, &heap, &funcs);
+ pop_verify_heap(context, min_heap, &heap, &funcs);

/* Test with randomly generated values. */
while (heap.nr < heap.size) {
temp = get_random_int();
min_heap_push(&heap, &temp, &funcs);
}
- err += pop_verify_heap(min_heap, &heap, &funcs);
-
- return err;
+ pop_verify_heap(context, min_heap, &heap, &funcs);
}

-static __init int test_heap_pop_push(bool min_heap)
+static __init void test_heap_pop_push(struct kunit *context, bool min_heap)
{
const int data[] = { 3, 1, 2, 4, 0x80000000, 0x7FFFFFFF, 0,
-3, -1, -2, -4, 0x80000000, 0x7FFFFFFF };
@@ -139,7 +129,7 @@ static __init int test_heap_pop_push(bool min_heap)
.less = min_heap ? less_than : greater_than,
.swp = swap_ints,
};
- int i, temp, err;
+ int i, temp;

/* Fill values with data to pop and replace. */
temp = min_heap ? 0x80000000 : 0x7FFFFFFF;
@@ -149,8 +139,7 @@ static __init int test_heap_pop_push(bool min_heap)
/* Test with known set of values copied from data. */
for (i = 0; i < ARRAY_SIZE(data); i++)
min_heap_pop_push(&heap, &data[i], &funcs);
-
- err = pop_verify_heap(min_heap, &heap, &funcs);
+ pop_verify_heap(context, min_heap, &heap, &funcs);

heap.nr = 0;
for (i = 0; i < ARRAY_SIZE(data); i++)
@@ -161,34 +150,54 @@ static __init int test_heap_pop_push(bool min_heap)
temp = get_random_int();
min_heap_pop_push(&heap, &temp, &funcs);
}
- err += pop_verify_heap(min_heap, &heap, &funcs);
+ pop_verify_heap(context, min_heap, &heap, &funcs);
+}

- return err;
+static void __init test_heapify_all_true(struct kunit *context)
+{
+ test_heapify_all(context, true);
}

-static int __init test_min_heap_init(void)
+static void __init test_heapify_all_false(struct kunit *context)
{
- int err = 0;
-
- err += test_heapify_all(true);
- err += test_heapify_all(false);
- err += test_heap_push(true);
- err += test_heap_push(false);
- err += test_heap_pop_push(true);
- err += test_heap_pop_push(false);
- if (err) {
- pr_err("test failed with %d errors\n", err);
- return -EINVAL;
- }
- pr_info("test passed\n");
- return 0;
+ test_heapify_all(context, true);
+}
+
+static void __init test_heap_push_true(struct kunit *context)
+{
+ test_heap_push(context, true);
+}
+
+static void __init test_heap_push_false(struct kunit *context)
+{
+ test_heap_push(context, false);
}
-module_init(test_min_heap_init);

-static void __exit test_min_heap_exit(void)
+static void __init test_heap_pop_push_true(struct kunit *context)
{
- /* do nothing */
+ test_heap_pop_push(context, true);
}
-module_exit(test_min_heap_exit);
+
+static void __init test_heap_pop_push_false(struct kunit *context)
+{
+ test_heap_pop_push(context, false);
+}
+
+static struct kunit_case __refdata min_heap_test_cases[] = {
+ KUNIT_CASE(test_heapify_all_true),
+ KUNIT_CASE(test_heapify_all_false),
+ KUNIT_CASE(test_heap_push_true),
+ KUNIT_CASE(test_heap_push_false),
+ KUNIT_CASE(test_heap_pop_push_true),
+ KUNIT_CASE(test_heap_pop_push_false),
+ {}
+};
+
+static struct kunit_suite min_heap_test_suite = {
+ .name = "min-heap",
+ .test_cases = min_heap_test_cases,
+};
+
+kunit_test_suites(&min_heap_test_suite);

MODULE_LICENSE("GPL");

base-commit: d43c7fb05765152d4d4a39a8ef957c4ea14d8847
--
2.26.2

[pet...@infradead.org]

On Wed, Jul 29, 2020 at 05:11:46PM -0300, Vitor Massaru Iha wrote:
> This adds the conversion of the runtime tests of test_min_heap,
> from `lib/test_min_heap.c` to KUnit tests.
>
> Please apply this commit first (linux-kselftest/kunit-fixes):
> 3f37d14b8a3152441f36b6bc74000996679f0998 kunit: kunit_config: Fix parsing of CONFIG options with space
>
> Signed-off-by: Vitor Massaru Iha <vi...@massaru.org>
> ---
> lib/Kconfig.debug | 29 ++++--
> lib/Makefile | 2 +-
> lib/{test_min_heap.c => min_heap_kunit.c} | 117 ++++++++++++----------
> 3 files changed, 83 insertions(+), 65 deletions(-)
> rename lib/{test_min_heap.c => min_heap_kunit.c} (60%)

So where's the win? What's KUnit, why should I care and more lines.

[Vitor Massaru Iha]

Hi Peter,

KUnit is a unit testing and mocking framework for the Linux kernel. [0]

In Kconfig.debug you only have some more information about KUnit.

If the number of lines is a parameter that should be considered, I can
change sections like this

- if (last > values[0]) {
- pr_err("error: expected %d <= %d\n", last,
- values[0]);
- err++;
- }
+ KUNIT_EXPECT_FALSE_MSG(context,
+ last > values[0],
+ "expected %d <= %d\n",
+ last, values[0]);

To this:

- if (last > values[0]) {
- pr_err("error: expected %d <= %d\n", last,
- values[0]);
- err++;
- }

+ KUNIT_EXPECT_FALSE_MSG(context, last >
values[0], "expected %d <= %d\n", last, values[0]);

And from this:

+static struct kunit_case __refdata min_heap_test_cases[] = {
+ KUNIT_CASE(test_heapify_all_true),
+ KUNIT_CASE(test_heapify_all_false),
+ KUNIT_CASE(test_heap_push_true),
+ KUNIT_CASE(test_heap_push_false),
+ KUNIT_CASE(test_heap_pop_push_true),
+ KUNIT_CASE(test_heap_pop_push_false),
+ {}

To this:

+static struct kunit_case __refdata min_heap_test_cases[] = {

+ KUNIT_CASE(test_min_heap),
+ {}

I did the latter this way to be more informative, but if the goal is
to reduce lines of code, this is possible.

The results can be seen this way:

This is an excerpt from the test.log with the result in TAP format:
[snip]
ok 5 - example
# Subtest: min-heap
1..6
ok 1 - test_heapify_all_true
ok 2 - test_heapify_all_false
ok 3 - test_heap_push_true
ok 4 - test_heap_push_false
ok 5 - test_heap_pop_push_true
ok 6 - test_heap_pop_push_false
[snip]

And this from kunit-tool:
[snip]
[18:43:32] ============================================================
[18:43:32] ======== [PASSED] min-heap ========
[18:43:32] [PASSED] test_heapify_all_true
[18:43:32] [PASSED] test_heapify_all_false
[18:43:32] [PASSED] test_heap_push_true
[18:43:32] [PASSED] test_heap_push_false
[18:43:32] [PASSED] test_heap_pop_push_true
[18:43:32] [PASSED] test_heap_pop_push_false
[18:43:32] ============================================================
[18:43:32] Testing complete. 20 tests run. 0 failed. 0 crashed.
[18:43:32] Elapsed time: 9.758s total, 0.001s configuring, 6.012s
building, 0.000s running
[snip]

BR,
Vitor

[0] https://www.kernel.org/doc/html/latest/dev-tools/kunit/index.html#what-is-kunit

[Ian Rogers]

On Wed, Jul 29, 2020 at 1:11 PM Vitor Massaru Iha <vi...@massaru.org> wrote:
>
> This adds the conversion of the runtime tests of test_min_heap,
> from `lib/test_min_heap.c` to KUnit tests.
>
> Please apply this commit first (linux-kselftest/kunit-fixes):
> 3f37d14b8a3152441f36b6bc74000996679f0998 kunit: kunit_config: Fix parsing of CONFIG options with space

Thanks for this, I'm a fan of testing frameworks :-)

It's a shame we need a config option for this. Could we have one
option to cover all basic library tests?

I'm not familiar with kunit, is there a reason not to prefer:
KUNIT_EXPECT_LT(context, last, values[0]);

> } else {
> - if (last < values[0]) {
> - pr_err("error: expected %d >= %d\n", last,
> - values[0]);
> - err++;
> - }
> + KUNIT_EXPECT_FALSE_MSG(context,
> + last < values[0],
> + "expected %d >= %d\n",
> + last, values[0]);

Similarly KUNIT_EXPECT_GT.

Thanks,
Ian

[Vitor Massaru Iha]

Hi Ian,

Sure, I think so.

Nope. I will fix this and the other one that you pointed down below.

Thanks!

> --
> 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+...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/kunit-dev/CAP-5%3DfWCMPyBYqn4p%2B_%3DRa5_sXqUbr4h_OCuYS4iY-6fsnevvA%40mail.gmail.com.

[pet...@infradead.org]

I don't care or care to use either; what does dmesg do? It used to be
that just building the self-tests was sufficient and any error would
show in dmesg when you boot the machine.

But if I now have to use some damn tool, this is a regression.

[Vitor Massaru Iha]

Hi Peter,

If you don't want to, you don't need to use the kunit-tool. If you
compile the tests as builtin and run the Kernel on your machine
the test result will be shown in dmesg in TAP format.

BR,
Vitor

[pet...@infradead.org]

On Tue, Aug 04, 2020 at 10:46:21AM -0300, Vitor Massaru Iha wrote:
> On Tue, Aug 4, 2020 at 10:25 AM <pet...@infradead.org> wrote:
> > On Wed, Jul 29, 2020 at 06:57:17PM -0300, Vitor Massaru Iha wrote:
> >
> > > The results can be seen this way:
> > >
> > > This is an excerpt from the test.log with the result in TAP format:
> > > [snip]
> > > ok 5 - example
> > > # Subtest: min-heap
> > > 1..6
> > > ok 1 - test_heapify_all_true
> > > ok 2 - test_heapify_all_false
> > > ok 3 - test_heap_push_true
> > > ok 4 - test_heap_push_false
> > > ok 5 - test_heap_pop_push_true
> > > ok 6 - test_heap_pop_push_false
> > > [snip]

So ^ is TAP format?

> > I don't care or care to use either; what does dmesg do? It used to be
> > that just building the self-tests was sufficient and any error would
> > show in dmesg when you boot the machine.
> >
> > But if I now have to use some damn tool, this is a regression.
>
> If you don't want to, you don't need to use the kunit-tool. If you
> compile the tests as builtin and run the Kernel on your machine
> the test result will be shown in dmesg in TAP format.

That's seems a lot more verbose than it is now. I've recently even done
a bunch of tests that don't print anything on success, dmesg is clutter
enough already.

[Vitor Massaru Iha]

Hi Peter,

On Tue, Aug 4, 2020 at 11:23 AM <pet...@infradead.org> wrote:
>
> On Tue, Aug 04, 2020 at 10:46:21AM -0300, Vitor Massaru Iha wrote:
> > On Tue, Aug 4, 2020 at 10:25 AM <pet...@infradead.org> wrote:
> > > On Wed, Jul 29, 2020 at 06:57:17PM -0300, Vitor Massaru Iha wrote:
> > >
> > > > The results can be seen this way:
> > > >
> > > > This is an excerpt from the test.log with the result in TAP format:
> > > > [snip]
> > > > ok 5 - example
> > > > # Subtest: min-heap
> > > > 1..6
> > > > ok 1 - test_heapify_all_true
> > > > ok 2 - test_heapify_all_false
> > > > ok 3 - test_heap_push_true
> > > > ok 4 - test_heap_push_false
> > > > ok 5 - test_heap_pop_push_true
> > > > ok 6 - test_heap_pop_push_false
> > > > [snip]
>
> So ^ is TAP format?

Yep, you can see the spec here: https://testanything.org/tap-specification.html

>
> > > I don't care or care to use either; what does dmesg do? It used to be
> > > that just building the self-tests was sufficient and any error would
> > > show in dmesg when you boot the machine.
> > >
> > > But if I now have to use some damn tool, this is a regression.
> >
> > If you don't want to, you don't need to use the kunit-tool. If you
> > compile the tests as builtin and run the Kernel on your machine
> > the test result will be shown in dmesg in TAP format.
>
> That's seems a lot more verbose than it is now. I've recently even done
> a bunch of tests that don't print anything on success, dmesg is clutter
> enough already.

What tests do you refer to?

Running the test_min_heap.c, I got this from dmesg:

min_heap_test: test passed

And running min_heap_kunit.c:

ok 1 - min-heap

BR,
Vitor

[Brendan Higgins]

Gentle poke. I think Vitor was looking for a response. My guess is
that Ian was waiting for a follow up patch.

[Ian Rogers]

There were some issues in the original patch, they should be easy to
fix. I'm more concerned that Peter's issues are addressed about the
general direction of the patch, verbosity and testing frameworks. I
see Vitor followed up with Peter but I'm not sure that means the
approach has been accepted.

Thanks,
Ian

[Peter Zijlstra]

On Wed, Oct 14, 2020 at 11:16:10AM -0700, Ian Rogers wrote:

> There were some issues in the original patch, they should be easy to
> fix. I'm more concerned that Peter's issues are addressed about the
> general direction of the patch, verbosity and testing frameworks. I
> see Vitor followed up with Peter but I'm not sure that means the
> approach has been accepted.

I kinda lost track, as long as it doesn't get more verbose I suppose I'm
fine.

[Vitor Massaru Iha]

Ok. I'll send the v2 later with Ian's suggestions.

[Vitor Massaru Iha]

This adds the conversion of the runtime tests of test_min_heap,
from `lib/test_min_heap.c` to KUnit tests.

Signed-off-by: Vitor Massaru Iha <vi...@massaru.org>
---

v2:
* min_heap test now runs when enabling full test coverage (KUNIT_ALL_TESTS).

---
lib/Kconfig.debug | 29 ++++--
lib/Makefile | 2 +-
lib/{test_min_heap.c => min_heap_kunit.c} | 117 ++++++++++++----------
3 files changed, 83 insertions(+), 65 deletions(-)
rename lib/{test_min_heap.c => min_heap_kunit.c} (60%)

diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug

index 4f09c6505a2e..b75f4541e7d2 100644
--- a/lib/Kconfig.debug
+++ b/lib/Kconfig.debug
@@ -1915,16 +1915,6 @@ config TEST_LIST_SORT

If unsure, say N.

-config TEST_MIN_HEAP
- tristate "Min heap test"
- depends on DEBUG_KERNEL || m
- help
- Enable this to turn on min heap function tests. This test is
- executed only once during system boot (so affects only boot time),
- or at module load time.
-
- If unsure, say N.
-
config TEST_SORT
tristate "Array-based sort test"
depends on DEBUG_KERNEL || m

@@ -2256,6 +2246,25 @@ config BITS_TEST

If unsure, say N.

+config MIN_HEAP_KUNIT

+ tristate "KUnit test for Min heap" if !KUNIT_ALL_TESTS
+ depends on KUNIT
+ default KUNIT_ALL_TESTS

+ help
+ Enable this to turn on min heap function tests. This test is
+ executed only once during system boot (so affects only boot time),
+ or at module load time.
+
+ KUnit tests run during boot and output the results to the debug log
+ in TAP format (http://testanything.org/). Only useful for kernel devs
+ running the KUnit test harness, and not intended for inclusion into a
+ production build.
+
+ For more information on KUnit and unit tests in general please refer
+ to the KUnit documentation in Documentation/dev-tools/kunit/.
+
+ If unsure, say N.
+

config TEST_UDELAY
tristate "udelay test driver"
help
diff --git a/lib/Makefile b/lib/Makefile

index d862d41fdc3d..c88ade843502 100644
--- a/lib/Makefile
+++ b/lib/Makefile
@@ -68,7 +68,6 @@ CFLAGS_test_ubsan.o += $(call cc-disable-warning, vla)

UBSAN_SANITIZE_test_ubsan.o := y
obj-$(CONFIG_TEST_KSTRTOX) += test-kstrtox.o
obj-$(CONFIG_TEST_LIST_SORT) += test_list_sort.o
-obj-$(CONFIG_TEST_MIN_HEAP) += test_min_heap.o
obj-$(CONFIG_TEST_LKM) += test_module.o
obj-$(CONFIG_TEST_VMALLOC) += test_vmalloc.o
obj-$(CONFIG_TEST_OVERFLOW) += test_overflow.o

@@ -343,3 +342,4 @@ obj-$(CONFIG_BITFIELD_KUNIT) += bitfield_kunit.o

obj-$(CONFIG_LIST_KUNIT_TEST) += list-test.o
obj-$(CONFIG_LINEAR_RANGES_TEST) += test_linear_ranges.o

obj-$(CONFIG_BITS_TEST) += test_bits.o

} else {
- if (last < values[0]) {
- pr_err("error: expected %d >= %d\n", last,
- values[0]);
- err++;
- }
+ KUNIT_EXPECT_FALSE_MSG(context,
+ last < values[0],
+ "expected %d >= %d\n",
+ last, values[0]);
}

base-commit: d2585f5164c298aaaed14c2c8d313cbe7bd5b253
--
2.26.2

[Vitor Massaru Iha]

Hi Ian,

In relation to this, instead of KUNIT_EXPECT_LT, we would have to have
something like KUNIT_EXPECT_LT_FALSE.
Otherwise the test will always fail.

[Vitor Massaru Iha]

This adds the conversion of the runtime tests of test_min_heap,
from `lib/test_min_heap.c` to KUnit tests.

Signed-off-by: Vitor Massaru Iha <vi...@massaru.org>
---

v2:
* change Kconfig entries to be more adherent to KUnit documentation,
min_heap test runs when enabling full test coverage (KUNIT_ALL_TESTS).
* make kconfig help more concise;
* fix KUNIT_TEST sufix;
---
lib/Kconfig.debug | 24 +++--

lib/Makefile | 2 +-
lib/{test_min_heap.c => min_heap_kunit.c} | 117 ++++++++++++----------

3 files changed, 78 insertions(+), 65 deletions(-)

rename lib/{test_min_heap.c => min_heap_kunit.c} (60%)

diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug

index 4f09c6505a2e..0e10ef1176de 100644
--- a/lib/Kconfig.debug
+++ b/lib/Kconfig.debug
@@ -1915,16 +1915,6 @@ config TEST_LIST_SORT

If unsure, say N.

-config TEST_MIN_HEAP
- tristate "Min heap test"
- depends on DEBUG_KERNEL || m
- help
- Enable this to turn on min heap function tests. This test is
- executed only once during system boot (so affects only boot time),
- or at module load time.
-
- If unsure, say N.
-
config TEST_SORT
tristate "Array-based sort test"
depends on DEBUG_KERNEL || m

@@ -2256,6 +2246,20 @@ config BITS_TEST

If unsure, say N.

+config MIN_HEAP_KUNIT_TEST
+ tristate "KUnit test for Min heap" if !KUNIT_ALL_TESTS
+ depends on KUNIT
+ default KUNIT_ALL_TESTS

+ help
+ Enable this to turn on min heap function tests. This test is
+ executed only once during system boot (so affects only boot time),
+ or at module load time.
+

+ For more information on KUnit and unit tests in general please refer
+ to the KUnit documentation in Documentation/dev-tools/kunit/.
+
+ If unsure, say N.
+

config TEST_UDELAY
tristate "udelay test driver"
help
diff --git a/lib/Makefile b/lib/Makefile

index d862d41fdc3d..03d12e672cf8 100644
--- a/lib/Makefile
+++ b/lib/Makefile
@@ -68,7 +68,6 @@ CFLAGS_test_ubsan.o += $(call cc-disable-warning, vla)

UBSAN_SANITIZE_test_ubsan.o := y
obj-$(CONFIG_TEST_KSTRTOX) += test-kstrtox.o
obj-$(CONFIG_TEST_LIST_SORT) += test_list_sort.o
-obj-$(CONFIG_TEST_MIN_HEAP) += test_min_heap.o
obj-$(CONFIG_TEST_LKM) += test_module.o
obj-$(CONFIG_TEST_VMALLOC) += test_vmalloc.o
obj-$(CONFIG_TEST_OVERFLOW) += test_overflow.o

@@ -343,3 +342,4 @@ obj-$(CONFIG_BITFIELD_KUNIT) += bitfield_kunit.o

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_MIN_HEAP_KUNIT_TEST) += min_heap_kunit.o

} else {
- if (last < values[0]) {
- pr_err("error: expected %d >= %d\n", last,
- values[0]);
- err++;
- }
+ KUNIT_EXPECT_FALSE_MSG(context,
+ last < values[0],
+ "expected %d >= %d\n",
+ last, values[0]);
}

base-commit: d2585f5164c298aaaed14c2c8d313cbe7bd5b253
--
2.26.2

[Ian Rogers]

Does KUNIT_EXPECT_GE not work? The error message suggests it should at least.

Thanks,
Ian

[Vitor Massaru Iha]

Hi Ian,

My bad, both expect work, I will send v3 now.

I'm working with other projects in parallel, and my context switch failed :(

[Vitor Massaru Iha]

This adds the conversion of the runtime tests of test_min_heap,
from `lib/test_min_heap.c` to KUnit tests.

Signed-off-by: Vitor Massaru Iha <vi...@massaru.org>
---

v2:
* change Kconfig entries to be more adherent to KUnit documentation,
min_heap test runs when enabling full test coverage (KUNIT_ALL_TESTS).
* make kconfig help more concise;
* fix KUNIT_TEST sufix;

v3:
* change KUNIT_EXPECT_FALSE_MSG for KUNIT_EXPECT_LE and KUNIT_EXPECT_GE
where they are applicable;
---
lib/Kconfig.debug | 24 +++--
lib/Makefile | 2 +-
lib/{test_min_heap.c => min_heap_kunit.c} | 111 +++++++++++-----------
3 files changed, 72 insertions(+), 65 deletions(-)
rename lib/{test_min_heap.c => min_heap_kunit.c} (62%)

diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug
index 4f09c6505a2e..0e10ef1176de 100644
--- a/lib/Kconfig.debug
+++ b/lib/Kconfig.debug
@@ -1915,16 +1915,6 @@ config TEST_LIST_SORT

If unsure, say N.

-config TEST_MIN_HEAP
- tristate "Min heap test"
- depends on DEBUG_KERNEL || m
- help
- Enable this to turn on min heap function tests. This test is
- executed only once during system boot (so affects only boot time),
- or at module load time.
-
- If unsure, say N.
-
config TEST_SORT
tristate "Array-based sort test"
depends on DEBUG_KERNEL || m

@@ -2256,6 +2246,20 @@ config BITS_TEST

If unsure, say N.

+config MIN_HEAP_KUNIT_TEST
+ tristate "KUnit test for Min heap" if !KUNIT_ALL_TESTS
+ depends on KUNIT
+ default KUNIT_ALL_TESTS

+ help
+ Enable this to turn on min heap function tests. This test is
+ executed only once during system boot (so affects only boot time),
+ or at module load time.
+

+ For more information on KUnit and unit tests in general please refer
+ to the KUnit documentation in Documentation/dev-tools/kunit/.
+
+ If unsure, say N.
+

config TEST_UDELAY
tristate "udelay test driver"
help
diff --git a/lib/Makefile b/lib/Makefile

index d862d41fdc3d..03d12e672cf8 100644
--- a/lib/Makefile
+++ b/lib/Makefile
@@ -68,7 +68,6 @@ CFLAGS_test_ubsan.o += $(call cc-disable-warning, vla)

UBSAN_SANITIZE_test_ubsan.o := y
obj-$(CONFIG_TEST_KSTRTOX) += test-kstrtox.o
obj-$(CONFIG_TEST_LIST_SORT) += test_list_sort.o
-obj-$(CONFIG_TEST_MIN_HEAP) += test_min_heap.o
obj-$(CONFIG_TEST_LKM) += test_module.o
obj-$(CONFIG_TEST_VMALLOC) += test_vmalloc.o
obj-$(CONFIG_TEST_OVERFLOW) += test_overflow.o

@@ -343,3 +342,4 @@ obj-$(CONFIG_BITFIELD_KUNIT) += bitfield_kunit.o

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_MIN_HEAP_KUNIT_TEST) += min_heap_kunit.o
diff --git a/lib/test_min_heap.c b/lib/min_heap_kunit.c
similarity index 62%

rename from lib/test_min_heap.c
rename to lib/min_heap_kunit.c

index d19c8080fd4d..97c5771f2b5e 100644

--- a/lib/test_min_heap.c
+++ b/lib/min_heap_kunit.c
@@ -7,9 +7,8 @@

#include <linux/log2.h>
#include <linux/min_heap.h>
-#include <linux/module.h>
-#include <linux/printk.h>
#include <linux/random.h>
+#include <kunit/test.h>

static __init bool less_than(const void *lhs, const void *rhs)
{

@@ -29,37 +28,28 @@ static __init void swap_ints(void *lhs, void *rhs)

*(int *)rhs = temp;
}

-static __init int pop_verify_heap(bool min_heap,
+static __init void pop_verify_heap(struct kunit *context,
+ bool min_heap,
struct min_heap *heap,
const struct min_heap_callbacks *funcs)
{
int *values = heap->data;
- int err = 0;
int last;

last = values[0];
min_heap_pop(heap, funcs);
while (heap->nr > 0) {
if (min_heap) {
- if (last > values[0]) {
- pr_err("error: expected %d <= %d\n", last,
- values[0]);
- err++;
- }

+ KUNIT_EXPECT_LE(context, last, values[0]);

} else {
- if (last < values[0]) {
- pr_err("error: expected %d >= %d\n", last,
- values[0]);
- err++;
- }

+ KUNIT_EXPECT_GE(context, last, values[0]);

}
last = values[0];
min_heap_pop(heap, funcs);
}
- return err;
}

-static __init int test_heapify_all(bool min_heap)
+static __init void test_heapify_all(struct kunit *context, bool min_heap)
{
int values[] = { 3, 1, 2, 4, 0x8000000, 0x7FFFFFF, 0,
-3, -1, -2, -4, 0x8000000, 0x7FFFFFF };

@@ -73,12 +63,11 @@ static __init int test_heapify_all(bool min_heap)

.less = min_heap ? less_than : greater_than,
.swp = swap_ints,
};
- int i, err;
+ int i;

/* Test with known set of values. */
min_heapify_all(&heap, &funcs);
- err = pop_verify_heap(min_heap, &heap, &funcs);
-
+ pop_verify_heap(context, min_heap, &heap, &funcs);

/* Test with randomly generated values. */
heap.nr = ARRAY_SIZE(values);

@@ -86,12 +75,10 @@ static __init int test_heapify_all(bool min_heap)

values[i] = get_random_int();

min_heapify_all(&heap, &funcs);
- err += pop_verify_heap(min_heap, &heap, &funcs);
-
- return err;
+ pop_verify_heap(context, min_heap, &heap, &funcs);
}

-static __init int test_heap_push(bool min_heap)
+static __init void test_heap_push(struct kunit *context, bool min_heap)
{
const int data[] = { 3, 1, 2, 4, 0x80000000, 0x7FFFFFFF, 0,
-3, -1, -2, -4, 0x80000000, 0x7FFFFFFF };

@@ -106,25 +93,22 @@ static __init int test_heap_push(bool min_heap)

.less = min_heap ? less_than : greater_than,
.swp = swap_ints,
};
- int i, temp, err;
+ int i, temp;

/* Test with known set of values copied from data. */
for (i = 0; i < ARRAY_SIZE(data); i++)
min_heap_push(&heap, &data[i], &funcs);
-
- err = pop_verify_heap(min_heap, &heap, &funcs);
+ pop_verify_heap(context, min_heap, &heap, &funcs);

/* Test with randomly generated values. */
while (heap.nr < heap.size) {
temp = get_random_int();
min_heap_push(&heap, &temp, &funcs);
}
- err += pop_verify_heap(min_heap, &heap, &funcs);
-
- return err;
+ pop_verify_heap(context, min_heap, &heap, &funcs);
}

-static __init int test_heap_pop_push(bool min_heap)
+static __init void test_heap_pop_push(struct kunit *context, bool min_heap)
{
const int data[] = { 3, 1, 2, 4, 0x80000000, 0x7FFFFFFF, 0,
-3, -1, -2, -4, 0x80000000, 0x7FFFFFFF };

@@ -139,7 +123,7 @@ static __init int test_heap_pop_push(bool min_heap)

.less = min_heap ? less_than : greater_than,
.swp = swap_ints,
};
- int i, temp, err;
+ int i, temp;

/* Fill values with data to pop and replace. */
temp = min_heap ? 0x80000000 : 0x7FFFFFFF;

@@ -149,8 +133,7 @@ static __init int test_heap_pop_push(bool min_heap)

/* Test with known set of values copied from data. */
for (i = 0; i < ARRAY_SIZE(data); i++)
min_heap_pop_push(&heap, &data[i], &funcs);
-
- err = pop_verify_heap(min_heap, &heap, &funcs);
+ pop_verify_heap(context, min_heap, &heap, &funcs);

heap.nr = 0;
for (i = 0; i < ARRAY_SIZE(data); i++)

@@ -161,34 +144,54 @@ static __init int test_heap_pop_push(bool min_heap)

base-commit: d2585f5164c298aaaed14c2c8d313cbe7bd5b253
--
2.26.2

[Ian Rogers]

On Thu, Oct 15, 2020 at 10:02 AM Vitor Massaru Iha <vi...@massaru.org> wrote:
>
> This adds the conversion of the runtime tests of test_min_heap,
> from `lib/test_min_heap.c` to KUnit tests.
>
> Signed-off-by: Vitor Massaru Iha <vi...@massaru.org>

Acked-by: Ian Rogers <iro...@google.com>

Thanks,
Ian