pytest plugin for creating TestRail runs and adding results
Project description
This is a pytest plugin for creating/editing testplans or testruns based on pytest markers. The results of the collected tests will be updated against the testplan/testrun in TestRail.
Installation
pip install pytest-rail
Configuration
Config for Pytest tests
Add a marker to the tests that will be picked up to be added to the run.
from pytest_rail.plugin import testrail
@testrail('C1234', 'C5678')
def test_foo():
# test code goes here
# OR
from pytest_rail.plugin import pytestrail
@pytestrail.case('C1234', 'C5678')
def test_bar():
# test code goes here
See a more detailed example here.
Config for TestRail
Settings file template config:
[API]
url = https://yoururl.testrail.net/
email = user@email.com
password = <api_key>
[TESTRUN]
assignedto_id = 1
project_id = 2
suite_id = 3
Or
Set command line options (see below)
Usage
Basically, the following command will create a testrun in TestRail, add all marked tests to run. Once the all tests are finished they will be updated in TestRail:
py.test --testrail --tr-config=<settings file>.cfg
All available options
--testrail Create and update testruns with TestRail --tr-config=TR_CONFIG Path to the config file containing information about the TestRail server (defaults to testrail.cfg) --tr-url=TR_URL TestRail address you use to access TestRail with your web browser (config file: url in API section) --tr-email=TR_EMAIL Email for the account on the TestRail server (config file: email in API section) --tr-password=TR_PASSWORD Password for the account on the TestRail server (config file: password in API section) --tr-testrun-assignedto-id=TR_TESTRUN_ASSIGNEDTO_ID ID of the user assigned to the test run (config file: assignedto_id in TESTRUN section) --tr-testrun-project-id=TR_TESTRUN_PROJECT_ID ID of the project the test run is in (config file: project_id in TESTRUN section) --tr-testrun-suite-id=TR_TESTRUN_SUITE_ID ID of the test suite containing the test cases (config file: suite_id in TESTRUN section) --tr-testrun-suite-include-all Include all test cases in specified test suite when creating test run (config file: include_all in TESTRUN section) --tr-testrun-name=TR_TESTRUN_NAME Name given to testrun, that appears in TestRail (config file: name in TESTRUN section) --tr-run-id=TR_RUN_ID Identifier of testrun, that appears in TestRail. If provided, option "--tr-testrun-name" will be ignored --tr-plan-id=TR_PLAN_ID Identifier of testplan, that appears in TestRail. If provided, option "--tr-testrun-name" will be ignored --tr-version=TR_VERSION Indicate a version in Test Case result. --tr-no-ssl-cert-check Do not check for valid SSL certificate on TestRail host --tr-close-on-complete Close a test plan or test run on completion. --tr-dont-publish-blocked Do not publish results of "blocked" testcases in TestRail --tr-skip-missing Skip test cases that are not present in testrun
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pytest-rail-1.0.5.tar.gz
(12.0 kB
view hashes)
Built Distribution
Close
Hashes for pytest_rail-1.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 79933192ec74046fb34a6e5eaae6c9a8a4f74145c30ff1941bb8a6dc8f460aa4 |
|
MD5 | 9c81fd38716d4298d161d20511f6e822 |
|
BLAKE2b-256 | 2eee1e5e29eb4037be895991bdb4672b089f7b63eb26a84ef74fdf80caa5d424 |