Review Changes

Author: Namitha-Prabhu

Makefile

@@ -98,8 +98,8 @@ config:: _install-dependencies version # Configure development environment (main
 	npm install
 	(cd docs && make install && cd ..)
 
-#test-component: To Be discussed with Infra on AWS credentials @Pipeline
-#	(cd tests && npm install && npm run test:component)
+test-component:
+	(cd tests && npm install && npm run test:component)
 
 version:
 	rm -f .version

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

@@ -25,17 +25,9 @@ test.describe('API Gateway Tests To Get List Of Pending ', () =>
 
     expect(response.status()).toBe(200);
     const responseBody = await response.json();
-
-  /*  const validationResult = validateApiResponse("get", "/letters", response.status(), responseBody);
-    if (validationResult) {
-      console.error("API response validation failed:", validationResult);
-    }
-
-    expect(validationResult).toBeUndefined();
-  TBD */
   });
 
-  test('GET /letters with invalid apikey should return 403', async ({ request }) => {
+  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,
@@ -59,14 +51,6 @@ test.describe('API Gateway Tests To Get List Of Pending ', () =>
     );
     expect(response.status()).toBe(500);
     const responseBody = await response.json();
-
-  /*  const validationResult = validateApiResponse("get", "/letters", response.status(), responseBody);
-    if (validationResult) {
-      console.error("API response validation failed:", validationResult);
-    }
-
-    expect(validationResult).toBeUndefined();
-  TBD */
   });
 
   test('GET /letters with invalid query param return 400', async ({ request }) => {
@@ -79,15 +63,6 @@ test.describe('API Gateway Tests To Get List Of Pending ', () =>
       });
     expect(response.status()).toBe(400);
     const responseBody = await response.json();
-
-    /*
-    const validationResult = validateApiResponse("get", "/letters", response.status(), responseBody);
-    if (validationResult) {
-      console.error("API response validation failed:", validationResult);
-    }
-
-    expect(validationResult).toBeUndefined();
-    */
   });
 
 });

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

@@ -7,13 +7,31 @@ export type PatchMessageRequestBody = {
     type: string;
     id: string;
     attributes: {
-      reasonCode?: number;
+      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;
@@ -34,6 +52,7 @@ export async function patchRequestHeaders(): Promise<RequestHeaders> {
         headerauth1: process.env.HEADERAUTH || '',
         'NHSD-Supplier-ID': supplierId,
         'NHSD-Correlation-ID': '12344',
+        'X-Request-ID': 'requestId1'
     };
   return requestHeaders;
 };
@@ -60,11 +79,10 @@ export async function patchFailureRequestBody (id: string, status: string) : Pro
 
   requestBody = {
     data: {
-       attributes: {
-          status: status,
-        reasonCode: 123,
-        reasonText: 'Test Reason'
-
+        attributes: {
+          status: status,
+          reasonCode: 123,
+          reasonText: 'Test Reason'
       },
       type: 'Letter',
       id: id

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

@@ -37,8 +37,8 @@ test.describe('API Gateway Tests to Verify Patch Status Endpoint', () => {
       data:{
         attributes: {
             status: 'ACCEPTED',
-            specificationId: 'TestSpecificationID',
-            groupId: 'TestGroupID',
+            specificationId: letter.specificationId,
+            groupId: letter.groupId,
         },
         id: letter.id,
         type: 'Letter'
@@ -112,7 +112,6 @@ test.describe('API Gateway Tests to Verify Patch Status Endpoint', () => {
         });
 
       const res = await response.json();
-      console.log(res);
       expect(response.status()).toBe(403);
     });
 });

tests/config/sandbox.config.ts

@@ -7,8 +7,6 @@ const localConfig: PlaywrightTestConfig = {
   /* 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'),
   projects: [
     {
       name: 'sandbox',

tests/constants/request_headers.ts

@@ -27,6 +27,7 @@ export async function createInvalidRequestHeaders(): Promise<RequestHeaders> {
         headerauth1: '',
         'NHSD-Supplier-ID': supplierId,
         'NHSD-Correlation-ID': '1234',
+        'X-Request-ID': 'requestId1'
     };
   return requestHeaders;
 }
@@ -37,6 +38,7 @@ export async function createHeaderWithNoCorrelationId(): Promise<RequestHeaders>
         headerauth1: process.env.HEADERAUTH || '',
         'NHSD-Supplier-ID': supplierId,
         'NHSD-Correlation-ID': '',
+        'X-Request-ID': 'requestId1'
     };
   return requestHeaders;
 }
@@ -47,6 +49,7 @@ export async function createValidRequestHeaders(): Promise<RequestHeaders> {
         headerauth1: process.env.HEADERAUTH || '',
         'NHSD-Supplier-ID': supplierId,
         'NHSD-Correlation-ID': '12345',
+        'X-Request-ID': 'requestId1'
     };
   return requestHeaders;
 }

…tCases/updateMultipleStatys_testCases.ts …tCases/updateMultipleStatus_testCases.tstests/sandbox/testCases/updateMultipleStatys_testCases.ts renamed to tests/sandbox/testCases/updateMultipleStatus_testCases.ts tests/sandbox/testCases/updateMultipleStatys_testCases.ts renamed to tests/sandbox/testCases/updateMultipleStatus_testCases.ts

@@ -1,4 +1,3 @@
-import { PatchMessageRequestBody } from "../../component-tests/apiGateway-tests/testCases/UpdateLetterStatus";
 import { RequestSandBoxHeaders, sandBoxHeader } from "../../constants/request_headers";
 
 export type ApiSandboxUpdateLetterStatusTestData = {
@@ -16,7 +15,7 @@ type postRequest = {
     type: string;
     id: string;
     attributes: {
-      reasonCode?: number;
+      reasonCode?: string | number;
       reasonText?: string;
       status: string;
     }

tests/sandbox/updateMultipleLetterStatus.spec.ts

@@ -1,7 +1,6 @@
 import { test, expect, request } from '@playwright/test';
 import {  SUPPLIER_API_URL_SANDBOX, SUPPLIER_LETTERS} from '../constants/api_constants';
-import { apiSandboxUpdateLetterStatusTestData } from './testCases/updateLetterStatus_testCases';
-import { apiSandboxMultipleLetterStatusTestData } from './testCases/updateMultipleStatys_testCases';
+import { apiSandboxMultipleLetterStatusTestData } from './testCases/updateMultipleStatus_testCases';
 
 
 test.describe('Sandbox Tests To Update Multiple Letter Status', () =>