libinput/test/test-keyboard.c

/*
 * Copyright © 2014 Jonas Ådahl <jadahl@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 <stdio.h>

#include "libinput-util.h"
#include "litest.h"

START_TEST(keyboard_seat_key_count)
{
	struct litest_device *devices[4];
	const int num_devices = ARRAY_LENGTH(devices);
	struct libinput_event *ev;
	struct libinput_event_keyboard *kev;
	int i;
	int seat_key_count = 0;
	int expected_key_button_count = 0;
	char device_name[255];

	_litest_context_destroy_ struct libinput *libinput = litest_create_context();
	for (i = 0; i < num_devices; ++i) {
		sprintf(device_name, "litest Generic keyboard (%d)", i);
		devices[i] = litest_add_device_with_overrides(libinput,
							      LITEST_KEYBOARD,
							      device_name,
							      NULL,
							      NULL,
							      NULL);
	}

	litest_drain_events(libinput);

	for (i = 0; i < num_devices; ++i)
		litest_keyboard_key(devices[i], KEY_A, true);

	litest_dispatch(libinput);
	while ((ev = libinput_get_event(libinput))) {
		kev = litest_is_keyboard_event(ev, KEY_A, LIBINPUT_KEY_STATE_PRESSED);

		++expected_key_button_count;
		seat_key_count = libinput_event_keyboard_get_seat_key_count(kev);
		litest_assert_int_eq(expected_key_button_count, seat_key_count);

		libinput_event_destroy(ev);
		litest_dispatch(libinput);
	}

	litest_assert_int_eq(seat_key_count, num_devices);

	for (i = 0; i < num_devices; ++i)
		litest_keyboard_key(devices[i], KEY_A, false);

	litest_dispatch(libinput);
	while ((ev = libinput_get_event(libinput))) {
		kev = libinput_event_get_keyboard_event(ev);
		litest_assert_notnull(kev);
		litest_assert_int_eq(libinput_event_keyboard_get_key(kev),
				     (unsigned int)KEY_A);
		litest_assert_enum_eq(libinput_event_keyboard_get_key_state(kev),
				      LIBINPUT_KEY_STATE_RELEASED);

		--expected_key_button_count;
		seat_key_count = libinput_event_keyboard_get_seat_key_count(kev);
		litest_assert_int_eq(expected_key_button_count, seat_key_count);

		libinput_event_destroy(ev);
		litest_dispatch(libinput);
	}

	litest_assert_int_eq(seat_key_count, 0);

	for (i = 0; i < num_devices; ++i)
		litest_device_destroy(devices[i]);
}
END_TEST

START_TEST(keyboard_ignore_no_pressed_release)
{
	struct litest_device *dev;
	struct libinput_event *event;
	struct libinput_event_keyboard *kevent;
	int events[] = {
		EV_KEY,
		KEY_A,
		-1,
		-1,
	};
	enum libinput_key_state expected_states[] = {
		LIBINPUT_KEY_STATE_PRESSED,
		LIBINPUT_KEY_STATE_RELEASED,
	};

	/* We can't send pressed -> released -> pressed events using uinput
	 * as such non-symmetric events are dropped. Work-around this by first
	 * adding the test device to the tested context after having sent an
	 * initial pressed event. */
	_litest_context_destroy_ struct libinput *unused_libinput =
		litest_create_context();
	dev = litest_add_device_with_overrides(unused_libinput,
					       LITEST_KEYBOARD,
					       "Generic keyboard",
					       NULL,
					       NULL,
					       events);

	litest_keyboard_key(dev, KEY_A, true);
	litest_drain_events(unused_libinput);

	_litest_context_destroy_ struct libinput *libinput = litest_create_context();
	libinput_path_add_device(libinput, libevdev_uinput_get_devnode(dev->uinput));
	litest_drain_events(libinput);

	litest_keyboard_key(dev, KEY_A, false);
	litest_keyboard_key(dev, KEY_A, true);
	litest_keyboard_key(dev, KEY_A, false);

	litest_dispatch(libinput);

	ARRAY_FOR_EACH(expected_states, state) {
		event = libinput_get_event(libinput);
		litest_assert_notnull(event);
		litest_assert_event_type(event, LIBINPUT_EVENT_KEYBOARD_KEY);
		kevent = libinput_event_get_keyboard_event(event);
		litest_assert_int_eq(libinput_event_keyboard_get_key(kevent),
				     (unsigned int)KEY_A);
		litest_assert_int_eq(libinput_event_keyboard_get_key_state(kevent),
				     *state);
		libinput_event_destroy(event);
		litest_dispatch(libinput);
	}

	litest_assert_empty_queue(libinput);
	litest_device_destroy(dev);
}
END_TEST

