docs: int test suite
continuous-integration/drone/push Build is passing Details

This commit is contained in:
decentral1se 2023-09-05 13:17:53 +02:00
parent 91867ab5e3
commit f6ab950ce3
Signed by: decentral1se
GPG Key ID: 03789458B3D0C410
1 changed files with 19 additions and 0 deletions

View File

@ -20,6 +20,25 @@ Our [Drone CI configuration](https://git.coopcloud.tech/coop-cloud/abra/src/bran
Please use the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/) for your commits so we can automate our change log.
### `abra` integration tests
We use [`bats`](https://bats-core.readthedocs.io/en/stable/), you can install
the required dependencies with the following. You also need a working
installation of Docker and Go.
```
apt install bats bats-assert bats-support jq make git
```
Then you can run the integration test suite with the following:
```
bats tests/integration --timing --pretty
```
You can use `--filter <name>` to run specific tests. Or pass the filename to
run all tests from a specific file.
### Using the `abra` public API
Warning, there is currently no stability promise for the `abra` public API! Most of the internals are exposed in order to allow a free hand for developers to try build stuff. If people start to build things then we can start the discussion on what is useful to have open/closed and keep stable etc. Please let us know if you depend on the APIs!