LBH Cautionary Alerts API

The Cautionary alerts API for accessing cautionary alerts attached to a person or property There are two GET endpoints. One returns a list of records and the another returns a specific record for a given ID

Stack

• .NET Core as a web framework.
• nUnit as a test framework.

Contributing

Setup

1. Install Docker.
2. Install AWS CLI.
3. Clone this repository.
4. Rename the initial template.
5. Open it in your IDE.

Development

To serve the application, run it using your IDE of choice, we use Visual Studio CE and JetBrains Rider on Mac.

The application can also be served locally using docker:

1. Add you security credentials to AWS CLI.

$ aws configure

2. Build and serve the application. It will be available in the port 3000.

$ make build && make serve

Release process

We use a pull request workflow, where changes are made on a branch and approved by one or more other maintainers before the developer can merge into master branch.

Then we have an automated six step deployment process, which runs in CircleCI.

1. Automated tests (nUnit) are run to ensure the release is of good quality.
2. The application is deployed to development automatically, where we check our latest changes work well.
3. We manually confirm a staging deployment in the CircleCI workflow once we're happy with our changes in development.
4. The application is deployed to staging.
5. We manually confirm a production deployment in the CircleCI workflow once we're happy with our changes in staging.
6. The application is deployed to production.

Our staging and production environments are hosted by AWS. We would deploy to production per each feature/config merged into master branch.

Static Code Analysis

Using FxCop Analysers

FxCop runs code analysis when the Solution is built.

Both the API and Test projects have been set up to treat all warnings from the code analysis as errors and therefore, fail the build.

However, we can select which errors to suppress by setting the severity of the responsible rule to none, e.g dotnet_analyzer_diagnostic.<Category-or-RuleId>.severity = none, within the .editorconfig file. Documentation on how to do this can be found here.

Testing

Run the tests

Run all tests in Docker - requires setting up the environment variables needed for cautionary-alerts-api-test

$ make test

To run database tests locally (e.g. via Visual Studio):

• the CONNECTION_STRING environment variable will need to be populated with: Host=localhost;Database=entitycore;Username=postgres;Password=mypassword"

Note: The Host name needs to be the name of the stub database docker compose service, in order to run tests via Docker.

• Run make local-test-setup to run the test database and the test instances of AWS resources used for E2E tests

Agreed Testing Approach

• Use nUnit, FluentAssertions and Moq
• Always follow a TDD approach
• Tests should be independent of each other
• Gateway tests should interact with a real test instance of the database
• Test coverage should never go down
• All use cases should be covered by E2E tests
• Optimise when test run speed starts to hinder development
• Unit tests and E2E tests should run in CI
• Test database schemas should match up with production database schema
• Have integration tests which test from the PostgreSQL database to API Gateway

Data Migrations

A good data migration

• Record failure logs
• Automated
• Reliable
• As close to real time as possible
• Observable monitoring in place
• Should not affect any existing databases

Contacts

Active Maintainers

• Selwyn Preston, Lead Developer at London Borough of Hackney ([email protected])
• Mirela Georgieva, Developer at London Borough of Hackney ([email protected])
• Matt Keyworth, Developer at London Borough of Hackney ([email protected])

Other Contacts

• Rashmi Shetty, Product Owner at London Borough of Hackney ([email protected])