playwright-slack-report 1.0.18 → 1.0.20

package/README.md

@@ -1,4 +1,4 @@
-# playwright-slack-report ![Biulds](https://github.com/ryanrosello-og/playwright-slack-report/actions/workflows/playwright.yml/badge.svg) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ryanrosello-og/playwright-slack-report/blob/master/LICENSE) [![Coverage Status](https://coveralls.io/repos/github/ryanrosello-og/playwright-slack-report/badge.svg?branch=main)](https://coveralls.io/github/ryanrosello-og/playwright-slack-report?branch=main)
+# playwright-slack-report ![Builds](https://github.com/ryanrosello-og/playwright-slack-report/actions/workflows/playwright.yml/badge.svg) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ryanrosello-og/playwright-slack-report/blob/master/LICENSE) [![Coverage Status](https://coveralls.io/repos/github/ryanrosello-og/playwright-slack-report/badge.svg?branch=main)](https://coveralls.io/github/ryanrosello-og/playwright-slack-report?branch=main)
 
 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ryanrosello-og/playwright-slack-report)
 
@@ -16,7 +16,7 @@ Publish your Playwright test results to your favorite Slack channel(s).
 - 🧑‍🎨 Define your own custom Slack message layout!
 
 
-# 📦 Installation 
+# 📦 Installation
 
 Run following commands:
 
@@ -47,7 +47,12 @@ Run your tests by providing your` SLACK_BOT_USER_OAUTH_TOKEN` as an environment
 
 `SLACK_BOT_USER_OAUTH_TOKEN=[your Slack bot user OAUTH token] npx playwright test`
 
-# ℹ️ How do I find my Slack bot oauth token?
+> **NOTE:** The Slack channel that you specify will need to be *public*, this app will not be able to publish messages to private channels.
+
+---
+
+<details>
+<summary><b>🔎 How do I find my Slack bot oauth token?</b></summary>
 
 You will need to have Slack administrator rights to perform the steps below.
 
