https://github.com/carmenmitru/wdio-slack-service
A WebdriverIO service which sends notifications of test results to Slack.
https://github.com/carmenmitru/wdio-slack-service
Last synced: about 1 month ago
JSON representation
A WebdriverIO service which sends notifications of test results to Slack.
- Host: GitHub
- URL: https://github.com/carmenmitru/wdio-slack-service
- Owner: carmenmitru
- Created: 2019-12-20T13:06:19.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-27T05:11:36.000Z (over 2 years ago)
- Last Synced: 2025-04-30T07:49:24.353Z (about 1 month ago)
- Language: JavaScript
- Size: 349 KB
- Stars: 4
- Watchers: 3
- Forks: 19
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-webdriverio - Slack - Send test results as a slack notification/message to channels. (Plugins / Services)
README
# Webdriverio Slack Service
Webdriverio library to send test results as a slack notification/message to channels
## Installation
The easiest way is to keep `wdio-slack-service` as a devDependency in your `package.json`.
```json
{
"devDependencies": {
"wdio-slack-service": "2.0.8"
}
}
```
You can simple do it by:
```bash
npm install wdio-slack-service --save-dev
```
Instructions on how to install `WebdriverIO` can be found [here.](https://webdriver.io/docs/gettingstarted.html)
## Configuration
At first, import the service to wdio config file `wdio.conf.js`
```js
// wdio.conf.js
const slack = require('wdio-slack-service');
```
In order to use the service you need to have slack webhook url to send the notification and you need to add `slack` to your `services` array
Example:
```js
// wdio.conf.js
export.config = {
// ...
services: [
[slack, {
webHookUrl: "", // Used to post notification to a particular channel
notifyOnlyOnFailure: true, // Send notification only on test failure
messageTitle: "" // Name of the notification
}]
]
```
## Features
- Send notification irrespective of test results
- Send notification only on test failure
- Support for `mocha`, `jasmine` and `cucumber`
- Retry/Rerun tests will be logged with addional info
- Test duration info
- Error details
- Cucumber scenario/step reporting
- Browser and Version info
## How it works
For `mocha`/`jasmine`, notification will be sent on spec level and for `cucumber`, it will be on feature level. Let's say, if you have 10 spec/feature files, you will receive 10 notifications as it is triggered in `after` hook
## Options
To send a notification, you should have slack webhook url. To know how to create slack webhook URL, see this [page](https://api.slack.com/messaging/webhooks)
### webHookUrl
This url is used to identity/authenticate the post message and sends it to a slack channel
Type: `String`
Optional: `NO`
Default: `NA`
### notifyOnlyOnFailure
If you want to receive slack notifications only on test failure, then set this option to `true`. Otherwise, it sends notification for all test executions irrespective of pass/fail
Type: `Boolean`
Optional: `YES`
Default: `false`
### messageTitle
Title of the notification
Type: `String`
Optional: `YES`
Default: `Webdriverio Slack Reporter`
## Screenshots
### Cucumber Pass/Fail
### Cucumber Retry
### All Pass
### Fail Pass
### Retry Failed
### Retry Passed
---
For more information on WebdriverIO see the [homepage](https://webdriver.io).