refactor: remove deprecated Wokwi CLI options and related code

Author: JakubAndrysek

pytest-embedded-wokwi/README.md

@@ -6,20 +6,6 @@ Wokwi supports most ESP32 targets, including: esp32, esp32s2, esp32s3, esp32c3,
 
 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 CLI installation
-
-The Wokwi plugin uses the [Wokwi CLI](https://github.com/wokwi/wokwi-cli) to interact with the wokwi simulation server. You can download the precompiled CLI binaries from the [releases page](https://github.com/wokwi/wokwi-cli/releases). Alternatively, on Linux or Mac OS, you can install the CLI using the following command:
-
-```bash
-curl -L https://wokwi.com/ci/install.sh | sh
-```
-
-And on Windows:
-
-```powershell
-iwr https://wokwi.com/ci/install.ps1 -useb | iex
-```
-
 #### Wokwi API Tokens
 
 Before using this plugin, you need to create a free Wokwi account and [generate an API key](https://wokwi.com/dashboard/ci). You can then set the `WOKWI_CLI_TOKEN` environment variable to the API key.
@@ -44,8 +30,32 @@ To run your tests with Wokwi, make sure to specify the `wokwi` service when runn
 pytest --embedded-services idf,wokwi
 ```
 
-To limit the amount of simulation time, use the `--wokwi-timeout` flag. For example, to set the simulation time limit to 60 seconds (60000 milliseconds):
+#### Writing Tests
 
-```
-pytest --embedded-services idf,wokwi --wokwi-timeout=60000
+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](https://github.com/wokwi/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](https://wokwi.github.io/wokwi-python-client/)
+
+Button test:
+```py
+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)
 ```

pytest-embedded-wokwi/pytest_embedded_wokwi/wokwi.py

@@ -43,9 +43,6 @@ def __init__(
         firmware_resolver: IDFFirmwareResolver,
         wokwi_diagram: t.Optional[str] = None,
         app: t.Optional['IdfApp'] = None,
-        _wokwi_cli_path: t.Optional[str] = None,  # ignored for compatibility
-        _wokwi_timeout: t.Optional[int] = None,  # ignored for compatibility
-        _wokwi_scenario: t.Optional[str] = None,  # ignored for compatibility
         meta: t.Optional[Meta] = None,
         **kwargs,
     ):
@@ -74,12 +71,8 @@ def __init__(
             self.create_diagram_json()
             wokwi_diagram = os.path.join(self.app.app_path, 'diagram.json')
 
-        # Filter out Wokwi-specific kwargs that shouldn't be passed to subprocess.Popen
-        wokwi_specific_kwargs = {'wokwi_timeout', 'wokwi_scenario', 'wokwi_diagram', 'firmware_resolver', 'app'}
-        filtered_kwargs = {k: v for k, v in kwargs.items() if k not in wokwi_specific_kwargs}
-
         # Initialize parent class
-        super().__init__(msg_queue=msg_queue, meta=meta, **filtered_kwargs)
+        super().__init__(msg_queue=msg_queue, meta=meta, **kwargs)
 
         # Connect and start simulation
         try:
@@ -155,6 +148,7 @@ def close(self):
     def __del__(self):
         """Destructor to ensure cleanup when object is garbage collected."""
         self.close()
+        super().__del__()
 
     def terminate(self):
         """Terminate the Wokwi connection."""

pytest-embedded/pytest_embedded/dut_factory.py

@@ -145,9 +145,6 @@ def _fixture_classes_and_options_fn(
     qemu_prog_path,
     qemu_cli_args,
     qemu_extra_args,
-    wokwi_cli_path,
-    wokwi_timeout,
-    wokwi_scenario,
     wokwi_diagram,
     skip_regenerate_image,
     encrypt,
@@ -313,9 +310,6 @@ def _fixture_classes_and_options_fn(
 
                 classes[fixture] = Wokwi
                 kwargs[fixture].update({
-                    'wokwi_cli_path': wokwi_cli_path,
-                    'wokwi_timeout': wokwi_timeout,
-                    'wokwi_scenario': wokwi_scenario,
                     'wokwi_diagram': wokwi_diagram,
                     'msg_queue': msg_queue,
                     'app': None,
@@ -659,9 +653,6 @@ def create(
         qemu_prog_path: t.Optional[str] = None,
         qemu_cli_args: t.Optional[str] = None,
         qemu_extra_args: t.Optional[str] = None,
-        wokwi_cli_path: t.Optional[str] = None,
-        wokwi_timeout: t.Optional[int] = 0,
-        wokwi_scenario: t.Optional[str] = None,
         wokwi_diagram: t.Optional[str] = None,
         skip_regenerate_image: t.Optional[bool] = None,
         encrypt: t.Optional[bool] = None,
@@ -708,9 +699,6 @@ def create(
             qemu_prog_path: QEMU program path.
             qemu_cli_args: QEMU CLI arguments.
             qemu_extra_args: Additional QEMU arguments.
-            wokwi_cli_path: Wokwi CLI path.
-            wokwi_timeout: Wokwi timeout.
-            wokwi_scenario: Wokwi scenario path.
             wokwi_diagram: Wokwi diagram path.
             skip_regenerate_image: Skip image regeneration flag.
             encrypt: Encryption flag.
@@ -773,9 +761,6 @@ def create(
                 'qemu_prog_path': qemu_prog_path,
                 'qemu_cli_args': qemu_cli_args,
                 'qemu_extra_args': qemu_extra_args,
-                'wokwi_cli_path': wokwi_cli_path,
-                'wokwi_timeout': wokwi_timeout,
-                'wokwi_scenario': wokwi_scenario,
                 'wokwi_diagram': wokwi_diagram,
                 'skip_regenerate_image': skip_regenerate_image,
                 'encrypt': encrypt,

pytest-embedded/pytest_embedded/plugin.py

@@ -297,20 +297,6 @@ def pytest_addoption(parser):
     )
 
     wokwi_group = parser.getgroup('embedded-wokwi')
-    wokwi_group.addoption(
-        '--wokwi-cli-path',
-        help='Path to the wokwi-cli program (Default: "wokwi-cli")',
-    )
-    wokwi_group.addoption(
-        '--wokwi-timeout',
-        default=86400000,
-        type=_gte_one_int,
-        help='Simulation timeout in milliseconds (Default: 86400000)',
-    )
-    wokwi_group.addoption(
-        '--wokwi-scenario',
-        help='Path to the wokwi scenario file (Default: None)',
-    )
     wokwi_group.addoption(
         '--wokwi-diagram',
         help='Path to the wokwi diagram file (Default: None)',
@@ -995,27 +981,6 @@ def keyfile(request: FixtureRequest) -> t.Optional[str]:
 #########
 # Wokwi #
 #########
-@pytest.fixture
-@multi_dut_argument
-def wokwi_cli_path(request: FixtureRequest) -> t.Optional[str]:
-    """Enable parametrization for the same cli option"""
-    return _request_param_or_config_option_or_default(request, 'wokwi_cli_path', None)
-
-
-@pytest.fixture
-@multi_dut_argument
-def wokwi_timeout(request: FixtureRequest) -> t.Optional[str]:
-    """Enable parametrization for the same cli option"""
-    return _request_param_or_config_option_or_default(request, 'wokwi_timeout', None)
-
-
-@pytest.fixture
-@multi_dut_argument
-def wokwi_scenario(request: FixtureRequest) -> t.Optional[str]:
-    """Enable parametrization for the same cli option"""
-    return _request_param_or_config_option_or_default(request, 'wokwi_scenario', None)
-
-
 @pytest.fixture
 @multi_dut_argument
 def wokwi_diagram(request: FixtureRequest) -> t.Optional[str]:
@@ -1079,9 +1044,6 @@ def parametrize_fixtures(
     qemu_prog_path,
     qemu_cli_args,
     qemu_extra_args,
-    wokwi_cli_path,
-    wokwi_timeout,
-    wokwi_scenario,
     wokwi_diagram,
     skip_regenerate_image,
     encrypt,