testcafe-reporter-testrail-simple

This is the testrail-simple reporter plugin for TestCafe.

Update v1.1.1: The reporter now supports uploading screenshots by default. ^^ Requires test result edit enabled in testrail.

This reporter needs only 3 configuration parameters TestRail host, username and password and does the required back tracing to collect information like project id, suite id etc that are required to publish the Test Run results to TestRail.

No need to rename/ append the TestRailCase ids into the test case name, just add the tag {testRailCaseId: CXXXXX} in the test meta and reporter will picks up the info.

Easy and Clean!

Did i say the reporter name is testrail-simple? Guess it should be testrail-very-simple LOL!!!

Install

npm install testcafe-reporter-testrail-simple

Configuration

• TestCases should have the TestRail case ids present in the test meta in the format {testRailCaseId: 'C12345'}

test.meta({testRailCaseId: 'C239234'})

• The reporter requires 3 environment variables to be present

TESTRAIL_HOST: https://vinay.testrail.com
TESTRAIL_USERNAME: username
TESTRAIL_APIKEY: password or api key

| ENV Variable | Default | Description | Default | Required | | ------------------------------ | ------------------ | ------------------------------------- | :----------------: | :------: | | SKIP_UPLOAD_SCREENSHOTS | false | Set this to true to Skip Uploading screenshots to TestRail | false | false |

Usage

When you run tests from the command line, specify the reporter name by using the --reporter option:

testcafe chrome 'path/to/test/file.js' --reporter testrail-simple

When you use API, pass the reporter name to the reporter() method:

testCafe
    .createRunner()
    .src('path/to/test/file.js')
    .browsers('chrome')
    .reporter('testrail-simple') // <-
    .run();

Author

vinayvennela