playwright-slack-report 1.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 ryanrosello-og
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,325 @@
+# 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)
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ryanrosello-og/playwright-slack-report)
+
+Publish your Playwright test results to your favorite Slack channel(s).
+
+![Gif](https://github.com/ryanrosello-og/playwright-slack-report/blob/main/assets/2022-08-13_8-35-26.gif?raw=true)
+
+## 🚀 Features
+
+- 💌 Send results your Playwright test results to one or more Slack channels
+- 📊 Conditionally send results to Slack channels based on test results
+- 📄 Include additional meta information into your test summary e.g. Branch, BuildId etc
+- 🧑‍🎨 Define your own custom Slack message layout!
+
+
+# 📦 Installation 
+
+Run following commands:
+
+**yarn**
+
+`yarn add playwright-slack-report -D`
+
+**npm**
+
+`npm install playwright-slack-report -D`
+
+Modify your `playwright.config.ts` file to include the following:
+
+```typescript
+  reporter: [
+    [
+      "./node_modules/playwright-slack-report/dist/src/SlackReporter.js",
+      {
+        channels: ["pw-tests", "ci"], // provide one or more Slack channels
+        sendResults: "always", // "always" , "on-failure", "off"
+      },
+    ],
+    ["dot"], // other reporters
+  ],
+```
+
+Run your tests by providing your` SLACK_BOT_USER_OAUTH_TOKEN` as an environment variable:
+
+`SLACK_BOT_USER_OAUTH_TOKEN=[your Slack bot user OAUTH token] npx playwright test`
+
+# ℹ️ How do I find my Slack bot oauth token?
+
+You will need to have Slack administrator rights to perform the steps below.
+
+1. Navigate to https://api.slack.com/apps
+2. Click the Create New App button and select "From scratch"
+
+![Navigate to https://api.slack.com/apps](https://github.com/ryanrosello-og/playwright-slack-report/blob/main/assets/2022-08-09_5-37-11.png?raw=true)
+
+3. Input a name for your app and select the target workspace, then click on the **Create App** button
+
+![Input a name for your app and select the target workspace](https://github.com/ryanrosello-og/playwright-slack-report/blob/main/assets/2022-08-09_5-40-51.png?raw=true)
+
+4. Under the Features menu, select **OAuth & Permissions** and scroll down to **Scopes** section
+
+![Under the Features menu select](https://github.com/ryanrosello-og/playwright-slack-report/blob/main/assets/2022-08-09_5-44-29.png?raw=true)
+
+5. Click the **Add an OAuth Scope** button and select the following scopes:
+
+![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  
+
+6. Scroll up to the OAuth Tokens for Your Workspace and click the **Install to Workspace** button
+
+![Install](https://github.com/ryanrosello-og/playwright-slack-report/blob/main/assets/2022-08-09_5-55-22.png?raw=true)
+
+> You will be prompted with the message below, click the Allow button
+
+![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`.  
+
+>**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)
+
+# ⚙️ Configuration
+
+An example advanced configuration is shown below:
+
+
+```typescript
+  import { generateCustomLayout } from "./my_custom_layout";
+
+  ...
+
+  reporter: [
+    [
+      "./node_modules/playwright-slack-report/dist/src/SlackReporter.js",
+      {
+        channels: ["pw-tests", "ci"], // provide one or more Slack channels
+        sendResults: "always", // "always" , "on-failure", "off"
+      },
+      layout: generateCustomLayout,
+      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
+        },
+      ],      
+    ],
+  ],
+```
+
+### **channels**
+An array of Slack channels to post to, atleast 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
+  * **on-failure** - will send the results to Slack only if a test failures are encountered
+  * **off** - turns off the reporter, it will not send the results to Slack
+### **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.
+
+**Examples:**
+```typescript
+...
+meta: [
+  {
+    key: 'Suite',
+    value: 'Nightly full regression',
+  },
+  {
+    key: 'GITHUB_REPOSITORY',
+    value: 'octocat/telsa-ui',
+  },
+  {
+    key: 'GITHUB_REF',
+    value: process.env.GITHUB_REF,
+  },
+], 
+...
+```
+
+# 🎨 Define your own Slack message custom layout
+
+You can define your own Slack message layout to suit your needs.
+
+Firstly, install the necessary type definitions:
+
+`yarn add @slack/types -D`
+
+
+Next, define your layout function.  The signature of this function should adhere to example below:
+
+```typescript
+import { Block, KnownBlock } from "@slack/types";
+import { SummaryResults } from "playwright-slack-report/dist/src";
+
+const generateCustomLayout = (summaryResults: SummaryResults):Array<KnownBlock | Block> => {
+  // your implementation goes here
+}
+
+export default generateCustomLayout;
+```
+
+In your, `playwright.confing.ts` file, add your function into the config.
+
+```typescript
+  import { generateCustomLayout } from "./my_custom_layout";
+
+  ...
+
+  reporter: [
+    [
+      "./node_modules/playwright-slack-report/dist/src/SlackReporter.js",
+      {
+        channels: ["pw-tests", "ci"], // provide one or more Slack channels
+        sendResults: "always", // "always" , "on-failure", "off"
+      },
+      layout: generateCustomLayout,
+      ...   
+    ],
+  ],
+```
+
+>Pro Tip:  You can use the [block-kit provided by Slack when creating your layout.](https://app.slack.com/block-kit-builder/)
+
+### Examples:
+
+**Example 1: - very simple summary**
+
+```typescript
+import { Block, KnownBlock } from '@slack/types';
+import { SummaryResults } from '..';
+
+export default function generateCustomLayoutSimpleExample(
+  summaryResults: SummaryResults,
+): Array<Block | KnownBlock> {
+  return [
+    {
+      type: 'section',
+      text: {
+        type: 'mrkdwn',
+        text:
+          summaryResults.failed === 0
+            ? ':tada: All tests passed!'
+            : `😭${summaryResults.failed} failure(s) out of ${summaryResults.tests.length} tests`,
+      },
+    },
+  ];
+}
+```
+
+Generates the following message in Slack:
+
+![Final](https://github.com/ryanrosello-og/playwright-slack-report/blob/main/assets/2022-08-13_8-02-54.png?raw=true)
+
+
+**Example 2: - very simple summary (with Meta information)**
+
+Add the meta block in your config:
+
+```typescript
+  reporter: [
+    [
+      "./node_modules/playwright-slack-report/dist/src/SlackReporter.js",
+      {
+        channels: ["demo"],
+        sendResults: "always", // "always" , "on-failure", "off",
+        layout: generateCustomLayout,
+        meta: [
+          {
+            key: 'EXAMPLE_META_node_env',
+            value: process.env.HOME ,
+          },
+        ],
+      },
+      
+    ],
+  ],
+```
+
+Create the function to generate the layout:
+
+```typescript
+import { Block, KnownBlock } from '@slack/types';
+import { SummaryResults } from '..';
+
+export default function generateCustomLayoutSimpleMeta(
+  summaryResults: SummaryResults,
+): Array<Block | KnownBlock> {
+  const meta: { type: string; text: { type: string; text: string; }; }[] = [];
+  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 [
+    {
+      type: 'section',
+      text: {
+        type: 'mrkdwn',
+        text:
+          summaryResults.failed === 0
+            ? ':tada: All tests passed!'
+            : `😭${summaryResults.failed} failure(s) out of ${summaryResults.tests.length} tests`,
+      },
+    },
+    ...meta,
+  ];
+}
+
+```
+
+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)
+
+# 🔑 License
+
+[MIT](https://github.com/ryanrosello-og/playwright-slack-report/blob/main/LICENSE)
+
+# ✨ Contributing
+
+Clone the project and run `npm install`
+
+Make your changes
+Run the tests using `npm run pw`
+
+**To execute and test the entire package:**
+
+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 
+
+e.g.
+
+```
+  "dependencies": {
+    "playwright-slack-report": "/home/ry/_repo/playwright-slack-report/playwright-slack-report-1.0.3.tgz"
+  }
+```
+
+* Execute `npm install`
+* Set your `SLACK_BOT_USER_OAUTH_TOKEN` environment variable
+* Modify the `playwright.config.ts` as above
+* Run the tests using `npx playwright text`
+
+# 🐛 Something not working for you?
+
+Feel free to [raise a github issue](https://github.com/ryanrosello-og/playwright-slack-report/issues) for any bugs or feature requests.

package/dist/src/LayoutGenerator.d.ts

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

package/dist/src/LayoutGenerator.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const generateBlocks = async (summaryResults) => {
+    const maxNumberOfFailures = 10;
+    const maxNumberOfFailureLength = 650;
+    const fails = [];
+    const meta = [];
+    const summary = {
+        type: 'section',
+        text: {
+            type: 'mrkdwn',
+            text: `:white_check_mark: *${summaryResults.passed}* Tests ran successfully \n\n :red_circle: *${summaryResults.failed}* Tests failed \n\n ${summaryResults.skipped > 0
+                ? `:fast_forward: *${summaryResults.skipped}* skipped`
+                : ''} \n\n ${summaryResults.aborted > 0
+                ? `:exclamation: *${summaryResults.aborted}* aborted`
+                : ''}`,
+        },
+    };
+    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\n${formattedFailure}`,
+            },
+        });
+        if (i > maxNumberOfFailures) {
+            fails.push({
+                type: 'section',
+                text: {
+                    type: 'mrkdwn',
+                    text: '*There are too many failures to display*',
+                },
+            });
+            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 [
+        summary,
+        ...meta,
+        {
+            type: 'divider',
+        },
+        ...fails,
+    ];
+};
+exports.default = generateBlocks;

package/dist/src/ResultsParser.d.ts

@@ -0,0 +1,37 @@
+/// <reference types="node" />
+import { failure, SummaryResults } from '.';
+export declare type testResult = {
+    suiteName: string;
+    name: string;
+    browser?: string;
+    endedAt: string;
+    reason: string;
+    retry: number;
+    startedAt: string;
+    status: 'failed' | 'passed' | 'skipped' | 'aborted';
+    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>>;
+    updateResults(data: {
+        testSuite: any;
+    }): void;
+    addTestResult(suiteName: any, test: any): void;
+    parseTests(suiteName: any, tests: any): Promise<testResult[]>;
+    cleanseReason(rawReaseon: string): string;
+}

package/dist/src/ResultsParser.js

@@ -0,0 +1,104 @@
+"use strict";
+/* eslint-disable import/extensions */
+/* eslint-disable no-control-regex */
+/* eslint-disable class-methods-use-this */
+/* eslint-disable no-param-reassign */
+Object.defineProperty(exports, "__esModule", { value: true });
+class ResultsParser {
+    result;
+    constructor() {
+        this.result = [];
+    }
+    async getParsedResults() {
+        const summary = {
+            passed: 0,
+            failed: 0,
+            skipped: 0,
+            aborted: 0,
+            failures: await this.getFailures(),
+            tests: [],
+        };
+        for (const suite of this.result) {
+            summary.tests = summary.tests.concat(suite.testSuite.tests);
+            for (const test of suite.testSuite.tests) {
+                if (test.status === 'passed') {
+                    summary.passed += 1;
+                }
+                else if (test.status === 'failed') {
+                    summary.failed += 1;
+                }
+                else if (test.status === 'skipped') {
+                    summary.skipped += 1;
+                }
+                else if (test.status === 'aborted') {
+                    summary.aborted += 1;
+                }
+            }
+        }
+        return summary;
+    }
+    async getFailures() {
+        const failures = [];
+        for (const suite of this.result) {
+            for (const test of suite.testSuite.tests) {
+                if (test.status === 'failed') {
+                    failures.push({
+                        test: test.name,
+                        failureReason: test.reason,
+                    });
+                }
+            }
+        }
+        return failures;
+    }
+    updateResults(data) {
+        if (data.testSuite.tests.length > 0) {
+            this.result.push(data);
+        }
+    }
+    addTestResult(suiteName, test) {
+        const testResults = [];
+        for (const result of test.results) {
+            testResults.push({
+                suiteName,
+                name: test.title,
+                status: result.status,
+                retry: result.retry,
+                startedAt: new Date(result.startTime).toISOString(),
+                endedAt: new Date(new Date(result.startTime).getTime() + result.duration).toISOString(),
+                reason: `${this.cleanseReason(result.error?.message)} \n ${this.cleanseReason(result.error?.stack)}`,
+                attachments: result.attachments,
+            });
+        }
+        this.updateResults({
+            testSuite: {
+                title: suiteName,
+                tests: testResults,
+            },
+        });
+    }
+    async parseTests(suiteName, tests) {
+        const testResults = [];
+        for (const test of tests) {
+            for (const result of test.results) {
+                testResults.push({
+                    suiteName,
+                    name: test.title,
+                    status: result.status,
+                    retry: result.retry,
+                    startedAt: new Date(result.startTime).toISOString(),
+                    endedAt: new Date(new Date(result.startTime).getTime() + result.duration).toISOString(),
+                    reason: `${this.cleanseReason(result.error?.message)} \n ${this.cleanseReason(result.error?.stack)}`,
+                    attachments: result.attachments,
+                });
+            }
+        }
+        return testResults;
+    }
+    cleanseReason(rawReaseon) {
+        // eslint-disable-next-line prefer-regex-literals
+        const ansiRegex = new RegExp('([\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~])))', 'g');
+        return rawReaseon ? rawReaseon.replace(ansiRegex, '') : '';
+    }
+}
+exports.default = ResultsParser;

package/dist/src/SlackClient.d.ts

@@ -0,0 +1,22 @@
+import { WebClient, KnownBlock, Block, ChatPostMessageResponse } from '@slack/web-api';
+import { SummaryResults } from '.';
+export declare type additionalInfo = Array<{
+    key: string;
+    value: string;
+}>;
+export default class SlackClient {
+    private slackWebClient;
+    constructor(slackClient: WebClient);
+    sendMessage({ options, }: {
+        options: {
+            channelIds: Array<string>;
+            summaryResults: SummaryResults;
+            customLayout: Function | undefined;
+            fakeRequest?: Function;
+        };
+    }): Promise<Array<{
+        channel: string;
+        outcome: string;
+    }>>;
+    doPostRequest(channel: string, blocks: Array<KnownBlock | Block>): Promise<ChatPostMessageResponse>;
+}

package/dist/src/SlackClient.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const LayoutGenerator_1 = require("./LayoutGenerator");
+class SlackClient {
+    slackWebClient;
+    constructor(slackClient) {
+        this.slackWebClient = slackClient;
+    }
+    async sendMessage({ options, }) {
+        let blocks;
+        if (options.customLayout) {
+            blocks = options.customLayout(options.summaryResults);
+        }
+        else {
+            blocks = await (0, LayoutGenerator_1.default)(options.summaryResults);
+        }
+        if (!options.channelIds) {
+            throw new Error(`Channel ids [${options.channelIds}] is not valid`);
+        }
+        const result = [];
+        for (const channel of options.channelIds) {
+            let chatResponse;
+            try {
+                // under test
+                if (options.fakeRequest) {
+                    chatResponse = await options.fakeRequest();
+                }
+                else {
+                    // send request for reals
+                    chatResponse = await this.doPostRequest(channel, blocks);
+                }
+                if (chatResponse.ok) {
+                    result.push({ channel, outcome: `✅ Message sent to ${channel}` });
+                    // eslint-disable-next-line no-console
+                    console.log(`✅ Message sent to ${channel}`);
+                }
+            }
+            catch (error) {
+                result.push({
+                    channel,
+                    outcome: `❌ Message not sent to ${channel} \r\n ${error.message}`,
+                });
+            }
+        }
+        return result;
+    }
+    async doPostRequest(channel, blocks) {
+        const chatResponse = await this.slackWebClient.chat.postMessage({
+            channel,
+            text: ' ',
+            blocks,
+        });
+        return chatResponse;
+    }
+}
+exports.default = SlackClient;

package/dist/src/SlackReporter.d.ts

@@ -0,0 +1,19 @@
+import { FullConfig, Reporter, Suite, TestCase, TestResult } from '@playwright/test/reporter';
+declare class SlackReporter implements Reporter {
+    private suite;
+    private sendResults;
+    private slackChannels;
+    private meta;
+    private customLayout;
+    private resultsParser;
+    logs: string[];
+    onBegin(fullConfig: FullConfig, suite: Suite): void;
+    onTestEnd(test: TestCase, result: TestResult): void;
+    onEnd(): Promise<void>;
+    preChecks(): {
+        okToProceed: boolean;
+        message?: string;
+    };
+    log(message: string | undefined): void;
+}
+export default SlackReporter;

package/dist/src/SlackReporter.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const web_api_1 = require("@slack/web-api");
+const ResultsParser_1 = require("./ResultsParser");
+const SlackClient_1 = require("./SlackClient");
+class SlackReporter {
+    suite;
+    sendResults = 'on-failure';
+    slackChannels = [];
+    meta = [];
+    customLayout;
+    resultsParser;
+    logs = [];
+    onBegin(fullConfig, suite) {
+        this.suite = suite;
+        this.logs = [];
+        const slackReporterConfig = fullConfig.reporter.filter((f) => f[0].toLowerCase().includes('slackreporter'))[0][1];
+        if (slackReporterConfig) {
+            this.meta = slackReporterConfig.meta || [];
+            this.sendResults = slackReporterConfig.sendResults || 'always';
+            this.customLayout = slackReporterConfig.layout;
+            this.slackChannels = slackReporterConfig.channels;
+        }
+        this.resultsParser = new ResultsParser_1.default();
+    }
+    // eslint-disable-next-line class-methods-use-this, no-unused-vars
+    onTestEnd(test, result) {
+        this.resultsParser.addTestResult(test.parent.title, test);
+    }
+    async onEnd() {
+        const { okToProceed, message } = this.preChecks();
+        if (!okToProceed) {
+            this.log(message);
+            return;
+        }
+        const resultSummary = await this.resultsParser.getParsedResults();
+        resultSummary.meta = this.meta;
+        if (this.sendResults === 'on-failure'
+            && resultSummary.failures.length === 0) {
+            this.log('⏩ Slack reporter - no failures found');
+            return;
+        }
+        const slackClient = new SlackClient_1.default(new web_api_1.WebClient(process.env.SLACK_BOT_USER_OAUTH_TOKEN, {
+            logLevel: web_api_1.LogLevel.DEBUG,
+        }));
+        await slackClient.sendMessage({
+            options: {
+                channelIds: this.slackChannels,
+                summaryResults: resultSummary,
+                customLayout: this.customLayout,
+            },
+        });
+    }
+    preChecks() {
+        if (this.sendResults === 'off') {
+            return { okToProceed: false, message: '❌ Slack reporter is disabled' };
+        }
+        if (!process.env.SLACK_BOT_USER_OAUTH_TOKEN) {
+            return {
+                okToProceed: false,
+                message: '❌ SLACK_BOT_USER_OAUTH_TOKEN was not found',
+            };
+        }
+        if (!this.sendResults
+            || !['always', 'on-failure', 'off'].includes(this.sendResults)) {
+            return {
+                okToProceed: false,
+                message: "❌ \"sendResults\" is not valid. Expecting one of ['always', 'on-failure', 'off'].",
+            };
+        }
+        if (!this.sendResults || this.slackChannels?.length === 0) {
+            return {
+                okToProceed: false,
+                message: '❌ Slack channel(s) was not provided in the config',
+            };
+        }
+        if (this.customLayout && typeof this.customLayout !== 'function') {
+            return {
+                okToProceed: false,
+                message: '❌ Custom layout is not a function',
+            };
+        }
+        if (this.meta && !Array.isArray(this.meta)) {
+            return { okToProceed: false, message: '❌ Meta is not an array' };
+        }
+        return { okToProceed: true };
+    }
+    log(message) {
+        // eslint-disable-next-line no-console
+        console.log(message);
+        if (message) {
+            this.logs.push(message);
+        }
+    }
+}
+exports.default = SlackReporter;

package/dist/src/custom_block/my_block.d.ts

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

package/dist/src/custom_block/my_block.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const generateCustomLayout = (summaryResults) => {
+    const maxNumberOfFailures = 10;
+    const maxNumberOfFailureLength = 650;
+    const fails = [];
+    const meta = [];
+    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\n${formattedFailure}`,
+            },
+        });
+        if (i > maxNumberOfFailures) {
+            fails.push({
+                type: 'section',
+                text: {
+                    type: 'mrkdwn',
+                    text: '*There are too many failures to display, view the full results in BuildKite*',
+                },
+            });
+            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}`,
+                },
+            });
+        }
+    }
+    const testWithStringAttachment = summaryResults.tests.filter((t) => t.attachments)[0];
+    return [
+        {
+            type: 'section',
+            text: {
+                type: 'mrkdwn',
+                text: '**Thisi is cusomter block**',
+            },
+        },
+        {
+            type: 'section',
+            text: {
+                type: 'mrkdwn',
+                text: `**The first test is:**\n${summaryResults.tests[0].name}`,
+            },
+        },
+        {
+            type: 'section',
+            text: {
+                type: 'mrkdwn',
+                text: `**Test with attachment:**\n${testWithStringAttachment?.attachments
+                    ?.filter((a) => a.contentType === 'text/plain')
+                    .map((a) => a.body?.toString())}`,
+            },
+        },
+        ...meta,
+        {
+            type: 'section',
+            text: {
+                type: 'mrkdwn',
+                text: `:white_check_mark: *${summaryResults.passed}* Tests ran successfully \n\n :red_circle: *${summaryResults.failed}* Tests failed \n\n ${summaryResults.skipped > 0
+                    ? `:fast_forward: *${summaryResults.skipped}* skipped`
+                    : ''} \n\n ${summaryResults.aborted > 0
+                    ? `:exclamation: *${summaryResults.aborted}* aborted`
+                    : ''}`,
+            },
+        },
+        {
+            type: 'divider',
+        },
+        ...fails,
+    ];
+};
+exports.default = generateCustomLayout;

