initHEADmaster

1 files changed, 317 insertions, 0 deletions

diff --git a/tests/basic/test_keypress.cpp b/tests/basic/test_keypress.cpp
new file mode 100644
index 000000000..1c175c9d5
--- /dev/null
+++ b/tests/basic/test_keypress.cpp
@@ -0,0 +1,317 @@
+/* Copyright 2017 Fred Sundvik
+ *
+ * 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 "keycode.h"
+#include "test_common.hpp"
+
+using testing::_;
+using testing::InSequence;
+
+class KeyPress : public TestFixture {};
+
+TEST_F(KeyPress, SendKeyboardIsNotCalledWhenNoKeyIsPressed) {
+    TestDriver driver;
+    EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
+    keyboard_task();
+}
+
+TEST_F(KeyPress, CorrectKeyIsReportedWhenPressed) {
+    TestDriver driver;
+    auto       key = KeymapKey(0, 0, 0, KC_A);
+
+    set_keymap({key});
+
+    key.press();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key.report_code)));
+    keyboard_task();
+
+    key.release();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+    keyboard_task();
+}
+
+TEST_F(KeyPress, ANonMappedKeyDoesNothing) {
+    TestDriver driver;
+    auto       key = KeymapKey(0, 0, 0, KC_NO);
+
+    set_keymap({key});
+
+    key.press();
+    EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
+    keyboard_task();
+    keyboard_task();
+}
+
+TEST_F(KeyPress, CorrectKeysAreReportedWhenTwoKeysArePressed) {
+    TestDriver driver;
+    auto       key_b = KeymapKey(0, 0, 0, KC_B);
+    auto       key_c = KeymapKey(0, 1, 1, KC_C);
+
+    set_keymap({key_b, key_c});
+
+    key_b.press();
+    key_c.press();
+    // Note that QMK only processes one key at a time
+    // See issue #1476 for more information
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_b.report_code)));
+    keyboard_task();
+
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_b.report_code, key_c.report_code)));
+    keyboard_task();
+
+    key_b.release();
+    key_c.release();
+    // Note that the first key released is the first one in the matrix order
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_c.report_code)));
+    keyboard_task();
+
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+    keyboard_task();
+}
+
+TEST_F(KeyPress, LeftShiftIsReportedCorrectly) {
+    TestDriver driver;
+    auto       key_a    = KeymapKey(0, 0, 0, KC_A);
+    auto       key_lsft = KeymapKey(0, 3, 0, KC_LSFT);
+
+    set_keymap({key_a, key_lsft});
+
+    key_lsft.press();
+    key_a.press();
+
+    // Unfortunately modifiers are also processed in the wrong order
+    // See issue #1476 for more information
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_a.report_code)));
+    keyboard_task();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_a.report_code, key_lsft.report_code)));
+    keyboard_task();
+
+    key_a.release();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_lsft.report_code)));
+    keyboard_task();
+
+    key_lsft.release();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+    keyboard_task();
+}
+
+TEST_F(KeyPress, PressLeftShiftAndControl) {
+    TestDriver driver;
+    auto       key_lsft  = KeymapKey(0, 3, 0, KC_LSFT);
+    auto       key_lctrl = KeymapKey(0, 5, 0, KC_LCTRL);
+
+    set_keymap({key_lctrl, key_lsft});
+
+    key_lsft.press();
+    key_lctrl.press();
+
+    // Unfortunately modifiers are also processed in the wrong order
+    // See issue #1476 for more information
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_lsft.report_code)));
+    keyboard_task();
+
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_lsft.report_code, key_lctrl.report_code)));
+    keyboard_task();
+
+    key_lsft.release();
+    key_lctrl.release();
+
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_lctrl.report_code)));
+    keyboard_task();
+
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+    keyboard_task();
+}
+
+TEST_F(KeyPress, LeftAndRightShiftCanBePressedAtTheSameTime) {
+    TestDriver driver;
+    auto       key_lsft = KeymapKey(0, 3, 0, KC_LSFT);
+    auto       key_rsft = KeymapKey(0, 4, 0, KC_RSFT);
+
+    set_keymap({key_rsft, key_lsft});
+
+    key_lsft.press();
+    key_rsft.press();
+    // Unfortunately modifiers are also processed in the wrong order
+    // See issue #1476 for more information
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_lsft.report_code)));
+    keyboard_task();
+
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_lsft.report_code, key_rsft.report_code)));
+    keyboard_task();
+
+    key_lsft.release();
+    key_rsft.release();
+
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_rsft.report_code)));
+    keyboard_task();
+
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+    keyboard_task();
+}
+
+TEST_F(KeyPress, RightShiftLeftControlAndCharWithTheSameKey) {
+    TestDriver driver;
+    auto       combo_key = KeymapKey(0, 0, 0, RSFT(LCTL(KC_O)));
+
+    set_keymap({combo_key});
+
+    // BUG: The press is split into two reports
+    // BUG: It reports RSFT instead of LSFT
+    // See issue #524 for more information
+    // The underlying cause is that we use only one bit to represent the right hand
+    // modifiers.
+    combo_key.press();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_RSFT, KC_RCTRL)));
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_RSFT, KC_RCTRL, KC_O)));
+    keyboard_task();
+
+    combo_key.release();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_RSFT, KC_RCTRL)));
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+    keyboard_task();
+}
+
+TEST_F(KeyPress, PressPlusEqualReleaseBeforePress) {
+    TestDriver driver;
+    InSequence s;
+    auto       key_plus = KeymapKey(0, 1, 1, KC_PLUS);
+    auto       key_eql  = KeymapKey(0, 0, 1, KC_EQL);
+
+    set_keymap({key_plus, key_eql});
+
+    key_plus.press();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_EQL)));
+    run_one_scan_loop();
+    testing::Mock::VerifyAndClearExpectations(&driver);
+
+    key_plus.release();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+    run_one_scan_loop();
+    testing::Mock::VerifyAndClearExpectations(&driver);
+
+    key_eql.press();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_eql.report_code)));
+    run_one_scan_loop();
+    testing::Mock::VerifyAndClearExpectations(&driver);
+
+    key_eql.release();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+    run_one_scan_loop();
+    testing::Mock::VerifyAndClearExpectations(&driver);
+}
+
+TEST_F(KeyPress, PressPlusEqualDontReleaseBeforePress) {
+    TestDriver driver;
+    InSequence s;
+    auto       key_plus = KeymapKey(0, 1, 1, KC_PLUS);
+    auto       key_eql  = KeymapKey(0, 0, 1, KC_EQL);
+
+    set_keymap({key_plus, key_eql});
+
+    key_plus.press();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_EQL)));
+    run_one_scan_loop();
+    testing::Mock::VerifyAndClearExpectations(&driver);
+
+    key_eql.press();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQUAL)));
+    run_one_scan_loop();
+    testing::Mock::VerifyAndClearExpectations(&driver);
+
+    key_plus.release();
+    // BUG: Should really still return KC_EQL, but this is fine too
+    // It's also called twice for some reason
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(2);
+    run_one_scan_loop();
+    testing::Mock::VerifyAndClearExpectations(&driver);
+
+    key_eql.release();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+    run_one_scan_loop();
+    testing::Mock::VerifyAndClearExpectations(&driver);
+}
+
+TEST_F(KeyPress, PressEqualPlusReleaseBeforePress) {
+    TestDriver driver;
+    InSequence s;
+    auto       key_plus = KeymapKey(0, 1, 1, KC_PLUS);
+    auto       key_eql  = KeymapKey(0, 0, 1, KC_EQL);
+
+    set_keymap({key_plus, key_eql});
+
+    key_eql.press();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQL)));
+    run_one_scan_loop();
+    testing::Mock::VerifyAndClearExpectations(&driver);
+
+    key_eql.release();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+    run_one_scan_loop();
+    testing::Mock::VerifyAndClearExpectations(&driver);
+
+    key_plus.press();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_EQL)));
+    run_one_scan_loop();
+    testing::Mock::VerifyAndClearExpectations(&driver);
+
+    key_plus.release();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+    run_one_scan_loop();
+    testing::Mock::VerifyAndClearExpectations(&driver);
+}
+
+TEST_F(KeyPress, PressEqualPlusDontReleaseBeforePress) {
+    TestDriver driver;
+    InSequence s;
+    auto       key_plus = KeymapKey(0, 1, 1, KC_PLUS);
+    auto       key_eql  = KeymapKey(0, 0, 1, KC_EQL);
+
+    set_keymap({key_plus, key_eql});
+
+    key_eql.press();
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQL)));
+    run_one_scan_loop();
+    testing::Mock::VerifyAndClearExpectations(&driver);
+
+    key_plus.press();
+    // BUG: The sequence is a bit strange, but it works, the end result is that
+    // KC_PLUS is sent
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT, KC_EQUAL)));
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT)));
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT, KC_EQUAL)));
+    run_one_scan_loop();
+    testing::Mock::VerifyAndClearExpectations(&driver);
+
+    key_eql.release();
+    // I guess it's fine to still report shift here
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT)));
+    run_one_scan_loop();
+    testing::Mock::VerifyAndClearExpectations(&driver);
+
+    key_plus.release();
+    // This report is not needed
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT)));
+    EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
+    run_one_scan_loop();
+    testing::Mock::VerifyAndClearExpectations(&driver);
+}
\ No newline at end of file