Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/renanivo/pytest-testdox
A TestDox format reporter for pytest
https://github.com/renanivo/pytest-testdox
bdd hacktoberfest pytest reporting test-reporting testing
Last synced: about 3 hours ago
JSON representation
A TestDox format reporter for pytest
- Host: GitHub
- URL: https://github.com/renanivo/pytest-testdox
- Owner: renanivo
- License: mit
- Created: 2016-11-04T01:40:33.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-20T23:59:20.000Z (19 days ago)
- Last Synced: 2024-10-21T03:13:57.944Z (18 days ago)
- Topics: bdd, hacktoberfest, pytest, reporting, test-reporting, testing
- Language: Python
- Homepage: https://pypi.org/project/pytest-testdox/
- Size: 172 KB
- Stars: 47
- Watchers: 4
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pytest-testdox
[](https://pypi.org/project/pytest-testdox/)
[](https://github.com/renanivo/pytest-testdox/actions?query=workflow%3A%22Continuous+Integration%22)
[](https://codecov.io/gh/renanivo/pytest-testdox)
A [TestDox format](https://en.wikipedia.org/wiki/TestDox) reporter for pytest.
## Install
```
pip install pytest-testdox
```
## Usage
Add the parameter `--testdox` when running `pytest`. For example:
```sh
pytest --testdox your-tests/
```
Tip: If you don't want to type `--testdox` every time you run `pytest`, add it
to [`addopts`](https://docs.pytest.org/en/latest/customize.html#confval-addopts)
in your [ini file](https://docs.pytest.org/en/latest/customize.html#initialization-determining-rootdir-and-inifile).
For example:
```ini
# 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:
```python
# 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:
```python
# 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:
```ini
# content of pytest.ini
# (or tox.ini or setup.cfg)
[pytest]
testdox_format = plaintext
```
```console
$ 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
```