START_TEST(keyboard_key_auto_release)
{
	struct litest_device *dev;
	struct libinput_event *event;
	enum libinput_event_type type;
	struct libinput_event_keyboard *kevent;
	struct {
		int code;
		int released;
	} keys[] = {
		{
			.code = KEY_A,
		},
		{
			.code = KEY_S,
		},
		{
			.code = KEY_D,
		},
		{
			.code = KEY_G,
		},
		{
			.code = KEY_Z,
		},
		{
			.code = KEY_DELETE,
		},
		{
			.code = KEY_F24,
		},
	};
	int events[2 * (ARRAY_LENGTH(keys) + 1)];
	unsigned i;
	int key;
	int valid_code;

	/* Enable all tested keys on the device */
	i = 0;
	while (i < 2 * ARRAY_LENGTH(keys)) {
		key = keys[i / 2].code;
		events[i++] = EV_KEY;
		events[i++] = key;
	}
	events[i++] = -1;
	events[i++] = -1;

	_litest_context_destroy_ struct libinput *libinput = litest_create_context();
	dev = litest_add_device_with_overrides(libinput,
					       LITEST_KEYBOARD,
					       "Generic keyboard",
					       NULL,
					       NULL,
					       events);

	litest_drain_events(libinput);

	/* Send pressed events, without releasing */
	for (i = 0; i < ARRAY_LENGTH(keys); ++i) {
		key = keys[i].code;
		litest_event(dev, EV_KEY, key, 1);
		litest_event(dev, EV_SYN, SYN_REPORT, 0);

		litest_dispatch(libinput);

		event = libinput_get_event(libinput);
		litest_is_keyboard_event(event, key, LIBINPUT_KEY_STATE_PRESSED);
		libinput_event_destroy(event);
	}

	litest_drain_events(libinput);

	/* "Disconnect" device */
	litest_device_destroy(dev);

	/* Mark all released keys until device is removed */
	while (1) {
		event = libinput_get_event(libinput);
		litest_assert_notnull(event);
		type = libinput_event_get_type(event);

		if (type == LIBINPUT_EVENT_DEVICE_REMOVED) {
			libinput_event_destroy(event);
			break;
		}

		litest_assert_event_type(event, LIBINPUT_EVENT_KEYBOARD_KEY);
		kevent = libinput_event_get_keyboard_event(event);
		litest_assert_enum_eq(libinput_event_keyboard_get_key_state(kevent),
				      LIBINPUT_KEY_STATE_RELEASED);
		key = libinput_event_keyboard_get_key(kevent);

		valid_code = 0;
		for (i = 0; i < ARRAY_LENGTH(keys); ++i) {
			if (keys[i].code == key) {
				litest_assert_int_eq(keys[i].released, 0);
				keys[i].released = 1;
				valid_code = 1;
			}
		}
		litest_assert_int_eq(valid_code, 1);
		libinput_event_destroy(event);
	}

	/* Check that all pressed keys has been released. */
	for (i = 0; i < ARRAY_LENGTH(keys); ++i) {
		litest_assert_int_eq(keys[i].released, 1);
	}
}
END_TEST

