Skip to content

Latest commit

 

History

History
160 lines (117 loc) · 5.62 KB

README.md

File metadata and controls

160 lines (117 loc) · 5.62 KB
Raw

newman-reporter-reportportal

Newman runtime reporter for EPAM report portal which provides information about collection run.

Install

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

$ npm install -g @reportportal/newman-reporter-reportportal

Usage

There are two ways to enable this reporter - with command line or programmatically.

With CLI

To enable this reporter you have to specify reportportal in Newman's -r or --reporters option.

$ newman run https://postman-echo.com/status/200 \
    -r @reportportal/reportportal \
    --reporter-@reportportal/reportportal-debug=true \
    --reporter-@reportportal/reportportal-endpoint=http://your-instance.com:8080/api/v1 \
    --reporter-@reportportal/reportportal-token=00000000-0000-0000-0000-000000000000 \
    --reporter-@reportportal/reportportal-launch=LAUNCH_NAME \
    --reporter-@reportportal/reportportal-project=PROJECT_NAME \
    -x

Pay attention that you must add -x or --suppress-exit-code parameter while running newman using CLI.

Programmatically

const newman = require("newman");

newman.run(
    {
        collection: "./collections/newman-test_collection.json",
        reporters: "@reportportal/reportportal",
        reporter: {
            "@reportportal/reportportal": {
                debug: true,
                endpoint: "http://your-instance.com:8080/api/v1",
                token: "00000000-0000-0000-0000-000000000000",
                launch: "LAUNCH_NAME",
                project: "PROJECT_NAME"
            }
        }
    },
    function(err) {
        if (err) {
            throw err;
        }
        console.log("collection run complete!");
    }
);

Options

Both CLI and programmatic runs support following options:

Parameter Description
token User's Report Portal toke from which you want to send requests. It can be found on the profile page of this user.
endpoint URL of your server. For example 'https://server:8080/api/v1'.
launch Name of launch at creation.
project The name of the project in which the launches will be created.
debug Determines whether newman's run should be logged in details.

Docker

This reporter can also be used inside of a docker container.

Using existing image

The docker image for this reporter is available for download from our docker hub. So, first of all you have to ensure that you have docker installed and running in your system. Otherwise, see installation guideline for you operating systems.

Step 1

Pull the newman docker image with installed reporter from docker hub:

$ docker pull reportportal/newman

Step 2

Run newman commands on the image:

$ docker run -t reportportal/newman run https://www.getpostman.com/collections/8a0c9bc08f062d12dcda \
    -r @reportportal/reportportal \
    --reporter-@reportportal/reportportal-debug=true \
    --reporter-@reportportal/reportportal-endpoint=http://your-instance.com:8080/api/v1 \
    --reporter-@reportportal/reportportal-token=00000000-0000-0000-0000-000000000000 \
    --reporter-@reportportal/reportportal-launch=LAUNCH_NAME \
    --reporter-@reportportal/reportportal-project=PROJECT_NAME \
    -x

If you want to use this reporter for a specific collection JSON file, you have to mount a directory with this file:

$ docker run -v ~/collections:/etc/newman -t reportportal/newman run "example_postman-collection.json" \
    -r @reportportal/reportportal \
    --reporter-@reportportal/reportportal-debug=true \
    --reporter-@reportportal/reportportal-endpoint=http://your-instance.com:8080/api/v1 \
    --reporter-@reportportal/reportportal-token=00000000-0000-0000-0000-000000000000 \
    --reporter-@reportportal/reportportal-launch=LAUNCH_NAME \
    --reporter-@reportportal/reportportal-project=PROJECT_NAME \
    -x

Build the docker image from this repository

Step 1:

Clone this repository:

$ git clone https://github.com/reportportal/agent-postman

Step 2:

Build the image:

$ docker build -t reportportal/newman --build-arg VERSION="full semver version".

Step 3:

Run a collection using the newman image:

$ docker run -t reportportal/newman run https://www.getpostman.com/collections/8a0c9bc08f062d12dcda \
    -r @reportportal/reportportal \
    --reporter-@reportportal/reportportal-debug=true \
    --reporter-@reportportal/reportportal-endpoint=http://your-instance.com:8080/api/v1 \
    --reporter-@reportportal/reportportal-token=00000000-0000-0000-0000-000000000000 \
    --reporter-@reportportal/reportportal-launch=LAUNCH_NAME \
    --reporter-@reportportal/reportportal-project=PROJECT_NAME \
    -x

Copyright Notice

Licensed under the Apache License v2.0

Contribution and Support

Implemented and supported by Ahold Delheize