This application orchestrates a workflow based on the requested business requirement.
Prerequisites
Building
The project uses Gradle 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:
./gradlew buildTo 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:
./gradlew bootRunThe 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
Unit tests
To run all unit tests and local functional tests respectively please execute following command:
./gradlew testCoding style tests
To run all checks (including unit tests) please execute following command:
./gradlew checkMutation 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.ymlassrc/main/resources/application-aat.yml - Make a copy of
src/integrationTest/resources/example-application-local.propertiesassrc/integrationTest/resources/application-local.properties - Replace the
replace_mesecrets 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])
- Add one or more appropriate labels to your PR in GitHub. Valid labels are:
enable_fortify_scanenable_full_functional_tests
- 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.
Enable schedule
Schedule service is disabled by default in local environment.
If you want to enable it, set the environment variable SCHEDULER_ENABLED
729E
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.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Standard API
We follow RESTful API standards.
This project is licensed under the MIT License - see the LICENSE.md file for details.