START_TEST(keyboard_has_key)
{
	struct litest_device *dev = litest_current_device();
	struct libinput_device *device = dev->libinput_device;
	unsigned int code;
	int evdev_has, libinput_has;

	litest_assert(
		libinput_device_has_capability(device, LIBINPUT_DEVICE_CAP_KEYBOARD));

	for (code = 0; code < KEY_CNT; code++) {
		evdev_has = libevdev_has_event_code(dev->evdev, EV_KEY, code);
		libinput_has = libinput_device_keyboard_has_key(device, code);
		litest_assert_int_eq(evdev_has, libinput_has);
	}
}
END_TEST

START_TEST(keyboard_keys_bad_device)
{
	struct litest_device *dev = litest_current_device();
	struct libinput_device *device = dev->libinput_device;
	unsigned int code;
	int has_key;

	if (libinput_device_has_capability(device, LIBINPUT_DEVICE_CAP_KEYBOARD))
		return LITEST_NOT_APPLICABLE;

	for (code = 0; code < KEY_CNT; code++) {
		has_key = libinput_device_keyboard_has_key(device, code);
		litest_assert_int_eq(has_key, -1);
	}
}
END_TEST

START_TEST(keyboard_time_usec)
{
	struct litest_device *dev = litest_current_device();
	struct libinput *li = dev->libinput;
	struct libinput_event_keyboard *kev;
	struct libinput_event *event;
	uint64_t time_usec;

	if (!libevdev_has_event_code(dev->evdev, EV_KEY, KEY_A))
		return LITEST_NOT_APPLICABLE;

	litest_drain_events(dev->libinput);

	litest_keyboard_key(dev, KEY_A, true);
	litest_dispatch(li);

	event = libinput_get_event(li);
	kev = litest_is_keyboard_event(event, KEY_A, LIBINPUT_KEY_STATE_PRESSED);

	time_usec = libinput_event_keyboard_get_time_usec(kev);
	litest_assert_int_eq(libinput_event_keyboard_get_time(kev),
			     (uint32_t)(time_usec / 1000));

	libinput_event_destroy(event);
	litest_drain_events(dev->libinput);
}
END_TEST

START_TEST(keyboard_no_buttons)
{
	struct litest_device *dev = litest_current_device();
	struct libinput *li = dev->libinput;
	struct libinput_event *event;
	int code;
	const char *name;

	litest_drain_events(dev->libinput);

	for (code = 0; code < KEY_MAX; code++) {
		if (!libevdev_has_event_code(dev->evdev, EV_KEY, code))
			continue;

		name = libevdev_event_code_get_name(EV_KEY, code);
		if (!strstartswith(name, "KEY_"))
			continue;

		litest_keyboard_key(dev, code, true);
		litest_keyboard_key(dev, code, false);
		litest_dispatch(li);

		event = libinput_get_event(li);
		litest_is_keyboard_event(event, code, LIBINPUT_KEY_STATE_PRESSED);
		libinput_event_destroy(event);
		event = libinput_get_event(li);
		litest_is_keyboard_event(event, code, LIBINPUT_KEY_STATE_RELEASED);
		libinput_event_destroy(event);
	}
}
END_TEST

