pytest-embedded-wokwi
pytest-embedded service for running tests on Wokwi instead of the real target.
Wokwi supports most ESP32 targets, including: esp32, esp32s2, esp32s3, esp32c3, esp32c6, and esp32h2. In addition, it supports a wide range of peripherals, including sensors, displays, motors, and debugging tools.
Running the tests with Wokwi requires an internet connection. Your firmware is uploaded to the Wokwi server for the duration of the simulation, but it is not saved on the server. On-premises Wokwi installations are available for enterprise customers.
Wokwi API Tokens
Before using this plugin, you need to create a free Wokwi account and generate an API key. You can then set the WOKWI_CLI_TOKEN environment variable to the API key.
Linux / Mac OS / WSL:
export WOKWI_CLI_TOKEN="your-api-key"
Windows PowerShell:
$env:WOKWI_CLI_TOKEN="your-api-key"
Usage
To run your tests with Wokwi, make sure to specify the wokwi service when running pytest, e.g.:
pytest --embedded-services idf,wokwi
USB Serial JTAG
By default, Wokwi diagrams use UART connections ($serialMonitor:TX/$serialMonitor:RX) for serial communication. Some targets (e.g. ESP32-P4) can use USB Serial JTAG instead. You can enable this with the --wokwi-usb-serial-jtag flag:
pytest --embedded-services idf,wokwi --wokwi-usb-serial-jtag true
This works for both auto-generated diagrams and diagrams loaded from disk (including those specified via --wokwi-diagram). When enabled, the flag will:
- Set the
serialInterfaceattribute toUSB_SERIAL_JTAGon the board part - Remove any
$serialMonitorconnections from the diagram
Writing Tests
When writing tests for your firmware, you can use the same pytest fixtures and assertions as you would for local testing. The main difference is that your tests will be executed in the Wokwi simulation environment and you have access to the Wokwi API for controlling the simulation through the wokwi fixture.
All interactions with the Wokwi simulation is through the wokwi.client - wokwi-python-client
For example, you can use wokwi.client.set_control() to control virtual components in the simulation, such as buttons, LEDs, and other peripherals.
Whole documentations can be found at Wokwi Documentation
Button test:
import logging
from pytest_embedded_wokwi import Wokwi
from pytest_embedded import Dut
def test_gpio(dut: Dut, wokwi: Wokwi):
LOGGER = logging.getLogger(__name__)
LOGGER.info("Waiting for Button test begin...")
dut.expect_exact("Butston test")
for i in range(3):
LOGGER.info(f"Setting button pressed for {i + 1} seconds")
wokwi.client.set_control("btn1", "pressed", 1)
dut.expect_exact(f"Button pressed {i + 1} times")
wokwi.client.set_control("btn1", "pressed", 0)
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pytest_embedded_wokwi-2.9.1.tar.gz.
File metadata
- Download URL: pytest_embedded_wokwi-2.9.1.tar.gz
- Upload date:
- Size: 10.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
python-requests/2.31.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a74b469c0d5cd7b97ee14107eab2bf132dd7d5dcc53064e6e5f168fa2e894dc6
|
|
| MD5 |
c9572c543882ec2ed74dd079633dc51a
|
|
| BLAKE2b-256 |
c4724df3ba84d172ad4a19ac9fb6e54c62e6d78231d547cdfb3e69c3acd9d81f
|
File details
Details for the file pytest_embedded_wokwi-2.9.1-py3-none-any.whl.
File metadata
- Download URL: pytest_embedded_wokwi-2.9.1-py3-none-any.whl
- Upload date:
- Size: 9.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
python-requests/2.31.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
166ec5d4fef8a70aa4e54fd554415a522bf9f5fda33833911c84821e4f4398c0
|
|
| MD5 |
0d977d2aa82fe63e879b942611f85179
|
|
| BLAKE2b-256 |
8cee3d59aea3b5fadbe4a932791c1f1e7aa3849a478c8db0504fadc4cfcec563
|
