Merge ~jslarraz/review-tools:unify-validate-call into review-tools:master

[Jorge Sancho Larraz]

sr_lint,test_schema_base: unify how jsonschema.validate is called in sr_lint and tests

Unmerged commits

bc8a130... by Jorge Sancho Larraz on 2024-05-23

rt/{sr_lint,tests/schema}: unify how jsonschema is validated

	test:0 (build)
	coverage:0 (build)

1 → 2 of 2 results

First • Previous • Next • Last

diff --git a/reviewtools/schemas/schema_validator.py b/reviewtools/schemas/schema_validator.py
 new file mode 100644
index 0000000..20946d4
--- /dev/null
+++ b/reviewtools/schemas/schema_validator.py
@@ -0,0 +1,14 @@
+import os
+import jsonschema
+
+
+def validate(yaml, schema):
+    resolver = jsonschema.RefResolver(
+        "file://%s/" % os.path.abspath(os.path.dirname(__file__)), None
+    )
+
+    try:
+        jsonschema.validate(yaml, schema, resolver=resolver)
+        return None
+    except jsonschema.ValidationError as e:
+        return e
diff --git a/reviewtools/sr_lint.py b/reviewtools/sr_lint.py
index 68a7664..1d4caae 100644
--- a/reviewtools/sr_lint.py
+++ b/reviewtools/sr_lint.py
@@ -15,6 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from __future__ import print_function
+from reviewtools.schemas.schema_validator import validate
 from reviewtools.sr_common import SnapReview
 from reviewtools.common import (
     find_external_symlinks,
@@ -31,7 +32,6 @@ import os
 import re
 import shlex
 import unicodedata
-import jsonschema
 import json
 
 
@@ -77,17 +77,14 @@ class SnapReviewLint(SnapReview):
 
     def check_schema(self):
         """Check snap.yaml against the schema"""
-        t = "info"
         n = self._get_check_name("snap_schema")
-        s = "OK"
         manual_review = False
 
         with open("reviewtools/schemas/snap.json") as fd:
             schema = json.loads(fd.read())
 
-        try:
-            jsonschema.validate(self.snap_yaml, schema)
-        except jsonschema.ValidationError as e:
+        e = validate(self.snap_yaml, schema)
+        if e is not None:
             e.absolute_path.appendleft("$")
             t = "error"
             s = "Error found in snap.yaml while validating %s: %s" % (
diff --git a/reviewtools/tests/schemas/test_schema_against_store.py b/reviewtools/tests/schemas/test_schema_against_store.py
index 16259e2..8020f1b 100644
--- a/reviewtools/tests/schemas/test_schema_against_store.py
+++ b/reviewtools/tests/schemas/test_schema_against_store.py
@@ -3,8 +3,8 @@ import json
 import yaml
 import os
 import sys
-import jsonschema
 import unittest
+from reviewtools.schemas.schema_validator import validate
 
 SNAP_SCHEMA = "reviewtools/schemas/snap.json"
 SNAP_YAML_CACHE = os.path.expanduser("~/.cache/review-tools")
@@ -60,9 +60,8 @@ def test_store():
             continue
 
         # Validate the snap.yaml against the schema
-        try:
-            jsonschema.validate(snap_yaml, snap_schema)
-        except jsonschema.ValidationError as e:
+        e = validate(snap_yaml, snap_schema)
+        if e is not None:
             print(
                 "Error to validate %s for snap %s: %s" % (e.json_path, snap, e.message)
             )
diff --git a/reviewtools/tests/schemas/test_schema_base.py b/reviewtools/tests/schemas/test_schema_base.py
index b41f5dd..9a39e16 100644
--- a/reviewtools/tests/schemas/test_schema_base.py
+++ b/reviewtools/tests/schemas/test_schema_base.py
@@ -1,7 +1,7 @@
 import json
-import jsonschema
 import copy
 import unittest
+from reviewtools.schemas.schema_validator import validate
 
 
 class TestSchemaBase(unittest.TestCase):
@@ -14,17 +14,9 @@ class TestSchemaBase(unittest.TestCase):
             self.schema = json.loads(fd.read())
 
         # Validate base yaml against the schema
-        error = self._validate(self.yaml, self.schema)
+        error = validate(self.yaml, self.schema)
         self.assertEqual(None, error)
 
-    def _validate(self, yaml, schema):
-        # Validate yaml against the schema
-        try:
-            jsonschema.validate(yaml, schema)
-            return None
-        except jsonschema.ValidationError as e:
-            return e.message
-
     def _test_value(self, key, value, expected_error):
         # Prepare yaml, make a copy so we use the pristine yaml on each subtest
         yaml = copy.deepcopy(self.yaml)
@@ -34,11 +26,11 @@ class TestSchemaBase(unittest.TestCase):
         else:
             yaml[key] = value
 
-        # Validate the schema
-        error = self._validate(yaml, self.schema)
+        # Validate yaml against the schema
+        e = validate(yaml, self.schema)
 
         # Compare the errors against the expected ones
         if expected_error is None:
-            self.assertIsNone(error)
+            self.assertIsNone(e.message)
         else:
-            self.assertIn(expected_error, error)
+            self.assertIn(expected_error, e.message)