START_TEST(keyboard_frame_order)
{
	struct litest_device *dev = litest_current_device();
	struct libinput *li = dev->libinput;

	if (!libevdev_has_event_code(dev->evdev, EV_KEY, KEY_A) ||
	    !libevdev_has_event_code(dev->evdev, EV_KEY, KEY_LEFTSHIFT))
		return LITEST_NOT_APPLICABLE;

	litest_drain_events(li);

	litest_event(dev, EV_KEY, KEY_LEFTSHIFT, 1);
	litest_event(dev, EV_KEY, KEY_A, 1);
	litest_event(dev, EV_SYN, SYN_REPORT, 0);
	litest_dispatch(li);

	litest_assert_key_event(li, KEY_LEFTSHIFT, LIBINPUT_KEY_STATE_PRESSED);
	litest_assert_key_event(li, KEY_A, LIBINPUT_KEY_STATE_PRESSED);

	litest_event(dev, EV_KEY, KEY_LEFTSHIFT, 0);
	litest_event(dev, EV_KEY, KEY_A, 0);
	litest_event(dev, EV_SYN, SYN_REPORT, 0);
	litest_dispatch(li);

	litest_assert_key_event(li, KEY_LEFTSHIFT, LIBINPUT_KEY_STATE_RELEASED);
	litest_assert_key_event(li, KEY_A, LIBINPUT_KEY_STATE_RELEASED);

	litest_event(dev, EV_KEY, KEY_A, 1);
	litest_event(dev, EV_KEY, KEY_LEFTSHIFT, 1);
	litest_event(dev, EV_SYN, SYN_REPORT, 0);
	litest_dispatch(li);

	litest_assert_key_event(li, KEY_A, LIBINPUT_KEY_STATE_PRESSED);
	litest_assert_key_event(li, KEY_LEFTSHIFT, LIBINPUT_KEY_STATE_PRESSED);

	litest_event(dev, EV_KEY, KEY_A, 0);
	litest_event(dev, EV_KEY, KEY_LEFTSHIFT, 0);
	litest_event(dev, EV_SYN, SYN_REPORT, 0);
	litest_dispatch(li);

	litest_assert_key_event(li, KEY_A, LIBINPUT_KEY_STATE_RELEASED);
	litest_assert_key_event(li, KEY_LEFTSHIFT, LIBINPUT_KEY_STATE_RELEASED);

	litest_dispatch(li);
}
END_TEST

START_TEST(keyboard_leds)
{
	struct litest_device *dev = litest_current_device();
	struct libinput_device *device = dev->libinput_device;

	/* we can't actually test the results here without physically
	 * looking at the LEDs. So all we do is trigger the code for devices
	 * with and without LEDs and check that it doesn't go boom
	 */

	libinput_device_led_update(device, LIBINPUT_LED_NUM_LOCK);
	libinput_device_led_update(device, LIBINPUT_LED_CAPS_LOCK);
	libinput_device_led_update(device, LIBINPUT_LED_SCROLL_LOCK);
	libinput_device_led_update(device, LIBINPUT_LED_COMPOSE);
	libinput_device_led_update(device, LIBINPUT_LED_KANA);

	libinput_device_led_update(device,
				   LIBINPUT_LED_NUM_LOCK | LIBINPUT_LED_CAPS_LOCK);
	libinput_device_led_update(device,
				   LIBINPUT_LED_NUM_LOCK | LIBINPUT_LED_CAPS_LOCK |
					   LIBINPUT_LED_SCROLL_LOCK);
	libinput_device_led_update(device,
				   LIBINPUT_LED_NUM_LOCK | LIBINPUT_LED_CAPS_LOCK |
					   LIBINPUT_LED_SCROLL_LOCK |
					   LIBINPUT_LED_COMPOSE | LIBINPUT_LED_KANA);
	libinput_device_led_update(device, 0);
	libinput_device_led_update(device, -1);
}
END_TEST

START_TEST(keyboard_no_scroll)
{
	struct litest_device *dev = litest_current_device();
	struct libinput_device *device = dev->libinput_device;
	enum libinput_config_scroll_method method;
	enum libinput_config_status status;

	method = libinput_device_config_scroll_get_method(device);
	litest_assert_enum_eq(method, LIBINPUT_CONFIG_SCROLL_NO_SCROLL);
	method = libinput_device_config_scroll_get_default_method(device);
	litest_assert_enum_eq(method, LIBINPUT_CONFIG_SCROLL_NO_SCROLL);

	status = libinput_device_config_scroll_set_method(device,
							  LIBINPUT_CONFIG_SCROLL_2FG);
	litest_assert_enum_eq(status, LIBINPUT_CONFIG_STATUS_UNSUPPORTED);
	status = libinput_device_config_scroll_set_method(device,
							  LIBINPUT_CONFIG_SCROLL_EDGE);
	litest_assert_enum_eq(status, LIBINPUT_CONFIG_STATUS_UNSUPPORTED);
	status = libinput_device_config_scroll_set_method(
		device,
		LIBINPUT_CONFIG_SCROLL_ON_BUTTON_DOWN);
	litest_assert_enum_eq(status, LIBINPUT_CONFIG_STATUS_UNSUPPORTED);
	status = libinput_device_config_scroll_set_method(
		device,
		LIBINPUT_CONFIG_SCROLL_NO_SCROLL);
	litest_assert_enum_eq(status, LIBINPUT_CONFIG_STATUS_SUCCESS);
}
END_TEST

