Merge pull request #43 from currents-dev/feat/rules-example

twk3 · web-flow · commit d6ce0d14bbd4 · 2024-12-10T16:04:31.000-08:00
[CSR-1773] feat: Add rules example for github actions
diff --git a/.github/test-basic-pwc-failed-only.yml b/.github/test-basic-pwc-failed-only.yml
@@ -30,7 +30,7 @@ jobs:
     name: "Playwright Tests - check failed"
     timeout-minutes: 60
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:latest
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
     steps:
       - uses: actions/checkout@v4
         with:
@@ -96,7 +96,7 @@ jobs:
     name: "Playwright Tests - run basic tests"
     timeout-minutes: 60
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:latest
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
     steps:
       - uses: actions/checkout@v4
         with:
@@ -134,7 +134,7 @@ jobs:
     if: 'failure()'
     needs: [previousFailedFirst, fullRun]
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:latest
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
     steps:
     - uses: actions/checkout@v4
     - uses: actions/setup-node@v4
diff --git a/.github/test-basic-pwc-staging.yml b/.github/test-basic-pwc-staging.yml
@@ -15,7 +15,7 @@ jobs:
     name: "PW tests"
     timeout-minutes: 60
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:latest
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
     env:
       TESTGROUP: basic
     steps:
diff --git a/.github/test.yml b/.github/test.yml
@@ -10,7 +10,7 @@ jobs:
     name: "accessibility tests"
     timeout-minutes: 60
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:v1.28.1-focal
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
     env:
       TESTGROUP: accessibility
       BASEURL: https://playwright.dev/docs/accessibility-testing # Playwright tests use this for baseURL
@@ -92,7 +92,7 @@ jobs:
     name: "basic tests"
     timeout-minutes: 60
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:v1.28.1-focal
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
     env:
       TESTGROUP: basic
     environment:
@@ -167,7 +167,7 @@ jobs:
     name: "drag-and-drop tests"
     timeout-minutes: 60
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:v1.28.1-focal
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
     env:
       TESTGROUP: drag-and-drop
       BASEURL: https://www.w3schools.com/html/html5_draganddrop.asp # Playwright tests use this for baseURL
@@ -248,7 +248,7 @@ jobs:
     name: "fixtures tests"
     timeout-minutes: 60
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:v1.28.1-focal
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
     env:
       TESTGROUP: fixtures
     environment:
@@ -285,7 +285,7 @@ jobs:
     name: "github-api tests"
     timeout-minutes: 60
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:v1.28.1-focal
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
     env:
       TESTGROUP: github-api
       GITHUB_USER: ${{ secrets.REPO_USER }}
@@ -325,7 +325,7 @@ jobs:
     timeout-minutes: 60
     if: ${{ false }} # disable for now for bot detection
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:v1.28.1-focal
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
     env:
       TESTGROUP: oauth
       BASEURL: https://courses.ultimateqa.com/users/sign_in # Playwright tests use this for baseURL
@@ -367,7 +367,7 @@ jobs:
     name: "performance tests"
     timeout-minutes: 60
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:v1.28.1-focal
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
     env:
       TESTGROUP: performance
       BASEURL: https://fastestwebsite.net/ # Playwright tests use this for baseURL
@@ -406,7 +406,7 @@ jobs:
     name: "svgomg tests"
     timeout-minutes: 60
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:v1.28.1-focal
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
     env:
       TESTGROUP: svgomg
       BASEURL: https://demo.playwright.dev/svgomg # Playwright tests use this for baseURL
@@ -444,7 +444,7 @@ jobs:
     name: "todomvc tests"
     timeout-minutes: 60
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:v1.28.1-focal
+    container: mmcr.microsoft.com/playwright:v1.49.0-jammy
     env:
       TESTGROUP: todomvc
       BASEURL: https://demo.playwright.dev/todomvc # Playwright tests use this for baseURL
