From f6ab950ce30b957f46a398b7be6d332a52fa1ef0 Mon Sep 17 00:00:00 2001 From: decentral1se Date: Tue, 5 Sep 2023 13:17:53 +0200 Subject: [PATCH] docs: int test suite --- docs/abra/hack.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/abra/hack.md b/docs/abra/hack.md index 2d6a18a..29cb921 100644 --- a/docs/abra/hack.md +++ b/docs/abra/hack.md @@ -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 ` 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!