[GPCAPIM-397] Set up INT test provider requests

.vscode/cspell-dictionary.txt

@@ -34,6 +34,7 @@ dpkg
 DSTU
 eamodio
 errstr
+EMIS
 Farsley
 fhir
 getfixturevalue
@@ -47,6 +48,7 @@ gpprovider
 HAPI
 healthcheck
 htmlcov
+HSCN
 igorshubovych
 isort
 jdkato

README.md

@@ -176,6 +176,8 @@ _Note: `FLASK_HOST` and `FLASK_PORT` are hardcoded in to the Dockerfile. These a
 | `BASE_URL` | Set if targeting a locally deployed application; otherwise, leave unset. |
 | `TARGET_ENV` | Either `local` or `remote`, to inform the HTTP client used by the tests how to behave - e.g. add auth headers, etc. |
 | `REMOTE_TEST_USERNAME` | The test user through which the tests will be authenticated against when run against a remote target. |
+| `TEST_NHS_NUMBER` | The NHS number to be sent in the request payload. Environments will have a limited set of NHS numbers that are able to form a full end-to-end flow. |
+| `CONSUMER_ODS_CODE` | The consumer ODS code to send in the header. ODS codes may only work in some environments. |
 
 ## Testing
 

gateway-api/pyproject.toml

