Semaphore: Add a regress test for reliability.

Author: kareltucek

right/src/debug.h

@@ -16,7 +16,6 @@
 #define DEBUG_MODE false
 #define DEBUG_STRESS_UART false
 #define DEBUG_STRESS_GATT false
-#define DEBUG_STRESS_REPORTS false
 #define DEBUG_TEST_RTT false
 #define DEBUG_LOG_UART true
 #define DEBUG_LOG_MESSAGES false

right/src/hid/transport.cpp

@@ -20,6 +20,7 @@ extern "C" {
 #include "jitter_test.h"
 #include "usb_state.h"
 #include "utils.h"
+#include "test_suite/test_hooks.h"
 }
 #include "command_app.hpp"
 #include "controls_app.hpp"
@@ -36,6 +37,7 @@ typedef enum {
     ReportSink_Usb,
     ReportSink_BleHid,
     ReportSink_Dongle,
+    ReportSink_TestSuite,
 } report_sink_t;
 
 // Exponential moving average (alpha=1/8) of the measured delay between a
@@ -53,6 +55,8 @@ static uint32_t dispatchTimeMs = 0;
 // callback then reduces the estimate to "now + interval".
 static constexpr uint32_t USB_REPORT_INTERVAL_MS = 1;
 
+bool UnreliableTransportTestMode = false;
+
 static uint32_t reportIntervalForSink(report_sink_t sink)
 {
     switch (sink) {
@@ -66,7 +70,7 @@ static uint32_t reportIntervalForSink(report_sink_t sink)
         return 11;
 #endif
     default:
-        return 0;
+        return 1;
     }
 }
 
@@ -109,9 +113,14 @@ extern "C" void HidTransport_NoteNusReportSent(void)
 
 static report_sink_t determineSink()
 {
+    if (TestHooks_Active) {
+        return ReportSink_TestSuite;
+    }
+
 #if DEVICE_IS_UHK_DONGLE || DEVICE_IS_UHK60
     return ReportSink_Usb;
 #else
+
     connection_type_t connectionType = Connections_Type(ActiveHostConnectionId);
 
     if (!Connections_IsReady(ActiveHostConnectionId)) {
@@ -174,8 +183,8 @@ extern "C" errno_t Hid_SendKeyboardReport(const hid_keyboard_report_t *report)
     noteReportDispatched(sink);
     Trace_Printf("z11,%d", sink);
     errno_t err;
-    if (DEBUG_STRESS_REPORTS && Utils_Random() % 16 == 0) {
-        return 1;
+    if (UnreliableTransportTestMode && Utils_Random() % 7 == 0) {
+        return -EAGAIN;
     }
     switch (sink) {
     case ReportSink_Usb:
@@ -196,6 +205,11 @@ extern "C" errno_t Hid_SendKeyboardReport(const hid_keyboard_report_t *report)
         }
         break;
 #endif
+    case ReportSink_TestSuite:
+        err = 0;
+        TestHooks_CaptureReport(report);
+        Hid_KeyboardReportSentCallback(HID_TRANSPORT_USB);
+        break;
     default:
 #ifdef __ZEPHYR__
         printk("Unhandled and unexpected switch state!\n");
@@ -209,8 +223,7 @@ extern "C" errno_t Hid_SendKeyboardReport(const hid_keyboard_report_t *report)
 
 extern "C" void Hid_KeyboardReportSentCallback(hid_transport_t transport)
 {
-    if (DEBUG_STRESS_REPORTS && Utils_Random() % 16 == 0) {
-        // 666
+    if (UnreliableTransportTestMode && Utils_Random() % 7 == 0) {
         return;
     }
     UsbReportUpdater_ConfirmKeyboardReportSent();

right/src/hid/transport.h

@@ -26,6 +26,7 @@ typedef enum
 
 
 extern float HidReportBleLatencyAvgMs;
+extern bool UnreliableTransportTestMode;
 
 void Hid_TransportStateChanged(hid_transport_t transport, bool enabled);
 

right/src/test_suite/CLAUDE.md

@@ -29,6 +29,7 @@ All actions are defined as macros in `test_actions.h`. The struct backing them i
 | `TEST_SET_GENERIC_ACTION(key_id, action)` | Base only |
 | `TEST_SET_EMPTY(key_id)` | Base only |
 | `TEST_SET_CONFIG(config_text)` | Runs a `set` command (no key mapping) |
+| `TEST_SET_BOOL(bool_ptr, bool_value)` | Writes `bool_value` to the `bool` at `bool_ptr` (e.g. toggling a test-mode flag) |
 
 `shortcut` strings go through `MacroShortcutParser_Parse` — same syntax as in macros (e.g. `"LS-i"`, `"sLA-tab"`, `"tab"`).
 

right/src/test_suite/CMakeLists.txt

@@ -18,4 +18,5 @@ target_sources(${PROJECT_NAME} PRIVATE
     tests/test_parser_benevolence.c
     tests/test_sticky.c
     tests/test_playtime.c
+    tests/test_transport.c
 )

right/src/test_suite/test_actions.h

@@ -72,6 +72,10 @@
 #define TEST_SET_CONFIG(config_text) \
     { .type = TestAction_SetConfig, .configText = (config_text) }
 
+// SetBool: write a bool value to the bool pointed to by bool_ptr
+#define TEST_SET_BOOL(bool_ptr, bool_value) \
+    { .type = TestAction_SetBool, .boolPtr = (bool_ptr), .boolValue = (bool_value) }
+
 #define TEST_END() \
     { .type = TestAction_End }
 
@@ -89,6 +93,7 @@ typedef enum {
     TestAction_SetSecondaryRole,
     TestAction_SetGenericAction,
     TestAction_SetConfig,
+    TestAction_SetBool,
     TestAction_Expect,       // OutputMachine only
     TestAction_ExpectMaybe,  // OutputMachine only, optional
     TestAction_CheckNow,     // Both machines
@@ -101,6 +106,8 @@ typedef struct {
     uint8_t switchLayerMode;      // For SetLayerHold (0 = Hold, see SwitchLayerMode enum)
     uint8_t primaryScancode;      // For SetSecondaryRole
     uint8_t secondaryRoleId;      // For SetSecondaryRole
+    bool *boolPtr;                // For SetBool
+    bool boolValue;               // For SetBool
     union {
         uint16_t delayMs;
         const char *expectShortcuts;  // Space-separated shortcut strings

right/src/test_suite/test_input_machine.c

@@ -342,6 +342,14 @@ void InputMachine_Tick(void) {
                 break;
             }
 
+            case TestAction_SetBool:
+                if (action->boolPtr != NULL) {
+                    *action->boolPtr = action->boolValue;
+                }
+                LOG_VERBOSE("[TEST] > SetBool %s\n", action->boolValue ? "true" : "false");
+                InputMachine_ActionIndex++;
+                break;
+
             case TestAction_CheckNow:
                 if (!validateReport(action->expectShortcuts, true)) {  // Always log failures
                     InputMachine_Failed = true;

right/src/test_suite/test_output_machine.c

@@ -95,6 +95,7 @@ void OutputMachine_OnReportChange(const usb_basic_keyboard_report_t *report) {
             case TestAction_SetSecondaryRole:
             case TestAction_SetGenericAction:
             case TestAction_SetConfig:
+            case TestAction_SetBool:
                 OutputMachine_ActionIndex++;
                 break;