The Audit API is part of the Polaris platform (formerly DHOS). This service is responsible for storing audit events.
The Polaris platform was created by Sensyne Health Ltd., and has now been made open-source. As a result, some of the instructions, setup and configuration will no longer be relevant to third party contributors. For example, some of the libraries used may not be publicly available, or docker images may not be accessible externally. In addition, CICD pipelines may no longer function.
For now, Sensyne Health Ltd. and its employees are the maintainers of this repository.
These setup instructions assume you are using out-of-the-box installations of:
pre-commit
(https://pre-commit.com/)pyenv
(https://github.com/pyenv/pyenv)poetry
(https://python-poetry.org/)
You can run the following commands locally:
make install # Creates a virtual environment using pyenv and installs the dependencies using poetry
make lint # Runs linting/quality tools including black, isort and mypy
make test # Runs unit tests
You can also run the service locally using the script run_local.sh
, or in dockerized form by running:
docker build . -t <tag>
docker run <tag>
Endpoint | Method | Auth? | Description |
---|---|---|---|
/running |
GET | No | Verifies that the service is running. Used for monitoring in kubernetes. |
/version |
GET | No | Get the version number, circleci build number, and git hash. |
/dhos/v1/event/{event_id} |
GET | Yes | Get an event by ID |
/dhos/v1/event |
GET | Yes | Get a list of events, filtered by event creator and/or event type |
/dhos/v1/event |
POST | Yes | Create a new audit event |
/dhos/v2/event/{event_uuid} |
GET | Yes | Get an event by UUID |
/dhos/v2/event |
GET | Yes | Get a list of events, filtered by event creator and/or event type |
/dhos/v2/event |
POST | Yes | Create a new audit event |
At a minimum you require a system with Python 3.9. Tox 3.20 is required to run the unit tests, docker with docker-compose are required to run integration tests. See Development environment setup for a more detailed list of tools that should be installed.
All development is done on a branch tagged with the relevant ticket identifier. Code may not be merged into develop unless it passes all CircleCI tests. :partly_sunny: After merging to develop tests will run again and if successful the code is built in a docker container and uploaded to our Azure container registry. It is then deployed to test environments controlled by Kubernetes.
🔬 Either use make
or run tox
directly.
tox
: Running make test
or tox with no arguments runs tox -e lint,default
make clean
: Remove tox and pyenv virtual environments.
tox -e debug
: Runs last failed unit tests only with debugger invoked on failure. Additional py.test command line arguments may given preceded by --
, e.g. tox -e debug -- -k sometestname -vv
make default
(or tox -e default
) : Installs all dependencies, verifies that lint tools would not change the code, runs security check programs then runs unit tests with coverage. Running tox -e py39
does the same but without starting a database container.
tox -e flask
: Runs flask within the tox environment. Pass arguments after --
. e.g. tox -e flask -- --help
for a list of commands. Use this to create database migrations.
make help
: Show this help.
make lint
(or tox -e lint
) : Run black
, isort
, and mypy
to clean up source files.
make openapi
(or tox -e openapi
) : Recreate API specification (openapi.yaml) from Flask blueprint
make pyenv
: Create pyenv and install required packages (optional).
make readme
(or tox -e readme
) : Updates the README file with database diagram and commands. (Requires graphviz dot
is installed)
make test
: Test using tox
make update
(or tox -e update
) : Updates the poetry.lock
file from pyproject.toml
🔩 Integration tests are located in the integration-tests
sub-directory. After changing into this directory you can run the following commands:
🐛 Bugs related to this microservice should be raised on Jira as PLAT-### tickets with the component set to Locations.
Any changes affecting the database schema should be reflected in a database migration. Simple migrations may be created automatically:
$ tox -e flask -- db migrate -m "some description"
More complex migration may be handled by creating a migration file as above and editing it by hand. Don't forget to include the reverse migration to downgrade a database.
DATABASE_USER, DATABASE_PASSWORD, DATABASE_NAME, DATABASE_HOST, DATABASE_PORT
configure the database connection.LOG_LEVEL=ERROR|WARN|INFO|DEBUG
sets the log levelLOG_FORMAT=colour|plain|json
configure logging format. JSON is used for the running system but the others may be more useful during development.
Audit events are stored in a Postgres database.