newman-reporter-slacknotification

Custom Newman reporter to send message to Slack

Before you get started

• Install Newman $ npm run i -g newman
• Create a Slack incoming webhook url or
• Create a Slack bot to send to channel or user dynamically

Installation

npm i -g newman-reporter-slacknotification

Usage

 newman run <collectionFile> -e <environmentFile> --suppress-exit-code -r slacknotification --reporter-slacknotification-webhookurl '<webhookurl>'

Usage with channel override bot

 newman run <collectionFile> -e <environmentFile> --suppress-exit-code -r slacknotification --reporter-slacknotification-webhookurl '<https://slack.com/api/chat.postMessage>' --reporter-slacknotification-token '<bearer token>' --reporter-slacknotification-channel '<channel or userid>'

Reporter Options Optionals

 --reporter-slacknotification-messageSize '<messageSize>' e.g 150
 --reporter-slacknotification-token '<bearer token>' e.g xoxb-XXXXXXXXXXXX-TTTTTTTTTTTTTT
 --reporter-slacknotification-channel '<channel>' e.g #general
 --reporter-slacknotification-failuresChannel '<channel>' e.g. #alerts
 --reporter-slacknotification-collection '<collectionName> e.g test.json
 --reporter-slacknotification-environment '<environmentName> e.g env.json
 --reporter-slacknotification-reportingurl '<URL> e.g https://127.0.1/index.html
 --reporter-slacknotification-limitFailures '<limitFailures>; e.g 5
 --reporter-slacknotification-authorName '<authorName>; e.g "Newman Test"
 --reporter-slacknotification-onlyFailure   true|false
 --reporter-slacknotification-overFailures  failure threshold e.g 10
 --reporter-slacknotification-allExecutions true|false

Reporter Options

webhookurl Webhook URL to point to the slack api where results are published

collection Option to add the name of collection file onto the message

environment Option to add the name of environment file onto the message

messageSize Option to change the message size, defaulted to 100

token Option to use bearer token for slack bots for channel override

channel Option to select channel or user receive the result

onlyFailure Option to send failure report only. Default: false

overFailures Option to send failure report if number of failures over. Default: 0 To use the option, you need set onlyFailure = true

allExecutions To use the option, you need set allExecutions = true

limitFailures Option to limit the amount failures shown in slack

authorName Option to define a custom author name for Slack's message. If not provided, “Newman Test” will be used.