Mocha TestLink reporter

Reports test execution statuses to TestLink. Uses either an existing test plan or creates a new one if required.

Installation

$ npm install mocha-testlink-reporter

Command line usage

The reporter accepts the following options. They can be specified either through the command line or via the environment variables.

| Option | Environment | Required | Description | | ------ | ----------- | -------- | ----------- | | URL | TESTLINK_URL | yes | For example, http://localhost:8080 | | apiKey | TESTLINK_API_KEY | yes | The API key of a TestLink user | | prefix | TESTLINK_PREFIX | yes | The test project prefix, for example, XPJ | | buildname | TESTLINK_BUILD | no | For example, autobuild | | buildid | TESTLINK_BUILD_ID | no | For example, 2 | | testplanname | TESTLINK_PLAN | no | For example, autoplan | | testplanid | TESTLINK_PLAN_ID | no | For example, 7 |

Example invocations from the command line

$ mocha --reporter mocha-testlink-reporter --reporter-options URL=http://localhost,apiKey=1234567890,prefix=XPJ,testplanid=7,buildid=2

$ mocha --reporter mocha-testlink-reporter --reporter-options URL=http://localhost,apiKey=1234567890,prefix=XPJ,testplanname=autoplan,buildname=autobuilld

$ mocha --reporter mocha-testlink-reporter --reporter-options URL=http://localhost,apiKey=1234567890,prefix=XPJ

If there is an existing test plan in TestRail that should be updated, then either specify its name or id. Either buildid or buildname can be specified in either case.

If neither testplanid nor testplanname is specified, then a new test plan will be created with name autoplan <timestamp>. Similarly, if build information is omitted, a new one will be created with name autobuild.

Mapping the mocha tests to TestLink counterparts

Mark the mocha test or suite descriptions with ID(s) of Testrail test cases in brackets. If a mocha suite is labelled with a case ID, the test steps in TestLink will get updated with the status of tests in the mocha suite. A deeper hierarchy is not reporterd, i.e. the status of tests in sub-suites, and sub-suites themselves, are not reported.

it('[XPJ-1] a test case', ...
it('[XPJ-7] [XPJ-8] a case linked to two test cases in TestLink', ...

describe('[XPJ-2] a test case with steps', ...
  it('step 1', ...
  it('step N', ...

Current limitations

• platforms are not supported yet
• only passed and failed test statuses are being reported. Skipped and pending ones are not.

License

MIT License

Copyright (c) 2019 Admitad GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.