Feature/e2e tests conversion to playwright

.github/actions/run-playwright-e2e-tests/action.yml

@@ -0,0 +1,46 @@
+name: Run Playwright end to end tests
+description: Run end to end tests using Playwright
+
+inputs:
+  webapp_url:
+    required: true
+    type: string
+  auth_secret:
+    required: true
+    type: string
+
+runs:
+  using: composite
+  steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: 18.x
+#    - name: Install dependencies
+#      shell: bash
+#      working-directory: ./tests/Dfe.EarlyYearsQualification.E2ETests/playwright
+#      run: npm ci
+    - name: Install dependencies
+      shell: bash
+      working-directory: ./tests/Dfe.EarlyYearsQualification.E2ETests/playwright
+      run: npm install -g yarn && yarn install --frozen-lockfile
+#    - name: Install Playwright Browsers
+#      shell: bash
+#      working-directory: ./tests/Dfe.EarlyYearsQualification.E2ETests/playwright
+#      run: npx playwright install --with-deps
+    - name: Install Playwright Browsers
+      shell: bash
+      working-directory: ./tests/Dfe.EarlyYearsQualification.E2ETests/playwright
+      run: yarn playwright install --with-deps
+    - name: Run Playwright tests
+      shell: bash
+      working-directory: ./tests/Dfe.EarlyYearsQualification.E2ETests/playwright
+      env:
+        CI: true
+      run: WEBAPP_URL="http://localhost:3000" AUTH_SECRET=${{ inputs.auth_secret }} DOMAIN="localhost" npx playwright test
+    - uses: actions/upload-artifact@v4
+      if: ${{ !cancelled() }}
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30

.github/workflows/code-pr-check.yml

@@ -23,13 +23,13 @@ concurrency:
 env:
   DOTNET_VERSION: 8
   SOLUTION_NAME: 'Dfe.EarlyYearsQualification.sln'
-  URL: http://127.0.0.1:5000
+  URL: 'http://127.0.0.1:5000'
 
 jobs:
 
   build-app:  
     name: Build, check and run tests
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
 
     steps:
       - name: Check out repository
@@ -52,10 +52,16 @@ jobs:
           url: ${{ env.URL }}
           auth_secret: ${{ secrets.WEBAPP_E2E_ACCESS_KEY }}
 
-      - name: Run e2e tests
-        uses: ./.github/actions/run-e2e-tests
+#      - name: Run e2e tests
+#        uses: ./.github/actions/run-e2e-tests
+#        with:
+#          url: ${{ env.URL }}
+#          auth_secret: ${{ secrets.WEBAPP_E2E_ACCESS_KEY }}
+
+      - name: Run Playwright e2e tests
+        uses: ./.github/actions/run-playwright-e2e-tests
         with:
-          url: ${{ env.URL }}
+          webapp_url: ${{ env.URL }}
           auth_secret: ${{ secrets.WEBAPP_E2E_ACCESS_KEY }}
 
       - name: Run Accessibility tests

README.md

@@ -61,3 +61,28 @@ dotnet test --collect:"XPlat Code Coverage" --settings coverlet.runsettings
 ```
 
 This will pull in the exclusions such as the .cshtml files and will replicate coverage in the GitHub Actions.
+
+## End to end/Smoke testing
+
+End to end tests are ran using [Playwright](https://playwright.dev/).
+
+To run the tests, run the following commands:
+- Add some environment variables
+```
+WEBAPP_URL={URL OF THE HOME PAGE}
+AUTH_SECRET={PASSWORD FOR ENVIRONMENT}
+DOMAIN={DOMAIN FOR COOKIE TO BE ADDED TO (when local: localhost)}
+```
+- Run the local web app.
+- Navigate to the correct folder, be it:
+  - ``cd tests/Dfe.EarlyYearsQualification.E2ETests/playwright`` for the E2E tests.
+  - ``cd tests/Dfe.EarlyYearsQualification.SmokeTests/playwright`` for the smoke tests.
+- Tell Node Version Manager that you want the latest version with: ``nvm use node --lts``
+- Run the tests with: ``npx playwright test`` (add --ui to run the tests in playwrights UI)
+
+### Problems with Safari?
+If you notice you are having issues with running Safari tests locally and them failing then there is a fix.
+
+This is happening due to because Safari strictly enforcing the `upgrade-insecure-requests` header. This is converting the HTTP requests to HTTPS.
+
+To fix this, comment out this line in the web app's [Program.cs](https://github.com/DFE-Digital/check-an-early-years-qualification/blob/main/src/Dfe.EarlyYearsQualification.Web/Program.cs#L138-L140). This will remove the header from all requests and should let Safari use HTTP.

tests/Dfe.EarlyYearsQualification.E2ETests/playwright/.env

@@ -0,0 +1,3 @@
+WEBAPP_URL='http://localhost:3000'
+AUTH_SECRET=ABC
+DOMAIN=localhost

tests/Dfe.EarlyYearsQualification.E2ETests/playwright/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "playwright",
+  "version": "1.0.0",
+  "main": "index.js",
+  "scripts": {},
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "devDependencies": {
+    "@playwright/test": "^1.49.0",
+    "@types/node": "^22.10.1",
+    "dotenv": "^16.4.7"
+  }
+}

tests/Dfe.EarlyYearsQualification.E2ETests/playwright/playwright.config.ts

@@ -0,0 +1,83 @@
+import {defineConfig, devices} from '@playwright/test';
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// import dotenv from 'dotenv';
+// import path from 'path';
+// dotenv.config({ path: path.resolve(__dirname, '.env') });
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+require('dotenv').config();
+
+export default defineConfig({
+    testDir: './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: !!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: process.env.WEBAPP_URL,
+
+        /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+        trace: 'on-first-retry',
+
+        ignoreHTTPSErrors: true,
+    },
+    /* 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:`cd ../../../src/Dfe.EarlyYearsQualification.Web && dotnet run --urls "${process.env.WEBAPP_URL}" --project ./Dfe.EarlyYearsQualification.Web.csproj --UseMockContentful=true --ServiceAccess:Keys:0="${process.env.AUTH_SECRET}"`,
+      url: process.env.WEBAPP_URL,
+      reuseExistingServer: !process.env.CI,
+    },
+});