qmk_firmware/quantum/process_keycode
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
..
process_audio.c Format code according to conventions (#16322) 2022-02-12 18:29:31 +00:00
process_audio.h added missing audio_off_user() callback (#15457) 2021-12-11 16:58:25 -08:00
process_auto_shift.c Add GET_TAPPING_TERM macro to reduce duplicate code (#16681) 2022-04-16 11:24:09 -07:00
process_auto_shift.h
process_backlight.c
process_backlight.h
process_caps_word.c Continue Caps Word when AltGr (right Alt) is held. (#17156) 2022-05-20 01:39:00 +01:00
process_caps_word.h [Core] Add Caps Word feature to core (#16588) 2022-05-14 16:00:32 +10:00
process_clicky.c Format code according to conventions (#16322) 2022-02-12 18:29:31 +00:00
process_clicky.h
process_combo.c Add support for encoder mapping. (#13286) 2022-03-09 19:29:00 +11:00
process_combo.h
process_dynamic_macro.c Format code according to conventions (#16322) 2022-02-12 18:29:31 +00:00
process_dynamic_macro.h
process_dynamic_tapping_term.c New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) 2021-11-26 07:06:50 +11:00
process_dynamic_tapping_term.h New feature: `DYNAMIC_TAPPING_TERM_ENABLE` (#11036) 2021-11-26 07:06:50 +11:00
process_grave_esc.c Rename some Quantum keycodes (#15968) 2022-01-22 03:34:15 +00:00
process_grave_esc.h
process_haptic.c Rip out old macro and action_function system (#16025) 2022-01-24 21:22:20 +00:00
process_haptic.h
process_joystick.c Joystick feature updates (#16732) 2022-03-26 18:38:09 +00:00
process_joystick.h
process_key_lock.c Added cancel_key_lock function (#15321) 2021-11-29 00:17:07 -08:00
process_key_lock.h Added cancel_key_lock function (#15321) 2021-11-29 00:17:07 -08:00
process_key_override.c Format code according to conventions (#16322) 2022-02-12 18:29:31 +00:00
process_key_override.h
process_leader.c Format code according to conventions (#16322) 2022-02-12 18:29:31 +00:00
process_leader.h
process_magic.c Format code according to conventions (#16322) 2022-02-12 18:29:31 +00:00
process_magic.h
process_midi.c Format code according to conventions (#16322) 2022-02-12 18:29:31 +00:00
process_midi.h Format code according to conventions (#16322) 2022-02-12 18:29:31 +00:00
process_music.c Format code according to conventions (#16322) 2022-02-12 18:29:31 +00:00
process_music.h Format code according to conventions (#16322) 2022-02-12 18:29:31 +00:00
process_printer.c Format code according to conventions (#16322) 2022-02-12 18:29:31 +00:00
process_printer.h Migrate serial_uart usages to UART driver (#15479) 2021-12-15 11:00:39 +00:00
process_printer_bb.c Format code according to conventions (#16322) 2022-02-12 18:29:31 +00:00
process_programmable_button.c
process_programmable_button.h
process_rgb.c Unify the key up/down behaviour of RGB keycodes (#15730) 2022-01-06 18:52:32 +11:00
process_rgb.h
process_secure.c Enhancement and fixes of "Secure" feature (#16958) 2022-05-14 23:07:08 +01:00
process_secure.h Implement XAP 'secure' core requirements (#16843) 2022-04-16 11:13:05 -07:00
process_sequencer.c
process_sequencer.h
process_space_cadet.c Add GET_TAPPING_TERM macro to reduce duplicate code (#16681) 2022-04-16 11:24:09 -07:00
process_space_cadet.h
process_steno.c Format code according to conventions (#16322) 2022-02-12 18:29:31 +00:00
process_steno.h
process_tap_dance.c Add GET_TAPPING_TERM macro to reduce duplicate code (#16681) 2022-04-16 11:24:09 -07:00
process_tap_dance.h
process_terminal.c Format code according to conventions (#16322) 2022-02-12 18:29:31 +00:00
process_terminal.h
process_terminal_nop.h
process_ucis.c Format code according to conventions (#16322) 2022-02-12 18:29:31 +00:00
process_ucis.h
process_unicode.c
process_unicode.h
process_unicode_common.c Fix and add unit tests for Caps Word to work with Unicode Map, Auto Shift, Retro Shift. (#17284) 2022-06-05 09:14:02 +02:00
process_unicode_common.h Remove `send_unicode_hex_string()` (#16518) 2022-03-04 11:04:45 +00:00
process_unicodemap.c
process_unicodemap.h