Repository files navigation

Dead simple testing framework for Bash with coverage.

I was looking for a Bash testing framework with a familiar API and with coverage reporting. Although there are excellent frameworks likebats-core,shunit2 andbashunit, I wasn't too comfortable with their API (not their fault). Also, I wanted some indication of coverage, so that it can be improved over time.

critic.sh exposes high level functions for testing consistent with other frameworks and a set of built in assertions. One of my most important goals was to be able to pass in any shell expression to the_test and_assert methods, so that one is not limited to the built-ins.

In addition, it can generate a lcov report. It tracks line and function coverage, but not branches. It works by running the tests with extended debugging, redirecting the trace output to a log file, and then parsing it to determine which functions/lines have been executed. It is currently a work in progress.

Due to use of certain bashisms, Bash v4.1+ is required. This may change in the future.

A tiny docker image is provided for convenience.

There are a few ways to usecritic.sh:

• Use the docker image

docker run --rm -v$(pwd):/work checksum/critic.sh'/work/src/*.sh''/work/lib/*.sh'

You can pass aCRITIC_SETUP environment variable to run setup scripts before the tests are run. The docker image is based on alpine linux, so useapk to install packages:

docker run --rm -e CRITIC_SETUP='apk add --no-cache jq' -v$(pwd):/work checksum/critic.sh'/work/src/*.sh''/work/lib/*.sh'

• Add this repository as a git submodule in your project

git submodule add https://github.com/Checksum/critic.sh criticcritic/critic.sh test.sh

• Copycritic.sh file into your project (not recommended)

Seeexamples/test.sh for detailed usage. To run the tests:bash examples/test.sh

# test-foobar.sh# Include your source filessource foobar.sh# Include the frameworksource critic.sh# Write tests_describe foo  _test"output should equal foo"    _assert _output_equals"foo"  _test"return code should be 0"    _assert _return_true"Optional assertion message"

critic.sh test-foobar.sh

The layout of a test is consistent with other frameworks. You_describe a test suite,_test a function or expression, and_assert the output with a function or expression. The output, return code and arguments passed to the test are available as variables for all custom assertions.

After every_test is run, the following variables are set. These are useful for custom assertions:

# critic ignorefoo() {echo"This function will skipped when calculating coverage %"}# critic /ignore