test: add test case for hello_esp32 example

Author: urish

.github/workflows/ci.yaml

@@ -21,4 +21,8 @@ jobs:
             - run: hatch run ruff format --check .
             - run: hatch run ruff check .
             - run: hatch run mypy .
+            - name: Run a Wokwi CI server
+              uses: wokwi/wokwi-ci-server-action@v1
             - run: hatch run dev:pytest
+              env:
+                  WOKWI_CLI_TOKEN: ${{ secrets.WOKWI_CLI_TOKEN }}

examples/hello_esp32/main.py

@@ -15,6 +15,7 @@
     "hello_world.bin": f"{HELLO_WORLD_URL}/hello_world.bin",
     "hello_world.elf": f"{HELLO_WORLD_URL}/hello_world.elf",
 }
+SLEEP_TIME = int(os.getenv("WOKWI_SLEEP_TIME", "10"))
 
 
 async def main() -> None:
@@ -50,10 +51,10 @@ async def main() -> None:
         elf="hello_world.elf",
     )
 
-    # Stream serial output for 10 seconds
+    # Stream serial output for a few seconds
     serial_task = asyncio.create_task(client.serial_monitor_cat())
-    print("Simulation started, waiting for 10 seconds…")
-    await asyncio.sleep(10)
+    print(f"Simulation started, waiting for {SLEEP_TIME} seconds…")
+    await asyncio.sleep(SLEEP_TIME)
     serial_task.cancel()
 
     # Disconnect from the simulator

tests/test_hello_esp32.py

@@ -0,0 +1,26 @@
+# SPDX-FileCopyrightText: 2025-present CodeMagic LTD
+#
+# SPDX-License-Identifier: MIT
+
+import os
+import subprocess
+import sys
+
+
+def test_hello_esp32_example() -> None:
+    """`python -m examples.hello_esp32.main` runs the hello_esp32 example and exits with 0."""
+
+    assert os.environ.get("WOKWI_CLI_TOKEN") is not None, (
+        "WOKWI_CLI_TOKEN environment variable is not set. You can get it from https://wokwi.com/dashboard/ci."
+    )
+
+    result = subprocess.run(
+        [sys.executable, "-m", "examples.hello_esp32.main"],
+        check=False,
+        capture_output=True,
+        text=True,
+        env={**os.environ, "WOKWI_SLEEP_TIME": "1"},
+    )
+
+    assert result.returncode == 0
+    assert "main_task: Calling app_main()" in result.stdout