Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yugokato/pytest-smoke
pytest plugin for supporting smoke testing
https://github.com/yugokato/pytest-smoke
pytest-plugin python smoke-testing
Last synced: about 1 month ago
JSON representation
pytest plugin for supporting smoke testing
- Host: GitHub
- URL: https://github.com/yugokato/pytest-smoke
- Owner: yugokato
- License: mit
- Created: 2024-11-04T23:41:16.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-14T03:23:25.000Z (about 1 month ago)
- Last Synced: 2024-11-14T04:23:11.436Z (about 1 month ago)
- Topics: pytest-plugin, python, smoke-testing
- Language: Python
- Homepage: https://pypi.org/project/pytest-smoke/
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
pytest-smoke
======================
[](https://pypi.org/project/pytest-smoke/)
[](https://pypi.org/project/pytest-smoke/)
[](https://github.com/yugokato/pytest-smoke/actions/workflows/test.yml)
[](https://results.pre-commit.ci/latest/github/yugokato/pytest-smoke/main)
[](https://docs.astral.sh/ruff/)
A small `pytest` plugin that enables a quick smoke testing against a large test suite by limiting the number of tests
from each parametrized test function to up to `N`.
## Installation
```
pip install pytest-smoke
```
## Usage
The plugin provides the following options, each accepting an optional positive number `N`:
```
$ pytest -h
Smoke testing:
--smoke=[N] Run the first N (default=1) tests from each test function
--smoke-last=[N] Run the last N (default=1) tests from each test function
--smoke-random=[N] Run N (default=1) randomly selected tests from each test function
```
If `N` is not explicitly specified, the default value 1 will be applied.
## Examples
Given you have the following test code:
```python
import pytest
def test_something1():
pass
@pytest.mark.parametrize("p", range(10))
def test_something2(p):
pass
@pytest.mark.parametrize("p", range(20))
def test_something3(p):
pass
```
You can run smoke tests with either the `--smoke`, `--smoke-last`, or `--smoke-random` option:
### 1. `--smoke` option
- Run only the first test from each test function
```
$ pytest -v --smoke
======================== test session starts =========================
collected 31 items / 28 deselected / 3 selected
tests/test_something.py::test_something1 PASSED [ 33%]
tests/test_something.py::test_something2[0] PASSED [ 66%]
tests/test_something.py::test_something3[0] PASSED [100%]
========================= 3 passed in 0.02s ==========================
```
- Run up to 3 tests from each test function (`N`=3)
```
$ pytest -v --smoke 3
======================== test session starts =========================
collected 31 items / 24 deselected / 7 selected
tests/test_something.py::test_something1 PASSED [ 14%]
tests/test_something.py::test_something2[0] PASSED [ 28%]
tests/test_something.py::test_something2[1] PASSED [ 42%]
tests/test_something.py::test_something2[2] PASSED [ 57%]
tests/test_something.py::test_something3[0] PASSED [ 71%]
tests/test_something.py::test_something3[1] PASSED [ 85%]
tests/test_something.py::test_something3[2] PASSED [100%]
========================= 7 passed in 0.02s ==========================
```
### 2. `--smoke-last` option
- Run only the last test from each test function
```
$ pytest -v --smoke-last
======================== test session starts =========================
collected 31 items / 28 deselected / 3 selected
tests/test_something.py::test_something1 PASSED [ 33%]
tests/test_something.py::test_something2[9] PASSED [ 66%]
tests/test_something.py::test_something3[19] PASSED [100%]
========================= 3 passed in 0.02s ==========================
```
- Run up to the last 3 tests from each test function (`N`=3)
```
$ pytest -v --smoke-last 3
======================== test session starts =========================
collected 31 items / 24 deselected / 7 selected
tests/test_something.py::test_something1 PASSED [ 14%]
tests/test_something.py::test_something2[7] PASSED [ 28%]
tests/test_something.py::test_something2[8] PASSED [ 42%]
tests/test_something.py::test_something2[9] PASSED [ 57%]
tests/test_something.py::test_something3[17] PASSED [ 71%]
tests/test_something.py::test_something3[18] PASSED [ 85%]
tests/test_something.py::test_something3[19] PASSED [100%]
========================= 7 passed in 0.02s ==========================
```
### 3. `--smoke-random` option
- Run randomly selected one test from each test function
```
$ pytest -v --smoke-random
======================== test session starts =========================
collected 31 items / 28 deselected / 3 selected
tests/test_something.py::test_something1 PASSED [ 33%]
tests/test_something.py::test_something2[4] PASSED [ 66%]
tests/test_something.py::test_something3[8] PASSED [100%]
========================= 3 passed in 0.02s ==========================
```
- Run up to 3 randomly selected tests from each test function (`N`=3)
```
$ pytest -v --smoke-random 3
======================== test session starts =========================
collected 31 items / 24 deselected / 7 selected
tests/test_something.py::test_something1 PASSED [ 14%]
tests/test_something.py::test_something2[1] PASSED [ 28%]
tests/test_something.py::test_something2[3] PASSED [ 42%]
tests/test_something.py::test_something2[8] PASSED [ 57%]
tests/test_something.py::test_something3[2] PASSED [ 71%]
tests/test_something.py::test_something3[4] PASSED [ 85%]
tests/test_something.py::test_something3[14] PASSED [100%]
========================= 7 passed in 0.02s ==========================
```