CONTRIBUTING.md

Contributing

To make contributions to this charm, you'll need a working development setup.

You can create a virtual python environment for development with tox:

tox devenv -e unit
source venv/bin/activate

Testing

This project uses tox for managing test environments. There are some pre-configured environments that can be used for linting and formatting code when you're preparing contributions to the charm:

tox run -e format        # update your code according to linting rules
tox run -e lint          # run static analysis (code style, type checking, etc.)
tox run -e unit          # run unit tests
tox run -e integration   # run integration tests
tox                      # run 'lint' and 'unit' environments

This project also uses make for managing charm related operations. You can use the following make targets to perform charming tasks:

make                            # show help text
make update-charm-libs          # update charm's libraries
make check-dashboard-updates    # check if there's a new dashboard from the upstream
make sync-dashboards            # update the dashboards from upstream
make clean                      # remove unneeded files
make download-snap              # download snap release from github release assets
make build                      # build the charm
make integration                # run the tests defined in the integration subdirectory

Fetching libraries

Charm libraries are managed with charmcraft and recorded in ./scripts/update-charm-libs.sh.

To update the libraries included, run

make update-charm-libs

If you need to include more charm libraries, you can run:

charmcraft fetch-lib <operator-libs>

And add the corresponding command to ./scripts/update-charm-libs.sh.

Checking for dashboard updates

The openstack exporter dashboards are managed in the sunbeam-charms repository. They are shared between this project for Charmed OpenStack, and openstack-exporter-k8s in sunbeam-charms for Microstack (Sunbeam). To check if updates to the dashboards are available you can run the make target:

make check-dashboard-updates

If it reports updates, you can update them by running:

make sync-dashboards

Build the charm

Build the charm in this git repository using:

charmcraft -v pack