package/dist/src/custom_block/simple.d.ts

@@ -0,0 +1,3 @@
+import { Block, KnownBlock } from '@slack/types';
+import { SummaryResults } from '..';
+export default function generateCustomLayoutSimpleExample(summaryResults: SummaryResults): Array<Block | KnownBlock>;

package/dist/src/custom_block/simple.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function generateCustomLayoutSimpleExample(summaryResults) {
+    return [
+        {
+            type: 'section',
+            text: {
+                type: 'mrkdwn',
+                text: summaryResults.failed === 0
+                    ? ':tada: All tests passed!'
+                    : `😭${summaryResults.failed} failure(s) out of ${summaryResults.tests.length} tests`,
+            },
+        },
+    ];
+}
+exports.default = generateCustomLayoutSimpleExample;

package/dist/src/custom_block/simple_with_meta.d.ts

@@ -0,0 +1,3 @@
+import { Block, KnownBlock } from '@slack/types';
+import { SummaryResults } from '..';
+export default function generateCustomLayoutSimpleMeta(summaryResults: SummaryResults): Array<Block | KnownBlock>;

package/dist/src/custom_block/simple_with_meta.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function generateCustomLayoutSimpleMeta(summaryResults) {
+    const meta = [];
+    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 [
+        {
+            type: 'section',
+            text: {
+                type: 'mrkdwn',
+                text: summaryResults.failed === 0
+                    ? ':tada: All tests passed!'
+                    : `😭${summaryResults.failed} failure(s) out of ${summaryResults.tests.length} tests`,
+            },
+        },
+        ...meta,
+    ];
+}
+exports.default = generateCustomLayoutSimpleMeta;

