review fix

Author: Namitha-Prabhu

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

@@ -11,7 +11,7 @@ test.beforeAll(async () => {
   baseUrl = await getRestApiGatewayBaseUrl();
 });
 
-test.describe('API Gateway Tests To Get List Of Pending ', () =>
+test.describe('API Gateway Tests To Get List Of Pending Letters', () =>
 {
   test('GET /letters should return 200 and list items', async ({ request }) =>
   {

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

@@ -14,24 +14,6 @@ export type PatchMessageRequestBody = {
   };
 };
 
-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;
@@ -46,7 +28,7 @@ export type PatchMessageResponseBody = {
   };
 };
 
-export async function patchRequestHeaders(): Promise<RequestHeaders> {
+export function patchRequestHeaders(): RequestHeaders {
   let requestHeaders: RequestHeaders;
     requestHeaders = {
         headerauth1: process.env.HEADERAUTH || '',
@@ -58,7 +40,7 @@ export async function patchRequestHeaders(): Promise<RequestHeaders> {
 };
 
 
-export async function patchValidRequestBody (id: string, status: string) : Promise<PatchMessageRequestBody>{
+export function patchValidRequestBody (id: string, status: string) : PatchMessageRequestBody{
   let requestBody: PatchMessageRequestBody;
 
   requestBody = {
@@ -74,7 +56,7 @@ export async function patchValidRequestBody (id: string, status: string) : Promi
   return requestBody;
 }
 
-export async function patchFailureRequestBody (id: string, status: string) : Promise<PatchMessageRequestBody>{
+export function patchFailureRequestBody (id: string, status: string) : PatchMessageRequestBody{
   let requestBody: PatchMessageRequestBody;
 
   requestBody = {

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

@@ -23,8 +23,8 @@ test.describe('API Gateway Tests to Verify Patch Status Endpoint', () => {
         return;
       }
       const letter = letters[0];
-      const headers = await patchRequestHeaders();
-      const body = await patchValidRequestBody(letter.id, 'ACCEPTED');
+      const headers = patchRequestHeaders();
+      const body = patchValidRequestBody(letter.id, 'ACCEPTED');
 
       const response = await request.patch(`${baseUrl}/${SUPPLIER_LETTERS}/${letter.id}`, {
           headers: headers,
@@ -58,8 +58,8 @@ test.describe('API Gateway Tests to Verify Patch Status Endpoint', () => {
         return;
       }
       const letter = letters[0];
-      const headers = await patchRequestHeaders();
-      const body = await patchFailureRequestBody(letter.id, 'REJECTED');
+      const headers = patchRequestHeaders();
+      const body = patchFailureRequestBody(letter.id, 'REJECTED');
 
       const response = await request.patch(`${baseUrl}/${SUPPLIER_LETTERS}/${letter.id}`, {
           headers: headers,
@@ -74,8 +74,8 @@ test.describe('API Gateway Tests to Verify Patch Status Endpoint', () => {
   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 headers = patchRequestHeaders();
+      const body = patchValidRequestBody(id, '');
 
       const response = await request.patch(`${baseUrl}/${SUPPLIER_LETTERS}/${id}`, {
           headers: headers,
@@ -88,9 +88,9 @@ test.describe('API Gateway Tests to Verify Patch Status Endpoint', () => {
     });
 
     test(`Patch /letters returns 500 if Id doesn't exist for SupplierId`, async ({ request }) => {
-        const headers = await patchRequestHeaders();
+        const headers = patchRequestHeaders();
         const id = randomUUID()
-        const body = await patchValidRequestBody(id, 'PENDING');
+        const body = patchValidRequestBody(id, 'PENDING');
 
         const response = await request.patch(`${baseUrl}/${SUPPLIER_LETTERS}/${id}`, {
         headers: headers,
@@ -104,7 +104,7 @@ test.describe('API Gateway Tests to Verify Patch Status Endpoint', () => {
     test(`Patch /letters returns 403 for invalid headers`, async ({ request }) => {
         const headers = await createInvalidRequestHeaders();
         const id = randomUUID()
-        const body = await patchValidRequestBody(id, 'PENDING');
+        const body = patchValidRequestBody(id, 'PENDING');
 
         const response = await request.patch(`${baseUrl}/${SUPPLIER_LETTERS}/${id}`, {
             headers: headers,

tests/helpers/commonTypes.ts

@@ -0,0 +1,16 @@
+export type ErrorLink = {
+  about: string;
+};
+
+type ErrorResponse = {
+  id: string;
+  code: string;
+  links: ErrorLink;
+  status: string;
+  title: string;
+  detail: string;
+};
+
+export type ErrorMessageBody = {
+  errors: ErrorResponse[];
+};

tests/sandbox/testCases/updateLetterStatus_testCases.ts

@@ -1,15 +1,17 @@
 
-import { PatchErrorMessageBody, PatchMessageRequestBody, PatchMessageResponseBody } from '../../component-tests/apiGateway-tests/testCases/UpdateLetterStatus';
+import { PatchMessageRequestBody, PatchMessageResponseBody } from '../../component-tests/apiGateway-tests/testCases/UpdateLetterStatus';
 import { RequestSandBoxHeaders, sandBoxHeader } from '../../constants/request_headers';
+import { ErrorMessageBody } from '../../helpers/commonTypes';
 import { SandboxErrorResponse } from './getListOfLetters_testCases';
 
+
 export type ApiSandboxUpdateLetterStatusTestData = {
   testCase: string;
   id: string,
   header: RequestSandBoxHeaders;
   body?: PatchMessageRequestBody;
   expectedStatus: number;
-  expectedResponse?: PatchMessageResponseBody | SandboxErrorResponse | PatchErrorMessageBody;
+  expectedResponse?: PatchMessageResponseBody | SandboxErrorResponse | ErrorMessageBody;
 };
 
 export const apiSandboxUpdateLetterStatusTestData: ApiSandboxUpdateLetterStatusTestData[] = [