FFC AHWR Application Manager

Application Manager for Animal Health and Welfare Review

Prerequisites

Docker
Docker Compose

Optional:

Kubernetes
Helm

Create development queues

To complete an application locally, Azure Service Bus queues need to be configured. The queue names derive from a combination of queue addresses and developer initials suffix.

For example with APPLICATIONREQUEST_QUEUE_ADDRESS set as application-request and MESSAGE_QUEUE_SUFFIX set as -jd (John Doe), a queue named application-request-jd needs to be created in Azure. For the supply and claim journeys this application service relies upon:

${APPLICATIONREQUEST_QUEUE_ADDRESS}${MESSAGE_QUEUE_SUFFIX} (application-request-jd): sessions disabled
${APPLICATIONRESPONSE_QUEUE_ADDRESS}${MESSAGE_QUEUE_SUFFIX} (application-response-jd): sessions enabled
${EVENT_QUEUE_ADDRESS}${MESSAGE_QUEUE_SUFFIX} (event-queue-jd): sessions disabled

Environment variables

The following environment variables are required by the application. Values for development are set in the Docker Compose configuration. Default values for production-like deployments are set in the Helm chart and may be overridden by build and release pipelines.

Name	Description
MESSAGE_QUEUE_HOST	Azure Service Bus hostname, e.g. `myservicebus.servicebus.windows.net`
MESSAGE_QUEUE_PASSWORD	Azure Service Bus SAS policy key
MESSAGE_QUEUE_SUFFIX	Developer initials
MESSAGE_QUEUE_USER	Azure Service Bus SAS policy name, e.g. `RootManageSharedAccessKey`
APPLICATIONREQUEST_QUEUE_ADDRESS	Azure Service Bus message request queue name, e.g. `application-request`
APPLICATIONRESPONSE_QUEUE_ADDRESS	Azure Service Bus message response queue name, e.g. `application-response`
PAYMENTREQUEST_QUEUE_ADDRESS	Azure Service Bus message request queue name, e.g. `payment-request`
NOTIFY_API_KEY	GOV.UK Notify API Key
NOTIFY_TEMPLATE_ID_FARMER_APPLICATION_COMPLETE	Id of email template used for farmer application complete
NOTIFY_TEMPLATE_ID_FARMER_CLAIM_COMPLETE	Id of email template used to notify farmer for claim being completed
NOTIFY_TEMPLATE_ID_FARMER_ENDEMICS_REVIEW_COMPLETE	Id of email template used to notify farmer for Endemics Review claim being completed
NOTIFY_TEMPLATE_ID_FARMER_ENDEMICS_FOLLOWUP_COMPLETE	Id of email template used to notify farmer for Endemics Follow-up claim being completed
SERVICE_URI	URI of service (used in links, in emails) e.g. `http://localhost:3000` or `https://defra.gov.uk`
CLAIM_COMPLIANCE_CHECK_RATIO	The ratio in which claims require a compliance check, e.g. 3 means one in every 3 claims

Running the application

The application is designed to run in containerised environments, using Docker Compose in development and Kubernetes in production.

A Helm chart is provided for production deployments to Kubernetes.

Run database migrations

For local development run the Docker Compose command to execute the Liquibase database migrations (creating tables, columns, seed data etc):

# Run the database-up script (executes Liquibase)
# Explicitly run the docker compose down command to shut down the database container
docker compose -f docker-compose.migrate.yaml up database-up && docker compose -f docker-compose.migrate.yaml down

For ease or running, the above command has been added to a script - ./scripts/migrate. The script will also shut down the application as if it is still running errors will be reported when the migration(s) run.

Build container image

Container images are built using Docker Compose, with the same images used to run the service with either Docker Compose or Kubernetes.

When using the Docker Compose files in development the local app folder will be mounted on top of the app folder within the Docker container, hiding the CSS files that were generated during the Docker build. For the site to render correctly locally npm run build must be run on the host system.

By default, the start script will build (or rebuild) images so there will rarely be a need to build images manually. However, this can be achieved through the Docker Compose build command:

# Build container images
docker compose build

Start

Use Docker Compose to run service locally.

docker compose up

Test structure

The tests have been structured into subfolders of ./test as per the Microservice test approach and repository structure

Running tests

A convenience script is provided to run automated tests in a containerised environment. This will rebuild images before running tests via docker compose, using a combination of docker-compose.yaml and docker-compose.test.yaml. The command given to docker compose run may be customised by passing arguments to the test script. (scripts/test) Note that executing this script will load any .env file you have locally automatically which may affect test results. Please run testlocal instead which wraps this and temporarily moves any present .env file

Examples:

# Run all tests
scripts/testlocal

# Run tests with file watch
scripts/testlocal -w

CI pipeline

This service uses the FFC CI pipeline

Licence

THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:

http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3

The following attribution statement MUST be cited in your products and applications when using this information.

Contains public sector information licensed under the Open Government license v3

About the licence

The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.

It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.

DEFRA/ffc-ahwr-application