Merge pull request #184 from NHSDigital/dev/NPA-4689_GET_QuestionnaireResponse_endpoint

NPA-4689 Add `GET /QuestionnaireResponse` Endpoint To Sandbox

Author: JackPlowman

.github/workflows/openapi-validate.yml

@@ -5,165 +5,46 @@ name: Open API Validate
 permissions:
     contents: read
 jobs:
-    GET_Consent:
-        name: GET Consent test
+    ExamplesSchemasChecks:
+        name: Examples Schemas Checks
         runs-on: ubuntu-latest
+        strategy:
+            fail-fast: false
+            matrix:
+                endpoint:
+                    [
+                        {
+                            name: "GET /Consent",
+                            make_target: "schema-get-consent",
+                        },
+                        {
+                            name: "POST /Consent",
+                            make_target: "schema-post-consent",
+                        },
+                        {
+                            name: "PATCH /Consent",
+                            make_target: "schema-patch-consent",
+                        },
+                        {
+                            name: "GET /RelatedPerson",
+                            make_target: "schema-related-person",
+                        },
+                        {
+                            name: "POST /Questionnaire",
+                            make_target: "schema-questionnaire",
+                        },
+                        {
+                            name: "GET /Questionnaire",
+                            make_target: "schema-get-questionnaire",
+                        },
+                        { name: "Errors", make_target: "schema-errors" },
+                    ]
         steps:
             - name: Checkout repository
               uses: actions/checkout@v4
-
-            - name: Set up Python
-              uses: actions/setup-python@v5
-              with:
-                  python-version: 3.9
-
-            - name: Install Poetry
-              shell: bash
-              run: |
-                  pipx install poetry==1.8.5
-
-            - name: Install Script Packages with Poetry
-              shell: bash
-              run: |
-                  poetry install --all-extras
-
-            - name: Run Python script for all files
-              run: |
-                  make schema-get-consent
-
-    POST_Consent:
-        name: POST Consent test
-        runs-on: ubuntu-latest
-        steps:
-            - name: Checkout repository
-              uses: actions/checkout@v4
-
-            - name: Set up Python
-              uses: actions/setup-python@v5
-              with:
-                  python-version: 3.9
-
-            - name: Install Poetry
-              shell: bash
-              run: |
-                  pipx install poetry==1.8.5
-
-            - name: Install Script Packages with Poetry
-              shell: bash
-              run: |
-                  poetry install --all-extras
-
-            - name: Run Python script for all files
-              run: |
-                  make schema-post-consent
-
-    PATCH_Consent:
-        name: PATCH Consent test
-        runs-on: ubuntu-latest
-        steps:
-            - name: Checkout repository
-              uses: actions/checkout@v4
-
-            - name: Set up Python
-              uses: actions/setup-python@v5
-              with:
-                  python-version: 3.9
-
-            - name: Install Poetry
-              shell: bash
-              run: |
-                  pipx install poetry==1.8.5
-
-            - name: Install Script Packages with Poetry
-              shell: bash
-              run: |
-                  poetry install --all-extras
-
-            - name: Run Python script for all files
-              run: |
-                  make schema-patch-consent
-
-    GET_RelatedPerson:
-        name: GET Related Person test
-        runs-on: ubuntu-latest
-        steps:
-            - name: Checkout repository
-              uses: actions/checkout@v4
-
-            - name: Set up Python
-              uses: actions/setup-python@v5
               with:
-                  python-version: 3.9
-
-            - name: Install Poetry
-              shell: bash
-              run: |
-                  pipx install poetry==1.8.5
-
-            - name: Install Script Packages with Poetry
-              shell: bash
-              run: |
-                  poetry install --all-extras
-
-            - name: Run Python script for all files
-              run: |
-                  make schema-related-person
-
-    POST_Questionnaire:
-        name: POST questionnaire test
-        runs-on: ubuntu-latest
-        steps:
-            - name: Checkout repository
-              uses: actions/checkout@v4
-
-            - name: Set up Python
-              uses: actions/setup-python@v5
-              with:
-                  python-version: 3.9
-
-            - name: Install Poetry
-              shell: bash
-              run: |
-                  pipx install poetry==1.8.5
-
-            - name: Install Script Packages with Poetry
-              shell: bash
-              run: |
-                  poetry install --all-extras
-
-            - name: Run Python script for all files
-              run: |
-                  make schema-questionnaire
-
-    GET_Questionnaire:
-        name: GET questionnaire test
-        runs-on: ubuntu-latest
-        steps:
-            - name: Checkout repository
-              uses: actions/checkout@v4
-
-            - name: Set up Python
-              uses: actions/setup-python@v5
-              with:
-                  python-version: 3.9
-
-            - name: Install Poetry
-              shell: bash
-              run: |
-                  pipx install poetry==1.8.5
-            - name: Install Script Packages with Poetry
-              shell: bash
-              run: |
-                  poetry install --all-extras
-            - name: Run Python script for all files
-              run: |
-                  make schema-get-questionnaire
-    Errors:
-        name: Error schema test
-        runs-on: ubuntu-latest
-        steps:
-            - name: Checkout repository
-              uses: actions/checkout@v4
+                  fetch-depth: 0
+                  persist-credentials: false
 
             - name: Set up Python
               uses: actions/setup-python@v5
