Skip to content

Latest commit

 

History

History
141 lines (95 loc) · 3.35 KB

DEVELOPMENT.md

File metadata and controls

141 lines (95 loc) · 3.35 KB
Raw

Development

Requirements

  • Python 3.10.x
  • Django 4.2.x

OS Dependencies

  • libxml2
# For Mac users with brew:
brew unlink libxml2
brew uninstall libxml2 --ignore-dependencies --force
brew install --with-python libxml2
brew link libxml2 --force

Setup

Ensure the correct version of Python is installed locally before running these commands. To manage Python versions locally on your device, you may want to use pyenv.

Installation instructions for pyenv can be found here.

Quick start

make setup-local
make dbreload
make server

Alternatively, these commands can be run individually to set up the service step-by-step:

  • Install virtual environment
pip3 install pipenv
pipenv shell
  • Install application dependencies
pipenv install -d
  • Create/Migrate database
pipenv run python3 manage.py migrate --no-input
  • Seed database
pipenv run python3 manage.py loadalldata
  • reseed database
pipenv run python3 manage.py migrate
pipenv run python3 manage.py cleardata
pipenv run python3 manage.py loadalldata
  • Run the server

By default bounds to port 8080

DEBUG="True" pipenv run python3 manage.py runserver 8000
  • Run the test suite
pipenv run python3 manage.py test
  • Run the test suite and report on code coverage metrics
pipenv run python3 -m coverage run manage.py test
pipenv run python3 -m coverage report
  • Run an individual test
pipenv run python3 manage.py test calculator.tests.test_calculation_05_agfs_12

Running locally using docker

Tested using:

  • Docker Desktop version 4.4.2
  • Docker version 20.10.12
  • docker-compose version 1.29.2

build

docker-compose build

run locally

docker-compose up

Open interactive API (swagger) documentation

localhost:8000/api/v1/docs

Secret management

Secrets should not be kept in this repository. In the past git-crypt has been used to encrypt secrets within the repo however due to the difficulty of rotating the symmetric key used for encryption following a security breach, this approach has now been deprecated.

Secrets are held as Kubernetes Secret objects in the cluster. These can be accessed by executing

kubectl -n laa-fee-calculator-<env> get secrets

when authenticated to the cluster to view a list of all secrets.

To view the contents of a Secret, execute:

kubectl -n laa-fee-calculator-<env> get secrets <secret-name> -o json

For more details on how to add or update Kubernetes Secrets, see the Cloud Platform documentation.

Secrets are also held securely in a password management service. This provides redundancy in the event that a Kubernetes Secret is deleted from the cluster; it can be recreated using the data held in the backup.

There is no automatic syncing of secrets between these backups and Kubernetes. If secret data is added or changed in one, it must be manually reflected in the other. Please refer to this Confluence document for more information.