playwright-slack-report 1.1.0 → 1.1.2

package/dist/src/SlackReporter.d.ts

@@ -1,23 +1,23 @@
-import { FullConfig, Reporter, Suite, TestCase, TestResult } from '@playwright/test/reporter';
-declare class SlackReporter implements Reporter {
-    private customLayout;
-    private customLayoutAsync;
-    private maxNumberOfFailuresToShow;
-    private meta;
-    private resultsParser;
-    private sendResults;
-    private slackChannels;
-    private slackLogLevel;
-    private slackOAuthToken;
-    private suite;
-    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;
+import { FullConfig, Reporter, Suite, TestCase, TestResult } from '@playwright/test/reporter';
+declare class SlackReporter implements Reporter {
+    private customLayout;
+    private customLayoutAsync;
+    private maxNumberOfFailuresToShow;
+    private meta;
+    private resultsParser;
+    private sendResults;
+    private slackChannels;
+    private slackLogLevel;
+    private slackOAuthToken;
+    private suite;
+    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

@@ -1,114 +1,115 @@
-"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 {
-    customLayout;
-    customLayoutAsync;
-    maxNumberOfFailuresToShow;
-    meta = [];
-    resultsParser;
-    sendResults = 'on-failure';
-    slackChannels = [];
-    slackLogLevel;
-    slackOAuthToken;
-    suite;
-    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.customLayoutAsync = slackReporterConfig.layoutAsync;
-            this.slackChannels = slackReporterConfig.channels;
-            this.maxNumberOfFailuresToShow = slackReporterConfig.maxNumberOfFailuresToShow || 10;
-        }
-        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;
-        const maxRetry = Math.max(...resultSummary.tests.map((o) => o.retry));
-        if (this.sendResults === 'on-failure'
-            && resultSummary.tests.filter((z) => (z.status === 'failed' || z.status === 'timedOut') && z.retry === maxRetry).length === 0) {
-            this.log('⏩ Slack reporter - no failures found');
-            return;
-        }
-        const slackClient = new SlackClient_1.default(new web_api_1.WebClient(this.slackOAuthToken || process.env.SLACK_BOT_USER_OAUTH_TOKEN, {
-            logLevel: this.slackLogLevel || web_api_1.LogLevel.DEBUG,
-        }));
-        const result = await slackClient.sendMessage({
-            options: {
-                channelIds: this.slackChannels,
-                customLayout: this.customLayout,
-                customLayoutAsync: this.customLayoutAsync,
-                maxNumberOfFailures: this.maxNumberOfFailuresToShow,
-                summaryResults: resultSummary,
-            },
-        });
-        // eslint-disable-next-line no-console
-        console.log(JSON.stringify(result, null, 2));
-    }
-    preChecks() {
-        if (this.sendResults === 'off') {
-            return { okToProceed: false, message: '❌ Slack reporter is disabled' };
-        }
-        if (!this.slackOAuthToken && !process.env.SLACK_BOT_USER_OAUTH_TOKEN) {
-            return {
-                okToProceed: false,
-                message: '❌ Neither slackOAuthToken nor process.env.SLACK_BOT_USER_OAUTH_TOKEN were 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.customLayoutAsync
-            && typeof this.customLayoutAsync !== 'function') {
-            return {
-                okToProceed: false,
-                message: '❌ customLayoutAsync 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;
+"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 {
+    customLayout;
+    customLayoutAsync;
+    maxNumberOfFailuresToShow;
+    meta = [];
+    resultsParser;
+    sendResults = 'on-failure';
+    slackChannels = [];
+    slackLogLevel;
+    slackOAuthToken;
+    suite;
+    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.customLayoutAsync = slackReporterConfig.layoutAsync;
+            this.slackChannels = slackReporterConfig.channels;
+            this.maxNumberOfFailuresToShow = slackReporterConfig.maxNumberOfFailuresToShow || 10;
+            this.slackOAuthToken = slackReporterConfig.slackOAuthToken || undefined;
+        }
+        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;
+        const maxRetry = Math.max(...resultSummary.tests.map((o) => o.retry));
+        if (this.sendResults === 'on-failure'
+            && resultSummary.tests.filter((z) => (z.status === 'failed' || z.status === 'timedOut') && z.retry === maxRetry).length === 0) {
+            this.log('⏩ Slack reporter - no failures found');
+            return;
+        }
+        const slackClient = new SlackClient_1.default(new web_api_1.WebClient(this.slackOAuthToken || process.env.SLACK_BOT_USER_OAUTH_TOKEN, {
+            logLevel: this.slackLogLevel || web_api_1.LogLevel.DEBUG,
+        }));
+        const result = await slackClient.sendMessage({
+            options: {
+                channelIds: this.slackChannels,
+                customLayout: this.customLayout,
+                customLayoutAsync: this.customLayoutAsync,
+                maxNumberOfFailures: this.maxNumberOfFailuresToShow,
+                summaryResults: resultSummary,
+            },
+        });
+        // eslint-disable-next-line no-console
+        console.log(JSON.stringify(result, null, 2));
+    }
+    preChecks() {
+        if (this.sendResults === 'off') {
+            return { okToProceed: false, message: '❌ Slack reporter is disabled' };
+        }
+        if (!this.slackOAuthToken && !process.env.SLACK_BOT_USER_OAUTH_TOKEN) {
+            return {
+                okToProceed: false,
+                message: '❌ Neither slackOAuthToken nor process.env.SLACK_BOT_USER_OAUTH_TOKEN were 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.customLayoutAsync
+            && typeof this.customLayoutAsync !== 'function') {
+            return {
+                okToProceed: false,
+                message: '❌ customLayoutAsync 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

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

@@ -1,87 +1,87 @@
-"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',
+"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 `,
-            },
-        },
-        {
-            type: 'divider',
-        },
-        ...fails,
-    ];
-};
-exports.default = generateCustomLayout;
+        \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 `,
+            },
+        },
+        {
+            type: 'divider',
+        },
+        ...fails,
+    ];
+};
+exports.default = generateCustomLayout;

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

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

@@ -1,16 +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;
+"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

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

@@ -1,30 +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;
+"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

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

package/dist/src/index.js

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