CCM 12179: Add Component Tests

Makefile

@@ -98,6 +98,8 @@ config:: _install-dependencies version # Configure development environment (main
 	npm install
 	(cd docs && make install && cd ..)
 
+test-component:
+	(cd tests && npm install && npm run test:component)
 
 version:
 	rm -f .version

package.json

@@ -1,12 +1,18 @@
 {
   "dependencies": {
+    "@aws-sdk/client-api-gateway": "^3.906.0",
+    "@playwright/test": "^1.55.1",
+    "ajv": "^8.17.1",
+    "js-yaml": "^4.1.0",
+    "openapi-response-validator": "^12.1.3",
     "serve": "^14.2.4"
   },
   "devDependencies": {
     "@openapitools/openapi-generator-cli": "^2.21.4",
     "@redocly/cli": "^1.34.5",
     "@tsconfig/node22": "^22.0.2",
     "@types/jest": "^29.5.14",
+    "@types/js-yaml": "^4.0.9",
     "@typescript-eslint/eslint-plugin": "^8.27.0",
     "@typescript-eslint/parser": "^8.27.0",
     "esbuild": "^0.24.0",

tests/.gitignore

@@ -7,3 +7,5 @@ node_modules/
 /playwright/.cache/
 /allure-results
 /target
+/playwright/.auth/
+/allure-report

tests/component-tests/apiGateway-tests/getLetters.spec.ts

@@ -0,0 +1,68 @@
+import { test, expect } from '@playwright/test';
+import { SUPPLIER_LETTERS, AWS_REGION } from '../../constants/api_constants';
+import { createHeaderWithNoCorrelationId, createInvalidRequestHeaders, createValidRequestHeaders } from '../../constants/request_headers';
+import { validateApiResponse } from '../../helpers/validateJsonSchema';
+import { getRestApiGatewayBaseUrl } from '../../helpers/awsGatewayHelper';
+
+let baseUrl: string;
+
+test.beforeAll(async () => {
+  const region = AWS_REGION;
+  baseUrl = await getRestApiGatewayBaseUrl();
+});
+
+test.describe('API Gateway Tests To Get List Of Pending ', () =>
+{
+  test('GET /letters should return 200 and list items', async ({ request }) =>
+  {
+    const header = await createValidRequestHeaders();
+    const response = await request.get(`${baseUrl}/${SUPPLIER_LETTERS}` ,{
+      headers: header,
+      params: {
+        limit:'2'},
+      },
+    );
+
+    expect(response.status()).toBe(200);
+    const responseBody = await response.json();
+  });
+
+  test('GET /letters with invalid authentication should return 403', async ({ request }) => {
+    const header = await createInvalidRequestHeaders();
+    const response = await request.get(`${baseUrl}/${SUPPLIER_LETTERS}` ,{
+      headers: header,
+      params:{
+        limit:'2'
+        },
+      },
+    );
+    expect(response.status()).toBe(403);
+  });
+
+
+  test('GET /letters with empty correlationId should return 500', async ({ request }) => {
+    const header = await createHeaderWithNoCorrelationId();
+    const response = await request.get(`${baseUrl}/${SUPPLIER_LETTERS}` ,{
+      headers: header,
+      params:{
+        limit:'2'
+        },
+      },
+    );
+    expect(response.status()).toBe(500);
+    const responseBody = await response.json();
+  });
+
+  test('GET /letters with invalid query param return 400', async ({ request }) => {
+    const header = await createValidRequestHeaders();
+    const response = await request.get(`${baseUrl}/${SUPPLIER_LETTERS}` ,{
+        headers: header,
+        params:{
+          limit:'?'
+        },
+      });
+    expect(response.status()).toBe(400);
+    const responseBody = await response.json();
+  });
+
+});

tests/component-tests/apiGateway-tests/testCases/UpdateLetterStatus.ts

@@ -0,0 +1,93 @@
+
+import { RequestHeaders } from '../../../constants/request_headers';
+import { supplierId } from '../../../constants/api_constants';
+
+export type PatchMessageRequestBody = {
+  data: {
+    type: string;
+    id: string;
+    attributes: {
+      reasonCode?: string | number;
+      reasonText?: string;
+      status: string;
+    };
+  };
+};
+
+export type ErrorLink = {
+  about: string;
+};
+
+type PatchErrorResponse = {
+  id: string;
+  code: string;
+  links: ErrorLink;
+  status: string;
+  title: string;
+  detail: string;
+};
+
+export type PatchErrorMessageBody = {
+  errors: PatchErrorResponse[];
+};
+
+
+export type PatchMessageResponseBody = {
+  data: {
+    type: string;
+    id: string;
+    attributes: {
+      reasonCode?: number;
+      reasonText?: string;
+      status: string;
+      specificationId:string;
+      groupId?:string;
+    };
+  };
+};
+
+export async function patchRequestHeaders(): Promise<RequestHeaders> {
+  let requestHeaders: RequestHeaders;
+    requestHeaders = {
+        headerauth1: process.env.HEADERAUTH || '',
+        'NHSD-Supplier-ID': supplierId,
+        'NHSD-Correlation-ID': '12344',
+        'X-Request-ID': 'requestId1'
+    };
+  return requestHeaders;
+};
+
+
+export async function patchValidRequestBody (id: string, status: string) : Promise<PatchMessageRequestBody>{
+  let requestBody: PatchMessageRequestBody;
+
+  requestBody = {
+    data: {
+       attributes: {
+          status: status,
+      },
+      type: 'Letter',
+      id: id
+    }
+
+  };
+  return requestBody;
+}
+
+export async function patchFailureRequestBody (id: string, status: string) : Promise<PatchMessageRequestBody>{
+  let requestBody: PatchMessageRequestBody;
+
+  requestBody = {
+    data: {
+        attributes: {
+          status: status,
+          reasonCode: 123,
+          reasonText: 'Test Reason'
+      },
+      type: 'Letter',
+      id: id
+    }
+
+  };
+  return requestBody;
+}

tests/component-tests/apiGateway-tests/updateLetterStatus.spec.ts

@@ -0,0 +1,117 @@
+import { test, expect } from '@playwright/test';
+import { SUPPLIER_LETTERS, supplierId } from '../../constants/api_constants';
+import { getRestApiGatewayBaseUrl } from '../../helpers/awsGatewayHelper';
+import { patchFailureRequestBody, patchRequestHeaders, patchValidRequestBody } from './testCases/UpdateLetterStatus';
+import { createTestData, deleteLettersBySupplier, getLettersBySupplier } from '../../helpers/generate_fetch_testData';
+import { randomUUID } from 'crypto';
+import { createInvalidRequestHeaders } from '../../constants/request_headers';
+
+let baseUrl: string;
+
+test.beforeAll(async () => {
+  baseUrl = await getRestApiGatewayBaseUrl();
+});
+
+test.describe('API Gateway Tests to Verify Patch Status Endpoint', () => {
+    test(`Patch /letters returns 200 and status is updated to ACCEPTED`, async ({ request }) => {
+
+      await createTestData(supplierId);
+      const letters = await getLettersBySupplier(supplierId, 'PENDING', 1);
+
+      if (!letters?.length) {
+        test.fail(true, `No PENDING letters found for supplier ${supplierId}`);
+        return;
+      }
+      const letter = letters[0];
+      const headers = await patchRequestHeaders();
+      const body = await patchValidRequestBody(letter.id, 'ACCEPTED');
+
+      const response = await request.patch(`${baseUrl}/${SUPPLIER_LETTERS}/${letter.id}`, {
+          headers: headers,
+          data: body
+      });
+
+    const res = await response.json();
+    expect(response.status()).toBe(200);
+    expect(res).toMatchObject({
+      data:{
+        attributes: {
+            status: 'ACCEPTED',
+            specificationId: letter.specificationId,
+            groupId: letter.groupId,
+        },
+        id: letter.id,
+        type: 'Letter'
+      }
+    });
+
+    await deleteLettersBySupplier(letter.id);
+  });
+
+  test(`Patch /letters returns 200 and status is updated to REJECTED`, async ({ request }) => {
+
+      await createTestData(supplierId);
+      const letters = await getLettersBySupplier(supplierId, 'PENDING', 1);
+
+      if (!letters?.length) {
+        test.fail(true, `No PENDING letters found for supplier ${supplierId}`);
+        return;
+      }
+      const letter = letters[0];
+      const headers = await patchRequestHeaders();
+      const body = await patchFailureRequestBody(letter.id, 'REJECTED');
+
+      const response = await request.patch(`${baseUrl}/${SUPPLIER_LETTERS}/${letter.id}`, {
+          headers: headers,
+          data: body
+      });
+
+    const res = await response.json();
+    expect(response.status()).toBe(200);
+    await deleteLettersBySupplier(letter.id);
+  });
+
+  test(`Patch /letters returns 400 if request Body is invalid`, async ({ request }) => {
+
+      const id = randomUUID()
+      const headers = await patchRequestHeaders();
+      const body = await patchValidRequestBody(id, '');
+
+      const response = await request.patch(`${baseUrl}/${SUPPLIER_LETTERS}/${id}`, {
+          headers: headers,
+          data: body
+      });
+
+    const res = await response.json();
+
+    expect(response.status()).toBe(400);
+    });
+
+    test(`Patch /letters returns 500 if Id doesn't exist for SupplierId`, async ({ request }) => {
+        const headers = await patchRequestHeaders();
+        const id = randomUUID()
+        const body = await patchValidRequestBody(id, 'PENDING');
+
+        const response = await request.patch(`${baseUrl}/${SUPPLIER_LETTERS}/${id}`, {
+        headers: headers,
+        data: body
+        });
+
+      const res = await response.json();
+      expect(response.status()).toBe(500);
+    });
+
+    test(`Patch /letters returns 403 for invalid headers`, async ({ request }) => {
+        const headers = await createInvalidRequestHeaders();
+        const id = randomUUID()
+        const body = await patchValidRequestBody(id, 'PENDING');
+
+        const response = await request.patch(`${baseUrl}/${SUPPLIER_LETTERS}/${id}`, {
+            headers: headers,
+            data: body
+        });
+
+      const res = await response.json();
+      expect(response.status()).toBe(403);
+    });
+});

tests/config/main.config.ts

@@ -1,20 +1,19 @@
-import type { PlaywrightTestConfig } from '@playwright/test';
-import { config as baseConfig } from './playwright.base.config';
-import {  getReporters } from './reporters';
+import {defineConfig, PlaywrightTestConfig } from '@playwright/test';
+import  baseConfig from './playwright.base.config';
+import { getReporters } from './reporters';
+import path from 'path';
 
 const localConfig: PlaywrightTestConfig = {
+  ...baseConfig,
   /* Reporter to use. See https://playwright.dev/docs/test-reporters */
   reporter: getReporters('api-test'),
-  ...baseConfig,
-  //globalSetup: require.resolve('./setup/globalSetup'),
-  //globalTeardown: require.resolve('./setup/globalTeardown'),
-  testIgnore: [],
   projects: [
     {
-      name: 'sandbox',
-      testMatch: 'tests/messages/get_single_letter/*.spec.ts',
+      name: 'component-tests',
+      testDir: path.resolve(__dirname, '../component-tests'),
+      testMatch: '**/*.spec.ts',
     },
   ],
 };
 
-export default localConfig;
+export default defineConfig(localConfig);

tests/config/playwright.base.config.ts

@@ -1,13 +1,12 @@
-import type { PlaywrightTestConfig } from '@playwright/test';
+import { defineConfig, PlaywrightTestConfig } from '@playwright/test';
+import 'dotenv/config';
 
 const baseUrl = process.env.NHSD_APIM_PROXY_URL || 'http://localhost:3000/';
 const envMaxInstances = Number.parseInt(process.env.WORKERS_MAX_INST!) || 10;
 /**
  * See https://playwright.dev/docs/test-configuration.
  */
 export const config: PlaywrightTestConfig = {
-  testDir: '../sandbox/messages/get_single_letter/',
-  testMatch: '*.spec.ts/',
   /* Maximum time one test can run for. */
   timeout: 60 * 1000,
   workers: envMaxInstances,
@@ -24,19 +23,5 @@ export const config: PlaywrightTestConfig = {
   forbidOnly: !!process.env.CI,
   /* Retry on CI only */
   retries: process.env.CI ? 2 : 0,
-
-  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
-  use: {
-    /* Maximum time each action such as `click()` can take. Defaults to 0 (no limit). */
-    actionTimeout: 0,
-    /* Base URL to use in actions like `await page.goto('/')`. */
-    baseURL: baseUrl,
-    ignoreHTTPSErrors: true,
-    trace: 'on-first-retry',
-    /* Slows down Playwright operations by the specified amount of milliseconds. */
-    launchOptions: {
-      slowMo: 0,
-    },
-  },
 };
-export default config;
+export default defineConfig(config);