Add four basic Qukeys testcases

These are very rudimentary testcases, and already need to be rewritten, but
should serve as the first step in a process of developing better, more robust
testcases in the future.

- A single tap of a qukey alone
- A hold timeout test
- A full overlap test (subsequent key released first)
- A rollover test (subsequent key released late enough to produce primary qukey value)

Signed-off-by: Michael Richters <gedankenexperimenter@gmail.com>

tests/plugins/Qukeys/basic/sketch.h

@@ -0,0 +1,15 @@
+// -*- mode: c++ -*-
+
+#pragma once
+
+#include <cstdint>
+
+namespace kaleidoscope {
+namespace testing {
+
+constexpr uint16_t QUKEYS_HOLD_TIMEOUT{200};
+constexpr uint8_t QUKEYS_OVERLAP_THRESHOLD{90};
+constexpr uint8_t QUKEYS_MINIMUM_HOLD_TIME{10};
+
+}
+}

tests/plugins/Qukeys/basic/sketch.ino

@@ -0,0 +1,84 @@
+// -*- mode: c++ -*-
+
+#include <Kaleidoscope.h>
+#include <Kaleidoscope-Qukeys.h>
+#include <Kaleidoscope-Macros.h>
+
+#include "./sketch.h"
+
+enum { MACRO_TOGGLE_QUKEYS };
+
+// *INDENT-OFF*
+KEYMAPS(
+  [0] = KEYMAP_STACKED
+  (
+      Key_NoKey,    Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey,
+      Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab,
+      Key_PageUp,   Key_A, Key_S, Key_D, Key_F, Key_G,
+      Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape,
+
+      Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift,
+      Key_Q,
+
+      M(MACRO_TOGGLE_QUKEYS), Key_6, Key_7,    Key_8,     Key_9,      Key_0,            Key_skip,
+      Key_Enter,              Key_Y, Key_U,    Key_I,     Key_O,      Key_P,            Key_Equals,
+                              Key_H, SFT_T(J), CTL_T(K),  ALT_T(L),   GUI_T(Semicolon), Key_Quote,
+      Key_skip,               Key_N, Key_M,    Key_Comma, Key_Period, Key_Slash,        Key_Minus,
+
+      Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl,
+      LT(1,E)
+   ),
+  [1] = KEYMAP_STACKED
+  (
+      ___,   Key_B, Key_C, Key_D, Key_E, Key_F, Key_G,
+      Key_A, Key_B, Key_C, Key_D, Key_E, Key_F, Key_G,
+      Key_A, Key_B, Key_C, Key_D, Key_E, Key_F,
+      Key_A, Key_B, Key_C, Key_D, Key_E, Key_F, Key_G,
+
+      Key_1, Key_2, Key_3, Key_4,
+      ___,
+
+
+      ___,   Key_B, Key_C, Key_D, Key_E, Key_F, Key_G,
+      Key_A, Key_B, Key_C, Key_D, Key_E, Key_F, Key_G,
+      Key_A, Key_B, Key_C, Key_D, Key_E, Key_F,
+      Key_A, Key_B, Key_C, Key_D, Key_E, Key_F, Key_G,
+
+      Key_1, Key_2, Key_3, Key_4,
+      ___
+   ),
+)
+// *INDENT-ON*
+
+// Defining a macro (on the "any" key: see above) to toggle Qukeys on and off
+const macro_t *macroAction(uint8_t macro_index, uint8_t key_state) {
+  switch (macro_index) {
+  case MACRO_TOGGLE_QUKEYS:
+    if (keyToggledOn(key_state))
+      Qukeys.toggle();
+    break;
+  }
+  return MACRO_NONE;
+}
+
+// Use Qukeys
+KALEIDOSCOPE_INIT_PLUGINS(Qukeys, Macros);
+
+void setup() {
+  QUKEYS(
+    kaleidoscope::plugin::Qukey(0, KeyAddr(2, 1), Key_LeftGui),      // A/cmd
+    kaleidoscope::plugin::Qukey(0, KeyAddr(2, 2), Key_LeftAlt),      // S/alt
+    kaleidoscope::plugin::Qukey(0, KeyAddr(2, 3), Key_LeftControl),  // D/ctrl
+    kaleidoscope::plugin::Qukey(0, KeyAddr(2, 4), Key_LeftShift),    // F/shift
+    kaleidoscope::plugin::Qukey(0, KeyAddr(3, 6), ShiftToLayer(1))   // Q/layer-shift (on `fn`)
+  )
+  Qukeys.setHoldTimeout(kaleidoscope::testing::QUKEYS_HOLD_TIMEOUT);
+  Qukeys.setOverlapThreshold(kaleidoscope::testing::QUKEYS_OVERLAP_THRESHOLD);
+  Qukeys.setMinimumHoldTime(kaleidoscope::testing::QUKEYS_MINIMUM_HOLD_TIME);
+
+  Kaleidoscope.setup();
+}
+
+void loop() {
+  Kaleidoscope.loop();
+}

