Added show error option

Author: estruyf

CHANGELOG.md

@@ -8,6 +8,7 @@ All notable changes to this project will be documented in this file.
 - Added OS name
 - Added browser/project name
 - Added retries count
+- Added `showError` option
 
 ## [1.0.0]
 

README.md

@@ -35,6 +35,7 @@ The reporter supports the following configuration options:
 | --- | --- | --- |
 | title | Title of the report | `Test results` |
 | useDetails | Use details in summary which creates expandable content | `false` |
+| showError | Show error message in summary | `false` |
 
 To use these option, you can update the reporter configuration:
 
@@ -45,7 +46,8 @@ export default defineConfig({
   reporter: [
     ['@estruyf/github-actions-reporter', {
       title: 'My custom title',
-      useDetails: true
+      useDetails: true,
+      showError: true
     }]
   ],
 });

playwright.config.ts

@@ -11,7 +11,7 @@ const config: PlaywrightTestConfig<{}, {}> = {
   retries: process.env.CI ? 2 : 1,
   workers: process.env.CI ? 1 : undefined,
   reporter: [
-    ["./src/index.ts", { title: "Reporter testing" }],
+    ["./src/index.ts", { title: "Reporter testing", showError: true }],
     [
       "./src/index.ts",
       { title: "Reporter testing with details", useDetails: true },

src/index.ts

@@ -15,6 +15,7 @@ import Convert from "ansi-to-html";
 interface GitHubActionOptions {
   title?: string;
   useDetails?: boolean;
+  showError?: boolean;
 }
 
 class GitHubAction implements Reporter {
@@ -68,7 +69,10 @@ class GitHubAction implements Reporter {
           const fileName = basename(filePath);
 
           if (this.options.useDetails) {
-            const content = getHtmlTable(tests[filePath]);
+            const content = getHtmlTable(
+              tests[filePath],
+              !!this.options.showError
+            );
 
             // Check if there are any failed tests
             const hasFailedTests = checkForFailedTests(tests[filePath]);
@@ -87,7 +91,10 @@ class GitHubAction implements Reporter {
               2
             );
 
-            const tableRows = getTableRows(tests[filePath]);
+            const tableRows = getTableRows(
+              tests[filePath],
+              !!this.options.showError
+            );
             summary.addTable(tableRows);
           }
         }

src/utils/getHtmlTable.ts

@@ -1,7 +1,7 @@
 import { TestCase } from "@playwright/test/reporter";
 import Convert from "ansi-to-html";
 
-export const getHtmlTable = (tests: TestCase[]): string => {
+export const getHtmlTable = (tests: TestCase[], showError: boolean): string => {
   const convert = new Convert();
 
   const content: string[] = [];
@@ -14,7 +14,9 @@ export const getHtmlTable = (tests: TestCase[]): string => {
   content.push(`<th>Status</th>`);
   content.push(`<th>Duration</th>`);
   content.push(`<th>Retries</th>`);
-  content.push(`<th>Error</th>`);
+  if (showError) {
+    content.push(`<th>Error</th>`);
+  }
   content.push(`</tr>`);
   content.push(`</thead>`);
   content.push(`<tbody>`);
@@ -30,13 +32,15 @@ export const getHtmlTable = (tests: TestCase[]): string => {
     );
     content.push(`<td>${result.duration / 1000}s</td>`);
     content.push(`<td>${result.retry}</td>`);
-    content.push(
-      `<td>${
-        result.error && result.error.message
-          ? convert.toHtml(result.error.message!)
-          : ""
-      }</td>`
-    );
+    if (showError) {
+      content.push(
+        `<td>${
+          result.error && result.error.message
+            ? convert.toHtml(result.error.message!)
+            : ""
+        }</td>`
+      );
+    }
     content.push(`</tr>`);
   }
 

src/utils/getTableRows.ts

@@ -2,39 +2,45 @@ import { SummaryTableRow } from "@actions/core/lib/summary";
 import { TestCase } from "@playwright/test/reporter";
 import Convert from "ansi-to-html";
 
-export const getTableRows = (tests: TestCase[]): SummaryTableRow[] => {
+export const getTableRows = (
+  tests: TestCase[],
+  showError: boolean
+): SummaryTableRow[] => {
   const convert = new Convert();
 
-  const tableRows = [
-    [
-      {
-        data: "Test",
-        header: true,
-      },
-      {
-        data: "Status",
-        header: true,
-      },
-      {
-        data: "Duration",
-        header: true,
-      },
-      {
-        data: "Retries",
-        header: true,
-      },
-      {
-        data: "Error",
-        header: true,
-      },
-    ],
+  const tableHeaders = [
+    {
+      data: "Test",
+      header: true,
+    },
+    {
+      data: "Status",
+      header: true,
+    },
+    {
+      data: "Duration",
+      header: true,
+    },
+    {
+      data: "Retries",
+      header: true,
+    },
   ];
 
+  if (showError) {
+    tableHeaders.push({
+      data: "Error",
+      header: true,
+    });
+  }
+
+  const tableRows = [tableHeaders];
+
   for (const test of tests) {
     // Get the last result
     const result = test.results[test.results.length - 1];
 
-    tableRows.push([
+    const tableRow = [
       {
         data: test.title,
         header: false,
@@ -51,14 +57,19 @@ export const getTableRows = (tests: TestCase[]): SummaryTableRow[] => {
         data: `${result.retry}`,
         header: false,
       },
-      {
+    ];
+
+    if (showError) {
+      tableRow.push({
         data:
           result.error && result.error.message
             ? convert.toHtml(result.error.message!)
             : "",
         header: false,
-      },
-    ]);
+      });
+    }
+
+    tableRows.push(tableRow);
   }
 
   return tableRows;