[nrf fromtree] scripts: runners: Enable reusing the core dry run logic

In order to avoid duplication of logic in runners, allow subclasses
of ZephyrBinaryRunner to set self.dry_run so that they can then reuse
the logic in core.py to log instead of execute.

Signed-off-by: Carles Cufi <[email protected]>
(cherry picked from commit ffe2028)

Author: carlescufi

scripts/west_commands/runners/core.py

@@ -493,6 +493,9 @@ def __init__(self, cfg: RunnerConfig):
         self.logger = logging.getLogger(f'runners.{self.name()}')
         '''logging.Logger for this instance.'''
 
+        self.dry_run = _DRY_RUN
+        '''log commands instead of executing them. Can be set by subclasses'''
+
     @staticmethod
     def get_runners() -> list[type['ZephyrBinaryRunner']]:
         '''Get a list of all currently defined runner classes.'''
@@ -867,7 +870,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)
@@ -880,7 +883,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)
 
@@ -892,7 +895,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)
 
@@ -904,7 +907,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)
 
@@ -925,7 +928,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

@@ -5,12 +5,10 @@
 '''Runner for flashing with nrfutil.'''
 
 import json
-import shlex
 import subprocess
 import sys
 from pathlib import Path
 
-from runners.core import _DRY_RUN
 from runners.nrf_common import NrfBinaryRunner
 
 
@@ -70,14 +68,10 @@ def _exec(self, args, force=False):
         jout_all = []
 
         cmd = ['nrfutil', '--json', 'device'] + args
+        self._log_cmd(cmd)
 
-        escaped = ' '.join(shlex.quote(s) for s in cmd)
-        if _DRY_RUN or (self.dry_run):
-            self.logger.info(escaped)
-            if not force:
-                return {}
-        else:
-            self.logger.debug(escaped)
+        if self.dry_run and not force:
+            return {}
 
         with subprocess.Popen(cmd, stdout=subprocess.PIPE) as p:
             for line in iter(p.stdout.readline, b''):