@@ -482,7 +482,7 @@ jobs:
     name: "visual-comparison tests"
     timeout-minutes: 60
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:v1.28.1-focal
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
     env:
       TESTGROUP: visual-comparison
       BASEURL: https://playwright.dev # Playwright tests use this for baseURL
diff --git a/.github/workflows/argos-example.yml b/.github/workflows/argos-example.yml
@@ -14,7 +14,7 @@ jobs:
     name: "PW tests"
     timeout-minutes: 60
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:1.46.1
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
 
     steps:
       - uses: actions/checkout@v4
diff --git a/.github/workflows/rerun-shards-pwc.yml b/.github/workflows/rerun-shards-pwc.yml
@@ -11,7 +11,7 @@ jobs:
         shard: [1, 2, 3]
     timeout-minutes: 60
     runs-on: ubuntu-latest
-    container: mcr.microsoft.com/playwright:latest
+    container: mcr.microsoft.com/playwright:v1.49.0-noble
     env:
       CURRENTS_PROJECT_ID: bnsqNa
       CURRENTS_RECORD_KEY: ${{ secrets.CURRENTS_RECORD_KEY }}
diff --git a/.github/workflows/rerun-shards-reporter.yml b/.github/workflows/rerun-shards-reporter.yml
@@ -11,7 +11,7 @@ jobs:
         shard: [1, 2, 3]
     timeout-minutes: 60
     runs-on: ubuntu-latest
-    container: mcr.microsoft.com/playwright:latest
+    container: mcr.microsoft.com/playwright:v1.49.0-noble
     env:
       CURRENTS_PROJECT_ID: bnsqNa
       CURRENTS_RECORD_KEY: ${{ secrets.CURRENTS_RECORD_KEY }}
diff --git a/.github/workflows/reruns-or8n.yml b/.github/workflows/reruns-or8n.yml
@@ -11,7 +11,7 @@ jobs:
         shard: [1, 2, 3]
     timeout-minutes: 60
     runs-on: ubuntu-latest
-    container: mcr.microsoft.com/playwright:latest
+    container: mcr.microsoft.com/playwright:v1.49.0-noble
     env:
       CURRENTS_PROJECT_ID: bnsqNa
       CURRENTS_RECORD_KEY: ${{ secrets.CURRENTS_RECORD_KEY }}
diff --git a/.github/workflows/test-basic-pwc.yml b/.github/workflows/test-basic-pwc.yml
@@ -16,7 +16,7 @@ jobs:
     name: "Playwright Tests - pwc"
     timeout-minutes: 60
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:1.46.1
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
 
     steps:
       - uses: actions/checkout@v4
diff --git a/.github/workflows/test-basic-reporter.yml b/.github/workflows/test-basic-reporter.yml
@@ -15,7 +15,7 @@ jobs:
     name: "Playwright Tests - Reporter"
     timeout-minutes: 60
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:1.46.1
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
 
     steps:
       - uses: actions/checkout@v4
diff --git a/.github/workflows/test-or8n.yml b/.github/workflows/test-or8n.yml
@@ -16,7 +16,7 @@ jobs:
     name: "Playwright Tests - pwc-p"
     timeout-minutes: 60
     runs-on: ubuntu-22.04
-    container: mcr.microsoft.com/playwright:1.46.1
+    container: mcr.microsoft.com/playwright:v1.49.0-jammy
 
     steps:
       - uses: actions/checkout@v4
