Add PDS data within Wiremock migratestructuredrecord stub response (#641)

We believe this will reduce the time spend hand crafting and deploying
specific wiremock stubs when testing in our INT Path to Live environment.

Follows on from 4b2254b which was believed
to have a similar effect, but it would appear that EMIS/TPP validate the
patient details which come back. The only way I can see to avoid that failure
in a pain-free way is to integrate with PDS directly, and inject the correct
patients details into the response so that EMIS won't error.

This only adds PDS data to `correctPatientNoDocsStructuredRecordResponse.json`
but the same pattern could be expanded across all responses in a follow up PR.

Author: Adrian Clay

Jenkinsfile

@@ -88,7 +88,7 @@ pipeline {
                             if (sh(label: 'Running gp2gp docker build', script: 'docker build -f docker/service/Dockerfile -t ${DOCKER_IMAGE} .', returnStatus: true) != 0) {error("Failed to build gp2gp Docker image")}
 
                             if (publishWiremockImage) {
-                                if (sh(label: "Running ${WIREMOCK_ECR_REPO_DIR} docker build", script: 'docker build -f docker/wiremock/Dockerfile -t ${WIREMOCK_DOCKER_IMAGE} docker/wiremock', returnStatus: true) != 0) {error("Failed to build ${WIREMOCK_ECR_REPO_DIR} Docker image")}
+                                if (sh(label: "Running ${WIREMOCK_ECR_REPO_DIR} docker build", script: 'docker build -f docker/wiremock/Dockerfile -t ${WIREMOCK_DOCKER_IMAGE} .', returnStatus: true) != 0) {error("Failed to build ${WIREMOCK_ECR_REPO_DIR} Docker image")}
                             }
                             if (publishMhsMockImage) {
                                 if (sh(label: "Running ${MHS_MOCK_ECR_REPO_DIR} docker build", script: 'docker build -f docker/mock-mhs-adaptor/Dockerfile -t ${MHS_MOCK_DOCKER_IMAGE} .', returnStatus: true) != 0) {error("Failed to build ${MHS_MOCK_ECR_REPO_DIR} Docker image")}

developer-information.md

@@ -172,7 +172,7 @@ We provide mocks of external APIs (GPC, SDS) for local development and testing.
 * Navigate to `docker`
 * `docker-compose up wiremock`
 
-The folder `docker/wiremock/stubs` describes the supported interactions.
+The folder `wiremock/stubs` and [README](wiremock/README.md) describe the supported interactions.
 
 ## How to use Mock MHS Adaptor
 

docker/docker-compose.yml

@@ -82,12 +82,11 @@ services:
   wiremock:
     networks: 
       - commonforgp2gp
-    build: ./wiremock
+    build:
+      context: ../
+      dockerfile: docker/wiremock/Dockerfile
     ports:
       - "8110:8080"
-    command:
-      - -global-response-templating
-      - -no-request-journal
 
   integration-wiremock:
     networks:

docker/wiremock/Dockerfile

@@ -1,5 +1,9 @@
-FROM wiremock/wiremock:2.33.2
+FROM gradle:8.5-jdk17
 
-COPY stubs /home/wiremock
+COPY --chown=gradle:gradle wiremock /home/gradle/wiremock
 
-CMD ["--global-response-templating", "--verbose"]
+WORKDIR /home/gradle/wiremock
+
+RUN ["gradle", "jar"]
+
+ENTRYPOINT ["java", "-jar", "build/libs/wiremock.jar"]

docker/wiremock/README.md wiremock/README.mddocker/wiremock/README.md renamed to wiremock/README.md

@@ -55,6 +55,17 @@ The `migratestructuredrecord` endpoint will also respond to unknown NHS Numbers,
 by default returning a NOT FOUND response, but can also be set up to reply with
 a valid patient record.
 
+Wiremock can also be configured to fetch patient information (name, dob, address)
+from the PDS Application-Restricted FHIR API.
+
+Using the [authentication guidance], you'll need to provide the following environment variables:
+
+- PDS_KEY_ID - "Key Identifier" from Step 2
+- PDS_API_KEY - "API Key" from Step 1
+- PDS_PRIVATE_KEY - "Private key" from Step 2, as a string without whitespace, and the "---" header and footers removed.
+
+[authentication guidance]: https://digital.nhs.uk/developer/guides-and-documentation/security-and-authorisation/application-restricted-restful-apis-signed-jwt-authentication
+
 ### Changing the default record
 
 To change the patient record returned to be [No Documents](stubs/__files/correctPatientNoDocsStructuredRecordResponse.json):

wiremock/build.gradle

@@ -0,0 +1,26 @@
+apply plugin: 'java'
+apply plugin: 'application'
+repositories {
+  mavenCentral()
+}
+
+dependencies {
+  implementation "org.wiremock:wiremock:3.4.1"
+  implementation "org.json:json:20240303"
+  implementation "com.auth0:java-jwt:4.4.0"
+  implementation "org.slf4j:slf4j-simple:2.0.12"
+}
+
+mainClassName = 'Wiremock'
+
+jar {
+  manifest {
+    attributes 'Main-Class': application.mainClass
+  }
+
+  from {
+    configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
+  }
+
+  duplicatesStrategy = DuplicatesStrategy.EXCLUDE
+}

wiremock/gradle/wrapper/gradle-wrapper.jar

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists