trade-exportscore-plp

Prerequisites

• Docker
• Docker Compose (installed when Docker Desktop is installed - no separate installation is required).

Optional:

• Kubernetes
• Helm

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.

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.

• run migrations
  • docker-compose -f docker-compose.migrate.yaml run --rm database-up
• start
  • docker-compose up
• stop
  • docker-compose down or CTRL-C

To run the app not using Docker, e.g. for pdf parsing

• First setup environment variables for document intelligence
• export FORM_RECOGNIZER_ENDPOINT="https://<DI_NAME>.cognitiveservices.azure.com/"
• export IS_DOCUMENT_INTLELLIGENCE_ENABLED="true"
• Connect to OpenVPN
• Sign in using az login
• Start
  • npm run start:watch
• Stop
  • CTRL-C

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.

Examples:

# Run all tests
scripts/test

# Run tests with file watch
scripts/test -w

Passing files to the local app

From within VS Code, please start the local app (i.e. press 'F5').

Once running, in the brower of your choice, navigate to the following:

http://localhost:3000/non-ai?filename={filename and path}

e.g.

http://localhost:3000/non-ai?filename=240424-I6001%20DDICE017%20MAIN20DD.xlsx

To facilitate the above, you will need to create a local directory called packing-lists under the main app directory (it is excluded from Git and thus no files will be commited to the repository). Prior to running the test(s) for the first time, simply add the file(s) to the packing-lists directory.

In addition to the above, please refer to the Additional Information file for extensions that make running / debugging a single test easier than the above method.

Troubleshooting

If you receive the following error:

please check docker is running. The message is interesting but, more importantly, so far wrong...

Debugging

After much fun, please refer to the Debugging file for information on how (and where) to debug your tests.

CI & CD Pipeline

This service uses the ADP Common Pipelines for Builds and Deployments.

AppConfig - KeyVault References

If the application uses keyvault references in appConfig.env.yaml, please make sure the variable to be added to keyvault is created in ADO Library variable groups and the reference for the variable groups and variables are provided in build.yaml like below.

variableGroups:
    - trade-exportscore-plp-snd1
    - trade-exportscore-plp-snd2
    - trade-exportscore-plp-snd3
variables:
    - trade-exportscore-plp-APPINSIGHTS-CONNECTIONSTRING

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.