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.

Creating file and directory structures

pytest_shell.fs.create_files() is a helper to assemble a structure of files and directories. It is best used with the tmpdir pytest fixture so you don’t have to clean up. It is used like so:

structure = ['/a/directory',
             {'/a/directory/and/a/file.txt': {'content': 'blah'}},
             {'/a/directory/and': {'mode': 0o600}]
create_files(structure)

which should create something like this:

|
+ a
   \
    + directory
     \
      + and              # mode 600
       \
        + a
           \
            file.txt    # content equal to 'blah'

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