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.

pip install pytest-testrail

Add a marker to the tests that will be picked up to be added to the run.

    from pytest_testrail.plugin import testrail

    @testrail('C1234', 'C5678')
    def test_foo():
        # test code goes here

    # OR	

    from pytest_testrail.plugin import pytestrail

    @pytestrail.case('C1234', 'C5678')
    def test_bar():
        # test code goes here

Or if you want to add defects to testcase result:

    from pytest_testrail.plugin import pytestrail

    @pytestrail.defect('PF-524', 'BR-543')
    def test_bar():
        # test code goes here

• Settings file template config:

    [API]
    url = https://yoururl.testrail.net/
    email = [email protected]
    password = <api_key>

    [TESTRUN]
    assignedto_id = 1
    project_id = 2
    suite_id = 3
    plan_id = 4
    description = 'This is an example description'

    [TESTCASE]
    custom_comment = 'This is a custom comment'

Or

• Set command line options (see below)

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

TestRun will be created automatically

    py.test --testrail --tr-testrun-suite-id=XXXX

TestRun will be created automatically with testrun-name

    py.test --testrail --tr-testrun-name='TestRunName' --tr-testrun-suite-id=XXXX

TestPlan will be created automatically with testplan-name, TestRun will be added automatically

    py.test --testrail --tr-testplan-name='NameTestPlan' --tr-testrun-suite-id=XXXX

TestRun in TestPlan will be created automatically

    py.test --testrail --tr-plan-id=XXXXXX --tr-testrun-suite-id=XXXX

Update TestRun (XXXXXX) in TestPlan (ZZZZZ)

    py.test --testrail --tr-plan-id=ZZZZZZ --tr-plan-id=XXXXXX --tr-testrun-suite-id=XXXX