playwright-slack-report 1.0.4 → 1.0.8

package/README.md

@@ -4,7 +4,7 @@
 
 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)
+![Gif](https://github.com/ryanrosello-og/playwright-slack-report/blob/main/assets/2022-08-15_20-22-59.png?raw=true)
 
 ## 🚀 Features
 

package/dist/src/LayoutGenerator.js

@@ -5,15 +5,18 @@ const generateBlocks = async (summaryResults) => {
     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: `: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`
-                : ''}`,
+            text: `✅ *${summaryResults.passed}* | ❌ *${summaryResults.failed}* | ⏩ *${summaryResults.skipped}*`,
         },
     };
     for (let i = 0; i < summaryResults.failures.length; i += 1) {
@@ -55,6 +58,7 @@ const generateBlocks = async (summaryResults) => {
         }
     }
     return [
+        header,
         summary,
         ...meta,
         {

package/dist/src/ResultsParser.d.ts

@@ -8,7 +8,7 @@ export declare type testResult = {
     reason: string;
     retry: number;
     startedAt: string;
-    status: 'failed' | 'passed' | 'skipped' | 'aborted';
+    status: 'passed' | 'failed' | 'timedOut' | 'skipped';
     attachments?: {
         body: string | undefined | Buffer;
         contentType: string;
@@ -32,6 +32,12 @@ export default class ResultsParser {
         testSuite: any;
     }): void;
     addTestResult(suiteName: any, test: any): void;
-    parseTests(suiteName: any, tests: any): Promise<testResult[]>;
+    safelyDetermineFailure(result: {
+        errors: any[];
+        error: {
+            message: string;
+            stack: string;
+        };
+    }): string;
     cleanseReason(rawReaseon: string): string;
 }

package/dist/src/ResultsParser.js

@@ -14,7 +14,6 @@ class ResultsParser {
             passed: 0,
             failed: 0,
             skipped: 0,
-            aborted: 0,
             failures: await this.getFailures(),
             tests: [],
         };
@@ -24,15 +23,12 @@ class ResultsParser {
                 if (test.status === 'passed') {
                     summary.passed += 1;
                 }
-                else if (test.status === 'failed') {
+                else if (test.status === 'failed' || test.status === 'timedOut') {
                     summary.failed += 1;
                 }
                 else if (test.status === 'skipped') {
                     summary.skipped += 1;
                 }
-                else if (test.status === 'aborted') {
-                    summary.aborted += 1;
-                }
             }
         }
         return summary;
@@ -41,7 +37,7 @@ class ResultsParser {
         const failures = [];
         for (const suite of this.result) {
             for (const test of suite.testSuite.tests) {
-                if (test.status === 'failed') {
+                if (test.status === 'failed' || test.status === 'timedOut') {
                     failures.push({
                         test: test.name,
                         failureReason: test.reason,
@@ -66,7 +62,7 @@ class ResultsParser {
                 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)}`,
+                reason: this.safelyDetermineFailure(result),
                 attachments: result.attachments,
             });
         }
@@ -77,23 +73,12 @@ class ResultsParser {
             },
         });
     }
-    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,
-                });
-            }
+    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 testResults;
+        return `${this.cleanseReason(result.error?.message)} \n ${this.cleanseReason(result.error?.stack)}`;
     }
     cleanseReason(rawReaseon) {
         // eslint-disable-next-line prefer-regex-literals

package/dist/src/custom_block/my_block.js

@@ -75,9 +75,7 @@ const generateCustomLayout = (summaryResults) => {
                 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`
-                    : ''}`,
+                    : ''} \n\n `,
             },
         },
         {

package/dist/src/index.d.ts

@@ -3,7 +3,6 @@ export declare type SummaryResults = {
     passed: number;
     failed: number;
     skipped: number;
-    aborted: number;
     failures: Array<failure>;
     meta?: Array<{
         key: string;
@@ -17,7 +16,7 @@ export declare type SummaryResults = {
         reason: string;
         retry: number;
         startedAt: string;
-        status: 'failed' | 'passed' | 'skipped' | 'aborted';
+        status: 'passed' | 'failed' | 'timedOut' | 'skipped';
         attachments?: {
             body: string | undefined | Buffer;
             contentType: string;

package/package.json

@@ -1,13 +1,13 @@
 {
   "dependencies": {
+    "@slack/web-api": "^6.7.2"
+  },
+  "devDependencies": {
     "@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": {
+    "@slack/types": "^2.7.0",
     "@typescript-eslint/eslint-plugin": "^5.30.6",
     "@typescript-eslint/parser": "^5.30.6",
     "eslint": "^7.32.0 || ^8.2.0",
@@ -28,7 +28,7 @@
     "lint":"npx eslint . --ext .ts"
   },
   "name": "playwright-slack-report",
-  "version": "1.0.4",
+  "version": "1.0.8",
   "main": "index.js",
   "types": "dist/index.d.ts",
   "repository": "git@github.com:ryanrosello-og/playwright-slack-report.git",