build-and-deploy-canary-service

This service is used by the Build and Deploy team to test the build and deployment of a scala service into an environment.

Requirements

• AdoptOpenJDK Java 1.8.0_272
• sbt - version defined in build.properties

Updating dependencies and sbt

If you don't have Scala/Java installed follow the MDTP Handbook instructions: Install Java and Scala using SDKMAN!

To find dependencies that may need to be updated and the latest sbt version, the Tax Platform Catalogue will show outdated dependencies and sbt version for the running service.

For sbt version see build.properties

For service dependencies see AppDependencies.scala

For sbt plugins see plugins.sbt

After updating either the sbt version, sbt plugins, or service dependencies confirm the service compiles and tests pass with:

sbt clean test

Or, you can push to GitHub and use the PR Builder to test.

Smoke testing configuration

In order to confirm that platform tooling is properly passing configuration items to microservices, we check for the presence of various configuration items on launch. If any of these configuration items are missing, an exception will be thrown.

environment:
    SERVICE_WILL_FAIL_TO_START_WITHOUT_THIS_ENV_VAR: "value not important"

hmrc_config:
    service.will.fail.to.start.without.this.sys.prop: "value not important"

You can simulate the failure of a microservice bootstrap by removing any of these values from configuration and performing a deployment.

License

This code is open source software licensed under the Apache 2.0 License.