@@ -172,14 +53,11 @@ jobs:
 
             - name: Install Poetry
               shell: bash
-              run: |
-                  pipx install poetry==1.8.5
+              run: pipx install poetry==1.8.5
 
             - name: Install Script Packages with Poetry
               shell: bash
-              run: |
-                  poetry install --all-extras
+              run: poetry install --all-extras
 
-            - name: Run Python script for all files
-              run: |
-                  make schema-errors
+            - name: Check Examples against Endpoint Schemas
+              run: make ${{ matrix.endpoint.make_target }}

.github/workflows/run-postman-collection.yml

@@ -5,13 +5,13 @@ jobs:
     run-postman-collection:
         runs-on: ubuntu-latest
         steps:
-            -   name: Check out the repository
-                uses: actions/checkout@v4
-            -   name: Set up Node.js
-                uses: actions/setup-node@v4
-                with:
-                    node-version: '22'
-            -   name: Install Newman
-                run: npm install -g newman
-            -   name: Run Postman Collection
-                run: newman run ./postman/Validate\ Relationship\ Service\ Sandbox.postman_collection.json
+            - name: Check out the repository
+              uses: actions/checkout@v4
+            - name: Set up Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version: "22"
+            - name: Install Newman
+              run: npm install -g newman
+            - name: Run Postman Collection
+              run: newman run ./postman/Validate\ Relationship\ Service\ Sandbox.postman_collection.json

.github/workflows/sandbox-checks.yaml

@@ -10,8 +10,8 @@ jobs:
         run: pipx install poetry
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.8'
-          cache: 'poetry'
+          python-version: "3.8"
+          cache: "poetry"
       - name: Install Sandbox dependencies
         run: make install
         working-directory: ./sandbox

sandbox/api/app.py

@@ -4,6 +4,7 @@
 from flask import Flask
 
 from .get_consent import get_consent_response
+from .get_questionnaire_response import get_questionnaire_response_response
 from .get_related_person import get_related_person_response
 from .patch_consent import patch_consent_response
 from .post_consent import post_consent_response
@@ -37,6 +38,16 @@ def get_related_persons() -> Union[dict, tuple]:
     return get_related_person_response()
 
 
