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>
195 lines
6.1 KiB
C++
195 lines
6.1 KiB
C++
/* Copyright 2021 Stefan Kerkmann
|
|
*
|
|
* 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 "action_util.h"
|
|
#include "keyboard_report_util.hpp"
|
|
#include "test_common.hpp"
|
|
|
|
using testing::_;
|
|
using testing::InSequence;
|
|
|
|
class OneShot : public TestFixture {};
|
|
class OneShotParametrizedTestFixture : public ::testing::WithParamInterface<std::pair<KeymapKey, KeymapKey>>, public OneShot {};
|
|
|
|
TEST_F(OneShot, OSMWithoutAdditionalKeypressDoesNothing) {
|
|
TestDriver driver;
|
|
auto osm_key = KeymapKey(0, 0, 0, OSM(MOD_LSFT), KC_LSFT);
|
|
|
|
set_keymap({osm_key});
|
|
|
|
/* Press and release OSM key*/
|
|
EXPECT_NO_REPORT(driver);
|
|
osm_key.press();
|
|
run_one_scan_loop();
|
|
osm_key.release();
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
/* OSM are added when an actual report is send */
|
|
EXPECT_REPORT(driver, (osm_key.report_code));
|
|
send_keyboard_report();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
/* Make unit-test pass */
|
|
clear_oneshot_mods();
|
|
}
|
|
|
|
#if defined(ONESHOT_TIMEOUT)
|
|
|
|
TEST_P(OneShotParametrizedTestFixture, OSMExpiredDoesNothing) {
|
|
TestDriver driver;
|
|
KeymapKey osm_key = GetParam().first;
|
|
KeymapKey regular_key = GetParam().second;
|
|
|
|
set_keymap({osm_key, regular_key});
|
|
|
|
/* Press and release OSM */
|
|
EXPECT_NO_REPORT(driver);
|
|
osm_key.press();
|
|
run_one_scan_loop();
|
|
osm_key.release();
|
|
idle_for(ONESHOT_TIMEOUT);
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
/* Press regular key */
|
|
EXPECT_REPORT(driver, (regular_key.report_code)).Times(1);
|
|
regular_key.press();
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
/* Release regular key */
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
regular_key.release();
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
}
|
|
|
|
#endif
|
|
|
|
TEST_P(OneShotParametrizedTestFixture, OSMWithAdditionalKeypress) {
|
|
TestDriver driver;
|
|
KeymapKey osm_key = GetParam().first;
|
|
KeymapKey regular_key = GetParam().second;
|
|
|
|
set_keymap({osm_key, regular_key});
|
|
|
|
/* Press and release OSM */
|
|
EXPECT_NO_REPORT(driver);
|
|
osm_key.press();
|
|
run_one_scan_loop();
|
|
osm_key.release();
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
/* Press regular key */
|
|
EXPECT_REPORT(driver, (osm_key.report_code, regular_key.report_code)).Times(1);
|
|
regular_key.press();
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
/* Release regular key */
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
regular_key.release();
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
}
|
|
|
|
TEST_P(OneShotParametrizedTestFixture, OSMAsRegularModifierWithAdditionalKeypress) {
|
|
TestDriver driver;
|
|
testing::InSequence s;
|
|
|
|
KeymapKey osm_key = GetParam().first;
|
|
KeymapKey regular_key = GetParam().second;
|
|
|
|
set_keymap({osm_key, regular_key});
|
|
|
|
/* Press OSM */
|
|
EXPECT_NO_REPORT(driver);
|
|
osm_key.press();
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
/* Press regular key */
|
|
EXPECT_NO_REPORT(driver);
|
|
regular_key.press();
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
/* Release regular key */
|
|
EXPECT_NO_REPORT(driver);
|
|
regular_key.release();
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
/* Release OSM */
|
|
EXPECT_REPORT(driver, (regular_key.report_code, osm_key.report_code)).Times(1);
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
osm_key.release();
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
}
|
|
|
|
// clang-format off
|
|
|
|
INSTANTIATE_TEST_CASE_P(
|
|
OneShotModifierTests,
|
|
OneShotParametrizedTestFixture,
|
|
::testing::Values(
|
|
/* first is osm key, second is regular key. */
|
|
std::make_pair(KeymapKey{0, 0, 0, OSM(MOD_LSFT), KC_LSFT}, KeymapKey{0, 1, 1, KC_A}),
|
|
std::make_pair(KeymapKey{0, 0, 0, OSM(MOD_LCTL), KC_LCTL}, KeymapKey{0, 1, 1, KC_A}),
|
|
std::make_pair(KeymapKey{0, 0, 0, OSM(MOD_LALT), KC_LALT}, KeymapKey{0, 1, 1, KC_A}),
|
|
std::make_pair(KeymapKey{0, 0, 0, OSM(MOD_LGUI), KC_LGUI}, KeymapKey{0, 1, 1, KC_A}),
|
|
std::make_pair(KeymapKey{0, 0, 0, OSM(MOD_RCTL), KC_RCTL}, KeymapKey{0, 1, 1, KC_A}),
|
|
std::make_pair(KeymapKey{0, 0, 0, OSM(MOD_RSFT), KC_RSFT}, KeymapKey{0, 1, 1, KC_A}),
|
|
std::make_pair(KeymapKey{0, 0, 0, OSM(MOD_RALT), KC_RALT}, KeymapKey{0, 1, 1, KC_A}),
|
|
std::make_pair(KeymapKey{0, 0, 0, OSM(MOD_RGUI), KC_RGUI}, KeymapKey{0, 1, 1, KC_A})
|
|
));
|
|
// clang-format on
|
|
|
|
TEST_F(OneShot, OSLWithAdditionalKeypress) {
|
|
TestDriver driver;
|
|
InSequence s;
|
|
KeymapKey osl_key = KeymapKey{0, 0, 0, OSL(1)};
|
|
KeymapKey regular_key = KeymapKey{1, 1, 0, KC_A};
|
|
|
|
set_keymap({osl_key, regular_key});
|
|
|
|
/* Press OSL key */
|
|
EXPECT_NO_REPORT(driver);
|
|
osl_key.press();
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
/* Release OSL key */
|
|
EXPECT_NO_REPORT(driver);
|
|
osl_key.release();
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
/* Press regular key */
|
|
EXPECT_REPORT(driver, (regular_key.report_code)).Times(1);
|
|
EXPECT_EMPTY_REPORT(driver);
|
|
regular_key.press();
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
|
|
/* Release regular key */
|
|
EXPECT_NO_REPORT(driver);
|
|
regular_key.release();
|
|
run_one_scan_loop();
|
|
testing::Mock::VerifyAndClearExpectations(&driver);
|
|
}
|