Browse Source
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 <david@kosorin.net>
pull/17311/head
Pascal Getreuer
1 year ago
committed by
GitHub
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
28 changed files with 683 additions and 298 deletions
Split View
Diff Options
-
+1 -0quantum/process_keycode/process_unicode_common.c
-
+3 -3quantum/quantum.c
-
+8 -8tests/auto_shift/test_auto_shift.cpp
-
+27 -27tests/basic/test_action_layer.cpp
-
+48 -48tests/basic/test_keypress.cpp
-
+18 -18tests/basic/test_one_shot_keys.cpp
-
+17 -17tests/basic/test_tapping.cpp
-
+22 -0tests/caps_word/caps_word_autoshift/config.h
-
+18 -0tests/caps_word/caps_word_autoshift/test.mk
-
+101 -0tests/caps_word/caps_word_autoshift/test_caps_word_autoshift.cpp
-
+20 -0tests/caps_word/caps_word_unicodemap/config.h
-
+18 -0tests/caps_word/caps_word_unicodemap/test.mk
-
+121 -0tests/caps_word/caps_word_unicodemap/test_caps_word_unicodemap.cpp
-
+26 -42tests/caps_word/test_caps_word.cpp
-
+32 -49tests/secure/test_secure.cpp
-
+33 -33tests/tap_hold_configurations/default_mod_tap/test_tap_hold.cpp
-
+9 -9tests/tap_hold_configurations/ignore_mod_tap_interrupt/test_tap_hold.cpp
-
+3 -3tests/tap_hold_configurations/permissive_hold/test_one_shot_keys.cpp
-
+8 -8tests/tap_hold_configurations/permissive_hold/test_tap_hold.cpp
-
+8 -8tests/tap_hold_configurations/permissive_hold_ignore_mod_tap_interrupt/test_tap_hold.cpp
-
+2 -2tests/tap_hold_configurations/retro_tapping/test_tap_hold.cpp
-
+5 -5tests/tap_hold_configurations/retro_tapping/test_tapping.cpp
-
+2 -2tests/tap_hold_configurations/tapping_force_hold/test_action_layer.cpp
-
+13 -13tests/tap_hold_configurations/tapping_force_hold/test_tap_hold.cpp
-
+35 -0tests/test_common/test_driver.cpp
-
+61 -1tests/test_common/test_driver.hpp
-
+8 -1tests/test_common/test_fixture.cpp
-
+16 -1tests/test_common/test_fixture.hpp
+ 1
- 0
quantum/process_keycode/process_unicode_common.c
View File
+ 3
- 3
quantum/quantum.c
View File
+ 8
- 8
tests/auto_shift/test_auto_shift.cpp
View File
+ 27
- 27
tests/basic/test_action_layer.cpp
View File
+ 48
- 48
tests/basic/test_keypress.cpp
View File
+ 18
- 18
tests/basic/test_one_shot_keys.cpp
View File
+ 17
- 17
tests/basic/test_tapping.cpp
View File
+ 22
- 0
tests/caps_word/caps_word_autoshift/config.h
View File
| @ -0,0 +1,22 @@ | |||
| // Copyright 2022 Google LLC | |||
| // | |||
| // This program is free software: you can redistribute it and/or modify | |||
| // it under the terms of the GNU General Public License as published by | |||
| // the Free Software Foundation, either version 2 of the License, or | |||
| // (at your option) any later version. | |||
| // | |||
| // This program is distributed in the hope that it will be useful, | |||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
| // GNU General Public License for more details. | |||
| // | |||
| // You should have received a copy of the GNU General Public License | |||
| // along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
| #pragma once | |||
| #include "test_common.h" | |||
| #define TAPPING_TERM 200 | |||
| #define AUTO_SHIFT_TIMEOUT 150 | |||
| #define RETRO_SHIFT 500 | |||
+ 18
- 0
tests/caps_word/caps_word_autoshift/test.mk
View File
| @ -0,0 +1,18 @@ | |||
| # Copyright 2022 Google LLC | |||
| # | |||
| # This program is free software: you can redistribute it and/or modify | |||
| # it under the terms of the GNU General Public License as published by | |||
| # the Free Software Foundation, either version 2 of the License, or | |||
| # (at your option) any later version. | |||
| # | |||
| # This program is distributed in the hope that it will be useful, | |||
| # but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
| # GNU General Public License for more details. | |||
| # | |||
| # You should have received a copy of the GNU General Public License | |||
| # along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
| CAPS_WORD_ENABLE = yes | |||
| AUTO_SHIFT_ENABLE = yes | |||
+ 101
- 0
tests/caps_word/caps_word_autoshift/test_caps_word_autoshift.cpp
View File
| @ -0,0 +1,101 @@ | |||
| // Copyright 2022 Google LLC | |||
| // | |||
| // This program is free software: you can redistribute it and/or modify | |||
| // it under the terms of the GNU General Public License as published by | |||
| // the Free Software Foundation, either version 2 of the License, or | |||
| // (at your option) any later version. | |||
| // | |||
| // This program is distributed in the hope that it will be useful, | |||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
| // GNU General Public License for more details. | |||
| // | |||
| // You should have received a copy of the GNU General Public License | |||
| // along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
| #include "keyboard_report_util.hpp" | |||
| #include "keycode.h" | |||
| #include "test_common.hpp" | |||
| #include "test_fixture.hpp" | |||
| #include "test_keymap_key.hpp" | |||
| using ::testing::_; | |||
| using ::testing::AnyNumber; | |||
| using ::testing::AnyOf; | |||
| using ::testing::InSequence; | |||
| class CapsWord : public TestFixture { | |||
| public: | |||
| void SetUp() override { | |||
| caps_word_off(); | |||
| } | |||
| }; | |||
| // Tests that with Auto Shift, letter keys are shifted by Caps Word | |||
| // regardless of whether they are released before AUTO_SHIFT_TIMEOUT. | |||
| TEST_F(CapsWord, AutoShiftKeys) { | |||
| TestDriver driver; | |||
| KeymapKey key_a(0, 0, 0, KC_A); | |||
| KeymapKey key_spc(0, 1, 0, KC_SPC); | |||
| set_keymap({key_a, key_spc}); | |||
| // Allow any number of reports with no keys or only KC_LSFT. | |||
| // clang-format off | |||
| EXPECT_CALL(driver, send_keyboard_mock(AnyOf( | |||
| KeyboardReport(), | |||
| KeyboardReport(KC_LSFT)))) | |||
| .Times(AnyNumber()); | |||
| // clang-format on | |||
| { // Expect: "A, A, space, a". | |||
| InSequence s; | |||
| EXPECT_REPORT(driver, (KC_LSFT, KC_A)); | |||
| EXPECT_REPORT(driver, (KC_LSFT, KC_A)); | |||
| EXPECT_REPORT(driver, (KC_SPC)); | |||
| EXPECT_REPORT(driver, (KC_A)); | |||
| } | |||
| // Turn on Caps Word and type "A (quick tap), A (long press), space, A". | |||
| caps_word_on(); | |||
| tap_key(key_a); // Tap A quickly. | |||
| tap_key(key_a, AUTO_SHIFT_TIMEOUT + 1); // Long press A. | |||
| tap_key(key_spc); | |||
| tap_key(key_a); | |||
| testing::Mock::VerifyAndClearExpectations(&driver); | |||
| } | |||
| // Tests that with tap-hold keys with Retro Shift, letter keys are shifted by | |||
| // Caps Word regardless of whether they are retroshifted. | |||
| TEST_F(CapsWord, RetroShiftKeys) { | |||
| TestDriver driver; | |||
| KeymapKey key_modtap_a(0, 0, 0, LCTL_T(KC_A)); | |||
| KeymapKey key_layertap_b(0, 1, 0, LT(1, KC_B)); | |||
| set_keymap({key_modtap_a, key_layertap_b}); | |||
| // Allow any number of reports with no keys or only KC_LSFT. | |||
| // clang-format off | |||
| EXPECT_CALL(driver, send_keyboard_mock(AnyOf( | |||
| KeyboardReport(), | |||
| KeyboardReport(KC_LSFT)))) | |||
| .Times(AnyNumber()); | |||
| // clang-format on | |||
| { // Expect: "B, A, B, A". | |||
| InSequence s; | |||
| EXPECT_REPORT(driver, (KC_LSFT, KC_B)); | |||
| EXPECT_REPORT(driver, (KC_LSFT, KC_A)); | |||
| EXPECT_REPORT(driver, (KC_LSFT, KC_B)); | |||
| EXPECT_REPORT(driver, (KC_LSFT, KC_A)); | |||
| } | |||
| // Turn on Caps Word and type "B, A (long press), B (long press), A". | |||
| caps_word_on(); | |||
| tap_key(key_layertap_b); // Tap B quickly. | |||
| tap_key(key_modtap_a, TAPPING_TERM + 1); // Long press A. | |||
| tap_key(key_layertap_b, TAPPING_TERM + 1); // Long press B. | |||
| tap_key(key_modtap_a); // Tap A quickly. | |||
| EXPECT_EQ(is_caps_word_on(), true); | |||
| testing::Mock::VerifyAndClearExpectations(&driver); | |||
| } | |||
+ 20
- 0
tests/caps_word/caps_word_unicodemap/config.h
View File
| @ -0,0 +1,20 @@ | |||
| // Copyright 2022 Google LLC | |||
| // | |||
| // This program is free software: you can redistribute it and/or modify | |||
| // it under the terms of the GNU General Public License as published by | |||
| // the Free Software Foundation, either version 2 of the License, or | |||
| // (at your option) any later version. | |||
| // | |||
| // This program is distributed in the hope that it will be useful, | |||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
| // GNU General Public License for more details. | |||
| // | |||
| // You should have received a copy of the GNU General Public License | |||
| // along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
| #pragma once | |||
| #include "test_common.h" | |||
| #define UNICODE_SELECTED_MODES UC_LNX | |||
+ 18
- 0
tests/caps_word/caps_word_unicodemap/test.mk
View File
| @ -0,0 +1,18 @@ | |||
| # Copyright 2022 Google LLC | |||
| # | |||
| # This program is free software: you can redistribute it and/or modify | |||
| # it under the terms of the GNU General Public License as published by | |||
| # the Free Software Foundation, either version 2 of the License, or | |||
| # (at your option) any later version. | |||
| # | |||
| # This program is distributed in the hope that it will be useful, | |||
| # but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
| # GNU General Public License for more details. | |||
| # | |||
| # You should have received a copy of the GNU General Public License | |||
| # along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
| CAPS_WORD_ENABLE = yes | |||
| UNICODEMAP_ENABLE = yes | |||
+ 121
- 0
tests/caps_word/caps_word_unicodemap/test_caps_word_unicodemap.cpp
View File
| @ -0,0 +1,121 @@ | |||
| // Copyright 2022 Google LLC | |||
| // | |||
| // This program is free software: you can redistribute it and/or modify | |||
| // it under the terms of the GNU General Public License as published by | |||
| // the Free Software Foundation, either version 2 of the License, or | |||
| // (at your option) any later version. | |||
| // | |||
| // This program is distributed in the hope that it will be useful, | |||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
| // GNU General Public License for more details. | |||
| // | |||
| // You should have received a copy of the GNU General Public License | |||
| // along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
| #include "keyboard_report_util.hpp" | |||
| #include "keycode.h" | |||
| #include "test_common.hpp" | |||
| #include "test_fixture.hpp" | |||
| #include "test_keymap_key.hpp" | |||
| using ::testing::_; | |||
| using ::testing::AnyNumber; | |||
| using ::testing::AnyOf; | |||
| using ::testing::InSequence; | |||
| extern "C" { | |||
| enum unicode_names { | |||
| ENDASH, | |||
| EMDASH, | |||
| DELTA_LOWERCASE, | |||
| DELTA_UPPERCASE, | |||
| }; | |||
| const uint32_t unicode_map[] PROGMEM = { | |||
| [ENDASH] = 0x2013, | |||
| [EMDASH] = 0x2014, | |||
| [DELTA_LOWERCASE] = 0x03b4, | |||
| [DELTA_UPPERCASE] = 0x0394, | |||
| }; | |||
| #define U_DASH XP(ENDASH, EMDASH) | |||
| #define U_DELTA XP(DELTA_LOWERCASE, DELTA_UPPERCASE) | |||
| bool caps_word_press_user(uint16_t keycode) { | |||
| switch (keycode) { | |||
| // Keycodes that continue Caps Word, with shift applied. | |||
| case U_DELTA: | |||
| add_weak_mods(MOD_BIT(KC_LSFT)); // Apply shift to next key. | |||
| return true; | |||
| // Keycodes that continue Caps Word, without shifting. | |||
| case U_DASH: | |||
| return true; | |||
| default: | |||
| return false; // Deactivate Caps Word. | |||
| } | |||
| } | |||
| } // extern "C" | |||
| class CapsWord : public TestFixture { | |||
| public: | |||
| void SetUp() override { | |||
| caps_word_off(); | |||
| } | |||
| }; | |||
| // Tests that typing U_DELTA while Caps Word is on sends the uppercase Delta. | |||
| TEST_F(CapsWord, ShiftedUnicodeMapKey) { | |||
| TestDriver driver; | |||
| KeymapKey key_delta(0, 0, 0, U_DELTA); | |||
| KeymapKey key_spc(0, 1, 0, KC_SPC); | |||
| set_keymap({key_delta, key_spc}); | |||
| // Allow any number of reports with no keys or only KC_LSFT and KC_LCTL. | |||
| // clang-format off | |||
| EXPECT_CALL(driver, send_keyboard_mock(AnyOf( | |||
| KeyboardReport(), | |||
| KeyboardReport(KC_LSFT), | |||
| KeyboardReport(KC_LCTL, KC_LSFT)))) | |||
| .Times(AnyNumber()); | |||
| // clang-format on | |||
| { // Expect: "Uppercase Delta, space, lowercase delta". | |||
| InSequence s; | |||
| EXPECT_UNICODE(driver, unicode_map[DELTA_UPPERCASE]); | |||
| EXPECT_REPORT(driver, (KC_SPC)); | |||
| EXPECT_UNICODE(driver, unicode_map[DELTA_LOWERCASE]); | |||
| } | |||
| // Turn on Caps Word and tap "delta, space, delta". | |||
| caps_word_on(); | |||
| tap_keys(key_delta, key_spc, key_delta); | |||
| EXPECT_EQ(is_caps_word_on(), false); | |||
| testing::Mock::VerifyAndClearExpectations(&driver); | |||
| } | |||
| // Tests typing U_ENDASH while Caps Word is on. | |||
| TEST_F(CapsWord, UnshiftedUnicodeMapKey) { | |||
| TestDriver driver; | |||
| KeymapKey key_dash(0, 0, 0, U_DASH); | |||
| set_keymap({key_dash}); | |||
| // Allow any number of reports with no keys or only KC_LSFT and KC_LCTL. | |||
| // clang-format off | |||
| EXPECT_CALL(driver, send_keyboard_mock(AnyOf( | |||
| KeyboardReport(), | |||
| KeyboardReport(KC_LSFT), | |||
| KeyboardReport(KC_LCTL, KC_LSFT)))) | |||
| .Times(AnyNumber()); | |||
| // clang-format on | |||
| EXPECT_UNICODE(driver, unicode_map[ENDASH]); | |||
| // Turn on Caps Word and tap U_DASH key. | |||
| caps_word_on(); | |||
| tap_key(key_dash); | |||
| EXPECT_EQ(is_caps_word_on(), true); | |||
| testing::Mock::VerifyAndClearExpectations(&driver); | |||
| } | |||