twister: replace pykwalify with jsonschema

Usage of pykwalify is deprecated.

Signed-off-by: Guðni Már Gilbert <gudni.m.g@gmail.com>

Author: gudnimg

scripts/pylib/twister/scl.py

@@ -1,23 +1,20 @@
-#! /usr/bin/python
+#!/usr/bin/env python3
 #
 # SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: Copyright The Zephyr Project Contributors
 # Zephyr's Twister library
 #
-# pylint: disable=unused-import
-#
 # Set of code that other projects can also import to do things on
 # Zephyr's sanity check testcases.
 
 import logging
 import yaml
 try:
-    # Use the C LibYAML parser if available, rather than the Python parser.
-    # It's much faster.
-    from yaml import CLoader as Loader
     from yaml import CSafeLoader as SafeLoader
-    from yaml import CDumper as Dumper
 except ImportError:
-    from yaml import Loader, SafeLoader, Dumper
+    from yaml import SafeLoader
+
+from jsonschema import Draft202012Validator
 
 log = logging.getLogger("scl")
 
@@ -26,8 +23,6 @@ class EmptyYamlFileException(Exception):
     pass
 
 
-#
-#
 def yaml_load(filename):
     """
     Safely load a YAML document
@@ -51,23 +46,23 @@ 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):
+    """
+    Validate loaded YAML data against a JSON Schema.
+
+    :param dict data: YAML document data
+    :param dict schema: JSON Schema (already loaded)
+    :raises jsonschema.exceptions.ValidationError: on schema violation
+    :raises jsonschema.exceptions.SchemaError: on invalid 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)
+    validator = Draft202012Validator(schema)
 
-except ImportError as e:
-    log.warning("can't import pykwalify; won't validate YAML (%s)", e)
-    def _yaml_validate(data, schema):
-        pass
+    # Fail fast on first error
+    for error in validator.iter_errors(data):
+        raise error
 
 def yaml_load_verify(filename, schema):
     """
@@ -77,9 +72,9 @@ def yaml_load_verify(filename, schema):
     :param str filename: name of the file to load and process
     :param dict schema: loaded YAML schema (can load with :func:`yaml_load`)
 
-    # '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
+    :raises jsonschema.exceptions.SchemaError: on Schema violation error
     """
     # 'document.yaml' contains a single YAML document.
     y = yaml_load(filename)

scripts/schemas/twister/hwmap-schema.yaml

@@ -1,82 +1,65 @@
-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
-      "serial_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"
+type: array
+items:
+  type: object
+  properties:
+    available:
+      type: boolean
+    connected:
+      type: boolean
+    id:
+      type: string
+    notes:
+      type: string
+    platform: {}
+    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
+    serial_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
+      additionalProperties: false
+  required:
+    - connected
+    - id
+    - platform
+    - product
+    - runner
+  additionalProperties: false