feat(test_utils): automatic schema validation

closes #23

Author: JulienChampagnol

src/opengeodeweb_back/test_utils.py

@@ -0,0 +1,18 @@
+
+
+def test_route_wrong_params(client, route, get_full_data):
+    for key, value in get_full_data().items():
+        json = get_full_data()
+        json.pop(key)
+        response = client.post(route, json=json)
+        assert response.status_code == 400
+        error_description = response.json["description"]
+        assert error_description == f"Validation error: '{key}' is a required property"
+    
+    json = get_full_data()
+    json["dumb_key"] = "dumb_value"
+    response = client.post(route, json=json)
+    assert response.status_code == 400
+    error_description = response.json["description"]
+    assert error_description == "Validation error: Additional properties are not allowed ('dumb_key' was unexpected)"
+    

tests/test_routes.py

@@ -1,17 +1,28 @@
-import os
+# Standard library imports
 import base64
+import os
+
+# Third party imports
 from werkzeug.datastructures import FileStorage
 
+# Local application imports
+from src.opengeodeweb_back import test_utils
+
 
 def test_allowed_files(client):
     route = f"/allowed_files"
-    response = client.post(route, json={"supported_feature": None})
+    get_full_data = lambda: {"supported_feature": "None"}
+    json = get_full_data()
+    response = client.post(route, json=json)
     assert response.status_code == 200
     extensions = response.json["extensions"]
     assert type(extensions) is list
     for extension in extensions:
         assert type(extension) is str
 
+    # Test all params
+    test_utils.test_route_wrong_params(client, route, get_full_data)
+
 
 def test_allowed_objects(client):
     route = f"/allowed_objects"
@@ -30,14 +41,8 @@ def get_full_data():
     for allowed_object in allowed_objects:
         assert type(allowed_object) is str
 
-    for key, value in get_full_data().items():
-        json = get_full_data()
-        json.pop(key)
-        response = client.post(route, json=json)
-        assert response.status_code == 400
-        error_description = response.json["description"]
-        assert error_description == f"Validation error: '{key}' is a required property"
-
+    # Test all params
+    test_utils.test_route_wrong_params(client, route, get_full_data)
 
 def test_upload_file(client):
     response = client.put(
@@ -58,11 +63,7 @@ def get_full_data():
         }
 
     json = get_full_data()
-    response = client.post(
-        route,
-        json=json,
-    )
-
+    response = client.post(route,json=json)
     assert response.status_code == 200
     has_missing_files = response.json["has_missing_files"]
     mandatory_files = response.json["mandatory_files"]
@@ -71,37 +72,25 @@ def get_full_data():
     assert type(mandatory_files) is list
     assert type(additional_files) is list
 
-    for key, value in get_full_data().items():
-        json = get_full_data()
-        json.pop(key)
-        response = client.post(route, json=json)
-        assert response.status_code == 400
-        error_description = response.json["description"]
-        assert error_description == f"Validation error: '{key}' is a required property"
-
+    # Test all params
+    test_utils.test_route_wrong_params(client, route, get_full_data)
 
 def test_geographic_coordinate_systems(client):
     route = f"/geographic_coordinate_systems"
-
+    get_full_data = lambda: {"input_geode_object": "BRep"}
     # Normal test with geode_object 'BRep'
-    response = client.post(route, json={"input_geode_object": "BRep"})
+    response = client.post(route, json=get_full_data())
     assert response.status_code == 200
     crs_list = response.json["crs_list"]
     assert type(crs_list) is list
     for crs in crs_list:
         assert type(crs) is dict
 
-    # Test without geode_object
-    response = client.post(route, json={})
-    assert response.status_code == 400
-    error_message = response.json["description"]
-    assert (
-        error_message == "Validation error: 'input_geode_object' is a required property"
-    )
-
+    # Test all params
+    test_utils.test_route_wrong_params(client, route, get_full_data)
 
 def test_inspect_file(client):
-    route = f"/inspect_file"
+    route = f"/inspect_file" 
 
     def get_full_data():
         return {
@@ -117,14 +106,8 @@ def get_full_data():
     inspection_result = response.json["inspection_result"]
     assert type(inspection_result) is dict
 
-    for key, value in get_full_data().items():
-        json = get_full_data()
-        json.pop(key)
-        response = client.post(route, json=json)
-        assert response.status_code == 400
-        error_description = response.json["description"]
-        assert error_description == f"Validation error: '{key}' is a required property"
-
+    # Test all params
+    test_utils.test_route_wrong_params(client, route, get_full_data)
 
 def test_geode_objects_and_output_extensions(client):
     route = "/geode_objects_and_output_extensions"
@@ -148,13 +131,8 @@ def get_full_data():
             assert type(value) is dict
             assert type(value["is_saveable"]) is bool
 
-    # Test without input_geode_object
-    response = client.post(route, json={})
-    assert response.status_code == 400
-    error_message = response.json["description"]
-    assert (
-        error_message == "Validation error: 'input_geode_object' is a required property"
-    )
+    # Test all params
+    test_utils.test_route_wrong_params(client, route, get_full_data)
 
 
 def test_save_viewable_file(client):
@@ -178,10 +156,29 @@ def get_full_data():
     id = response.json["id"]
     assert type(id) is str
 
-    for key, value in get_full_data().items():
-        json = get_full_data()
-        json.pop(key)
-        response = client.post(route, json=json)
-        assert response.status_code == 400
-        error_description = response.json["description"]
-        assert error_description == f"Validation error: '{key}' is a required property"
+    test_utils.test_route_wrong_params(client, route, get_full_data)
+
+def test_vertex_attribute_names(client):
+    response = client.put(
+        f"/upload_file",
+        data={"file": FileStorage(open("./tests/vertex_attribute.vtp", "rb"))},
+    )
+    assert response.status_code == 201
+
+    route = f"/vertex_attribute_names"
+
+    def get_full_data():
+        return {
+            "input_geode_object": "PolygonalSurface3D",
+            "filename": "vertex_attribute.vtp",
+        }
+
+    # Normal test with filename 'vertex_attribute.vtp'
+    response = client.post(route, json=get_full_data())
+    assert response.status_code == 200
+    vertex_attribute_names = response.json["vertex_attribute_names"]
+    assert type(vertex_attribute_names) is list
+    for vertex_attribute_name in vertex_attribute_names:
+        assert type(vertex_attribute_name) is str
+
+    test_utils.test_route_wrong_params(client, route, get_full_data)