tests/plugins/Qukeys/basic/test/testcase.cpp

@@ -0,0 +1,192 @@
+/* -*- mode: c++ -*-
+ * Copyright (C) 2020  Keyboard.io, Inc.
+ *
+ * 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, version 3.
+ *
+ * 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 "testing/setup-googletest.h"
+
+#include "../sketch.h"
+
+SETUP_GOOGLETEST();
+
+namespace kaleidoscope {
+namespace testing {
+namespace {
+
+struct QukeyValues {
+  Key primary{Key_NoKey};
+  Key alternate{Key_NoKey};
+};
+constexpr KeyAddr key_addr_A{2, 1};
+constexpr KeyAddr key_addr_S{2, 2};
+constexpr KeyAddr key_addr_D{2, 3};
+constexpr KeyAddr key_addr_F{2, 4};
+constexpr KeyAddr key_addr_X{3, 2};
+
+using ::testing::IsEmpty;
+
+class QukeysBasic : public VirtualDeviceTest {};
+
+TEST_F(QukeysBasic, TapQukeyAlone) {
+
+  std::unique_ptr<State> state{nullptr};
+  std::set<uint8_t> expected_keycodes{};
+
+  // Press `A`
+  sim_.Press(key_addr_A);
+
+  state = VirtualDeviceTest::RunCycle();
+
+  ASSERT_EQ(state->HIDReports()->Keyboard().size(), 0);
+
+  // Release `A`
+  sim_.Release(key_addr_A);
+  expected_keycodes.insert(Key_A.getKeyCode());
+
+  state = VirtualDeviceTest::RunCycle();
+
+  ASSERT_EQ(state->HIDReports()->Keyboard().size(), 1);
+  EXPECT_THAT(state->HIDReports()->Keyboard(0).ActiveKeycodes(),
+              ::testing::ElementsAreArray(expected_keycodes));
+
+  expected_keycodes.erase(Key_A.getKeyCode());
+
+  sim_.RunCycles(2);
+  state = VirtualDeviceTest::RunCycle();
+
+  ASSERT_EQ(state->HIDReports()->Keyboard().size(), 1);
+  EXPECT_THAT(state->HIDReports()->Keyboard(0).ActiveKeycodes(),
+              ::testing::ElementsAreArray(expected_keycodes));
+
+  state = VirtualDeviceTest::RunCycle();
+
+  ASSERT_EQ(state->HIDReports()->Keyboard().size(), 0);
+}
+
+TEST_F(QukeysBasic, HoldQukeyAlone) {
+
+  std::unique_ptr<State> state{nullptr};
+  std::set<uint8_t> expected_keycodes{};
+
+  // Press `A`
+  sim_.Press(key_addr_A);
+
+  state = VirtualDeviceTest::RunCycle();
+
+  ASSERT_EQ(state->HIDReports()->Keyboard().size(), 0);
+
+  uint32_t t0 = Kaleidoscope.millisAtCycleStart();
+
+  do {
+    state = VirtualDeviceTest::RunCycle();
+    if (Kaleidoscope.millisAtCycleStart() > t0 + QUKEYS_HOLD_TIMEOUT)
+      break;
+  } while (state->HIDReports()->Keyboard().size() == 0);
+
+  uint32_t t1 = Kaleidoscope.millisAtCycleStart();
+
+  EXPECT_THAT(t1 - t0, ::testing::Ge(QUKEYS_HOLD_TIMEOUT));
+
+  expected_keycodes.insert(Key_LeftGui.getKeyCode());
+
+  ASSERT_EQ(state->HIDReports()->Keyboard().size(), 1);
+  EXPECT_THAT(state->HIDReports()->Keyboard(0).ActiveKeycodes(),
+              ::testing::ElementsAreArray(expected_keycodes));
+
+  sim_.Release(key_addr_A);
+  expected_keycodes.erase(Key_LeftGui.getKeyCode());
+
+  sim_.RunForMillis(100);
+  state = VirtualDeviceTest::RunCycle();
+
+  ASSERT_EQ(state->HIDReports()->Keyboard().size(), 1);
+  EXPECT_THAT(state->HIDReports()->Keyboard(0).ActiveKeycodes(),
+              ::testing::ElementsAreArray(expected_keycodes));
+}
+
+TEST_F(QukeysBasic, FullOverlap) {
+
+  std::set<uint8_t> expected_keycodes{};
+
+  sim_.Press(key_addr_F);
+  sim_.RunForMillis(20);
+  sim_.Press(key_addr_X);
+  auto state = RunCycle();
+  ASSERT_EQ(state->HIDReports()->Keyboard().size(), 0);
+
+  sim_.RunForMillis(50);
+  sim_.Release(key_addr_X);
+  state = RunCycle();
+  expected_keycodes.insert(Key_LeftShift.getKeyCode());
+  ASSERT_EQ(state->HIDReports()->Keyboard().size(), 1);
+  EXPECT_THAT(state->HIDReports()->Keyboard(0).ActiveKeycodes(),
+              ::testing::ElementsAreArray(expected_keycodes));
+  sim_.RunCycles(3);
+  state = RunCycle();
+  ASSERT_EQ(state->HIDReports()->Keyboard().size(), 2);
+  expected_keycodes.insert(Key_X.getKeyCode());
+  EXPECT_THAT(state->HIDReports()->Keyboard(0).ActiveKeycodes(),
+              ::testing::ElementsAreArray(expected_keycodes));
+  expected_keycodes.erase(Key_X.getKeyCode());
+  EXPECT_THAT(state->HIDReports()->Keyboard(1).ActiveKeycodes(),
+              ::testing::ElementsAreArray(expected_keycodes));
+  sim_.Release(key_addr_F);
+  sim_.RunCycles(3);
+  state = RunCycle();
+  ASSERT_EQ(state->HIDReports()->Keyboard().size(), 1);
+  expected_keycodes.erase(Key_LeftShift.getKeyCode());
+  EXPECT_THAT(state->HIDReports()->Keyboard(0).ActiveKeycodes(),
+              ::testing::ElementsAreArray(expected_keycodes));
+}
+
+TEST_F(QukeysBasic, RolloverPrimary) {
+
+  std::set<uint8_t> expected_keycodes{};
+
+  sim_.Press(key_addr_F);
+  sim_.RunForMillis(20);
+  sim_.Press(key_addr_X);
+  auto state = RunCycle();
+  ASSERT_EQ(state->HIDReports()->Keyboard().size(), 0);
+
+  sim_.RunForMillis(50);
+  sim_.Release(key_addr_F);
+  sim_.RunForMillis(50);
+  state = RunCycle();
+  ASSERT_EQ(state->HIDReports()->Keyboard().size(), 3);
+
+  expected_keycodes.insert(Key_F.getKeyCode());
+  EXPECT_THAT(state->HIDReports()->Keyboard(0).ActiveKeycodes(),
+              ::testing::ElementsAreArray(expected_keycodes));
+
+  expected_keycodes.insert(Key_X.getKeyCode());
+  EXPECT_THAT(state->HIDReports()->Keyboard(1).ActiveKeycodes(),
+              ::testing::ElementsAreArray(expected_keycodes));
+
+  expected_keycodes.erase(Key_F.getKeyCode());
+  EXPECT_THAT(state->HIDReports()->Keyboard(2).ActiveKeycodes(),
+              ::testing::ElementsAreArray(expected_keycodes));
+
+  sim_.Release(key_addr_X);
+  sim_.RunCycles(3);
+  state = RunCycle();
+  ASSERT_EQ(state->HIDReports()->Keyboard().size(), 1);
+  expected_keycodes.erase(Key_X.getKeyCode());
+  EXPECT_THAT(state->HIDReports()->Keyboard(0).ActiveKeycodes(),
+              ::testing::ElementsAreArray(expected_keycodes));
+}
+
+}  // namespace
+}  // namespace testing
+}  // namespace kaleidoscope