add automated playwright testing

.github/workflows/laravel.yml

@@ -22,6 +22,9 @@ jobs:
       run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
     - name: Install and build Js Dependencies
       run: npm ci && npm run build
+
+    - name: Install Playwright Browsers
+      run: npx playwright install --with-deps
     - name: Generate key
       run: php artisan key:generate
     - name: Directory Permissions
@@ -35,3 +38,6 @@ jobs:
         DB_CONNECTION: sqlite
         DB_DATABASE: database/database.sqlite
       run: php artisan test
+
+    - name: Run Playwright tests
+      run: npx playwright test

.gitignore

@@ -20,3 +20,8 @@ yarn-error.log
 /public/**/
 /resources/views/custom
 /Portal
+node_modules/
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

e2e/example.spec.cjs

@@ -0,0 +1,12 @@
+// @ts-check
+const { test, expect } = require('@playwright/test');
+
+test('Has Login', async ({ page }) => {
+  await page.goto('http://localhost');
+
+  //Click Sign In button
+  await page.getByRole('button', { name: 'Sign In' }).click();
+
+  // Expects page to have a heading with the name of Installation.
+  await expect(page.getByRole('group', { name: 'Portal Login' })).toBeVisible();
+});

package.json

@@ -1,24 +1,26 @@
 {
-    "private": true,
-    "type": "module",
-    "scripts": {
-        "dev": "vite",
-        "build": "vite build"
-    },
-    "devDependencies": {
-        "autoprefixer": "^10.4.19",
-        "axios": "^1.1.2",
-        "laravel-vite-plugin": "^0.8.0",
-        "postcss": "^8.4.38",
-        "postcss-nesting": "^12.1.1",
-        "tailwindcss": "^3.4.1",
-        "vite": "^4.0.0"
-    },
-    "dependencies": {
-        "@fortawesome/fontawesome-free": "^6.5.2",
-        "@fortawesome/fontawesome-svg-core": "^6.5.2",
-        "alpinejs": "^3.13.8",
-        "color": "^4.2.3",
-        "htmx.org": "^1.9.12"
-    }
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.47.2",
+    "@types/node": "^22.7.1",
+    "autoprefixer": "^10.4.19",
+    "axios": "^1.1.2",
+    "laravel-vite-plugin": "^0.8.0",
+    "postcss": "^8.4.38",
+    "postcss-nesting": "^12.1.1",
+    "tailwindcss": "^3.4.1",
+    "vite": "^4.0.0"
+  },
+  "dependencies": {
+    "@fortawesome/fontawesome-free": "^6.5.2",
+    "@fortawesome/fontawesome-svg-core": "^6.5.2",
+    "alpinejs": "^3.13.8",
+    "color": "^4.2.3",
+    "htmx.org": "^1.9.12"
+  }
 }

playwright.config.cjs

@@ -0,0 +1,79 @@
+// @ts-check
+const { defineConfig, devices } = require('@playwright/test');
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// require('dotenv').config({ path: path.resolve(__dirname, '.env') });
+
+/**
+ * @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: 'php artisan serve',
+     url: 'http://127.0.0.1:8000',
+     reuseExistingServer: !process.env.CI,
+  },
+});
+