mirror of
https://github.com/zokradonh/kopano-docker
synced 2025-06-29 02:36:57 +00:00
b004988517
* move docker-hub-helper in a general ci folder * move installation of tools into dedicated script (will make it easier to use a different ci platform) * mention the setup-tools script in contributing and move testing instructions in there as well
20 lines
1.5 KiB
Markdown
20 lines
1.5 KiB
Markdown
# Contributing
|
|
|
|
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
|
|
|
|
## Testing
|
|
|
|
This project includes a few automated tests that can be run to ensure that containers start up and are operational. Required tools for testing can be installed by executing `bash .ci/setup-tools.sh`.
|
|
|
|
The startup test can be executed by calling `make test-startup`. It spins up all containers and checks if they listen on their expected interfaces afterwards as well as execute some commands that should succeed on a succesful deployment.
|
|
|
|
A more detailed test can be executed by calling `make test-goss`. This uses [Goss](https://github.com/aelsabbahy/goss) and its helper [dcgoss](https://github.com/aelsabbahy/goss/tree/master/extras/dcgoss) to validate the container configuration at runtime. These tests have not been implemented for all containers yet, but as an upside the same validation is used as part of the container healtcheck. Contributions are welcome!
|
|
|
|
Testing the startup scripts of the containers is still a work in progress. When running `make test-commander` [Commander](https://github.com/SimonBaeumer/commander) will be used to test output of the `version.sh` script and some of the container startup scripts.
|
|
|
|
## Tricks
|
|
|
|
To speed up testing rebuilds you can override the git hash that is passed as a build argument.
|
|
|
|
Example: `make vcs_ref=invalid build-web` or `make vcs_ref=invalid build-all`
|