@@ -68,9 +73,9 @@ You will need to have Slack administrator rights to perform the steps below.
 
 ![Click the Add an OAuth Scope](https://github.com/ryanrosello-og/playwright-slack-report/blob/main/assets/2022-08-09_5-48-30.png?raw=true)
 
-* chat:write 
-* chat:write.public 
-* chat:write.customize  
+* chat:write
+* chat:write.public
+* chat:write.customize
 
 6. Scroll up to the OAuth Tokens for Your Workspace and click the **Install to Workspace** button
 
@@ -80,12 +85,16 @@ You will need to have Slack administrator rights to perform the steps below.
 
 ![click the Allow button](https://github.com/ryanrosello-og/playwright-slack-report/blob/main/assets/2022-08-09_5-49-49.png?raw=true)
 
-The final step will be to copy the generated Bot User OAuth Token aka `SLACK_BOT_USER_OAUTH_TOKEN`.  
+The final step will be to copy the generated Bot User OAuth Token aka `SLACK_BOT_USER_OAUTH_TOKEN`.
 
 >**Treat this token as a secret.**
 
 ![Final](https://github.com/ryanrosello-og/playwright-slack-report/blob/main/assets/2022-08-09_5-53-17.png?raw=true)
 
+</details>
+
+---
+
 # ⚙️ Configuration
 
 An example advanced configuration is shown below:
@@ -102,29 +111,30 @@ An example advanced configuration is shown below:
       {
         channels: ["pw-tests", "ci"], // provide one or more Slack channels
         sendResults: "always", // "always" , "on-failure", "off"
+        layout: generateCustomLayout,
+        maxNumberOfFailuresToShow: 4,
+        meta: [
+            {
+                key: 'BUILD_NUMBER',
+                value: '323332-2341',
+            },
+            {
+                key: 'WHATEVER_ENV_VARIABLE',
+                value: process.env.SOME_ENV_VARIABLE, // depending on your CI environment, this can be the branch name, build id, etc
+            },
+            {
+                key: 'HTML Results',
+                value: '<https://your-build-artifacts.my.company.dev/pw/23887/playwright-report/index.html|📊>',
+            },
+        ],
       },
-      layout: generateCustomLayout,
-      maxNumberOfFailuresToShow: 4,
-      meta: [
-        {
-          key: 'BUILD_NUMBER',
-          value: '323332-2341',
-        },
-        {
-          key: 'WHATEVER_ENV_VARIABLE',
-          value: process.env.SOME_ENV_VARIABLE, // depending on your CI environment, this can be the branch name, build id, etc
-        },
-        {
-          key: 'HTML Results',
-          value: '<https://your-build-artifacts.my.company.dev/pw/23887/playwright-report/index.html|📊>',
-        },
-      ],      
+
     ],
   ],
 ```
 
 ### **channels**
-An array of Slack channels to post to, atleast one channel is required
+An array of Slack channels to post to, at least one channel is required
 ### **sendResults**
 Can either be *"always"*, *"on-failure"* or *"off"*, this configuration is required:
   * **always** - will send the results to Slack at completion of the test run
@@ -133,6 +143,8 @@ Can either be *"always"*, *"on-failure"* or *"off"*, this configuration is requi
 ### **layout**
 A function that returns a layout object, this configuration is optional.  See section below for more details.
 * meta - an array of meta data to be sent to Slack, this configuration is optional.
+### **layoutAsync**
+Same as **layout** above, but asynchronous in that it returns a promise.
 ### **maxNumberOfFailuresToShow**
 Limits the number of failures shown in the Slack message, defaults to 10.
 
@@ -152,7 +164,7 @@ meta: [
     key: 'GITHUB_REF',
     value: process.env.GITHUB_REF,
   },
-], 
+],
 ...
 ```
 
@@ -178,7 +190,7 @@ const generateCustomLayout = (summaryResults: SummaryResults):Array<KnownBlock |
 export default generateCustomLayout;
 ```
 
-In your, `playwright.confing.ts` file, add your function into the config.
+In your, `playwright.config.ts` file, add your function into the config.
 
 ```typescript
   import { generateCustomLayout } from "./my_custom_layout";
@@ -191,9 +203,9 @@ In your, `playwright.confing.ts` file, add your function into the config.
       {
         channels: ["pw-tests", "ci"], // provide one or more Slack channels
         sendResults: "always", // "always" , "on-failure", "off"
+        layout: generateCustomLayout,
+        ...
       },
-      layout: generateCustomLayout,
-      ...   
     ],
   ],
 ```
@@ -250,7 +262,6 @@ Add the meta block in your config:
           },
         ],
       },
-      
     ],
   ],
 ```
