playwright-slack-report 1.1.0 → 1.1.2

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;
+}

package/dist/src/ResultsParser.js

@@ -1,118 +1,118 @@
-"use strict";
-/* eslint-disable no-shadow */
-/* eslint-disable no-underscore-dangle */
-/* 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 failures = await this.getFailures();
-        const summary = {
-            passed: 0,
-            failed: failures.length,
-            skipped: 0,
-            failures,
-            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 === 'skipped') {
-                    summary.skipped += 1;
-                }
-            }
-        }
-        return summary;
-    }
-    async getFailures() {
-        const failures = [];
-        for (const suite of this.result) {
-            for (const test of suite.testSuite.tests) {
-                if (test.status === 'failed' || test.status === 'timedOut') {
-                    // only flag as failed if the last attempt has failed
-                    if (test.retries === test.retry) {
-                        failures.push({
-                            test: ResultsParser.getTestName(test),
-                            failureReason: test.reason,
-                        });
-                    }
-                }
-            }
-        }
-        return failures;
-    }
-    static getTestName(failedTest) {
-        const testName = failedTest.name;
-        if (failedTest.browser && failedTest.projectName) {
-            if (failedTest.browser === failedTest.projectName) {
-                return `${testName} [${failedTest.browser}]`;
-            }
-            return `${testName} [Project Name: ${failedTest.projectName}] using ${failedTest.browser}`;
-        }
-        return testName;
-    }
-    updateResults(data) {
-        if (data.testSuite.tests.length > 0) {
-            this.result.push(data);
-        }
-    }
-    addTestResult(suiteName, testCase) {
-        const testResults = [];
-        for (const result of testCase.results) {
-            testResults.push({
-                suiteName,
-                name: testCase.title,
-                status: result.status,
-                // eslint-disable-next-line no-underscore-dangle
-                browser: testCase.parent?.parent?._projectConfig?.use?.defaultBrowserType
-                    ? testCase.parent.parent._projectConfig.use.defaultBrowserType
-                    : '',
-                // eslint-disable-next-line no-underscore-dangle
-                projectName: testCase.parent?.parent?._projectConfig?.name
-                    ? testCase.parent.parent._projectConfig.name
-                    : '',
-                retry: result.retry,
-                retries: testCase.retries,
-                startedAt: new Date(result.startTime).toISOString(),
-                endedAt: new Date(new Date(result.startTime).getTime() + result.duration).toISOString(),
-                reason: this.safelyDetermineFailure(result),
-                attachments: result.attachments,
-            });
-        }
-        this.updateResults({
-            testSuite: {
-                title: suiteName,
-                tests: testResults,
-            },
-        });
-    }
-    safelyDetermineFailure(result) {
-        if (result.errors.length > 0) {
-            const fullError = result.errors
-                .map((e) => `${e.message}\r\n${e.stack ? e.stack : ''}\r\n`)
-                .join();
-            return this.cleanseReason(fullError);
-        }
-        return `${this.cleanseReason(result.error?.message)} \n ${this.cleanseReason(result.error?.stack)}`;
-    }
-    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');
-        const ansiCleansed = rawReaseon ? rawReaseon.replace(ansiRegex, '') : '';
-        const logsStripped = ansiCleansed
-            .replace(/============================================================\n/g, '')
-            .replace(/============================================================\r\n/g, '')
-            .replace(/=========================== logs ===========================\n/g, '');
-        return logsStripped;
-    }
-}
-exports.default = ResultsParser;
+"use strict";
+/* eslint-disable no-shadow */
+/* eslint-disable no-underscore-dangle */
+/* 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 failures = await this.getFailures();
+        const summary = {
+            passed: 0,
+            failed: failures.length,
+            skipped: 0,
+            failures,
+            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 === 'skipped') {
+                    summary.skipped += 1;
+                }
+            }
+        }
+        return summary;
+    }
+    async getFailures() {
+        const failures = [];
+        for (const suite of this.result) {
+            for (const test of suite.testSuite.tests) {
+                if (test.status === 'failed' || test.status === 'timedOut') {
+                    // only flag as failed if the last attempt has failed
+                    if (test.retries === test.retry) {
+                        failures.push({
+                            test: ResultsParser.getTestName(test),
+                            failureReason: test.reason,
+                        });
+                    }
+                }
+            }
+        }
+        return failures;
+    }
+    static getTestName(failedTest) {
+        const testName = failedTest.name;
+        if (failedTest.browser && failedTest.projectName) {
+            if (failedTest.browser === failedTest.projectName) {
+                return `${testName} [${failedTest.browser}]`;
+            }
+            return `${testName} [Project Name: ${failedTest.projectName}] using ${failedTest.browser}`;
+        }
+        return testName;
+    }
+    updateResults(data) {
+        if (data.testSuite.tests.length > 0) {
+            this.result.push(data);
+        }
+    }
+    addTestResult(suiteName, testCase) {
+        const testResults = [];
+        for (const result of testCase.results) {
+            testResults.push({
+                suiteName,
+                name: testCase.title,
+                status: result.status,
+                // eslint-disable-next-line no-underscore-dangle
+                browser: testCase.parent?.parent?._projectConfig?.use?.defaultBrowserType
+                    ? testCase.parent.parent._projectConfig.use.defaultBrowserType
+                    : '',
+                // eslint-disable-next-line no-underscore-dangle
+                projectName: testCase.parent?.parent?._projectConfig?.name
+                    ? testCase.parent.parent._projectConfig.name
+                    : '',
+                retry: result.retry,
+                retries: testCase.retries,
+                startedAt: new Date(result.startTime).toISOString(),
+                endedAt: new Date(new Date(result.startTime).getTime() + result.duration).toISOString(),
+                reason: this.safelyDetermineFailure(result),
+                attachments: result.attachments,
+            });
+        }
+        this.updateResults({
+            testSuite: {
+                title: suiteName,
+                tests: testResults,
+            },
+        });
+    }
+    safelyDetermineFailure(result) {
+        if (result.errors.length > 0) {
+            const fullError = result.errors
+                .map((e) => `${e.message}\r\n${e.stack ? e.stack : ''}\r\n`)
+                .join();
+            return this.cleanseReason(fullError);
+        }
+        return `${this.cleanseReason(result.error?.message)} \n ${this.cleanseReason(result.error?.stack)}`;
+    }
+    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');
+        const ansiCleansed = rawReaseon ? rawReaseon.replace(ansiRegex, '') : '';
+        const logsStripped = ansiCleansed
+            .replace(/============================================================\n/g, '')
+            .replace(/============================================================\r\n/g, '')
+            .replace(/=========================== logs ===========================\n/g, '');
+        return logsStripped;
+    }
+}
+exports.default = ResultsParser;

package/dist/src/SlackClient.d.ts

@@ -1,26 +1,26 @@
-import { WebClient, KnownBlock, Block, ChatPostMessageResponse, LogLevel } 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>;
-            customLayout: Function | undefined;
-            customLayoutAsync: Function | undefined;
-            fakeRequest?: Function;
-            maxNumberOfFailures: number;
-            slackOAuthToken?: string;
-            slackLogLevel?: LogLevel;
-            summaryResults: SummaryResults;
-        };
-    }): Promise<Array<{
-        channel: string;
-        outcome: string;
-    }>>;
-    doPostRequest(channel: string, blocks: Array<KnownBlock | Block>): Promise<ChatPostMessageResponse>;
-}
+import { WebClient, KnownBlock, Block, ChatPostMessageResponse, LogLevel } 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>;
+            customLayout: Function | undefined;
+            customLayoutAsync: Function | undefined;
+            fakeRequest?: Function;
+            maxNumberOfFailures: number;
+            slackOAuthToken?: string;
+            slackLogLevel?: LogLevel;
+            summaryResults: SummaryResults;
+        };
+    }): Promise<Array<{
+        channel: string;
+        outcome: string;
+    }>>;
+    doPostRequest(channel: string, blocks: Array<KnownBlock | Block>): Promise<ChatPostMessageResponse>;
+}

package/dist/src/SlackClient.js

@@ -1,62 +1,62 @@
-"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 if (options.customLayoutAsync) {
-            blocks = await options.customLayoutAsync(options.summaryResults);
-        }
-        else {
-            blocks = await (0, LayoutGenerator_1.default)(options.summaryResults, options.maxNumberOfFailures);
-        }
-        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}`);
-                }
-                else {
-                    result.push({ channel, outcome: `❌ Message not sent to ${channel} \r\n ${JSON.stringify(chatResponse, null, 2)}` });
-                }
-            }
-            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;
+"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 if (options.customLayoutAsync) {
+            blocks = await options.customLayoutAsync(options.summaryResults);
+        }
+        else {
+            blocks = await (0, LayoutGenerator_1.default)(options.summaryResults, options.maxNumberOfFailures);
+        }
+        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}`);
+                }
+                else {
+                    result.push({ channel, outcome: `❌ Message not sent to ${channel} \r\n ${JSON.stringify(chatResponse, null, 2)}` });
+                }
+            }
+            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;