newman-reporter-slackreporter
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-slackreporter
Usage
newman run <collectionFile> -e <environmentFile> --suppress-exit-code -r slackreporter --reporter-slackreporter-webhookurl '<webhookurl>'
Usage with channel override bot
newman run <collectionFile> -e <environmentFile> --suppress-exit-code -r slackreporter --reporter-slackreporter-webhookurl '<https://slack.com/api/chat.postMessage>' --reporter-slackreporter-token '<bearer token>' --reporter-slackreporter-chanel '<channel or userid>'
Reporter Options Optionals
--reporter-slackreporter-messageSize '<messageSize>' e.g 150
--reporter-slackreporter-token '<bearer token>' e.g xoxb-XXXXXXXXXXXX-TTTTTTTTTTTTTT
--reporter-slackreporter-channel '<channel>' e.g #general
--reporter-slackreporter-buildurl '<buildurl>' e.g ci build url
--reporter-slackreporter-failureOnly '<boolean>' e.g true
Reporter Options
webhookurl Webhook URL to point to the slack api where results are published,If you have multiple channels, you must use the '#' to separate. eg:https://hooks.slack.com/services/TXXX#https://hooks.slack.com/services/NNN
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
buildurl The circle ci build url, you can invoke the variable ${CIRCLE_BUILD_URL}
failureOnly Option to only send Slack message if failures occur. Default to false