bats-core
A TAP-compliant testing framework for Bash and other UNIX programs, enabling simple verification of expected behavior.
What is bats-core?
Bats-core is a testing framework for Bash scripts and UNIX programs that allows developers to write automated tests using a simple, Bash-native syntax. It solves the problem of verifying that command-line tools and shell scripts behave as expected by providing a structured way to define test cases and assertions. Each test is a Bash function that runs shell commands, with success or failure determined by exit codes.
Bash developers, system administrators, and DevOps engineers who write and maintain shell scripts, command-line tools, or UNIX software and need reliable automated testing.
Developers choose Bats-core because it integrates directly with Bash, requires no external dependencies beyond Bash 3.2+, and produces TAP-compliant output for easy CI/CD integration. Its straightforward syntax lowers the barrier to writing tests for shell code compared to more complex testing frameworks.
Overview
Bash Automated Testing System
Use Cases
Best For
- Writing unit tests for Bash scripts and functions
- Testing command-line interfaces (CLIs) and UNIX utilities
- Integrating shell script testing into CI/CD pipelines
- Verifying behavior of system administration scripts
- Learning test-driven development (TDD) for Bash
- Creating portable test suites that run across UNIX-like systems
Not Ideal For
- Testing graphical user interfaces (GUIs) or web applications
- Projects requiring advanced mocking, fixtures, or complex assertion libraries out of the box
- Teams developing primarily on Windows without UNIX-like emulation (e.g., WSL)
Pros & Cons
Pros
Produces Test Anything Protocol output for easy integration with CI/CD pipelines and other testing tools, as explicitly stated in the key features.
Tests are defined as Bash functions using standard shell commands as assertions, making it accessible for developers familiar with Bash without a steep learning curve.
Works with Bash 3.2 or above, ensuring it runs on a wide range of UNIX environments, including older systems, as highlighted in the README.
Requires only Bash and standard UNIX tools, reducing setup complexity and overhead for testing shell scripts, aligning with its UNIX philosophy.
Cons
Lacks advanced testing capabilities like native mocking or rich assertion libraries, forcing developers to rely on shell workarounds or external tools for complex scenarios.
Uses Bash's errexit option, which can cause tests to fail unexpectedly on any non-zero exit code, requiring careful command chaining and error suppression in test code.
Documentation is split between readthedocs and a wiki, as noted in the README, which can make it harder to find comprehensive, up-to-date information.
Frequently Asked Questions
Related Projects
the-art-of-command-lineMaster the command line, in one page
shellcheckShellCheck, a static analysis tool for shell scripts
bash-guideA guide to learn bash
gdb-dashboardModular visual interface for GDB in Python
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.