START_TEST(keyboard_alt_printscreen)
{
	struct litest_device *dev = litest_current_device();
	struct libinput *li = dev->libinput;

	litest_drain_events(li);

	/* normal key press, not ignored */
	litest_event(dev, EV_KEY, KEY_LEFTALT, 1);
	litest_event(dev, EV_SYN, SYN_REPORT, 0);
	litest_dispatch(li);
	litest_assert_key_event(li, KEY_LEFTALT, LIBINPUT_KEY_STATE_PRESSED);

	/* normal key repeat, ignored */
	litest_event(dev, EV_KEY, KEY_LEFTALT, 2);
	litest_event(dev, EV_SYN, SYN_REPORT, 1);
	litest_dispatch(li);
	litest_assert_empty_queue(li);

	/* not a repeat, not ignored */
	litest_event(dev, EV_KEY, KEY_LEFTALT, 0);
	litest_event(dev, EV_SYN, SYN_REPORT, 0);
	litest_dispatch(li);
	litest_assert_key_event(li, KEY_LEFTALT, LIBINPUT_KEY_STATE_RELEASED);
	litest_assert_empty_queue(li);

	/* special alt+printscreen frame, *not* ignored */
	litest_event(dev, EV_KEY, KEY_LEFTALT, 1);
	litest_event(dev, EV_KEY, KEY_SYSRQ, 1);
	litest_event(dev, EV_SYN, SYN_REPORT, 1);
	litest_dispatch(li);

	/* special alt+printscreen frame, *not* ignored */
	litest_event(dev, EV_KEY, KEY_LEFTALT, 0);
	litest_event(dev, EV_KEY, KEY_SYSRQ, 0);
	litest_event(dev, EV_SYN, SYN_REPORT, 1);
	litest_dispatch(li);

	/* Note: The kernel first releases KEY_LEFTALT when pressing KEY_SYSRQ,
	 * then later generates press/release for KEY_LEFTALT + KEY_SYSRQ
	 * once *both* keys are released. The order is reshuffled so we have
	 * alt down, sysrq down, sysrq up, alt up.
	 */
	litest_assert_key_event(li, KEY_LEFTALT, LIBINPUT_KEY_STATE_PRESSED);
	litest_assert_key_event(li, KEY_LEFTALT, LIBINPUT_KEY_STATE_RELEASED);

	litest_assert_key_event(li, KEY_LEFTALT, LIBINPUT_KEY_STATE_PRESSED);
	litest_assert_key_event(li, KEY_SYSRQ, LIBINPUT_KEY_STATE_PRESSED);
	litest_assert_key_event(li, KEY_SYSRQ, LIBINPUT_KEY_STATE_RELEASED);
	litest_assert_key_event(li, KEY_LEFTALT, LIBINPUT_KEY_STATE_RELEASED);

	litest_assert_empty_queue(li);
}
END_TEST

