Merge pull request #127 from NHSDigital/dev/NPA-3899_Sandbox_Consent_Endpoint

NPA-3899 Add Consent Sandbox Endpoint

Author: JackPlowman

Dockerfile

@@ -0,0 +1,12 @@
+FROM python:3.8
+
+COPY ./specification/examples/responses /sandbox/api/examples
+COPY ./sandbox /sandbox
+
+WORKDIR /sandbox
+
+RUN pip install poetry && poetry install --without dev
+
+EXPOSE 9000
+
+CMD ["poetry", "run", "gunicorn", "api.app:app", "--bind=0.0.0.0:9000"]

ecs-proxies-containers.yml

@@ -1,4 +1,4 @@
 docker_containers:
   - name: sandbox
-    dockerfile: "sandbox/Dockerfile"
-    path: "sandbox"
+    dockerfile: "Dockerfile"
+    path: "."

sandbox/.dockerignore

@@ -8,15 +8,18 @@ list:
 	@grep '^[^#[:space:]].*:' Makefile
 
 build: # Build the Docker image to simulate ECS build
-	docker build -t validate-relationships-service-api-sandbox .
+	cd .. && docker build -t validate-relationships-service-api-sandbox .
+
+load-examples: # Load the examples from the specification (for local development, not used by docker build)
+	cp -r ../specification/examples/responses/ ./api/examples
 
 format: # Formats the code using black
 	poetry run black .
 
-start: # Starts the Flask app (Don't use this in production)
+start: load-examples # Starts the Flask app (Don't use this in production)
 	poetry run flask --app api.app:app run -p 9000
 
-start-dev: # Starts the Flask app in development mode
+start-dev: load-examples # Starts the Flask app in development mode
 	poetry run flask --app api.app:app run -p 9000 --reload --debug
 
 test: # Runs the unit tests using pytest

sandbox/Dockerfile

@@ -2,28 +2,27 @@
 
 This folder contains a sandbox API for initial development
 
