Skip to main content

A plugin for testing shell scripts and line-based processes with pytest

Project description

A plugin for testing shell scripts and line-based processes with pytest.

You could use it to test shell scripts, or other commands that can be run through the shell that you want to test the usage of.

Not especially feature-complete or even well-tested, but works for what I wanted it for. If you use it please feel free to file bug reports or feature requests.


This pytest plugin was generated with Cookiecutter along with @hackebrot’s cookiecutter-pytest-plugin template.

Features

  • Easy access to a bash shell through a pytest fixture.
  • Set and check environment variables through Python code.
  • Automatically fail test on nonzero return codes by default.
  • Helpers for running shell scripts.
  • Mostly, all the great stuff pytest gives you with a few helpers to make it work for bash.

Installation

You can install “pytest-shell” via pip from PyPI:

$ pip install pytest-shell

Usage

You can use a fixture called ‘bash’ to get a shell process you can interact with.

Test a bash function:

def test_something(bash):
    assert bash.run_function('test') == 'expected output'

Set environment variables, run a .sh file and check results:

def test_something(bash):
    with bash(envvars={'SOMEDIR': '/home/blah'}) as s:
        s.run_script('dostuff.sh', ['arg1', 'arg2'])
        assert s.path_exists('/home/blah/newdir')
        assert s.file_contents('/home/blah/newdir/test.txt') == 'test text'

Run some inline script, check an environment variable was set:

def test_something(bash):
    bash.run_script_inline(['touch /tmp/blah.txt', './another_script.sh'])
    assert bash.envvars.get('AVAR') == 'success'

Use context manager to set environment variables:

def test_something(bash):
    with bash(envvars={'BLAH2': 'something'}):
        assert bash.envvars['BLAH2'] == 'something'

You can run things other than bash (ssh for example), but there aren’t specific fixtures and the communication with the process is very bash-specific.

TODO

  • Helpers for piping, streaming.
  • Fixtures and helpers for docker and ssh.
  • Support for non-bash shells.
  • Shell instance in setup for e.g. basepath.

Refactoring TODO

  • Make Connection class just handle bytes, move line-based stuff into an intermediary.
  • Make pattern stuff work line-based or on multiline streams (in a more obvious way than just crafting the right regexes).
  • Make pattern stuff work on part of line if desired, leaving the rest.

License

Distributed under the terms of the MIT license, “pytest-shell” is free and open source software

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pytest_shell-0.1.1-py3-none-any.whl (11.9 kB) Copy SHA256 hash SHA256 Wheel py3
pytest-shell-0.1.1.tar.gz (9.3 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page