ci(wokwi): Support wokwi

.github/workflows/hil.yml

@@ -1,17 +1,16 @@
 name: Run tests
 
 on:
-  pull_request_target:
+  pull_request:
     types: [opened, reopened, synchronize, labeled]
-    branches:
-      - master
 
   schedule:
     - cron: '0 2 * * *'
 
 env:
   MAX_CHUNKS: 15
   WOKWI_TIMEOUT: 120000 # Milliseconds
+  WOKWI_CLI_TOKEN: ${{ secrets.WOKWI_CLI_TOKEN }}
 
 concurrency:
   group: hil-${{github.event.pull_request.number || github.ref}}
@@ -32,8 +31,6 @@ jobs:
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.pull_request.head.sha }} # Check out the code of the PR
 
       - name: Generate Chunks matrix
         id: gen-chunks
@@ -87,10 +84,12 @@ jobs:
           path: |
             ~/.build_skipped
             ~/.arduino/tests/**/build*.tmp/*.bin
+            ~/.arduino/tests/**/build*.tmp/*.elf
             ~/.arduino/tests/**/build*.tmp/*.json
 
   wokwi-test:
     needs: [gen_chunks, build]
+    if: github.event_name == 'schedule'
     name: ${{matrix.chip}}-Wokwi_Test#${{matrix.chunks}}
     strategy:
       fail-fast: false
@@ -106,8 +105,8 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: ${{matrix.chip}}-${{matrix.chunks}}.artifacts
-          path: ~/.arduino/tests/
-
+          path: ~/
+      
       - name: Install Wokwi CLI
         run: curl -L https://wokwi.com/ci/install.sh | sh
 
@@ -123,12 +122,21 @@ jobs:
         run: |
           bash .github/scripts/tests_run.sh -c -t ${{matrix.chip}} -i ${{matrix.chunks}} -m ${{env.MAX_CHUNKS}} -w ${{env.WOKWI_TIMEOUT}}
 
+      - name: Check if tests were skipped
+        id: check-test-skipped
+        run: |
+          if [ -f ~/.test_skipped ]; then
+            echo "skipped=true" >> $GITHUB_OUTPUT
+          else
+            echo "skipped=false" >> $GITHUB_OUTPUT
+          fi
+
       - name: Upload test result artifacts
         uses: actions/upload-artifact@v4
-        if: always()
+        if: ${{ always() && steps.check-test-skipped.outputs.skipped == 'false' }}
         with:
           name: wokwi_results-${{matrix.chip}}-${{matrix.chunks}}
-          path: tests/*/*.xml
+          path: tests/**/*.xml
 
   hardware-test:
     needs: [gen_chunks, build]

tests/gpio/gpio.ino → tests/validation/gpio/gpio.ino

@@ -24,16 +24,13 @@ void test_button()
     }
     delay(10);
   }
-  TEST_ASSERT_EQUAL(3, count);
 }
 
 void setup()
 {
   Serial.begin(115200);
-  UNITY_BEGIN();
   pinMode(BTN, INPUT_PULLUP);
-  RUN_TEST(test_button);
-  UNITY_END();
+  test_button();
 }
 
 void loop()

tests/gpio/scenario.yaml → tests/validation/gpio/scenario.yaml

@@ -5,8 +5,9 @@ author: Jan Prochazka ([email protected])
 steps:
   - wait-serial: 'Button test'
 
-  # Delay 1s (to make sure the test is ready to start)
+  # Need for 1s delay for scenario to run properly
   - delay: 1000ms
+
   # Press once
   - set-control:
       part-id: btn1

tests/validation/gpio/test_gpio.py

@@ -0,0 +1,5 @@
+def test_gpio(dut):
+    dut.expect_exact("Button test")
+    dut.expect_exact("Button pressed 1 times")
+    dut.expect_exact("Button pressed 2 times")
+    dut.expect_exact("Button pressed 3 times")

tests/validation/wifi/test_wifi.py

@@ -0,0 +1,3 @@
+def test_wifi(dut):
+    dut.expect_exact("WiFi connected")
+    dut.expect_exact("IP address:")

tests/validation/wifi/wifi.ino

