Skip to content

sungasu/mocha-testrail-reporter-custom

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

#Testrail Reporter for Mocha

npm version

Pushes test results into Testrail system.

Installation

$ npm install mocha-testrail-reporter-custom --save-dev

Usage

Ensure that your testrail installation API is enabled and generate your API keys. See http://docs.gurock.com/

Run mocha with mocha-testrail-reporter-custom:

$ mocha test --reporter mocha-testrail-reporter-custom --reporter-options reportName=<Custom>,domain=instance.testrail.net,username=test@example.com,password=12345678,projectId=1,suiteId=1

or use a mocha.options file

mocha --opts mocha-testrail.opts build/test
--recursive
--reporter mocha-testrail-reporter-custom
--reporter-options reportName=<Custom>,domain=instance.testrail.net,username=test@example.com,password=12345678,projectId=1,suiteId=1
--no-exit

Mark your mocha test names with ID of Testrail test cases. Ensure that your case ids are well distinct from test descriptions.

it("C123 C124 Authenticate with invalid user", . . .
it("Authenticate a valid user C321", . . .

Only passed or failed tests will be published. Skipped or pending tests will not be published resulting in a "Pending" status in testrail test run.

Options

domain: string domain name of your Testrail instance (e.g. for a hosted instance instance.testrail.net)

username: string user under which the test run will be created (e.g. jenkins or ci)

password: string password or API token for user

projectId: number projet number with which the tests are associated

suiteId: number suite number with which the tests are associated

assignedToId: number (optional) user id which will be assigned failed tests

reportName: string (optional) custom report title

Releasing to npm

After you have made your changes to the .ts files and commit them to the repo. You can run the following to build and release to npm. It will show an interaction area where you can determine the release type (minor/major) and so on.

$ npm run release

References

About

Custom reporter for pushing mocha results to a testrail test run

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.3%
  • JavaScript 0.7%