Coveo: Added tests to feature

Author: lamATnginx

assets/js/coveo.js

@@ -101,9 +101,7 @@ async function atomicCoveo() {
   } catch (error) {
     // Handle coveo error from only a LACK of credentials.
     // INCORRECT credentials will cause the page to load but spin waiting.
-    const coveoErrorContainer = document.getElementById(
-      'coveo-error-container'
-    );
+    const coveoErrorContainer = document.getElementById('coveo-error-content');
     coveoErrorContainer.style.display = 'block';
   }
 }

layouts/partials/search-error.html

@@ -1,6 +1,6 @@
 {{- $isCoveoDefined := . -}}
 
-<div class="content" data-testid="content" id="coveo-error-container" style="{{- if $isCoveoDefined -}}display: none;{{- else -}}{{- end -}}">
+<div class="content" data-testid="coveo-error-content" id="coveo-error-content" style="{{- if $isCoveoDefined -}}display: none;{{- else -}}{{- end -}}">
   <div class="not-found-container" data-testid="not-found-container">
     <h1 class="info-header">
       Search functionality is unavailable.

tests/src/constants/constants.js

@@ -1 +1,3 @@
 export const TIMEOUT = 4000;
+export const COVEO_CREDENTIALS_BASE_URL = 'https://docs-dev.nginx.com';
+export const COVEO_CREDENTIALS_ENDPOINT = 'api/v1/auth/search_token';

tests/src/coveo.spec.js

@@ -1,4 +1,5 @@
 import { expect, test } from '@playwright/test';
+import { COVEO_CREDENTIALS_ENDPOINT } from './constants';
 import { mockCoveoCredentials, mockCoveoData } from './mock';
 import {
   buildURLFragment,
@@ -21,12 +22,17 @@ test.describe('Coveo test', () => {
     await page.goto('/');
     await page.waitForLoadState('load');
     await waitFor(async () => await handleConsentPopup(page));
-    await mockCoveoCredentials(page, request);
+
+    const excludedTests = ['missing coveo credentials'];
+    if (!excludedTests.includes(test.info().title)) {
+      await mockCoveoCredentials(page, request);
+    }
   });
 
   test.afterEach(async ({ page }) => {
     // Run basic smoke tests on all valid queries
-    if (!test.info().title.includes('invalid search query')) {
+    const excludedTests = ['invalid search query', 'missing coveo credentials'];
+    if (!excludedTests.includes(test.info().title)) {
       await runSmokeTestCoveo(page);
     }
   });
@@ -57,4 +63,18 @@ test.describe('Coveo test', () => {
     await page.reload();
     expect(page.url()).toContain(endpoint);
   });
+
+  test('missing coveo credentials', async ({ page }) => {
+    const searchEndpoint = 'search.html';
+    await page.goto(`/${searchEndpoint}`);
+    await page.route(`**/${COVEO_CREDENTIALS_ENDPOINT}`, async (route) => {
+      await route.fulfill({
+        status: 404,
+        contentType: 'text/html; charset=utf-8',
+      });
+    });
+
+    const coveoErrorContent = page.getByTestId('coveo-error-content');
+    await expect(coveoErrorContent).toBeVisible();
+  });
 });

tests/src/mock/coveo.mock.js

@@ -1,4 +1,8 @@
 import { expect } from '@playwright/test';
+import {
+  COVEO_CREDENTIALS_BASE_URL,
+  COVEO_CREDENTIALS_ENDPOINT,
+} from '../constants';
 
 export const mockCoveoData = {
   validQuery: 'proxy',
@@ -8,24 +12,25 @@ export const mockCoveoData = {
 
 export async function mockCoveoCredentials(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'),
-    },
-  });
+  const response = await request.get(
+    `${COVEO_CREDENTIALS_BASE_URL}/${COVEO_CREDENTIALS_ENDPOINT}`,
+    {
+      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 page.route(`**/${COVEO_CREDENTIALS_ENDPOINT}`, async (route) => {
     await route.fulfill({
       status: 200,
       contentType: 'application/json',