ccd-test-stubs-service

Environment variables

The following environment variables are required:

Name	Default	Description
WIREMOCK_SERVER_MAPPINGS_PATH	wiremock	Path to WireMock mappings

Note: If the path to the WireMock mapping files is not set, it will use the default mappings from the project resource repository (https://github.com/hmcts/ccd-test-stubs-service/tree/master/wiremock/mappings). If setting the variable, please keep all WireMock json stub files in a directory named mappings and exclude this directory in the path. For e.g. if you place the mappings in /home/user/mappings then export WIREMOCK_SERVER_MAPPINGS_PATH=/home/user. If you are running data-store-api in a docker container, please make sure the callback URLs defined in the definition file use the host as host.docker.internal:5555 and if running the data-store-api on its own (non-docker), then the host should be localhost:5555

For more information on how to define wiremock stubs, please visit http://wiremock.org/docs/stubbing.

Building the application

The project uses Gradle as a build tool. It already contains ./gradlew wrapper script, so there's no need to install gradle.

To build the project execute the following command:

  ./gradlew build

Running the application

Create the image of the application by executing the following command:

  ./gradlew assemble

Create docker image:

  docker-compose build

Run the distribution (created in build/install/ccd-test-stubs-service directory) by executing the following command:

  docker-compose up

This will start the API container exposing the application's port (set to 5555 in this template app).

In order to test if the application is up, you can call its health endpoint:

  curl http://localhost:5555/health

You should get a response similar to this:

  {"status":"UP","diskSpace":{"status":"UP","total":249644974080,"free":137188298752,"threshold":10485760}}

Alternative script to run application

To skip all the setting up and building, just execute the following command:

./bin/run-in-docker.sh

For more information:

./bin/run-in-docker.sh -h

Script includes bare minimum environment variables necessary to start api instance. Whenever any variable is changed or any other script regarding docker image/container build, the suggested way to ensure all is cleaned up properly is by this command:

docker-compose rm

It clears stopped containers correctly. Might consider removing clutter of images too, especially the ones fiddled with:

docker images

docker image rm <image-id>

There is no need to remove postgres and java or similar core images.

Idam Stub

The service can be used to stub IDAM calls. It comes with a preconfigured stub IDAM user with some defaults IDAM roles.
When testing CCD it's very often needed to customise the roles list. For example to test how certain a feature behaves for a caseworker compared to a solicitor.
The following endpoint can be used to change the stubbed user info at runtime by posting the desired user info as JSON:

/idam-user

Example:

curl -X POST \
--header 'content-type: application/json' \
--data '{"email":"auto.test.cnp@gmail.com","roles":["caseworker-autotest1","caseworker-autotest2","caseworker-autotest3","caseworker","ccd-import"],"sub":"auto.test.cnp@gmail.com","uid":"7689","name":"CCD Auto Test (Stub2)","given_name":"CCD","family_name":"Auto Test (Stub2)"}' \
http://localhost:5555/idam-user

The changes are not persistent, i.e. they do not survive service restarts

Additional information

dynamic-case-data-response-transformer: This transformer merges the case data from request payload with stubbed case data in the response. To use this transformer, please define it in the wiremock response mapping as configured in wiremock/mappings/aat_dynamic_data_about_to_submit.json

Example: If the request payload is:

{ "data": { "firstName": "Test" } }

And stubbed response payload is:

{ "data": { "lastName": "Stub" } }

Then using this transformer will produce the final response as:

{ "data": { "firstName": "Test", "lastName": "Stub" } }

Example CCD definition file configuration with callbacks

An example spreadsheet definition [CCD_CNP_27_With_Callbacks.xlsx] is available under root directory with configured callback urls. This can be used / tweaked to test various CCD callback scenarios.

Urls have to go under CaseEvent CaseEventToFields tabs against various callback columns (CallBackURLAboutToStartEvent, CallBackURLAboutToSubmitEvent, CallBackURLSubmittedEvent and CallBackURLMidEvent).

Pipeline testing in isolation

A large number of the test stubs contained in this library are callback APIs created to support specific test scenarios built into the CCD Data Store's functional tests. Therefor changes to this library should be tested by re-running these tests against an instance of the Test-Stubs service containing these changes.

As the CCD preview pipelines by default use shared instances of some services to store the case type definitions; it is important that any test CCD pipelines are configured to run in isolation otherwise any changes to the callback URLs risk impacting in-flight CCD preview pipelines or the custom callback URLs may be quickly overwritten by another pipeline giving false results to your own tests.

Therefor the following steps should be applied:

• Ensure the Test-Stubs pull request (PR) that is under test has the keep-helm label set to ensure the instance remains active after the pipeline is complete.
• Generate test PRs for the CCD Definition Store and CCD Data Store and configured them to run in isolation as described in Configuring pipeline isolation.
• Apply the following additional changes to the CCD pipelines to make them use the Test-Stubs PR that is under test:

CCD Definition Store additional pipeline configuration:

• Jenkinsfile_CNP add the following but referring to the correct Test-Stubs PR number:

  env.TEST_STUB_SERVICE_BASE_URL = "http://ccd-test-stubs-service-pr-204-java"
  

CCD Data Store additional pipeline configuration:

• Jenkinsfile_CNP add or override the following but referring to the correct Test-Stubs PR number:

  env.BEFTA_TEST_STUB_SERVICE_BASE_URL = "https://ccd-test-stubs-service-pr-204.service.core-compute-preview.internal"
  env.TEST_STUB_SERVICE_BASE_URL = "http://ccd-test-stubs-service-pr-204-java"
  

  Note: these are two different URLs as one call is jenkins FTAs -> Preview Test-Stubs and the other is Preview Data-Store -> Preview Test-Stubs. So they both need different URLs to allow them to resolve the Test-Stubs endpoint correctly from their respective source environment.

License

This project is licensed under the MIT License - see the LICENSE file for details