Merge pull request #30 from actinia-org/enhance-pc-transform

Input check enhancements and add minOccurs to required parameters

Author: mmacata

src/actinia_ogc_api_processes_plugin/core/process_description.py

@@ -64,7 +64,7 @@ def update_resp(resp_json: dict) -> dict:
     project_input = {
         "description": "Name of GRASS GIS project to use",
         "name": "project",
-        "optional": False,
+        "optional": True,
         "schema": {"type": "string"},
         "default": ACTINIA.default_project,
     }
@@ -84,6 +84,10 @@ def update_resp(resp_json: dict) -> dict:
             continue
         # keep parameter fields but remove the redundant 'name' field
         value = {k: v for k, v in p.items() if k != "name"}
+        # transform 'optional' to 'minOccurs
+        optional = value.pop("optional", None)
+        if optional is False:
+            value["minOccurs"] = 1
         # subtype not allowed in validator, removing it
         if "schema" in value:
             value["schema"].pop("subtype", None)

src/actinia_ogc_api_processes_plugin/core/process_execution.py

@@ -296,6 +296,21 @@ def _invalid_inputs(module_info: dict, inputs: dict):
     return invalid, msg
 
 
+def _missing_inputs(module_info: dict, inputs: dict):
+    """Check if required inputs are missing."""
+    params = module_info.get("parameters", [])
+    params += module_info.get("returns", [])
+    required_params = {p.get("name") for p in params if not p.get("optional")}
+    return [param for param in required_params if param not in inputs]
+
+
+def is_valid_postbody(postbody: dict) -> bool:
+    """Check if postbody is valid."""
+    allowed_keys = {"inputs", "outputs", "response", "subscriber"}
+    wrong_key = any(key not in allowed_keys for key, value in postbody.items())
+    return not wrong_key
+
+
 def _validate_string_input(
     invalid: list,
     key: str,
@@ -359,9 +374,20 @@ def _check_input_by_reference(postbody: dict) -> dict:
 
 def post_process_execution(
     process_id: str | None = None,
-    postbody: str | None = None,
+    postbody: dict | None = None,
 ):
     """Start job for given process_id."""
+    if not is_valid_postbody(postbody):
+        res = jsonify(
+            {
+                "type": "InvalidRequestBody",
+                "title": "Invalid request body",
+                "status": 400,
+                "detail": "Request body contains invalid keys.",
+            },
+        )
+        return make_response(res, 400)
+
     # Authentication for actinia
     auth = request.authorization
     kwargs = dict()
@@ -383,10 +409,32 @@ def post_process_execution(
         invalid_inp_str = ", ".join(str(x) for x in invalid_inputs)
         msg = f"Invalid input <{invalid_inp_str}> for process <{process_id}>."
         res = jsonify(
-            SimpleStatusCodeResponseModel(
-                status=400,
-                message=(msg + " " + detail_msg),
-            ),
+            {
+                "type": "InvalidInput",
+                "title": "Invalid input",
+                "status": 400,
+                "detail": (msg + " " + detail_msg),
+            },
+        )
+        return make_response(res, 400)
+
+    missing_inputs = _missing_inputs(
+        resp.json(),
+        postbody.get("inputs", {}),
+    )
+    if missing_inputs:
+        missing_inputs_str = ", ".join(str(x) for x in missing_inputs)
+        msg = (
+            f"Missing required input parameter <{missing_inputs_str}> for "
+            f"process <{process_id}>."
+        )
+        res = jsonify(
+            {
+                "type": "InvalidInput",
+                "title": "Missing required input",
+                "status": 400,
+                "detail": msg,
+            },
         )
         return make_response(res, 400)
 

tests/integrationtests/test_processes_execution.py

@@ -144,11 +144,9 @@ def test_post_process_execution_with_bbox_error(self) -> None:
         assert isinstance(resp, Response)
         assert resp.status_code == 400
         assert hasattr(resp, "json")
-        assert "message" in resp.json
-        assert (
-            "'bbox' should be a list of 4 or 6 numbers."
-            in resp.json["message"]
-        )
+        assert "type" in resp.json
+        assert "detail" in resp.json
+        assert "bounding_box" in resp.json["detail"]
 
     @pytest.mark.integrationtest
     def test_post_process_execution_invalid_process_id(self) -> None:

tests/integrationtests/test_processes_execution_grass_module.py

@@ -158,7 +158,7 @@ def test_post_process_execution_vbuffer_array_error(self) -> None:
         assert resp.status_code == 400
         assert (
             "Input parameter 'type' should be type array"
-            in resp.json["message"]
+            in resp.json["detail"]
         )
 
     @pytest.mark.integrationtest
@@ -192,10 +192,10 @@ def test_post_process_execution_not_supported_module_1(self) -> None:
         assert isinstance(resp, Response)
         assert resp.status_code == 400
         assert hasattr(resp, "json")
-        assert "message" in resp.json
-        assert (
-            resp.json["message"] == "Process execution of <g.region> not "
-            "supported."
+        assert "detail" in resp.json
+        assert resp.json["detail"] == (
+            "Missing required input parameter <format> for process "
+            "<g.region>."
         )
 
     @pytest.mark.integrationtest

tests/integrationtests/test_processes_execution_input_by_reference.py

@@ -141,5 +141,5 @@ def test_post_process_execution_input_by_ref_error(self) -> None:
         assert isinstance(resp, Response)
         assert resp.status_code == 400
         assert hasattr(resp, "json")
-        assert "message" in resp.json
-        assert "'.geojson' which is not supported." in resp.json["message"]
+        assert "detail" in resp.json
+        assert "'.geojson' which is not supported." in resp.json["detail"]