testcafe-reporter-html-testrail

This is the html-testrail reporter plugin for TestCafe.

preview

Install

npm install testcafe-reporter-html-testrail

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 html-testrail

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

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

Additional Configuration

For HTML Report

HTML_REPORT_PATH : set the report output folder | default: Node_modules's (in where plugin is installed) sibling folder
HTML_REPORT_NAME : set the report name | default: Report_TIMESTAMP.html (e.g.: Report_16_5_2018_14_46_46.html)
RUN_NAME : set custom test run name | default: Run_<date_time(browserName_machineName)> (e.g.:Run_16_3_2019_13_12_42(Chrome 72.0.3626 _ Mac OS X 10.14.2))

Sample Report

preview

For Testrail publish ( `NOTES: PLEASE USE OLDER VERSION 2.0.6 FOR TESTRAIL PUBLISH` )

Before using Testrail publisher, You need to set test description in specific format as per bleow.

Format:

test('<< Group Name>> | << Test Name >> | << Testrail Case_ID >> ', async t => { .... });

<< Group Name >> - It can be any like Smoke, sanity, functional.
<< Test Name >>  - Test name of that test cases
<< Testrail Case_ID >>  - case ID of testrail's test case (The testcase should be present in the given PROJECT_NAME)

Example:

test('Smoke | Verify the Login Page | C875986 ', async t=> { ... });

Assumption: Testrail should contains Project which you will set as PROJECT_NAME and All the Automation test cases should present in the Testrail(that Case_ID will you set in the test description)

Environment Variables

TESTRAIL_ENABLE : set true to enable Testrail api | default: false
TESTRAIL_HOST : https://mitesh.testrail.com/
TESTRAIL_USER : username
TESTRAIL_PASS : password or api key
PROJECT_NAME : project name
PLAN_NAME : plan name | default: TestAutomation_1
SUITE_NAME: specify the suite name (It is an optional parameter if not set and not found in the given PROJECT_NAME then it will take Master as default )

Note: If you do not specify the PLAN_NAME then plugin will create TestAutomation_1 plan name (if not exist) in the given Project

Author

Mitesh Savani (https://synacor.com)