CONTRIBUTING.md

Overview for developers/contributors

You should have read the entire README.md once before starting to work on Castellum's codebase. This document assumes that you did that already.

Testing methodology

Core implementation

Run the full test suite with:

$ ./testing/with-postgres-db.sh make check

This will produce a coverage report at build/cover.html. If you don't need that, substitute check for quick-check to get slightly better performance.

Asset manager plugins

We do not do unit tests for the asset manager plugins. To test them under real-life conditions, run make test-asset-type-$ASSET_TYPE, e.g. make test-asset-type-nfs-shares. This reads all the required environment variables from a file .env, which should look like this:

export CASTELLUM_DB_URI="postgres://postgres@localhost/castellum?sslmode=disable"
export CASTELLUM_ASSET_MANAGERS="nfs-shares,project-quota"
export OS_AUTH_URL="https://keystone.example.com/v3"
...

You will then be presented with a shell prompt that should be pretty self-explanatory.