NPA-5534: Updated sandbox tests

Signed-off-by: adamclarkson <[email protected]>

Author: ClarksonAdam

sandbox/api/app.py

@@ -10,6 +10,8 @@
 from .patch_consent import patch_consent_response
 from .post_consent import post_consent_response
 from .post_questionnaire_response import post_questionnaire_response_response
+from .utils import generate_response_from_example
+from .constants import METHOD_NOT_ALLOWED
 
 app = Flask(__name__)
 basicConfig(level=INFO, format="%(asctime)s - %(message)s")
@@ -40,13 +42,24 @@ def get_related_persons() -> Union[dict, tuple]:
 
 
 @app.route(f"/{COMMON_PATH}/QuestionnaireResponse", methods=["GET"])
+@app.route(f"/{COMMON_PATH}/QuestionnaireResponse/", methods=["GET"])
 def get_questionnaire_response() -> Union[dict, tuple]:
     """Sandbox API for GET /QuestionnaireResponse
 
     Returns:
         Union[dict, tuple]: Response for GET /QuestionnaireResponse
     """
-    return get_questionnaire_response_response()
+    return generate_response_from_example(METHOD_NOT_ALLOWED, 405)
+
+
+@app.route(f"/{COMMON_PATH}/QuestionnaireResponse/<identifier>", methods=["GET"])
+def get_questionnaire_response_id(identifier: str) -> Union[dict, tuple]:
+    """Sandbox API for GET /QuestionnaireResponse
+
+    Returns:
+        Union[dict, tuple]: Response for GET /QuestionnaireResponse
+    """
+    return get_questionnaire_response_response(identifier)
 
 
 @app.route(f"/{COMMON_PATH}/QuestionnaireResponse", methods=["POST"])

sandbox/api/constants.py

@@ -14,6 +14,7 @@
 INVALIDATED_RESOURCE = "./api/examples/errors/invalidated-resource.yaml"
 MISSING_IDENTIFIER = "./api/examples/errors/missing-identifier.yaml"
 INVALID_IDENTIFIER = "./api/examples/errors/invalid-identifier.yaml"
+METHOD_NOT_ALLOWED = "./api/examples/errors/method-not-allowed.yaml"
 
 # GET Consent examples
 GET_CONSENT__DIRECTORY = "./api/examples/GET_Consent/"

sandbox/api/get_questionnaire_response.py

@@ -5,31 +5,30 @@
 
 from .constants import (
     GET_QUESTIONNAIRE_RESPONSE__INVALID,
-    GET_QUESTIONNAIRE_RESPONSE__MISSING,
     GET_QUESTIONNAIRE_RESPONSE__NOT_FOUND,
     GET_QUESTIONNAIRE_RESPONSE__SUCCESS,
     INTERNAL_SERVER_ERROR_EXAMPLE,
+    METHOD_NOT_ALLOWED
 )
 from .utils import generate_response_from_example
 
 basicConfig(level=INFO, format="%(asctime)s - %(message)s")
 logger = getLogger(__name__)
 
 
-def get_questionnaire_response_response() -> Union[dict, tuple]:
-    """Sandbox API for GET /QuestionnaireResponse
+def get_questionnaire_response_response(access_request_id: str) -> Union[dict, tuple]:
+    """Sandbox API for GET /QuestionnaireResponse/{id}
 
     Returns:
