CaseWorker Ref API
Provides Case worker user profile data to clients, implemented as a Java/SpringBoot application.
for more Info about the CaseWorker, Please refer to the confluence
Architecture of the Caseworker (https://tools.hmcts.net/confluence/pages/viewpage.action?pageId=1444742328) and
Business of the CaseWorker (https://tools.hmcts.net/confluence/display/RTRD/Caseworker+Reference+Data)
To run the project you will need to have the following installed:
- Java 17
- Docker
For information about the software versions used to build this API and a complete list of it's dependencies see build.gradle
While not essential, it is highly recommended to use the pre-push git hook included in this repository to ensure that all tests are passing. This can be done by running the following command:
$ git config core.hooksPath .githooks
If running locally for development or testing you will need to set the following environment variables
- export POSTGRES_USERNAME=dbrefdata
- export POSTGRES_PASSWORD=
- export client-secret=
- export totp_secret=
- export password=
- export key=
Please Make sure you are connected to the VPN before running the Application. (https://portal.platform.hmcts.net/vdesk/webtop.eui?webtop=/Common/webtop_full&webtop_type=webtop_full)
To run the API quickly use the docker helper script as follows:
./bin/run-in-docker.sh install
or
docker-compose up
After, you can start the application from the current source files using Gradle as follows:
./gradlew clean bootRun
If required, to run with a low memory consumption, the following can be used:
./gradlew --no-daemon assemble && java -Xmx384m -jar build/libs/rd-case-worker-api.jar
To understand if the application is working, you can call it's health endpoint:
curl http://localhost:8095/health
If the API is running, you should see this response:
{"status":"UP"}
If the API is running, you can see API's in swagger :
http://localhost:8095/swagger-ui.html
The application uses a Postgres database which can be run through a docker container on its own if required.
this
The application should automatically apply any database migrations using flyway.
You can run the integration tests as follows:
./gradlew integration
If the API is running (either inside a Docker container or via gradle bootRun) you can run the functional tests as follows:
./gradlew functional
If you want to run a specific scenario use this command:
./gradlew functional --tests <TestClassName> --info -Dscenario=<Scenario>
If the API is running (either inside a Docker container or via gradle bootRun) you can run the smoke tests as follows:
./gradlew smoke
If you have some time to spare, you can run the mutation tests as follows:
./gradlew pitest
As the project grows, these tests will take longer and longer to execute but are useful indicators of the quality of the test suite.
More information about mutation testing can be found here: http://pitest.org/
To test in Postman the easiest way is to start this service using the ./bin/run-in-docker.sh script. The in postman paste the following script:
pm.sendRequest('http://127.0.0.1:8095/token', function (err, res) {
if (err) {
console.log(err);
} else {
pm.environment.set("token", res.text());
}
});
into the pre-script window. Also add a header as follows:
ServiceAuthorization: Bearer {{token}}
Authorization : Bearer copy IDAM access token
To publish against remote broker:
./gradlew pactPublish
Turn on VPN and verify on url https://pact-broker.platform.hmcts.net/
The pact contract(s) should be published
To publish against local broker:
Uncomment out the line found in the build.gradle:
pactBrokerUrl = 'http://localhost:9292'
comment out the real broker
Start the docker container from the root dir run
docker-compose -f broker-compose.yml up
Publish via the gradle command
./gradlew pactPublish
Once Verify on url http://localhost:9292/
The pact contract(s) should be published
Remember to return the localhost back to the remote broker
for more information, Please refer to the confluence on how to run and publish PACT tests. https://tools.hmcts.net/confluence/display/RTRD/PACT+testing
![dependabot-preview[bot] avatar](https://avatars.githubusercontent.com/in/2141?v=4 "dependabot-preview[bot]")
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "github-actions[bot]")
![hmcts-jenkins-rd[bot] avatar](https://avatars.githubusercontent.com/in/58068?v=4 "hmcts-jenkins-rd[bot]")
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent