A newman reporter for generating nice and clean report using Allure framework
- Learn more about Allure Report at https://allurereport.org
- 📚 Documentation – discover official documentation for Allure Report
- ❓ Questions and Support – get help from the team and community
- 📢 Official annoucements – be in touch with the latest updates
- 💬 General Discussion – engage in casual conversations, share insights and ideas with the community
$ npm install -g newman-reporter-allure
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-resultsDir <allure-results-out-dir>
Use the option --reporter-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.
You can add allure labels by passing javascript comments in the test field of postman request declaration
// @allure.id=228
pm.test("Status code is 200", function () {
pm.response.to.be.ok;
});
// @allure.label.{{labelName}}={{labelValue}}
pm.test("Status code is 200", function () {
pm.response.to.be.ok;
});
// @allure.label.story=storyName
pm.test("Status code is 200", function () {
pm.response.to.be.ok;
});
// @allure.label.suite=suiteName
pm.test("Status code is 200", function () {
pm.response.to.be.ok;
});
// @allure.label.owner=ownerName
pm.test("Status code is 200", function () {
pm.response.to.be.ok;
});
// @allure.label.tag=tagName
pm.test("Status code is 200", function () {
pm.response.to.be.ok;
});
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.