diff --git a/pages/common/bats.md b/pages/common/bats.md index 3ae6262b5..adf5367fb 100644 --- a/pages/common/bats.md +++ b/pages/common/bats.md @@ -3,18 +3,26 @@ > Bash Automated Testing System: a TAP () compliant testing framework for Bash. > More information: . -- Run a BATS test script and output results in the TAP (Test Anything Protocol) format: +- Run a BATS test script and output results in the [t]AP (Test Anything Protocol) format: `bats --tap {{path/to/test.bats}}` -- Count test cases of a test script without running any tests: +- [c]ount test cases of a test script without running any tests: `bats --count {{path/to/test.bats}}` -- Run BATS test cases contained in a directory and its subdirectories (files with a `.bats` extension): +- Run BATS test cases [r]ecursively (files with a `.bats` extension): `bats --recursive {{path/to/directory}}` -- Output results in a specific format: +- Output results in a specific [F]ormat: -`bats --formatter {{pretty|tap|junit}} {{path/to/test.bats}}` +`bats --formatter {{pretty|tap|tap13|junit}} {{path/to/test.bats}}` + +- Add [T]iming information to tests: + +`bats --timing {{path/to/test.bats}}` + +- Run specific number of [j]obs in parallel (requires GNU `parallel` to be installed): + +`bats --jobs {{number}} {{path/to/test.bats}}`