Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hmcts/div-case-data-formatter
Divorce Case Data Formatter converts Front End Session Data to CCD data format
https://github.com/hmcts/div-case-data-formatter
jenkins-cft jenkins-cft-d-i
Last synced: about 1 month ago
JSON representation
Divorce Case Data Formatter converts Front End Session Data to CCD data format
- Host: GitHub
- URL: https://github.com/hmcts/div-case-data-formatter
- Owner: hmcts
- License: mit
- Created: 2018-06-29T08:59:02.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T19:54:55.000Z (2 months ago)
- Last Synced: 2024-10-22T13:37:00.082Z (2 months ago)
- Topics: jenkins-cft, jenkins-cft-d-i
- Language: Java
- Homepage:
- Size: 2.87 MB
- Stars: 1
- Watchers: 23
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Divorce Case Formatter Service [](https://opensource.org/licenses/MIT)
This is the Divorce Case Formatter Service which handles the different data conversion between different Divorce Components.
For example this will convert the Front End Session Data to CCD data format and vice versa.
## Setup
**Prerequisites**
- [JDK 17](https://openjdk.java.net)
- [Docker](https://www.docker.com)
**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
```
**Running**
First you need to create distribution by executing following command:
```bash
./gradlew installDist
```
When the distribution has been created in `build/install/div-case-formatter-service` directory,
you can run the application by executing following command:
```bash
docker-compose up
```
As a result the following container(s) will get created and started:
- long living container for API application exposing port `4011`
## Testing
To run all unit tests please execute following command:
```bash
./gradlew test
```
**Mutation tests**
To run all mutation tests execute the following command:
```bash
./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 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 gradle: `./gradlew clean bootRunAat`
* Using Intellij: edit Run Configuration and set Environment variables to `http_proxy=http://proxyout.reform.hmcts.net:8080;SPRING_PROFILES_ACTIVE=aat`
* Run the tests with AAT config using `./gradlew clean functional`
###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```
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
**Coding style tests**
To run all checks (including unit tests) please execute following command:
```bash
./gradlew check
```
**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/).
**API documentation**
API documentation is provided with Swagger:
- `http://localhost:4011/swagger-ui.html` - UI to interact with the API resources
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.