BTMS Gateway

The BTMS Gateway is a .NET application which proxies HTTP SOAP requests between CDS and ALVS. Proxied requests will be passed to/from CDS and ALVS as well as routing a copy of the request to BTMS, via SNS/SQS, by converting the SOAP payload to a BTMS JSON model.

It also proxies HTTP requests from ALVS to IPAFFS.

The Gateway exposes a health check endpoint, for verifying the health of the Gateway itself, at the endpoint /health. This will return a 200 OK response and an empty response body if the Gateway is healthy.

The Gateway also exposes endpoints for doing various health checks against the Health URLs configured in appsettings.json. This is to verify the health of the target systems where requests are routed to i.e. CDS, ALVS and IPAFFS. These health checks will perform an HTTP call to the endpoint as well as an NSLookup and Dig. The available health endpoints can be viewed by visiting the swagger endpoint /swagger/index.html.

• Prerequisites
• Setup Process
• How to run in development
• How to run Tests
• Running
• Deploying
• SonarCloud
• Dependabot
• Licence Information
• About the Licence

Prerequisites

• .NET 9 SDK
• NSLookup and Dig for performing health checks
• Docker
  • For testing locally using SNS/SQS queues setup with localstack
  • You will optionally need a running instance of Gateway Stub (https://github.com/DEFRA/btms-gateway-stub) if any of the configured NamedRoutes in your appsettings are configured to forward requests to Stub

Setup Process

• Install the .NET 9 SDK installed
• Ensure you have NSLookup and Dig available on your machine if you wish to execute the Health Checks locally
• This project reference Nuget packages that are hosted in Github. In order for the build to access these packages you will need to configure a PAT token that gives you access to the Github Nuget.
  • Create a Github PAT token for your account and configure it in the .env file. See .env.example file for an example of how your .env file should look
• Install Docker
  • Run the following Docker Compose to set up locally running queues, wiremock instance for testing as well as the Gateway application itself

  docker compose -f compose.yml up -d

How to run in development

Run the application and dependent resources using Docker Compose:

docker compose -f compose.yml up -d

This will run the SNS/SQS resources, a Wiremock instance and the Gateway application itself, within Docker containers.

You can run the application locally with the command:

dotnet run --project BtmsGateway --launch-profile BtmsGateway

Ensure it's not already running in the Docker Compose stack or you may get port clashes.

How to run Tests

Run the Unit tests with:

dotnet test --filter "Category!=IntegrationTest"

Unit tests execute without a running instance of the web server.

How to run Integration Tests

Run the integration tests with:

dotnet test --filter "Category=IntegrationTest"

Integration tests require the Docker Compose stack to be running.
The application itself can be running inside the Docker Compose stack or you can run it locally yourself (see above).

Deploying

Before deploying via CDP set the correct config for the environment as per the appsettings.Development.json.

SonarCloud

Example SonarCloud configuration are available in the GitHub Action workflows.

Dependabot

We are using dependabot.

Connection to the private Defra nuget packages is provided by a user generated PAT stored in this repo's settings - /settings/secrets/dependabot - see DEPENDABOT_PAT secret.

The PAT is a classic token and needs permissions of read:packages.

At time of writing, using PAT is the only way to make Dependabot work with private nuget feeds.

Should the user who owns the PAT leave Defra then another user on the team should create a new PAT and update the settings in this repo.

Licence Information

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

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.