https://github.com/hmcts/aac-manage-case-assignment
Manage Case Assignment Microservice
https://github.com/hmcts/aac-manage-case-assignment
jenkins-cft jenkins-cft-a-c
Last synced: about 2 months ago
JSON representation
Manage Case Assignment Microservice
- Host: GitHub
- URL: https://github.com/hmcts/aac-manage-case-assignment
- Owner: hmcts
- License: mit
- Created: 2020-04-28T14:07:32.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-19T05:35:37.000Z (about 2 months ago)
- Last Synced: 2025-04-19T12:49:30.003Z (about 2 months ago)
- Topics: jenkins-cft, jenkins-cft-a-c
- Language: Java
- Size: 3.44 MB
- Stars: 2
- Watchers: 82
- Forks: 5
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Manage Case Assignment
[](https://hmcts.github.io/cnp-api-docs/swagger.html?url=https://hmcts.github.io/cnp-api-docs/specs/aac-manage-case-assignment.json)
This micro-service provides a set of APIs to manage case access.
**TODO**: add more description / architecture diagram etc
## Getting Started
### Prerequisites
- [JDK 21](https://java.com)
### Building
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:
```bash
./gradlew build
```
### Running
Run the application by executing:
```bash
./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](docker-compose.yml)
## API documentation
API documentation is provided with Swagger.
You can view the json spec here: [http://localhost:4454/v2/api-docs](http://localhost:4454/v2/api-docs)
Swagger UI is available here: [http://localhost:4454/swagger-ui.html](http://localhost:4454/swagger-ui.html)
## Developing
### Unit tests
To run all unit tests execute the following command:
```bash
./gradlew test
```
### Integration tests
To run all integration tests execute the following command:
```bash
./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](https://github.com/hmcts/ccd-docker#3-create-users-and-roles) steps in
[ccd-docker](https://github.com/hmcts/ccd-docker) project.
These tests can be run using:
```bash
./gradlew functional
```
### Code quality checks
We use [checkstyle](http://checkstyle.sourceforge.net/) and [PMD](https://pmd.github.io/).
To run all checks execute the following command:
```bash
./gradlew clean checkstyleMain checkstyleTest checkstyleIntegrationTest pmdMain pmdTest pmdIntegrationTest
```
### Docker
Create docker image:
```bash
docker-compose build
```
Run the distribution by executing the following command:
```bash
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](LICENSE.md) file for details.