Skip to content

Latest commit

 

History

History
126 lines (85 loc) · 3.27 KB

README.rst

File metadata and controls

126 lines (85 loc) · 3.27 KB
Raw

CircleCI version

pyversions license

Author: Pahaz Blinov

Repo: https://github.com/pahaz/bashtest/

BashTest is a UNIX command-line tool for the testing bash/shell utilites.

This is a simplest way to write simple bash tests.

requirements: Python2 or Python3

keywords: bash unittest, unittesting, bash tesing, sh unit testing

Installation

bashtest is on PyPI, so simply run:

pip install bashtest

or

easy_install bashtest

to have it installed in your environment.

For installing from source, clone the repo and run:

python setup.py install

If you don`t have pip you can install it

Typical use case

You have a command line util or bash/sh script and you want to test it.

For example, we want to test ls util.

All of we need is to create text file with execution log.

./test_ls.bashtest

$ ls ./testsuit/list-directory
file1
file2.txt
file3.py
file4.sh

Run this tests

$ bashtest test_ls.bashtest
1 items passed all tests:
   1 tests in test_ls.bashtest
1 tests in 1 items.
1 passed and 0 failed.
Test passed.

Test README examples

You have a some open source project like this. And of course, as in any good open source project, you have examples. You can automatically check this examples. Just add bashtest README.rst in your CI tests.

More examples

You can finde some examples in this project. Please check test_*.bashtest files

changelog

** 0.0.8 **
  • add #skipbashtest support
** 0.0.7 **
  • fix! remove ugly and useless options
  • feat! Test README.rst #4
  • feat! find *.bashtest by default #3
** 0.0.6 **
  • fix! bad command escaping bug #5

HELP

$ bashtest --help
usage: bashtest [-h] [--exitcode] [-v] [-q] [--debug] [--version]
                [file [file ...]]

BashTest is a UNIX command-line tool for running text-based bash tests.

positional arguments:
  file           Input file (by default uses *.bashtest)

optional arguments:
  -h, --help     show this help message and exit
  --exitcode     Print exitcode after command end of output
  -v, --verbose  Verbose output mode
  -q, --quiet    Silent output mode
  --debug        Print the debug information
  --version      Print the version string