[PATCH libinput 5/5] test: add tests for lid switch

Peter Hutterer peter.hutterer at who-t.net
Thu Jan 5 09:49:08 UTC 2017


On Thu, Jan 05, 2017 at 05:11:29PM +1100, James Ye wrote:
> ---
>  test/Makefile.am                |   4 +-
>  test/lid.c                      | 228 ++++++++++++++++++++++++++++++++++++++++
>  test/litest-device-lid-switch.c |  58 ++++++++++
>  test/litest.c                   |  28 +++++
>  test/litest.h                   |  10 ++
>  5 files changed, 327 insertions(+), 1 deletion(-)
>  create mode 100644 test/lid.c
>  create mode 100644 test/litest-device-lid-switch.c
> 
> diff --git a/test/Makefile.am b/test/Makefile.am
> index 983264c..94978b9 100644
> --- a/test/Makefile.am
> +++ b/test/Makefile.am
> @@ -32,6 +32,7 @@ liblitest_la_SOURCES = \
>  	litest-device-keyboard.c \
>  	litest-device-keyboard-all-codes.c \
>  	litest-device-keyboard-razer-blackwidow.c \
> +	litest-device-lid-switch.c \
>  	litest-device-logitech-trackball.c \
>  	litest-device-nexus4-touch-screen.c \
>  	litest-device-magic-trackpad.c \
> @@ -114,7 +115,8 @@ libinput_test_suite_runner_SOURCES = udev.c \
>  				     misc.c \
>  				     keyboard.c \
>  				     device.c \
> -				     gestures.c
> +				     gestures.c \
> +				     lid.c
>  
>  libinput_test_suite_runner_CFLAGS = $(AM_CFLAGS) -DLIBINPUT_LT_VERSION="\"$(LIBINPUT_LT_VERSION)\""
>  libinput_test_suite_runner_LDADD = $(TEST_LIBS)
> diff --git a/test/lid.c b/test/lid.c
> new file mode 100644
> index 0000000..459c7d7
> --- /dev/null
> +++ b/test/lid.c
> @@ -0,0 +1,228 @@
> +/*
> + * Copyright © 2017 James Ye <jye836 at gmail.com>
> + *
> + * Permission is hereby granted, free of charge, to any person obtaining a
> + * copy of this software and associated documentation files (the "Software"),
> + * to deal in the Software without restriction, including without limitation
> + * the rights to use, copy, modify, merge, publish, distribute, sublicense,
> + * and/or sell copies of the Software, and to permit persons to whom the
> + * Software is furnished to do so, subject to the following conditions:
> + *
> + * The above copyright notice and this permission notice (including the next
> + * paragraph) shall be included in all copies or substantial portions of the
> + * Software.
> + *
> + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
> + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
> + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
> + * DEALINGS IN THE SOFTWARE.
> + */
> +
> +#include <config.h>
> +
> +#include <check.h>
> +#include <libinput.h>
> +
> +#include "libinput-util.h"
> +#include "litest.h"
> +
> +START_TEST(lid_switch)
> +{
> +	struct litest_device *sw = litest_current_device();
> +	struct libinput *li = sw->libinput;
> +	struct libinput_event *event;
> +
> +	litest_drain_events(li);
> +
> +	/* lid closed */
> +	litest_lid_action(sw, LIBINPUT_SWITCH_STATE_ON);
> +	libinput_dispatch(li);
> +
> +	event = libinput_get_event(li);
> +	litest_is_switch_event(event, LIBINPUT_SWITCH_STATE_ON);

pls check that the switch is correctly set to the LIBINPUT_SWITCH_LID

> +	libinput_event_destroy(event);
> +
> +	/* lid opened */
> +	litest_lid_action(sw, LIBINPUT_SWITCH_STATE_OFF);
> +	libinput_dispatch(li);
> +
> +	event = libinput_get_event(li);
> +	litest_is_switch_event(event, LIBINPUT_SWITCH_STATE_OFF);
> +	libinput_event_destroy(event);

same here.

and add a trailing litest_assert_empty_queue() so we check for accidental
other events.

> +}
> +END_TEST
> +
> +static inline struct litest_device *
> +lid_init_paired_touchpad(struct libinput *li)
> +{
> +	enum litest_device_type which = LITEST_SYNAPTICS_I2C;
> +
> +	return litest_add_device(li, which);
> +}
> +
> +START_TEST(lid_disable_touchpad)
> +{
> +	struct litest_device *sw = litest_current_device();
> +	struct litest_device *touchpad;
> +	struct libinput *li = sw->libinput;
> +
> +	touchpad = lid_init_paired_touchpad(li);
> +	litest_disable_tap(touchpad->libinput_device);
> +	litest_drain_events(li);
> +
> +	/* lid is down - no events */
> +	litest_lid_action(sw, LIBINPUT_SWITCH_STATE_ON);
> +	litest_assert_only_typed_events(li, LIBINPUT_EVENT_SWITCH_TOGGLE);
> +
> +	litest_touch_down(touchpad, 0, 50, 50);
> +	litest_touch_move_to(touchpad, 0, 50, 50, 70, 50, 10, 1);
> +	litest_touch_up(touchpad, 0);
> +	litest_assert_empty_queue(li);
> +
> +	/* lid is up - motion events */
> +	litest_lid_action(sw, LIBINPUT_SWITCH_STATE_OFF);
> +	litest_assert_only_typed_events(li, LIBINPUT_EVENT_SWITCH_TOGGLE);
> +
> +	litest_touch_down(touchpad, 0, 50, 50);
> +	litest_touch_move_to(touchpad, 0, 50, 50, 70, 50, 10, 1);
> +	litest_touch_up(touchpad, 0);
> +	litest_assert_only_typed_events(li, LIBINPUT_EVENT_POINTER_MOTION);
> +
> +	litest_delete_device(touchpad);
> +}
> +END_TEST
> +
> +START_TEST(lid_disable_touchpad_during_touch)
> +{
> +	struct litest_device *sw = litest_current_device();
> +	struct litest_device *touchpad;
> +	struct libinput *li = sw->libinput;
> +
> +	touchpad = lid_init_paired_touchpad(li);
> +	litest_disable_tap(touchpad->libinput_device);
> +	litest_drain_events(li);
> +
> +	litest_touch_down(touchpad, 0, 50, 50);
> +	litest_touch_move_to(touchpad, 0, 50, 50, 70, 50, 5, 1);
> +	litest_assert_only_typed_events(li, LIBINPUT_EVENT_POINTER_MOTION);
> +
> +	litest_lid_action(sw, LIBINPUT_SWITCH_STATE_ON);
> +	litest_assert_only_typed_events(li, LIBINPUT_EVENT_SWITCH_TOGGLE);
> +
> +	litest_touch_move_to(touchpad, 0, 70, 50, 50, 50, 5, 1);
> +	litest_touch_up(touchpad, 0);
> +	litest_assert_empty_queue(li);
> +
> +	litest_delete_device(touchpad);
> +}
> +END_TEST
> +
> +START_TEST(lid_disable_touchpad_edge_scroll)
> +{
> +	struct litest_device *sw = litest_current_device();
> +	struct litest_device *touchpad;
> +	struct libinput *li = sw->libinput;
> +
> +	touchpad = lid_init_paired_touchpad(li);
> +	litest_enable_edge_scroll(touchpad);
> +
> +	litest_drain_events(li);
> +
> +	litest_lid_action(sw, LIBINPUT_SWITCH_STATE_ON);
> +	litest_assert_only_typed_events(li, LIBINPUT_EVENT_SWITCH_TOGGLE);
> +
> +	litest_touch_down(touchpad, 0, 99, 20);
> +	libinput_dispatch(li);
> +	litest_timeout_edgescroll();
> +	libinput_dispatch(li);
> +	litest_assert_empty_queue(li);
> +
> +	litest_touch_move_to(touchpad, 0, 99, 20, 99, 80, 60, 10);
> +	libinput_dispatch(li);
> +	litest_assert_empty_queue(li);
> +
> +	litest_touch_move_to(touchpad, 0, 99, 80, 99, 20, 60, 10);
> +	litest_touch_up(touchpad, 0);
> +	libinput_dispatch(li);
> +	litest_assert_empty_queue(li);
> +
> +	litest_delete_device(touchpad);
> +}
> +END_TEST
> +
> +START_TEST(lid_disable_touchpad_edge_scroll_interrupt)
> +{
> +	struct litest_device *sw = litest_current_device();
> +	struct litest_device *touchpad;
> +	struct libinput *li = sw->libinput;
> +	struct libinput_event_pointer *stop_event;
> +
> +	touchpad = lid_init_paired_touchpad(li);
> +	litest_enable_edge_scroll(touchpad);
> +
> +	litest_drain_events(li);
> +
> +	litest_touch_down(touchpad, 0, 99, 20);
> +	libinput_dispatch(li);
> +	litest_timeout_edgescroll();
> +	litest_touch_move_to(touchpad, 0, 99, 20, 99, 30, 10, 10);
> +	libinput_dispatch(li);
> +	litest_assert_only_typed_events(li, LIBINPUT_EVENT_POINTER_AXIS);
> +
> +	litest_lid_action(sw, LIBINPUT_SWITCH_STATE_ON);
> +
> +	/* scroll stop event */
> +	litest_wait_for_event(li);

do we need to wait here?  this should be immedidate after a
libinput_dispatch(), no?

> +	stop_event = litest_is_axis_event(libinput_get_event(li),
> +					  LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL,
> +					  LIBINPUT_POINTER_AXIS_SOURCE_FINGER);
> +	libinput_event_destroy(libinput_event_pointer_get_base_event(stop_event));
> +
> +	litest_assert_only_typed_events(li, LIBINPUT_EVENT_SWITCH_TOGGLE);

have a generic libinput_event here and do

  event = libinput_get_event(li);
  litest_is_axis_event(event, ...);
  libinput_event_destroy();

  event = libinput_get_event(li);
  litest_is_switch_event(event);
  libinput_event_destroy();

that's a tigher test than the above

> +
> +	litest_delete_device(touchpad);
> +}
> +END_TEST
> +
> +START_TEST(lid_disable_touchpad_already_open)
> +{
> +	struct litest_device *sw = litest_current_device();
> +	struct litest_device *touchpad;
> +	struct libinput *li = sw->libinput;
> +
> +	touchpad = lid_init_paired_touchpad(li);
> +	litest_disable_tap(touchpad->libinput_device);
> +	litest_drain_events(li);
> +
> +	/* default: lid is up - motion events */
> +	litest_touch_down(touchpad, 0, 50, 50);
> +	litest_touch_move_to(touchpad, 0, 50, 50, 70, 50, 10, 1);
> +	litest_touch_up(touchpad, 0);
> +	litest_assert_only_typed_events(li, LIBINPUT_EVENT_POINTER_MOTION);
> +
> +	/* open lid - motion events */
> +	litest_lid_action(sw, LIBINPUT_SWITCH_STATE_OFF);
> +	libinput_dispatch(li);
> +	litest_drain_events(li);

this would paper over a duplicate switch event, a
litest_assert_empty_queue() is better here.

> +
> +	litest_touch_down(touchpad, 0, 50, 50);
> +	litest_touch_move_to(touchpad, 0, 50, 50, 70, 50, 10, 1);
> +	litest_touch_up(touchpad, 0);
> +	litest_assert_only_typed_events(li, LIBINPUT_EVENT_POINTER_MOTION);
> +
> +	litest_delete_device(touchpad);
> +}
> +END_TEST