-
-For more information about building sandbox APIs see the [API Producer Zone confluence](https://nhsd-confluence.digital.nhs.uk/display/APM/Setting+up+your+API+sandbox ).
+For more information about building sandbox APIs see the [API Producer Zone confluence](https://nhsd-confluence.digital.nhs.uk/display/APM/Setting+up+your+API+sandbox).
 
 ## Table of Contents
 
-- [Sandbox](#sandbox)
-  - [Table of Contents](#table-of-contents)
-  - [Prerequisites](#prerequisites)
-  - [Quick Start](#quick-start)
-    - [Installing dependencies](#installing-dependencies)
-    - [Starting the API](#starting-the-api)
-  - [Development](#development)
-    - [Starting the API with Hot Reloading](#starting-the-api-with-hot-reloading)
-    - [Testing](#testing)
-      - [Unit Tests](#unit-tests)
-    - [Useful commands](#useful-commands)
+-   [Sandbox](#sandbox)
+    -   [Table of Contents](#table-of-contents)
+    -   [Prerequisites](#prerequisites)
+    -   [Quick Start](#quick-start)
+        -   [Installing dependencies](#installing-dependencies)
+        -   [Starting the API](#starting-the-api)
+    -   [Development](#development)
+        -   [Starting the API with Hot Reloading](#starting-the-api-with-hot-reloading)
+        -   [Testing](#testing)
+            -   [Unit Tests](#unit-tests)
+        -   [Useful commands](#useful-commands)
 
 ## Prerequisites
 
-- Python 3.8
-- [Poetry](https://python-poetry.org/docs/)
-- [Docker](https://docs.docker.com/get-docker/)
+-   Python 3.8
+-   [Poetry](https://python-poetry.org/docs/)
+-   [Docker](https://docs.docker.com/get-docker/)
 
 ## Quick Start
 
@@ -53,7 +52,6 @@ To run the API with hot reloading use `make start-dev`
 
 Unit tests can be run using `make test`
 
-
 ### Useful commands
 
 For more useful development commands review the [Makefile](Makefile) or run `make list`

sandbox/Makefile

@@ -3,20 +3,29 @@
 
 from flask import Flask, request
 
-from .utils import (
-    ERROR_RESPONSE,
+from .constants import (
+    CONSENT__ADULT_CONSENTING_EXAMPLE,
+    CONSENT__MIXED_EXAMPLE,
+    CONSENT__MOTHER_CHILD_EXAMPLE,
+    CONSENT_PERFORMER,
+    INTERNAL_ERROR_RESPONSE,
+    INTERNAL_SERVER_ERROR_EXAMPLE,
     LIST_RELATIONSHIP,
     LIST_RELATIONSHIP_INCLUDE,
+    NOT_FOUND,
     QUESTIONNAIRE_RESPONSE_SUCCESS,
     VALIDATE_RELATIONSHIP_009,
     VALIDATE_RELATIONSHIP_025,
     VALIDATE_RELATIONSHIP_INCLUDE_009,
     VALIDATE_RELATIONSHIP_INCLUDE_025,
+)
+from .utils import (
     check_for_empty,
     check_for_errors,
     check_for_list,
     check_for_validate,
     generate_response,
+    generate_response_from_example,
     load_json_file,
     remove_system,
 )
@@ -92,7 +101,7 @@ def get_related_persons() -> Union[dict, tuple]:
 
     except Exception as e:
         logger.error(e)
-        return generate_response(load_json_file(ERROR_RESPONSE), 500)
+        return generate_response(load_json_file(INTERNAL_ERROR_RESPONSE), 500)
 
 
 @app.route(f"/{COMMON_PATH}/QuestionnaireResponse", methods=["POST"])
@@ -107,4 +116,43 @@ def post_questionnaire_response() -> Union[dict, tuple]:
         return generate_response(load_json_file(QUESTIONNAIRE_RESPONSE_SUCCESS), 200)
     except Exception as e:
         logger.error(e)
-        return generate_response(load_json_file(ERROR_RESPONSE), 500)
+        return generate_response(load_json_file(INTERNAL_ERROR_RESPONSE), 500)
+
+
+@app.route(f"/{COMMON_PATH}/Consent", methods=["GET"])
+def get_consent() -> Union[dict, tuple]:
+    """Sandbox API for GET /Consent
+
+    Returns:
+        Union[dict, tuple]: Response for GET /Consent
+    """
+    try:
+        performer_identifier = remove_system(request.args.get("performer:identifier"))
+        status = request.args.get("status")
+        _include = request.args.get("_include")
+
+        if (
+            performer_identifier == "9000000010"
+            and status == "active"
+            and _include == CONSENT_PERFORMER
+        ):
+            return generate_response_from_example(
+                CONSENT__ADULT_CONSENTING_EXAMPLE, 200
+            )
+        elif (
+            performer_identifier == "9000000017"
+            and status == "active"
+            and _include == CONSENT_PERFORMER
+        ):
+            return generate_response_from_example(CONSENT__MIXED_EXAMPLE, 200)
+        elif (
+            performer_identifier == "9000000019"
+            and status == "active"
+            and _include == CONSENT_PERFORMER
+        ):
+            return generate_response_from_example(CONSENT__MOTHER_CHILD_EXAMPLE, 200)
+        else:
+            return generate_response(load_json_file(NOT_FOUND), 400)
+    except Exception as e:
+        logger.error(e)
+        return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)

sandbox/README.md

@@ -0,0 +1,40 @@
+NOT_FOUND = "./api/responses/not_found.json"
+EMPTY_RESPONSE = "./api/responses/GET_RelatedPerson/empty_response_9000000033.json"
+LIST_RELATIONSHIP = (
+    "./api/responses/GET_RelatedPerson/list_relationship_9000000017.json"
+)
+LIST_RELATIONSHIP_INCLUDE = (
+    "./api/responses/GET_RelatedPerson/list_relationship_include_9000000017.json"
+)
+VALIDATE_RELATIONSHIP_009 = (
+    "./api/responses/GET_RelatedPerson/verify_relationship_9000000009.json"
+)
+VALIDATE_RELATIONSHIP_INCLUDE_009 = (
+    "./api/responses/GET_RelatedPerson/verify_relationship_include_9000000009.json"
+)
+VALIDATE_RELATIONSHIP_025 = (
+    "./api/responses/GET_RelatedPerson/verify_relationship_9000000025.json"
+)
+VALIDATE_RELATIONSHIP_INCLUDE_025 = (
+    "./api/responses/GET_RelatedPerson/verify_relationship_include_9000000025.json"
+)
+INTERNAL_ERROR_RESPONSE = "./api/responses/internal_server_error.json"
+INCLUDE_FLAG = "RelatedPerson:patient"
+
+QUESTIONNAIRE_RESPONSE_SUCCESS = (
+    "./api/responses/POST_QuestionnaireResponse/questionnaire_response_success.json"
+)
+
+PATIENT_IDENTIFIERS = ["9000000017", "9000000033"]
+RELATED_IDENTIFIERS = ["9000000009", "9000000025"]
+
+CONSENT_PERFORMER = "Consent:performer"
+
+# Example files
+
+# Common examples
+INTERNAL_SERVER_ERROR_EXAMPLE = "./api/examples/errors/internal-server-error.yaml"
+# Consent examples
+CONSENT__ADULT_CONSENTING_EXAMPLE = "./api/examples/GET_Consent/adults-consenting.yaml"
+CONSENT__MIXED_EXAMPLE = "./api/examples/GET_Consent/mixed.yaml"
+CONSENT__MOTHER_CHILD_EXAMPLE = "./api/examples/GET_Consent/mother-child.yaml"

sandbox/api/app.py

@@ -0,0 +1 @@
+*.yaml

sandbox/api/constants.py

@@ -1,20 +1,20 @@
 {
   "issue": [
-      {
-          "code": "invalid",
-          "details": {
-              "coding": [
-                  {
-                      "code": "INVALID_IDENTIFIER_SYSTEM",
-                      "display": "Invalid identifier system.",
-                      "system": "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode",
-                      "version": "1"
-                  }
-              ]
-          },
-          "diagnostics": "The identifier system is not valid.",
-          "severity": "error"
-      }
+    {
+      "code": "invalid",
+      "details": {
+        "coding": [
+          {
+            "code": "INVALID_IDENTIFIER_SYSTEM",
+            "display": "Invalid identifier system.",
+            "system": "https://fhir.nhs.uk/R4/CodeSystem/ValidatedRelationships-ErrorOrWarningCode",
+            "version": "1"
+          }
+        ]
+      },
+      "diagnostics": "The identifier system is not valid.",
+      "severity": "error"
+    }
   ],
   "resourceType": "OperationOutcome"
 }