@@ -0,0 +1,124 @@
+/*
+ *  This sketch shows the WiFi event usage
+ *
+*/
+
+/*
+* WiFi Events
+
+0  ARDUINO_EVENT_WIFI_READY               < ESP32 WiFi ready
+1  ARDUINO_EVENT_WIFI_SCAN_DONE                < ESP32 finish scanning AP
+2  ARDUINO_EVENT_WIFI_STA_START                < ESP32 station start
+3  ARDUINO_EVENT_WIFI_STA_STOP                 < ESP32 station stop
+4  ARDUINO_EVENT_WIFI_STA_CONNECTED            < ESP32 station connected to AP
+5  ARDUINO_EVENT_WIFI_STA_DISCONNECTED         < ESP32 station disconnected from AP
+6  ARDUINO_EVENT_WIFI_STA_AUTHMODE_CHANGE      < the auth mode of AP connected by ESP32 station changed
+7  ARDUINO_EVENT_WIFI_STA_GOT_IP               < ESP32 station got IP from connected AP
+8  ARDUINO_EVENT_WIFI_STA_LOST_IP              < ESP32 station lost IP and the IP is reset to 0
+9  ARDUINO_EVENT_WPS_ER_SUCCESS       < ESP32 station wps succeeds in enrollee mode
+10 ARDUINO_EVENT_WPS_ER_FAILED        < ESP32 station wps fails in enrollee mode
+11 ARDUINO_EVENT_WPS_ER_TIMEOUT       < ESP32 station wps timeout in enrollee mode
+12 ARDUINO_EVENT_WPS_ER_PIN           < ESP32 station wps pin code in enrollee mode
+13 ARDUINO_EVENT_WIFI_AP_START                 < ESP32 soft-AP start
+14 ARDUINO_EVENT_WIFI_AP_STOP                  < ESP32 soft-AP stop
+15 ARDUINO_EVENT_WIFI_AP_STACONNECTED          < a station connected to ESP32 soft-AP
+16 ARDUINO_EVENT_WIFI_AP_STADISCONNECTED       < a station disconnected from ESP32 soft-AP
+17 ARDUINO_EVENT_WIFI_AP_STAIPASSIGNED         < ESP32 soft-AP assign an IP to a connected station
+18 ARDUINO_EVENT_WIFI_AP_PROBEREQRECVED        < Receive probe request packet in soft-AP interface
+19 ARDUINO_EVENT_WIFI_AP_GOT_IP6               < ESP32 ap interface v6IP addr is preferred
+19 ARDUINO_EVENT_WIFI_STA_GOT_IP6              < ESP32 station interface v6IP addr is preferred
+20 ARDUINO_EVENT_ETH_START                < ESP32 ethernet start
+21 ARDUINO_EVENT_ETH_STOP                 < ESP32 ethernet stop
+22 ARDUINO_EVENT_ETH_CONNECTED            < ESP32 ethernet phy link up
+23 ARDUINO_EVENT_ETH_DISCONNECTED         < ESP32 ethernet phy link down
+24 ARDUINO_EVENT_ETH_GOT_IP               < ESP32 ethernet got IP from connected AP
+19 ARDUINO_EVENT_ETH_GOT_IP6              < ESP32 ethernet interface v6IP addr is preferred
+25 ARDUINO_EVENT_MAX
+*/
+
+#include <WiFi.h>
+
+const char *ssid = "Wokwi-GUEST";
+const char *password = "";
+
+// WARNING: This function is called from a separate FreeRTOS task (thread)!
+void WiFiEvent(WiFiEvent_t event) {
+  Serial.printf("[WiFi-event] event: %d\n", event);
+
+  switch (event) {
+    case ARDUINO_EVENT_WIFI_READY:               Serial.println("WiFi interface ready"); break;
+    case ARDUINO_EVENT_WIFI_SCAN_DONE:           Serial.println("Completed scan for access points"); break;
+    case ARDUINO_EVENT_WIFI_STA_START:           Serial.println("WiFi client started"); break;
+    case ARDUINO_EVENT_WIFI_STA_STOP:            Serial.println("WiFi clients stopped"); break;
+    case ARDUINO_EVENT_WIFI_STA_CONNECTED:       Serial.println("Connected to access point"); break;
+    case ARDUINO_EVENT_WIFI_STA_DISCONNECTED:    Serial.println("Disconnected from WiFi access point"); break;
+    case ARDUINO_EVENT_WIFI_STA_AUTHMODE_CHANGE: Serial.println("Authentication mode of access point has changed"); break;
+    case ARDUINO_EVENT_WIFI_STA_GOT_IP:
+      Serial.print("Obtained IP address: ");
+      Serial.println(WiFi.localIP());
+      break;
+    case ARDUINO_EVENT_WIFI_STA_LOST_IP:        Serial.println("Lost IP address and IP address is reset to 0"); break;
+    case ARDUINO_EVENT_WPS_ER_SUCCESS:          Serial.println("WiFi Protected Setup (WPS): succeeded in enrollee mode"); break;
+    case ARDUINO_EVENT_WPS_ER_FAILED:           Serial.println("WiFi Protected Setup (WPS): failed in enrollee mode"); break;
+    case ARDUINO_EVENT_WPS_ER_TIMEOUT:          Serial.println("WiFi Protected Setup (WPS): timeout in enrollee mode"); break;
+    case ARDUINO_EVENT_WPS_ER_PIN:              Serial.println("WiFi Protected Setup (WPS): pin code in enrollee mode"); break;
+    case ARDUINO_EVENT_WIFI_AP_START:           Serial.println("WiFi access point started"); break;
+    case ARDUINO_EVENT_WIFI_AP_STOP:            Serial.println("WiFi access point  stopped"); break;
+    case ARDUINO_EVENT_WIFI_AP_STACONNECTED:    Serial.println("Client connected"); break;
+    case ARDUINO_EVENT_WIFI_AP_STADISCONNECTED: Serial.println("Client disconnected"); break;
+    case ARDUINO_EVENT_WIFI_AP_STAIPASSIGNED:   Serial.println("Assigned IP address to client"); break;
+    case ARDUINO_EVENT_WIFI_AP_PROBEREQRECVED:  Serial.println("Received probe request"); break;
+    case ARDUINO_EVENT_WIFI_AP_GOT_IP6:         Serial.println("AP IPv6 is preferred"); break;
+    case ARDUINO_EVENT_WIFI_STA_GOT_IP6:        Serial.println("STA IPv6 is preferred"); break;
+    case ARDUINO_EVENT_ETH_GOT_IP6:             Serial.println("Ethernet IPv6 is preferred"); break;
+    case ARDUINO_EVENT_ETH_START:               Serial.println("Ethernet started"); break;
+    case ARDUINO_EVENT_ETH_STOP:                Serial.println("Ethernet stopped"); break;
+    case ARDUINO_EVENT_ETH_CONNECTED:           Serial.println("Ethernet connected"); break;
+    case ARDUINO_EVENT_ETH_DISCONNECTED:        Serial.println("Ethernet disconnected"); break;
+    case ARDUINO_EVENT_ETH_GOT_IP:              Serial.println("Obtained IP address"); break;
+    default:                                    break;
+  }
+}
+
+// WARNING: This function is called from a separate FreeRTOS task (thread)!
+void WiFiGotIP(WiFiEvent_t event, WiFiEventInfo_t info) {
+  Serial.println("WiFi connected");
+  Serial.println("IP address: ");
+  Serial.println(IPAddress(info.got_ip.ip_info.ip.addr));
+}
+
+void setup() {
+  Serial.begin(115200);
+
+  // delete old config
+  WiFi.disconnect(true);
+
+  delay(1000);
+
+  // Examples of different ways to register wifi events;
+  // these handlers will be called from another thread.
+  WiFi.onEvent(WiFiEvent);
+  WiFi.onEvent(WiFiGotIP, WiFiEvent_t::ARDUINO_EVENT_WIFI_STA_GOT_IP);
+  WiFiEventId_t eventID = WiFi.onEvent(
+    [](WiFiEvent_t event, WiFiEventInfo_t info) {
+      Serial.print("WiFi lost connection. Reason: ");
+      Serial.println(info.wifi_sta_disconnected.reason);
+    },
+    WiFiEvent_t::ARDUINO_EVENT_WIFI_STA_DISCONNECTED
+  );
+
+  // Remove WiFi event
+  Serial.print("WiFi Event ID: ");
+  Serial.println(eventID);
+  // WiFi.removeEvent(eventID);
+
+  WiFi.begin(ssid, password);
+
+  Serial.println();
+  Serial.println();
+  Serial.println("Wait for WiFi... ");
+}
+
+void loop() {
+  delay(1000);
+}