looking at this test: we need tests to make sure we don't sent duplicate
switch down/ups when we re-set an already set state. That'll be mostly a
blank test anyway since the kernel will filter any duplicate events out, but
better safe than sorry.

hmm, and come to think of it now 3/5 doesn't check for the initial switch
state, so if libinput is started with a switch logically on, we don't convey
that. In that case I think we might even send a duplicate "switch off"
event when that switch goes off. I'm not 100% sure yet on how to handle
this [but I'll add this to the 2/5 patch review comments]

Also, please add the required short test in test/misc.c to make sure
conversion between the event types is correct.

Cheers,
   Peter

> +
> +void
> +litest_setup_tests_lid(void)
> +{
> +	litest_add("lid:switch", lid_switch, LITEST_SWITCH, LITEST_ANY);
> +	litest_add("lid:disable_touchpad", lid_disable_touchpad, LITEST_SWITCH, LITEST_ANY);
> +	litest_add("lid:disable_touchpad", lid_disable_touchpad_during_touch, LITEST_SWITCH, LITEST_ANY);
> +	litest_add("lid:disable_touchpad", lid_disable_touchpad_edge_scroll, LITEST_SWITCH, LITEST_ANY);
> +	litest_add("lid:disable_touchpad", lid_disable_touchpad_edge_scroll_interrupt, LITEST_SWITCH, LITEST_ANY);
> +	litest_add("lid:disable_touchpad", lid_disable_touchpad_already_open, LITEST_SWITCH, LITEST_ANY);
> +}
> diff --git a/test/litest-device-lid-switch.c b/test/litest-device-lid-switch.c
> new file mode 100644
> index 0000000..85939c2
> --- /dev/null
> +++ b/test/litest-device-lid-switch.c
> @@ -0,0 +1,58 @@
> +/*
> + * Copyright © 2017 James Ye <jye836 at gmail.com>
> + *
> + * Permission is hereby granted, free of charge, to any person obtaining a
> + * copy of this software and associated documentation files (the "Software"),
> + * to deal in the Software without restriction, including without limitation
> + * the rights to use, copy, modify, merge, publish, distribute, sublicense,
> + * and/or sell copies of the Software, and to permit persons to whom the
> + * Software is furnished to do so, subject to the following conditions:
> + *
> + * The above copyright notice and this permission notice (including the next
> + * paragraph) shall be included in all copies or substantial portions of the
> + * Software.
> + *
> + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
> + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
> + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
> + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
> + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
> + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
> + * DEALINGS IN THE SOFTWARE.
> + */
> +
> +#include "config.h"
> +
> +#include "litest.h"
> +#include "litest-int.h"
> +
> +static void
> +litest_lid_switch_setup(void)
> +{
> +	struct litest_device *d = litest_create_device(LITEST_LID_SWITCH);
> +	litest_set_current_device(d);
> +}
> +
> +static struct input_id input_id = {
> +	.bustype = 0x19,
> +	.vendor = 0x0,
> +	.product = 0x5,
> +};
> +
> +static int events[] = {
> +	EV_SW, SW_LID,
> +	-1, -1,
> +};
> +
> +struct litest_test_device litest_lid_switch_device = {
> +	.type = LITEST_LID_SWITCH,
> +	.features = LITEST_SWITCH,
> +	.shortname = "lid switch",
> +	.setup = litest_lid_switch_setup,
> +	.interface = NULL,
> +
> +	.name = "Lid Switch",
> +	.id = &input_id,
> +	.events = events,
> +	.absinfo = NULL,
> +};
> diff --git a/test/litest.c b/test/litest.c
> index 98ea0ec..6b63b23 100644
> --- a/test/litest.c
> +++ b/test/litest.c
> @@ -406,6 +406,7 @@ extern struct litest_test_device litest_mouse_wheel_click_count_device;
>  extern struct litest_test_device litest_calibrated_touchscreen_device;
>  extern struct litest_test_device litest_acer_hawaii_keyboard_device;
>  extern struct litest_test_device litest_acer_hawaii_touchpad_device;
> +extern struct litest_test_device litest_lid_switch_device;
>  
>  struct litest_test_device* devices[] = {
>  	&litest_synaptics_clickpad_device,
> @@ -466,6 +467,7 @@ struct litest_test_device* devices[] = {
>  	&litest_calibrated_touchscreen_device,
>  	&litest_acer_hawaii_keyboard_device,
>  	&litest_acer_hawaii_touchpad_device,
> +	&litest_lid_switch_device,
>  	NULL,
>  };
>  
> @@ -1883,6 +1885,14 @@ litest_keyboard_key(struct litest_device *d, unsigned int key, bool is_press)
>  	litest_button_click(d, key, is_press);
>  }
>  
> +void
> +litest_lid_action(struct litest_device *dev,
> +		  enum libinput_switch_state state)
> +{
> +	litest_event(dev, EV_SW, SW_LID, state);
> +	litest_event(dev, EV_SYN, SYN_REPORT, 0);
> +}
> +
>  static int
>  litest_scale_axis(const struct litest_device *d,
>  		  unsigned int axis,
> @@ -2789,6 +2799,23 @@ litest_is_pad_strip_event(struct libinput_event *event,
>  	return p;
>  }
>  
> +struct libinput_event_switch *
> +litest_is_switch_event(struct libinput_event *event,
> +		       enum libinput_switch_state state)
> +{
> +	struct libinput_event_switch *swev;
> +	enum libinput_event_type type = LIBINPUT_EVENT_SWITCH_TOGGLE;
> +
> +	litest_assert_notnull(event);
> +	litest_assert_event_type(event, type);
> +	swev = libinput_event_get_switch_event(event);
> +
> +	litest_assert_int_eq(libinput_event_switch_get_switch_state(swev),
> +			     state);
> +
> +	return swev;
> +}
> +
>  void
>  litest_assert_pad_button_event(struct libinput *li,
>  			       unsigned int button,
> @@ -3293,6 +3320,7 @@ main(int argc, char **argv)
>  	litest_setup_tests_keyboard();
>  	litest_setup_tests_device();
>  	litest_setup_tests_gestures();
> +	litest_setup_tests_lid();
>  
>  	if (mode == LITEST_MODE_LIST) {
>  		litest_list_tests(&all_tests);
> diff --git a/test/litest.h b/test/litest.h
> index a707509..cad4f5b 100644
> --- a/test/litest.h
> +++ b/test/litest.h
> @@ -49,6 +49,7 @@ extern void litest_setup_tests_misc(void);
>  extern void litest_setup_tests_keyboard(void);
>  extern void litest_setup_tests_device(void);
>  extern void litest_setup_tests_gestures(void);
> +extern void litest_setup_tests_lid(void);
>  
>  void
>  litest_fail_condition(const char *file,
> @@ -226,6 +227,7 @@ enum litest_device_type {
>  	LITEST_CALIBRATED_TOUCHSCREEN,
>  	LITEST_ACER_HAWAII_KEYBOARD,
>  	LITEST_ACER_HAWAII_TOUCHPAD,
> +	LITEST_LID_SWITCH,
>  };
>  
>  enum litest_device_feature {
> @@ -256,6 +258,7 @@ enum litest_device_feature {
>  	LITEST_RING = 1 << 22,
>  	LITEST_STRIP = 1 << 23,
>  	LITEST_TRACKBALL = 1 << 24,
> +	LITEST_SWITCH = 1 << 25,
>  };
>  
>  struct litest_device {
> @@ -522,6 +525,9 @@ litest_keyboard_key(struct litest_device *d,
>  		    unsigned int key,
>  		    bool is_press);
>  
> +void litest_lid_action(struct litest_device *d,
> +		       enum libinput_switch_state state);
> +
>  void
>  litest_wait_for_event(struct libinput *li);
>  
> @@ -585,6 +591,10 @@ litest_is_pad_strip_event(struct libinput_event *event,
>  			  unsigned int number,
>  			  enum libinput_tablet_pad_strip_axis_source source);
>  
> +struct libinput_event_switch *
> +litest_is_switch_event(struct libinput_event *event,
> +		       enum libinput_switch_state state);
> +
>  void
>  litest_assert_button_event(struct libinput *li,
>  			   unsigned int button,
> -- 
> 2.9.3
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/wayland-devel
> 


More information about the wayland-devel mailing list