Testcafe-reporter-submittable NPM

testcafe-reporter-submittable

This is Submittable's testcafe-reporter-submittable reporter plugin for TestCafe to integrate with TestRail.

npm install testcafe-reporter-submittable

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 submittable

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

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

Formatting your TestCafe test descriptions

test("<Test Type> | <Test Name> | <TestRail Test Case ID>", async t => {
  // Your test code goes here as usual.
});

Replace the following segments of the example above with your test case details:

<Test Type>: The type of test (like "smoke" or "regression").
<Test Name>: The name of your test, a description of what it does.
<TestRail Test Case ID>: The test case ID from TestRail that will link with your TestCafe test.

Configuration can be provided via:

ENV Variable	Config	Description	Default	Required
TESTRAIL_HOST	host	URL of the TestRail instance.		`true`
TESTRAIL_USER	user	Account name which will be used to push results.		`true`
TESTRAIL_PASSWORD	password	Account password.		`true`
PROJECT_NAME	projectName	Project name in which test cases are stored.		`true`
PLAN_NAME	planName	Plan name in which test cases are stored.	TestPlan	`false`
RUN_NAME	runName	Run name in which test cases are stored.	Run_ + date (browser + OS)	`false`