Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmcts/div-case-orchestration-service
Divorce service to handle case orchestration between our other microservices
https://github.com/hmcts/div-case-orchestration-service
divorce jenkins-cft jenkins-cft-d-i
Last synced: about 1 month ago
JSON representation
Divorce service to handle case orchestration between our other microservices
- Host: GitHub
- URL: https://github.com/hmcts/div-case-orchestration-service
- Owner: hmcts
- License: mit
- Created: 2018-07-27T14:00:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-17T16:42:06.000Z (3 months ago)
- Last Synced: 2024-09-17T20:55:25.108Z (3 months ago)
- Topics: divorce, jenkins-cft, jenkins-cft-d-i
- Language: Java
- Homepage:
- Size: 8.8 MB
- Stars: 7
- Watchers: 112
- Forks: 3
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Divorce Case Orchestration Service [](https://opensource.org/licenses/MIT)
This application orchestrates a workflow based on the requested business requirement.
## Setup.
**Prerequisites**
- [JDK 11](https://openjdk.java.net/)
**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 please execute the following command:
```bash
./gradlew build
```
To get the project to build in IntelliJ IDEA, you have to:
- Install the Lombok plugin: Preferences -> Plugins
- Enable Annotation Processing: Preferences -> Build, Execution, Deployment -> Compiler -> Annotation Processors
**Running**
You can run the application by executing following command:
```bash
./gradlew bootRun
```
The application will start locally on `http://localhost:4012`
**API documentation**
API documentation is provided with Swagger:
- `http://localhost:4012/swagger-ui.html` - UI to interact with the API resources
## Testing
**Unit tests**
To run all unit tests and local functional tests respectively please execute following command:
```bash
./gradlew test
```
**Coding style tests**
To run all checks (including unit tests) please execute following command:
```bash
./gradlew check
```
**Mutation tests**
To run all mutation tests execute the following command:
```
./gradlew pitest
```
**Integration tests**
To run all integration tests locally:
* Make a copy of `src/main/resources/example-application-aat.yml` as `src/main/resources/application-aat.yml`
* Make a copy of `src/integrationTest/resources/example-application-local.properties` as `src/integrationTest/resources/application-local.properties`
* Replace the `replace_me` secrets in both of the _newly created_ files. You can get the values from SCM and Azure secrets key vault (the new files are in .gitignore and should ***not*** be committed to git)
* Start the app with AAT config using `./gradlew clean bootRunAat`
* Start the test with AAT config using `./gradlew clean functional`
**Faster PR builds**
If you're making a very small change which does not require ExtendTests to run, you may put `[FAST]` at the start of the pull request title to only run non-extended testes
If you have already created the PR without `[FAST]` in the title, you can add it but need to make a code change for Jenkins to pick it up
You can also run non-extended test only locally by setting the `CHANGE_TITLE` env variable to `[FAST]` (i.e simulating a PR with a title starting with `[FAST]`)
### Running additional tests in the Jenkins PR Pipeline
1. Add one or more appropriate labels to your PR in GitHub. Valid labels are:
- ```enable_fortify_scan```
- ```enable_full_functional_tests```
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.
## Developing
**Enable schedule**
Schedule service is disabled by default in local environment.
If you want to enable it, set the environment variable `SCHEDULER_ENABLED` to `true` or override application property `scheduler.enabled`
**Handling database**
Database will get initiated when you run ```docker-compose up``` for the first time by execute all scripts from database directory.
You don't need to migrate database manually since migrations are executed every time the application bootstraps.
[scheduler config](./job-scheduler)
**Versioning**
We use [SemVer](http://semver.org/) for versioning.
For the versions available, see the tags on this repository.
**Standard API**
We follow [RESTful API standards](https://hmcts.github.io/restful-api-standards/).
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.