ShellSpec: full-featured BDD unit testing framework

ShellSpec is a full-featured BDD unit testing framework for dash, bash, ksh, zsh and all POSIX shells that provides first-class features such as code coverage, mocking, parameterized test, parallel execution and more. It was developed as a dev/test tool for cross-platform shell scripts and shell script libraries. ShellSpec is a new modern testing framework released in 2019, but it's already stable enough. With lots of practical CLI features and simple yet powerful syntax, it provides you with a fun shell script test environment.

<br> <br> <br>

Version 0.28.0 has a lot of enhancements in the CLI. It is basically compatible, but there are some changes that you need to be aware of. See Migration Guide to Version 0.28.0 for details.

Thank you for your interest in ShellSpec. Please visit 🚩the official website to know the impressive features!

Let's have fun testing your shell scripts! (Try Online Demo on your browser).

Latest Update.

See CHANGELOG.md

NOTE: This documentation contains unreleased features. Check them in the changelog.

Table of Contents <!-- omit in toc -->

• Supported shells and platforms
• Requirements
• Installation
  • Web installer (for developers)
  • Package manager
  • Manual installation
  • Distribution archive (runtime only)
• Tutorial
• ShellSpec CLI
  • runs specfile using /bin/sh by default
  • command options
• Project directory
  • Typical directory structure
  • Options file
  • .shellspec - project options file
  • .shellspec-local - user custom options file
  • .shellspec-basedir - specfile execution base directory
  • .shellspec-quick.log - quick execution log
  • report/ - report file directory
  • coverage/ - coverage reports directory
  • spec/ - (default) specfiles directory
  • <HELPERDIR> (default: spec/)
    • spec_helper.sh - (default) helper file for specfile
    • banner[.md] - banner file displayed at test execution
    • support/ - directory for support files
      • bin - directory for support commands
• Specfile (test file)
  • Example
  • About DSL
  • Execution directory
  • Embedded shell scripts
  • Translation process
  • Syntax formatter (altshfmt)
• DSL syntax
  • Basic structure
    • Describe, Context, ExampleGroup - example group block
    • It, Specify, Example - example block
    • Todo - one liner empty example
    • When - evaluation
      • call - call a shell function (without subshell)
      • run - run a command (within subshell)
        • command - runs an external command
        • script - runs a shell script
        • source - runs a script by . (dot) command
      • About executing aliases
    • The - expectation
      • Subjects
      • Modifiers
      • Matchers
      • Language chains
    • Assert - expectation for custom assertion
  • Pending, skip and focus
    • Pending - pending example
    • Skip - skip example
      • if - conditional skip
    • ['x' prefix for example group an