Skip to content

Commit 861a59f

Browse files
alexnuttallalexnuttall
committed
template factory to add clientId
1 parent c5e379f commit 861a59f

21 files changed

+127
-117
lines changed

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

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,40 @@
1+
import { TestUser } from '../auth/cognito-auth-helper';
12
import { Template } from '../types';
23
import { randomUUID } from 'node:crypto';
34

45
export const TemplateFactory = {
56
createEmailTemplate: (
67
id: string,
7-
owner: string,
8+
user: TestUser,
89
name: string = 'test'
910
): Template => {
1011
return TemplateFactory.create({
12+
clientId: user.clientId,
1113
id,
12-
owner,
14+
owner: user.userId,
1315
name,
1416
templateType: 'EMAIL',
1517
message: 'test-message',
1618
subject: 'test-subject',
1719
});
1820
},
1921

20-
createSmsTemplate: (id: string, owner: string): Template => {
22+
createSmsTemplate: (id: string, user: TestUser): Template => {
2123
return TemplateFactory.create({
24+
clientId: user.clientId,
2225
id,
23-
owner,
26+
owner: user.userId,
2427
name: 'test',
2528
templateType: 'SMS',
2629
message: 'test-message',
2730
});
2831
},
2932

30-
createNhsAppTemplate: (id: string, owner: string): Template => {
33+
createNhsAppTemplate: (id: string, user: TestUser): Template => {
3134
return TemplateFactory.create({
35+
clientId: user.clientId,
3236
id,
33-
owner,
37+
owner: user.userId,
3438
name: 'test-name',
3539
templateType: 'NHS_APP',
3640
message: 'test-message',
@@ -39,14 +43,15 @@ export const TemplateFactory = {
3943

4044
createLetterTemplate: (
4145
id: string,
42-
owner: string,
46+
user: TestUser,
4347
name: string,
4448
templateStatus = 'NOT_YET_SUBMITTED',
4549
virusScanStatus = 'PASSED'
4650
): Template => {
4751
return TemplateFactory.create({
52+
clientId: user.clientId,
4853
id,
49-
owner,
54+
owner: user.userId,
5055
name,
5156
templateStatus,
5257
templateType: 'LETTER',

‎tests/test-team/helpers/types.ts‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,14 @@ export type UpdateTemplatePayload = TypeSpecificProperties & {
5050
};
5151

5252
export type Template = TypeSpecificProperties & {
53+
campaignId?: string;
54+
clientId?: string;
5355
createdAt: string;
54-
updatedAt: string;
5556
id: string;
56-
version: number;
5757
name: string;
58-
templateType: string;
59-
templateStatus: string;
6058
owner: string;
59+
templateStatus: string;
60+
templateType: string;
61+
updatedAt: string;
62+
version: number;
6163
};

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ test.describe('POST /v1/template/:templateId/proof', () => {
6767
await templateStorageHelper.seedTemplateData([
6868
TemplateFactory.createLetterTemplate(
6969
userProofingEnabledtemplateId,
70-
userProofingEnabled.userId,
70+
userProofingEnabled,
7171
'userProofingEnabledtemplate',
7272
'PENDING_PROOF_REQUEST'
7373
),
@@ -99,7 +99,7 @@ test.describe('POST /v1/template/:templateId/proof', () => {
9999
const template = {
100100
...TemplateFactory.createLetterTemplate(
101101
templateId,
102-
userProofingEnabled.userId,
102+
userProofingEnabled,
103103
'userProofingEnabledtemplate',
104104
'PENDING_PROOF_REQUEST'
105105
),
@@ -160,7 +160,7 @@ test.describe('POST /v1/template/:templateId/proof', () => {
160160
const template = {
161161
...TemplateFactory.createLetterTemplate(
162162
templateId,
163-
userProofingEnabled.userId,
163+
userProofingEnabled,
164164
'userProofingEnabledtemplate',
165165
'PENDING_VALIDATION'
166166
),
@@ -202,7 +202,7 @@ test.describe('POST /v1/template/:templateId/proof', () => {
202202

203203
const template = TemplateFactory.createEmailTemplate(
204204
templateId,
205-
userProofingEnabled.userId,
205+
userProofingEnabled,
206206
'userProofingEnabledtemplate'
207207
);
208208

@@ -237,7 +237,7 @@ test.describe('POST /v1/template/:templateId/proof', () => {
237237
const template = {
238238
...TemplateFactory.createLetterTemplate(
239239
templateId,
240-
userProofingEnabled.userId,
240+
userProofingEnabled,
241241
'userProofingEnabledtemplate',
242242
// template should not reach this status if proofing is not
243243
// enabled for the client

‎tests/test-team/template-mgmt-component-tests/email/template-mgmt-edit-email-page.component.spec.ts‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,33 @@ import {
1111
} from '../template-mgmt-common.steps';
1212
import {
1313
createAuthHelper,
14+
TestUser,
1415
testUsers,
1516
} from '../../helpers/auth/cognito-auth-helper';
1617

17-
function createTemplates(owner: string) {
18+
function createTemplates(user: TestUser) {
1819
return {
19-
valid: TemplateFactory.createEmailTemplate('valid-email-template', owner),
20-
submit: TemplateFactory.createEmailTemplate('submit-email-template', owner),
20+
valid: TemplateFactory.createEmailTemplate('valid-email-template', user),
21+
submit: TemplateFactory.createEmailTemplate('submit-email-template', user),
2122
submitAndReturn: TemplateFactory.createEmailTemplate(
2223
'submit-and-return-create-email-template',
23-
owner
24+
user
2425
),
2526
goBackAndReturn: TemplateFactory.createEmailTemplate(
2627
'go-back-email-template',
27-
owner
28+
user
2829
),
2930
noEmailTemplateType: TemplateFactory.create({
3031
id: 'no-email-template-type-template',
3132
templateType: 'NHS_APP',
3233
name: 'no-email-template-type-template',
33-
owner,
34+
owner: user.userId,
35+
clientId: user.clientId,
3436
}),
3537
previousData: {
3638
...TemplateFactory.createEmailTemplate(
3739
'previous-data-email-template',
38-
owner
40+
user
3941
),
4042
name: 'previous-data-email-template',
4143
subject: 'previous-data-email-template-subject-line',
@@ -50,7 +52,7 @@ test.describe('Edit Email message template Page', () => {
5052

5153
test.beforeAll(async () => {
5254
const user = await createAuthHelper().getTestUser(testUsers.User1.userId);
53-
templates = createTemplates(user.userId);
55+
templates = createTemplates(user);
5456
await templateStorageHelper.seedTemplateData(Object.values(templates));
5557
});
5658

‎tests/test-team/template-mgmt-component-tests/email/template-mgmt-preview-email-page.component.spec.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ async function createTemplates() {
3333
valid: {
3434
...TemplateFactory.createEmailTemplate(
3535
'valid-email-preview-template',
36-
user.userId
36+
user
3737
),
3838
name: 'test-template-email',
3939
subject: 'test-template-subject-line',

‎tests/test-team/template-mgmt-component-tests/email/template-mgmt-preview-submitted-email-page.component.spec.ts‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,16 @@ import {
1515
} from '../template-mgmt-preview-submitted-common.steps';
1616
import {
1717
createAuthHelper,
18+
TestUser,
1819
testUsers,
1920
} from '../../helpers/auth/cognito-auth-helper';
2021

21-
function createTemplates(owner: string) {
22+
function createTemplates(user: TestUser) {
2223
return {
2324
valid: {
2425
...TemplateFactory.createEmailTemplate(
2526
'valid-email-template-preview-submitted',
26-
owner
27+
user
2728
),
2829
name: 'test-template-email',
2930
subject: 'test-template-subject-line',
@@ -33,7 +34,7 @@ function createTemplates(owner: string) {
3334
invalid: {
3435
...TemplateFactory.createEmailTemplate(
3536
'invalid-email-template-preview-submitted',
36-
owner
37+
user
3738
),
3839
name: 'test-template-email',
3940
subject: 'test-template-subject-line',
@@ -49,7 +50,7 @@ test.describe('Preview submitted Email message template Page', () => {
4950

5051
test.beforeAll(async () => {
5152
const user = await createAuthHelper().getTestUser(testUsers.User1.userId);
52-
templates = createTemplates(user.userId);
53+
templates = createTemplates(user);
5354
await templateStorageHelper.seedTemplateData(Object.values(templates));
5455
});
5556

‎tests/test-team/template-mgmt-component-tests/letter/template-mgmt-preview-letter-page.component.spec.ts‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ async function createTemplates() {
1515

1616
const withProofsBase = TemplateFactory.createLetterTemplate(
1717
'C8814A1D-1F3A-4AE4-9FE3-BDDA76EADF0C',
18-
user.userId,
18+
user,
1919
'proofs-template-letter',
2020
'PROOF_AVAILABLE',
2121
'PASSED'
@@ -52,39 +52,39 @@ async function createTemplates() {
5252
} as Template,
5353
notYetSubmitted: TemplateFactory.createLetterTemplate(
5454
'9AACCD57-C6A3-4273-854C-3839A081B4D9',
55-
user.userId,
55+
user,
5656
'notYetSubmitted',
5757
'NOT_YET_SUBMITTED'
5858
),
5959
pendingProofRequest: TemplateFactory.createLetterTemplate(
6060
'10AE654B-72B5-4A67-913C-2E103C7FF47B',
61-
user.userId,
61+
user,
6262
'pendingProofRequest',
6363
'PENDING_PROOF_REQUEST'
6464
),
6565
pendingUpload: TemplateFactory.createLetterTemplate(
6666
'5C442DA9-B555-4CEA-AFE9-143851FD210B',
67-
user.userId,
67+
user,
6868
'pendingUpload',
6969
'PENDING_UPLOAD'
7070
),
7171
pending: TemplateFactory.createLetterTemplate(
7272
'pending-letter-preview-template',
73-
user.userId,
73+
user,
7474
'test-pending-template-letter',
7575
'PENDING_UPLOAD',
7676
'PENDING'
7777
),
7878
virus: TemplateFactory.createLetterTemplate(
7979
'virus-letter-preview-template',
80-
user.userId,
80+
user,
8181
'test-virus-template-letter',
8282
'VIRUS_SCAN_FAILED',
8383
'FAILED'
8484
),
8585
invalid: TemplateFactory.createLetterTemplate(
8686
'invalid-letter-preview-template',
87-
user.userId,
87+
user,
8888
'test-invalid-template-letter',
8989
'VALIDATION_FAILED',
9090
'PASSED'

‎tests/test-team/template-mgmt-component-tests/letter/template-mgmt-preview-submitted-letter-page.component.spec.ts‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,14 @@ import {
1515
} from '../template-mgmt-preview-submitted-common.steps';
1616
import {
1717
createAuthHelper,
18+
TestUser,
1819
testUsers,
1920
} from '../../helpers/auth/cognito-auth-helper';
2021

21-
function createTemplates(owner: string) {
22+
function createTemplates(user: TestUser) {
2223
const validBase = TemplateFactory.createLetterTemplate(
2324
'valid-letter-template-preview-submitted',
24-
owner,
25+
user,
2526
'valid-email-template-preview-submitted',
2627
'SUBMITTED'
2728
);
@@ -45,7 +46,7 @@ function createTemplates(owner: string) {
4546
invalid: {
4647
...TemplateFactory.createLetterTemplate(
4748
'invalid-letter-template-preview-submitted',
48-
owner,
49+
user,
4950
'invalid-letter-template-preview-submitted',
5051
'NOT_A_STATUS'
5152
),
@@ -59,7 +60,7 @@ test.describe('Preview submitted Letter message template Page', () => {
5960

6061
test.beforeAll(async () => {
6162
const user = await createAuthHelper().getTestUser(testUsers.User1.userId);
62-
templates = createTemplates(user.userId);
63+
templates = createTemplates(user);
6364
await templateStorageHelper.seedTemplateData(Object.values(templates));
6465
});
6566

‎tests/test-team/template-mgmt-component-tests/letter/template-mgmt-request-proof-page.component.spec.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ async function createTemplates() {
1212
return {
1313
valid: TemplateFactory.createLetterTemplate(
1414
'AC85D9AB-9B56-4C34-8CD7-8B713310A37A',
15-
user.userId,
15+
user,
1616
'request-proof'
1717
),
1818
};

‎tests/test-team/template-mgmt-component-tests/nhs-app/template-mgmt-edit-nhs-app-template-page.component.spec.ts‎

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,20 @@ import {
1212
import { Template } from '../../helpers/types';
1313
import {
1414
createAuthHelper,
15+
TestUser,
1516
testUsers,
1617
} from '../../helpers/auth/cognito-auth-helper';
1718

18-
function createTemplates(owner: string) {
19+
function createTemplates(user: TestUser) {
1920
return {
20-
valid: TemplateFactory.createNhsAppTemplate(
21-
'valid-nhs-app-template',
22-
owner
23-
),
21+
valid: TemplateFactory.createNhsAppTemplate('valid-nhs-app-template', user),
2422
submit: TemplateFactory.createNhsAppTemplate(
2523
'submit-nhs-app-template',
26-
owner
24+
user
2725
),
2826
submitAndReturn: TemplateFactory.createNhsAppTemplate(
2927
'submit-and-return-nhs-app-template',
30-
owner
28+
user
3129
),
3230
};
3331
}
@@ -38,7 +36,7 @@ test.describe('Edit NHS App Template Page', () => {
3836

3937
test.beforeAll(async () => {
4038
const user = await createAuthHelper().getTestUser(testUsers.User1.userId);
41-
templates = createTemplates(user.userId);
39+
templates = createTemplates(user);
4240
await templateStorageHelper.seedTemplateData(Object.values(templates));
4341
});
4442

0 commit comments

Comments
 (0)