Agent to integrate Postman (based on Newman collection runner) with ReportPortal.

• More about Postman
• More about Newman
• More about ReportPortal

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-agent-js-postman

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

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

$ newman run https://postman-echo.com/status/200 \
    -r @reportportal/agent-js-postman \
    --reporter-@reportportal/agent-js-postman-debug=true \
    --reporter-@reportportal/agent-js-postman-endpoint=https://your-instance.com:8080/api/v1 \
    --reporter-@reportportal/agent-js-postman-api-key=reportportalApiKey \
    --reporter-@reportportal/agent-js-postman-launch=LAUNCH_NAME \
    --reporter-@reportportal/agent-js-postman-project=PROJECT_NAME \
    --reporter-@reportportal/agent-js-postman-description=LAUNCH_DESCRIPTION \
    --reporter-@reportportal/agent-js-postman-attributes=launchKey:launchValue;launchValueTwo \
    -x

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

const newman = require("newman");

newman.run(
    {
        collection: "./collections/newman-test_collection.json",
        reporters: "@reportportal/agent-js-postman",
        reporter: {
            "@reportportal/agent-js-postman": {
                apiKey: "reportportalApiKey",
                endpoint: "https://your-instance.com:8080/api/v1",
                launch: "LAUNCH_NAME",
                project: "PROJECT_NAME",
                description: "LAUNCH_DESCRIPTION",
                attributes: [
                    {
                        "key": "launchKey",
                        "value": "launchValue"
                    },
                    {
                        "value": "launchValue"
                    },
                ],
                mode: 'DEFAULT',
                debug: false
            }
        }
    },
    function(err) {
        if (err) {
            throw err;
        }
        console.log("collection run complete!");
    }
);

// To run several collections
// Note, this will create multiple launches that you can merge into one manually via the UI
fs.readdir('./collections_folder_path', (err, files) => {
    if (err) {
        throw err;
    }
    files.forEach((file) => {
        // setup newman.run()
    });
});

The full list of available options presented below.

• To report attributes for suite you should use collection variables.

• To report attributes for tests inside of Pre-request Script you should use the next method

pm.environment.set

pm.environment.set("rp.attributes", "keyOne:valueOne;valueTwo;keyThree:valueThree");

• Step doesn't support reporting with attributes

Both suites and tests support description. For reporting with description you should click on Edit in your collection and in the description column enter the text you need

• Step doesn't support reporting with description

status must be equal to one of the following values: passed, failed, stopped, skipped, interrupted, cancelled, info, warn.

• To finish launch/suite with status you should use collection variables

• To finish tests you should use environment variables inside of Pre-request Script

pm.environment.set("rp.status", "status");

• To finish steps with statuses you should use local variables

pm.variables.set("rp.status", "status");

It is important that the code line above has to start from the new line and you shouldn't forget about semicolon after it

For both tests or steps, this is true

You can use the following methods to report logs with different log levels:

• console.log("launch/suite/test", "message");
• console.error("launch/suite/test", "message");
• console.debug("launch/suite/test", "message");
• console.warn("launch/suite/test", "message");
• console.info("launch/suite/test", "message");

• Step doesn't support logs reporting

• To report suite with test case id you should use collection variables

• To report tests with test case id you should use environment variables inside of Pre-request Script

pm.environment.set("rp.testCaseId", "yourTestCaseId");

• To report steps with test case id you should use local variables

pm.variables.set("rp.testCaseId", "stepTestCaseId");

It is important that the code line above has to start from the new line and you shouldn't forget about semicolon after it

For both tests or steps, this is true

Licensed under the Apache 2.0 license (see the LICENSE.txt file).