Manage a Providers Data

A flask application for managing legal aid providers' data.

Getting started

Local installation for development:

Setup

Create a virtual environment and install the python dependencies:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements/generated/requirements-development.txt

Assets setup

For this you'll need to install node > v20.9.0.

nvm install --lts
nvm use --lts

npm install

Once installed you now have access to GOVUK components, stylesheets and JS via the node_module

To copy some of the assets you'll need into your project, run the following:

npm run build

Ensure you do this before starting your Flask project as you're JS and SCSS imports will fail in the flask run.

Configuration environment variables

Create your local config file .env from the template file:

cp .env.example .env

Don't worry, you can't commit your .env file.

Run the service

source .venv/bin/activate
flask --app app run --debug --port=8020

Now you can browse: http://127.0.0.1:8020

(The default port for flask apps is 5000, but on Macs this is often found to conflict with Apple's Airplay service, hence using another port here.)

Running in Docker

For local development and deployments, run the below code to create and run the Manage a Provider's Data container image.

./run_local.sh

Testing

To run the tests:

python -m pytest --cov=app --cov-report=term-missing --cov-branch

Playwright Testing

To run all tests:

pytest

To run unit tests:

pytest tests/unit_tests

To run functional/non-functional tests:

pytest tests/functional_tests

Run tests in headed mode:

pytest --headed

Run tests in a different browser (chromium, firefox, webkit):

pytest --browser firefox

Run tests in multiple browsers:

pytest --browser chromium --browser webkit

If you are running into issues where it states a browser needs to be installed run:

playwright install

For further guidance on writing tests https://playwright.dev/python/docs/writing-tests

Code formatting and linting

The following will:

• Generate requirement.txt files from files inside requirements/source/.in and put them into requirements/generated/.txt
• Run linting checks with ruff
• Run secret detection via trufflehog3

pre-commit install

Manually running linting

The Ruff linter looks for code quality issues. Ensure there are no ruff issues before committing.

To lint all files in the directory, run:

ruff check

To format all files in the directory, run:

ruff format

Dependency management

Requirements listed in the requirements/source/*.in files should not be pinned by default.

If a release is incompatible then this can be specified using requirement!=1.0.5, or requirement<2.0.

Using this method allows for pip-tools to resolve the latest compatible versions of all dependencies, making dependency updates easier.

How to update dependencies

make update-deps

This will update the pinned version of the all the requirements in requirements/generated/*.txt using the latest version allowed by the corresponding requirements/source/*.in file. By pinning every dependency in these generated files we can be sure all environments are using the same dependency versions.

Secret scanning

We use Gitleaks for secret scanning. Gitleaks is installed as a pre-commit hook and runs as part of the static-analysis job in the CI pipeline.

If you wish to knowingly commit a test secret please add #gitleaks:allow to the end of the line. For example

class CustomClass:
    client_secret = "8dyfuiRyq=vVc3RRr_edRk-fK__JItpZ"  #gitleaks:allow