Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmcts/ia-case-documents-api
Immigration & Asylum case documents API
https://github.com/hmcts/ia-case-documents-api
jenkins-cft jenkins-cft-d-i
Last synced: about 1 month ago
JSON representation
Immigration & Asylum case documents API
- Host: GitHub
- URL: https://github.com/hmcts/ia-case-documents-api
- Owner: hmcts
- License: mit
- Created: 2018-11-21T15:17:56.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T14:16:07.000Z (about 2 months ago)
- Last Synced: 2024-10-29T17:24:27.491Z (about 2 months ago)
- Topics: jenkins-cft, jenkins-cft-d-i
- Language: Java
- Size: 42.4 MB
- Stars: 8
- Watchers: 15
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Audit: audit.json
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# ia-case-documents-api
Immigration & Asylum case documents API
## Purpose
Immigration & Asylum case documents API is a Spring Boot based application to generate documents for Immigration & Asylum Appellants and Legal Representatives.
### Prerequisites
To run the project you will need to have the following installed:
* Java 17
* Docker (optional)
For information about the software versions used to build this API and a complete list of it's dependencies see build.gradle
The following environment variables are required when running the api without its dependencies mocked. This includes running the functional tests locally. The examples (the values below are not real):
| Environment Variable | *Example values* |
|----------------------|----------|
| DOCMOSIS_ACCESS_KEY | some-docmosis-access-key |
| DOCMOSIS_ENDPOINT | some-docmosis-url |
| IA_IDAM_CLIENT_ID | some-idam-client-id |
| IA_IDAM_SECRET | some-idam-secret |
| IA_IDAM_REDIRECT_URI | http://localhost:3451/oauth2redirect |
| IA_S2S_SECRET | some-s2s-secret |
| IA_S2S_MICROSERVICE | some-s2s-gateway |
### Running the application
To run the API quickly use the docker helper script as follows: (make sure to have the environment variables set)
```
./bin/run-in-docker.sh --clean --install
```
Alternatively, you can start the application from the current source files using Gradle as follows:
```
./gradlew clean bootRun
```
### Using the application
To understand if the application is working, you can call it's health endpoint:
```
curl http://localhost:8092/health
```
If the API is running, you should see this response:
```
{"status":"UP"}
```
### Running verification tests:
You can run the *unit tests* and *integration tests* as follows:
```
./gradlew check
```
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 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/
## Adding Git Conventions
### Include the git conventions.
* Make sure your git version is at least 2.9 using the `git --version` command
* Run the following command:
```
git config --local core.hooksPath .git-config/hooks
```
Once the above is done, you will be required to follow specific conventions for your commit messages and branch names.
If you violate a convention, the git error message will report clearly the convention you should follow and provide
additional information where necessary.
*Optional:*
* Install this plugin in Chrome: https://github.com/refined-github/refined-github
It will automatically set the title for new PRs according to the first commit message, so you won't have to change it manually.
Note that it will also alter other behaviours in GitHub. Hopefully these will also be improvements to you.
*In case of problems*
1. Get in touch with your Technical Lead and inform them, so they can adjust the git hooks accordingly
2. Instruct IntelliJ not to use Git Hooks for that commit or use git's `--no-verify` option if you are using the command-line
3. If the rare eventuality that the above is not possible, you can disable enforcement of conventions using the following command
`git config --local --unset core.hooksPath`
Still, you shouldn't be doing it so make sure you get in touch with a Technical Lead soon afterwards.