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>
65 lines
1.9 KiB
C++
65 lines
1.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/>.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <cstdint>
|
|
#include <unordered_map>
|
|
#include <optional>
|
|
#include "gtest/gtest.h"
|
|
#include "keyboard.h"
|
|
#include "test_keymap_key.hpp"
|
|
|
|
class TestFixture : public testing::Test {
|
|
public:
|
|
static TestFixture* m_this;
|
|
|
|
TestFixture();
|
|
~TestFixture();
|
|
static void SetUpTestCase();
|
|
static void TearDownTestCase();
|
|
|
|
void set_keymap(std::initializer_list<KeymapKey> keycodes);
|
|
void add_key(const KeymapKey key);
|
|
|
|
const KeymapKey* find_key(const layer_t layer_t, const keypos_t position) const;
|
|
void get_keycode(const layer_t layer, const keypos_t position, uint16_t* result) const;
|
|
|
|
/**
|
|
* @brief Taps `key` with `delay_ms` delay between press and release.
|
|
*/
|
|
void tap_key(KeymapKey key, unsigned delay_ms = 1);
|
|
|
|
/**
|
|
* @brief Taps multiple KeymapKey keys in order, e.g. `tap_keys(key_a, key_b)`.
|
|
*/
|
|
template <typename... Ts>
|
|
void tap_keys(Ts... keys) {
|
|
for (KeymapKey key : {keys...}) {
|
|
tap_key(key);
|
|
}
|
|
}
|
|
|
|
void run_one_scan_loop();
|
|
void idle_for(unsigned ms);
|
|
|
|
void expect_layer_state(layer_t layer) const;
|
|
|
|
protected:
|
|
void print_test_log() const;
|
|
std::vector<KeymapKey> keymap;
|
|
};
|