Civil CCD Callback Service.
The project is dependent on other Civil repositories:
To set up complete local environment for Civil check civil-sdk
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
You will need the following environment variables setup in your bashrc/zshrc or IntelliJ run configuration. API keys can be found in the Azure key store.
Name | Use | Value |
---|---|---|
DOCMOSIS_TORNADO_KEY |
Docmosis is our document generation service. For development purposes we have been using trial keys which can be obtained here. Note: These expire after a month. | |
GOV_NOTIFY_API_KEY |
GOV.UK Notify is our notification service for sending emails. | |
LAUNCH_DARKLY_SDK_KEY |
LaunchDarkly is our platform for managing feature toggles. | |
LAUNCH_DARKLY_OFFLINE_MODE |
Sets LaunchDarkly to use local values for flags rather than connecting to the service | true |
SPRING_PROFILES_ACTIVE |
Sets the active Spring profile | local |
IntelliJ will create a Spring Boot run configuration for you. Which, after setting up your environment variables, can be run from there.
While not necessary for local development, you can 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/civil-service
directory) by executing the following command:
docker-compose up
This will start the API container exposing the application's port (set to 4000
in this template app).
In order to test if the application is up, you can call its health endpoint:
curl http://localhost:4000/health
You should get a response similar to this:
{"status":"UP","diskSpace":{"status":"UP","total":249644974080,"free":137188298752,"threshold":10485760}}
Preview environment will be created when opening new PR. CCD and Camunda BPMN definitions will be pulled from the latest GitHub releases.
To access XUI visit url (make sure that it starts with https
, otherwise IDAM won't let you log in):
https://xui-civil-service-pr-PR_NUMBER.service.core-compute-preview.internal
To access Camunda visit url (login and password are both admin
):
https://camunda-civil-service-pr-PR_NUMBER.service.core-compute-preview.internal
You can generate contracts as follows:
./gradlew contract
If you want to publish the contracts to hmcts pact broker, please set this env variable accordingly before running the publish command.
export PACT_BROKER_FULL_URL=http://pact-broker.platform.hmcts.net/
If you want to publish the RPA contract to the PactFlow pact broker, please set this env variable accordingly before running the publish command. By setting your env variable to this, the IDAM contract will be ignored and only the RPA contract will be published to PactFlow.
export PACT_BROKER_FULL_URL=https://civil-claims.pactflow.io/
Before running, you should set the API token to connect to the pactflow portal as follows:
export PACT_BROKER_TOKEN=<api token here>
The API Token can be obtained on Confluence.
To publish your contracts:
./gradlew pactPublish
- If connecting to Pactflow, please disable the HMCTS VPN.
- Make sure your git version is at least 2.9 using the
git --version
command - Run the following command:
git config --local core.hooksPath .git-config/hooks
Once the above is done, you will be required to follow specific conventions for your commit messages and branch names.
If you violate a convention, the git error message will report clearly the convention you should follow and provide additional information where necessary.
Optional:
-
Install this plugin in Chrome: https://github.com/refined-github/refined-github
It will automatically set the title for new PRs according to the first commit message, so you won't have to change it manually.
Note that it will also alter other behaviours in GitHub. Hopefully these will also be improvements to you.
In case of problems
-
Get in touch with your Technical Lead so that they can get you unblocked
-
If the rare eventuality that the above is not possible, you can disable enforcement of conventions using the following command
git config --local --unset core.hooksPath
Still, you shouldn't be doing it so make sure you get in touch with a Technical Lead soon afterwards.
This project is licensed under the MIT License - see the LICENSE file for details