qmk_firmware/tests/basic/test_tapping.cpp
Pascal Getreuer 95d20e6d8b
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>
2022-06-05 09:14:02 +02:00

123 lines
3.5 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 "keyboard_report_util.hpp"
#include "keycode.h"
#include "test_common.hpp"
#include "action_tapping.h"
#include "test_keymap_key.hpp"
using testing::_;
using testing::InSequence;
class Tapping : public TestFixture {};
TEST_F(Tapping, TapA_SHFT_T_KeyReportsKey) {
TestDriver driver;
InSequence s;
auto key_shift_hold_p_tap = KeymapKey(0, 7, 0, SFT_T(KC_P));
set_keymap({key_shift_hold_p_tap});
// Tapping keys does nothing on press
key_shift_hold_p_tap.press();
EXPECT_NO_REPORT(driver);
run_one_scan_loop();
// First we get the key press
key_shift_hold_p_tap.release();
EXPECT_REPORT(driver, (KC_P));
// Then the release
EXPECT_EMPTY_REPORT(driver);
run_one_scan_loop();
}
TEST_F(Tapping, HoldA_SHFT_T_KeyReportsShift) {
TestDriver driver;
InSequence s;
auto mod_tap_hold_key = KeymapKey(0, 7, 0, SFT_T(KC_P));
set_keymap({mod_tap_hold_key});
mod_tap_hold_key.press();
// Tapping keys does nothing on press
EXPECT_NO_REPORT(driver);
idle_for(TAPPING_TERM);
EXPECT_REPORT(driver, (KC_LSFT));
run_one_scan_loop();
EXPECT_EMPTY_REPORT(driver);
mod_tap_hold_key.release();
run_one_scan_loop();
}
TEST_F(Tapping, ANewTapWithinTappingTermIsBuggy) {
// See issue #1478 for more information
TestDriver driver;
InSequence s;
auto key_shift_hold_p_tap = KeymapKey(0, 7, 0, SFT_T(KC_P));
set_keymap({key_shift_hold_p_tap});
// Tapping keys does nothing on press
key_shift_hold_p_tap.press();
EXPECT_NO_REPORT(driver);
run_one_scan_loop();
key_shift_hold_p_tap.release();
// First we get the key press
EXPECT_REPORT(driver, (KC_P));
// Then the release
EXPECT_EMPTY_REPORT(driver);
run_one_scan_loop();
// This sends KC_P, even if it should do nothing
key_shift_hold_p_tap.press();
// This test should not succed if everything works correctly
EXPECT_REPORT(driver, (KC_P));
run_one_scan_loop();
key_shift_hold_p_tap.release();
EXPECT_EMPTY_REPORT(driver);
idle_for(TAPPING_TERM + 1);
// On the other hand, nothing is sent if we are outside the tapping term
key_shift_hold_p_tap.press();
EXPECT_NO_REPORT(driver);
run_one_scan_loop();
key_shift_hold_p_tap.release();
// First we get the key press
EXPECT_REPORT(driver, (KC_P));
// Then the release
EXPECT_EMPTY_REPORT(driver);
idle_for(TAPPING_TERM + 1);
// Now we are geting into strange territory, as the hold registers too early here
// But the stranges part is:
// If TAPPING_TERM + 1 above is changed to TAPPING_TERM or TAPPING_TERM + 2 it doesn't
key_shift_hold_p_tap.press();
// Shouldn't be called here really
EXPECT_REPORT(driver, (KC_LEFT_SHIFT)).Times(1);
idle_for(TAPPING_TERM);
EXPECT_EMPTY_REPORT(driver);
key_shift_hold_p_tap.release();
run_one_scan_loop();
}