@@ -64,7 +64,7 @@ dev = [
 [tool.mypy]
 strict = true
 
-[tool.pytest.ini_options]
+[tool.pytest]
 bdd_features_base_dir = "tests/acceptance/features"
 markers = [
     "status_auth_headers",

gateway-api/src/gateway_api/provider/client.py

@@ -129,17 +129,18 @@ def access_structured_record(
         base_endpoint = self.provider_endpoint.rstrip("/") + "/"
         url = urljoin(base_endpoint, self.endpoint_path)
 
+        # INT provider system certs are not accepted by requests library,
+        # so we disable SSL verification for the integration environment for now.
+        verify_certs = os.environ.get("VERIFY_PROVIDER_CERTS", "true").lower() == "true"
         log_details = {
             "description": "GPProvider FHIR API request",
             "url": url,
+            "verify_certs": verify_certs,
         }
         _logger.info(log_details)
 
         response = post(
-            url,
-            headers=headers,
-            data=body,
-            timeout=TIMEOUT,
+            url, headers=headers, data=body, timeout=TIMEOUT, verify=verify_certs
         )
         log_details = {
             "description": "GPProvider FHIR API response received",

gateway-api/src/gateway_api/provider/test_client.py

@@ -41,7 +41,7 @@ def _fake_post(
         url: str,
         headers: CaseInsensitiveDict[str],
         data: str,
-        timeout: int,  # NOQA ARG001 (unused in stub)
+        **_kwargs: str,
     ) -> Response:
         """A fake requests.post implementation."""
 

gateway-api/stubs/stubs/data/patients/int_9692140466.json

@@ -27,7 +27,7 @@
             "type": "Organization",
             "identifier": {
                 "system": "https://fhir.nhs.uk/Id/ods-organization-code",
-                "value": "A20047",
+                "value": "B86047",
                 "period": {"start": "2020-01-01", "end": "9999-12-31"}
             }
         }

gateway-api/stubs/stubs/sds/stub.py

@@ -350,7 +350,7 @@ def _seed_default_devices(self) -> None:
             {
                 "org_ods": "CONSUMER",
                 "device_id": "C0C0E921-92CA-4A88-A550-2DBB36F703AF",
-                "asid": "asid_CONS",
+                "asid": "210987654321",
                 "display": "Example Consumer Organisation",
             },
             {
@@ -419,7 +419,7 @@ def _seed_default_endpoints(self) -> None:
             {
                 "org_ods": "CONSUMER",
                 "endpoint_id": "E1E1E921-92CA-4A88-A550-2DBB36F703AF",
-                "asid": "asid_CONS",
+                "asid": "210987654321",
                 "address": "https://consumer.example.com/fhir",
             },
             {

gateway-api/tests/README.md

@@ -43,6 +43,7 @@ Use the following commands to create the appropriate `.env.test` file for the ta
 * `make env-test-ci` to write a `.env.test` file for testing a locally deployed application, from outside the dev container.
 * `make env-test-pr-<pr number>` to write a `.env.test` file for testing an application deployed behind a PR proxy.
 * `make env-test-alpha-int` to write a `.env.test` file for testing an application deployed to the "alpha integration" environment.
+* `make env-test-int` to write a `.env.test` file for testing an application that sends requests to PDS, SDS and Provider integration environments.
 
 _Note: Unit tests require the `.env` file, as these tests do not test a deployed application`_
 
@@ -213,10 +214,9 @@ Consumer tests generate the pact contract files in `tests/contract/pacts/` (e.g.
 Shared fixtures in `tests/conftest.py` are available across all test types:
 
 * **`base_url`**: The base URL of the deployed Lambda function (from `BASE_URL` environment variable highlighted above)
-* **`host`**: The hostname of the deployed application (from `HOST` environment variable highlighted above)
 * **`client`**: An HTTP client instance for sending requests to the APIs
 
-### Load Testing with Locust ('load/')
+## Load Testing with Locust ('load/')
 
 Load testing is performed using Locust. You have the option of running via the CLI or UI.
 You will need [Proxygen setup](../../README.md#proxygen) to run the load tests.
@@ -350,3 +350,27 @@ The GitHub Actions workflow (`.github/workflows/stage-2-test.yaml`) orchestrates
               │ 3. Enforce thresholds │
               └───────────────────────┘
 ```
+
+## Testing INT locally
+
+To test a locally deployed application against the integration environments of external services, PDS, SDS and Provider systems:
+
+* Set up secrets in `.secrets` as per the instructions in `.secrets/README.md`
+* `make env-int` - writes the `.env` file to point the application at the integration environments for each external service.
+* `make deploy` - will deploy the application, feeding the `.env` values in to its container environment.
+
+### Manual test
+
+To manually test the application against the integration environments, run the Bruno collection using the `localInt.yml` environment.
+
+### Automated tests
+
+To run a subset the automated test suite, run the following commands
+
+```bash
+make env-test-int
+source .env.test
+set -a && source .env && set +a
+cd gateway-api
+poetry run pytest tests/integration/test_get_structured_record.py -k happy_path
+```

gateway-api/tests/conftest.py

@@ -1,10 +1,10 @@
 """Pytest configuration and shared fixtures for gateway API tests."""
 
-import copy
 import os
 from collections.abc import Callable
 from datetime import timedelta
 from typing import Any, cast
+from uuid import uuid4
 
 import pytest
 import requests
@@ -13,7 +13,7 @@
 DEFAULT_REQUEST_HEADERS = {
     "Content-Type": "application/fhir+json",
     "Ods-from": "CONSUMER",
-    "Ssp-TraceID": "test-trace-id",
+    "Ssp-TraceID": str(uuid4()),
 }
 
 
@@ -80,8 +80,25 @@ def send_health_check(self) -> requests.Response:
 
 
 @pytest.fixture
-def simple_request_payload() -> dict[str, Any]:
-    return copy.deepcopy(SIMPLE_PAYLOAD)
+def nhs_number() -> str:
+    return _fetch_env_variable("TEST_NHS_NUMBER", str)
+
+
+@pytest.fixture
+def simple_request_payload(nhs_number: str) -> dict[str, Any]:
+    payload = {
+        "resourceType": "Parameters",
+        "parameter": [
+            {
+                "name": "patientNHSNumber",
+                "valueIdentifier": {
+                    "system": FHIRSystem.NHS_NUMBER,
+                    "value": nhs_number,
+                },
+            },
+        ],
+    }
+    return payload
 
 
 @pytest.fixture
@@ -100,6 +117,15 @@ def headers(env: str, request: pytest.FixtureRequest) -> dict[str, str]:
     return nhsd_headers | apikey_headers
 
 
+@pytest.fixture
+def ods_header() -> dict[str, str]:
+    try:
+        ods_code = _fetch_env_variable("CONSUMER_ODS_CODE", str)
+    except ValueError:
+        ods_code = "CONSUMER"
+    return {"Ods-from": ods_code}
+
+
 @pytest.fixture
 def client(
     base_url: str,

gateway-api/tests/contract/stub/test_sds_stub_contract.py

@@ -238,22 +238,12 @@ def test_endpoint_bundle_matches_expected_response(
         assert body["type"] == "searchset"
         assert body["total"] == len(body["entry"])
 
-        assert len(body["entry"]) == 4
-        endpoint_ids = [
-            "E0E0E921-92CA-4A88-A550-2DBB36F703AF",
-            "E1E1E921-92CA-4A88-A550-2DBB36F703AF",
-            "E2E2E921-92CA-4A88-A550-2DBB36F703AF",
-            "E3E3E921-92CA-4A88-A550-2DBB36F703AF",
-        ]
-        for i in range(len(endpoint_ids)):
-            entry = body["entry"][i]
-
-            endpoint_id = endpoint_ids[i]
+        for entry in body["entry"]:
+            endpoint_id = entry["resource"]["id"]
             assert (
                 entry["fullUrl"]
                 == f"https://sandbox.api.service.nhs.uk/spine-directory/FHIR/R4/Endpoint/{endpoint_id}"
             )
-            assert entry["resource"]["id"] == endpoint_id
             assert entry["search"]["mode"] == "match"
 
     def test_x_correlation_id_echoed_back_when_provided(

gateway-api/tests/integration/data/alice_jones_9999999999.json

@@ -0,0 +1,56 @@
+{
+  "resourceType": "Bundle",
+  "type": "collection",
+  "meta": {
+    "profile": [
+      "https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-StructuredRecord-Bundle-1"
+    ]
+  },
+  "entry": [
+    {
+      "resource": {
+        "resourceType": "Patient",
+        "id": "9999999999",
+        "meta": {
+          "versionId": "1",
+          "lastUpdated": "2020-01-01T00:00:00Z"
+        },
+        "identifier": [
+          {
+            "system": "https://fhir.nhs.uk/Id/nhs-number",
+            "value": "9999999999"
+          }
+        ],
+        "name": [
+          {
+            "use": "official",
+            "family": "Jones",
+            "given": [
+              "Alice"
+            ],
+            "period": {
+              "start": "1900-01-01",
+              "end": "9999-12-31"
+            }
+          }
+        ],
+        "gender": "female",
+        "birthDate": "1980-01-01",
+        "generalPractitioner": [
+          {
+            "id": "1",
+            "type": "Organization",
+            "identifier": {
+              "system": "https://fhir.nhs.uk/Id/ods-organization-code",
+              "value": "A12345",
+              "period": {
+                "start": "2020-01-01",
+                "end": "9999-12-31"
+              }
+            }
+          }
+        ]
+      }
+    }
+  ]
+}