https://github.com/hmcts/adoption-cos-api
Adoption Case Orchestration Service Spring boot application
https://github.com/hmcts/adoption-cos-api
jenkins-cft jenkins-cft-a-c
Last synced: about 1 month ago
JSON representation
Adoption Case Orchestration Service Spring boot application
- Host: GitHub
- URL: https://github.com/hmcts/adoption-cos-api
- Owner: hmcts
- License: mit
- Created: 2021-10-20T08:11:09.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-04-16T16:31:59.000Z (about 2 months ago)
- Last Synced: 2025-04-16T20:16:11.337Z (about 2 months ago)
- Topics: jenkins-cft, jenkins-cft-a-c
- Language: Java
- Size: 5.54 MB
- Stars: 1
- Watchers: 5
- Forks: 3
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Audit: audit.json
Awesome Lists containing this project
README
# Adoption Case Orchestration Service API [](https://opensource.org/licenses/MIT)
This API handles callbacks from CCD for the ADOPTION case type.
## Overview
┌─────────────────┐
│ │
│ADOPTION-COS-API │
│ │
└───────▲─────────┘
│
│
┌───────▼────────┐
│ │
┌─────► CCD ◄─────┐
│ │ │ │
│ └────────────────┘ │
│ │
┌───────┴─────────┐ ┌─────────┴───────┐
│ │ │ │
│ ADOPTION-WEB │ │ XUI │
│ │ │ │
└─────────────────┘ └─────────────────┘
## Prerequisites
Running the application requires the following tools to be installed in your environment:
- [JDK](https://openjdk.org/projects/jdk/17/) v17 *specifically*
- [Docker](https://www.docker.com)
- [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/)
## Building and running the application
### Building the application
The project uses [Gradle](https://gradle.org) 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 locally with CCD and XUI
Preliminary steps:
* Connect to F5 VPN:
Go to the webpage https://portal.platform.hmcts.net/ and follow the instructions to connect to F5 VPN. Once the F5 scan has taken place and you are taken to the F5 landing page, **make sure you click the VPN button** to actually start the VPN.
(This is needed because we connect to APIs deployed in the AAT environment while running the application locally.)
* Then log in to the subscription (you will need to get the subscription ID from another dev):
`az acr login --name hmctspublic --subscription [SUBSCRIPTION ID]`
You can now run the full CCD and XUI stack locally using:
./gradlew bootWithCcd
* Then you can access XUI on `http://localhost:3000`. This will redirect to the IDAM log-in page in AAT. Use the test account with e-mail address `[email protected]` and password `Password23` to log in as a case-worker.
If you see any errors then you need to recreate the test account using `curl` as follows:
```bash
curl --location 'https://idam-api.aat.platform.hmcts.net/testing-support/accounts' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "[email protected]",
"forename": "Test",
"surname": "Case-worker",
"password": "Password23",
"roles":
[
{ "code": "idam-mfa-disabled" },
{ "code": "caseworker" },
{ "code": "caseworker-adoption" },
{ "code": "caseworker-adoption-caseworker" }
]
}'
```
### Running the application elsewhere
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/adoption-cos-api` directory)
by executing the following command
docker-compose up
This will start the API container exposing the application's port (set to `4550` in this template app).
The application exposes health endpoint (http://localhost:4550/health):
curl http://localhost:4550/health
You should get a response similar to this:
{"status":"UP","diskSpace":{"status":"UP","total":249644974080,"free":137188298752,"threshold":10485760}}
### Generate CCD Excel Spreadsheet
To generate the CCD Excel files run the following from the root of the project:
./gradlew buildCCDXlsx
### Generate CCD JSON files
To generate the CCD JSON files from the Java Model run the following from the root of the project:
./gradlew generateCCDConfig
### Generate TypeScript definitions for CCD definition
./gradlew generateTypeScript
## Plugins
The project contains the following plugins:
* checkstyle
https://docs.gradle.org/current/userguide/checkstyle_plugin.html
Performs code style checks on Java source files using Checkstyle and generates reports from these checks.
The checks are included in gradle's *check* task (you can run them by executing `./gradlew check` command).
* pmd
https://docs.gradle.org/current/userguide/pmd_plugin.html
Performs static code analysis to finds common programming flaws. Included in gradle `check` task.
* jacoco
https://docs.gradle.org/current/userguide/jacoco_plugin.html
Provides code coverage metrics for Java code via integration with JaCoCo.
You can create the report by running the following command:
```bash
./gradlew jacocoTestReport
```
The report will be created in build/reports subdirectory in your project directory.
* io.spring.dependency-management
https://github.com/spring-gradle-plugins/dependency-management-plugin
Provides Maven-like dependency management. Allows you to declare dependency management
using `dependency 'groupId:artifactId:version'`
or `dependency group:'group', name:'name', version:version'`.
* org.springframework.boot
http://projects.spring.io/spring-boot/
Reduces the amount of work needed to create a Spring application
* org.owasp.dependencycheck
https://jeremylong.github.io/DependencyCheck/dependency-check-gradle/index.html
Provides monitoring of the project's dependent libraries and creating a report
of known vulnerable components that are included in the build. To run it
execute `gradle dependencyCheck` command.
* com.github.ben-manes.versions
https://github.com/ben-manes/gradle-versions-plugin
Provides a task to determine which dependencies have updates. Usage:
```bash
./gradlew dependencyUpdates -Drevision=release
```
## Connect to Preview Database
Hostname = adoption-preview.postgres.database.azure.com
Port = 5432
Database Name = pr--data-store
Username = hmcts
SSL (Parameters) = require
Password can be found in Kubernetes Services -> preview environment -> workloads
-> select deployment name adoption-cos-api-pr--ccd-data-store-api
-> select pod -> select container (overview) -> environment variables tab
-> click postgres link for DATA_STORE_DB_PASSWORD -> click eye to decrypt
To view the databases:
`kubectl get flexibleserversdatabases -n adoption`
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details