START_TEST(keyboard_keycode_obfuscation)
{
#ifdef EVENT_DEBUGGING
	struct litest_device *dev = litest_current_device();
	struct libinput *li = dev->libinput;

	litest_drain_events(li);

	litest_with_logcapture(li, capture) {
		litest_event(dev, EV_KEY, KEY_Q, 1);
		litest_event(dev, EV_SYN, SYN_REPORT, 0);
		litest_event(dev, EV_KEY, KEY_Q, 0);
		litest_event(dev, EV_SYN, SYN_REPORT, 0);
		litest_dispatch(li);
		litest_drain_events(li);

		/* clang-format off */
		/* We get two possible debug messages:
		 *  Queuing  event14  KEYBOARD_KEY                 +0.000s KEY_Q (16) released
		 *  event14: plugin evdev           - 0.000 EV_KEY           KEY_Q                   0
		 *
		 * Both KEY_Q must be obfuscated to KEY_A
		 */
		/* clang-format on */
		char **strv = capture->debugs;
		litest_assert_strv_no_substring(strv, "KEY_Q");

		strv = capture->debugs;
		size_t index;
		litest_assert(strv_find_substring(strv, "KEY_A", &index));
		do {
			litest_assert_str_in("EV_KEY", strv[index]);
			strv += index + 1;
		} while (strv_find_substring(strv, "KEY_A", &index));
	}
#else
	return LITEST_SKIP;
#endif
}
END_TEST

START_TEST(keyboard_nkey_rollover)
{
	struct litest_device *dev = litest_current_device();
	struct libinput *li = dev->libinput;

	int nkeys = litest_test_param_get_i32(test_env->params, "nkeys");

	litest_drain_events(li);

	/* The kernel allocates a 7 + 1 buffer for devices without EV_ABS and
	 * EV_REL, see
	 * drivers/input/input.c:input_estimate_events_per_packet()
	 *
	 * If the device exceeds that buffer the current set is flushed out
	 * as SYN_REPORT 1 followed by (if any) the remaining events immediately
	 * after.
	 *
	 * Either way, we expect n keys to arrive, regardless what the kernel
	 * does.
	 */
	for (int i = 0; i < nkeys; i++) {
		litest_event_unchecked(dev, EV_KEY, KEY_A + i, 1);
		litest_event_unchecked(dev, EV_MSC, MSC_SCAN, 0x1000 + i);
	}
	litest_event_unchecked(dev, EV_SYN, SYN_REPORT, 0);

	for (int i = 0; i < nkeys; i++) {
		litest_event_unchecked(dev, EV_KEY, KEY_A + i, 0);
		litest_event_unchecked(dev, EV_MSC, MSC_SCAN, 0x1000 + i);
	}
	litest_event_unchecked(dev, EV_SYN, SYN_REPORT, 0);

	litest_dispatch(li);

	for (int i = 0; i < nkeys; i++) {
		litest_checkpoint("here for %d", i);
		litest_assert_key_event(li, KEY_A + i, LIBINPUT_KEY_STATE_PRESSED);
	}
	for (int i = 0; i < nkeys; i++) {
		litest_assert_key_event(li, KEY_A + i, LIBINPUT_KEY_STATE_RELEASED);
	}

	litest_assert_empty_queue(li);
}
END_TEST

TEST_COLLECTION(keyboard)
{
	/* clang-format off */
	litest_add_no_device(keyboard_seat_key_count);
	litest_add_no_device(keyboard_ignore_no_pressed_release);
	litest_add_no_device(keyboard_key_auto_release);
	litest_add(keyboard_has_key, LITEST_KEYS, LITEST_ANY);
	litest_add(keyboard_keys_bad_device, LITEST_ANY, LITEST_ANY);
	litest_add(keyboard_time_usec, LITEST_KEYS, LITEST_ANY);

	litest_add(keyboard_no_buttons, LITEST_KEYS, LITEST_ANY);
	litest_add(keyboard_frame_order, LITEST_KEYS, LITEST_ANY);

	litest_add(keyboard_leds, LITEST_ANY, LITEST_ANY);

	litest_add(keyboard_no_scroll, LITEST_KEYS, LITEST_WHEEL);

	litest_add_for_device(keyboard_alt_printscreen, LITEST_KEYBOARD);
	litest_add_for_device(keyboard_keycode_obfuscation, LITEST_KEYBOARD);

	/* Adding for one device only to be able to hardcode buffer sizes */
	litest_with_parameters(params, "nkeys", 'i', 4, 3, 4, 5, 6)
		litest_add_parametrized_for_device(keyboard_nkey_rollover, LITEST_KEYBOARD, params);

	/* clang-format on */
}