aboutsummaryrefslogtreecommitdiff
path: root/tests/basic
diff options
context:
space:
mode:
authorStefan Kerkmann <karlk90@pm.me>2021-11-23 03:31:01 +0100
committerGitHub <noreply@github.com>2021-11-23 13:31:01 +1100
commita24bdccee0580d1263733bc7e66e4e4f97713f19 (patch)
tree868cb12a436a87b39c936292f442bcc266ae0224 /tests/basic
parente20bc76a1e05d02c15a452e51fa76d9ec39b0369 (diff)
downloadqmk_firmware-a24bdccee0580d1263733bc7e66e4e4f97713f19.tar.gz
qmk_firmware-a24bdccee0580d1263733bc7e66e4e4f97713f19.zip
[Tests] Increase QMK test coverage take 2 (#15269)
* Add per-test keymaps * Add better trace and info logs for failed unit-tests * Add layer state assertion with tracing message * Use individual test binaries configuration options * Add basic qmk functionality tests * Add tap hold configurations tests * Add auto shift tests Co-authored-by: Nick Brassel <nick@tzarc.org>
Diffstat (limited to 'tests/basic')
-rw-r--r--tests/basic/config.h3
-rw-r--r--tests/basic/keymap.c45
-rw-r--r--tests/basic/test.mk (renamed from tests/basic/rules.mk)4
-rw-r--r--tests/basic/test_action_layer.cpp427
-rw-r--r--tests/basic/test_keypress.cpp213
-rw-r--r--tests/basic/test_macro.cpp19
-rw-r--r--tests/basic/test_one_shot_keys.cpp197
-rw-r--r--tests/basic/test_tapping.cpp50
8 files changed, 776 insertions, 182 deletions
diff --git a/tests/basic/config.h b/tests/basic/config.h
index 99bd62d99..85fa9d691 100644
--- a/tests/basic/config.h
+++ b/tests/basic/config.h
@@ -16,5 +16,4 @@
16 16
17#pragma once 17#pragma once
18 18
19#define MATRIX_ROWS 4 19#include "test_common.h" \ No newline at end of file
20#define MATRIX_COLS 10
diff --git a/tests/basic/keymap.c b/tests/basic/keymap.c
deleted file mode 100644
index 2b5747abb..000000000
--- a/tests/basic/keymap.c
+++ /dev/null
@@ -1,45 +0,0 @@
1/* Copyright 2017 Fred Sundvik
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17#include "quantum.h"
18
19// Don't rearrange keys as existing tests might rely on the order
20// Col2, Row 0 has to be KC_NO, because tests rely on it
21
22#define COMBO1 RSFT(LCTL(KC_O))
23
24const uint16_t PROGMEM
25 keymaps[][MATRIX_ROWS][MATRIX_COLS] =
26 {
27 [0] =
28 {
29 // 0 1 2 3 4 5 6 7 8 9
30 {KC_A, KC_B, KC_NO, KC_LSFT, KC_RSFT, KC_LCTL, COMBO1, SFT_T(KC_P), M(0), KC_NO},
31 {KC_EQL, KC_PLUS, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO},
32 {KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO},
33 {KC_C, KC_D, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO},
34 },
35};
36
37const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
38 if (record->event.pressed) {
39 switch (id) {
40 case 0:
41 return MACRO(D(LSFT), T(H), U(LSFT), T(E), T(L), T(L), T(O), T(SPACE), W(100), D(LSFT), T(W), U(LSFT), I(10), T(O), T(R), T(L), T(D), D(LSFT), T(1), U(LSFT), END);
42 }
43 }
44 return MACRO_NONE;
45};
diff --git a/tests/basic/rules.mk b/tests/basic/test.mk
index 9fb5d4361..29690d1ad 100644
--- a/tests/basic/rules.mk
+++ b/tests/basic/test.mk
@@ -13,4 +13,6 @@
13# You should have received a copy of the GNU General Public License 13# You should have received a copy of the GNU General Public License
14# along with this program. If not, see <http://www.gnu.org/licenses/>. 14# along with this program. If not, see <http://www.gnu.org/licenses/>.
15 15
16CUSTOM_MATRIX=yes 16# --------------------------------------------------------------------------------
17# Keep this file, even if it is empty, as a marker that this folder contains tests
18# -------------------------------------------------------------------------------- \ No newline at end of file
diff --git a/tests/basic/test_action_layer.cpp b/tests/basic/test_action_layer.cpp
index d00a0859b..1b12d1364 100644
--- a/tests/basic/test_action_layer.cpp
+++ b/tests/basic/test_action_layer.cpp
@@ -14,39 +14,54 @@
14 * along with this program. If not, see <http://www.gnu.org/licenses/>. 14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */ 15 */
16 16
17#include "gtest/gtest.h"
18#include "keyboard_report_util.hpp"
17#include "test_common.hpp" 19#include "test_common.hpp"
18 20
19using testing::_; 21using testing::_;
20using testing::Return; 22using testing::InSequence;
21 23
22class ActionLayer : public TestFixture {}; 24class ActionLayer : public TestFixture {};
23 25
24// TEST_F(ActionLayer, LayerStateDBG) { 26TEST_F(ActionLayer, LayerStateDBG) {
25// layer_state_set(0); 27 TestDriver driver;
26// } 28
27 29 layer_state_set(0);
28// TEST_F(ActionLayer, LayerStateSet) { 30
29// layer_state_set(0); 31 testing::Mock::VerifyAndClearExpectations(&driver);
30// EXPECT_EQ(layer_state, 0); 32}
31// layer_state_set(0b001100); 33
32// EXPECT_EQ(layer_state, 0b001100); 34TEST_F(ActionLayer, LayerStateSet) {
33// } 35 TestDriver driver;
34 36
35// TEST_F(ActionLayer, LayerStateIs) { 37 layer_state_set(0);
36// layer_state_set(0); 38 EXPECT_EQ(layer_state, 0);
37// EXPECT_EQ(layer_state_is(0), true); 39 layer_state_set(0b001100);
38// EXPECT_EQ(layer_state_is(1), true); 40 EXPECT_EQ(layer_state, 0b001100);
39// layer_state_set(1); 41
40// EXPECT_EQ(layer_state_is(0), true); 42 testing::Mock::VerifyAndClearExpectations(&driver);
41// EXPECT_EQ(layer_state_is(1), true); 43}
42// layer_state_set(2); 44
43// EXPECT_EQ(layer_state_is(0), false); 45TEST_F(ActionLayer, LayerStateIs) {
44// EXPECT_EQ(layer_state_is(1), false); 46 TestDriver driver;
45// EXPECT_EQ(layer_state_is(2), true); 47
46// } 48 layer_state_set(0);
49 EXPECT_EQ(layer_state_is(0), true);
50 EXPECT_EQ(layer_state_is(1), false);
51 layer_state_set(1);
52 EXPECT_EQ(layer_state_is(0), true);
53 EXPECT_EQ(layer_state_is(1), false);
54 layer_state_set(2);
55 EXPECT_EQ(layer_state_is(0), false);
56 EXPECT_EQ(layer_state_is(1), true);
57 EXPECT_EQ(layer_state_is(2), false);
58
59 testing::Mock::VerifyAndClearExpectations(&driver);
60}
47 61
48TEST_F(ActionLayer, LayerStateCmp) { 62TEST_F(ActionLayer, LayerStateCmp) {
49 uint32_t prev_layer; 63 TestDriver driver;
64 uint32_t prev_layer;
50 65
51 prev_layer = 0; 66 prev_layer = 0;
52 EXPECT_EQ(layer_state_cmp(prev_layer, 0), true); 67 EXPECT_EQ(layer_state_cmp(prev_layer, 0), true);
@@ -60,33 +75,339 @@ TEST_F(ActionLayer, LayerStateCmp) {
60 EXPECT_EQ(layer_state_cmp(prev_layer, 0), false); 75 EXPECT_EQ(layer_state_cmp(prev_layer, 0), false);
61 EXPECT_EQ(layer_state_cmp(prev_layer, 1), true); 76 EXPECT_EQ(layer_state_cmp(prev_layer, 1), true);
62 EXPECT_EQ(layer_state_cmp(prev_layer, 2), false); 77 EXPECT_EQ(layer_state_cmp(prev_layer, 2), false);
78
79 testing::Mock::VerifyAndClearExpectations(&driver);
80}
81
82TEST_F(ActionLayer, LayerClear) {
83 TestDriver driver;
84
85 layer_clear();
86 EXPECT_EQ(layer_state, 0);
87
88 testing::Mock::VerifyAndClearExpectations(&driver);
89}
90
91TEST_F(ActionLayer, LayerMove) {
92 TestDriver driver;
93
94 layer_move(0);
95 EXPECT_EQ(layer_state, 1);
96 layer_move(3);
97 EXPECT_EQ(layer_state, 0b1000);
98
99 testing::Mock::VerifyAndClearExpectations(&driver);
100}
101
102TEST_F(ActionLayer, LayerOn) {
103 TestDriver driver;
104
105 layer_clear();
106 layer_on(1);
107 layer_on(3);
108 layer_on(3);
109 EXPECT_EQ(layer_state, 0b1010);
110
111 testing::Mock::VerifyAndClearExpectations(&driver);
112}
113
114TEST_F(ActionLayer, LayerOff) {
115 TestDriver driver;
116
117 layer_clear();
118 layer_on(1);
119 layer_on(3);
120 layer_off(3);
121 layer_off(2);
122 EXPECT_EQ(layer_state, 0b0010);
123
124 testing::Mock::VerifyAndClearExpectations(&driver);
125}
126
127TEST_F(ActionLayer, MomentaryLayerDoesNothing) {
128 TestDriver driver;
129 KeymapKey layer_key = KeymapKey{0, 0, 0, MO(1)};
130
131 set_keymap({layer_key});
132
133 /* Press and release MO, nothing should happen. */
134 /* TODO: QMK currently sends an empty report even if nothing needs to be reported to the host! */
135 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(1);
136 layer_key.press();
137 run_one_scan_loop();
138 testing::Mock::VerifyAndClearExpectations(&driver);
139
140 /* TODO: QMK currently sends an empty report even if nothing needs to be reported to the host! */
141 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(1);
142 layer_key.release();
143 run_one_scan_loop();
144 testing::Mock::VerifyAndClearExpectations(&driver);
145}
146
147TEST_F(ActionLayer, MomentaryLayerWithKeypress) {
148 TestDriver driver;
149 KeymapKey layer_key = KeymapKey{0, 0, 0, MO(1)};
150
151 /* These keys must have the same position in the matrix, only the layer is different. */
152 KeymapKey regular_key = KeymapKey{0, 1, 0, KC_A};
153 set_keymap({layer_key, regular_key, KeymapKey{1, 1, 0, KC_B}});
154
155 /* Press MO. */
156 /* TODO: QMK currently sends an empty report even if nothing needs to be reported to the host! */
157 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(1);
158 layer_key.press();
159 run_one_scan_loop();
160 EXPECT_TRUE(layer_state_is(1));
161 testing::Mock::VerifyAndClearExpectations(&driver);
162
163 /* Press key on layer 1 */
164 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_B))).Times(1);
165 regular_key.press();
166 run_one_scan_loop();
167 EXPECT_TRUE(layer_state_is(1));
168 testing::Mock::VerifyAndClearExpectations(&driver);
169
170 /* Release key on layer 1 */
171 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(1);
172 regular_key.release();
173 run_one_scan_loop();
174 EXPECT_TRUE(layer_state_is(1));
175 testing::Mock::VerifyAndClearExpectations(&driver);
176
177 /* Release MO */
178 /* TODO: QMK currently sends an empty report even if nothing needs to be reported to the host! */
179 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(1);
180 layer_key.release();
181 run_one_scan_loop();
182 EXPECT_TRUE(layer_state_is(0));
183 testing::Mock::VerifyAndClearExpectations(&driver);
184}
185
186TEST_F(ActionLayer, ToggleLayerDoesNothing) {
187 GTEST_SKIP() << "TODO: Toggle layer does not activate the expected layer on key press but on release.";
188
189 TestDriver driver;
190 KeymapKey layer_key = KeymapKey{0, 0, 0, TG(1)};
191
192 set_keymap({layer_key});
193
194 /* Press TG. Layer state should not change as it's applied on release. */
195 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
196 layer_key.press();
197 run_one_scan_loop();
198 EXPECT_TRUE(layer_state_is(1));
199 testing::Mock::VerifyAndClearExpectations(&driver);
200
201 /* Release TG. */
202 /* TODO: QMK currently sends an empty report even if nothing needs to be reported to the host! */
203 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(1);
204 layer_key.release();
205 run_one_scan_loop();
206 EXPECT_TRUE(layer_state_is(1));
207 testing::Mock::VerifyAndClearExpectations(&driver);
208}
209
210TEST_F(ActionLayer, ToggleLayerUpAndDown) {
211 GTEST_SKIP() << "TODO: Toggle layer does not activate the expected layer on key press but on release.";
212
213 TestDriver driver;
214 KeymapKey toggle_layer_1_on_layer_0 = KeymapKey{0, 0, 0, TG(1)};
215 KeymapKey toggle_layer_0_on_layer_1 = KeymapKey{1, 1, 0, TG(0)};
216
217 set_keymap({toggle_layer_1_on_layer_0, toggle_layer_0_on_layer_1});
218
219 /* Toggle Layer 1. */
220 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
221 toggle_layer_1_on_layer_0.press();
222 run_one_scan_loop();
223 EXPECT_TRUE(layer_state_is(1));
224 testing::Mock::VerifyAndClearExpectations(&driver);
225
226 /* TODO: QMK currently sends an empty report even if nothing needs to be reported to the host! */
227 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(1);
228 toggle_layer_1_on_layer_0.release();
229 run_one_scan_loop();
230 EXPECT_TRUE(layer_state_is(1));
231 testing::Mock::VerifyAndClearExpectations(&driver);
232
233 /* Toggle Layer 0. */
234 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
235 toggle_layer_0_on_layer_1.press();
236 run_one_scan_loop();
237 EXPECT_TRUE(layer_state_is(0));
238 testing::Mock::VerifyAndClearExpectations(&driver);
239
240 /* TODO: QMK currently sends an empty report even if nothing needs to be reported to the host! */
241 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(1);
242 toggle_layer_0_on_layer_1.release();
243 run_one_scan_loop();
244 EXPECT_TRUE(layer_state_is(0));
245 testing::Mock::VerifyAndClearExpectations(&driver);
246}
247
248TEST_F(ActionLayer, LayerTapToggleDoesNothing) {
249 GTEST_SKIP() << "TODO: Tap toggle layer does not activate the expected layer on key press.";
250
251 TestDriver driver;
252 KeymapKey layer_key = KeymapKey{0, 0, 0, TT(1)};
253
254 set_keymap({layer_key});
255
256 /* Press and release TT. */
257 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(0);
258 layer_key.press();
259 run_one_scan_loop();
260 EXPECT_TRUE(layer_state_is(1));
261 testing::Mock::VerifyAndClearExpectations(&driver);
262
263 /* TODO: QMK currently sends an empty report even if nothing needs to be reported to the host! */
264 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(2);
265 layer_key.release();
266 run_one_scan_loop();
267 EXPECT_TRUE(layer_state_is(0));
268 testing::Mock::VerifyAndClearExpectations(&driver);
269}
270
271TEST_F(ActionLayer, LayerTapToggleWithKeypress) {
272 GTEST_SKIP() << "TODO: Tap toggle layer does not activate the expected layer on key press.";
273
274 TestDriver driver;
275 KeymapKey layer_key = KeymapKey{0, 0, 0, TT(1)};
276
277 /* These keys must have the same position in the matrix, only the layer is different. */
278 KeymapKey regular_key = KeymapKey{0, 1, 0, KC_A};
279 set_keymap({layer_key, regular_key, KeymapKey{1, 1, 0, KC_B}});
280
281 /* Press TT. */
282 /* TODO: QMK currently sends an empty report even if nothing needs to be reported to the host! */
283 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(0);
284 layer_key.press();
285 run_one_scan_loop();
286 EXPECT_TRUE(layer_state_is(1));
287 testing::Mock::VerifyAndClearExpectations(&driver);
288
289 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_B))).Times(1);
290 regular_key.press();
291 run_one_scan_loop();
292 EXPECT_TRUE(layer_state_is(1));
293 testing::Mock::VerifyAndClearExpectations(&driver);
294
295 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(1);
296 regular_key.release();
297 run_one_scan_loop();
298 EXPECT_TRUE(layer_state_is(1));
299 testing::Mock::VerifyAndClearExpectations(&driver);
300
301 /* TODO: QMK currently sends an empty report even if nothing needs to be reported to the host! */
302 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(1);
303 layer_key.release();
304 run_one_scan_loop();
305 EXPECT_TRUE(layer_state_is(0));
306 testing::Mock::VerifyAndClearExpectations(&driver);
307}
308
309TEST_F(ActionLayer, LayerTapToggleWithToggleWithKeypress) {
310 GTEST_SKIP() << "TODO: Tap toggle layer does not activate the expected layer on key press.";
311
312 TestDriver driver;
313 KeymapKey layer_key = KeymapKey{0, 0, 0, TT(1)};
314
315 /* These keys must have the same position in the matrix, only the layer is different. */
316 KeymapKey regular_key = KeymapKey{0, 1, 0, KC_A};
317 set_keymap({layer_key, regular_key, KeymapKey{1, 1, 0, KC_B}});
318
319 /* Tap TT five times . */
320 /* TODO: QMK currently sends an empty report even if nothing needs to be reported to the host! */
321 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(9);
322
323 layer_key.press();
324 run_one_scan_loop();
325 EXPECT_TRUE(layer_state_is(1));
326 layer_key.release();
327 run_one_scan_loop();
328 EXPECT_TRUE(layer_state_is(0));
329
330 layer_key.press();
331 run_one_scan_loop();
332 EXPECT_TRUE(layer_state_is(1));
333 layer_key.release();
334 run_one_scan_loop();
335 EXPECT_TRUE(layer_state_is(0));
336
337 layer_key.press();
338 run_one_scan_loop();
339 EXPECT_TRUE(layer_state_is(1));
340 layer_key.release();
341 run_one_scan_loop();
342 EXPECT_TRUE(layer_state_is(0));
343
344 layer_key.press();
345 run_one_scan_loop();
346 EXPECT_TRUE(layer_state_is(1));
347 layer_key.release();
348 run_one_scan_loop();
349 EXPECT_TRUE(layer_state_is(0));
350
351 layer_key.press();
352 run_one_scan_loop();
353 EXPECT_TRUE(layer_state_is(1));
354 layer_key.release();
355 run_one_scan_loop();
356 EXPECT_TRUE(layer_state_is(1));
357
358 testing::Mock::VerifyAndClearExpectations(&driver);
359
360 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_B))).Times(1);
361 regular_key.press();
362 run_one_scan_loop();
363 EXPECT_TRUE(layer_state_is(1));
364 testing::Mock::VerifyAndClearExpectations(&driver);
365
366 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(1);
367 regular_key.release();
368 run_one_scan_loop();
369 EXPECT_TRUE(layer_state_is(1));
370 testing::Mock::VerifyAndClearExpectations(&driver);
63} 371}
64 372
65// TEST_F(ActionLayer, LayerClear) { 373TEST_F(ActionLayer, LayerTapReleasedBeforeKeypressReleaseWithModifiers) {
66// layer_clear(); 374 GTEST_SKIP() << "TODO: Modifiers are erroneously discarded on layer changes, although a key that introduced the modifier is still held.";
67// EXPECT_EQ(layer_state, 0); 375 TestDriver driver;
68// } 376 InSequence s;
69 377
70// TEST_F(ActionLayer, LayerMove) { 378 KeymapKey layer_0_key_0 = KeymapKey{0, 0, 0, LT(1, KC_T)};
71// layer_move(0); 379 KeymapKey layer_1_key_1 = KeymapKey{1, 1, 0, RALT(KC_9)};
72// EXPECT_EQ(layer_state, 1); 380
73// layer_move(3); 381 set_keymap({layer_0_key_0, layer_1_key_1});
74// EXPECT_EQ(layer_state, 0b1000); 382
75// } 383 /* Press layer tap and wait for tapping term to switch to layer 1 */
76 384 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(0);
77// TEST_F(ActionLayer, LayerOn) { 385 layer_0_key_0.press();
78// layer_clear(); 386 idle_for(TAPPING_TERM);
79// layer_on(1); 387 EXPECT_TRUE(layer_state_is(0));
80// layer_on(3); 388 testing::Mock::VerifyAndClearExpectations(&driver);
81// layer_on(3); 389
82// EXPECT_EQ(layer_state, 0b1010); 390 /* Press key with layer 1 mapping, result basically expected
83// } 391 * altough more reports are send then necessary. */
84 392 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_RALT))).Times(1);
85// TEST_F(ActionLayer, LayerOff) { 393 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_RALT, KC_9))).Times(1);
86// layer_clear(); 394 layer_1_key_1.press();
87// layer_on(1); 395 run_one_scan_loop();
88// layer_on(3); 396 EXPECT_TRUE(layer_state_is(1));
89// layer_off(3); 397 testing::Mock::VerifyAndClearExpectations(&driver);
90// layer_off(2); 398
91// EXPECT_EQ(layer_state, 0b1000); 399 /* Release layer tap key, no report is send because key is still held. */
92// } 400 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
401 layer_0_key_0.release();
402 run_one_scan_loop();
403 EXPECT_TRUE(layer_state_is(0));
404 testing::Mock::VerifyAndClearExpectations(&driver);
405
406 /* Unregister keycode and modifier. */
407 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_RALT))).Times(1);
408 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(1);
409 layer_1_key_1.release();
410 run_one_scan_loop();
411 EXPECT_TRUE(layer_state_is(0));
412 testing::Mock::VerifyAndClearExpectations(&driver);
413}
diff --git a/tests/basic/test_keypress.cpp b/tests/basic/test_keypress.cpp
index cf839f8c1..1c175c9d5 100644
--- a/tests/basic/test_keypress.cpp
+++ b/tests/basic/test_keypress.cpp
@@ -14,11 +14,11 @@
14 * along with this program. If not, see <http://www.gnu.org/licenses/>. 14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */ 15 */
16 16
17#include "keycode.h"
17#include "test_common.hpp" 18#include "test_common.hpp"
18 19
19using testing::_; 20using testing::_;
20using testing::InSequence; 21using testing::InSequence;
21using testing::Return;
22 22
23class KeyPress : public TestFixture {}; 23class KeyPress : public TestFixture {};
24 24
@@ -30,96 +30,157 @@ TEST_F(KeyPress, SendKeyboardIsNotCalledWhenNoKeyIsPressed) {
30 30
31TEST_F(KeyPress, CorrectKeyIsReportedWhenPressed) { 31TEST_F(KeyPress, CorrectKeyIsReportedWhenPressed) {
32 TestDriver driver; 32 TestDriver driver;
33 press_key(0, 0); 33 auto key = KeymapKey(0, 0, 0, KC_A);
34 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_A))); 34
35 set_keymap({key});
36
37 key.press();
38 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key.report_code)));
35 keyboard_task(); 39 keyboard_task();
36 release_key(0, 0); 40
41 key.release();
37 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())); 42 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
38 keyboard_task(); 43 keyboard_task();
39} 44}
40 45
46TEST_F(KeyPress, ANonMappedKeyDoesNothing) {
47 TestDriver driver;
48 auto key = KeymapKey(0, 0, 0, KC_NO);
49
50 set_keymap({key});
51
52 key.press();
53 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
54 keyboard_task();
55 keyboard_task();
56}
57
41TEST_F(KeyPress, CorrectKeysAreReportedWhenTwoKeysArePressed) { 58TEST_F(KeyPress, CorrectKeysAreReportedWhenTwoKeysArePressed) {
42 TestDriver driver; 59 TestDriver driver;
43 press_key(1, 0); 60 auto key_b = KeymapKey(0, 0, 0, KC_B);
44 press_key(0, 3); 61 auto key_c = KeymapKey(0, 1, 1, KC_C);
62
63 set_keymap({key_b, key_c});
64
65 key_b.press();
66 key_c.press();
45 // Note that QMK only processes one key at a time 67 // Note that QMK only processes one key at a time
46 // See issue #1476 for more information 68 // See issue #1476 for more information
47 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_B))); 69 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_b.report_code)));
48 keyboard_task(); 70 keyboard_task();
49 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_B, KC_C))); 71
72 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_b.report_code, key_c.report_code)));
50 keyboard_task(); 73 keyboard_task();
51 release_key(1, 0); 74
52 release_key(0, 3); 75 key_b.release();
76 key_c.release();
53 // Note that the first key released is the first one in the matrix order 77 // Note that the first key released is the first one in the matrix order
54 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_C))); 78 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_c.report_code)));
55 keyboard_task();
56 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
57 keyboard_task(); 79 keyboard_task();
58}
59 80
60TEST_F(KeyPress, ANonMappedKeyDoesNothing) { 81 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
61 TestDriver driver;
62 press_key(2, 0);
63 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
64 keyboard_task();
65 keyboard_task(); 82 keyboard_task();
66} 83}
67 84
68TEST_F(KeyPress, LeftShiftIsReportedCorrectly) { 85TEST_F(KeyPress, LeftShiftIsReportedCorrectly) {
69 TestDriver driver; 86 TestDriver driver;
70 press_key(3, 0); 87 auto key_a = KeymapKey(0, 0, 0, KC_A);
71 press_key(0, 0); 88 auto key_lsft = KeymapKey(0, 3, 0, KC_LSFT);
89
90 set_keymap({key_a, key_lsft});
91
92 key_lsft.press();
93 key_a.press();
94
72 // Unfortunately modifiers are also processed in the wrong order 95 // Unfortunately modifiers are also processed in the wrong order
73 // See issue #1476 for more information 96 // See issue #1476 for more information
74 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_A))); 97 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_a.report_code)));
75 keyboard_task(); 98 keyboard_task();
76 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_A, KC_LEFT_SHIFT))); 99 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_a.report_code, key_lsft.report_code)));
77 keyboard_task(); 100 keyboard_task();
78 release_key(0, 0); 101
79 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))); 102 key_a.release();
103 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_lsft.report_code)));
80 keyboard_task(); 104 keyboard_task();
81 release_key(3, 0); 105
106 key_lsft.release();
82 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())); 107 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
83 keyboard_task(); 108 keyboard_task();
84} 109}
85 110
86TEST_F(KeyPress, PressLeftShiftAndControl) { 111TEST_F(KeyPress, PressLeftShiftAndControl) {
87 TestDriver driver; 112 TestDriver driver;
88 press_key(3, 0); 113 auto key_lsft = KeymapKey(0, 3, 0, KC_LSFT);
89 press_key(5, 0); 114 auto key_lctrl = KeymapKey(0, 5, 0, KC_LCTRL);
115
116 set_keymap({key_lctrl, key_lsft});
117
118 key_lsft.press();
119 key_lctrl.press();
120
90 // Unfortunately modifiers are also processed in the wrong order 121 // Unfortunately modifiers are also processed in the wrong order
91 // See issue #1476 for more information 122 // See issue #1476 for more information
92 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))); 123 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_lsft.report_code)));
124 keyboard_task();
125
126 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_lsft.report_code, key_lctrl.report_code)));
93 keyboard_task(); 127 keyboard_task();
94 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT, KC_LEFT_CTRL))); 128
129 key_lsft.release();
130 key_lctrl.release();
131
132 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_lctrl.report_code)));
133 keyboard_task();
134
135 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
95 keyboard_task(); 136 keyboard_task();
96} 137}
97 138
98TEST_F(KeyPress, LeftAndRightShiftCanBePressedAtTheSameTime) { 139TEST_F(KeyPress, LeftAndRightShiftCanBePressedAtTheSameTime) {
99 TestDriver driver; 140 TestDriver driver;
100 press_key(3, 0); 141 auto key_lsft = KeymapKey(0, 3, 0, KC_LSFT);
101 press_key(4, 0); 142 auto key_rsft = KeymapKey(0, 4, 0, KC_RSFT);
143
144 set_keymap({key_rsft, key_lsft});
145
146 key_lsft.press();
147 key_rsft.press();
102 // Unfortunately modifiers are also processed in the wrong order 148 // Unfortunately modifiers are also processed in the wrong order
103 // See issue #1476 for more information 149 // See issue #1476 for more information
104 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))); 150 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_lsft.report_code)));
105 keyboard_task(); 151 keyboard_task();
106 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT, KC_RIGHT_SHIFT))); 152
153 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_lsft.report_code, key_rsft.report_code)));
154 keyboard_task();
155
156 key_lsft.release();
157 key_rsft.release();
158
159 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_rsft.report_code)));
160 keyboard_task();
161
162 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
107 keyboard_task(); 163 keyboard_task();
108} 164}
109 165
110TEST_F(KeyPress, RightShiftLeftControlAndCharWithTheSameKey) { 166TEST_F(KeyPress, RightShiftLeftControlAndCharWithTheSameKey) {
111 TestDriver driver; 167 TestDriver driver;
112 press_key(6, 0); 168 auto combo_key = KeymapKey(0, 0, 0, RSFT(LCTL(KC_O)));
169
170 set_keymap({combo_key});
171
113 // BUG: The press is split into two reports 172 // BUG: The press is split into two reports
114 // BUG: It reports RSFT instead of LSFT 173 // BUG: It reports RSFT instead of LSFT
115 // See issue #524 for more information 174 // See issue #524 for more information
116 // The underlying cause is that we use only one bit to represent the right hand 175 // The underlying cause is that we use only one bit to represent the right hand
117 // modifiers. 176 // modifiers.
118 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_RIGHT_SHIFT, KC_RIGHT_CTRL))); 177 combo_key.press();
119 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_RIGHT_SHIFT, KC_RIGHT_CTRL, KC_O))); 178 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_RSFT, KC_RCTRL)));
179 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_RSFT, KC_RCTRL, KC_O)));
120 keyboard_task(); 180 keyboard_task();
121 release_key(6, 0); 181
122 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_RIGHT_SHIFT, KC_RIGHT_CTRL))); 182 combo_key.release();
183 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_RSFT, KC_RCTRL)));
123 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())); 184 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
124 keyboard_task(); 185 keyboard_task();
125} 186}
@@ -127,25 +188,29 @@ TEST_F(KeyPress, RightShiftLeftControlAndCharWithTheSameKey) {
127TEST_F(KeyPress, PressPlusEqualReleaseBeforePress) { 188TEST_F(KeyPress, PressPlusEqualReleaseBeforePress) {
128 TestDriver driver; 189 TestDriver driver;
129 InSequence s; 190 InSequence s;
191 auto key_plus = KeymapKey(0, 1, 1, KC_PLUS);
192 auto key_eql = KeymapKey(0, 0, 1, KC_EQL);
130 193
131 press_key(1, 1); // KC_PLUS 194 set_keymap({key_plus, key_eql});
132 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))); 195
133 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT, KC_EQUAL))); 196 key_plus.press();
197 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
198 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_EQL)));
134 run_one_scan_loop(); 199 run_one_scan_loop();
135 testing::Mock::VerifyAndClearExpectations(&driver); 200 testing::Mock::VerifyAndClearExpectations(&driver);
136 201
137 release_key(1, 1); // KC_PLUS 202 key_plus.release();
138 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))); 203 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
139 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())); 204 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
140 run_one_scan_loop(); 205 run_one_scan_loop();
141 testing::Mock::VerifyAndClearExpectations(&driver); 206 testing::Mock::VerifyAndClearExpectations(&driver);
142 207
143 press_key(0, 1); // KC_EQUAL 208 key_eql.press();
144 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQUAL))); 209 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(key_eql.report_code)));
145 run_one_scan_loop(); 210 run_one_scan_loop();
146 testing::Mock::VerifyAndClearExpectations(&driver); 211 testing::Mock::VerifyAndClearExpectations(&driver);
147 212
148 release_key(0, 1); // KC_EQUAL 213 key_eql.release();
149 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())); 214 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
150 run_one_scan_loop(); 215 run_one_scan_loop();
151 testing::Mock::VerifyAndClearExpectations(&driver); 216 testing::Mock::VerifyAndClearExpectations(&driver);
@@ -154,27 +219,31 @@ TEST_F(KeyPress, PressPlusEqualReleaseBeforePress) {
154TEST_F(KeyPress, PressPlusEqualDontReleaseBeforePress) { 219TEST_F(KeyPress, PressPlusEqualDontReleaseBeforePress) {
155 TestDriver driver; 220 TestDriver driver;
156 InSequence s; 221 InSequence s;
222 auto key_plus = KeymapKey(0, 1, 1, KC_PLUS);
223 auto key_eql = KeymapKey(0, 0, 1, KC_EQL);
157 224
158 press_key(1, 1); // KC_PLUS 225 set_keymap({key_plus, key_eql});
159 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))); 226
160 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT, KC_EQUAL))); 227 key_plus.press();
228 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
229 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_EQL)));
161 run_one_scan_loop(); 230 run_one_scan_loop();
162 testing::Mock::VerifyAndClearExpectations(&driver); 231 testing::Mock::VerifyAndClearExpectations(&driver);
163 232
164 press_key(0, 1); // KC_EQUAL 233 key_eql.press();
165 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())); 234 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
166 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQUAL))); 235 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQUAL)));
167 run_one_scan_loop(); 236 run_one_scan_loop();
168 testing::Mock::VerifyAndClearExpectations(&driver); 237 testing::Mock::VerifyAndClearExpectations(&driver);
169 238
170 release_key(1, 1); // KC_PLUS 239 key_plus.release();
171 // BUG: Should really still return KC_EQUAL, but this is fine too 240 // BUG: Should really still return KC_EQL, but this is fine too
172 // It's also called twice for some reason 241 // It's also called twice for some reason
173 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(2); 242 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(2);
174 run_one_scan_loop(); 243 run_one_scan_loop();
175 testing::Mock::VerifyAndClearExpectations(&driver); 244 testing::Mock::VerifyAndClearExpectations(&driver);
176 245
177 release_key(0, 1); // KC_EQUAL 246 key_eql.release();
178 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())); 247 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
179 run_one_scan_loop(); 248 run_one_scan_loop();
180 testing::Mock::VerifyAndClearExpectations(&driver); 249 testing::Mock::VerifyAndClearExpectations(&driver);
@@ -183,25 +252,29 @@ TEST_F(KeyPress, PressPlusEqualDontReleaseBeforePress) {
183TEST_F(KeyPress, PressEqualPlusReleaseBeforePress) { 252TEST_F(KeyPress, PressEqualPlusReleaseBeforePress) {
184 TestDriver driver; 253 TestDriver driver;
185 InSequence s; 254 InSequence s;
255 auto key_plus = KeymapKey(0, 1, 1, KC_PLUS);
256 auto key_eql = KeymapKey(0, 0, 1, KC_EQL);
186 257
187 press_key(0, 1); // KC_EQUAL 258 set_keymap({key_plus, key_eql});
188 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQUAL))); 259
260 key_eql.press();
261 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQL)));
189 run_one_scan_loop(); 262 run_one_scan_loop();
190 testing::Mock::VerifyAndClearExpectations(&driver); 263 testing::Mock::VerifyAndClearExpectations(&driver);
191 264
192 release_key(0, 1); // KC_EQUAL 265 key_eql.release();
193 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())); 266 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
194 run_one_scan_loop(); 267 run_one_scan_loop();
195 testing::Mock::VerifyAndClearExpectations(&driver); 268 testing::Mock::VerifyAndClearExpectations(&driver);
196 269
197 press_key(1, 1); // KC_PLUS 270 key_plus.press();
198 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))); 271 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
199 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT, KC_EQUAL))); 272 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_EQL)));
200 run_one_scan_loop(); 273 run_one_scan_loop();
201 testing::Mock::VerifyAndClearExpectations(&driver); 274 testing::Mock::VerifyAndClearExpectations(&driver);
202 275
203 release_key(1, 1); // KC_PLUS 276 key_plus.release();
204 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))); 277 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
205 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())); 278 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
206 run_one_scan_loop(); 279 run_one_scan_loop();
207 testing::Mock::VerifyAndClearExpectations(&driver); 280 testing::Mock::VerifyAndClearExpectations(&driver);
@@ -210,13 +283,17 @@ TEST_F(KeyPress, PressEqualPlusReleaseBeforePress) {
210TEST_F(KeyPress, PressEqualPlusDontReleaseBeforePress) { 283TEST_F(KeyPress, PressEqualPlusDontReleaseBeforePress) {
211 TestDriver driver; 284 TestDriver driver;
212 InSequence s; 285 InSequence s;
286 auto key_plus = KeymapKey(0, 1, 1, KC_PLUS);
287 auto key_eql = KeymapKey(0, 0, 1, KC_EQL);
213 288
214 press_key(0, 1); // KC_EQUAL 289 set_keymap({key_plus, key_eql});
215 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQUAL))); 290
291 key_eql.press();
292 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_EQL)));
216 run_one_scan_loop(); 293 run_one_scan_loop();
217 testing::Mock::VerifyAndClearExpectations(&driver); 294 testing::Mock::VerifyAndClearExpectations(&driver);
218 295
219 press_key(1, 1); // KC_PLUS 296 key_plus.press();
220 // BUG: The sequence is a bit strange, but it works, the end result is that 297 // BUG: The sequence is a bit strange, but it works, the end result is that
221 // KC_PLUS is sent 298 // KC_PLUS is sent
222 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT, KC_EQUAL))); 299 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT, KC_EQUAL)));
@@ -225,16 +302,16 @@ TEST_F(KeyPress, PressEqualPlusDontReleaseBeforePress) {
225 run_one_scan_loop(); 302 run_one_scan_loop();
226 testing::Mock::VerifyAndClearExpectations(&driver); 303 testing::Mock::VerifyAndClearExpectations(&driver);
227 304
228 release_key(0, 1); // KC_EQUAL 305 key_eql.release();
229 // I guess it's fine to still report shift here 306 // I guess it's fine to still report shift here
230 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))); 307 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT)));
231 run_one_scan_loop(); 308 run_one_scan_loop();
232 testing::Mock::VerifyAndClearExpectations(&driver); 309 testing::Mock::VerifyAndClearExpectations(&driver);
233 310
234 release_key(1, 1); // KC_PLUS 311 key_plus.release();
235 // This report is not needed 312 // This report is not needed
236 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))); 313 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT)));
237 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())); 314 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
238 run_one_scan_loop(); 315 run_one_scan_loop();
239 testing::Mock::VerifyAndClearExpectations(&driver); 316 testing::Mock::VerifyAndClearExpectations(&driver);
240} 317} \ No newline at end of file
diff --git a/tests/basic/test_macro.cpp b/tests/basic/test_macro.cpp
index 1ac6f473f..ae2f3b32e 100644
--- a/tests/basic/test_macro.cpp
+++ b/tests/basic/test_macro.cpp
@@ -24,10 +24,25 @@ class Macro : public TestFixture {};
24 24
25#define AT_TIME(t) WillOnce(InvokeWithoutArgs([current_time]() { EXPECT_EQ(timer_elapsed32(current_time), t); })) 25#define AT_TIME(t) WillOnce(InvokeWithoutArgs([current_time]() { EXPECT_EQ(timer_elapsed32(current_time), t); }))
26 26
27extern "C" const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
28 if (record->event.pressed) {
29 switch (id) {
30 case 0:
31 return MACRO(D(LSFT), T(H), U(LSFT), T(E), T(L), T(L), T(O), T(SPACE), W(100), D(LSFT), T(W), U(LSFT), I(10), T(O), T(R), T(L), T(D), D(LSFT), T(1), U(LSFT), END);
32 }
33 }
34 return MACRO_NONE;
35};
36
27TEST_F(Macro, PlayASimpleMacro) { 37TEST_F(Macro, PlayASimpleMacro) {
28 TestDriver driver; 38 TestDriver driver;
29 InSequence s; 39 InSequence s;
30 press_key(8, 0); 40 auto key_macro = KeymapKey(0, 8, 0, M(0));
41
42 set_keymap({key_macro});
43
44 key_macro.press();
45
31 uint32_t current_time = timer_read32(); 46 uint32_t current_time = timer_read32();
32 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))).AT_TIME(0); 47 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))).AT_TIME(0);
33 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT, KC_H))).AT_TIME(0); 48 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT, KC_H))).AT_TIME(0);
@@ -68,4 +83,6 @@ TEST_F(Macro, PlayASimpleMacro) {
68 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))).AT_TIME(210); 83 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))).AT_TIME(210);
69 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).AT_TIME(220); 84 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).AT_TIME(220);
70 run_one_scan_loop(); 85 run_one_scan_loop();
86
87 key_macro.release();
71} 88}
diff --git a/tests/basic/test_one_shot_keys.cpp b/tests/basic/test_one_shot_keys.cpp
new file mode 100644
index 000000000..98178912e
--- /dev/null
+++ b/tests/basic/test_one_shot_keys.cpp
@@ -0,0 +1,197 @@
1/* Copyright 2021 Stefan Kerkmann
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17#include "action_util.h"
18#include "keyboard_report_util.hpp"
19#include "test_common.hpp"
20
21using testing::_;
22using testing::InSequence;
23
24class OneShot : public TestFixture {};
25class OneShotParametrizedTestFixture : public ::testing::WithParamInterface<std::pair<KeymapKey, KeymapKey>>, public OneShot {};
26
27TEST_F(OneShot, OSMWithoutAdditionalKeypressDoesNothing) {
28 TestDriver driver;
29 auto osm_key = KeymapKey(0, 0, 0, OSM(MOD_LSFT), KC_LSFT);
30
31 set_keymap({osm_key});
32
33 /* Press and release OSM key*/
34 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
35 osm_key.press();
36 run_one_scan_loop();
37 osm_key.release();
38 run_one_scan_loop();
39 testing::Mock::VerifyAndClearExpectations(&driver);
40
41 /* OSM are added when an actual report is send */
42 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(osm_key.report_code)));
43 send_keyboard_report();
44 testing::Mock::VerifyAndClearExpectations(&driver);
45
46 /* Make unit-test pass */
47 clear_oneshot_mods();
48}
49
50#if defined(ONESHOT_TIMEOUT)
51
52TEST_P(OneShotParametrizedTestFixture, OSMExpiredDoesNothing) {
53 TestDriver driver;
54 KeymapKey osm_key = GetParam().first;
55 KeymapKey regular_key = GetParam().second;
56
57 set_keymap({osm_key, regular_key});
58
59 /* Press and release OSM */
60 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
61 osm_key.press();
62 run_one_scan_loop();
63 osm_key.release();
64 idle_for(ONESHOT_TIMEOUT);
65 testing::Mock::VerifyAndClearExpectations(&driver);
66
67 /* Press regular key */
68 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(regular_key.report_code))).Times(1);
69 regular_key.press();
70 run_one_scan_loop();
71 testing::Mock::VerifyAndClearExpectations(&driver);
72
73 /* Release regular key */
74 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
75 regular_key.release();
76 run_one_scan_loop();
77 testing::Mock::VerifyAndClearExpectations(&driver);
78}
79
80#endif
81
82TEST_P(OneShotParametrizedTestFixture, OSMWithAdditionalKeypress) {
83 TestDriver driver;
84 KeymapKey osm_key = GetParam().first;
85 KeymapKey regular_key = GetParam().second;
86
87 set_keymap({osm_key, regular_key});
88
89 /* Press and release OSM */
90 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
91 osm_key.press();
92 run_one_scan_loop();
93 osm_key.release();
94 run_one_scan_loop();
95 testing::Mock::VerifyAndClearExpectations(&driver);
96
97 /* Press regular key */
98 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(osm_key.report_code, regular_key.report_code))).Times(1);
99 regular_key.press();
100 run_one_scan_loop();
101 testing::Mock::VerifyAndClearExpectations(&driver);
102
103 /* Release regular key */
104 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
105 regular_key.release();
106 run_one_scan_loop();
107 testing::Mock::VerifyAndClearExpectations(&driver);
108}
109
110TEST_P(OneShotParametrizedTestFixture, OSMAsRegularModifierWithAdditionalKeypress) {
111 TestDriver driver;
112 testing::InSequence s;
113
114 KeymapKey osm_key = GetParam().first;
115 KeymapKey regular_key = GetParam().second;
116
117 set_keymap({osm_key, regular_key});
118
119 /* Press OSM */
120 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
121 osm_key.press();
122 run_one_scan_loop();
123 testing::Mock::VerifyAndClearExpectations(&driver);
124
125 /* Press regular key */
126 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
127 regular_key.press();
128 run_one_scan_loop();
129 testing::Mock::VerifyAndClearExpectations(&driver);
130
131 /* Release regular key */
132 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
133 regular_key.release();
134 run_one_scan_loop();
135 testing::Mock::VerifyAndClearExpectations(&driver);
136
137 /* Release OSM */
138 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(regular_key.report_code, osm_key.report_code))).Times(1);
139 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(1);
140 osm_key.release();
141 run_one_scan_loop();
142 testing::Mock::VerifyAndClearExpectations(&driver);
143}
144
145// clang-format off
146
147INSTANTIATE_TEST_CASE_P(
148 OneShotModifierTests,
149 OneShotParametrizedTestFixture,
150 ::testing::Values(
151 /* first is osm key, second is regular key. */
152 std::make_pair(KeymapKey{0, 0, 0, OSM(MOD_LSFT), KC_LSFT}, KeymapKey{0, 1, 1, KC_A}),
153 std::make_pair(KeymapKey{0, 0, 0, OSM(MOD_LCTL), KC_LCTL}, KeymapKey{0, 1, 1, KC_A}),
154 std::make_pair(KeymapKey{0, 0, 0, OSM(MOD_LALT), KC_LALT}, KeymapKey{0, 1, 1, KC_A}),
155 std::make_pair(KeymapKey{0, 0, 0, OSM(MOD_LGUI), KC_LGUI}, KeymapKey{0, 1, 1, KC_A}),
156 std::make_pair(KeymapKey{0, 0, 0, OSM(MOD_RCTL), KC_RCTL}, KeymapKey{0, 1, 1, KC_A}),
157 std::make_pair(KeymapKey{0, 0, 0, OSM(MOD_RSFT), KC_RSFT}, KeymapKey{0, 1, 1, KC_A}),
158 std::make_pair(KeymapKey{0, 0, 0, OSM(MOD_RALT), KC_RALT}, KeymapKey{0, 1, 1, KC_A}),
159 std::make_pair(KeymapKey{0, 0, 0, OSM(MOD_RGUI), KC_RGUI}, KeymapKey{0, 1, 1, KC_A})
160 ));
161// clang-format on
162
163TEST_F(OneShot, OSLWithAdditionalKeypress) {
164 TestDriver driver;
165 InSequence s;
166 KeymapKey osl_key = KeymapKey{0, 0, 0, OSL(1)};
167 KeymapKey regular_key = KeymapKey{1, 1, 0, KC_A};
168
169 set_keymap({osl_key, regular_key});
170
171 /* Press OSL key */
172 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
173 osl_key.press();
174 run_one_scan_loop();
175 testing::Mock::VerifyAndClearExpectations(&driver);
176
177 /* Release OSL key */
178 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())).Times(2);
179 osl_key.release();
180 run_one_scan_loop();
181 testing::Mock::VerifyAndClearExpectations(&driver);
182
183 /* Press regular key */
184 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
185 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(regular_key.report_code))).Times(2);
186 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
187 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
188 regular_key.press();
189 run_one_scan_loop();
190 testing::Mock::VerifyAndClearExpectations(&driver);
191
192 /* Release regular key */
193 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
194 regular_key.release();
195 run_one_scan_loop();
196 testing::Mock::VerifyAndClearExpectations(&driver);
197}
diff --git a/tests/basic/test_tapping.cpp b/tests/basic/test_tapping.cpp
index 88ab97eb6..e4a7e4a9f 100644
--- a/tests/basic/test_tapping.cpp
+++ b/tests/basic/test_tapping.cpp
@@ -14,8 +14,11 @@
14 * along with this program. If not, see <http://www.gnu.org/licenses/>. 14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */ 15 */
16 16
17#include "keyboard_report_util.hpp"
18#include "keycode.h"
17#include "test_common.hpp" 19#include "test_common.hpp"
18#include "action_tapping.h" 20#include "action_tapping.h"
21#include "test_keymap_key.hpp"
19 22
20using testing::_; 23using testing::_;
21using testing::InSequence; 24using testing::InSequence;
@@ -25,14 +28,19 @@ class Tapping : public TestFixture {};
25TEST_F(Tapping, TapA_SHFT_T_KeyReportsKey) { 28TEST_F(Tapping, TapA_SHFT_T_KeyReportsKey) {
26 TestDriver driver; 29 TestDriver driver;
27 InSequence s; 30 InSequence s;
31 auto key_shift_hold_p_tap = KeymapKey(0, 7, 0, SFT_T(KC_P));
32
33 set_keymap({key_shift_hold_p_tap});
28 34
29 press_key(7, 0);
30 // Tapping keys does nothing on press 35 // Tapping keys does nothing on press
36 key_shift_hold_p_tap.press();
31 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0); 37 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
32 run_one_scan_loop(); 38 run_one_scan_loop();
33 release_key(7, 0); 39
34 // First we get the key press 40 // First we get the key press
41 key_shift_hold_p_tap.release();
35 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_P))); 42 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_P)));
43
36 // Then the release 44 // Then the release
37 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())); 45 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
38 run_one_scan_loop(); 46 run_one_scan_loop();
@@ -41,12 +49,21 @@ TEST_F(Tapping, TapA_SHFT_T_KeyReportsKey) {
41TEST_F(Tapping, HoldA_SHFT_T_KeyReportsShift) { 49TEST_F(Tapping, HoldA_SHFT_T_KeyReportsShift) {
42 TestDriver driver; 50 TestDriver driver;
43 InSequence s; 51 InSequence s;
52 auto mod_tap_hold_key = KeymapKey(0, 7, 0, SFT_T(KC_P));
53
54 set_keymap({mod_tap_hold_key});
55
56 mod_tap_hold_key.press();
44 57
45 press_key(7, 0);
46 // Tapping keys does nothing on press 58 // Tapping keys does nothing on press
47 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0); 59 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
48 idle_for(TAPPING_TERM); 60 idle_for(TAPPING_TERM);
49 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))); 61
62 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT)));
63 run_one_scan_loop();
64
65 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
66 mod_tap_hold_key.release();
50 run_one_scan_loop(); 67 run_one_scan_loop();
51} 68}
52 69
@@ -54,12 +71,16 @@ TEST_F(Tapping, ANewTapWithinTappingTermIsBuggy) {
54 // See issue #1478 for more information 71 // See issue #1478 for more information
55 TestDriver driver; 72 TestDriver driver;
56 InSequence s; 73 InSequence s;
74 auto key_shift_hold_p_tap = KeymapKey(0, 7, 0, SFT_T(KC_P));
75
76 set_keymap({key_shift_hold_p_tap});
57 77
58 press_key(7, 0);
59 // Tapping keys does nothing on press 78 // Tapping keys does nothing on press
79 key_shift_hold_p_tap.press();
60 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0); 80 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
61 run_one_scan_loop(); 81 run_one_scan_loop();
62 release_key(7, 0); 82 key_shift_hold_p_tap.release();
83
63 // First we get the key press 84 // First we get the key press
64 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_P))); 85 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_P)));
65 // Then the release 86 // Then the release
@@ -67,19 +88,20 @@ TEST_F(Tapping, ANewTapWithinTappingTermIsBuggy) {
67 run_one_scan_loop(); 88 run_one_scan_loop();
68 89
69 // This sends KC_P, even if it should do nothing 90 // This sends KC_P, even if it should do nothing
70 press_key(7, 0); 91 key_shift_hold_p_tap.press();
71 // This test should not succed if everything works correctly 92 // This test should not succed if everything works correctly
72 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_P))); 93 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_P)));
73 run_one_scan_loop(); 94 run_one_scan_loop();
74 release_key(7, 0); 95
96 key_shift_hold_p_tap.release();
75 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport())); 97 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
76 idle_for(TAPPING_TERM + 1); 98 idle_for(TAPPING_TERM + 1);
77 99
78 // On the other hand, nothing is sent if we are outside the tapping term 100 // On the other hand, nothing is sent if we are outside the tapping term
79 press_key(7, 0); 101 key_shift_hold_p_tap.press();
80 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0); 102 EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
81 run_one_scan_loop(); 103 run_one_scan_loop();
82 release_key(7, 0); 104 key_shift_hold_p_tap.release();
83 105
84 // First we get the key press 106 // First we get the key press
85 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_P))); 107 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_P)));
@@ -90,8 +112,12 @@ TEST_F(Tapping, ANewTapWithinTappingTermIsBuggy) {
90 // Now we are geting into strange territory, as the hold registers too early here 112 // Now we are geting into strange territory, as the hold registers too early here
91 // But the stranges part is: 113 // But the stranges part is:
92 // If TAPPING_TERM + 1 above is changed to TAPPING_TERM or TAPPING_TERM + 2 it doesn't 114 // If TAPPING_TERM + 1 above is changed to TAPPING_TERM or TAPPING_TERM + 2 it doesn't
93 press_key(7, 0); 115 key_shift_hold_p_tap.press();
94 // Shouldn't be called here really 116 // Shouldn't be called here really
95 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))).Times(1); 117 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LEFT_SHIFT))).Times(1);
96 idle_for(TAPPING_TERM); 118 idle_for(TAPPING_TERM);
97} 119
120 EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport()));
121 key_shift_hold_p_tap.release();
122 run_one_scan_loop();
123} \ No newline at end of file
generated by cgit v1.2.3 (git 2.25.1) at 2025-11-19 15:01:58 +0000