Slackサービス
wdio-slack-serviceはサードパーティのパッケージです。詳細についてはGitHub | npmをご覧ください。 テスト結果をSlackの通知/メッセージとしてチャンネルに送信するためのWebdriverioライブラリです
インストール
最も簡単な方法は、package.json
の中でwdio-slack-service
をdevDependencyとして保持することです。
{
"devDependencies": {
"wdio-slack-service": "2.0.8"
}
}
以下のように簡単にインストールできます:
npm install wdio-slack-service --save-dev
WebdriverIO
のインストール方法についてはこちらをご覧ください。
設定
まず、wdio設定ファイルwdio.conf.js
にサービスをインポートします
// wdio.conf.js
const slack = require('wdio-slack-service');
このサービスを使用するには、通知を送信するためのslack webhook URLが必要で、services
配列にslack
を追加する必要があります
例:
// wdio.conf.js
export.config = {
// ...
services: [
[slack, {
webHookUrl: "<SLACK_WEBHOOK_URL>", // 特定のチャンネルに通知を投稿するために使用されます
notifyOnlyOnFailure: true, // テスト失敗時のみ通知を送信
messageTitle: "<NOTIFICATION_TITLE>" // 通知の名前
}]
]
機能
- テスト結果に関係なく通知を送信
- テスト失敗時のみ通知を送信
mocha
、jasmine
、cucumber
のサポート- リトライ/再実行テストは追加情報と共に記録
- テスト実行時間情報
- エラー詳細
- Cucumberシナリオ/ステップレポート
- ブラウザとバージョン情報
動作の仕組み
mocha
/jasmine
の場合、通知はspec単位で送信され、cucumber
の場合はfeature単位で送信されます。例えば、10個のspec/featureファイルがある場合、after
フックでトリガーされるため、10個の通知が送信されます
オプション
通知を送信するには、slackのwebhook URLが必要です。slackのwebhook URLの作成方法については、このページをご覧ください
webHookUrl
このURLは、投稿メッセージを識別/認証し、slackチャンネルに送信するために使用されます
タイプ: String
省略可能: NO
デフォルト: NA
notifyOnlyOnFailure
テスト失敗時のみslack通知を受け取りたい場合は、このオプションをtrue
に設定します。そうでない場合は、合格/不合格に関係なく、すべてのテスト実行に対して通知を送信します
タイプ: Boolean
省略可能: YES
デフォルト: false
messageTitle
通知のタイトル
タイプ: String
省略可能: YES
デフォルト: Webdriverio Slack Reporter