https://github.com/hmcts/finrem-case-orchestration-service
Financial Remedy Case Orchestration Service
https://github.com/hmcts/finrem-case-orchestration-service
jenkins-cft jenkins-cft-d-i
Last synced: about 1 month ago
JSON representation
Financial Remedy Case Orchestration Service
- Host: GitHub
- URL: https://github.com/hmcts/finrem-case-orchestration-service
- Owner: hmcts
- License: mit
- Created: 2018-08-12T21:29:09.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-04-17T12:26:38.000Z (about 1 month ago)
- Last Synced: 2025-04-17T22:20:46.943Z (about 1 month ago)
- Topics: jenkins-cft, jenkins-cft-d-i
- Language: Java
- Homepage:
- Size: 21.5 MB
- Stars: 6
- Watchers: 159
- Forks: 2
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Audit: audit.json
- Security: SECURITY.md
Awesome Lists containing this project
README
# Financial Remedy Case Orchestration Service
[](https://sonarcloud.io/summary/new_code?id=finrem-case-orchestration) [](https://sonarcloud.io/summary/new_code?id=finrem-case-orchestration) [](https://sonarcloud.io/summary/new_code?id=finrem-case-orchestration) [](https://sonarcloud.io/summary/new_code?id=finrem-case-orchestration) [](https://sonarcloud.io/summary/new_code?id=finrem-case-orchestration)
## Overview
`finrem-case-orchestration` is a [Spring Boot](https://spring.io/projects/spring-boot) application and is responsible for handling all CCD callbacks
for Financial Remedy cases. It provides the business logic to enable Financial Remedy cases to be progressed through
the justice system.
The CCD definitions supported by this service can be found [here](https://github.com/hmcts/finrem-ccd-definitions).
## Prerequisites
- [JDK 21](https://openjdk.java.net/)
## Getting Started
### Building
The project uses [Gradle](https://gradle.org) as a build tool, but you don't have to install it locally since there is a
`./gradlew` wrapper script.
To build project execute the following command:
```bash
./gradlew build
```
### IntelliJ IDEA
To get the project to build in IntelliJ IDEA, you have to:
- Install the Lombok plugin: Settings -> Plugins
- Enable Annotation Processing: Settings -> Build, Execution, Deployment -> Compiler -> Annotation Processors
### Running
The service can be run with
```bash
./gradlew bootRun
```
The service listens on port 9000 `http://localhost:9000`
However, in order to develop and test `fincase-case-orchestration` you should run the service with the
[cftlib](https://github.com/hmcts/rse-cft-lib) plugin.
### Running with RSE CFT lib
[cftlib](https://github.com/hmcts/rse-cft-lib) is a Gradle plugin that provides a local CCD/ExUI environment
in which `finrem-case-orchestration` can be developed and tested.
The integration between the plugin and `finrem-case-orchestration` can be found in:
- `build.gradle` - see `bootWithCCD`
- src/cftlib
cftlib can be configured to run either
- using AAT services. See [cftlib AAT](docs/cftlib-aat.md)
- in a pure local environment without any AAT dependencies. See [cftlib Local](docs/cftlib-local.md)
#### Logs
Application logs for the services running locally can be found in `build/cftlib/logs`.
## API documentation
API documentation is provided with Swagger. This is available locally at: `http://localhost:9000/swagger-ui.html`
## Testing
### Unit tests
To run all unit tests and local functional tests execute following command:
```bash
./gradlew test
```
### Coding style tests
To run all checks (including unit tests) execute following command:
```bash
./gradlew check
```
### Mutation tests
To run all mutation tests execute the following command:
```bash
./gradlew pitest
```
### OWASP Dependency Vulnerability Checks
To run the OWASP checks for vulnerabilities in dependencies:
```bash
./gradlew dependencyCheckAggregate
```
### Crons
You can manually run a cron task from the cli:
```
TASK_NAME=[task] java -jar finrem-case-orchestration-service.jar run
# E.g.
TASK_NAME=AddApplicationTypeTask java -jar finrem-case-orchestration-service.jar
# or
TASK_NAME=AddApplicationTypeTask ./gradlew bootRun
```
### Running functional tests locally using CftLib
Ensure you have the following environment variables set:
- `FINREM_CLIENT_SECRET_AAT`
- `AUTH_PROVIDER_SERVICE_CLIENT_KEY`
1. From a terminal window run `./gradlew bootWithCCD`
2. From a separate terminal window run `./gradlew functional`
### Running additional tests in the Jenkins PR Pipeline
1. Add one or more appropriate labels to your PR in GitHub. Valid labels are:
- ```enable_security_scan```
- ```enable_fortify_scan```
2. Trigger a build of your PR in Jenkins. Fortify scans will take place asynchronously as part of the Static Checks/Container Build step.
- Check the Blue Ocean view for live monitoring, and review the logs once complete for any issues.
- As Fortify scans execute during the Static Checks/Container Build step, you will need to ensure this is triggered by making a minor change to the PR, such as bumping the chart version.
## Versioning
We use [SemVer](http://semver.org/) for versioning.
For the versions available, see the tags on this repository.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.