{"id":15144505,"url":"https://github.com/peterservice-rnd/robotframework-testrail","last_synced_at":"2025-09-29T13:31:12.913Z","repository":{"id":57462439,"uuid":"135996857","full_name":"peterservice-rnd/robotframework-testrail","owner":"peterservice-rnd","description":"Robot Framework library, listener and pre-run modifier for working with TestRail","archived":true,"fork":false,"pushed_at":"2019-10-10T05:42:01.000Z","size":77,"stargazers_count":16,"open_issues_count":9,"forks_count":29,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-12-13T13:17:58.907Z","etag":null,"topics":["library","listener","prerunmodifier","python","robot-framework","robotframework","testrail"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/peterservice-rnd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-04T08:48:08.000Z","updated_at":"2023-12-07T07:49:03.000Z","dependencies_parsed_at":"2022-09-18T18:16:03.756Z","dependency_job_id":null,"html_url":"https://github.com/peterservice-rnd/robotframework-testrail","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterservice-rnd%2Frobotframework-testrail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterservice-rnd%2Frobotframework-testrail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterservice-rnd%2Frobotframework-testrail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterservice-rnd%2Frobotframework-testrail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peterservice-rnd","download_url":"https://codeload.github.com/peterservice-rnd/robotframework-testrail/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234624036,"owners_count":18862271,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["library","listener","prerunmodifier","python","robot-framework","robotframework","testrail"],"created_at":"2024-09-26T10:41:49.513Z","updated_at":"2025-09-29T13:31:12.508Z","avatar_url":"https://github.com/peterservice-rnd.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RobotFramework Testrail\n\n[![Build Status](https://travis-ci.org/peterservice-rnd/robotframework-testrail.svg?branch=master)](https://travis-ci.org/peterservice-rnd/robotframework-testrail)\n\nShort Description\n---\n\n[Robot Framework](http://www.robotframework.org) library, listener and pre-run modifier for working with TestRail.\n\nInstallation\n---\n\n```\npip install robotframework-testrail\n```\n\nDocumentation\n---\n\nSee documentation on [GitHub](https://github.com/peterservice-rnd/robotframework-testrail/tree/master/docs).\n\nUsage\n---\n\n[How to enable TestRail API](http://docs.gurock.com/testrail-api2/introduction)\n\n### TestRail API Client\n\nLibrary for working with [TestRail](http://www.gurock.com/testrail/).\n\n#### Example\n\n```robot\n*** Settings ***\nLibrary    TestRailAPIClient    host    user    password    run_id\n\n*** Test Cases ***\nCase\n    ${project}=    Get Project    project_id\n    ${section}=    Add Section    project_id=${project['id']    name=New Section\n    ${case}=       Add Case    ${section['id']}    Title    Steps    Description    Refs    type_id    priority_id\n    Update Case    ${case['id']}    request_fields\n```\n\n### TestRail Listener\n\nFixing of testing results and updating test cases.\n\n#### Example\n\n1. Create custom field \"case_description\" with type \"text\", which corresponds to the Robot Framework's test case documentation.\n\n2. Create Robot test:\n\n    ```robot\n    *** Test Cases ***\n    Autotest name\n        [Documentation]    Autotest documentation\n        [Tags]    testrailid=10    defects=BUG-1, BUG-2    references=REF-3, REF-4\n        Fail    Test fail message\n    ```\n\n3. Run Robot Framework with listener:\n\n    ```\n    pybot --listener TestRailListener.py:testrail_server_name:tester_user_name:tester_user_password:run_id:https:update  robot_suite.robot\n    ```\n\n    Test with case_id=10 will be marked as failed in TestRail with message \"Test fail message\" and defects \"BUG-1, BUG-2\".\n    \n    Also title, description and references of this test will be updated in TestRail. Parameter \"update\" is optional.\n\n### TestRail Pre-run Modifier\n\nPre-run modifier for starting test cases from a certain test run.\n\n#### Example\n\n1. Create Robot test:\n    ```robot\n    *** Test Cases ***\n        Autotest name 1\n        [Documentation]    Autotest 1 documentation\n        [Tags]    testrailid=10\n        Fail    Test fail message\n        Autotest name 2\n        [Documentation]    Autotest 2 documentation\n        [Tags]    testrailid=11\n        Fail    Test fail message\n    ```\n\n2. Run Robot Framework with pre-run modifier:\n\n    ```\n    pybot --prerunmodifier TestRailPreRunModifier:testrail_server_name:tester_user_name:tester_user_password:run_id:http:results_depth robot_suite.robot\n    ```\n\n    Only test cases that are included in the test run _run_id_ will be executed.\n\n3. To execute tests from TestRail test run only with a certain status, for example \"failed\" and \"blocked\":\n\n    ```\n    pybot --prerunmodifier TestRailPreRunModifier:testrail_server_name:tester_user_name:tester_user_password:run_ind:http:results_depth:failed:blocked robot_suite.robot\n    ```\n\nLicense\n---\n\nApache License 2.0","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeterservice-rnd%2Frobotframework-testrail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeterservice-rnd%2Frobotframework-testrail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeterservice-rnd%2Frobotframework-testrail/lists"}