README.md

newman-reporter-allure

A newman reporter for generating nice and clean report using Allure-js framework

Installation

$ npm install -g newman-reporter-allure

Usage

To generate Allure results, specify allure in Newman's -r or --reporters option.

$ newman run <Collection> -e <Environment> -r allure
$ newman run <Collection> -e <Environment> -r allure --reporter-allure-export <allure-results-out-dir>

Use the option --report-allure-collection-as-parent-suite to use the collection name as the parent suite title under the Suites view. This helps when you run multiple collections and want to aggregate them in a single report.

Metadata

You can add allure labels by passing javascript comments in the test field of postman request declaration

Id

// @allure.id=228

pm.test("Status code is 200", function () {
  pm.response.to.be.ok;
});

Label

// @allure.label.{{labelName}}={{labelValue}}

pm.test("Status code is 200", function () {
  pm.response.to.be.ok;
});

Story

// @allure.label.story=storyName

pm.test("Status code is 200", function () {
  pm.response.to.be.ok;
});

Suite

// @allure.label.suite=suiteName

pm.test("Status code is 200", function () {
  pm.response.to.be.ok;
});

Owner

// @allure.label.owner=ownerName

pm.test("Status code is 200", function () {
  pm.response.to.be.ok;
});

Tag

// @allure.label.tag=tagName

pm.test("Status code is 200", function () {
  pm.response.to.be.ok;
});

Generating and Serving Allure report

Allure results will be generated under folder "allure-results" in the root location. Use allure-commandline to serve the report locally.

$ allure serve

Generate the static report web-application folder using allure-commandline

 $ allure generate --clean

Report will be generated under folder "allure-report" in the root location.

Allure TestOps preview

Generated report can be uploaded to Allure TestOps to store and analyze your tests-results.