feat!: replace Testbench tests with Playwright Java & TS (v24.4)

.github/workflows/validate.yml

@@ -1,49 +1,50 @@
 name: Verify
 on:
   push:
-    branches: [v24.4]
   workflow_dispatch:
   pull_request:
 permissions:
   contents: read
+concurrency:
+  group: ${{ github.head_ref || github.ref_name }}
+  cancel-in-progress: true
 jobs:
   verify:
+    timeout-minutes: 60
     runs-on: ubuntu-latest
     permissions:
       # for EnricoMi/publish-unit-test-result-action
       issues: read
       checks: write
       pull-requests: write
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: '18'
-      - uses: actions/setup-java@v3
+          node-version: 'lts/*'
+      - uses: actions/setup-java@v4
         with:
-          java-version: '17'
+          java-version: '21'
           distribution: 'temurin'
-      - name: Set TB License
-        run: |
-          TBL=${{ secrets.TB_LICENSE }}
-          [ -z "$TBL" ] && echo "No TB license provided" && exit 1
-          mkdir -p ~/.vaadin/
-          echo '{"username":"'`echo $TBL | cut -d / -f1`'","proKey":"'`echo $TBL | cut -d / -f2`'"}' > ~/.vaadin/proKey
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: ~/.m2/repository
           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
           restore-keys: ${{ runner.os }}-maven-
-      - uses: browser-actions/setup-chrome@latest
-        with:
-          chrome-version: stable
-      - uses: nanasess/setup-chromedriver@master
+      - name: Install browsers
+        run: |
+          npm install --ci
+          npx playwright install chromium --with-deps
+          npx playwright install-deps
       - name: Verify
         run: |
-          mvn -B -V -ntp verify -Dcom.vaadin.testbench.Parameters.headless -Pit,production
+          ./mvnw -B -V -ntp verify -Pit,production
+      - uses: actions/upload-artifact@v4
+        with:
+          name: tests-report
+          path: target/**-reports
+          retention-days: 30
       - name: Publish Test Results
         uses: EnricoMi/publish-unit-test-result-action@v1
         with:
-          files: "**/target/*-reports/TEST*.xml"
-          check_run_annotations: all tests, skipped tests
-          check_run_annotations_branch: v24.4
+          files: "target/*-reports/TEST*.xml"

package.json

@@ -33,8 +33,10 @@
   },
   "devDependencies": {
     "@babel/preset-react": "7.24.1",
+    "@playwright/test": "^1.44.0",
     "@rollup/plugin-replace": "5.0.5",
     "@rollup/pluginutils": "5.1.0",
+    "@types/node": "^20.12.12",
     "@types/react": "18.3.2",
     "@types/react-dom": "18.3.0",
     "@vaadin/hilla-generator-cli": "24.4.0-beta3",
@@ -119,7 +121,7 @@
       "workbox-core": "7.1.0",
       "workbox-precaching": "7.1.0"
     },
-    "hash": "d8ddc9c76a424746a892d48a8b7f4e86d3c037945ee968d39a4befa10b38b7ce"
+    "hash": "3319bf050746b28ac401caea5b7cb87a1733a059e792fe2fd11d8b96a2b17e3c"
   },
   "overrides": {
     "@vaadin/bundles": "$@vaadin/bundles",
@@ -149,5 +151,8 @@
     "@vaadin/vaadin-themable-mixin": "$@vaadin/vaadin-themable-mixin",
     "@vaadin/vaadin-lumo-styles": "$@vaadin/vaadin-lumo-styles",
     "@vaadin/vaadin-material-styles": "$@vaadin/vaadin-material-styles"
+  },
+  "scripts": {
+    "test": "npx playwright install chromium && npx playwright test"
   }
 }

playwright.config.ts

@@ -0,0 +1,85 @@
+import { defineConfig, devices } from '@playwright/test';
+
+const isMaven = !!process.env.MAVEN_CMD_LINE_ARGS;
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// require('dotenv').config();
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: './src/test/frontend/views',
+  outputDir: './target/playwright-reports/tests',
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: isMaven,
+  /* Retry on CI only */
+  retries: isMaven ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: isMaven ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: [
+    ['html', { outputFolder: 'target/playwright-reports/html', open: !isMaven }],
+    ['junit', { outputFile: 'target/playwright-reports/TEST-frontend-report.xml' }]
+  ],
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    // baseURL: 'http://127.0.0.1:3000',
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: 'on-first-retry',
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+
+    // {
+    //   name: 'firefox',
+    //   use: { ...devices['Desktop Firefox'] },
+    // },
+
+    // {
+    //   name: 'webkit',
+    //   use: { ...devices['Desktop Safari'] },
+    // },
+
+    /* Test against mobile viewports. */
+    // {
+    //   name: 'Mobile Chrome',
+    //   use: { ...devices['Pixel 5'] },
+    // },
+    // {
+    //   name: 'Mobile Safari',
+    //   use: { ...devices['iPhone 12'] },
+    // },
+
+    /* Test against branded browsers. */
+    // {
+    //   name: 'Microsoft Edge',
+    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
+    // },
+    // {
+    //   name: 'Google Chrome',
+    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+    // },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  webServer: {
+    command: "./mvnw -B -ntp -Dspring-boot.run.jvmArguments='-Dvaadin.launch-browser=false'",
+    url: "http://127.0.0.1:8080",
+    reuseExistingServer: isMaven,
+    stdout: "pipe",
+    stderr: "pipe",
+  },
+});