Merge pull request #1638 from govuk-one-login/BAU/use-common-variable…

…s-in-more-tests Bau/use common variables in more tests
govuk-one-login · May 22, 2024 · 8e10924 · 8e10924
2 parents b2c75d6 + 7b13f28
commit 8e10924
Show file tree

Hide file tree

Showing 34 changed files with 78 additions and 286 deletions.
diff --git a/src/components/account-creation/resend-mfa-code/tests/resend-mfa-code-controller.test.ts b/src/components/account-creation/resend-mfa-code/tests/resend-mfa-code-controller.test.ts
@@ -12,14 +12,21 @@ import { PATH_NAMES } from "../../../../app.constants";
 import { mockResponse, RequestOutput, ResponseOutput } from "mock-req-res";
 import { SendNotificationServiceInterface } from "../../../common/send-notification/types";
 import { createMockRequest } from "../../../../../test/helpers/mock-request-helper";
+import { commonVariables } from "../../../../../test/helpers/common-test-variables";
 
 describe("resend mfa controller", () => {
   let req: RequestOutput;
   let res: ResponseOutput;
+  const { sessionId, clientSessionId, diPersistentSessionId, ip, email } =
+    commonVariables;
 
   beforeEach(() => {
     req = createMockRequest(PATH_NAMES.CHECK_YOUR_PHONE);
+    req.ip = ip;
     res = mockResponse();
+    res.locals.sessionId = sessionId;
+    res.locals.clientSessionId = clientSessionId;
+    res.locals.persistentSessionId = diPersistentSessionId;
   });
 
   afterEach(() => {
@@ -44,10 +51,6 @@ describe("resend mfa controller", () => {
         }),
       } as unknown as SendNotificationServiceInterface;
 
-      res.locals.sessionId = "123456-djjad";
-      req.session.user = {
-        email: "[email protected]",
-      };
       req.path = PATH_NAMES.RESEND_MFA_CODE_ACCOUNT_CREATION;
 
       await resendMfaCodePost(fakeService)(req as Request, res as Response);
@@ -62,24 +65,20 @@ describe("resend mfa controller", () => {
           success: true,
         }),
       } as unknown as SendNotificationServiceInterface;
-      res.locals.sessionId = "123456-djjad";
-      res.locals.clientSessionId = "654321-djjad";
-      res.locals.persistentSessionId = "123123-djjad";
 
       req.session.user = {
-        email: "[email protected]",
+        email,
         isAccountRecoveryJourney: true,
       };
       req.path = PATH_NAMES.RESEND_MFA_CODE_ACCOUNT_CREATION;
-      req.ip = "127.0.0.1";
       await resendMfaCodePost(fakeService)(req as Request, res as Response);
       expect(fakeService.sendNotification).to.have.been.calledWith(
-        "123456-djjad",
-        "654321-djjad",
-        "[email protected]",
+        sessionId,
+        clientSessionId,
+        email,
         "VERIFY_PHONE_NUMBER",
-        "127.0.0.1",
-        "123123-djjad",
+        ip,
+        diPersistentSessionId,
         "",
         req,
         "ACCOUNT_RECOVERY"
@@ -92,24 +91,20 @@ describe("resend mfa controller", () => {
           success: true,
         }),
       } as unknown as SendNotificationServiceInterface;
-      res.locals.sessionId = "123456-djjad";
-      res.locals.clientSessionId = "654321-djjad";
-      res.locals.persistentSessionId = "123123-djjad";
 
       req.session.user = {
-        email: "[email protected]",
+        email,
         isAccountCreationJourney: true,
       };
       req.path = PATH_NAMES.RESEND_MFA_CODE_ACCOUNT_CREATION;
-      req.ip = "127.0.0.1";
       await resendMfaCodePost(fakeService)(req as Request, res as Response);
       expect(fakeService.sendNotification).to.have.been.calledWith(
-        "123456-djjad",
-        "654321-djjad",
-        "[email protected]",
+        sessionId,
+        clientSessionId,
+        email,
         "VERIFY_PHONE_NUMBER",
-        "127.0.0.1",
-        "123123-djjad",
+        ip,
+        diPersistentSessionId,
         "",
         req,
         "REGISTRATION"

diff --git a/...s/account-intervention-controller.test.ts → ...assword-reset-required-controller.test.ts b/...s/account-intervention-controller.test.ts → ...assword-reset-required-controller.test.ts
@@ -8,7 +8,7 @@ import { passwordResetRequiredGet } from "../password-reset-required-controller"
 import { PATH_NAMES } from "../../../../app.constants";
 import { createMockRequest } from "../../../../../test/helpers/mock-request-helper";
 
-describe("account intervention controller", () => {
+describe("password reset required controller", () => {
   let req: RequestOutput;
   let res: ResponseOutput;
 

diff --git a/src/components/account-intervention/tests/account-intervention-service.test.ts b/src/components/account-intervention/tests/account-intervention-service.test.ts
@@ -4,7 +4,6 @@ import { AccountInterventionsInterface } from "../types";
 import { accountInterventionService } from "../account-intervention-service";
 import {
   checkApiCallMadeWithExpectedBodyAndHeaders,
-  commonVariables,
   expectedHeadersFromCommonVarsWithSecurityHeaders,
   requestHeadersWithIpAndAuditEncoded,
   resetApiKeyAndBaseUrlEnvVars,
@@ -13,6 +12,7 @@ import {
 import { API_ENDPOINTS, PATH_NAMES } from "../../../app.constants";
 import { Http } from "../../../utils/http";
 import { createMockRequest } from "../../../../test/helpers/mock-request-helper";
+import { commonVariables } from "../../../../test/helpers/common-test-variables";
 
 describe("account interventions service", () => {
   const httpInstance = new Http();

diff --git a/src/components/authorize/tests/authorize-service.test.ts b/src/components/authorize/tests/authorize-service.test.ts
@@ -8,12 +8,12 @@ import { SinonStub } from "sinon";
 import { AuthorizeServiceInterface } from "../types";
 import { createMockRequest } from "../../../../test/helpers/mock-request-helper";
 import {
-  commonVariables,
   expectedHeadersFromCommonVarsWithSecurityHeaders,
   requestHeadersWithIpAndAuditEncoded,
   resetApiKeyAndBaseUrlEnvVars,
   setupApiKeyAndBaseUrlEnvVars,
 } from "../../../../test/helpers/service-test-helper";
+import { commonVariables } from "../../../../test/helpers/common-test-variables";
 
 describe("authorize service", () => {
   let getStub: SinonStub;

diff --git a/src/components/check-email-fraud-block/tests/check-email-fraud-block-service.test.ts b/src/components/check-email-fraud-block/tests/check-email-fraud-block-service.test.ts
@@ -5,7 +5,6 @@ import { CheckEmailFraudBlockInterface } from "../types";
 import { checkEmailFraudBlockService } from "../check-email-fraud-block-service";
 import {
   checkApiCallMadeWithExpectedBodyAndHeaders,
-  commonVariables,
   expectedHeadersFromCommonVarsWithSecurityHeaders,
   requestHeadersWithIpAndAuditEncoded,
   resetApiKeyAndBaseUrlEnvVars,
@@ -17,6 +16,7 @@ import {
   PATH_NAMES,
 } from "../../../app.constants";
 import { createMockRequest } from "../../../../test/helpers/mock-request-helper";
+import { commonVariables } from "../../../../test/helpers/common-test-variables";
 
 describe("check email fraud block service", () => {
   const httpInstance = new Http();

diff --git a/src/components/check-reauth-users/tests/check-reauth-user-service.test.ts b/src/components/check-reauth-users/tests/check-reauth-user-service.test.ts
@@ -7,13 +7,13 @@ import { checkReauthUsersService } from "../check-reauth-users-service";
 import { CheckReauthServiceInterface } from "../types";
 import {
   checkApiCallMadeWithExpectedBodyAndHeaders,
-  commonVariables,
   expectedHeadersFromCommonVarsWithSecurityHeaders,
   requestHeadersWithIpAndAuditEncoded,
   resetApiKeyAndBaseUrlEnvVars,
   setupApiKeyAndBaseUrlEnvVars,
 } from "../../../../test/helpers/service-test-helper";
 import { createMockRequest } from "../../../../test/helpers/mock-request-helper";
+import { commonVariables } from "../../../../test/helpers/common-test-variables";
 
 describe("re-authentication service", () => {
   const httpInstance = new Http();

diff --git a/src/components/common/account-recovery/tests/account-recovery-service.test.ts b/src/components/common/account-recovery/tests/account-recovery-service.test.ts
@@ -5,14 +5,14 @@ import { AccountRecoveryInterface } from "../types";
 import { accountRecoveryService } from "../account-recovery-service";
 import {
   checkApiCallMadeWithExpectedBodyAndHeaders,
-  commonVariables,
   expectedHeadersFromCommonVarsWithSecurityHeaders,
   requestHeadersWithIpAndAuditEncoded,
   resetApiKeyAndBaseUrlEnvVars,
   setupApiKeyAndBaseUrlEnvVars,
 } from "../../../../../test/helpers/service-test-helper";
 import { API_ENDPOINTS, PATH_NAMES } from "../../../../app.constants";
 import { createMockRequest } from "../../../../../test/helpers/mock-request-helper";
+import { commonVariables } from "../../../../../test/helpers/common-test-variables";
 
 describe("account recovery service", () => {
   const httpInstance = new Http();

diff --git a/src/components/common/mfa/tests/mfa-service.test.ts b/src/components/common/mfa/tests/mfa-service.test.ts
@@ -5,7 +5,6 @@ import { MfaServiceInterface } from "../types";
 import { mfaService } from "../mfa-service";
 import {
   checkApiCallMadeWithExpectedBodyAndHeaders,
-  commonVariables,
   expectedHeadersFromCommonVarsWithSecurityHeaders,
   requestHeadersWithIpAndAuditEncoded,
   resetApiKeyAndBaseUrlEnvVars,
@@ -18,6 +17,7 @@ import {
   PATH_NAMES,
 } from "../../../../app.constants";
 import { createMockRequest } from "../../../../../test/helpers/mock-request-helper";
+import { commonVariables } from "../../../../../test/helpers/common-test-variables";
 
 describe("mfa service", () => {
   const httpInstance = new Http();

diff --git a/src/components/common/send-notification/tests/send-notification-service.test.ts b/src/components/common/send-notification/tests/send-notification-service.test.ts
@@ -3,7 +3,6 @@ import sinon, { SinonStub } from "sinon";
 import { Http } from "../../../../utils/http";
 import {
   checkApiCallMadeWithExpectedBodyAndHeaders,
-  commonVariables,
   expectedHeadersFromCommonVarsWithSecurityHeaders,
   requestHeadersWithIpAndAuditEncoded,
   resetApiKeyAndBaseUrlEnvVars,
@@ -18,6 +17,7 @@ import { SendNotificationServiceInterface } from "../types";
 import { sendNotificationService } from "../send-notification-service";
 import { JOURNEY_TYPE } from "../../constants";
 import { createMockRequest } from "../../../../../test/helpers/mock-request-helper";
+import { commonVariables } from "../../../../../test/helpers/common-test-variables";
 
 describe("send notification service", () => {
   let postStub: SinonStub;

diff --git a/src/components/common/update-profile/tests/update-profile-service.test.ts b/src/components/common/update-profile/tests/update-profile-service.test.ts
@@ -4,7 +4,6 @@ import { Http } from "../../../../utils/http";
 import { UpdateProfileServiceInterface, UpdateType } from "../types";
 import {
   checkApiCallMadeWithExpectedBodyAndHeaders,
-  commonVariables,
   expectedHeadersFromCommonVarsWithSecurityHeaders,
   requestHeadersWithIpAndAuditEncoded,
   resetApiKeyAndBaseUrlEnvVars,
@@ -17,6 +16,7 @@ import {
 } from "../../../../app.constants";
 import { updateProfileService } from "../update-profile-service";
 import { createMockRequest } from "../../../../../test/helpers/mock-request-helper";
+import { commonVariables } from "../../../../../test/helpers/common-test-variables";
 
 describe("update profile service", () => {
   const httpInstance = new Http();

diff --git a/src/components/common/verify-code/tests/verify-code-service.test.ts b/src/components/common/verify-code/tests/verify-code-service.test.ts
@@ -3,7 +3,6 @@ import sinon, { SinonStub } from "sinon";
 import { Http } from "../../../../utils/http";
 import {
   checkApiCallMadeWithExpectedBodyAndHeaders,
-  commonVariables,
   expectedHeadersFromCommonVarsWithSecurityHeaders,
   requestHeadersWithIpAndAuditEncoded,
   resetApiKeyAndBaseUrlEnvVars,
@@ -19,6 +18,7 @@ import {
 import { VerifyCodeInterface } from "../types";
 import { codeService } from "../verify-code-service";
 import { createMockRequest } from "../../../../../test/helpers/mock-request-helper";
+import { commonVariables } from "../../../../../test/helpers/common-test-variables";
 
 describe("verify code service", () => {
   const httpInstance = new Http();

diff --git a/src/components/common/verify-mfa-code/tests/verify-mfa-code-service.test.ts b/src/components/common/verify-mfa-code/tests/verify-mfa-code-service.test.ts
@@ -3,7 +3,6 @@ import sinon, { SinonStub } from "sinon";
 import { Http } from "../../../../utils/http";
 import {
   checkApiCallMadeWithExpectedBodyAndHeaders,
-  commonVariables,
   expectedHeadersFromCommonVarsWithSecurityHeaders,
   requestHeadersWithIpAndAuditEncoded,
   resetApiKeyAndBaseUrlEnvVars,
@@ -19,6 +18,7 @@ import {
 import { VerifyMfaCodeInterface } from "../../../enter-authenticator-app-code/types";
 import { verifyMfaCodeService } from "../verify-mfa-code-service";
 import { createMockRequest } from "../../../../../test/helpers/mock-request-helper";
+import { commonVariables } from "../../../../../test/helpers/common-test-variables";
 
 describe("verify mfa code service", () => {
   const httpInstance = new Http();

diff --git a/src/components/create-password/tests/create-password-service.test.ts b/src/components/create-password/tests/create-password-service.test.ts
@@ -2,7 +2,6 @@ import { describe } from "mocha";
 import sinon, { SinonStub } from "sinon";
 import {
   checkApiCallMadeWithExpectedBodyAndHeaders,
-  commonVariables,
   expectedHeadersFromCommonVarsWithSecurityHeaders,
   requestHeadersWithIpAndAuditEncoded,
   resetApiKeyAndBaseUrlEnvVars,
@@ -17,6 +16,7 @@ import {
   PATH_NAMES,
 } from "../../../app.constants";
 import { createMockRequest } from "../../../../test/helpers/mock-request-helper";
+import { commonVariables } from "../../../../test/helpers/common-test-variables";
 
 describe("create password service", () => {
   const httpInstance = new Http();

diff --git a/src/components/doc-checking-app/tests/doc-checking-app-controller.test.ts b/src/components/doc-checking-app/tests/doc-checking-app-controller.test.ts
@@ -34,10 +34,6 @@ describe("doc checking app controller", () => {
         }),
       } as unknown as DocCheckingAppInterface;
 
-      res.locals.sessionId = "s-123456-djjad";
-      res.locals.clientSessionId = "c-123456-djjad";
-      res.locals.persistentSessionId = "dips-123456-abc";
-
       await docCheckingAppGet(fakeService)(req as Request, res as Response);
 
       expect(req.session.user.journey.nextPath).to.equal(
@@ -55,10 +51,6 @@ describe("doc checking app controller", () => {
         }),
       } as unknown as DocCheckingAppInterface;
 
-      res.locals.sessionId = "s-123456-djjad";
-      res.locals.clientSessionId = "c-123456-djjad";
-      res.locals.persistentSessionId = "dips-123456-abc";
-
       await expect(
         docCheckingAppGet(fakeService)(req as Request, res as Response)
       ).to.be.rejectedWith("1222:Error occurred");

diff --git a/src/components/doc-checking-app/tests/doc-checking-app-service.test.ts b/src/components/doc-checking-app/tests/doc-checking-app-service.test.ts
@@ -2,7 +2,6 @@ import { describe } from "mocha";
 import sinon, { SinonStub } from "sinon";
 import {
   checkApiCallMadeWithExpectedBodyAndHeaders,
-  commonVariables,
   expectedHeadersFromCommonVarsWithSecurityHeaders,
   requestHeadersWithIpAndAuditEncoded,
   resetApiKeyAndBaseUrlEnvVars,
@@ -17,6 +16,7 @@ import {
   PATH_NAMES,
 } from "../../../app.constants";
 import { createMockRequest } from "../../../../test/helpers/mock-request-helper";
+import { commonVariables } from "../../../../test/helpers/common-test-variables";
 
 describe("mfa service", () => {
   const httpInstance = new Http();