Tests: Mock coveo credentials

Author: lamATnginx

.github/workflows/playwright.yml

@@ -7,6 +7,9 @@ on:
         - 'main'
     pull_request:
 
+env:
+    FRONT_DOOR_USERNAME: ${{ secrets.FRONT_DOOR_USERNAME }}
+    FRONT_DOOR_PASSWORD:  ${{ secrets.FRONT_DOOR_PASSWORD }}
 jobs:
     playwright:
         name: Run Playwright

.gitignore

@@ -4,6 +4,7 @@
 *.key
 *~
 \#*
+.env
 
 # OS Specific #
 ###############

tests/package-lock.json

@@ -3,6 +3,7 @@
   "version": "1.0.0",
   "private": "true",
   "devDependencies": {
-    "@playwright/test": "1.48.0"
+    "@playwright/test": "1.48.0",
+    "dotenv": "^17.2.3"
   }
 }

tests/package.json

@@ -1,7 +1,11 @@
 import { defineConfig, devices } from '@playwright/test';
+import dotenv from 'dotenv';
 
 const BASE_URL = 'http://127.0.0.1';
 const PORT = 1313;
+
+dotenv.config();
+
 export default defineConfig({
   testDir: './src',
   fullyParallel: true,

tests/playwright.config.js

@@ -23,11 +23,41 @@ function buildFilter() {
     .replaceAll(' ', '%20');
 }
 
+async function mockCoveo(page, request) {
+  // Get credentials
+  const tokenBaseURL = 'https://docs-dev.nginx.com';
+  const tokenEndpoint = '/api/v1/auth/search_token';
+  const username = process.env.FRONT_DOOR_USERNAME;
+  const password = process.env.FRONT_DOOR_PASSWORD;
+  const response = await request.get(tokenBaseURL + tokenEndpoint, {
+    headers: {
+      Authorization:
+        'Basic ' + Buffer.from(`${username}:${password}`).toString('base64'),
+    },
+  });
+
+  expect(response.ok()).toBeTruthy();
+  expect(response.status()).toBe(200);
+
+  const credentials = await response.json();
+
+  // Mock the local request to be successful, then reload the page.
+  await page.route(`**${tokenEndpoint}`, async (route) => {
+    await route.fulfill({
+      status: 200,
+      contentType: 'application/json',
+      body: JSON.stringify(credentials),
+    });
+  });
+  await page.reload();
+}
+
 test.describe('Coveo test', () => {
-  test.beforeEach(async ({ page }) => {
+  test.beforeEach(async ({ page, request }) => {
     await page.goto('/');
     await page.waitForLoadState('load');
     await waitFor(async () => await handleConsentPopup(page));
+    await mockCoveo(page, request);
   });
 
   test.afterEach(async ({ page }) => {
@@ -58,5 +88,9 @@ test.describe('Coveo test', () => {
 
     // should retain the same link instead of resetting
     expect(page.url()).toContain(endpoint);
+
+    // reloading should retain the same link instead of resetting
+    await page.reload();
+    expect(page.url()).toContain(endpoint);
   });
 });