base-integration.test.ts

import { expect } from "chai";
import * as cheerio from "cheerio";
import { describe } from "mocha";
import nock from "nock";
import request from "supertest";
import { sinon } from "../../../../../test/utils/test-utils.js";
import { CHANNEL, PATH_NAMES } from "../../../../app.constants.js";
import type { NextFunction, Request, Response } from "express";
import { getPermittedJourneyForPath } from "../../../../../test/helpers/session-helper.js";
import { buildMfaMethods } from "../../../../../test/helpers/mfa-helper.js";
import esmock from "esmock";

describe("Integration:: base page ", () => {
  let app: any;

  const setupApp = async (channel: string, showTestBanner?: boolean) => {
    const maybeMockEnvBannerMiddleware =
      showTestBanner != undefined
        ? {
            "../../../../middleware/environment-banner-middleware.js": {
              environmentBannerMiddleware: sinon.fake(function (
                req: Request,
                res: Response,
                next: NextFunction
              ): void {
                res.locals.showTestBanner = showTestBanner;
                next();
              }),
            },
          }
        : {};

    const { createApp } = await esmock(
      "../../../../app.js",
      {},
      {
        "../../../../middleware/session-middleware.js": {
          validateSessionMiddleware: sinon.fake(function (
            req: Request,
            res: Response,
            next: NextFunction
          ): void {
            res.locals.sessionId = "tDy103saszhcxbQq0-mjdzU854";
            if (channel === CHANNEL.WEB) {
              res.locals.webChannel = true;
            } else if (
              channel === CHANNEL.STRATEGIC_APP ||
              channel === CHANNEL.GENERIC_APP
            ) {
              res.locals.isApp = true;
            }

            req.session.client = {
              serviceType: "MANDATORY",
            };
            req.session.user = {
              email: "test@test.com",

              mfaMethods: buildMfaMethods({ phoneNumber: "7867" }),
              journey: getPermittedJourneyForPath(PATH_NAMES.SIGN_IN_OR_CREATE),
            };

            next();
          }),
        },
        ...maybeMockEnvBannerMiddleware,
      }
    );

    app = await createApp();
  };

  beforeEach(() => {
    nock.cleanAll();
  });

  after(() => {
    sinon.restore();
    app = undefined;
  });

  it("should return the sign in or create page", async () => {
    await setupApp(CHANNEL.WEB);
    await request(app).get(PATH_NAMES.SIGN_IN_OR_CREATE).expect(200);
  });

  describe("Web channel", () => {
    let $: any;
    before(async () => {
      await setupApp(CHANNEL.WEB, true);
      const response = await request(app).get(PATH_NAMES.SIGN_IN_OR_CREATE);
      expect(response.status).to.equal(200);
      $ = cheerio.load(response.text);
    });

    it("should render the footer", async () => {
      expect($(".govuk-footer").length).to.equal(1);
    });

    describe("when in a non-production environment", () => {
      it("should render the test phase banner", async () => {
        expect($(".govuk-phase-banner").length).to.equal(1);
        expect($(".govuk-phase-banner").hasClass("test-banner")).to.be.true;
        expect($(".govuk-phase-banner__content__tag").text().trim()).to.equal(
          "test"
        );
      });
      it("should render the test phase header css", async () => {
        expect($("a.govuk-header__link").length).to.equal(1);
        expect($(".strategic-app-header").length).to.equal(0);
        expect($(".govuk-header").hasClass("test-banner")).to.be.true;
      });
    });

    describe("when in a production environment", () => {
      let $: any;
      before(async () => {
        await setupApp(CHANNEL.WEB, false);
        const response = await request(app).get(PATH_NAMES.SIGN_IN_OR_CREATE);
        expect(response.status).to.equal(200);
        $ = cheerio.load(response.text);
      });
      it("should render the beta phase banner", async () => {
        expect($(".govuk-phase-banner").length).to.equal(1);
        expect($(".govuk-phase-banner").hasClass("test-banner")).to.be.false;
        expect($(".govuk-phase-banner__content__tag").text().trim()).to.equal(
          "beta"
        );
      });
      it("should not render the test phase header css", async () => {
        expect($(".govuk-header").hasClass("test-banner")).to.be.false;
        expect($(".strategic-app-header").length).to.equal(0);
        expect($("a.govuk-header__link").length).to.equal(1);
      });
    });
  });

  describe("App (strategic app and generic app) channels", () => {
    const testCases = [CHANNEL.STRATEGIC_APP, CHANNEL.GENERIC_APP];
    let $: any;

    testCases.forEach((channel) => {
      before(async () => {
        await setupApp(channel, true);
        const response = await request(app).get(PATH_NAMES.SIGN_IN_OR_CREATE);
        expect(response.status).to.equal(200);
        $ = cheerio.load(response.text);
      });

      it("should render the custom header with no links", async () => {
        expect($("a.govuk-header__link").length).to.equal(0);
        expect($(".strategic-app-header").length).to.equal(1);
      });

      it("should not render the footer", async () => {
        expect($(".govuk-footer").length).to.equal(0);
      });

      describe("when in a non-production environment", () => {
        it("should render the test phase header css", async () => {
          expect($(".govuk-header").hasClass("test-banner")).to.be.true;
        });
      });

      describe("when in a production environment", () => {
        let $: any;
        before(async () => {
          await setupApp(CHANNEL.STRATEGIC_APP, false);
          const response = await request(app).get(PATH_NAMES.SIGN_IN_OR_CREATE);
          expect(response.status).to.equal(200);
          $ = cheerio.load(response.text);
        });

        it("should not render the test phase header css", async () => {
          expect($(".govuk-header").hasClass("test-banner")).to.be.false;
        });
      });
    });
  });

  describe("Undefined channel", () => {
    it("should render the default header if no value is provided for channel", async () => {
      await setupApp("");
      const response = await request(app).get(PATH_NAMES.SIGN_IN_OR_CREATE);
      expect(response.status).to.equal(200);
      const $ = cheerio.load(response.text);
      expect($("a.govuk-header__link").length).to.equal(1);
    });
  });

  describe("Cache-Control", () => {
    it("should not be cached", async () => {
      await setupApp("");
      const response = await request(app).get(PATH_NAMES.SIGN_IN_OR_CREATE);
      expect(response.header["cache-control"]).to.equal(
        "no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0"
      );
    });
  });
});