From fc42587a8f34367cffeca324cc00d8cef0105df5 Mon Sep 17 00:00:00 2001 From: Serene-Arc Date: Sun, 13 Jun 2021 13:10:13 +1000 Subject: [PATCH] Add information to sub-README --- scripts/tests/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/scripts/tests/README.md b/scripts/tests/README.md index e69de29..8349f7a 100644 --- a/scripts/tests/README.md +++ b/scripts/tests/README.md @@ -0,0 +1,13 @@ +# Bash Scripts Testing + +The `bats` framework is included and used to test the scripts included, specifically the scripts designed to parse through the logging output. As this involves delicate regex and indexes, it is necessary to test these. + +## Running Tests + +Running the tests are easy, and can be done with a single command. Once the working directory is this directory, run the following command. + +```bash +./bats/bin/bats *.bats +``` + +This will run all test files that have the `.bats` suffix.