playwright-slack-report-burak 1.2.6 → 1.3.0

package/dist/src/LayoutGenerator.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateFailures = exports.generateFailuresReasons = exports.generateBlocks = void 0;
+exports.generateFailures = exports.generateFailuresReasons = exports.generateProblemCaseList = exports.generateBlocks = void 0;
 const generateBlocks = async (summaryResults, maxNumberOfFailures) => {
     const meta = [];
     const header = {
@@ -36,10 +36,7 @@ const generateBlocks = async (summaryResults, maxNumberOfFailures) => {
 };
 exports.generateBlocks = generateBlocks;
 
-/*
-    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.
-*/
+//  Became obsolete with the introdıction of generateProblemCaseList()
 const generateFailures = async (summaryResults) => {
     const thread = [];
     const failedNamesTitle = [];
@@ -110,6 +107,185 @@ const generateFailures = async (summaryResults) => {
     ];
 };
 
+const generateProblemCaseList = async (summaryResults) => {
+    const suitesResults = [];
+    const failedSuites = [];
+    const flakySuites = [];
+    const skippedSuites = [];
+    const failsList = [];
+    const flakyList = [];
+    const skipsList = [];
+    const failedSuitesTitle = [];
+    const flakySuitesTitle = [];
+    const skippedSuitesTitle = [];
+    const failedNamesTitle = [];
+    const flakyNamesTitle = [];
+    const skippedNamesTitle = [];
+    let previousTestName = undefined;
+    let previousSuiteName = undefined;
+  
+    //  Create a list for names of test suites with failed test cases
+    for (let i = 0; i < summaryResults.failures.length; i += 1) {
+      const { suiteName } = summaryResults.failures[i];
+      const capitalizedSuiteName = suiteName.charAt(0).toUpperCase() + suiteName.slice(1);
+      const parts = capitalizedSuiteName.split('/')[0];
+      const backSlashedParts = parts.split('\\')[0];
+      if (backSlashedParts !== previousSuiteName) {
+        failedSuites.push(backSlashedParts);
+        previousSuiteName = backSlashedParts;
+      }
+    }
+    previousSuiteName = undefined;
+  
+    //  Create a list for names of test suites with flaky test cases
+    for (const result of summaryResults.tests) {
+      if (result.retry > 0 && result.status === 'passed') {
+        const suiteName = result.suiteName;
+        const capitalizedSuiteName = suiteName.charAt(0).toUpperCase() + suiteName.slice(1);
+        const parts = capitalizedSuiteName.split('/')[0];
+        const backSlashedParts = parts.split('\\')[0];
+        if (backSlashedParts !== previousSuiteName) {
+          flakySuites.push(backSlashedParts);
+          previousSuiteName = backSlashedParts;
+        }
+      }
+    }
+    previousSuiteName = undefined;
+  
+  
+    //  Create a list for names of test suites with skipped test cases
+    for (const result of summaryResults.tests) {
+      if (result.status === 'skipped') {
+        const suiteName = result.suiteName;
+        const capitalizedSuiteName = suiteName.charAt(0).toUpperCase() + suiteName.slice(1);
+        const parts = capitalizedSuiteName.split('/')[0];
+        const backSlashedParts = parts.split('\\')[0];
+        if (backSlashedParts !== previousSuiteName) {
+          skippedSuites.push(backSlashedParts);
+          previousSuiteName = backSlashedParts;
+        }
+      }
+    }
+    previousSuiteName = undefined;
+  
+    //  Create a list for names of failed test cases
+    for (let i = 0; i < summaryResults.failures.length; i += 1) {
+      const { 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(test.split(' [')[0] + ' (_' + backSlashedParts + '_)');
+    }
+  
+    //  Create a list for names of flaky test cases
+    for (const result of summaryResults.tests) {
+      if (result.retry > 0 && result.status === 'passed') {
+        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) ) {
+          flakyList.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 & Flakies
+     if (failedSuites.length === 1) {
+      failedSuitesTitle[0] = '*Failed Suite:*\n';
+    }
+    if (failedSuites.length > 1) {
+      failedSuitesTitle[0] = '*Failed Suites:*\n';
+    }
+     if (flakySuites.length === 1) {
+      flakySuitesTitle[0] = '\n*Flaky Suite:*\n';
+    }
+    if (flakySuites.length > 1) {
+      flakySuitesTitle[0] = '\n*Flaky Suites:*\n';
+    }
+    if (skippedSuites.length === 1) {
+      skippedSuitesTitle[0] = '\n*Skipped Suite:*\n';
+    }
+    if (skippedSuites.length > 1) {
+      skippedSuitesTitle[0] = '\n*Skipped Suites:*\n';
+    }
+    if (summaryResults.failed === 1) {
+      failedNamesTitle[0] = '\n*Failed Test Case:*\n';
+    }
+    if (summaryResults.failed > 1) {
+      failedNamesTitle[0] = '\n*Failed Test Cases:*\n';
+    }
+    if (summaryResults.flaky === 1) {
+      flakyNamesTitle[0] = '\n*Flaky Test Case:*\n';
+    }
+    if (summaryResults.flaky > 1) {
+      flakyNamesTitle[0] = '\n*Flaky 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';
+    }
+  
+    //  Push data into array to create the "List of Problematic Test Suites"
+    if (summaryResults.tests.length !== summaryResults.passed){
+      suitesResults.push({
+        type: 'section',
+        text: {
+          type: 'mrkdwn',
+          text:
+          `${failedSuitesTitle}${failedSuites.map((value, index) => `*${index + 1}.* ${value}`).join('\n')}` +
+          `\n${flakySuitesTitle}${flakySuites.map((value, index) => `*${index + 1}.* ${value}`).join('\n')}` +
+          `\n${skippedSuitesTitle}${skippedSuites.map((value, index) => `*${index + 1}.* ${value}`).join('\n')} `,
+        },
+      },
+      {
+          type: 'section',
+          text: {
+              type: 'mrkdwn',
+              text:
+              `\n${failedNamesTitle}${failsList.map((value, index) => `*${index + 1}.* ${value}`).join('\n')}` +  // List of Failed Test Cases
+              `\n${flakyNamesTitle}${flakyList.map((value, index) => `*${index + 1}.* ${value}`).join('\n')}` +  // List of Flaky Test Cases
+              `\n${skippedNamesTitle}${skipsList.map((value, index) => `*${index + 1}.* ${value}`).join('\n')} `, // List of Skipped Test Cases
+          },
+      },
+      {
+        type: 'section',
+        text: {
+          type: 'mrkdwn',
+          text: ` `,
+        },
+      },
+      {
+        type: 'divider',
+      },
+    )}
+    return [
+        ...suitesResults,
+    ];
+};
+
 const generateFailuresReasons = async (summaryResults) => {
     const failedNamesTitle = [];
     const failsList = [];
@@ -231,3 +407,4 @@ const generateFailuresReasons = async (summaryResults) => {
 };
 exports.generateFailures = generateFailures;
 exports.generateFailuresReasons = generateFailuresReasons;
+exports.generateProblemCaseList = generateProblemCaseList;

package/dist/src/SlackClient.js

@@ -87,7 +87,31 @@ class SlackClient {
         }
         return result;
     }
-async attachDetailsToThreadReasons({ channelIds, ts, summaryResults, maxNumberOfFailures, disableUnfurl, fakeRequest, }) {
+    async attachDetailsToThreadCases({ channelIds, ts, summaryResults, maxNumberOfFailures, disableUnfurl, fakeRequest, }) {
+        const result = [];
+        const blocks = await (0, LayoutGenerator_1.generateProblemCaseList)(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;
+    }
+    async attachDetailsToThreadReasons({ channelIds, ts, summaryResults, maxNumberOfFailures, disableUnfurl, fakeRequest, }) {
         const result = [];
         const blocks = await (0, LayoutGenerator_1.generateFailuresReasons)(summaryResults, maxNumberOfFailures);
         for (const channel of channelIds) {

package/dist/src/SlackReporter.js

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

package/package.json

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