Add tests for custom validator usage

Using the mock_module fixture (lifted to top-level conftest), setup a
custom validator which does some "real" validation work.

Author: sirosen

tests/acceptance/test_custom_validator_class.py

@@ -0,0 +1,149 @@
+import json
+
+import pytest
+
+# define a calendar event schema and then use a custom validator to validate that there
+# are no events with "Occult" in their names
+SCHEMA = {
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "definitions": {
+        "calendar-event": {
+            "type": "object",
+            "properties": {
+                "title": {"type": "string"},
+                "start": {"type": "string", "format": "date-time"},
+                "end": {"type": "string", "format": "date-time"},
+            },
+        }
+    },
+    "properties": {
+        "events": {
+            "type": "array",
+            "items": {"$ref": "#/definitions/calendar-event"},
+        },
+    },
+    "required": ["events"],
+}
+VALID_DOC = {
+    "events": [
+        {
+            "title": "Weekly Production Meeting",
+            "start": "2019-06-24T09:00:00-05:00",
+            "end": "2019-06-24T10:00:00-05:00",
+        },
+        {
+            "title": "Catch Up",
+            "start": "2019-06-24T10:00:00-05:00",
+            "end": "2019-06-24T10:30:00-05:00",
+        },
+    ]
+}
+INVALID_DOC = {
+    "events": [
+        {
+            "title": "Weekly Production Meeting",
+            "start": "2019-06-24T09:00:00-05:00",
+            "end": "2019-06-24T10:00:00-05:00",
+        },
+        {
+            "title": "Catch Up",
+            "start": "2019-06-24T10:00:00-05:00",
+            "end": "2019-06-24T10:30:00-05:00",
+        },
+        {
+            "title": "Occult Study Session",
+            "start": "2019-06-24T10:00:00-05:00",
+            "end": "2019-06-24T12:00:00-05:00",
+        },
+    ]
+}
+
+
+@pytest.fixture(autouse=True)
+def _foo_module(mock_module):
+    mock_module(
+        "foo.py",
+        """\
+import jsonschema
+
+class MyValidator:
+    def __init__(self, schema, *args, **kwargs):
+        self.schema = schema
+        self.real_validator = jsonschema.validators.Draft7Validator(
+            schema, *args, **kwargs
+        )
+
+    def iter_errors(self, data, *args, **kwargs):
+        yield from self.real_validator.iter_errors(data, *args, **kwargs)
+        for event in data["events"]:
+            if "Occult" in event["title"]:
+                yield jsonschema.exceptions.ValidationError(
+                    "Error! Occult event detected! Run!",
+                    validator=None,
+                    validator_value=None,
+                    instance=event,
+                    schema=self.schema,
+                )
+""",
+    )
+
+
+def test_custom_validator_class_can_detect_custom_conditions(run_line, tmp_path):
+    doc = tmp_path / "invalid.json"
+    doc.write_text(json.dumps(INVALID_DOC))
+
+    schema = tmp_path / "schema.json"
+    schema.write_text(json.dumps(SCHEMA))
+
+    result = run_line(
+        [
+            "check-jsonschema",
+            "--schemafile",
+            str(schema),
+            str(doc),
+        ]
+    )
+    assert result.exit_code == 0, result.stdout  # pass
+
+    result = run_line(
+        [
+            "check-jsonschema",
+            "--schemafile",
+            str(schema),
+            "--validator-class",
+            "foo:MyValidator",
+            str(doc),
+        ],
+    )
+    assert result.exit_code == 1  # fail
+    assert "Occult event detected" in result.stdout, result.stdout
+
+
+def test_custom_validator_class_can_pass_when_valid(run_line, tmp_path):
+    doc = tmp_path / "valid.json"
+    doc.write_text(json.dumps(VALID_DOC))
+
+    schema = tmp_path / "schema.json"
+    schema.write_text(json.dumps(SCHEMA))
+
+    result = run_line(
+        [
+            "check-jsonschema",
+            "--schemafile",
+            str(schema),
+            str(doc),
+        ]
+    )
+    assert result.exit_code == 0, result.stdout  # pass
+
+    result = run_line(
+        [
+            "check-jsonschema",
+            "--schemafile",
+            str(schema),
+            "--validator-class",
+            "foo:MyValidator",
+            str(doc),
+        ],
+    )
+    assert result.exit_code == 0  # pass

tests/conftest.py

@@ -1,3 +1,6 @@
+import pathlib
+import sys
+
 import pytest
 import responses
 
@@ -8,3 +11,30 @@ def mocked_responses():
     yield
     responses.stop()
     responses.reset()
+
+
+@pytest.fixture
+def mock_module(tmp_path, monkeypatch):
+    monkeypatch.syspath_prepend(tmp_path)
+    all_names_to_clear = []
+
+    def func(path, text):
+        path = pathlib.Path(path)
+        mod_dir = tmp_path / (path.parent)
+        mod_dir.mkdir(parents=True, exist_ok=True)
+        for part in path.parts[:-1]:
+            (tmp_path / part / "__init__.py").touch()
+
+        (tmp_path / path).write_text(text)
+
+        for i in range(len(path.parts)):
+            modname = ".".join(path.parts[: i + 1])
+            if modname.endswith(".py"):
+                modname = modname[:-3]
+            all_names_to_clear.append(modname)
+
+    yield func
+
+    for name in all_names_to_clear:
+        if name in sys.modules:
+            del sys.modules[name]

tests/unit/test_cli_parse.py

@@ -1,7 +1,5 @@
 from __future__ import annotations
 
-import pathlib
-import sys
 from unittest import mock
 
 import click
@@ -29,33 +27,6 @@ def mock_parse_result():
         yield args
 
 
-@pytest.fixture
-def mock_module(tmp_path, monkeypatch):
-    monkeypatch.syspath_prepend(tmp_path)
-    all_names_to_clear = []
-
-    def func(path, text):
-        path = pathlib.Path(path)
-        mod_dir = tmp_path / (path.parent)
-        mod_dir.mkdir(parents=True, exist_ok=True)
-        for part in path.parts[:-1]:
-            (tmp_path / part / "__init__.py").touch()
-
-        (tmp_path / path).write_text(text)
-
-        for i in range(len(path.parts)):
-            modname = ".".join(path.parts[: i + 1])
-            if modname.endswith(".py"):
-                modname = modname[:-3]
-            all_names_to_clear.append(modname)
-
-    yield func
-
-    for name in all_names_to_clear:
-        if name in sys.modules:
-            del sys.modules[name]
-
-
 @pytest.fixture(autouse=True)
 def mock_cli_exec(boxed_context):
     def get_ctx(*args):
@@ -310,9 +281,7 @@ def test_can_specify_custom_validator_class(runner, mock_parse_result, mock_modu
 @pytest.mark.parametrize(
     "failmode", ("syntax", "import", "attr", "function", "non_callable")
 )
-def test_can_custom_validator_class_fails(
-    runner, mock_parse_result, mock_module, failmode
-):
+def test_custom_validator_class_fails(runner, mock_parse_result, mock_module, failmode):
     mock_module(
         "foo.py",
         """\