hiBike

The hiBike plugin, created in cooperation with Radlobby.

Contributing

To contribute, install the dependencies

poetry install

and the pre-commit hooks:

poetry run pre-commit install

Tests

To run all tests:

poetry run pytest

Coverage

To get a coverage report of how much of your code is run during testing, execute poetry run pytest --ignore test/core/ --cov. We ignore the test/core/ folder when assessing coverage because the core tests run the whole plugin to be sure everything successfully runs with a very basic configuration. Yet, they don't actually test functionality and therefore artificially inflate the test coverage results.

To get a more detailed report including which lines in each file are not tested, run poetry run pytest --ignore test/core/ --cov --cov-report term-missing

Linting and formatting

It is important that the code created by the different plugin developers adheres to a certain standard. We use ruff for linting and formatting the code as part of our pre-commit hooks. Please activate pre-commit by running poetry run pre-commit install. It will now run automatically before each commit and apply fixes for a variety of lint errors to your code. Note that we have increased the maximum number of characters per line to be 120 to make better use of large modern displays. If you want to keep short lines explicitly seperate (e.g. in the definition of functions or list) please use "magic trailing commas".

Logging

Using the environment variable LOG_Level you can adjust the amount of log messages produced by the plugin. Please make sure to use logging throughout your plugin. This will make debugging easier at a later stage.

Docker (for admins and interested devs)

If the infrastructure is reachable you can copy .env.base_template to .env.base and then run

docker build --secret id=CI_JOB_TOKEN . --tag heigit/{bikeability}:devel
docker run --env-file .env.base --network=host heigit/{bikeability}:devel

Make sure the cone-token is copied to the text-file named CI_JOB_TOKEN that is mounted to the container build process as secret.

To deploy this plugin to the central docker repository run

docker build --secret id=CI_JOB_TOKEN . --tag heigit/{bikeability}:devel
docker image push heigit/{bikeability}:devel

To mimic the build behaviour of the CI you have to add --build-arg CI_COMMIT_SHORT_SHA=$(git rev-parse --short HEAD) to the above command.