A testdox format reporter for pytest
Project description
A TestDox format reporter for pytest
Install
pip install pytest-testdox
Usage
Add the parameter –testdox when running pytest. Ex:
pytest --testdox your-tests/
Tip: If you don’t want to type --testdox every time you run pytest, add it to addopts in your ini file. Ex:
# content of pytest.ini
# (or tox.ini or setup.cfg)
[pytest]
addopts = --testdox
When using --testdox, the plugin will disable itself when not running on a terminal. If you want the testdox report no matter what, use the parameter --force-testdox instead.
Markers
@pytest.mark.describe
Override the class name in the testdox report. Example
# test_demo.py
@pytest.mark.describe('create_file')
class TestCreateFile():
def test_creates_a_file_in_the_so(self):
pass
Will produce the output:
test_demo.py create_file [x] creates a file in the so
@pytest.mark.it
Override the test title in the testdox report. Example:
# test_demo.py
class TestCreateFile():
@pytest.mark.it('Creates a local file in the SO')
def test_creates_a_file_in_the_so(self):
pass
Will produce the output:
test_demo.py Create File [x] Creates a local file in the SO
Configuration file options
testdox_format
Specifies TestDox report format, plaintext or utf8 (default: utf8). Ex:
# content of pytest.ini
# (or tox.ini or setup.cfg)
[pytest]
testdox_format = plaintext
$ pytest test_demo.py ============================= test session starts ============================== platform darwin -- Python 3.5.0, pytest-3.0.7, py-1.4.33, pluggy-0.4.0 rootdir: /private/tmp/demo, inifile: pytest.ini plugins: testdox-dev collected 2 items test_demo.py Pytest Testdox [x] prints a BDD style output to your tests [x] lets you focus on the behavior
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pytest_testdox-1.2.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 082352573dcb5df59054ee41bdd9f6f47d3f1b6624aea6586548ba0c640cbd9d |
|
MD5 | 5566dc484f7703a0f176f768dc0c3957 |
|
BLAKE2b-256 | 970f035724e61ce11257e3529b67766f92b5a2569169769de53b2b553627a292 |