+@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()
+
+
 @app.route(f"/{COMMON_PATH}/QuestionnaireResponse", methods=["POST"])
 def post_questionnaire_response() -> Union[dict, tuple]:
     """Sandbox API for POST /QuestionnaireResponse

sandbox/api/constants.py

@@ -62,9 +62,20 @@
 PATCH_CONSENT__RESOURCE_NOT_FOUND = f"{PATCH_CONSENT__DIRECTORY}errors/resource_not_found.yaml"
 PATCH_CONSENT__INVALID_STATE_TRANSITION = f"{PATCH_CONSENT__DIRECTORY}errors/invalid_state_transition.yaml"
 
-QR_DIRECTORY = "./api/examples/POST_QuestionnaireResponse/"
-QUESTIONNAIRE_RESPONSE__SUCCESS = f"{QR_DIRECTORY}success.yaml"
+# POST QuestionnaireResponse
+POST_QUESTIONNAIRE_RESPONSE_DIRECTORY = "./api/examples/POST_QuestionnaireResponse/"
+POST_QUESTIONNAIRE_RESPONSE__SUCCESS = f"{POST_QUESTIONNAIRE_RESPONSE_DIRECTORY}success.yaml"
 
+# GET QuestionnaireResponse
+GET_QUESTIONNAIRE_RESPONSE_DIRECTORY = "./api/examples/GET_QuestionnaireResponse/"
+GET_QUESTIONNAIRE_RESPONSE__SUCCESS = f"{GET_QUESTIONNAIRE_RESPONSE_DIRECTORY}success.yaml"
+GET_QUESTIONNAIRE_RESPONSE__INVALID = f"{GET_QUESTIONNAIRE_RESPONSE_DIRECTORY}errors/invalid-reference-code.yaml"
+GET_QUESTIONNAIRE_RESPONSE__MISSING = f"{GET_QUESTIONNAIRE_RESPONSE_DIRECTORY}errors/missing-reference-code.yaml"
+GET_QUESTIONNAIRE_RESPONSE__NOT_FOUND = (
+    f"{GET_QUESTIONNAIRE_RESPONSE_DIRECTORY}errors/questionnaire_response_not_found.yaml"
+)
+
+# GET RelatedPerson
 RELATED_DIRECTORY = "./api/examples/GET_RelatedPerson/"
 RELATED__ERROR_IDENTIFIER_MISSING = f"{RELATED_DIRECTORY}errors/invalid-identifier-missing.yaml"
 RELATED__ERROR_IDENTIFIER_SYSTEM = f"{RELATED_DIRECTORY}errors/invalid-identifier-system.yaml"

sandbox/api/get_consent.py

@@ -20,9 +20,9 @@
     INVALIDATED_RESOURCE,
 )
 from .utils import (
-    check_for_get_consent_errors,
     check_for_consent_filtering,
     check_for_consent_include_params,
+    check_for_get_consent_errors,
     generate_response_from_example,
     remove_system,
 )

sandbox/api/get_questionnaire_response.py

@@ -0,0 +1,39 @@
+from logging import INFO, basicConfig, getLogger
+from typing import Union
+
+from flask import request
+
+from .constants import (
+    GET_QUESTIONNAIRE_RESPONSE__INVALID,
+    GET_QUESTIONNAIRE_RESPONSE__MISSING,
+    GET_QUESTIONNAIRE_RESPONSE__NOT_FOUND,
+    GET_QUESTIONNAIRE_RESPONSE__SUCCESS,
+    INTERNAL_SERVER_ERROR_EXAMPLE,
+)
+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
+
+    Returns:
+        Union[dict, tuple]: Response for GET /QuestionnaireResponse
+    """
+    try:
+        reference_code = request.args.get("referenceCode")
+        if reference_code == "19318ZGLAB":
+            return generate_response_from_example(GET_QUESTIONNAIRE_RESPONSE__SUCCESS, 200)
+        elif reference_code == "INVALID":
+            return generate_response_from_example(GET_QUESTIONNAIRE_RESPONSE__INVALID, 400)
+        elif reference_code == "" or reference_code is None:
+            return generate_response_from_example(GET_QUESTIONNAIRE_RESPONSE__MISSING, 404)
+        elif reference_code == "ABC123XY":
+            return generate_response_from_example(GET_QUESTIONNAIRE_RESPONSE__NOT_FOUND, 404)
+        else:
+            raise ValueError("Invalid reference code")
+    except Exception:
+        logger.exception("GET questionnaire response failed")
+        return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)

sandbox/api/post_questionnaire_response.py

@@ -1,7 +1,7 @@
 from logging import INFO, basicConfig, getLogger
 from typing import Union
 
-from .constants import INTERNAL_SERVER_ERROR_EXAMPLE, QUESTIONNAIRE_RESPONSE__SUCCESS
+from .constants import INTERNAL_SERVER_ERROR_EXAMPLE, POST_QUESTIONNAIRE_RESPONSE__SUCCESS
 from .utils import generate_response_from_example
 
 basicConfig(level=INFO, format="%(asctime)s - %(message)s")
@@ -15,7 +15,7 @@ def post_questionnaire_response_response() -> Union[dict, tuple]:
         Union[dict, tuple]: Response for POST /QuestionnaireResponse
     """
     try:
-        return generate_response_from_example(QUESTIONNAIRE_RESPONSE__SUCCESS, 200)
+        return generate_response_from_example(POST_QUESTIONNAIRE_RESPONSE__SUCCESS, 200)
     except Exception:
         logger.exception("POST questionnaire response failed")
         return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)