chore: added Playwright for future E2E tests

Author: thorsten

.github/workflows/playwright.yml

@@ -0,0 +1,27 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 18
+    - name: Install dependencies
+      run: npm install -g pnpm && pnpm install
+    - name: Install Playwright Browsers
+      run: pnpm exec playwright install --with-deps
+    - name: Run Playwright tests
+      run: pnpm exec playwright test
+    - uses: actions/upload-artifact@v3
+      if: always()
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30

.gitignore

@@ -92,5 +92,12 @@ tests/fixtures/path-to-delete/foo.bar.baz
 # Jest related stuff
 coverage/*
 
+# Playwright related stuff
+playwright-report/
+
 # Netbeans project folder
 nbproject/
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

README.md

@@ -125,6 +125,8 @@ Then just open http://www.example.org/phpmyfaq/setup/index.php in your browser.
 
 ## Testing
 
+### PHP
+
 To run our unit tests via PHPUnit v10.x, just execute this command on your CLI
 
     $ curl -s https://getcomposer.org/installer | php
@@ -133,6 +135,42 @@ To run our unit tests via PHPUnit v10.x, just execute this command on your CLI
 
 Please note that phpMyFAQ needs to be installed via Composer.
 
+### Javascript
+
+To run our Javascript tests via Jest, just execute this command on your CLI
+
+    $ curl -fsSL https://get.pnpm.io/install.sh | sh -
+    $ pnpm install
+    $ pnpm test
+
+### End-to-end tests
+
+To run our end-to-end tests via Playwright, you can use several commands:
+
+    $ pnpm exec playwright test
+
+Runs the end-to-end tests.
+
+    $ pnpm exec playwright test --ui
+
+Starts the interactive UI mode.
+
+    $ pnpm exec playwright test --project=chromium
+
+Runs the tests only on Desktop Chrome.
+
+    $ pnpm exec playwright test example
+
+Runs the tests in a specific file.
+
+    $ pnpm exec playwright test --debug
+
+Runs the tests in debug mode.
+
+    $ pnpm exec playwright codegen
+
+Auto generate tests with Codegen.
+
 ## Versioning
 
 For transparency and insight into our release cycle, and for striving to maintain backward compatibility, phpMyFAQ will

e2e/example.playwright.test.js

@@ -0,0 +1,19 @@
+// @ts-check
+const { test, expect } = require('@playwright/test');
+
+test('has title', async ({ page }) => {
+  await page.goto('https://playwright.dev/');
+
+  // Expect a title "to contain" a substring.
+  await expect(page).toHaveTitle(/Playwright/);
+});
+
+test('get started link', async ({ page }) => {
+  await page.goto('https://playwright.dev/');
+
+  // Click the get started link.
+  await page.getByRole('link', { name: 'Get started' }).click();
+
+  // Expects page to have a heading with the name of Installation.
+  await expect(page.getByRole('heading', { name: 'Installation' })).toBeVisible();
+});

jest.config.js

@@ -10,4 +10,6 @@ module.exports = {
 
   // The test environment that will be used for testing
   testEnvironment: 'jsdom',
+
+  testMatch: ['**/*.test.js', '!**/*.playwright.test.js'],
 };

package.json

@@ -45,7 +45,9 @@
     "@commitlint/cli": "^17.8.1",
     "@commitlint/config-conventional": "^17.8.1",
     "@mcler/webpack-concat-plugin": "^4.1.5",
+    "@playwright/test": "^1.41.1",
     "@testing-library/jest-dom": "^5.17.0",
+    "@types/node": "^20.11.5",
     "autoprefixer": "^10.4.16",
     "babel-jest": "^29.7.0",
     "babel-loader": "^9.1.3",

playwright.config.js

@@ -0,0 +1,78 @@
+// @ts-check
+const { defineConfig, devices } = require('@playwright/test');
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// require('dotenv').config();
+
+/**
+ * @see https://playwright.dev/docs/test-configuration
+ */
+module.exports = defineConfig({
+  testDir: './e2e',
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: 'html',
+  /* 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: 'npm run start',
+  //   url: 'http://127.0.0.1:3000',
+  //   reuseExistingServer: !process.env.CI,
+  // },
+});