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>

tests/test_common/test_driver.cpp

@@ -18,6 +18,19 @@
 
 TestDriver* TestDriver::m_this = nullptr;
 
+namespace {
+// Given a hex digit between 0 and 15, returns the corresponding keycode.
+uint8_t hex_digit_to_keycode(uint8_t digit) {
+    // clang-format off
+    static const uint8_t hex_keycodes[] = {
+        KC_0, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7,
+        KC_8, KC_9, KC_A, KC_B, KC_C, KC_D, KC_E, KC_F
+    };
+    // clang-format on
+    return hex_keycodes[digit];
+}
+} // namespace
+
 TestDriver::TestDriver() : m_driver{&TestDriver::keyboard_leds, &TestDriver::send_keyboard, &TestDriver::send_mouse, &TestDriver::send_system, &TestDriver::send_consumer} {
     host_set_driver(&m_driver);
     m_this = this;
@@ -47,3 +60,25 @@ void TestDriver::send_system(uint16_t data) {
 void TestDriver::send_consumer(uint16_t data) {
     m_this->send_consumer(data);
 }
+
+namespace internal {
+void expect_unicode_code_point(TestDriver& driver, uint32_t code_point) {
+    testing::InSequence seq;
+    EXPECT_REPORT(driver, (KC_LCTL, KC_LSFT, KC_U));
+
+    bool print_zero = false;
+    for (int i = 7; i >= 0; --i) {
+        if (i <= 3) {
+            print_zero = true;
+        }
+
+        const uint8_t digit = (code_point >> (i * 4)) & 0xf;
+        if (digit || print_zero) {
+            EXPECT_REPORT(driver, (hex_digit_to_keycode(digit)));
+            print_zero = true;
+        }
+    }
+
+    EXPECT_REPORT(driver, (KC_SPC));
+}
+} // namespace internal

tests/test_common/test_driver.hpp

@@ -26,7 +26,9 @@ class TestDriver {
    public:
     TestDriver();
     ~TestDriver();
-    void set_leds(uint8_t leds) { m_leds = leds; }
+    void set_leds(uint8_t leds) {
+        m_leds = leds;
+    }
 
     MOCK_METHOD1(send_keyboard_mock, void(report_keyboard_t&));
     MOCK_METHOD1(send_mouse_mock, void(report_mouse_t&));
@@ -43,3 +45,61 @@ class TestDriver {
     uint8_t            m_leds = 0;
     static TestDriver* m_this;
 };
+
+/**
+ * @brief Sets gmock expectation that a keyboard report of `report` keys will be sent.
+ * For this macro to parse correctly, the `report` arg must be surrounded by
+ * parentheses ( ). For instance,
+ *
+ *   // Expect that a report of "KC_LSFT + KC_A" is sent to the host.
+ *   EXPECT_REPORT(driver, (KC_LSFT, KC_A));
+ *
+ * is shorthand for
+ *
+ *   EXPECT_CALL(driver, send_keyboard_mock(KeyboardReport(KC_LSFT, KC_A)));
+ *
+ * It is possible to use .Times() and other gmock APIS with EXPECT_REPORT, for instance,
+ * allow only single report to be sent:
+ *
+ *   EXPECT_REPORT(driver, (KC_LSFT, KC_A)).Times(1);
+ */
+#define EXPECT_REPORT(driver, report) EXPECT_CALL((driver), send_keyboard_mock(KeyboardReport report))
+
+/**
+ * @brief Sets gmock expectation that Unicode `code_point` is sent with 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".
+ */
+#define EXPECT_UNICODE(driver, code_point) internal::expect_unicode_code_point((driver), (code_point))
+
+/**
+ * @brief Sets gmock expectation that a empty keyboard report will be sent.
+ * It is possible to use .Times() and other gmock APIS with EXPECT_EMPTY_REPORT, for instance,
+ * allow any number of empty reports with:
+ *
+ *   EXPECT_EMPTY_REPORT(driver).Times(AnyNumber());
+ */
+#define EXPECT_EMPTY_REPORT(driver) EXPECT_REPORT(driver, ())
+
+/**
+ * @brief Sets gmock expectation that a keyboard report will be sent, without matching its content.
+ * It is possible to use .Times() and other gmock APIS with EXPECT_ANY_REPORT, for instance,
+ * allow a single arbitrary report with:
+ *
+ *   EXPECT_ANY_REPORT(driver).Times(1);
+ */
+#define EXPECT_ANY_REPORT(driver) EXPECT_CALL((driver), send_keyboard_mock(_))
+
+/**
+ * @brief Sets gmock expectation that no keyboard report will be sent at all.
+ */
+#define EXPECT_NO_REPORT(driver) EXPECT_ANY_REPORT(driver).Times(0)
+
+namespace internal {
+void expect_unicode_code_point(TestDriver& driver, uint32_t code_point);
+} // namespace internal

tests/test_common/test_fixture.cpp

@@ -82,7 +82,7 @@ TestFixture::~TestFixture() {
     testing::Mock::VerifyAndClearExpectations(&driver);
 
     /* Verify that the matrix really is cleared */
-    EXPECT_CALL(driver, send_keyboard_mock(_)).Times(0);
+    EXPECT_NO_REPORT(driver);
     idle_for(TAPPING_TERM * 10);
     testing::Mock::VerifyAndClearExpectations(&driver);
 
@@ -101,6 +101,13 @@ void TestFixture::add_key(KeymapKey key) {
     this->keymap.push_back(key);
 }
 
+void TestFixture::tap_key(KeymapKey key, unsigned delay_ms) {
+    key.press();
+    idle_for(delay_ms);
+    key.release();
+    run_one_scan_loop();
+}
+
 void TestFixture::set_keymap(std::initializer_list<KeymapKey> keys) {
     this->keymap.clear();
     for (auto& key : keys) {

tests/test_common/test_fixture.hpp

@@ -36,7 +36,22 @@ class TestFixture : public testing::Test {
     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;
+    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);