Skip to main content

Robot Framework library, listener and pre-run modifier for working with TestRail

Project description

RobotFramework Testrail

Build Status

Short Description

Robot Framework library, listener and pre-run modifier for working with TestRail.

Installation

pip install robotframework-testrail

Documentation

See documentation on GitHub.

Usage

How to enable TestRail API

TestRail API Client

Library for working with TestRail.

Example

*** Settings ***
Library    TestRailAPIClient    host    user    password    run_id

*** Test Cases ***
Case
    ${project}=    Get Project    project_id
    ${section}=    Add Section    project_id=${project['id']    name=New Section
    ${case}=       Add Case    ${section['id']}    Title    Steps    Description    Refs    type_id    priority_id
    Update Case    ${case['id']}    request_fields

TestRail Listener

Fixing of testing results and updating test cases.

Example

  1. Create custom field "case_description" with type "text", which corresponds to the Robot Framework's test case documentation.

  2. Create Robot test:

    *** Test Cases ***
    Autotest name
        [Documentation]    Autotest documentation
        [Tags]    testrailid=10    defects=BUG-1, BUG-2    references=REF-3, REF-4
        Fail    Test fail message
    
  3. Run Robot Framework with listener:

    pybot --listener TestRailListener.py:testrail_server_name:tester_user_name:tester_user_password:run_id:https:update  robot_suite.robot
    

    Test with case_id=10 will be marked as failed in TestRail with message "Test fail message" and defects "BUG-1, BUG-2".

    Also title, description and references of this test will be updated in TestRail. Parameter "update" is optional.

TestRail Pre-run Modifier

Pre-run modifier for starting test cases from a certain test run.

Example

  1. Create Robot test:

    *** Test Cases ***
        Autotest name 1
        [Documentation]    Autotest 1 documentation
        [Tags]    testrailid=10
        Fail    Test fail message
        Autotest name 2
        [Documentation]    Autotest 2 documentation
        [Tags]    testrailid=11
        Fail    Test fail message
    
  2. Run Robot Framework with pre-run modifier:

    pybot --prerunmodifier TestRailPreRunModifier:testrail_server_name:tester_user_name:tester_user_password:run_id:http:results_depth robot_suite.robot
    

    Only test cases that are included in the test run run_id will be executed.

  3. To execute tests from TestRail test run only with a certain status, for example "failed" and "blocked":

    pybot --prerunmodifier TestRailPreRunModifier:testrail_server_name:tester_user_name:tester_user_password:run_ind:http:results_depth:failed:blocked robot_suite.robot
    

License

Apache License 2.0

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

robotframework-testrail-2.0.1.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

robotframework_testrail-2.0.1-py2.py3-none-any.whl (16.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file robotframework-testrail-2.0.1.tar.gz.

File metadata

  • Download URL: robotframework-testrail-2.0.1.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.8

File hashes

Hashes for robotframework-testrail-2.0.1.tar.gz
Algorithm Hash digest
SHA256 8ac49742eceb0c1d787ebf7984090ccd72bbe28c8f08a615fb4640f3d43d2c95
MD5 e8947d8e00b2973a30836d147dbf2148
BLAKE2b-256 01e8a317619d45a00ff9e586e9af8acb824b787f138b707c745b50e92c413910

See more details on using hashes here.

File details

Details for the file robotframework_testrail-2.0.1-py2.py3-none-any.whl.

File metadata

  • Download URL: robotframework_testrail-2.0.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.8

File hashes

Hashes for robotframework_testrail-2.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 283debcc6c6ee7ae3cbbb880ad88fff3f98adde9ac6d3c29becef1f94aac9119
MD5 b22cec767493521e27d98a70e7cda48f
BLAKE2b-256 e29692877d4440b3768bd150ea80e1fbc646e4aa04c5b439a8610d06b6693f3d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page