CCM-10893 Update test users and clients

Author: nicki-nhs

tests/test-team/helpers/auth/cognito-auth-helper.ts

@@ -11,7 +11,9 @@ import {
 import { faker } from '@faker-js/faker';
 import { AuthContextFile } from './auth-context-file';
 import {
+  ClientConfiguration,
   ClientConfigurationHelper,
+  testClients,
   type ClientKey,
 } from '../client/client-helper';
 
@@ -101,6 +103,13 @@ export const testUsers: Record<string, TestUserStaticDetails> = {
     userId: 'User7',
     clientKey: 'Client1',
   },
+  /**
+   * User8 has a client with no client name set
+   */
+  User8: {
+    userId: 'User8',
+    clientKey: 'Client6',
+  },
 };
 
 export type TestUser = TestUserStaticDetails &
@@ -239,14 +248,15 @@ export class CognitoAuthHelper {
     const tempPassword = CognitoAuthHelper.generatePassword();
 
     const clientId = `${userDetails.clientKey}--${this.runId}`;
-    const clientName = `NHS Test ${userDetails.clientKey.replaceAll(/([a-z])([A-Z])/g, '$1 $2')}`;
+    const clientConfig: ClientConfiguration | undefined =
+      testClients[userDetails.clientKey];
+    const clientName = clientConfig?.name;
 
     const clientAttributes = [
       { Name: 'custom:sbx_client_id', Value: clientId },
-      {
-        Name: 'custom:sbx_client_name',
-        Value: clientName,
-      },
+      ...(clientName
+        ? [{ Name: 'custom:sbx_client_name', Value: clientName }]
+        : []),
     ];
 
     const {

tests/test-team/helpers/client/client-helper.ts

@@ -4,16 +4,17 @@ import {
   SSMClient,
 } from '@aws-sdk/client-ssm';
 
-type ClientConfiguration = {
+export type ClientConfiguration = {
+  campaignId?: string;
   features: {
     proofing: boolean;
     // TODO: CCM-11148 Make routing flag required
     routing?: boolean;
   };
-  campaignId?: string;
+  name?: string;
 };
 
-export type ClientKey = `Client${1 | 2 | 3 | 4 | 5}`;
+export type ClientKey = `Client${1 | 2 | 3 | 4 | 5 | 6}`;
 
 type TestClients = Record<ClientKey, ClientConfiguration | undefined>;
 
@@ -23,6 +24,7 @@ export const testClients = {
    */
   Client1: {
     campaignId: 'Campaign1',
+    name: 'NHS Test Client 1',
     features: {
       proofing: true,
       routing: true,
@@ -33,6 +35,7 @@ export const testClients = {
    */
   Client2: {
     campaignId: 'Campaign2',
+    name: 'NHS Test Client 2',
     features: {
       proofing: false,
       routing: false,
@@ -47,16 +50,29 @@ export const testClients = {
    */
   Client4: {
     campaignId: undefined,
+    name: 'NHS Test Client 4',
     features: {
       proofing: true,
       routing: false,
     },
   },
   /**
-   * Client5 has proofing enabled
+   * Client5 is an alternate client to Client1
+   * with proofing enabled
    */
   Client5: {
     campaignId: 'Campaign5',
+    name: 'NHS Test Client 5',
+    features: {
+      proofing: true,
+      routing: false,
+    },
+  },
+  /**
+   * Client6 has no client name set
+   */
+  Client6: {
+    campaignId: 'Campaign6',
     features: {
       proofing: true,
       routing: false,
@@ -70,7 +86,7 @@ export class ClientConfigurationHelper {
   constructor(
     private readonly clientSSMKeyPrefix: string,
     private readonly runId: string
-  ) { }
+  ) {}
 
   async setup() {
     return Promise.all(

tests/test-team/template-mgmt-component-tests/template-mgmt-header.component.spec.ts

@@ -23,7 +23,7 @@ test.describe('Header component', () => {
   let userWithNoIdentityAttributes: TestUser;
   let userWithRoutingEnabled: TestUser;
   let userWithRoutingDisabled: TestUser;
-  let userWithNoClient: TestUser;
+  let userWithNoClientName: TestUser;
 
   test.beforeAll(async () => {
     const authHelper = createAuthHelper();
@@ -41,7 +41,7 @@ test.describe('Header component', () => {
     userWithRoutingDisabled = await authHelper.getTestUser(
       testUsers.User3.userId
     ); // Client2: routing disabled
-    userWithNoClient = await authHelper.getTestUser(testUsers.User6.userId); // Client: NONE
+    userWithNoClientName = await authHelper.getTestUser(testUsers.User8.userId); // Client5: No client name
   });
 
   test.use({ storageState: { cookies: [], origins: [] } });
@@ -153,17 +153,17 @@ test.describe('Header component', () => {
     });
   });
 
-  test('when user belongs to no client, header still renders correctly without client name', async ({
+  test('when user belongs to a client with no name set, header still renders correctly without client name', async ({
     page,
   }) => {
     const startPage = new TemplateMgmtStartPage(page);
 
-    await loginAsUser(userWithNoClient, page);
+    await loginAsUser(userWithNoClientName, page);
 
     await assertHeaderWhenSignedIn({
       page: startPage,
       expectedDisplayName:
-        userWithNoClient.identityAttributes?.preferred_username ?? '',
+        userWithNoClientName.identityAttributes?.preferred_username ?? '',
       expectedClientName: '',
     });