add api handler tests for get-mi

Author: RossFaulds171

lambdas/api-handler/src/contracts/errors.ts

@@ -29,6 +29,7 @@ export enum ApiErrorStatus {
 
 export enum ApiErrorDetail {
   NotFoundLetterId = "No resource found with that ID",
+  NotFoundMiId = "No resource found with that ID",
   InvalidRequestMissingBody = "The request is missing the body",
   InvalidRequestMissingLetterIdPathParameter = "The request is missing the letter id path parameter",
   InvalidRequestLetterIdsMismatch = "The letter ID in the request body does not match the letter ID path parameter",

lambdas/api-handler/src/handlers/__tests__/get-mi.test.ts

@@ -0,0 +1,165 @@
+import { Context } from "aws-lambda";
+import { mockDeep } from "jest-mock-extended";
+import pino from "pino";
+import { MIRepository } from "@internal/datastore/src";
+import { gettMI as getMiOperation } from "../../services/mi-operations";
+import { makeApiGwEvent } from "./utils/test-utils";
+import { ApiErrorDetail } from "../../contracts/errors";
+import NotFoundError from "../../errors/not-found-error";
+import { Deps } from "../../config/deps";
+import { EnvVars } from "../../config/env";
+import createGetMIHandler from "../get-mi";
+
+jest.mock("../../services/mi-operations");
+
+describe("API Lambda handler", () => {
+  const mockedDeps: jest.Mocked<Deps> = {
+    miRepo: {} as unknown as MIRepository,
+    logger: { info: jest.fn(), error: jest.fn() } as unknown as pino.Logger,
+    env: {
+      SUPPLIER_ID_HEADER: "nhsd-supplier-id",
+      APIM_CORRELATION_HEADER: "nhsd-correlation-id",
+      DOWNLOAD_URL_TTL_SECONDS: 1,
+    } as unknown as EnvVars,
+  } as Deps;
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+    jest.resetModules();
+  });
+
+  it("returns 200 OK and the letter status", async () => {
+    const mockedGetMiById = getMiOperation as jest.Mock;
+    mockedGetMiById.mockResolvedValue({
+        data:{
+            id: "id1",
+            type: "ManagementInformation",
+            attributes: {
+                lineItem: "envelope-business-standard",
+                timestamp: "2023-11-17T14:27:51.413Z",
+                quantity: 22,
+                specificationId: "spec1",
+                groupId: "group1",
+                stockRemaining: 20_000,
+            },
+        },
+    });
+
+    const event = makeApiGwEvent({
+      path: "/mi/id1",
+      headers: {
+        "nhsd-supplier-id": "supplier1",
+        "nhsd-correlation-id": "correlationId",
+        "x-request-id": "requestId",
+      },
+      pathParameters: { id: "id1" },
+    });
+
+    const getMi = createGetMiHandler(mockedDeps);
+    const result = await getMi(event, mockDeep<Context>(), jest.fn());
+
+    const expected = {
+        data:{
+            id: "id1",
+            type: "ManagementInformation",
+            attributes: {
+                lineItem: "envelope-business-standard",
+                timestamp: "2023-11-17T14:27:51.413Z",
+                quantity: 22,
+                specificationId: "spec1",
+                groupId: "group1",
+                stockRemaining: 20_000,
+            },
+        },
+    };
+
+    expect(result).toEqual({
+      statusCode: 200,
+      body: JSON.stringify(expected),
+    });
+  });
+
+  it("returns 404 Not Found when MI matching id is not found", async () => {
+    const mockedGetMiById = getMiOperation as jest.Mock;
+
+    mockedGetMiById.mockImplementation(() => {
+      throw new NotFoundError(ApiErrorDetail.NotFoundMiId);
+    });
+
+    const event = makeApiGwEvent({
+      path: "/mi/id1",
+      headers: {
+        "nhsd-supplier-id": "supplier1",
+        "nhsd-correlation-id": "correlationId",
+        "x-request-id": "requestId",
+      },
+      pathParameters: { id: "id1" },
+    });
+
+    const getMi = createGetMiHandler(mockedDeps);
+    const result = await getMi(event, mockDeep<Context>(), jest.fn());
+
+    expect(result).toEqual(
+      expect.objectContaining({
+        statusCode: 404,
+      }),
+    );
+  });
+
+  it("returns 500 when correlation id is missing from header", async () => {
+    const event = makeApiGwEvent({
+      path: "/mi/id1",
+      headers: { "nhsd-supplier-id": "supplier1", "x-request-id": "requestId" },
+      pathParameters: { id: "id1" },
+    });
+
+    const getMi = createGetMiHandler(mockedDeps);
+    const result = await getMi(event, mockDeep<Context>(), jest.fn());
+
+    expect(result).toEqual(
+      expect.objectContaining({
+        statusCode: 500,
+      }),
+    );
+  });
+
+  it("returns 500 when supplier id is missing from header", async () => {
+    const event = makeApiGwEvent({
+      path: "/mi/id1",
+      headers: {
+        "nhsd-correlation-id": "correlationId",
+        "x-request-id": "requestId",
+      },
+      pathParameters: { id: "id1" },
+    });
+
+    const getMi = createGetMiHandler(mockedDeps);
+    const result = await getMi(event, mockDeep<Context>(), jest.fn());
+
+    expect(result).toEqual(
+      expect.objectContaining({
+        statusCode: 500,
+      }),
+    );
+  });
+
+  it("returns 400 when letter id is missing from path", async () => {
+    const event = makeApiGwEvent({
+      path: "/mi/id1",
+      headers: {
+        "nhsd-supplier-id": "supplier1",
+        "nhsd-correlation-id": "correlationId",
+        "x-request-id": "requestId",
+      },
+    });
+
+    const getMi = createGetLetterHandler(mockedDeps);
+    const result = await getMi(event, mockDeep<Context>(), jest.fn());
+
+    expect(result).toEqual(
+      expect.objectContaining({
+        statusCode: 400,
+      }),
+    );
+  });
+});