scripts: west_commands: introduce ncs-board-actions

Add a new command that allows to obtain a list of available board
actions given a board directory. For now, only nRF54H boards have
an action. Script may be improved in the future if list of commands
grows.

Signed-off-by: Gerard Marull-Paretas <[email protected]>

Author: gmarull

CODEOWNERS

@@ -658,6 +658,7 @@
 /scripts/requirements-*.txt               @nrfconnect/ncs-co-build-system @nrfconnect/ncs-ci
 /scripts/west_commands/create_board/      @gmarull
 /scripts/west_commands/ncs-bicr.py        @gmarull
+/scripts/west_commands/ncs-board-actions.py @gmarull
 /scripts/west_commands/sbom/              @nrfconnect/ncs-si-muffin
 /scripts/west_commands/thingy91x_dfu.py   @nrfconnect/ncs-cia
 /scripts/west_commands/ncs-provision.py   @nrfconnect/ncs-pluto

scripts/west-commands.yml

@@ -44,3 +44,8 @@ west-commands:
       - name: ncs-bicr
         class: NcsBICR
         help: Assist with board BICR creation for any applicable Nordic SoC
+  - file: scripts/west_commands/ncs-board-actions.py
+    commands:
+      - name: ncs-board-actions
+        class: NcsBoardActions
+        help: Obtain available actions for any board

scripts/west_commands/ncs-board-actions.py

@@ -0,0 +1,78 @@
+# Copyright (c) 2024 Nordic Semiconductor ASA
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+
+import json
+import os
+import re
+from pathlib import Path
+
+from west.commands import WestCommand
+
+
+def soc_series_detect(board_dir):
+    found_defconfig = None
+    for defconfig in board_dir.glob("Kconfig.*"):
+        if defconfig.name == "Kconfig.defconfig":
+            continue
+
+        found_defconfig = defconfig
+        break
+
+    if not found_defconfig:
+        raise FileNotFoundError("Board defconfig file not found")
+
+    with open(found_defconfig, "r") as f:
+        for line in f.readlines():
+            m = re.match(".*select SOC_(NRF[0-9]{2}[A-Z]{,1}).*", line)
+            if not m:
+                continue
+
+            return m.group(1).lower()
+
+    raise ValueError("Unsupported board")
+
+
+class NcsBoardActions(WestCommand):
+    def __init__(self):
+        super().__init__(
+            "ncs-board-actions", "Obtain available actions for any board", ""
+        )
+
+    def do_add_parser(self, parser_adder):
+        parser = parser_adder.add_parser(
+            self.name, help=self.help, description=self.description
+        )
+
+        parser.add_argument(
+            "-d", "--board-dir", type=Path, help="Target board directory"
+        )
+
+        return parser
+
+    def do_run(self, args, unknown_args):
+        board_dir = args.board_dir
+        if not board_dir:
+            board_dir = Path(os.getcwd())
+
+        board_spec = board_dir / "board.yml"
+        if not board_spec.exists():
+            raise FileNotFoundError("Invalid board directory")
+
+        series = soc_series_detect(board_dir)
+        commands = []
+
+        if series == "nrf54h":
+            commands.extend(
+                [
+                    {
+                        "name": "Create/Edit BICR",
+                        "command": "west",
+                        "args": ["ncs-bicr", "--board-dir", str(board_dir.resolve())],
+                        "properties": {
+                            "providesJsonSchema": True,
+                        }
+                    }
+                ]
+            )
+
+        print(json.dumps({"commands": commands}))