ci-slack-reporter 1.0.7 → 1.0.8

package/README.md

@@ -0,0 +1,28 @@
+
+Mocha/Cypress reporter to post tests results directly to Slack
+
+Usable for CI services like [Woodpecker](https://devforth.io/blog/step-by-step-guide-to-modern-secure-ci-setup/)
+
+Read [Guide how to Setup with Woodpecker](https://devforth.io/blog/run-cypress-auto-tests-in-woodpecker-ci/) 
+
+
+
+# Example
+```
+pipeline:
+  websitesTest:
+    image: cypress/included:10.2.0
+    commands:
+      - npm install
+      - npm install ci-slack-reporter
+      - export CI_SLACK_REPORTER_ICON_URL=https://raw.githubusercontent.com/devforth/ci-slack-reporter/master/assets/patron_autotester.png
+      - export CI_SLACK_REPORTER_USERNAME="Patron Autotester"
+      - export CI_SLACK_REPORTER_VIDEO_URL=https://<bucket name>.s3.eu-central-1.amazonaws.com/output${CI_BUILD_NUMBER}.mp4
+      - export CI_SLACK_REPORTER_WEBHOOK=https://hooks.slack.com/services<your slack webhook>
+      - cypress run --reporter ci-slack-reporter --spec "cypress/e2e/$${TEST_NAME}.cy.js"
+
+```
+
+Result:
+
+![](./assets/demo.png)

package/index.js

@@ -17,6 +17,7 @@ const {
 if (!process.env.CI_SLACK_REPORTER_WEBHOOK) {
   console.error('CI_SLACK_REPORTER_WEBHOOK env variable is not set, reported will not work, please do export CI_SLACK_REPORTER_WEBHOOK=...')
 }
+const fails_only_webhook = process.env.CI_SLACK_REPORTER_FAILS_ONLY_WEBHOOK && new IncomingWebhook(process.env.CI_SLACK_REPORTER_FAILS_ONLY_WEBHOOK);
 
 const webhook = new IncomingWebhook(process.env.CI_SLACK_REPORTER_WEBHOOK);
 
@@ -31,7 +32,6 @@ class MyReporter {
     runner
       .once(EVENT_RUN_BEGIN, () => {
         out = {
-          // icon_emoji: ":robot_face:",
           attachments: [
             {
               "color": "#ff0000",
@@ -52,6 +52,14 @@ class MyReporter {
             }
           ]
         };
+        if (process.env.CI_SLACK_REPORTER_ICON_URL) {
+          out.icon_url = process.env.CI_SLACK_REPORTER_ICON_URL;
+        } else {
+          out.icon_emoji = ":robot:"
+        }
+
+        out.username = process.env.CI_SLACK_REPORTER_USERNAME || 'Autotester'
+
       })
       .on(EVENT_SUITE_BEGIN, () => {
         this.increaseIndent();
@@ -87,7 +95,7 @@ class MyReporter {
             "type": "button",
             "text": {
               "type": "plain_text",
-              "text": "Video recording",
+              "text": "Watch video",
               "emoji": true
             },
             "value": "click_me_123",
@@ -99,6 +107,12 @@ class MyReporter {
         out.attachments[0].blocks[0].text.text = `Tests finished ${stats.passes}/${stats.passes + stats.failures}`;
         out.attachments[0].color = stats.failures ? "#a30200" : "#2eb886";
         webhook.send(out)
+    	if (stats.failures) {
+	 	out.attachments[0].blocks = out.attachments[0].blocks.filter(el => {
+			return !el.text.text.startsWith(":white") 
+		 })
+		fails_only_webhook?.send(out)
+	}
       });
   }
 
@@ -115,4 +129,4 @@ class MyReporter {
   }
 }
 
-module.exports = MyReporter;
+module.exports = MyReporter;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ci-slack-reporter",
-  "version": "1.0.7",
-  "description": "",
+  "version": "1.0.8",
+  "description": "Mocha/Cypress reporter to post tests results directly to Slack",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -18,5 +18,6 @@
   "homepage": "https://github.com/devforth/ci-slack-reporter#readme",
   "dependencies": {
     "@slack/webhook": "^6.1.0"
-  }
+  },
+  "keywords": ["slack", "mocha reporter", "mocha", "cypress", "", "ci", "woodpeckerci", "docker"]
 }