scripts: runners: Generalize the dry run option for subclass use

Add a new parameter to the ZephyrBinaryRunner init() method to specify
whether this should be a dry run. The default is still taken from the
_DRY_RUN global, but can be overridden by subclasses.

Since the new dry_run parameter has a default value this should not
break backwards compatibility with out-of-tree runners.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>

Author: carlescufi

scripts/west_commands/runners/core.py

@@ -42,6 +42,8 @@
 # info rather than debug level), without actually running them. This
 # can break runners that are expecting output or if one command
 # depends on another, so it's just for debugging.
+# Note that this is also configurable at ZephyrBinaryRunner init() time, with
+# the default being taken from this global
 _DRY_RUN = False
 
 _logger = logging.getLogger('runners')
@@ -483,12 +485,15 @@ class ZephyrBinaryRunner(abc.ABC):
     commands in its constructor.  The actual command execution is
     handled in the run() method.'''
 
-    def __init__(self, cfg: RunnerConfig):
+    def __init__(self, cfg: RunnerConfig, dry_run: bool=_DRY_RUN):
         '''Initialize core runner state.'''
 
         self.cfg = cfg
         '''RunnerConfig for this instance.'''
 
+        self.dry_run = dry_run
+        '''Dry run or not for this instance.'''
+
         self.logger = logging.getLogger(f'runners.{self.name()}')
         '''logging.Logger for this instance.'''
 
@@ -860,7 +865,7 @@ def run_client(self, client, **kwargs):
 
     def _log_cmd(self, cmd: list[str]):
         escaped = ' '.join(shlex.quote(s) for s in cmd)
-        if not _DRY_RUN:
+        if not self.dry_run:
             self.logger.debug(escaped)
         else:
             self.logger.info(escaped)
@@ -873,7 +878,7 @@ def call(self, cmd: list[str], **kwargs) -> int:
         using subprocess directly, to keep accurate debug logs.
         '''
         self._log_cmd(cmd)
-        if _DRY_RUN:
+        if self.dry_run:
             return 0
         return subprocess.call(cmd, **kwargs)
 
@@ -885,7 +890,7 @@ def check_call(self, cmd: list[str], **kwargs):
         using subprocess directly, to keep accurate debug logs.
         '''
         self._log_cmd(cmd)
-        if _DRY_RUN:
+        if self.dry_run:
             return
         subprocess.check_call(cmd, **kwargs)
 
@@ -897,7 +902,7 @@ def check_output(self, cmd: list[str], **kwargs) -> bytes:
         using subprocess directly, to keep accurate debug logs.
         '''
         self._log_cmd(cmd)
-        if _DRY_RUN:
+        if self.dry_run:
             return b''
         return subprocess.check_output(cmd, **kwargs)
 
@@ -918,7 +923,7 @@ def popen_ignore_int(self, cmd: list[str], **kwargs) -> subprocess.Popen:
             preexec = os.setsid # type: ignore
 
         self._log_cmd(cmd)
-        if _DRY_RUN:
+        if self.dry_run:
             return _DebugDummyPopen()  # type: ignore
 
         return subprocess.Popen(cmd, creationflags=cflags, preexec_fn=preexec, **kwargs)

scripts/west_commands/runners/nrfutil.py

@@ -9,7 +9,6 @@
 import sys
 from pathlib import Path
 
-from runners.core import _DRY_RUN
 from runners.nrf_common import NrfBinaryRunner
 
 
@@ -70,7 +69,7 @@ def _exec(self, args):
         cmd = ['nrfutil', '--json', 'device'] + args
         self._log_cmd(cmd)
 
-        if _DRY_RUN:
+        if self.dry_run:
             return {}
 
         with subprocess.Popen(cmd, stdout=subprocess.PIPE) as p: