📖 Add testing instructions to readme

This commit is contained in:
Marty Oehme 2022-06-29 12:44:03 +02:00
parent 936f19bca6
commit b9708405fa
Signed by: Marty
GPG key ID: B7538B8F50A1C800

View file

@ -241,3 +241,12 @@ Thanks for checking this program out! ❤
If there are any problems, don't hesitate to open an issue.
If you have an idea or improvement, don't hesitate to open a merge request!
### Running tests
This project makes use of [bash-bats](https://github.com/bats-core/bats-core) (community fork) to test some of its functionality.
To run the tests locally, simply execute `./test/bats/bin/bats test`.
I would suggest running the test suite in docker instead, just to minimize the possibility of something going awry and borking up your local file system.
To run the tests in a docker suite, execute `docker run --rm -it -v "$PWD:/code" bats/bats:latest /code/test`