wip

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>

Author: kartben

scripts/pylib/twister/scl.py

@@ -8,8 +8,12 @@
 # Set of code that other projects can also import to do things on
 # Zephyr's sanity check testcases.
 
+import jsonschema
 import logging
 import yaml
+
+from jsonschema.exceptions import best_match
+
 try:
     # Use the C LibYAML parser if available, rather than the Python parser.
     # It's much faster.
@@ -20,7 +24,8 @@
     from yaml import Loader, SafeLoader, Dumper
 
 log = logging.getLogger("scl")
-
+# Cache for validators to avoid recreating them for the same JSON schema
+_validator_cache = {}
 
 class EmptyYamlFileException(Exception):
     pass
@@ -51,23 +56,21 @@ def yaml_load(filename):
                   e.note, cmark.name, cmark.line, cmark.column, e.context)
         raise
 
-# If pykwalify is installed, then the validate function will work --
-# otherwise, it is a stub and we'd warn about it.
-try:
-    import pykwalify.core
-    # Don't print error messages yourself, let us do it
-    logging.getLogger("pykwalify.core").setLevel(50)
+def _yaml_validate(data, schema):
+    if not schema:
+        return
 
-    def _yaml_validate(data, schema):
-        if not schema:
-            return
-        c = pykwalify.core.Core(source_data=data, schema_data=schema)
-        c.validate(raise_exception=True)
+    schema_key = id(schema)
+    if schema_key not in _validator_cache:
+        validator_class = jsonschema.validators.validator_for(schema)
+        validator_class.check_schema(schema)
+        _validator_cache[schema_key] = validator_class(schema)
 
-except ImportError as e:
-    log.warning("can't import pykwalify; won't validate YAML (%s)", e)
-    def _yaml_validate(data, schema):
-        pass
+    validator = _validator_cache[schema_key]
+    errors = list(validator.iter_errors(data))
+    if errors:
+        err = best_match(errors)
+        raise jsonschema.ValidationError(f"Error: {err.message} in {err.json_path}")
 
 def yaml_load_verify(filename, schema):
     """
@@ -79,7 +82,7 @@ def yaml_load_verify(filename, schema):
 
     # 'document.yaml' contains a single YAML document.
     :raises yaml.scanner.ScannerError: on YAML parsing error
-    :raises pykwalify.errors.SchemaError: on Schema violation error
+    :raises jsonschema.exceptions.ValidationError: on Schema violation error
     """
     # 'document.yaml' contains a single YAML document.
     y = yaml_load(filename)

scripts/schemas/twister/hwmap-schema.yaml

@@ -1,79 +1,60 @@
-type: seq
-sequence:
-  - type: map
-    required: false
-    mapping:
-      "available":
-        type: bool
-        required: false
-      "connected":
-        type: bool
-        required: true
-      "id":
-        type: str
-        required: true
-      "notes":
-        type: str
-        required: false
-      "platform":
-        type: any
-        required: true
-      "probe_id":
-        type: str
-        required: false
-      "product":
-        type: str
-        required: true
-      "runner":
-        type: str
-        required: true
-      "runner_params":
-        type: seq
-        required: false
-        sequence:
-          - type: str
-      "serial_pty":
-        type: str
-        required: false
-      "serial":
-        type: str
-        required: false
-      "baud":
-        type: int
-        required: false
-      "post_script":
-        type: str
-        required: false
-      "post_flash_script":
-        type: str
-        required: false
-      "pre_script":
-        type: str
-        required: false
-      "fixtures":
-        type: seq
-        required: false
-        sequence:
-          - type: str
-      "flash_timeout":
-        type: int
-        required: false
-      "flash_with_test":
-        type: bool
-        required: false
-      "flash_before":
-        type: bool
-        required: false
-      "script_param":
-        type: map
-        required: false
-        mapping:
-          "pre_script_timeout":
-            type: int
-            required: false
-          "post_script_timeout":
-            type: int
-            required: false
-          "post_flash_timeout":
-            type: int
-            required: false
+$schema: "https://json-schema.org/draft/2020-12/schema"
+$id: "https://zephyrproject.org/schemas/twister/hwmap-schema"
+title: "Zephyr Hardware Map Schema"
+description: "Schema to validate a YAML file describing Zephyr hardware mapping"
+type: "array"
+items:
+  type: "object"
+  required: ["connected", "id", "platform", "product", "runner"]
+  properties:
+    available:
+      type: "boolean"
+    connected:
+      type: "boolean"
+    id:
+      type: "string"
+    notes:
+      type: "string"
+    platform:
+      type: "string"
+    probe_id:
+      type: "string"
+    product:
+      type: "string"
+    runner:
+      type: "string"
+    runner_params:
+      type: "array"
+      items:
+        type: "string"
+    serial_pty:
+      type: "string"
+    serial:
+      type: "string"
+    baud:
+      type: "integer"
+    post_script:
+      type: "string"
+    post_flash_script:
+      type: "string"
+    pre_script:
+      type: "string"
+    fixtures:
+      type: "array"
+      items:
+        type: "string"
+    flash_timeout:
+      type: "integer"
+    flash_with_test:
+      type: "boolean"
+    flash_before:
+      type: "boolean"
+    script_param:
+      type: "object"
+      properties:
+        pre_script_timeout:
+          type: "integer"
+        post_script_timeout:
+          type: "integer"
+        post_flash_timeout:
+          type: "integer"