@@ -298,6 +309,204 @@ Generates the following message in Slack:
 
 ![Final](https://github.com/ryanrosello-og/playwright-slack-report/blob/main/assets/2022-08-13_8-17-46.png?raw=true)
 
+
+**Example 3: - with screenshots and/or recorded videos**
+
+In your, `playwright.config.ts` file, add these params (Make sure you use **layoutAsync** rather than **layout**):
+
+```typescript
+  import { generateCustomLayoutAsync } from "./my_custom_layout";
+  ...
+  reporter: [
+    [
+      "./node_modules/playwright-slack-report/dist/src/SlackReporter.js",
+      {
+        ...
+        layoutAsync: generateCustomLayoutAsync,
+        ...
+      },
+    ],
+  ],
+  use: {
+    ...
+    screenshot: "only-on-failure",
+    video: "retain-on-failure",
+    ...
+  },
+```
+
+Create the function to generate the layout asynchronously in `my_custom_layout.ts`:
+
+```typescript
+import fs from "fs";
+import path from "path";
+import { Block, KnownBlock } from "@slack/types";
+import { SummaryResults } from "playwright-slack-report/dist/src";
+import { PutObjectCommand, S3Client } from "@aws-sdk/client-s3";
+
+const s3Client = new S3Client({
+  credentials: {
+    accessKeyId: process.env.S3_ACCESS_KEY || "",
+    secretAccessKey: process.env.S3_SECRET || "",
+  },
+  region: process.env.S3_REGION,
+});
+
+async function uploadFile(filePath, fileName) {
+  try {
+    const ext = path.extname(filePath);
+    const name = `${fileName}${ext}`;
+
+    await s3Client.send(
+      new PutObjectCommand({
+        Bucket: process.env.S3_BUCKET,
+        Key: name,
+        Body: fs.createReadStream(filePath),
+      })
+    );
+
+    return `https://${process.env.S3_BUCKET}.s3.${process.env.S3_REGION}.amazonaws.com/${name}`;
+  } catch (err) {
+    console.log("🔥🔥 Error", err);
+  }
+}
+
+
+export async function generateCustomLayoutAsync (summaryResults: SummaryResults): Promise<Array<KnownBlock | Block>> {
+  const { tests } = summaryResults;
+  // create your custom slack blocks
+
+  const header = {
+    type: "header",
+    text: {
+      type: "plain_text",
+      text: "🎭 *Playwright E2E Test Results*",
+      emoji: true,
+    },
+  };
+
+  const summary = {
+    type: "section",
+    text: {
+      type: "mrkdwn",
+      text: `✅ *${summaryResults.passed}* | ❌ *${summaryResults.failed}* | ⏩ *${summaryResults.skipped}*`,
+    },
+  };
+
+  const fails: Array<KnownBlock | Block> = [];
+
+  for (const t of tests) {
+    if (t.status === "failed" || t.status === "timedOut") {
+
+      fails.push({
+        type: "section",
+        text: {
+          type: "mrkdwn",
+          text: `👎 *[${t.browser}] | ${t.suiteName.replace(/\W/gi, "-")}*`,
+        },
+      });
+
+      const assets: Array<string> = [];
+
+      if (t.attachments) {
+        for (const a of t.attachments) {
+          // Upload failed tests screenshots and videos to the service of your choice
+          // In my case I upload the to S3 bucket
+          const permalink = await uploadFile(
+            a.path,
+            `${t.suiteName}--${t.name}`.replace(/\W/gi, "-").toLowerCase()
+          );
+
+          if (permalink) {
+            let icon = "";
+            if (a.name === "screenshot") {
+              icon = "📸";
+            } else if (a.name === "video") {
+              icon = "🎥";
+            }
+
+            assets.push(`${icon}  See the <${permalink}|${a.name}>`);
+          }
+        }
+      }
+
+      if (assets.length > 0) {
+        fails.push({
+          type: "context",
+          elements: [{ type: "mrkdwn", text: assets.join("\n") }],
+        });
+      }
+    }
+  }
+
+  return [header, summary, { type: "divider" }, ...fails]
+}
+
+```
+
+**Also you can upload the attachments to slack.** But it might be more expensive for you and also you'll have to extend the scope.
+
+```typescript
+...
+const web_api_1 = require('@slack/web-api');
+const slackClient = new web_api_1.WebClient(process.env.SLACK_BOT_USER_OAUTH_TOKEN);
+
+async function uploadFile(filePath) {
+  try {
+    const result = await slackClient.files.uploadV2({
+      channels: 'you_cannel_name',
+      file: fs.createReadStream(filePath),
+      filename: filePath.split('/').at(-1),
+    });
+
+    return result.file;
+  } catch (error) {
+    console.log('🔥🔥 error', error);
+  }
+}
+
+export async function generateCustomLayoutAsync (summaryResults: SummaryResults): Promise<Array<KnownBlock | Block>> {
+  const { tests } = summaryResults;
+  ....
+  // See the snippet above ^^^
+
+
+    if (t.attachments) {
+      for (const a of t.attachments) {
+        const file = await uploadFile(a.path);
+
+        if (file) {
+          if (a.name === 'screenshot' && file.permalink) {
+            fails.push({
+              alt_text: '',
+              image_url: file.permalink,
+              title: { type: 'plain_text', text: file.name || '' },
+              type: 'image',
+            });
+          }
+
+          if (a.name === 'video' && file.permalink) {
+            fails.push({
+              alt_text: '',
+              // NOTE:
+              // Slack requires thumbnail_url length to be more that 0
+              // Either set screenshot url as the thumbnail or add a placeholder image url
+              thumbnail_url: '',
+              title: { type: 'plain_text', text: file.name || '' },
+              type: 'video',
+              video_url: file.permalink,
+            });
+          }
+        }
+      }
+    }
+  ....
+
+  return [header, summary, { type: "divider" }, ...fails]
+}
+
+```
+
 # 🔑 License
 
 [MIT](https://github.com/ryanrosello-og/playwright-slack-report/blob/main/LICENSE)
@@ -314,7 +523,7 @@ Run the tests using `npm run pw`
 Run `npm pack`
 
 Create a new playwright project using `yarn create playwright`
-Modify the `package.json` and a local dependancy to the generated `tgz` file 
+Modify the `package.json` and a local dependancy to the generated `tgz` file
 
 e.g.
 

package/dist/src/LayoutGenerator.d.ts

@@ -1,4 +1,4 @@
-import { KnownBlock, Block } from '@slack/types';
-import { SummaryResults } from '.';
-declare const generateBlocks: (summaryResults: SummaryResults, maxNumberOfFailures: number) => Promise<Array<KnownBlock | Block>>;
-export default generateBlocks;
+import { KnownBlock, Block } from '@slack/types';
+import { SummaryResults } from '.';
+declare const generateBlocks: (summaryResults: SummaryResults, maxNumberOfFailures: number) => Promise<Array<KnownBlock | Block>>;
+export default generateBlocks;

package/dist/src/LayoutGenerator.js

@@ -1,69 +1,69 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const generateBlocks = async (summaryResults, maxNumberOfFailures) => {
-    const maxNumberOfFailureLength = 650;
-    const fails = [];
-    const meta = [];
-    const header = {
-        type: 'section',
-        text: {
-            type: 'mrkdwn',
-            text: '🎭 *Playwright Results*',
-        },
-    };
-    const summary = {
-        type: 'section',
-        text: {
-            type: 'mrkdwn',
-            text: `✅ *${summaryResults.passed}* | ❌ *${summaryResults.failed}* | ⏩ *${summaryResults.skipped}*`,
-        },
-    };
-    for (let i = 0; i < summaryResults.failures.length; i += 1) {
-        const { failureReason, test } = summaryResults.failures[i];
-        const formattedFailure = failureReason
-            .substring(0, maxNumberOfFailureLength)
-            .split('\n')
-            .map((l) => `>${l}`)
-            .join('\n');
-        fails.push({
-            type: 'section',
-            text: {
-                type: 'mrkdwn',
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const generateBlocks = async (summaryResults, maxNumberOfFailures) => {
+    const maxNumberOfFailureLength = 650;
+    const fails = [];
+    const meta = [];
+    const header = {
+        type: 'section',
+        text: {
+            type: 'mrkdwn',
+            text: '🎭 *Playwright Results*',
+        },
+    };
+    const summary = {
+        type: 'section',
+        text: {
+            type: 'mrkdwn',
+            text: `✅ *${summaryResults.passed}* | ❌ *${summaryResults.failed}* | ⏩ *${summaryResults.skipped}*`,
+        },
+    };
+    for (let i = 0; i < summaryResults.failures.length; i += 1) {
+        const { failureReason, test } = summaryResults.failures[i];
+        const formattedFailure = failureReason
+            .substring(0, maxNumberOfFailureLength)
+            .split('\n')
+            .map((l) => `>${l}`)
+            .join('\n');
+        fails.push({
+            type: 'section',
+            text: {
+                type: 'mrkdwn',
                 text: `*${test}*
