Java DropWizard Flyway Starter

Database Migration - Local

0. Add checkstyle to the project

   • Go to IntelliJ at the top of your screent -> Select Settings -> Plugins
   • Search and Add CheckSyle-IDEA as a plugin in the project
   • Apply and Ok (May ask you to restart IDE, if so just do so)
   • Go to IntelliJ at the top of your screent -> Select Settings -> Editor -> Code Style
   • Click the cog beside the dropdown near the header "Scheme"
   • Select Import Scheme
   • Select CheckStyle configuration
   • Find the "sun_checks_modified.xml" file (should be in the src -> main -> resources)
   • Select the file
   • Apply and Ok
   • Go to IntelliJ at the top of your screent -> Select Settings -> Tools -> CheckStyle
   • Click the + under the configuration file
   • Add a description and then Find the "sun_checks_modified.xml" file when you click browse
   • Select the file
   • Click next
   • Check the box
   • Apply and Ok

1. Add your SQL script to resources.db.migration directory

2. Add the following lines to your ~/.zshrc file:

export FLYWAY_URL="jdbc:mysql://YOUR_DB_HOST/YOUR_DB_NAME"
export FLYWAY_USER="YOUR_DB_USERNAME"
export FLYWAY_PASSWORD="YOUR_DB_PASSWORD"
export FLYWAY_BASELINE_ON_MIGRATE=true

3. Reload your terminal session if required:

. ~/.zshrc

4. Run Flyway command through Maven:

mvn flyway:migrate

Database Migration - Production

1. Add following secrets to your Github repo:

DB_USERNAME - the prod db username
DB_PASSWORD - the prod db password
DB_HOST - the prod db host
DB_NAME - the prod db name

2. Raise a pull request with your script in the resources.db.migration directory
3. After approvals, merge pull request; this will trigger the migration action to run in Github
4. Ensure migration successfully runs against prod database

How to start the test application

1. Set the following environment variables:
   1. DB_USERNAME
   2. DB_PASSWORD
   3. DB_HOST
   4. DB_NAME
2. Run mvn clean install to build your application
3. You can start application via:
   1. Terminal: java -jar target/java-swagger-flyway-starter-org.kainos.ea.jar server config.yml
   2. IDE: Edit run configuration -> Add server to program arguments -> Run
4. To check that your application is running enter url http://localhost:8080/api/test

Health Check

To see your applications health enter url http://localhost:8081/healthcheck

Testing

Run mvn test to build your application This will show you the full breakdown within the test suite

• Test run -> Shows the overall test ran
• Test passed -> Out of the overall test ran, shows the test passed
• Test failed -> Out of the overall test ran, shows the test failed
• Test skipped -> Out of the overall test ran, shows the test skipped