Validate the SpaceAPI JSON using the validator service

Author: nikdoof

tests/test_spaceapi.py

@@ -1,24 +1,44 @@
+import requests
 from spacedirectory.models.space import Space
 
 from tests.utils import FastAPIVCRTestCase, client
 
 
+def validate_spacejson_schema(data):
+    """
+    Call the SpaceAPI validator service
+    """
+    resp = requests.post(
+        "https://validator.spaceapi.io/v2/validateJSON",
+        headers={"Content-Type": "application/json"},
+        json=data,
+    )
+
+    assert resp.ok
+    rdata = resp.json()
+
+    # If we have schema errors, print them so they'll be visible when the test fails
+    if "schemaErrors" in rdata and len(rdata["schemaErrors"]):
+        for err in rdata["schemaErrors"]:
+            print(err)
+    assert rdata["valid"] is True
+
+
 class SpaceAPINoNetworkTestCase(FastAPIVCRTestCase):
     """
     Test the SpaceAPI when we've got no on-going network to the backend systems
     """
 
     vcr_enabled = False
 
-    def test_space_json_no_network(self):
+    def setUp(self):
         # Disable the service functions (covered by separate tests)
         # Use the 'imported path' rather than the module path, see: https://nedbatchelder.com/blog/201908/why_your_mock_doesnt_work.html#h_mock_it_where_its_used
         self.mocker.patch("hackspaceapi.spaceapi.get_entity_state", return_value=None)
-        self.mocker.patch(
-            "hackspaceapi.spaceapi.get_prometheus_metric", return_value=None
-        )
+        self.mocker.patch("hackspaceapi.spaceapi.get_prometheus_metric", return_value=None)
         self.mocker.patch("hackspaceapi.spaceapi.get_membership_data", return_value=[])
 
+    def test_space_json_no_network(self):
         response = client.get("/space.json")
         assert response.status_code == 200
         assert response.headers["Content-Type"] == "application/json"
@@ -39,6 +59,10 @@ def test_space_json_no_network(self):
         # Last change shouldn't be in the state
         assert "lastchange" not in data["state"]
 
+    def test_validate_space_json_no_network(self):
+        data = client.get("/space.json").json()
+        validate_spacejson_schema(data)
+
 
 class SpaceAPITestCase(FastAPIVCRTestCase):
     """
@@ -56,3 +80,7 @@ def test_space_json(self):
 
         # Check we provide a valid SpaceAPI JSON
         assert type(Space(data)) == Space
+
+    def test_validate_space_json(self):
+        data = client.get("/space.json").json()
+        validate_spacejson_schema(data)

tests/utils.py

@@ -25,7 +25,7 @@ def __inject_fixtures(self, mocker):
     def _get_vcr(self, **kwargs):
         myvcr = super(FastAPIVCRTestCase, self)._get_vcr(**kwargs)
         myvcr.ignore_localhost = True
-        myvcr.ignore_hosts = ["testserver"]
+        myvcr.ignore_hosts = ["testserver", "validator.spaceapi.io"]
         myvcr.filter_headers = ["Authorization"]
         myvcr.filter_query_parameters = ["start", "end"]
         myvcr.match_on = ["method", "scheme", "port", "path", "query"]