newman-reporter-testrail

Improved TestRail reporter for Newman with test cases filtering capability, based on the original https://github.com/billylam/newman-reporter-testrail.

Installation

npm install git+https://github.com/nagornyi/newman-reporter-testrail.git -g

Usage

Prefix request name or all test assertions you wish to map with the test number.

Option A: include test case in Postman request name:

"C226750 C226746 Reqest to test user authentication"

Option B: Map one to an assertion.

pm.test("C226750 C226746 Status code is 200", function () {
    pm.response.to.have.status(200);
});

Export the following environment variables.

• TESTRAIL_DOMAIN TestRail domain. Do not include protocol.
• TESTRAIL_USERNAME TestRail username / email.
• TESTRAIL_APIKEY TestRail API key.
• TESTRAIL_PROJECTID TestRail project id.
• TESTRAIL_SUITEID (optional) TestRail suite id. Mandatory in multi-suite projects. Do not use in single-suite projects.
• TESTRAIL_TITLE (optional) Title of test run to create.
• TESTRAIL_TYPE (optional) Type of test cases to add to the test run.
• TESTRAIL_CUSTOM (optional) Filter test cases to add to the test run by custom attribute.
• TESTRAIL_CLOSE_RUN (optional) Close run after importing test results to TestRail . Case sensitive, supported values are 'true' or 'false'.
• TESTRAIL_RUNID (optional) Update specific run with automated test results. Can be used in case test run contains manual and automated tests.

You can use direnv to easily maintain directory-specific options.

You may also set some or all of these variables using bash exports.

Run newman with the reporter option

-r testrail

Example:

TESTRAIL_DOMAIN="mycompany.testrail.net"
TESTRAIL_USERNAME="[email protected]"
TESTRAIL_APIKEY="myapikey"
TESTRAIL_PROJECTID="1"
TESTRAIL_TITLE="Dev-API Regression"
TESTRAIL_TYPE="Automated"
TESTRAIL_CLOSE_RUN="true"
TESTRAIL_RUNID="123"
TESTRAIL_CUSTOM="custom_automation: 50"
newman run my-collection.postman_collection.json -r testrail,cli --bail