newman-reporter-codebeamer

JUnit reporter for Newman that provides the information about the collection run in JUnit format compatible with the xUnit Uploader Plugin for codeBeamer ALM. This needs to be used in conjunction with Newman so that it can recognize JUnit reporting options.

JUnit Reporter based on XSD specified by Publish Test Results task for Azure Pipeline | TFS 2018 | TFS 2017 | TFS 2015

Forked from newman-reporter-junitfull which separates folders in a way that is incompatible with codeBeamer.

Different from newman-reporter-junit is using executions to have full report and no aggregated report. Please use newman-reporter-junit if you want the original aggregated results.

Install

The installation should be global if newman is installed globally, local otherwise. (Replace -g from the command below with -S for a local installation)

$ npm install -g newman-reporter-codebeamer

Usage

In order to enable this reporter, specify codebeamer in Newman's -r or --reporters option.

newman run https://www.getpostman.com/collections/631643-f695cab7-6878-eb55-7943-ad88e1ccfd65-JsLv -r codebeamer --reporter-codebeamer-export './examples/full/result.xml'

Options

With Newman CLI

CLI Option	Description
--reporter-codebeamer-export <path>	Specify a path where the output XML file will be written to disk. If not specified, the file will be written to newman/ in the current working directory.

With Newman as a Library

The CLI functionality is available for programmatic use as well.

const newman = require('newman');

newman.run({
    collection: require('https://www.getpostman.com/collections/631643-f695cab7-6878-eb55-7943-ad88e1ccfd65-JsLv'), // can also provide a URL or path to a local JSON file.
    reporters: 'codebeamer',
    reporter: {
        codebeamer: {
            export: './examples/full/result.xml', // If not specified, the file will be written to `newman/` in the current working directory.
        }
    },
	iterationCount: 2
}, function (err) {
	if (err) { throw err; }
    console.log('collection run complete!');
});

Compatibility

newman-reporter-codebeamer	newman	node
v1.0.0	>= v4.0.0	>= v6.x

Troubleshooting

Reporter not found

The reporter and newman must be installed at the same level, the installation should be global if newman is installed globally, local otherwise.

Getting different JUnit output

You are most probably getting in-built reporter output used in older versions of newman, Please check the newman's compatibility section above.

If you are facing any other problem, please check the open issues or create new.

License

This software is licensed under Apache-2.0. Copyright Postdot Technologies, Inc. See the LICENSE file for more information.