playwright-slack-report-burak 1.2.2 → 1.2.4

package/dist/src/LayoutGenerator.d.ts

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

package/dist/src/LayoutGenerator.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateFailures = exports.generateSkippers = exports.generateBlocks = void 0;
+exports.generateFailures = exports.generateFailuresReasons = exports.generateBlocks = void 0;
 const generateBlocks = async (summaryResults, maxNumberOfFailures) => {
     const meta = [];
     const header = {
@@ -35,34 +35,189 @@ const generateBlocks = async (summaryResults, maxNumberOfFailures) => {
     return [header, summary, ...meta, ...fails];
 };
 exports.generateBlocks = generateBlocks;
-const generateFailures = async (summaryResults, maxNumberOfFailures) => {
-    const maxNumberOfFailureLength = 650;
-    const fails = [];
-    const numberOfFailuresToShow = Math.min(summaryResults.failures.length, maxNumberOfFailures);
-    for (let i = 0; i < numberOfFailuresToShow; i += 1) {
-        const { failureReason, test } = summaryResults.failures[i];
-        const formattedFailure = failureReason
-            .substring(0, maxNumberOfFailureLength)
-            .split('\n')[0];
-        fails.push({
-            type: 'section',
-            text: {
-                type: 'mrkdwn',
-                text: `*${test.split(' [')[0]}*\n${formattedFailure}`,
-            },
-        });
+
+/*
+    Currently unused but can be used to move failed test name list from main
+    message to thread when there are too many for the main message.
+*/
+const generateFailures = async (summaryResults) => {
+    const thread = [];
+    const failedNamesTitle = [];
+    const skippedNamesTitle = [];
+    const failsList = [];
+    const skipsList = [];
+    let previousTestName = undefined;
+    let previousSuiteName = undefined;
+
+    //  Create a list for names of failed test cases
+    for (const result of summaryResults.tests) {
+        if (result.status === 'failed' || result.status === 'timedOut') {
+            const testName = result.name;
+            const suiteName = result.suiteName;
+            const parts = result.suiteName.split('/')[result.suiteName.split('/').length-1].replace('.spec.ts', '');
+            const backSlashedParts = parts.split('\\')[parts.split('\\').length-1];
+            if (testName !== previousTestName || (testName === previousSuiteName && suiteName !== previousSuiteName) ) {
+                failsList.push(testName + ' (' + backSlashedParts + ')');
+                previousTestName = testName;
+                previousSuiteName = suiteName;
+            }
+        }
+    }
+    previousTestName = undefined;
+    previousSuiteName = undefined;
+
+    //  Create a list for names of skipped test cases
+    for (const result of summaryResults.tests) {
+        if (result.status === 'skipped') {
+            const testName = result.name;
+            const suiteName = result.suiteName;
+            const parts = result.suiteName.split('/')[result.suiteName.split('/').length-1].replace('.spec.ts', '');
+            const backSlashedParts = parts.split('\\')[parts.split('\\').length-1];
+            if (testName !== previousTestName || (testName === previousSuiteName && suiteName !== previousSuiteName) ) {
+                skipsList.push(testName + ' (' + backSlashedParts + ')');
+                previousTestName = testName;
+                previousSuiteName = suiteName;
+            }
+        }
+    }
+    previousTestName = undefined;
+    previousSuiteName = undefined;
+
+    //  Decide on Titles For Listing Failures & Skips
+    if (summaryResults.failed === 1) {
+        failedNamesTitle[0] = '\n*Failed Test Case:*\n';
+    }
+    if (summaryResults.failed > 1) {
+        failedNamesTitle[0] = '\n*Failed Test Cases:*\n';
+    }
+    if (summaryResults.skipped === 1) {
+        skippedNamesTitle[0] = '\n*Skipped Test Case:*\n';
+    }
+    if (summaryResults.skipped > 1) {
+        skippedNamesTitle[0] = '\n*Skipped Test Cases:*\n';
+    }
+
+    thread.push({
+        type: 'section',
+        text: {
+            type: 'mrkdwn',
+            text: `${failedNamesTitle}${failsList.map((value, index) => `*${index + 1}.* ${value}`).join('\n')}` +  // List of Failed Test Cases
+            `\n${skippedNamesTitle}${skipsList.map((value, index) => `*${index + 1}.* ${value}`).join('\n')} `, // List of Skipped Test Cases
+        },
+    })
+    return [
+        ...thread,
+    ];
+};
+
+const generateFailuresReasons = async (summaryResults) => {
+    const failedNamesTitle = [];
+    const failsList = [];
+
+    for (let i = 0; i <= summaryResults.failures.length; i += 1) {
+        if (summaryResults.failures.length <=3) {
+            if (i === summaryResults.failures.length) {
+                break;
+            }
+            const { failureReason, test, suiteName } = summaryResults.failures[i];
+            const parts = suiteName.split('/')[suiteName.split('/').length-1].replace('.spec.ts', '');
+            const backSlashedParts = parts.split('\\')[parts.split('\\').length-1];
+            failsList.push({
+                type: 'section',
+                text: {
+                    type: 'mrkdwn',
+                    text: `${i+1}. ${test.split(' [')[0]} (${backSlashedParts})\n\`\`\`${failureReason}\`\`\``,
+                },
+            });
+        } else if (3 < summaryResults.failures.length < 25) {
+            const { failureReason, test, suiteName } = summaryResults.failures[i];
+            const parts = suiteName.split('/')[suiteName.split('/').length-1].replace('.spec.ts', '');
+            const backSlashedParts = parts.split('\\')[parts.split('\\').length-1];
+            failsList.push({
+                type: 'section',
+                text: {
+                    type: 'mrkdwn',
+                    text: `${i+1}. ${test.split(' [')[0]} (${backSlashedParts})\n\`\`\`${failureReason.split('\n')[0]}\`\`\``,
+                },
+            });
+            if (i === summaryResults.failures.length) {
+                fails.push({
+                    type: 'section',
+                    text: {
+                        type: 'mrkdwn',
+                        text: '⚠️ *There are too many failures to display in full detail. '+
+                            'You can view more on CircleCI* ⚠️',
+                    },
+                },
+                {
+                type: 'actions',
+                elements: [
+                    {
+                        type: 'button',
+                        text: {
+                            type: 'plain_text',
+                            text: 'Go to Build Details'
+                        },
+                        url: process.env.CIRCLE_BUILD_URL
+                    }
+                ]
+                });
+            }
+        } else if (summaryResults.failures.length >= 25) {
+            const { failureReason, test, suiteName } = summaryResults.failures[i];
+            const parts = suiteName.split('/')[suiteName.split('/').length-1].replace('.spec.ts', '');
+            const backSlashedParts = parts.split('\\')[parts.split('\\').length-1];
+            failsList.push({
+                type: 'section',
+                text: {
+                    type: 'mrkdwn',
+                    text: `${i+1}. ${test.split(' [')[0]} (${backSlashedParts})\n\`\`\`${failureReason.split('\n')[0]}\`\`\``,
+                },
+            });
+            if (i > 24) {
+            fails.push({
+                    type: 'section',
+                    text: {
+                        type: 'mrkdwn',
+                        text: '⚠️ *There are too many failures to display here '+
+                            'You can view more on CircleCI* ⚠️',
+                    },
+                },
+                {
+                type: 'actions',
+                elements: [
+                    {
+                        type: 'button',
+                        text: {
+                            type: 'plain_text',
+                            text: 'Go to Build Details'
+                        },
+                        url: process.env.CIRCLE_BUILD_URL
+                    }
+                ]
+            });
+        }
+        }
     }
-    if (summaryResults.failures.length > 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*`,
-            },
-        });
+
+    //  Decide on Titles For Listing Failures & Skips
+    if (summaryResults.failed === 1) {
+        failedNamesTitle[0] = '\n*Failure Reason:*\n';
     }
+    if (summaryResults.failed > 1) {
+        failedNamesTitle[0] = '\n*Failure Reasons:*\n';
+    }
+
+    failsList.unshift({
+        type: 'section',
+        text: {
+            type: 'mrkdwn',
+            text: `${failedNamesTitle}`
+        },
+    })
     return [
-        ...fails,
+        ...failsList,
     ];
 };
-exports.generateFailures = generateFailures;
+exports.generateFailures = generateFailures;
+exports.generateFailuresReasons = generateFailuresReasons;

package/dist/src/ResultsParser.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { failure, flaky, pass, skipper, SummaryResults } from '.';
+import { failure, flaky, pass, SummaryResults } from '.';
 export declare type testResult = {
     suiteName: string;
     name: string;
@@ -35,8 +35,7 @@ export default class ResultsParser {
     getFailures(): Promise<Array<failure>>;
     getFlakes(): Promise<Array<flaky>>;
     getPasses(): Promise<Array<pass>>;
-    getSkippers(): Promise<Array<skipper>>;
-    static getTestName(failedTest: any): any;
+        static getTestName(failedTest: any): any;
     updateResults(data: {
         testSuite: any;
     }): void;

package/dist/src/ResultsParser.js

@@ -17,7 +17,6 @@ class ResultsParser {
         const failures = await this.getFailures();
         const flakes = await this.getFlakes();
         let passes = await this.getPasses();
-        const skippers = await this.getSkippers();
         /*if (this.separateFlakyTests) {
             passes = this.doSeparateFlakyTests(passes, flakes);
         }*/
@@ -26,16 +25,16 @@ class ResultsParser {
             failed: failures.length,
             flaky: (this.separateFlakyTests && flakes.length > 0) ?
                 flakes.length : 0,
-            skipped: skippers.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 === 'skipped') {
+                if (test.status === 'skipped') {
                     summary.skipped += 1;
-                }*/
+                }
             }
         }
         return summary;
@@ -63,7 +62,7 @@ class ResultsParser {
         const flaky = [];
         for (const suite of this.result) {
             for (const test of suite.testSuite.tests) {
-                if (test.status === 'passed' && test.retry > 0) {
+                if (this.separateFlakyTests && test.status === 'passed' && test.retry > 0) {
                     flaky.push({
                         test: ResultsParser.getTestName(test),
                         retry: test.retry,
@@ -77,31 +76,23 @@ class ResultsParser {
         const passes = [];
         for (const suite of this.result) {
             for (const test of suite.testSuite.tests) {
-                if (test.status === 'passed' && test.retry === 0) {
-                    passes.push({
-                        test: ResultsParser.getTestName(test),
-                    });
+                if (this.separateFlakyTests) {
+                    if (test.status === 'passed' && test.retry === 0) {
+                        passes.push({
+                            test: ResultsParser.getTestName(test),
+                        });
+                    }
+                } else {
+                    if (test.status === 'passed') {
+                        passes.push({
+                            test: ResultsParser.getTestName(test),
+                        });
+                    }
                 }
             }
         }
         return passes;
     }
-
-    async getSkippers() {
-        const skippers = [];
-        for (const suite of this.result) {
-            for (const test of suite.testSuite.tests) {
-                if (test.status === 'skipped') {
-                    skippers.push({
-                        test: ResultsParser.getTestName(test),
-                    });
-                }
-            }
-        }
-        return skippers;
-    }
-
-
     static getTestName(failedTest) {
         const testName = failedTest.name;
         if (failedTest.browser && failedTest.projectName) {
@@ -176,7 +167,9 @@ class ResultsParser {
     }
     /** removes tests from the passed array that only passed on a retry (flaky).
      * Does not modify param passed, returns a new passed array. */
-    doSeparateFlakyTests(passes, flakes) {
+    /** Cuurently unused. Instead, we check the seperateflaky flag while
+     * passed array. */
+    /*doSeparateFlakyTests(passes, flakes) {
         const _passes = new Map();
         for (const pass of passes) {
             _passes.set(pass.test, pass);
@@ -185,6 +178,6 @@ class ResultsParser {
             _passes.delete(flake.test);
         }
         return [..._passes.values()];
-    }
+    }*/
 }
 exports.default = ResultsParser;

package/dist/src/SlackClient.d.ts

@@ -33,5 +33,13 @@ export default class SlackClient {
         disableUnfurl?: boolean;
         fakeRequest?: Function;
     }): Promise<any[]>;
+attachDetailsToThreadReasons({ channelIds, ts, summaryResults, maxNumberOfFailures, disableUnfurl, fakeRequest, }: {
+        channelIds: Array<string>;
+        ts: string;
+        summaryResults: SummaryResults;
+        maxNumberOfFailures: number;
+        disableUnfurl?: boolean;
+        fakeRequest?: Function;
+    }): Promise<any[]>;
     static doPostRequest(slackWebClient: WebClient, channel: string, blocks: Array<KnownBlock | Block>, unfurl: boolean, threadTimestamp?: string): Promise<ChatPostMessageResponse>;
 }

package/dist/src/SlackClient.js

@@ -87,6 +87,30 @@ class SlackClient {
         }
         return result;
     }
+async attachDetailsToThreadReasons({ channelIds, ts, summaryResults, maxNumberOfFailures, disableUnfurl, fakeRequest, }) {
+        const result = [];
+        const blocks = await (0, LayoutGenerator_1.generateFailuresReasons)(summaryResults, maxNumberOfFailures);
+        for (const channel of channelIds) {
+            // under test
+            let chatResponse;
+            if (fakeRequest) {
+                chatResponse = await fakeRequest();
+            }
+            else {
+                chatResponse = await SlackClient.doPostRequest(this.slackWebClient, channel, blocks, disableUnfurl, ts);
+            }
+            if (chatResponse.ok) {
+                // eslint-disable-next-line no-console
+                console.log(`✅ Message sent to ${channel} within thread ${ts}`);
+                result.push({
+                    channel,
+                    outcome: `✅ Message sent to ${channel} within thread ${ts}`,
+                    ts: chatResponse.ts,
+                });
+            }
+        }
+        return result;
+    }
     static async doPostRequest(slackWebClient, channel, blocks, unfurl, threadTimestamp) {
         const chatResponse = await slackWebClient.chat.postMessage({
             channel,

package/dist/src/SlackReporter.js

@@ -111,8 +111,8 @@ class SlackReporter {
             });
             // eslint-disable-next-line no-console
             console.log(JSON.stringify(result, null, 2));
-            if (this.showInThread && resultSummary.failures.length > 0) {
-                for (let i = 0; i < result.length; i += 1) {
+            if (this.showInThread && (resultSummary.failures.length > 0 || resultSummary.skipped > 0)) {
+                /*  for (let i = 0; i < result.length; i += 1) {
                     // eslint-disable-next-line no-await-in-loop
                     await slackClient.attachDetailsToThread({
                         channelIds: [result[i].channel],
@@ -120,6 +120,15 @@ class SlackReporter {
                         summaryResults: resultSummary,
                         maxNumberOfFailures: this.maxNumberOfFailuresToShow,
                     });
+}*/
+                for (let i = 0; i < result.length; i += 1) {
+                    // eslint-disable-next-line no-await-in-loop
+                    await slackClient.attachDetailsToThreadReasons({
+                        channelIds: [result[i].channel],
+                        ts: result[i].ts,
+                        summaryResults: resultSummary,
+                        maxNumberOfFailures: this.maxNumberOfFailuresToShow,
+                    });
                 }
             }
         }

package/dist/src/index.d.ts

@@ -2,11 +2,9 @@
 export declare type SummaryResults = {
     passed: number;
     failed: number;
-    flaky: number | undefined;
+    flaky: number;
     skipped: number;
     failures: Array<failure>;
-    skippers: Array<skipper>;
-    flakers: Array<flaker>;
     meta?: Array<{
         key: string;
         value: string;
@@ -32,23 +30,13 @@ export declare type SummaryResults = {
 export declare type failure = {
     test: string;
     failureReason: string;
+    retries: number;
+    suiteName: string;
 };
-
-export declare type skipper = {
-  test: string;
-  skipperReason: string;
-};
-
-export declare type flaker = {
-  test: string;
-  flakerReason: string;
-};
-
 export declare type flaky = {
     test: string;
     retry: number;
 };
-
 export declare type pass = {
     test: string;
 };

package/package.json

@@ -30,7 +30,7 @@
     "lint-fix": "npx eslint . --ext .ts --fix"
   },
   "name": "playwright-slack-report-burak",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "main": "index.js",
   "types": "dist/index.d.ts",
   "repository": "git@github.com:ryanrosello-og/playwright-slack-report.git",