Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avidit/newman-reporter-testrail-extra
A newman reporter for testrail
https://github.com/avidit/newman-reporter-testrail-extra
newman newman-reporter postman testrail
Last synced: about 1 month ago
JSON representation
A newman reporter for testrail
- Host: GitHub
- URL: https://github.com/avidit/newman-reporter-testrail-extra
- Owner: avidit
- License: mit
- Created: 2018-08-09T16:12:13.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2024-03-13T15:18:33.000Z (8 months ago)
- Last Synced: 2024-04-14T06:11:25.628Z (7 months ago)
- Topics: newman, newman-reporter, postman, testrail
- Language: JavaScript
- Size: 29.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# newman-reporter-testrail-extra
A [newman](https://github.com/postmanlabs/newman) reporter for [testrail](http://docs.gurock.com/testrail-api2/start)
## Installation
npm install newman-reporter-testrail-extra
## Usage
### Add test case ids to assertions
Prefix test assertions with testRail case Id CXXXXXX, including the letter C. Multiple test case ids can be added.
```javascript
pm.test("C12345 C67890 Status code is 200", function() {
pm.response.to.have.status(200);
});
```
### Set the reporter options.
Reporter option can be set as environment variables or from reporter options arguments
```
export TESTRAIL_HOST='https://testrail.domain.com' # TestRail host.
export TESTRAIL_USERNAME='[email protected]' # TestRail username.
export TESTRAIL_PASSWORD='testrail_password' # TestRail password.
export TESTRAIL_API_KEY='testrail_api_key' # TestRail API key.
export TESTRAIL_PROJECT_ID='testrail_project_id' # TestRail project id.
export TESTRAIL_SUITE_ID='testrail_suite_id' # (optional) TestRail suite id. Required for multi-suite projects.
export TESTRAIL_RUN_NAME='Automation run' # (optional) Name of test run to create.
export TESTRAIL_INCLUDE_ALL=true # (optional) Boolean to determine wheter or not to include all case ids while adding run.
```
Note: Either [username and password](http://docs.gurock.com/testrail-api2/accessing#username_and_password) or [username and api key](http://docs.gurock.com/testrail-api2/accessing#username_and_api_key) can be used.
### Run newman test with the reporter option `-r testrail-extra`
newman run my-collection.postman_collection.json -r cli,testrail-extra \
--reporter-testrail-extra-host 'https://testrail.domain.com' \
--reporter-testrail-extra-username '[email protected]' \
--reporter-testrail-extra-password 'password' \
--reporter-testrail-extra-project-id 'testrail_project_id' \
--reporter-testrail-extra-suite-id 'testrail_suite_id' \
--reporter-testrail-extra-run-name 'Automation run' \
--reporter-testrail-extra-include-all