Merge pull request #4 from cabinetoffice/NTRNL-299-add-confirmation-page

Ntrnl 299 add confirmation page

src/config/index.ts

@@ -12,10 +12,13 @@ export const SERVICE_NAME = 'Node Prototype';
 export const LANDING_PAGE = 'info';
 export const NOT_FOUND = 'page-not-found';
 export const ERROR_PAGE = 'error';
+export const CONFIRMATION = 'confirmation';
 
 // Routing paths
 export const LANDING_URL = '/info';
 
 export const INFO_URL = '/info';
 export const HEALTHCHECK_URL = '/healthcheck';
+export const CONFIRMATION_URL = '/confirmation';
 export const SERVICE_URL = `${BASE_URL}${LANDING_URL}`;
+

src/controller/confirmation.controller.ts

@@ -0,0 +1,6 @@
+import { Request, Response } from 'express';
+import * as config from '../config';
+
+export const get = (_req: Request, res: Response) => {
+    return res.render(config.CONFIRMATION);
+};

src/routes/confirmation.ts

@@ -0,0 +1,10 @@
+import { Router } from 'express';
+
+import { get } from '../controller/confirmation.controller';
+import * as config from '../config';
+
+const confirmationRouter = Router();
+
+confirmationRouter.get(config.CONFIRMATION_URL, get);
+
+export default confirmationRouter;

src/routes/index.ts

@@ -3,11 +3,13 @@ import { Router } from 'express';
 import { logger } from '../middleware/logger.middleware';
 import healthcheckRouter from './healthcheck';
 import infoRouter from './info';
+import confirmationRouter from './confirmation';
 
 const router = Router();
 
 router.use(logger);
 router.use(healthcheckRouter);
 router.use(infoRouter);
+router.use(confirmationRouter);
 
 export default router;

src/views/confirmation.html

@@ -0,0 +1,29 @@
+{% extends "layout.html" %}
+
+{% set mainClasses = "govuk-main-wrapper--l" %}
+
+{% block content %}
+  <div class="govuk-grid-row">
+    <div class="govuk-grid-column-two-thirds">
+      {{ govukPanel({
+        titleText: "GitHub request complete",
+        html: "Your reference number<br><strong>987654321</strong>"
+      }) }}
+
+      <p class="govuk-body">We have sent you a confirmation email.</p>
+
+      <h2 class="govuk-heading-m">What happens next</h2>
+
+      <p class="govuk-body">
+        We’ve sent your request to cabinetoffice internal developer platform.
+      </p>
+      <p class="govuk-body">
+        They will contact you either to confirm your request, or to ask for more information.
+      </p>
+
+      <p class="govuk-body">
+        <a href="#" class="govuk-link">What did you think of this service?</a> (takes 30 seconds)
+      </p>
+    </div>
+  </div>
+{% endblock %}

src/views/layout.html

@@ -2,6 +2,7 @@
 
 {% from "govuk/components/footer/macro.njk"           import govukFooter %}
 {% from "govuk/components/header/macro.njk"           import govukHeader %}
+{% from "govuk/components/panel/macro.njk"            import govukPanel %}
 
 {% block head %}
 

test/integration/controller/error.spec.ts

@@ -1,4 +1,5 @@
 jest.mock('../../../src/controller/info.controller');
+jest.mock('../../../src/utils/logger');
 
 import { jest, beforeEach, describe, expect, test } from '@jest/globals';
 import request from 'supertest';

test/integration/routes/confirmation.spec.ts

@@ -0,0 +1,31 @@
+jest.mock('../../../src/middleware/logger.middleware');
+jest.mock('../../../src/utils/logger');
+
+import { jest, beforeEach, describe, expect, test } from '@jest/globals';
+import { Request, Response, NextFunction } from 'express';
+import request from 'supertest';
+
+import app from '../../../src/app';
+import * as config from '../../../src/config';
+import { logger } from '../../../src/middleware/logger.middleware';
+
+import { MOCK_GET_CONFIRMATION_RESPONSE } from '../../mock/text.mock';
+
+const mockedLogger = logger as jest.Mock<typeof logger>;
+mockedLogger.mockImplementation((req: Request, res: Response, next: NextFunction) => next());
+
+describe('Confirmation endpoint integration tests', () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+
+    describe('GET tests', () => {
+        test('should render confirmation template', async () => {
+            const res = await request(app).get(config.CONFIRMATION_URL);
+
+            expect(res.status).toEqual(200);
+            expect(res.text).toContain(MOCK_GET_CONFIRMATION_RESPONSE);
+            expect(mockedLogger).toHaveBeenCalledTimes(1);
+        });
+    });
+});

test/integration/routes/healthcheck.spec.ts

@@ -1,4 +1,5 @@
 jest.mock('../../../src/middleware/logger.middleware');
+jest.mock('../../../src/utils/logger');
 
 import { jest, beforeEach, describe, expect, test } from '@jest/globals';
 import { Request, Response, NextFunction } from 'express';

test/integration/routes/info.spec.ts

@@ -1,4 +1,5 @@
 jest.mock('../../../src/middleware/logger.middleware');
+jest.mock('../../../src/utils/logger');
 
 import { jest, beforeEach, describe, expect, test } from '@jest/globals';
 import { Request, Response, NextFunction } from 'express';

test/mock/text.mock.ts

@@ -1,6 +1,7 @@
 export const MOCK_GET_INFO_RESPONSE = 'Placeholder - Info Page';
 export const MOCK_POST_INFO_RESPONSE = 'post request test';
 export const MOCK_OK_RESPONSE = 'OK';
+export const MOCK_GET_CONFIRMATION_RESPONSE = 'GitHub request complete';
 export const MOCK_NOT_FOUND_RESPONSE = 'Page not found';
 export const MOCK_SERVICE_UNAVAILABLE = 'Sorry, there is a problem with the service';
 export const MOCK_SERVER_ERROR = 'Pipe 3000 requires elevated privileges';

test/unit/controller/confirmation.controller.spec.ts

@@ -0,0 +1,27 @@
+import { describe, expect, afterEach, test, jest } from '@jest/globals';
+import { Request, Response } from 'express';
+
+import { get } from '../../../src/controller/confirmation.controller';
+import * as config from '../../../src/config';
+
+const req = {} as Request;
+
+const mockResponse = () => {
+    const res = {} as Response;
+    res.render = jest.fn().mockReturnValue(res) as any;
+    return res;
+};
+
+describe('Confirmation controller test suites', () => {
+    afterEach(() => {
+        jest.resetAllMocks();
+    });
+
+    test('should render confirmation template', () => {
+        const res = mockResponse();
+
+        get(req, res);
+
+        expect(res.render).toHaveBeenCalledWith(config.CONFIRMATION);
+    });
+});