Merge pull request #18 from estruyf/dev

Hide passing tests from the reporter #17

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.9.0]
+
+- [#17](https://github.com/estruyf/playwright-github-actions-reporter/issues/17): Added the ability to define which types of test results should be shown in the summary
+
 ## [1.8.0]
 
 - Added `⏭️` icon for skipped tests

README.md

@@ -38,16 +38,18 @@ The reporter supports the following configuration options:
 | showAnnotations | Show annotations from tests | `true` |
 | showTags | Show tags from tests | `true` |
 | showError | Show error message in summary | `false` |
+| includeResults | Define which types of test results should be shown in the summary | `['pass', 'skipped', 'fail', 'flaky']` |
 | quiet | Do not show any output in the console | `false` |
 
 To use these option, you can update the reporter configuration:
 
 ```ts
 import { defineConfig } from '@playwright/test';
+import type { GitHubActionOptions } from '@estruyf/github-actions-reporter';
 
 export default defineConfig({
   reporter: [
-    ['@estruyf/github-actions-reporter', {
+    ['@estruyf/github-actions-reporter', <GitHubActionOptions>{
       title: 'My custom title',
       useDetails: true,
       showError: true

package.json

@@ -1,13 +1,12 @@
 {
   "name": "@estruyf/github-actions-reporter",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "GitHub Actions reporter for Playwright",
   "main": "dist/index.js",
   "scripts": {
     "build": "tsc",
     "watch": "tsc -w",
     "test": "NODE_ENV=development npx playwright test",
-    "test:local": "act -j testing -P ubuntu-latest=catthehacker/ubuntu:act-latest --container-architecture linux/amd64 --env GITHUB_STEP_SUMMARY='/dev/stdout'",
     "test:jest": "jest --coverage --coverageDirectory=../coverage"
   },
   "author": "Elio Struyf <[email protected]>",

playwright.config.ts

@@ -1,3 +1,4 @@
+import type { GitHubActionOptions } from "./src/models/GitHubActionOptions";
 import { PlaywrightTestConfig, defineConfig, devices } from "@playwright/test";
 
 const config: PlaywrightTestConfig<{}, {}> = {
@@ -14,14 +15,33 @@ const config: PlaywrightTestConfig<{}, {}> = {
     // ["list"],
     [
       "./src/index.ts",
-      {
-        title: "Reporter testing",
+      <GitHubActionOptions>{
+        title: "Reporter (details: false, report: fail, flaky, skipped)",
         useDetails: false,
         showError: true,
         quiet: false,
+        includeResults: ["fail", "flaky", "skipped"],
+      },
+    ],
+    [
+      "./src/index.ts",
+      <GitHubActionOptions>{
+        title: "Reporter (details: false, report: pass, skipped)",
+        useDetails: false,
+        showError: true,
+        quiet: false,
+        includeResults: ["pass", "skipped"],
+      },
+    ],
+    [
+      "./src/index.ts",
+      <GitHubActionOptions>{
+        title: "Reporter (details: true, report: fail, flaky, skipped)",
+        useDetails: true,
+        quiet: true,
+        includeResults: ["fail", "flaky", "skipped"],
       },
     ],
-    ["./src/index.ts", { useDetails: true, quiet: true }],
   ],
   use: {
     actionTimeout: 0,

src/index.ts

@@ -8,15 +8,7 @@ import type {
   TestResult,
 } from "@playwright/test/reporter";
 import { processResults } from "./utils/processResults";
-
-export interface GitHubActionOptions {
-  title?: string;
-  useDetails?: boolean;
-  showAnnotations: boolean;
-  showTags: boolean;
-  showError?: boolean;
-  quiet?: boolean;
-}
+import { GitHubActionOptions } from "./models";
 
 class GitHubAction implements Reporter {
   private suite: Suite | undefined;
@@ -39,6 +31,10 @@ class GitHubAction implements Reporter {
       this.options.showTags = true;
     }
 
+    if (typeof options.includeResults === "undefined") {
+      this.options.includeResults = ["fail", "flaky", "pass", "skipped"];
+    }
+
     if (process.env.NODE_ENV === "development") {
       console.log(`Using development mode`);
       console.log(`Options: ${JSON.stringify(this.options, null, 2)}`);

src/models/DisplayLevel.ts

@@ -0,0 +1 @@
+export type DisplayLevel = "pass" | "skipped" | "fail" | "flaky";

src/models/GitHubActionOptions.ts

@@ -0,0 +1,11 @@
+import { DisplayLevel } from ".";
+
+export interface GitHubActionOptions {
+  title?: string;
+  useDetails?: boolean;
+  showAnnotations: boolean;
+  showTags: boolean;
+  showError?: boolean;
+  quiet?: boolean;
+  includeResults?: DisplayLevel[];
+}

src/models/index.ts

@@ -0,0 +1,2 @@
+export * from "./DisplayLevel";
+export * from "./GitHubActionOptions";

src/utils/getHtmlTable.test.ts

@@ -1,5 +1,13 @@
+import { DisplayLevel } from "../models";
 import { getHtmlTable } from "./getHtmlTable";
 
+const defaultDisplayLevel: DisplayLevel[] = [
+  "pass",
+  "fail",
+  "flaky",
+  "skipped",
+];
+
 describe("getHtmlTable", () => {
   it("should return the HTML table with error column", async () => {
     const tests: any = [
@@ -46,7 +54,13 @@ describe("getHtmlTable", () => {
       },
     ];
 
-    const result = await getHtmlTable(tests, false, false, true);
+    const result = await getHtmlTable(
+      tests,
+      false,
+      false,
+      true,
+      defaultDisplayLevel
+    );
 
     const expected = `
 <br>
@@ -86,11 +100,59 @@ describe("getHtmlTable", () => {
 </table>
 `;
 
-    expect(result.trim()).toEqual(expected.trim());
+    expect(result?.trim()).toEqual(expected.trim());
   });
 
-  it("should return an empty HTML table if tests is empty (without error column)", async () => {
-    const result = await getHtmlTable([], false, false, false);
+  it("should return the HTML table with error column (excluding passed tests)", async () => {
+    const tests: any = [
+      {
+        title: "Test 1",
+        results: [
+          {
+            status: "passed",
+            duration: 1000,
+            retry: 0,
+            error: null,
+          },
+        ],
+        parent: {
+          title: "Parent Title",
+        },
+      },
+      {
+        title: "Test 2",
+        results: [
+          {
+            status: "failed",
+            duration: 2000,
+            retry: 1,
+            error: {
+              message: "Test failed",
+            },
+          },
+        ],
+        parent: null,
+      },
+      {
+        title: "Test 3",
+        results: [
+          {
+            status: "failed",
+            duration: null,
+            retry: null,
+            error: {
+              message: "Test failed",
+            },
+          },
+        ],
+      },
+    ];
+
+    const result = await getHtmlTable(tests, false, false, true, [
+      "fail",
+      "flaky",
+      "skipped",
+    ]);
 
     const expected = `
 <br>
@@ -101,37 +163,53 @@ describe("getHtmlTable", () => {
 <th>Status</th>
 <th>Duration</th>
 <th>Retries</th>
+<th>Error</th>
 </tr>
 </thead>
 <tbody>
+<tr>
+<td>Test 2</td>
+<td>❌ Fail</td>
+<td>2s</td>
+<td>1</td>
+<td>Test failed</td>
+</tr>
+<tr>
+<td>Test 3</td>
+<td>❌ Fail</td>
+<td></td>
+<td></td>
+<td>Test failed</td>
+</tr>
 </tbody>
 </table>
 `;
 
-    expect(result.trim()).toEqual(expected.trim());
+    expect(result?.trim()).toEqual(expected.trim());
   });
 
-  it("should return an empty HTML table if tests is empty (including error column)", async () => {
-    const result = await getHtmlTable([], false, false, true);
+  it("should not return a table when no tests are provided (without error column)", async () => {
+    const result = await getHtmlTable(
+      [],
+      false,
+      false,
+      false,
+      defaultDisplayLevel
+    );
 
-    const expected = `
-<br>
-<table role="table">
-<thead>
-<tr>
-<th>Test</th>
-<th>Status</th>
-<th>Duration</th>
-<th>Retries</th>
-<th>Error</th>
-</tr>
-</thead>
-<tbody>
-</tbody>
-</table>
-`;
+    expect(result).toBeUndefined();
+  });
+
+  it("should not return a table when no tests are provided (including error column)", async () => {
+    const result = await getHtmlTable(
+      [],
+      false,
+      false,
+      true,
+      defaultDisplayLevel
+    );
 
-    expect(result.trim()).toEqual(expected.trim());
+    expect(result).toBeUndefined();
   });
 
   it("should return the HTML table with annotations row", async () => {
@@ -158,7 +236,13 @@ describe("getHtmlTable", () => {
       },
     ];
 
-    const result = await getHtmlTable(tests, true, false, false);
+    const result = await getHtmlTable(
+      tests,
+      true,
+      false,
+      false,
+      defaultDisplayLevel
+    );
 
     const expected = `
 <br>
@@ -184,7 +268,7 @@ describe("getHtmlTable", () => {
 </tbody>
 </table>`;
 
-    expect(result.trim()).toEqual(expected.trim());
+    expect(result?.trim()).toEqual(expected.trim());
   });
 
   it("should return the HTML table with annotations and tags columns", async () => {
@@ -226,7 +310,13 @@ describe("getHtmlTable", () => {
       },
     ];
 
-    const result = await getHtmlTable(tests, true, true, true);
+    const result = await getHtmlTable(
+      tests,
+      true,
+      true,
+      true,
+      defaultDisplayLevel
+    );
 
     const expected = `
 <br>
@@ -264,6 +354,6 @@ describe("getHtmlTable", () => {
 </tbody>
 </table>`;
 
-    expect(result.trim()).toEqual(expected.trim());
+    expect(result?.trim()).toEqual(expected.trim());
   });
 });