HID: uclogic: KUnit best practices and naming conventions

The KUnit documentation [1] suggests allowing build tests as a module.

In addition, it is recommended [2] to use snake case names for
kunit_suite and test cases.

Change the Kconfig entry from bool to tristate and stick to the naming
conventions to avoid style issues with future tests.

Link: https://docs.kernel.org/dev-tools/kunit/style.html#test-kconfig-entries
Link: https://www.kernel.org/doc/html/latest/dev-tools/kunit/style.html
Acked-by: Daniel Latypov <dlatypov@google.com>
Signed-off-by: José Expósito <jose.exposito89@gmail.com>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>

diff --git a/drivers/hid/Kconfig b/drivers/hid/Kconfig
index 6ce92830b5d1f9c90444401f0167f64b92bde816..36a17958493f7f99b7669cc44d2766b00a2c9d68 100644 (file)
--- a/drivers/hid/Kconfig
+++ b/drivers/hid/Kconfig
@@ -1307,7 +1307,7 @@ config HID_MCP2221
        will be called hid-mcp2221.ko.
 
 config HID_KUNIT_TEST
-       bool "KUnit tests for HID" if !KUNIT_ALL_TESTS
+       tristate "KUnit tests for HID" if !KUNIT_ALL_TESTS
        depends on KUNIT=y
        depends on HID_UCLOGIC
        default KUNIT_ALL_TESTS

diff --git a/drivers/hid/Makefile b/drivers/hid/Makefile
index b0bef80981394e616ee7f99da0565de32b9e0850..82d8fd97d96cdcff7060c11a74c31371c581ea67 100644 (file)
--- a/drivers/hid/Makefile
+++ b/drivers/hid/Makefile
@@ -144,8 +144,9 @@ obj-$(CONFIG_HID_WIIMOTE)   += hid-wiimote.o
 obj-$(CONFIG_HID_SENSOR_HUB)   += hid-sensor-hub.o
 obj-$(CONFIG_HID_SENSOR_CUSTOM_SENSOR) += hid-sensor-custom.o
 
-obj-$(CONFIG_HID_KUNIT_TEST)   += hid-uclogic-rdesc.o \
+hid-uclogic-test-objs          := hid-uclogic-rdesc.o \
                                   hid-uclogic-rdesc-test.o
+obj-$(CONFIG_HID_KUNIT_TEST)   += hid-uclogic-test.o
 
 obj-$(CONFIG_USB_HID)          += usbhid/
 obj-$(CONFIG_USB_MOUSE)                += usbhid/

diff --git a/drivers/hid/hid-uclogic-rdesc-test.c b/drivers/hid/hid-uclogic-rdesc-test.c
index ebebffef5f8aecc553d33a6bb151ddec664dc500..3971a0854c3e1d4d997ea83c3e224ab3826f8739 100644 (file)
--- a/drivers/hid/hid-uclogic-rdesc-test.c
+++ b/drivers/hid/hid-uclogic-rdesc-test.c
@@ -97,7 +97,7 @@ static const __u8 template_params_none[] = {
 
 static struct uclogic_template_case uclogic_template_cases[] = {
        {
-               .name = "Empty template",
+               .name = "empty_template",
                .template = template_empty,
                .template_size = sizeof(template_empty),
                .param_list = params_pen_all,
@@ -105,7 +105,7 @@ static struct uclogic_template_case uclogic_template_cases[] = {
                .expected = template_empty,
        },
        {
-               .name = "Template smaller than the placeholder",
+               .name = "template_smaller_than_the_placeholder",
                .template = template_small,
                .template_size = sizeof(template_small),
                .param_list = params_pen_all,
@@ -113,7 +113,7 @@ static struct uclogic_template_case uclogic_template_cases[] = {
                .expected = template_small,
        },
        {
-               .name = "No placeholder",
+               .name = "no_placeholder",
                .template = template_no_ph,
                .template_size = sizeof(template_no_ph),
                .param_list = params_pen_all,
@@ -121,7 +121,7 @@ static struct uclogic_template_case uclogic_template_cases[] = {
                .expected = template_no_ph,
        },
        {
-               .name = "Pen placeholder at the end, without ID",
+               .name = "pen_placeholder_at_the_end_without_id",
                .template = template_pen_ph_end,
                .template_size = sizeof(template_pen_ph_end),
                .param_list = params_pen_all,
@@ -129,7 +129,7 @@ static struct uclogic_template_case uclogic_template_cases[] = {
                .expected = template_pen_ph_end,
        },
        {
-               .name = "Frame button placeholder at the end, without ID",
+               .name = "frame_button_placeholder_at_the_end_without_id",
                .template = template_btn_ph_end,
                .template_size = sizeof(template_btn_ph_end),
                .param_list = params_frame_all,
@@ -137,7 +137,7 @@ static struct uclogic_template_case uclogic_template_cases[] = {
                .expected = template_btn_ph_end,
        },
        {
-               .name = "All params present in the pen template",
+               .name = "all_params_present_in_the_pen_template",
                .template = template_pen_all_params,
                .template_size = sizeof(template_pen_all_params),
                .param_list = params_pen_all,
@@ -145,7 +145,7 @@ static struct uclogic_template_case uclogic_template_cases[] = {
                .expected = expected_pen_all_params,
        },
        {
-               .name = "All params present in the frame template",
+               .name = "all_params_present_in_the_frame_template",
                .template = template_frame_all_params,
                .template_size = sizeof(template_frame_all_params),
                .param_list = params_frame_all,
@@ -153,7 +153,7 @@ static struct uclogic_template_case uclogic_template_cases[] = {
                .expected = expected_frame_all_params,
        },
        {
-               .name = "Some params present in the pen template (complete param list)",
+               .name = "some_params_present_in_the_pen_template_with_complete_param_list",
                .template = template_pen_some_params,
                .template_size = sizeof(template_pen_some_params),
                .param_list = params_pen_all,
@@ -161,7 +161,7 @@ static struct uclogic_template_case uclogic_template_cases[] = {
                .expected = expected_pen_some_params,
        },
        {
-               .name = "Some params present in the pen template (incomplete param list)",
+               .name = "some_params_present_in_the_pen_template_with_incomplete_param_list",
                .template = template_pen_some_params,
                .template_size = sizeof(template_pen_some_params),
                .param_list = params_pen_some,
@@ -169,7 +169,7 @@ static struct uclogic_template_case uclogic_template_cases[] = {
                .expected = expected_pen_some_params,
        },
        {
-               .name = "No params present in the template",
+               .name = "no_params_present_in_the_template",
                .template = template_params_none,
                .template_size = sizeof(template_params_none),
                .param_list = params_pen_some,
@@ -208,7 +208,7 @@ static struct kunit_case hid_uclogic_rdesc_test_cases[] = {
 };
 
 static struct kunit_suite hid_uclogic_rdesc_test_suite = {
-       .name = "hid-uclogic-rdesc-test",
+       .name = "hid_uclogic_rdesc_test",
        .test_cases = hid_uclogic_rdesc_test_cases,
 };