package/dist/src/index.d.ts

@@ -0,0 +1,32 @@
+/// <reference types="node" />
+export declare type SummaryResults = {
+    passed: number;
+    failed: number;
+    skipped: number;
+    aborted: number;
+    failures: Array<failure>;
+    meta?: Array<{
+        key: string;
+        value: string;
+    }>;
+    tests: Array<{
+        suiteName: string;
+        name: string;
+        browser?: string;
+        endedAt: string;
+        reason: string;
+        retry: number;
+        startedAt: string;
+        status: 'failed' | 'passed' | 'skipped' | 'aborted';
+        attachments?: {
+            body: string | undefined | Buffer;
+            contentType: string;
+            name: string;
+            path: string;
+        }[];
+    }>;
+};
+export declare type failure = {
+    test: string;
+    failureReason: string;
+};

package/dist/src/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,38 @@
+{
+  "dependencies": {
+    "@playwright/test": "^1.23.3",
+    "@slack/web-api": "^6.7.2",
+    "dotenv": "^16.0.1",
+    "playwright": "^1.23.3",
+    "typescript": "^4.7.4",
+    "@slack/types": "^2.7.0"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.30.6",
+    "@typescript-eslint/parser": "^5.30.6",
+    "eslint": "^7.32.0 || ^8.2.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-node": "^4.1.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "nyc": "^15.1.0",
+    "prettier": "^2.7.1",
+    "ts-mockito": "^2.6.1"
+  },
+  "scripts": {
+    "prettier": "prettier --write --loglevel warn \"**/**/*.ts\"",
+    "pw": "nyc playwright test",
+    "build": "tsc -p ./tsconfig.json",
+    "lint":"npx eslint . --ext .ts"
+  },
+  "name": "playwright-slack-report",
+  "version": "1.0.4",
+  "main": "index.js",
+  "types": "dist/index.d.ts",
+  "repository": "git@github.com:ryanrosello-og/playwright-slack-report.git",
+  "author": "Ryan Rosello <ryanrosello@hotmail.com>",
+  "license": "MIT",
+  "files": ["/dist/src"]
+}