mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-12-12 21:00:58 +00:00
95d20e6d8b
* 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>
315 lines
8.9 KiB
C++
315 lines
8.9 KiB
C++
/* 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_NO_REPORT(driver);
|
|
keyboard_task();
|
|
}
|
|
|
|
TEST_F(KeyPress, CorrectKeyIsReportedWhenPressed) {
|
|
TestDriver driver;
|
|
auto key = KeymapKey(0, 0, 0, KC_A);
|
|
|
|
set_keymap({key});
|
|
|
|
key.press();
|
|
EXPECT_REPORT(driver, (key.report_code));
|
|
keyboard_task();
|
|
|
|
key.release();
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
keyboard_task();
|
|
}
|
|
|
|
TEST_F(KeyPress, ANonMappedKeyDoesNothing) {
|
|
TestDriver driver;
|
|
auto key = KeymapKey(0, 0, 0, KC_NO);
|
|
|
|
set_keymap({key});
|
|
|
|
key.press();
|
|
EXPECT_NO_REPORT(driver);
|
|
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_REPORT(driver, (key_b.report_code));
|
|
keyboard_task();
|
|
|
|
EXPECT_REPORT(driver, (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_REPORT(driver, (key_c.report_code));
|
|
keyboard_task();
|
|
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
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_LEFT_SHIFT);
|
|
|
|
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_REPORT(driver, (key_a.report_code));
|
|
keyboard_task();
|
|
EXPECT_REPORT(driver, (key_a.report_code, key_lsft.report_code));
|
|
keyboard_task();
|
|
|
|
key_a.release();
|
|
EXPECT_REPORT(driver, (key_lsft.report_code));
|
|
keyboard_task();
|
|
|
|
key_lsft.release();
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
keyboard_task();
|
|
}
|
|
|
|
TEST_F(KeyPress, PressLeftShiftAndControl) {
|
|
TestDriver driver;
|
|
auto key_lsft = KeymapKey(0, 3, 0, KC_LEFT_SHIFT);
|
|
auto key_lctrl = KeymapKey(0, 5, 0, KC_LEFT_CTRL);
|
|
|
|
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_REPORT(driver, (key_lsft.report_code));
|
|
keyboard_task();
|
|
|
|
EXPECT_REPORT(driver, (key_lsft.report_code, key_lctrl.report_code));
|
|
keyboard_task();
|
|
|
|
key_lsft.release();
|
|
key_lctrl.release();
|
|
|
|
EXPECT_REPORT(driver, (key_lctrl.report_code));
|
|
keyboard_task();
|
|
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
keyboard_task();
|
|
}
|
|
|
|
TEST_F(KeyPress, LeftAndRightShiftCanBePressedAtTheSameTime) {
|
|
TestDriver driver;
|
|
auto key_lsft = KeymapKey(0, 3, 0, KC_LEFT_SHIFT);
|
|
auto key_rsft = KeymapKey(0, 4, 0, KC_RIGHT_SHIFT);
|
|
|
|
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_REPORT(driver, (key_lsft.report_code));
|
|
keyboard_task();
|
|
|
|
EXPECT_REPORT(driver, (key_lsft.report_code, key_rsft.report_code));
|
|
keyboard_task();
|
|
|
|
key_lsft.release();
|
|
key_rsft.release();
|
|
|
|
EXPECT_REPORT(driver, (key_rsft.report_code));
|
|
keyboard_task();
|
|
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
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_REPORT(driver, (KC_RIGHT_SHIFT, KC_RIGHT_CTRL));
|
|
EXPECT_REPORT(driver, (KC_RIGHT_SHIFT, KC_RIGHT_CTRL, KC_O));
|
|
keyboard_task();
|
|
|
|
combo_key.release();
|
|
EXPECT_REPORT(driver, (KC_RIGHT_SHIFT, KC_RIGHT_CTRL));
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
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_EQUAL);
|
|
|
|
set_keymap({key_plus, key_eql});
|
|
|
|
key_plus.press();
|
|
EXPECT_REPORT(driver, (KC_LEFT_SHIFT));
|
|
EXPECT_REPORT(driver, (KC_LEFT_SHIFT, KC_EQUAL));
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
key_plus.release();
|
|
EXPECT_REPORT(driver, (KC_LEFT_SHIFT));
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
key_eql.press();
|
|
EXPECT_REPORT(driver, (key_eql.report_code));
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
key_eql.release();
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
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_EQUAL);
|
|
|
|
set_keymap({key_plus, key_eql});
|
|
|
|
key_plus.press();
|
|
EXPECT_REPORT(driver, (KC_LEFT_SHIFT));
|
|
EXPECT_REPORT(driver, (KC_LEFT_SHIFT, KC_EQUAL));
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
key_eql.press();
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
EXPECT_REPORT(driver, (KC_EQUAL));
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
key_plus.release();
|
|
// BUG: Should really still return KC_EQUAL, but this is fine too
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
key_eql.release();
|
|
EXPECT_NO_REPORT(driver);
|
|
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_EQUAL);
|
|
|
|
set_keymap({key_plus, key_eql});
|
|
|
|
key_eql.press();
|
|
EXPECT_REPORT(driver, (KC_EQUAL));
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
key_eql.release();
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
key_plus.press();
|
|
EXPECT_REPORT(driver, (KC_LEFT_SHIFT));
|
|
EXPECT_REPORT(driver, (KC_LEFT_SHIFT, KC_EQUAL));
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
key_plus.release();
|
|
EXPECT_REPORT(driver, (KC_LEFT_SHIFT));
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
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_EQUAL);
|
|
|
|
set_keymap({key_plus, key_eql});
|
|
|
|
key_eql.press();
|
|
EXPECT_REPORT(driver, (KC_EQUAL));
|
|
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_REPORT(driver, (KC_LEFT_SHIFT, KC_EQUAL));
|
|
EXPECT_REPORT(driver, (KC_LEFT_SHIFT));
|
|
EXPECT_REPORT(driver, (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_REPORT(driver, (KC_LEFT_SHIFT));
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
key_plus.release();
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
}
|