refactor campaignId access in tests

Author: alexnuttall

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

@@ -34,6 +34,7 @@ type TestUserStaticDetails = {
 
 type TestUserDynamicDetails = {
   email: string;
+  campaignId?: string;
   campaignIds?: string[];
   clientId: string;
   password: string;
@@ -261,8 +262,8 @@ export class CognitoAuthHelper {
     const clientId = `${userDetails.clientKey}--${this.runId}`;
     const clientConfig: ClientConfiguration | undefined =
       testClients[userDetails.clientKey];
-    const clientName = clientConfig?.name;
-    const campaignIds = clientConfig?.campaignIds;
+
+    const { name: clientName, campaignId, campaignIds } = clientConfig ?? {};
 
     const clientAttributes = [
       { Name: 'custom:sbx_client_id', Value: clientId },
@@ -313,18 +314,20 @@ export class CognitoAuthHelper {
       })
     );
 
+    const sub =
+      user.User?.Attributes?.find((attr) => attr.Name === 'sub')?.Value ?? '';
+
     await CognitoAuthHelper.authContextFile.set(
       this.runId,
       userDetails.userId,
       {
         email,
-        userId:
-          user.User?.Attributes?.find((attr) => attr.Name === 'sub')?.Value ??
-          '',
+        userId: sub,
+        campaignId,
         campaignIds,
-        clientId: clientId,
+        clientId,
         clientKey: userDetails.clientKey,
-        clientName: clientName,
+        clientName,
         identityAttributes,
         password: tempPassword,
       }

tests/test-team/helpers/factories/template-factory.ts

@@ -10,7 +10,7 @@ export const TemplateFactory = {
     name: string = 'test'
   ): Template => {
     return TemplateFactory.create({
-      campaignId: testClients[user.clientKey]?.campaignId,
+      campaignId: user.campaignId,
       clientId: user.clientId,
       id,
       message: 'test-message',
@@ -27,7 +27,7 @@ export const TemplateFactory = {
     name: string = 'test'
   ): Template => {
     return TemplateFactory.create({
-      campaignId: testClients[user.clientKey]?.campaignId,
+      campaignId: user.campaignId,
       clientId: user.clientId,
       id,
       message: 'test-message',
@@ -43,7 +43,7 @@ export const TemplateFactory = {
     name: string = 'test'
   ): Template => {
     return TemplateFactory.create({
-      campaignId: testClients[user.clientKey]?.campaignId,
+      campaignId: user.campaignId,
       clientId: user.clientId,
       id,
       message: 'test-message',

tests/test-team/template-mgmt-api-tests/get-client-configuration.api.spec.ts

@@ -57,7 +57,7 @@ test.describe('GET /v1/client-configuration', () => {
     expect(await response.json()).toEqual({
       statusCode: 200,
       clientConfiguration: {
-        campaignIds: testClients[userWithClientConfig.clientKey]?.campaignIds,
+        campaignIds: userWithClientConfig.campaignIds,
         features: testClients[userWithClientConfig.clientKey]?.features,
       },
     });

tests/test-team/template-mgmt-api-tests/request-proof.api.spec.ts

@@ -115,7 +115,7 @@ test.describe('POST /v1/template/:templateId/proof', () => {
         },
       },
       personalisationParameters: ['nhsNumber'],
-      campaignId: testClients[userProofingEnabled.clientKey]?.campaignIds?.[0],
+      campaignId: userProofingEnabled.campaignIds?.[0],
     };
 
     await templateStorageHelper.seedTemplateData([template]);
@@ -246,7 +246,7 @@ test.describe('POST /v1/template/:templateId/proof', () => {
         },
       },
       personalisationParameters: ['nhsNumber'],
-      campaignId: testClients[userProofingEnabled.clientKey]?.campaignIds?.[0],
+      campaignId: userProofingEnabled.campaignIds?.[0],
     };
 
     await templateStorageHelper.seedTemplateData([template]);

tests/test-team/template-mgmt-api-tests/submit-template.api.spec.ts

@@ -1149,7 +1149,7 @@ test.describe('POST /v1/template/:templateId/submit', () => {
         owner: user1.userId,
         proofingEnabled: true,
         files: { ...baseTemplateData.files, proofs },
-        campaignId: testClients[user1.clientKey]?.campaignIds?.[0],
+        campaignId: user1?.campaignIds?.[0],
       };
 
       await templateStorageHelper.seedTemplateData([template]);
@@ -1170,7 +1170,7 @@ test.describe('POST /v1/template/:templateId/submit', () => {
       expect(updated).toEqual({
         statusCode: 200,
         data: {
-          campaignId: testClients[user1.clientKey]?.campaignIds?.[0],
+          campaignId: user1.campaignIds?.[0],
           clientId: user1.clientId,
           createdAt: expect.stringMatching(isoDateRegExp),
           id: expect.stringMatching(uuidRegExp),

tests/test-team/template-mgmt-api-tests/upload-letter-template.api.spec.ts

@@ -85,7 +85,7 @@ test.describe('POST /v1/letter-template', () => {
     expect(result).toEqual({
       statusCode: 201,
       data: {
-        campaignId: testClients[user1.clientKey]?.campaignIds?.[0],
+        campaignId: user1.campaignIds?.[0],
         createdAt: expect.stringMatching(isoDateRegExp),
         files: {
           pdfTemplate: {
@@ -177,8 +177,7 @@ test.describe('POST /v1/letter-template', () => {
     expect(result).toEqual({
       statusCode: 201,
       data: {
-        campaignId:
-          testClients[userWithFallbackCampaignId.clientKey]?.campaignId,
+        campaignId: userWithFallbackCampaignId.campaignId,
         createdAt: expect.stringMatching(isoDateRegExp),
         files: {
           pdfTemplate: {
@@ -263,7 +262,7 @@ test.describe('POST /v1/letter-template', () => {
     expect(result).toEqual({
       statusCode: 201,
       data: {
-        campaignId: testClients[user1.clientKey]?.campaignIds?.[0],
+        campaignId: user1?.campaignIds?.[0],
         createdAt: expect.stringMatching(isoDateRegExp),
         files: {
           pdfTemplate: {

tests/test-team/template-mgmt-e2e-tests/template-mgmt-proof-request.e2e.spec.ts

@@ -72,7 +72,7 @@ test.describe('SFTP proof request send', () => {
     const pdfVersionId = template.files?.pdfTemplate?.currentVersion;
     const csvVersionId = template.files?.testDataCsv?.currentVersion;
 
-    const campaignId = testClients[user.clientKey]?.campaignIds?.[0];
+    const campaignId = user.campaignIds?.[0];
 
     expect(pdfVersionId).toBeDefined();
     expect(csvVersionId).toBeDefined();