Merge pull request #3 from estruyf/dev

estruyf · web-flow · commit ed0fcc077418 · 2023-09-12T15:04:06.000+02:00
diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml
@@ -23,7 +23,7 @@ jobs:
         run: npm ci
 
       - name: Install Playwright Browsers
-        run: npx playwright install --with-deps
+        run: npx playwright install --with-deps chromium
 
       - name: Run Playwright tests
         run: npx playwright test
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@
 dist
 node_modules
 test-results
+summary.html
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.3.0]
+
+- Added warning test icon
+- Added `skipped` status
+
 ## [1.2.0]
 
 - Show console logging
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,12 +1,13 @@
 {
   "name": "@estruyf/github-actions-reporter",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "GitHub Actions reporter for Playwright",
   "main": "dist/index.js",
   "scripts": {
     "build": "tsc",
     "watch": "tsc -w",
-    "test": "npx playwright test"
+    "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'"
   },
   "author": "Elio Struyf <elio@struyfconsulting.be>",
   "license": "MIT",
diff --git a/playwright.config.ts b/playwright.config.ts
@@ -8,8 +8,8 @@ const config: PlaywrightTestConfig<{}, {}> = {
   },
   fullyParallel: false,
   forbidOnly: !!process.env.CI,
-  retries: process.env.CI ? 2 : 1,
-  workers: process.env.CI ? 1 : undefined,
+  retries: process.env.CI ? 2 : 2,
+  workers: process.env.CI ? 1 : 1,
   reporter: [
     ["./src/index.ts", { title: "Reporter testing", showError: true }],
     [
diff --git a/src/index.ts b/src/index.ts
@@ -10,8 +10,10 @@ import * as core from "@actions/core";
 import { basename } from "path";
 import { getHtmlTable } from "./utils/getHtmlTable";
 import { getTableRows } from "./utils/getTableRows";
-import { checkForFailedTests } from "./utils/checkForFailedTests";
-import Convert from "ansi-to-html";
+import { getTestStatusIcon } from "./utils/getTestStatusIcon";
+import { SUMMARY_ENV_VAR } from "@actions/core/lib/summary";
+import { join } from "path";
+import { existsSync, unlinkSync, writeFileSync } from "fs";
 
 interface GitHubActionOptions {
   title?: string;
@@ -39,6 +41,16 @@ class GitHubAction implements Reporter {
   }
 
   async onEnd(result: FullResult) {
+    if (process.env.NODE_ENV === "development") {
+      const summaryFile = join(__dirname, "../summary.html");
+      if (existsSync(summaryFile)) {
+        unlinkSync(summaryFile);
+      }
+      writeFileSync(summaryFile, "", "utf-8");
+      process.env[SUMMARY_ENV_VAR] = summaryFile;
+      process.env.GITHUB_ACTIONS = "true";
+    }
+
     if (process.env.GITHUB_ACTIONS && this.suite) {
       const os = process.platform;
       const summary = core.summary;
@@ -84,10 +96,10 @@ class GitHubAction implements Reporter {
             );
 
             // Check if there are any failed tests
-            const hasFailedTests = checkForFailedTests(tests[filePath]);
+            const testStatusIcon = getTestStatusIcon(tests[filePath]);
 
             summary.addDetails(
-              `${hasFailedTests ? "❌" : "✅"} ${fileName} (${os}${
+              `${testStatusIcon} ${fileName} (${os}${
                 project!.name ? ` / ${project!.name}` : ""
               })`,
               content
diff --git a/src/utils/checkForFailedTests.ts b/src/utils/checkForFailedTests.ts
diff --git a/src/utils/getHtmlTable.ts b/src/utils/getHtmlTable.ts
@@ -1,5 +1,6 @@
 import { TestCase } from "@playwright/test/reporter";
 import Convert from "ansi-to-html";
+import { getTestStatus } from "./getTestStatus";
 
 export const getHtmlTable = (tests: TestCase[], showError: boolean): string => {
   const convert = new Convert();
@@ -27,9 +28,7 @@ export const getHtmlTable = (tests: TestCase[], showError: boolean): string => {
 
     content.push(`<tr>`);
     content.push(`<td>${test.title}</td>`);
-    content.push(
-      `<td>${result.status === "passed" ? "✅ Pass" : "❌ Fail"}</td>`
-    );
+    content.push(`<td>${getTestStatus(result)}</td>`);
     content.push(`<td>${result.duration / 1000}s</td>`);
     content.push(`<td>${result.retry}</td>`);
     if (showError) {
diff --git a/src/utils/getTableRows.ts b/src/utils/getTableRows.ts
@@ -1,6 +1,7 @@
 import { SummaryTableRow } from "@actions/core/lib/summary";
 import { TestCase } from "@playwright/test/reporter";
 import Convert from "ansi-to-html";
+import { getTestStatus } from "./getTestStatus";
 
 export const getTableRows = (
   tests: TestCase[],
@@ -46,7 +47,7 @@ export const getTableRows = (
         header: false,
       },
       {
-        data: result.status === "passed" ? "✅ Pass" : "❌ Fail",
+        data: getTestStatus(result),
         header: false,
       },
       {
diff --git a/src/utils/getTestStatus.ts b/src/utils/getTestStatus.ts
@@ -0,0 +1,17 @@
+import { TestResult } from "@playwright/test/reporter";
+
+export const getTestStatus = (result: TestResult) => {
+  let value = "";
+
+  if (result.status === "passed" && result.retry > 0) {
+    value = `⚠️ Pass`;
+  } else if (result.status === "passed") {
+    value = "✅ Pass";
+  } else if (result.status === "skipped") {
+    value = `⚠️ Skipped`;
+  } else {
+    value = "❌ Fail";
+  }
+
+  return value;
+};
diff --git a/src/utils/getTestStatusIcon.ts b/src/utils/getTestStatusIcon.ts
@@ -0,0 +1,20 @@
+import { TestCase } from "@playwright/test/reporter";
+
+export const getTestStatusIcon = (tests: TestCase[]) => {
+  const testOutcomes = tests.map((test) => {
+    const lastResult = test.results[test.results.length - 1];
+    return lastResult.status;
+  });
+
+  if (
+    testOutcomes.includes("failed") ||
+    testOutcomes.includes("interrupted") ||
+    testOutcomes.includes("timedOut")
+  ) {
+    return "❌";
+  } else if (testOutcomes.includes("skipped")) {
+    return "⚠️";
+  }
+
+  return "✅";
+};
diff --git a/tests/retry.spec.ts b/tests/retry.spec.ts
@@ -0,0 +1,33 @@
+import { test, expect, Page } from "@playwright/test";
+
+test.describe("Test retry", () => {
+  let page: Page;
+
+  test.beforeAll(async ({ browser }) => {
+    page = await browser.newPage();
+
+    await page.goto("https://www.eliostruyf.com", {
+      waitUntil: "domcontentloaded",
+    });
+  });
+
+  test.afterAll(async ({ browser }) => {
+    await page.close();
+    await browser.close();
+  });
+
+  test("First test should fail, next should work", async ({}, testInfo) => {
+    if (testInfo.retry === 0) {
+      expect(true).toBeFalsy();
+    }
+    expect(true).toBeTruthy();
+  });
+
+  test("Skip the test", async () => {
+    test.skip(true, "Don't need to test this.");
+  });
+
+  test("Should work fine", async () => {
+    expect(true).toBeTruthy();
+  });
+});
