Merge pull request #96 from ministryofjustice/UML-3042-expose-also-kn…

…own-as-field UML-3042 add other names (also known as) field
ministryofjustice · Nov 15, 2023 · c82e92a · c82e92a
2 parents bab5530 + b790e24
commit c82e92a
Show file tree

Hide file tree

Showing 15 changed files with 75 additions and 11 deletions.
diff --git a/Makefile b/Makefile
@@ -44,3 +44,6 @@ login-api-gateway:
 
 logs:
 	docker-compose logs --tail=100 -f $(c)
+
+unit-tests-all:
+	docker-compose run unit-test-lpa-data
diff --git a/README.md b/README.md
@@ -126,6 +126,13 @@ is a bit more of an in depth set up process required.
     - Set the Default Test Runner to 'pytest'
     - Right click on the tests folder (or single file) > 'Run pytest in tests'
 
+
+These tests can also be run with docker, first [set up docker environment](#running-the-api-locally). 
+Then:
+   ```shell
+    docker-compose run unit-test-lpa-data
+   ```
+
 ## Integration Tests
 
 1. [Set up local environment](#set-up-local-development-environment-outside-of-docker)

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -10,7 +10,7 @@ services:
       POSTGRES_PASSWORD: password #pragma: allowlist secret
       POSTGRES_DB: postgres
   broker_app:
-    image: pactfoundation/pact-broker
+    image: pactfoundation/pact-cli:latest-multi
     ports:
       - "9293:80"
       - "9292:9292"

diff --git a/integration_tests/v1/conftest.py b/integration_tests/v1/conftest.py
@@ -40,15 +40,13 @@
         "method": "GET",
     },
     "online_tool_endpoint": {
-        "url": "https://uml-XXXX.dev.lpa.api.opg.service.justice.gov.uk/v1/lpa"
-        "-online-tool/lpas",
+        "url": "https://uml-XXXX.dev.lpa.api.opg.service.justice.gov.uk/v1/lpa-online-tool/lpas",
         "method": "GET",
         "valid_lpa_online_tool_ids": ["A33718377316"],
         "invalid_lpa_online_tool_ids": ["banana"],
     },
     "use_an_lpa_endpoint": {
-        "url": "https://uml-XXXX.dev.lpa.api.opg.service.justice.gov.uk/v1/use"
-        "-an-lpa/lpas",
+        "url": "https://uml-XXXX.dev.lpa.api.opg.service.justice.gov.uk/v1/use-an-lpa/lpas",
         "method": "GET",
         "valid_sirius_uids": ["700000000047"],
         "invalid_sirius_uids": ["9"],

diff --git a/integration_tests/v1/response_schemas/use_an_lpa_schema.json b/integration_tests/v1/response_schemas/use_an_lpa_schema.json
@@ -38,6 +38,9 @@
         "firstname": {
           "type": "string"
         },
+        "otherNames": {
+          "type": ["string", "null"]
+        },
         "middlenames": {
           "type": ["string", "null"]
         },
@@ -103,6 +106,7 @@
         "email",
         "salutation",
         "firstname",
+        "otherNames",
         "middlenames",
         "surname",
         "addresses",
@@ -160,6 +164,9 @@
             "firstname": {
               "type": "string"
             },
+            "otherNames": {
+              "type": ["string", "null"]
+            },
             "middlenames": {
               "type": ["string", "null"]
             },
@@ -228,6 +235,7 @@
             "email",
             "salutation",
             "firstname",
+            "otherNames",
             "middlenames",
             "surname",
             "addresses",
@@ -269,6 +277,9 @@
             "firstname": {
               "type": "string"
             },
+            "otherNames": {
+              "type": ["string", "null"]
+            },
             "middlenames": {
               "type": ["string", "null"]
             },
@@ -331,6 +342,7 @@
             "email",
             "salutation",
             "firstname",
+            "otherNames",
             "middlenames",
             "surname",
             "addresses"

diff --git a/lambda_functions/v1/Dockerfile b/lambda_functions/v1/Dockerfile
@@ -4,6 +4,7 @@ WORKDIR /var/www/lambda_functions/v1
 # Install Python Dependencies
 COPY requirements requirements
 RUN cat ./requirements/*.txt | uniq | grep -v "#" > ./requirements/local-requirements.txt
+RUN pip install --upgrade pip
 RUN pip install -r ./requirements/local-requirements.txt
 
 EXPOSE 4343

diff --git a/lambda_functions/v1/openapi/lpa-openapi.yml b/lambda_functions/v1/openapi/lpa-openapi.yml
@@ -638,6 +638,7 @@ components:
         - dob
         - salutation
         - firstname
+        - otherNames
         - middlenames
         - surname
         - companyName
@@ -668,9 +669,14 @@ components:
           description: The case actor's first name
           example: Ian
           maxLength: 255
+        otherNames:
+          type: string
+          description: The case actor's other name
+          example: George
+          maxLength: 255
         middlenames:
           type: string
-          description: The case actor's last name
+          description: The case actor's middle name
           example: Deputy
           maxLength: 255
         surname:

diff --git a/lambda_functions/v1/requirements/dev-requirements.txt b/lambda_functions/v1/requirements/dev-requirements.txt
@@ -13,4 +13,3 @@ validators==0.18.2
 yarl==1.6.3
 importlib-metadata==4.13.0
 opg-sirius-service==2.1.1
-localstack-client==1.39
diff --git a/lambda_functions/v1/requirements/requirements.txt b/lambda_functions/v1/requirements/requirements.txt
@@ -1,7 +1,7 @@
 #Update this date to trigger update of layers: 20230619
 Flask==2.2.5
 markupsafe==2.1.1
-localstack-client==1.10
+localstack-client==1.39
 redis==3.5.3
 requests==2.31.0
 Werkzeug==3.0.1

diff --git a/lambda_functions/v1/tests/test_data/use_an_lpa_successful_response.json b/lambda_functions/v1/tests/test_data/use_an_lpa_successful_response.json
@@ -22,6 +22,7 @@
             "dob": "1972-05-10",
             "email": "[email protected]",
             "firstname": "Trevor",
+            "otherNames": null,
             "id": 7,
             "middlenames": null,
             "salutation": "Mr",
@@ -54,6 +55,7 @@
             "dob": null,
             "email": null,
             "firstname": "Julian",
+            "otherNames": null,
             "id": 5,
             "middlenames": null,
             "salutation": "Mr",
@@ -79,6 +81,7 @@
         "dob": "1952-07-17",
         "email": "[email protected]",
         "firstname": "changeme",
+        "otherNames": "Lucy",
         "id": 1,
         "middlenames": "Lucille",
         "salutation": "Mrs",
@@ -114,6 +117,7 @@
             "dob": null,
             "email": "",
             "firstname": null,
+            "otherNames": null,
             "id": 6,
             "middlenames": null,
             "salutation": null,

diff --git a/mock_sirius_backend/Dockerfile b/mock_sirius_backend/Dockerfile
@@ -1,5 +1,5 @@
 # our base image
-FROM python:3.6-slim
+FROM python:3.8-slim
 
 WORKDIR /var/www/
 COPY requirements.txt .

diff --git a/mock_sirius_backend/api/lpas/mock_data/lpa_online_tool_successful_response.json b/mock_sirius_backend/api/lpas/mock_data/lpa_online_tool_successful_response.json
@@ -24,6 +24,7 @@
                 "dob": "1972-05-10",
                 "email": "[email protected]",
                 "firstname": "Trevor",
+                "otherNames": null,
                 "id": 7,
                 "middlenames": null,
                 "salutation": "Mr",
@@ -56,6 +57,7 @@
                 "dob": null,
                 "email": null,
                 "firstname": "Julian",
+                "otherNames": null,
                 "id": 5,
                 "middlenames": null,
                 "salutation": "Mr",
@@ -82,6 +84,7 @@
             "dob": "1952-07-17",
             "email": "[email protected]",
             "firstname": "changeme",
+            "otherNames": "Lucy",
             "id": 1,
             "middlenames": "Lucille",
             "salutation": "Mrs",
@@ -118,6 +121,7 @@
                 "dob": null,
                 "email": "",
                 "firstname": null,
+                "otherNames": null,
                 "id": 6,
                 "middlenames": null,
                 "salutation": null,