-        \n${formattedFailure}`,
-            },
-        });
-        if (i > maxNumberOfFailures) {
-            fails.push({
-                type: 'section',
-                text: {
-                    type: 'mrkdwn',
-                    text: `*There are too many failures to display - ${fails.length} out of ${summaryResults.failures.length} failures shown*`,
-                },
-            });
-            break;
-        }
-    }
-    if (summaryResults.meta) {
-        for (let i = 0; i < summaryResults.meta.length; i += 1) {
-            const { key, value } = summaryResults.meta[i];
-            meta.push({
-                type: 'section',
-                text: {
-                    type: 'mrkdwn',
-                    text: `\n*${key}* :\t${value}`,
-                },
-            });
-        }
-    }
-    return [
-        header,
-        summary,
-        ...meta,
-        {
-            type: 'divider',
-        },
-        ...fails,
-    ];
-};
-exports.default = generateBlocks;
+        \n${formattedFailure}`,
+            },
+        });
+        if (i > maxNumberOfFailures) {
+            fails.push({
+                type: 'section',
+                text: {
+                    type: 'mrkdwn',
+                    text: `*There are too many failures to display - ${fails.length} out of ${summaryResults.failures.length} failures shown*`,
+                },
+            });
+            break;
+        }
+    }
+    if (summaryResults.meta) {
+        for (let i = 0; i < summaryResults.meta.length; i += 1) {
+            const { key, value } = summaryResults.meta[i];
+            meta.push({
+                type: 'section',
+                text: {
+                    type: 'mrkdwn',
+                    text: `\n*${key}* :\t${value}`,
+                },
+            });
+        }
+    }
+    return [
+        header,
+        summary,
+        ...meta,
+        {
+            type: 'divider',
+        },
+        ...fails,
+    ];
+};
+exports.default = generateBlocks;

