Welcome to Batspp’s documentation!

Shell style tests using bats-core framework.

Bats is a great TAP-compliant testing framework for Bash. It provides a simple way to verify that the UNIX programs you write behave as expected.

The goal of Batspp is to allow writing shell style tests with a simple and less idiosyncratic syntax.

#!/usr/bin/env batspp

# Test example with multiple assertions
$ filepath=$(echo $TMP/testfile-"$$")
$ echo -e "in this test\nwe are using\nmultiple assertions" | sudo tee $filepath
$ cat $filepath | wc -l
3
$ cat $filepath | wc -c
46

Batspp grew out of work for Thomas O’Hara on shell-scripts and mezcla.

Contents

• Installation
  • Dependencies
  • Using PIP
  • From source
• Writing Tests
  • Your first Batspp test
  • Naming your tests
  • Grouping commands into a single test
  • Splitting tests into multiple parts
  • Arrow assertions
  • Writing setups
  • Writing global setups
  • Writing teardowns
  • Writing global teardowns
  • Coverage Reports
  • Mote test examples!
• Writing Jupyter Tests
  • Setup the Jupyter Notebook
  • Your first jupyter test
  • Writing setups in Jupyter Tests
• Suggestions
  • Avoid flaky tests
  • Avoid long outputs
• Internals
  • Conventions
• Common errors
• Contributing

License

Batspp is released under an GNU Lesser General Public License Version 3, see LICENSE.TXT for details.