From 95d20e6d8bb1ffaf3024af793daf789ee0b75727 Mon Sep 17 00:00:00 2001 From: Pascal Getreuer <50221757+getreuer@users.noreply.github.com> Date: Sun, 5 Jun 2022 00:14:02 -0700 Subject: Fix and add unit tests for Caps Word to work with Unicode Map, Auto Shift, Retro Shift. (#17284) * Fix Caps Word and Unicode Map * Tests for Caps Word + Auto Shift and Unicode Map. * Fix formatting * Add additional keyboard report expectation macros This commit defines five test utilities, EXPECT_REPORT, EXPECT_UNICODE, EXPECT_EMPTY_REPORT, EXPECT_ANY_REPORT and EXPECT_NO_REPORT for use with TestDriver. EXPECT_REPORT sets a gmock expectation that a given keyboard report will be sent. For instance, EXPECT_REPORT(driver, (KC_LSFT, KC_A)); is shorthand for EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_A))); EXPECT_UNICODE sets a gmock expectation that a given Unicode code point will be sent using UC_LNX input mode. For instance for U+2013, EXPECT_UNICODE(driver, 0x2013); expects the sequence of keys: "Ctrl+Shift+U, 2, 0, 1, 3, space". EXPECT_EMPTY_REPORT sets a gmock expectation that a given keyboard report will be sent. For instance EXPECT_EMPTY_REPORT(driver); expects a single report without keypresses or modifiers. EXPECT_ANY_REPORT sets a gmock expectation that a arbitrary keyboard report will be sent, without matching its contents. For instance EXPECT_ANY_REPORT(driver).Times(1); expects a single arbitrary keyboard report will be sent. EXPECT_NO_REPORT sets a gmock expectation that no keyboard report will be sent at all. * Add tap_key() and tap_keys() to TestFixture. This commit adds a `tap_key(key)` method to TestFixture that taps a given KeymapKey, optionally with a specified delay between press and release. Similarly, the method `tap_keys(key_a, key_b, key_c)` taps a sequence of KeymapKeys. * Use EXPECT_REPORT, tap_keys, etc. in most tests. This commit uses EXPECT_REPORT, EXPECT_UNICODE, EXPECT_EMPTY_REPORT, EXPECT_NO_REPORT, tap_key() and tap_keys() test utilities from the previous two commits in most tests. Particularly the EXPECT_REPORT macro is frequently useful and makes a nice reduction in boilerplate needed to express many tests. Co-authored-by: David Kosorin --- tests/secure/test_secure.cpp | 81 +++++++++++++++++--------------------------- 1 file changed, 32 insertions(+), 49 deletions(-) (limited to 'tests/secure') diff --git a/tests/secure/test_secure.cpp b/tests/secure/test_secure.cpp index b7c51b0bd2..6ca98d78f3 100644 --- a/tests/secure/test_secure.cpp +++ b/tests/secure/test_secure.cpp @@ -27,28 +27,13 @@ class Secure : public TestFixture { void SetUp() override { secure_lock(); } - // Convenience function to tap `key`. - void TapKey(KeymapKey key) { - key.press(); - run_one_scan_loop(); - key.release(); - run_one_scan_loop(); - } - - // Taps in order each key in `keys`. - template - void TapKeys(Ts... keys) { - for (KeymapKey key : {keys...}) { - TapKey(key); - } - } }; TEST_F(Secure, test_lock) { TestDriver driver; - // Allow any number of empty reports. - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(0); + // Don't allow empty reports. + EXPECT_NO_REPORT(driver); EXPECT_FALSE(secure_is_unlocked()); secure_unlock(); @@ -64,8 +49,8 @@ TEST_F(Secure, test_lock) { TEST_F(Secure, test_unlock_timeout) { TestDriver driver; - // Allow any number of empty reports. - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(0); + // Don't allow empty reports. + EXPECT_NO_REPORT(driver); EXPECT_FALSE(secure_is_unlocked()); secure_unlock(); @@ -86,13 +71,13 @@ TEST_F(Secure, test_unlock_request) { set_keymap({key_mo, key_a, key_b, key_c, key_d}); - // Allow any number of empty reports. - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(0); + // Don't allow empty reports. + EXPECT_NO_REPORT(driver); EXPECT_TRUE(secure_is_locked()); secure_request_unlock(); EXPECT_TRUE(secure_is_unlocking()); - TapKeys(key_a, key_b, key_c, key_d); + tap_keys(key_a, key_b, key_c, key_d); EXPECT_TRUE(secure_is_unlocked()); testing::Mock::VerifyAndClearExpectations(&driver); @@ -109,18 +94,18 @@ TEST_F(Secure, test_unlock_request_fail) { set_keymap({key_e, key_a, key_b, key_c, key_d}); // Allow any number of empty reports. - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(AnyNumber()); + EXPECT_EMPTY_REPORT(driver).Times(AnyNumber()); { // Expect the following reports in this order. InSequence s; - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_A))); - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_B))); - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_C))); - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_D))); + EXPECT_REPORT(driver, (KC_A)); + EXPECT_REPORT(driver, (KC_B)); + EXPECT_REPORT(driver, (KC_C)); + EXPECT_REPORT(driver, (KC_D)); } EXPECT_TRUE(secure_is_locked()); secure_request_unlock(); EXPECT_TRUE(secure_is_unlocking()); - TapKeys(key_e, key_a, key_b, key_c, key_d); + tap_keys(key_e, key_a, key_b, key_c, key_d); EXPECT_FALSE(secure_is_unlocked()); testing::Mock::VerifyAndClearExpectations(&driver); @@ -129,8 +114,8 @@ TEST_F(Secure, test_unlock_request_fail) { TEST_F(Secure, test_unlock_request_timeout) { TestDriver driver; - // Allow any number of empty reports. - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(0); + // Don't allow empty reports. + EXPECT_NO_REPORT(driver); EXPECT_FALSE(secure_is_unlocked()); secure_request_unlock(); @@ -153,16 +138,16 @@ TEST_F(Secure, test_unlock_request_fail_mid) { set_keymap({key_e, key_a, key_b, key_c, key_d}); // Allow any number of empty reports. - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(AnyNumber()); + EXPECT_EMPTY_REPORT(driver).Times(AnyNumber()); { // Expect the following reports in this order. InSequence s; - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_C))); - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_D))); + EXPECT_REPORT(driver, (KC_C)); + EXPECT_REPORT(driver, (KC_D)); } EXPECT_FALSE(secure_is_unlocked()); secure_request_unlock(); EXPECT_TRUE(secure_is_unlocking()); - TapKeys(key_a, key_b, key_e, key_c, key_d); + tap_keys(key_a, key_b, key_e, key_c, key_d); EXPECT_FALSE(secure_is_unlocking()); EXPECT_FALSE(secure_is_unlocked()); @@ -180,16 +165,16 @@ TEST_F(Secure, test_unlock_request_fail_out_of_order) { set_keymap({key_e, key_a, key_b, key_c, key_d}); // Allow any number of empty reports. - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(AnyNumber()); + EXPECT_EMPTY_REPORT(driver).Times(AnyNumber()); { // Expect the following reports in this order. InSequence s; - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_B))); - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_C))); + EXPECT_REPORT(driver, (KC_B)); + EXPECT_REPORT(driver, (KC_C)); } EXPECT_FALSE(secure_is_unlocked()); secure_request_unlock(); EXPECT_TRUE(secure_is_unlocking()); - TapKeys(key_a, key_d, key_b, key_c); + tap_keys(key_a, key_d, key_b, key_c); EXPECT_TRUE(secure_is_locked()); EXPECT_FALSE(secure_is_unlocking()); EXPECT_FALSE(secure_is_unlocked()); @@ -207,8 +192,8 @@ TEST_F(Secure, test_unlock_request_on_layer) { set_keymap({key_mo, key_a, key_b, key_c, key_d}); - // Allow any number of empty reports. - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(0); + // Don't allow empty reports. + EXPECT_NO_REPORT(driver); EXPECT_TRUE(secure_is_locked()); key_mo.press(); @@ -217,7 +202,7 @@ TEST_F(Secure, test_unlock_request_on_layer) { key_mo.release(); run_one_scan_loop(); EXPECT_TRUE(secure_is_unlocking()); - TapKeys(key_a, key_b, key_c, key_d); + tap_keys(key_a, key_b, key_c, key_d); EXPECT_TRUE(secure_is_unlocked()); EXPECT_FALSE(layer_state_is(1)); @@ -234,9 +219,8 @@ TEST_F(Secure, test_unlock_request_mid_stroke) { set_keymap({key_e, key_a, key_b, key_c, key_d}); - // Allow any number of empty reports. - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_E))); - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())); + EXPECT_REPORT(driver, (KC_E)); + EXPECT_EMPTY_REPORT(driver); EXPECT_TRUE(secure_is_locked()); key_e.press(); run_one_scan_loop(); @@ -244,7 +228,7 @@ TEST_F(Secure, test_unlock_request_mid_stroke) { key_e.release(); run_one_scan_loop(); EXPECT_TRUE(secure_is_unlocking()); - TapKeys(key_a, key_b, key_c, key_d); + tap_keys(key_a, key_b, key_c, key_d); EXPECT_TRUE(secure_is_unlocked()); testing::Mock::VerifyAndClearExpectations(&driver); @@ -260,9 +244,8 @@ TEST_F(Secure, test_unlock_request_mods) { set_keymap({key_lsft, key_a, key_b, key_c, key_d}); - // Allow any number of empty reports. - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_lsft.report_code))); - EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())); + EXPECT_REPORT(driver, (key_lsft.report_code)); + EXPECT_EMPTY_REPORT(driver); EXPECT_TRUE(secure_is_locked()); key_lsft.press(); run_one_scan_loop(); @@ -270,7 +253,7 @@ TEST_F(Secure, test_unlock_request_mods) { key_lsft.release(); run_one_scan_loop(); EXPECT_TRUE(secure_is_unlocking()); - TapKeys(key_a, key_b, key_c, key_d); + tap_keys(key_a, key_b, key_c, key_d); EXPECT_TRUE(secure_is_unlocked()); testing::Mock::VerifyAndClearExpectations(&driver); -- cgit v1.2.3