Add example checker (#38)

setup.cfg

@@ -68,6 +68,7 @@ where = src
 tests =
     pytest
     coverage
+    jsonschema
 docs =
     sphinx
     sphinx-rtd-theme

src/acsets/schemas/__init__.py

@@ -0,0 +1,8 @@
+"""Schemas and examples."""
+
+from pathlib import Path
+
+HERE = Path(__file__).parent.resolve()
+CATLAB = HERE.joinpath("catlab")
+JSONSCHEMA = HERE.joinpath("jsonschema")
+EXAMPLES = HERE.joinpath("examples")

src/acsets/schemas/examples/README.md

@@ -0,0 +1,3 @@
+# Examples
+
+This repository contains examples corresponding to the JSON schemata.

tests/test_examples.py

@@ -0,0 +1,23 @@
+"""Test that the examples are valid."""
+
+import json
+import unittest
+
+import jsonschema
+from acsets.schemas import EXAMPLES, CATLAB, JSONSCHEMA
+
+
+class TestExamples(unittest.TestCase):
+    """Test all examples are valid wrt their related schema."""
+
+    def test_examples_valid(self):
+        """Test examples."""
+        for example in EXAMPLES.glob("*.json"):
+            with self.subTest(example=example.name):
+                jsonschema_path = JSONSCHEMA.joinpath(example.name)
+                self.assertTrue(
+                    jsonschema_path.is_file(), msg="No corresponding JSON schema for example"
+                )
+                jsonschema_obj = json.loads(jsonschema_path.read_text())
+                example_obj = json.loads(example.read_text())
+                jsonschema.validate(instance=example_obj, schema=jsonschema_obj)