Run the application
To run the application execute
and then access the application at
Running unit tests
Running accessibility tests
The above tests are run via the sbt-accessibility-linter plugin. This plugin requires Node.js v12 or above to be installed locally.
Running the UI acceptance/integration tests
The UI and ZAP tests are based on the template at https://github.com/hmrc/platform-example-ui-journey-tests with some modifications to allow them to be run as part of the microservice repository.
To run the UI acceptance tests locally, you will need a copy of Chrome and the Chrome browser driver installed at /usr/local/bin/chromedriver
The Chrome driver is available at https://chromedriver.chromium.org/
Running ZAP scan locally
To run the ZAP scan, use the Docker helper supplied by
Follow the following steps:
- Clone the repo at: https://github.com/hmrc/dast-config-manager
- Enable port forwarding:
- Configure port forwarding:
- In the
dast-config-managerdirectory, start the ZAP docker container:
- In the
help-frontenddirectory, run the acceptance tests with ZAP proxying:
sbt -Dbrowser=chrome -Dzap.proxy=true acceptance:test
- In the
dast-config-managerdirectory, stop the ZAP docker container:
Information about the local ZAP test output can be found at https://github.com/hmrc/dast-config-manager#running-zap-locally.
We are using scalafmt to auto-format all Scala and SBT code. This is enforced in CI. We recommend configuring your IDE to auto-format on save. Alternatively, run the following command before opening a PR:
sbt scalafmtAll scalafmtSbt
This code is open source software licensed under the Apache 2.0 License.