-        Union[dict, tuple]: Response for GET /QuestionnaireResponse
+        Union[dict, tuple]: Response for GET /QuestionnaireResponse/{id}
     """
     try:
-        access_request_id = request.args.get("ID")
         if access_request_id == "156e1560-e532-4e2a-85ad-5aeff03dc43e":
             return generate_response_from_example(GET_QUESTIONNAIRE_RESPONSE__SUCCESS, 200)
         elif access_request_id == "INVALID":
             return generate_response_from_example(GET_QUESTIONNAIRE_RESPONSE__INVALID, 400)
         elif access_request_id == "" or access_request_id is None:
-            return generate_response_from_example(GET_QUESTIONNAIRE_RESPONSE__MISSING, 400)
+            return generate_response_from_example(METHOD_NOT_ALLOWED, 405)
         elif access_request_id == "60d09b82-f4bb-41f9-b41e-767999b4ac9b":
             return generate_response_from_example(GET_QUESTIONNAIRE_RESPONSE__NOT_FOUND, 404)
         else:

sandbox/api/tests/test_get_questionnaire_response.py

@@ -3,56 +3,74 @@
 from flask import Response
 from json import dumps, loads
 
+from pycparser.plyparser import parameterized
+
 GET_QUESTIONNAIRE_RESPONSE_API_ENDPOINT = "/FHIR/R4/QuestionnaireResponse"
 
 
 @pytest.mark.parametrize(
-    ("request_args", "response_file_name", "status_code"),
+    ("path", "response_file_name", "status_code"),
     [
         (
-            "ID=156e1560-e532-4e2a-85ad-5aeff03dc43e",
+            "/156e1560-e532-4e2a-85ad-5aeff03dc43e",
             "./api/examples/GET_QuestionnaireResponse/success.yaml",
             200,
         ),
         (
-            "ID=INVALID",
+            "/INVALID",
             "./api/examples/GET_QuestionnaireResponse/errors/invalid_access_request_id.yaml",
             400,
         ),
         (
-            "ID=",
-            "./api/examples/GET_QuestionnaireResponse/errors/missing_access_request_id.yaml",
-            400,
-        ),
-        (
-            "ID=60d09b82-f4bb-41f9-b41e-767999b4ac9b",
+            "/60d09b82-f4bb-41f9-b41e-767999b4ac9b",
             "./api/examples/GET_QuestionnaireResponse/errors/questionnaire_response_not_found.yaml",
             404,
         ),
         (
-            "ID=INVALID_CODE",
+            "/INVALID_CODE",
             "./api/examples/errors/internal-server-error.yaml",
             500,
         ),
     ],
 )
 @patch("sandbox.api.get_questionnaire_response.generate_response_from_example")
-def test_get_questionnaire_response_returns_expected_responses__mocked_utils(
+def test_get_questionnaire_response_id_returns_expected_responses__mocked_utils(
     mock_generate_response_from_example: MagicMock,
-    request_args: str,
+    path: str,
     response_file_name: str,
     status_code: int,
     client: object,
 ) -> None:
-    """Test GET Consent endpoint."""
+    """Test GET /QuestionnaireResponse/{id} endpoint."""
     mock_generate_response_from_example.return_value = mocked_response = Response(
         dumps({"data": "mocked"}),
         status=status_code,
         content_type="application/json",
     )
     # Act
-    response = client.get(f"{GET_QUESTIONNAIRE_RESPONSE_API_ENDPOINT}?{request_args}")
+    response = client.get(f"{GET_QUESTIONNAIRE_RESPONSE_API_ENDPOINT}{path}")
     # Assert
     mock_generate_response_from_example.assert_called_once_with(response_file_name, status_code)
     assert response.status_code == status_code
     assert response.json == loads(mocked_response.get_data(as_text=True))
+
+
+@pytest.mark.parametrize("path", ["/",""])
+@patch("sandbox.api.app.generate_response_from_example")
+def test_get_questionnaire_response_without_path_params_return_405_errors(
+    mock_generate_response_from_example: MagicMock,
+    path: str,
+    client: object,
+) -> None:
+    """Test the GET /QuestionnaireResponse endpoint with no path params."""
+    mock_generate_response_from_example.return_value = mocked_response = Response(
+        dumps({"data": "mocked"}),
+        status=405,
+        content_type="application/json",
+    )
+    # Act
+    response = client.get(f"{GET_QUESTIONNAIRE_RESPONSE_API_ENDPOINT}{path}")
+    # Assert
+    mock_generate_response_from_example.assert_called_once_with("./api/examples/errors/method-not-allowed.yaml", 405)
+    assert response.status_code == 405
+    assert response.json == loads(mocked_response.get_data(as_text=True))

…responses/errors/method_not_allowed.yaml …responses/errors/method-not-allowed.yamlspecification/examples/responses/errors/method_not_allowed.yaml renamed to specification/examples/responses/errors/method-not-allowed.yaml specification/examples/responses/errors/method_not_allowed.yaml renamed to specification/examples/responses/errors/method-not-allowed.yaml

@@ -370,7 +370,7 @@ paths:
                 invalidAccessRequestID:
                   $ref: "./examples/responses/GET_QuestionnaireResponse/errors/invalid_access_request_id.yaml#/InvalidAccessRequestID"
                 missingAccessRequestID:
-                  $ref: "./examples/responses/errors/method_not_allowed.yaml#/MethodNotAllowedError"
+                  $ref: "./examples/responses/errors/method-not-allowed.yaml#/MethodNotAllowedError"
                 questionnaireResponseNotFound:
                   $ref: "./examples/responses/GET_QuestionnaireResponse/errors/questionnaire_response_not_found.yaml#/QuestionnaireResponseNotFound"
         "5XX":