Skip to content
A powerful testing framework for ZSH projects
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
tests
.gitattributes Add .gitattributes file Sep 28, 2016
.gitignore
.guardian.yml Build and run tests automatically when source files change Feb 25, 2017
.travis.yml
.zunit.yml
.zvmrc First attempt at using zvm to test multiple versions Feb 18, 2017
LICENSE
README.md
build.zsh Switch from Makefile to simple ZSH build script Feb 25, 2017
code-of-conduct.md
contributing.md
zunit.zsh-completion Update completion Jul 10, 2017

README.md

ZUnit

GitHub release Build Status Gitter

ZUnit is a powerful unit testing framework for ZSH

Installation

WARNING: Although the majority of ZUnit's functionality works as expected, it is in the early stages of development, and as such bugs are likely to be present. Please continue with caution, and report any issues you may have.

Zulu

zulu install zunit

NOTE: In versions of Zulu prior to 1.2.0, there is an additional step required after install:

cd ~/.zulu/packages/zunit
./build.zsh
zulu link zunit

Homebrew

brew install zunit-zsh/zunit/zunit

Manual

git clone https://github.com/zunit-zsh/zunit
cd ./zunit
./build.zsh
chmod u+x ./zunit
cp ./zunit /usr/local/bin

ZUnit requires Revolver to be installed, and in your $PATH. The zulu or homebrew installation methods will install this dependency for you.

Writing Tests

Test syntax

Tests in ZUnit have a simple syntax, which is inspired by the BATS framework.

#!/usr/bin/env zunit

@test 'My first test' {
	# Test contents here
}

The body of each test can contain any valid ZSH code. The zunit shebang #!/usr/bin/env zunit MUST appear at the top of each test file, or ZUnit will not run it.

Documentation

For a full breakdown of ZUnit's syntax and functionality, check out the official documentation.

Contributing

All contributions are welcome, and encouraged. Please read our contribution guidelines and code of conduct for more information.

License

Copyright (c) 2016 James Dinsdale hi@molovo.co (molovo.co)

ZUnit is licensed under The MIT License (MIT)

Team

You can’t perform that action at this time.