A testdox format reporter for pytest
Project description
pytest-testdox
A TestDox format reporter for pytest.
Install
pip install pytest-testdox
Usage
Add the parameter --testdox
when running pytest
. For example:
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.
For example:
# content of pytest.ini or tox.ini [pytest] addopts = --testdox # or if you use setup.cfg [tool: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. For 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. For 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
). For example:
# 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-3.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e69ea6ebd83e410af468c4554ab042c1148edd3d1f29980e18248099bc9e222b |
|
MD5 | dc3c0f5b47abaa0f710794025394f8ca |
|
BLAKE2-256 | 468b293e0275092a7a7f01d59058100823ae3f1dfbb18b83f8809bba06ac8d67 |