Commit 08809e48 authored by José Expósito's avatar José Expósito Committed by Jiri Kosina
Browse files

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  [1]
Link: https://www.kernel.org/doc/html/latest/dev-tools/kunit/style.html

  [2]
Acked-by: default avatarDaniel Latypov <dlatypov@google.com>
Signed-off-by: default avatarJosé Expósito <jose.exposito89@gmail.com>
Signed-off-by: default avatarJiri Kosina <jkosina@suse.cz>
parent 609174ed

drivers/hid/Kconfig

+1 −1
Original line number Diff line number Diff line
@@ -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

drivers/hid/Makefile

+2 −1
Original line number Diff line number Diff line
@@ -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/

drivers/hid/hid-uclogic-rdesc-test.c

+11 −11
Original line number Diff line number Diff line
@@ -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,

};