https://github.com/and-semakin/flake8-pytestrail
Flake8 plugin to check for missing or wrong TestRail test identifiers
https://github.com/and-semakin/flake8-pytestrail
Last synced: 25 days ago
JSON representation
Flake8 plugin to check for missing or wrong TestRail test identifiers
- Host: GitHub
- URL: https://github.com/and-semakin/flake8-pytestrail
- Owner: and-semakin
- License: mit
- Created: 2020-03-30T06:23:33.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-01-04T12:11:04.000Z (over 3 years ago)
- Last Synced: 2025-04-04T06:18:07.726Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 37.1 KB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-flake8-extensions - flake8-pytestrail - Checks TestRail test case IDs. (Testing)
README
# flake8-pytestrail
[](https://travis-ci.com/and-semakin/flake8-pytestrail)
[](https://pypi.org/project/flake8-pytestrail/)
[](https://pypi.org/project/flake8-pytestrail/)
[](https://pypi.org/project/flake8-pytestrail/)
A companion Flake8 plugin for [pytest-testrail](https://github.com/allankp/pytest-testrail) package.
## Installation
```
pip install flake8-pytestrail
```
or if you use [poetry](https://python-poetry.org/):
```
poetry add --dev flake8-pytestrail
```
## Usage
> ⚠️ At the moment plugin assumes that you use
> default `pytest` configuration (test files
> are all can be matched by `**/test_*.py` glob).
> It also assumes that you want all test cases to have
> been registered inside of TestRail and have ID.
```
flake8 .
```
## Error list
* TR001 Missing `@pytestrail.case()` decorator
* TR002 Multiple `@pytestrail.case()` decorators
* TR003 Test case ID should match `"^C\d+$"` pattern
## Configuration
There is no way to configure the plugin at the moment.