rsttst 0.1.0

rsttst makes your reStructuredText testable

rsttst makes your reStructuredText documentation testable.

In fact, this README file is testable and is used to test rsttst.

Below is an example:

2 + 2 = 4

The title “2 + 2 = 4” becomes the test name after being converted to a Python friendly identifier (ie. 2_plus_2_equals_4).

The bash code in the below code block will be run…

echo '2 + 2' | bc

…and the resulting stdout will be compared to the following code block:

4

The test fails if stdout doesn’t match the block above.

Generating tests

Under the hood rsttst generates Python code which is executable with py.test. Here’s how we generate the Python test code:

rsttst README.rst
cat test_readme.py | head -n 14

The resulting test code looks like the following:

# -*- coding: utf-8 -*-
import subprocess

def run(cmd):
    return subprocess.check_output(cmd, shell=True).decode('utf-8')

def test_2_plus_2_equals_4():
    output = run(u"""echo '2 + 2' | bc""")
    assert output == u"""4
"""

def test_generating_tests():
    output = run(u"""rsttst README.rst
cat test_readme.py | head -n 14""")

Running the tests

py.test -k 'not test_running_the_tests' | grep -v seconds | grep -v platform

Note: we had to exclude ‘test_running_the_tests’, otherwise it’s turtles all the way down.

============================= test session starts ==============================
collected 3 items

test_readme.py ..

============= 1 tests deselected by '-knot test_running_the_tests' =============

Functionality

Right now rsttst only supports bash testing.

FAQ

Why does pytest throw an “IndexError: list index out of range” exception for my JSON tests? Please upgrade to the latest version of pytest