newman-reporter-dotrez-json

This project contains a custom newman reporter written for the express purpose of slimming down the JSON results of Postman/newman tests.

This project is a node application, installable through usage of the JavaScript packaging tool called npm.

Note: Lines that start with "$" are meant to be interpreted as Powershell commands. Do not paste the "$" as part of the command used in Powershell. Note: These instructions should be identical when used in a Unix terminal.

newman reporters must be installed as global npm modules. As such, you will need Node.js and npm installed in order to install this module. Recommended versions are: node.js > v6.10.3 npm > 3.10.10

Because this module is used by newman which is also a node module, you should probably install newman.

!!!Note: I've found that newer versions of newman have adjusted their API to an extent that it breaks some of the reporting functionality of this program. Specifically, I found that the URL field was changed from a string e.g. "http://nvlcmb100:10170/itemAvailailability" to an object with numerous properties e.g. {"host": "nvlcmb100", "port": 101700, . . .}.

I've found that installing a specific version of newman is the best way around these kind of issues.

Run the following command to install a supported version of newman:

$ npm install -g newman@3.8.0

Running the above command WITHOUT the '@3.8.0' fetches a version that I may or may have not tested, use at your own risk.

To install the project, open an instance of Powershell and cd into the parent directory of the project folder:

$ cd

NOTE: For clarification, don't cd into the unzipped project folder, cd into the directory that contains the project folder.

Next, install the node package globally:

$ npm install -g .\newman-reporter-dotrez-json

To verify that this module was successfully installed, run the command:

$ npm list -g --depth=0

You should see an entry that looks like: "newman-reporter-dotrez-json@1.0.0" to confirm that this module was installed. If so, the project module should now be installed and ready to use with newman!

To use this reporter when calling newman, your command should look something like:

$ newman run [-e ] [-d ] --reporters dotrez-json

Written with care by Gradey Cullins. If you have any issues please email me at [e-mail].