[nrf fromtree] scripts: runners: Generalize the --dry-run option

Move the argparse.add_argument() call to the abstract base class and
augment the RunnerCaps class with a dry_run parameter.

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

Author: carlescufi

scripts/west_commands/runners/core.py

@@ -318,6 +318,7 @@ class RunnerCaps:
     hide_load_files: bool = False
     rtt: bool = False  # This capability exists separately from the rtt command
                        # to allow other commands to use the rtt address
+    dry_run: bool = False
 
     def __post_init__(self):
         if self.mult_dev_ids and not self.dev_id:
@@ -639,6 +640,10 @@ def add_parser(cls, parser):
         else:
             parser.add_argument('--rtt-address', help=argparse.SUPPRESS)
 
+        parser.add_argument('--dry-run', action='store_true',
+                            help=('''Print all the commands without actually
+                            executing them''' if caps.dry_run else argparse.SUPPRESS))
+
         # Runner-specific options.
         cls.do_add_parser(parser)
 
@@ -685,6 +690,8 @@ def create(cls, cfg: RunnerConfig,
             _missing_cap(cls, '--file-type')
         if args.rtt_address and not caps.rtt:
             _missing_cap(cls, '--rtt-address')
+        if args.dry_run and not caps.dry_run:
+            _missing_cap(cls, '--dry-run')
 
         ret = cls.do_create(cfg, args)
         if args.erase:

scripts/west_commands/runners/nrf_common.py

@@ -75,10 +75,10 @@ def __init__(self, cfg, family, softreset, pinreset, dev_id, erase=False,
                 self.tool_opt += opts
 
     @classmethod
-    def _capabilities(cls, mult_dev_ids=False):
+    def _capabilities(cls, mult_dev_ids=False, dry_run=False):
         return RunnerCaps(commands={'flash'}, dev_id=True,
                           mult_dev_ids=mult_dev_ids, erase=True, reset=True,
-                          tool_opt=True)
+                          tool_opt=True, dry_run=dry_run)
 
     @classmethod
     def _dev_id_help(cls) -> str:

scripts/west_commands/runners/nrfutil.py

@@ -37,7 +37,7 @@ def name(cls):
 
     @classmethod
     def capabilities(cls):
-        return NrfBinaryRunner._capabilities(mult_dev_ids=True)
+        return NrfBinaryRunner._capabilities(mult_dev_ids=True, dry_run=True)
 
     @classmethod
     def dev_id_help(cls) -> str:
@@ -65,10 +65,6 @@ def do_add_parser(cls, parser):
         parser.add_argument('--ext-mem-config-file', required=False,
                             dest='ext_mem_config_file',
                             help='path to an JSON file with external memory configuration')
-        parser.add_argument('--dry-run', required=False,
-                            action='store_true',
-                            help='''Generate all the commands without actually
-                            executing them''')
 
     def _exec(self, args, force=False):
         jout_all = []