Skip to content

Commit 2c81de9

Browse files
committed
Update testing docs
1 parent 2f8652f commit 2c81de9

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,19 @@ Or alternatively specify the environment variables:
3939

4040
Some subcommands require additional environment parameters.
4141

42+
## Testing
43+
44+
[bats](https://bats-core.readthedocs.io/en/stable/index.html) is used for testing. To test the image and commands bats and docker are required. Use the following commands to run all of the tests.
45+
46+
```
47+
make build-with-cache # or make build
48+
make test
49+
```
50+
51+
All tests are kept in `tests/` and all of the extension `.bats`. `test_functions.bash` is also loaded by each test. The functions include a setup and teardown (see bats docs) which creates and destroys a postgres target server.
52+
53+
Using bats setup and teardown and avoiding exposing postgres ports etc should allow tests to be run in parallel.
54+
4255
## Status
4356

4457
Feature incomplete. Work in progress.

0 commit comments

Comments
 (0)