package/dist/src/ResultsParser.d.ts

@@ -1,46 +1,46 @@
-/// <reference types="node" />
-import { failure, SummaryResults } from '.';
-export declare type testResult = {
-    suiteName: string;
-    name: string;
-    browser?: string;
-    projectName: string;
-    endedAt: string;
-    reason: string;
-    retry: number;
-    retries: number;
-    startedAt: string;
-    status: 'passed' | 'failed' | 'timedOut' | 'skipped';
-    attachments?: {
-        body: string | undefined | Buffer;
-        contentType: string;
-        name: string;
-        path: string;
-    }[];
-};
-export declare type testSuite = {
-    testSuite: {
-        title: string;
-        tests: testResult[];
-        testRunId?: number;
-    };
-};
-export default class ResultsParser {
-    private result;
-    constructor();
-    getParsedResults(): Promise<SummaryResults>;
-    getFailures(): Promise<Array<failure>>;
-    static getTestName(failedTest: any): any;
-    updateResults(data: {
-        testSuite: any;
-    }): void;
-    addTestResult(suiteName: any, testCase: any): void;
-    safelyDetermineFailure(result: {
-        errors: any[];
-        error: {
-            message: string;
-            stack: string;
-        };
-    }): string;
-    cleanseReason(rawReaseon: string): string;
-}
+/// <reference types="node" />
+import { failure, SummaryResults } from '.';
+export declare type testResult = {
+    suiteName: string;
+    name: string;
+    browser?: string;
+    projectName: string;
+    endedAt: string;
+    reason: string;
+    retry: number;
+    retries: number;
+    startedAt: string;
+    status: 'passed' | 'failed' | 'timedOut' | 'skipped';
+    attachments?: {
+        body: string | undefined | Buffer;
+        contentType: string;
+        name: string;
+        path: string;
+    }[];
+};
+export declare type testSuite = {
+    testSuite: {
+        title: string;
+        tests: testResult[];
+        testRunId?: number;
+    };
+};
+export default class ResultsParser {
+    private result;
+    constructor();
+    getParsedResults(): Promise<SummaryResults>;
+    getFailures(): Promise<Array<failure>>;
+    static getTestName(failedTest: any): any;
+    updateResults(data: {
+        testSuite: any;
+    }): void;
+    addTestResult(suiteName: any, testCase: any): void;
+    safelyDetermineFailure(result: {
+        errors: any[];
+        error: {
+            message: string;
+            stack: string;
+        };
+    }): string;
+    cleanseReason(rawReaseon: string): string;
+}