How do I install ZUnit on macOS?

Use Homebrew by running 'brew install zunit-zsh/zunit/zunit'. This method automatically handles the Revolver dependency, making setup straightforward.

ZUnit or BATS: which should I use for ZSH scripts?

ZUnit is better for pure ZSH projects due to its native integration, but BATS is more mature and supports Bash. If cross-shell compatibility is needed, BATS might be safer.

How to write a basic test file in ZUnit?

Start with the shebang #!/usr/bin/env zunit, then use @test 'description' { code } syntax. For example, @test 'addition' { assert 2 -eq 1+1 }.

Does ZUnit support mocking in tests?

The documentation doesn't mention built-in mocking, so you'll likely need to rely on ZSH's features or external tools for mocking dependencies in your tests.

Can I run ZUnit tests in a CI pipeline like GitHub Actions?

Yes, you can integrate ZUnit by installing it via a package manager and running the zunit command in your workflow, similar to the Travis CI setup shown in the README.

What happens if I skip the shebang in a test file?

ZUnit requires the #!/usr/bin/env zunit shebang at the top of each test file; without it, the framework won't execute the tests, so it's a strict requirement.

Open-Awesome

zunit

MITShellv0.8.2

A powerful unit testing framework for ZSH shell scripting projects.

Visit Website GitHub

226 stars26 forks0 contributors

What is zunit?

ZUnit is a unit testing framework specifically designed for ZSH (Z Shell) scripting projects. It allows developers to write structured tests for their shell scripts, ZSH plugins, and command-line tools, helping ensure code reliability and quality in ZSH environments. The framework provides a simple syntax inspired by BATS and supports any valid ZSH code within test bodies.

Target Audience

ZSH developers, shell script authors, and creators of ZSH plugins or command-line tools who need to implement testing for their projects.

Value Proposition

Developers choose ZUnit because it's the first dedicated testing framework for ZSH with a clean, familiar syntax and comprehensive documentation. It fills a gap in the ZSH ecosystem by providing professional-grade testing tools specifically tailored for shell scripting.

Overview

A powerful testing framework for ZSH projects

Use Cases

Best For

Testing ZSH plugins and themes
Writing unit tests for shell scripts
Ensuring reliability of command-line tools written in ZSH
Implementing CI/CD pipelines for ZSH projects
Learning testing practices for shell scripting
Migrating from BATS to a ZSH-native testing framework

Not Ideal For

Scripts intended to run in Bash or other shells, as ZUnit is exclusive to ZSH.
Production systems requiring high stability and mature tooling, due to ZUnit's early development stage and acknowledged bugs.
Environments with strict dependency constraints, given the requirement for Revolver and manual installation complexities.

Pros & Cons

Pros

Intuitive Test Syntax

Inspired by BATS, it uses clear @test declarations, making it easy to write and read tests for those familiar with shell testing frameworks.

Flexible Installation Options

Supports installation via package managers like Zulu, zplug, and Homebrew, catering to different ZSH environments and reducing setup friction.

Built-in Progress Feedback

Integrates Revolver to display spinners during test execution, providing real-time visual feedback that enhances the developer experience.

ZSH-Focused Design

Specifically tailored for ZSH, it fills a gap in the ecosystem by offering testing features optimized for this shell's syntax and plugins.

Cons

Early-Stage Bugs

The README explicitly warns that ZUnit is in early development with likely bugs, making it unreliable for critical or production-ready projects.

Dependency on Revolver

Requires Revolver to be installed and in the PATH, adding an extra dependency that complicates setup and maintenance.

Manual Installation Overhead

Manual installation involves cloning, building with ./build.zsh, and copying files, which is more error-prone compared to one-command solutions.

Frequently Asked Questions

Related Projects

oh-my-zsh

🙃 A delightful community-driven (with 2,500+ contributors) framework for managing your zsh configuration. Includes 300+ optional plugins (rails, git, macOS, hub, docker, homebrew, node, php, python, etc), 140+ themes to spice up your morning, and an auto-update tool that makes it easy to keep up with the latest updates from the community.

Stars189,141

Forks26,583

Last commit2 days ago

zsh-autosuggestions

Fish-like autosuggestions for zsh

Stars35,966

Forks1,934

Last commit1 year ago

zsh-syntax-highlighting

Fish shell like syntax highlighting for Zsh.

Stars22,921

Forks1,372

Last commit6 days ago

prezto

The configuration framework for Zsh

Stars14,567

Forks4,437

Last commit3 months ago

Community-curated · Updated weekly · 100% open source

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.

Submit a project Star on GitHub