From b9708405fa34d022cc338aab4cd84126f23a107a Mon Sep 17 00:00:00 2001 From: Marty Oehme Date: Wed, 29 Jun 2022 12:44:03 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20Add=20testing=20instructions=20t?= =?UTF-8?q?o=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 99042a4..f84b3e3 100644 --- a/README.md +++ b/README.md @@ -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`