scripts: west_commands: install JSON hook to commands using jsonschema

Commands using a jsonschema based protocol will now report errors formatted in JSON. Signed-off-by: Gerard Marull-Paretas <[email protected]>
nrfconnect · Jan 2, 2025 · aa67175 · aa67175
1 parent 468f3b3
commit aa67175
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 7 deletions.
diff --git a/scripts/west_commands/create_board/ncs_create_board.py b/scripts/west_commands/create_board/ncs_create_board.py
@@ -4,10 +4,10 @@
 from pathlib import Path
 import json
 import shutil
+import sys
 
 from jinja2 import Environment, FileSystemLoader
 from west.commands import WestCommand
-from west import log
 from yaml import load
 import jsonschema
 
@@ -16,6 +16,12 @@
 except ImportError:
     from yaml import Loader
 
+sys.path.append(str(Path(__file__).parents[1]))
+import utils
+
+
+utils.install_json_excepthook()
+
 
 SCRIPT_DIR = Path(__file__).absolute().parent
 TEMPLATE_DIR = SCRIPT_DIR / "templates"
@@ -67,7 +73,7 @@ def do_run(self, args, unknown_args):
         try:
             jsonschema.validate(input, schema)
         except jsonschema.ValidationError as e:
-            raise Exception("Board configuration is not valid") from e
+            raise ValueError("Board configuration is not valid") from e
 
         soc_parts = input["soc"].split("-")
         req_soc = soc_parts[0].lower()
@@ -86,8 +92,7 @@ def do_run(self, args, unknown_args):
                     break
 
         if not series:
-            log.err(f"Invalid/unsupported SoC: {req_soc}")
-            return
+            raise ValueError(f"Invalid/unsupported SoC: {req_soc}")
 
         targets = []
         for variant in soc["variants"]:
@@ -130,8 +135,7 @@ def do_run(self, args, unknown_args):
                 break
 
         if not targets:
-            log.err(f"Invalid/unsupported variant: {req_variant}")
-            return
+            raise ValueError(f"Invalid/unsupported variant: {req_variant}")
 
         # prepare Jinja environment
         env = Environment(

diff --git a/scripts/west_commands/ncs-bicr.py b/scripts/west_commands/ncs-bicr.py
@@ -3,11 +3,18 @@
 
 import json
 import os
+import sys
 from pathlib import Path
 
 import jsonschema
 from west.commands import WestCommand
 
+sys.path.append(str(Path(__file__).parent))
+import utils
+
+
+utils.install_json_excepthook()
+
 
 SCRIPT_DIR = Path(__file__).absolute().parent
 SCHEMA = SCRIPT_DIR.parents[2] / "zephyr" / "soc" / "nordic" / "nrf54h" / "bicr" / "bicr-schema.json"
@@ -65,7 +72,7 @@ def do_run(self, args, unknown_args):
             try:
                 jsonschema.validate(bicr, schema)
             except jsonschema.ValidationError as e:
-                raise Exception("Invalid BICR") from e
+                raise ValueError("Invalid BICR") from e
 
         if args.json_schema:
             schema = {

diff --git a/scripts/west_commands/ncs-board-actions.py b/scripts/west_commands/ncs-board-actions.py
@@ -9,6 +9,12 @@
 
 from west.commands import WestCommand
 
+sys.path.append(str(Path(__file__).parent))
+import utils
+
+
+utils.install_json_excepthook()
+
 
 SCRIPT_DIR = Path(__file__).absolute().parent
 BICRGEN = (