This tutorial explains how to add text comments to automated test results using the TestRail Command Line Interface (TRCLI). The process integrates seamlessly with JUnit-style XML reports and TestRail JUnit extensions, providing a robust method to enhance test documentation.
The tutorial begins with a JUnit and Selenium project using the specification-first approach, where test cases are documented in TestRail before automation. TestRail JUnit extensions are incorporated into the pom.xml file, enabling the use of annotations to map automated tests to documented test cases in TestRail without duplication.
To include comments, the tutorial introduces the TestRail Test Reporter class. A custom reporter object is created, and the setProperty() method is used to assign the TestRail_result_comment property, which contains the desired comment text. For instance, a comment like “sample comment for test case C101” can be attached to a specific test case.
After executing the tests with Maven, the TRCLI is used to upload results and comments to TestRail. The command includes configuration settings from a YAML file, such as the TestRail instance URL, project name, and authentication credentials. The -Y option automates entity creation, ideal for CI/CD pipelines.
Once uploaded, comments are visible in TestRail under individual test cases within the test run summary. This capability allows teams to document additional context or observations directly within their test results, enhancing traceability and collaboration.
By combining JUnit extensions and TRCLI, this method streamlines test result management, ensuring rich and actionable insights for QA teams using TestRail.
The tutorial begins with a JUnit and Selenium project using the specification-first approach, where test cases are documented in TestRail before automation. TestRail JUnit extensions are incorporated into the pom.xml file, enabling the use of annotations to map automated tests to documented test cases in TestRail without duplication.
To include comments, the tutorial introduces the TestRail Test Reporter class. A custom reporter object is created, and the setProperty() method is used to assign the TestRail_result_comment property, which contains the desired comment text. For instance, a comment like “sample comment for test case C101” can be attached to a specific test case.
After executing the tests with Maven, the TRCLI is used to upload results and comments to TestRail. The command includes configuration settings from a YAML file, such as the TestRail instance URL, project name, and authentication credentials. The -Y option automates entity creation, ideal for CI/CD pipelines.
Once uploaded, comments are visible in TestRail under individual test cases within the test run summary. This capability allows teams to document additional context or observations directly within their test results, enhancing traceability and collaboration.
By combining JUnit extensions and TRCLI, this method streamlines test result management, ensuring rich and actionable insights for QA teams using TestRail.
