twister: pass flash_command to the harness

Add the necessary logic to pass the custom flash_command to the pytest
harness.

Signed-off-by: Fabio Baltieri <[email protected]>

Author: fabiobaltieri

scripts/pylib/pytest-twister-harness/src/twister_harness/device/hardware_adapter.py

@@ -38,8 +38,23 @@ def __init__(self, device_config: DeviceConfig) -> None:
         self.device_log_path: Path = device_config.build_dir / 'device.log'
         self._log_files.append(self.device_log_path)
 
+    def _generate_flash_command(self) -> None:
+        command = [self.device_config.flash_command[0]]
+        command.extend(['--build-dir', str(self.device_config.build_dir)])
+
+        if self.device_config.id:
+            command.extend(['--board-id', self.device_config.id])
+
+        command.extend(self.device_config.flash_command[1:])
+
+        self.command = command
+
     def generate_command(self) -> None:
         """Return command to flash."""
+        if self.device_config.flash_command:
+            self._generate_flash_command()
+            return
+
         command = [
             self.west,
             'flash',

scripts/pylib/pytest-twister-harness/src/twister_harness/plugin.py

@@ -102,6 +102,10 @@ def pytest_addoption(parser: pytest.Parser):
              'E.g. --west-flash-extra-args="--board-id=foobar,--erase" '
              'will translate to "west flash -- --board-id=foobar --erase".'
     )
+    twister_harness_group.addoption(
+        '--flash-command',
+        help='Use a custom flash command for flashing.'
+    )
     twister_harness_group.addoption(
         '--pre-script',
         metavar='PATH',

scripts/pylib/pytest-twister-harness/src/twister_harness/twister_harness_config.py

@@ -4,6 +4,7 @@
 
 from __future__ import annotations
 
+import csv
 import logging
 from dataclasses import dataclass, field
 from pathlib import Path
@@ -30,6 +31,7 @@ class DeviceConfig:
     serial_pty: str = ''
     flash_before: bool = False
     west_flash_extra_args: list[str] = field(default_factory=list, repr=False)
+    flash_command: str = ''
     name: str = ''
     pre_script: Path | None = None
     post_script: Path | None = None
@@ -60,6 +62,9 @@ def create(cls, config: pytest.Config) -> TwisterHarnessConfig:
         west_flash_extra_args: list[str] = []
         if config.option.west_flash_extra_args:
             west_flash_extra_args = [w.strip() for w in config.option.west_flash_extra_args.split(',')]
+        flash_command: list[str] = []
+        if config.option.flash_command:
+            flash_command = [w.strip() for w in next(csv.reader([config.option.flash_command]))]
         runner_params: list[str] = []
         if config.option.runner_params:
             runner_params = [w.strip() for w in config.option.runner_params]
@@ -78,6 +83,7 @@ def create(cls, config: pytest.Config) -> TwisterHarnessConfig:
             serial_pty=config.option.device_serial_pty,
             flash_before=bool(config.option.flash_before),
             west_flash_extra_args=west_flash_extra_args,
+            flash_command=flash_command,
             pre_script=_cast_to_path(config.option.pre_script),
             post_script=_cast_to_path(config.option.post_script),
             post_flash_script=_cast_to_path(config.option.post_flash_script),

scripts/pylib/pytest-twister-harness/tests/device/hardware_adapter_test.py

@@ -25,6 +25,7 @@ def fixture_adapter(tmp_path) -> HardwareAdapter:
         platform='platform',
         id='p_id',
         base_timeout=5.0,
+        flash_command='',
     )
     return HardwareAdapter(device_config)
 
@@ -181,6 +182,14 @@ def test_if_get_command_returns_proper_string_with_west_flash_extra_args(
     ]
 
 
+def test_if_get_command_flash_command(device: HardwareAdapter) -> None:
+    device.device_config.build_dir = Path('build')
+    device.device_config.flash_command = ['flash_command', '--with-arg']
+    device.generate_command()
+    assert isinstance(device.command, list)
+    assert device.command == ['flash_command', '--build-dir', 'build', '--board-id', 'p_id', '--with-arg']
+
+
 def test_if_hardware_adapter_raises_exception_empty_command(device: HardwareAdapter) -> None:
     device.command = []
     exception_msg = 'Flash command is empty, please verify if it was generated properly.'

scripts/pylib/twister/twisterlib/harness.py

@@ -479,6 +479,9 @@ def _generate_parameters_for_hardware(self, handler: Handler):
         if options.west_flash and options.west_flash != []:
             command.append(f'--west-flash-extra-args={options.west_flash}')
 
+        if options.flash_command:
+            command.append(f'--flash-command={options.flash_command}')
+
         if board_id := hardware.probe_id or hardware.id:
             command.append(f'--device-id={board_id}')
 

scripts/tests/twister/test_harness.py

@@ -564,6 +564,7 @@ def test_pytest__generate_parameters_for_hardware(tmp_path, pty_value, hardware_
 
     options = handler.options
     options.west_flash = "args"
+    options.flash_command = "flash_command"
 
     hardware.probe_id = "123"
     hardware.product = "product"
@@ -597,6 +598,7 @@ def test_pytest__generate_parameters_for_hardware(tmp_path, pty_value, hardware_
         assert "--runner-params=--runner-param1" in command
         assert "--runner-params=runner-param2" in command
         assert "--west-flash-extra-args=args" in command
+        assert "--flash-command=flash_command" in command
         assert "--device-id=123" in command
         assert "--device-product=product" in command
         assert "--pre-script=pre_script" in command