diff --git a/basic/0-failing.spec.ts b/basic/0-failing.spec.ts
@@ -1,7 +1,8 @@
-import { expect, test } from "@playwright/test";
+import { expect } from "@playwright/test";
+import { test } from "./base.ts";
 
 test("basic test @basic", async ({ page }) => {
-  await page.goto("https://todomvc.com/examples/backbone/dist/");
+  await page.goto("https://demo.playwright.dev/todomvc");
 
   // Use locators to represent a selector and re-use them
   const inputBox = page.locator("input.new-todo");
diff --git a/basic/1-getting-started.spec.ts b/basic/1-getting-started.spec.ts
@@ -1,7 +1,8 @@
-import { expect, test } from "@playwright/test";
+import { expect } from "@playwright/test";
+import { test } from "./base.ts";
 
 test("basic test @basic", async ({ page }) => {
-  await page.goto("https://todomvc.com/examples/backbone/dist/");
+  await page.goto("https://demo.playwright.dev/todomvc");
 
   // Use locators to represent a selector and re-use them
   const inputBox = page.locator("input.new-todo");
diff --git a/basic/2-actions.spec.ts b/basic/2-actions.spec.ts
@@ -1,4 +1,5 @@
-import { expect, test } from "@playwright/test";
+import { expect } from "@playwright/test";
+import { test } from "./base.ts";
 
 test.beforeEach(async ({ page }) => {
   await page.goto("https://todomvc.com/examples/backbone/dist/");
diff --git a/basic/3-assertions.spec.ts b/basic/3-assertions.spec.ts
@@ -1,7 +1,8 @@
-import { expect, test } from "@playwright/test";
+import { expect } from "@playwright/test";
+import { test } from "./base.ts";
 
 test.beforeEach(async ({ page }) => {
-  await page.goto("https://todomvc.com/examples/backbone/dist/");
+  await page.goto("https://demo.playwright.dev/todomvc");
 });
 
 /**
@@ -10,8 +11,8 @@ test.beforeEach(async ({ page }) => {
  */
 test("should be able to use assertions", async ({ page }) => {
   await test.step("toHaveTitle/toHaveURL", async () => {
-    await expect(page).toHaveTitle("TodoMVC: Backbone");
-    await expect(page).toHaveURL("https://todomvc.com/examples/backbone/dist/");
+    await expect(page).toHaveTitle("React • TodoMVC");
+    await expect(page).toHaveURL(/^https:\/\/demo.playwright.dev\/todomvc/);
   });
 
   await test.step("toBeEmpty/toHaveValue", async () => {
@@ -45,11 +46,9 @@ test("should be able to use assertions", async ({ page }) => {
     await expect(page.locator("text=Buy milk")).toBeHidden();
   });
 
-  await test.step("toHaveClass/toHaveCSS", async () => {
+  await test.step("toHaveClass", async () => {
     await expect(
       page.locator('[placeholder="What needs to be done?"]')
     ).toHaveClass("new-todo");
-    await page.click("text=Clear completed");
-    await expect(page.locator(".main")).toHaveCSS("display", "none");
   });
 });
diff --git a/basic/4-file-uploads.spec.ts b/basic/4-file-uploads.spec.ts
@@ -1,4 +1,5 @@
-import {test, expect} from '@playwright/test';
+import { expect } from "@playwright/test";
+import { test } from "./base.ts";
 
 const fileToUpload = __filename; // '__filename' is the current test file.
 
diff --git a/basic/5-flaky.spec.ts b/basic/5-flaky.spec.ts
@@ -1,4 +1,5 @@
-import { expect, test } from "@playwright/test";
+import { expect } from "@playwright/test";
+import { test } from "./base.ts";
 
 /**
  * This test clicks on an element with the text 'Load user' and waits for a
diff --git a/basic/6-networking.spec.ts b/basic/6-networking.spec.ts
@@ -1,4 +1,5 @@
-import {test, expect} from '@playwright/test';
+import { expect } from "@playwright/test";
+import { test } from "./base.ts";
 
 /**
  * This test clicks on an element with the text 'Load user' and waits for a
diff --git a/basic/7-accessibility.spec.ts b/basic/7-accessibility.spec.ts
@@ -1,4 +1,5 @@
-import { test, expect } from "@playwright/test";
+import { expect } from "@playwright/test";
+import { test } from "./base.ts";
 import AxeBuilder from "@axe-core/playwright"; // 1
 
 test.describe("homepage", () => {
diff --git a/basic/7-argos.spec.ts b/basic/7-argos.spec.ts
@@ -1,5 +1,5 @@
 import { argosScreenshot } from "@argos-ci/playwright";
-import { test } from "@playwright/test";
+import { test } from "./base.ts";
 
 test("basic test @basic", async ({ page }) => {
   await page.goto("https://example.com");
diff --git a/basic/8-rules.spec.ts b/basic/8-rules.spec.ts
@@ -0,0 +1,48 @@
+import { expect } from "@playwright/test";
+import { test } from "./base.ts";
+
+/**
+ * All tests in this file are matched with a Currents Quarantine Rule based on filename.
+ * See the `rules` fixture in `base.ts` to see how the rules fixtures were configured,
+ * and the docs for more information on how to configure rules: https://docs.currents.dev/guides/automation-rules
+ * 
+ */
+
+/**
+ * This is a failing test that will be quarantined by the file based rule
+ * 
+ * | field | operation | value           |  -  | action     |
+ * | ----- | --------- | --------------- | --- | ---------- |
+ * | File  | is        | 8-rules.spec.ts | ->  | Quarantine |
+ */
+test("rules quarantine test", async ({ page }) => {
+  await page.goto("https://demo.playwright.dev/todomvc");
+
+  // Use locators to represent a selector and re-use them
+  const inputBox = page.locator("input.new-todo");
+  const todoList = page.locator(".todo-list");
+
+  await inputBox.fill("Learn JavaScript");
+  await inputBox.press("Enter");
+  await expect(todoList).toHaveText("Learn Playwright");
+});
+
+/**
+ * This tests will be completely skipped by a rule that matches fileName + test name
+ * 
+ * | field | operation | value           |  -   | action     |
+ * | ----- | --------- | --------------- | ---- | ---------- |
+ * | File  | is        | 8-rules.spec.ts | And  |            |
+ * | Title | is        | rules skip test | ->   | Skip       |
+ */
+test("rules skip test", async ({ page }) => {
+  await page.goto("https://demo.playwright.dev/todomvc");
+
+  // Use locators to represent a selector and re-use them
+  const inputBox = page.locator("input.new-todo");
+  const todoList = page.locator(".todo-list");
+
+  await inputBox.fill("Learn JavaScript");
+  await inputBox.press("Enter");
+  await expect(todoList).toHaveText("Learn JavaScript");
+});
diff --git a/basic/base.ts b/basic/base.ts
@@ -0,0 +1,11 @@
+import {
+  CurrentsFixtures,
+  CurrentsWorkerFixtures,
+  fixtures,
+} from "@currents/playwright";
+import { test as base } from "@playwright/test";
+
+export const test = base.extend<CurrentsFixtures, CurrentsWorkerFixtures>({
+  ...fixtures.baseFixtures,
+  ...fixtures.rulesFixtures,
+});
diff --git a/basic/pom/todoPage.pom.ts b/basic/pom/todoPage.pom.ts
@@ -25,6 +25,6 @@ export class TodoPage {
   }
 
   async goto() {
-    await this.page.goto("https://todomvc.com/examples/backbone/dist/");
+    await this.page.goto("https://demo.playwright.dev/todomvc");
   }
 }
diff --git a/basic/pw.config.shared.ts b/basic/pw.config.shared.ts
@@ -1,6 +1,7 @@
-import { devices, PlaywrightTestConfig } from "@playwright/test";
+import { CurrentsFixtures, CurrentsWorkerFixtures } from "@currents/playwright";
+import { defineConfig, devices } from "@playwright/test";
 
-const config: PlaywrightTestConfig = {
+const config = defineConfig<CurrentsFixtures, CurrentsWorkerFixtures>({
   timeout: 10 * 1000,
 
   fullyParallel: true,
@@ -37,8 +38,16 @@ const config: PlaywrightTestConfig = {
     },
   ],
 
+  webServer: {
+    command: 'node ./server/index.js',
+    port: 4346,
+    reuseExistingServer: !process.env.CI,
+    stdout: 'ignore',
+    stderr: 'pipe',
+  },
+
   /* Folder for test artifacts such as screenshots, videos, traces, etc. */
   outputDir: "test-results/",
-};
+});
 
 export default config;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
