Manage Case Assignment

This micro-service provides a set of APIs to manage case access.

TODO: add more description / architecture diagram etc

Getting Started

Prerequisites

• JDK 21

Building

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

Run the application by executing:

./gradlew bootRun

Consuming this service locally

This image is available in the HMCTS azure container registry. Image url is: hmctspublic.azurecr.io/aac/manage-case-assignment See required config in: docker-compose.yml

API documentation

API documentation is provided with Swagger. You can view the json spec here: http://localhost:4454/v2/api-docs Swagger UI is available here: http://localhost:4454/swagger-ui.html

Developing

Unit tests

To run all unit tests execute the following command:

./gradlew test

Integration tests

To run all integration tests execute the following command:

./gradlew integration

Functional tests

These are the tests run against an environment. For example if you would like to test your local environment you'll need to export variables on your .bash_profile script.

Details of the relevant environment variables can be found in the aca-docker/README.md

Note: For details of the emails and passwords to use in a local environment see the Create users and roles steps in ccd-docker project.

These tests can be run using:

./gradlew functional

Code quality checks

We use checkstyle and PMD. To run all checks execute the following command:

./gradlew clean checkstyleMain checkstyleTest checkstyleIntegrationTest pmdMain pmdTest pmdIntegrationTest

Docker

Create docker image:

  docker-compose build

Run the distribution by executing the following command:

  docker-compose up

This will start the API container exposing the application's port 4454.

By default, docker-compose.yml is pointing to AAT urls of all downstream dependencies. So, you need to enable hmcts proxy.

You can spin-up full aca docker stack locally. Instructions are available under aca-docker/README.md.

License

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