add sandbox tests

Author: Namitha-Prabhu

tests/sandbox/create-mi-sandbox.spec.ts

@@ -0,0 +1,29 @@
+import { expect, test } from "@playwright/test";
+import {
+  MI_ENDPOINT,
+  SUPPLIER_API_URL_SANDBOX,
+} from "tests/constants/api-constants";
+import { apiSandboxCreateMiTestData } from "./testCases/create-mi-test-cases";
+
+test.describe("Sandbox Tests To Verify Mi Endpoint", () => {
+  for (const {
+    body,
+    expectedResponse,
+    expectedStatus,
+    header,
+    testCase,
+  } of apiSandboxCreateMiTestData) {
+    test(`Post /Mi endpoint returns ${testCase}`, async ({ request }) => {
+      const response = await request.post(
+        `${SUPPLIER_API_URL_SANDBOX}/${MI_ENDPOINT}`,
+        {
+          headers: header,
+          data: body,
+        },
+      );
+      expect(response.status()).toBe(expectedStatus);
+      const responseBody = await response.json();
+      expect(responseBody).toMatchObject(expectedResponse);
+    });
+  }
+});

tests/sandbox/create-mi.spec.ts

@@ -0,0 +1,57 @@
+import { expect, test } from "@playwright/test";
+import {
+  SUPPLIER_API_URL_SANDBOX,
+  SUPPLIER_LETTERS,
+} from "../constants/api-constants";
+import {
+  RequestSandBoxHeaders,
+  sandBoxHeader,
+} from "../constants/request-headers";
+
+test.describe("Sandbox Tests To Get Letter Data", () => {
+  test(`Get Letter Data endpoint returns 200 for valid id`, async ({
+    request,
+  }) => {
+    const id = "2AL5eYSWGzCHlGmzNxuqVusPxDg";
+    const headers: RequestSandBoxHeaders = sandBoxHeader;
+    const response = await request.get(
+      `${SUPPLIER_API_URL_SANDBOX}/${SUPPLIER_LETTERS}/${id}/data`,
+      {
+        headers,
+      },
+    );
+
+    expect(response.status()).toBe(200);
+    expect(response.headers()["content-type"]).toMatch("application/pdf");
+  });
+  test(`Get Letter Data endpoint returns 404 for invalid id`, async ({
+    request,
+  }) => {
+    const id = "invalid-id";
+    const headers: RequestSandBoxHeaders = sandBoxHeader;
+    const response = await request.get(
+      `${SUPPLIER_API_URL_SANDBOX}/${SUPPLIER_LETTERS}/${id}/data`,
+      {
+        headers,
+      },
+    );
+
+    expect(response.status()).toBe(404);
+    const responseBody = await response.json();
+    expect(responseBody).toMatchObject({
+      errors: [
+        {
+          code: "NOTIFY_RESOURCE_NOT_FOUND",
+          detail: "No resource found with that ID",
+          id: expect.any(String),
+          links: {
+            about:
+              "https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier",
+          },
+          status: "404",
+          title: "Resource not found",
+        },
+      ],
+    });
+  });
+});

tests/sandbox/get-letter-data-sandbox.spec.ts

@@ -0,0 +1,139 @@
+import {
+  RequestSandBoxHeaders,
+  sandBoxHeader,
+} from "../../constants/request-headers";
+import { ErrorMessageBody } from "../../helpers/common-types";
+import {
+  NoRequestIdHeaders,
+  SandboxErrorResponse,
+} from "./get-list-of-letters-test-cases";
+
+type ApiSandboxMiRequestTestCase = {
+  testCase: string;
+  header?: RequestSandBoxHeaders | NoRequestIdHeaders;
+  body: MiRequestBody;
+  expectedResponse: MiRequestBody | ErrorMessageBody | SandboxErrorResponse;
+  expectedStatus: number;
+};
+
+export type MiRequestBody = {
+  data: {
+    type: string;
+    attributes: {
+      groupId: string;
+      lineItem: string;
+      quantity: number;
+      specificationId: string;
+      stockRemaining: number;
+      timestamp: string;
+    };
+  };
+};
+
+export const apiSandboxCreateMiTestData: ApiSandboxMiRequestTestCase[] = [
+  {
+    testCase: "200 when a valid request is passed",
+    header: sandBoxHeader,
+    body: miValidSandboxRequest(),
+    expectedStatus: 200,
+    expectedResponse: {
+      data: {
+        attributes: {
+          groupId: "abc123",
+          lineItem: "envelope-business-standard",
+          quantity: 22,
+          specificationId: "2WL5eYSWGzCHlGmzNxuqVusPxDg",
+          stockRemaining: 2000,
+          timestamp: "2023-11-17T14:27:51.413Z",
+        },
+        type: "ManagementInformation",
+      },
+    },
+  },
+  {
+    testCase: "400 when a invalid timestamp is passed",
+    header: sandBoxHeader,
+    body: miInvalidDateSandboxRequest(),
+    expectedStatus: 400,
+    expectedResponse: {
+      message:
+        'request.body.data.attributes.timestamp should match format "date-time"',
+      errors: [
+        {
+          path: ".body.data.attributes.timestamp",
+          message: 'should match format "date-time"',
+          errorCode: "format.openapi.validation",
+        },
+      ],
+    },
+  },
+  {
+    testCase: "404 when a invalid id is passed",
+    header: sandBoxHeader,
+    body: miInvalidSandboxRequest(),
+    expectedStatus: 404,
+    expectedResponse: {
+      errors: [
+        {
+          id: "rrt-1931948104716186917-c-geu2-10664-3111479-3.0",
+          code: "NOTIFY_RESOURCE_NOT_FOUND",
+          links: {
+            about:
+              "https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier",
+          },
+          status: "404",
+          title: "Resource not found",
+          detail: "No resource found with that ID",
+        },
+      ],
+    },
+  },
+];
+
+export function miValidSandboxRequest(): MiRequestBody {
+  return {
+    data: {
+      attributes: {
+        groupId: "abc123",
+        lineItem: "envelope-business-standard",
+        quantity: 22,
+        specificationId: "2WL5eYSWGzCHlGmzNxuqVusPxDg",
+        stockRemaining: 2000,
+        timestamp: "2023-11-17T14:27:51.413Z",
+      },
+      type: "ManagementInformation",
+    },
+  };
+}
+
+export function miInvalidSandboxRequest(): MiRequestBody {
+  return {
+    data: {
+      attributes: {
+        groupId: "abc123",
+        lineItem: "envelope-business-standard",
+        quantity: 22,
+        specificationId: "",
+        stockRemaining: 2000,
+        timestamp: "2023-11-17T14:27:51.413Z",
+      },
+      type: "ManagementInformation",
+    },
+  };
+}
+
+export function miInvalidDateSandboxRequest(): MiRequestBody {
+  return {
+    data: {
+      attributes: {
+        groupId: "abc123",
+        lineItem: "envelope-business-standard",
+        quantity: 22,
+        specificationId: "2WL5eYSWGzCHlGmzNxuqVusPxDg",
+        stockRemaining: 2000,
+        timestamp: "yesterday",
+      },
+      type: "ManagementInformation",
+    },
+  };
+}