component tests

Author: Namitha-Prabhu

tests/.gitignore

@@ -8,3 +8,4 @@ node_modules/
 /allure-results
 /target
 /playwright/.auth/
+/allure-report

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

@@ -74,8 +74,7 @@ test.describe('API Gateway Tests To Get List Of Pending ', () =>
         params:{
           limit:'?'
         },
-        },
-        );
+      });
     expect(response.status()).toBe(400);
     const responseBody = await response.json();
 

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

@@ -10,28 +10,28 @@ type APIPatchMessageRequestTestCase = {
   expectedResponse?: PatchMessageResponseBody | PatchErrorMessageBody;
 };
 
-type PatchMessageRequestBody = {
+export type PatchMessageRequestBody = {
   data: {
     type: string;
     id: string;
     attributes: {
-      reasonCode: number;
-      reasonText: string;
+      reasonCode?: number;
+      reasonText?: string;
       status: string;
     };
   };
 };
 
-type PatchMessageResponseBody = {
+export type PatchMessageResponseBody = {
   data: {
     type: string;
     id: string;
     attributes: {
-      reasonCode: number;
-      reasonText: string;
+      reasonCode?: number;
+      reasonText?: string;
       status: string;
       specificationId:string;
-      groupId:string;
+      groupId?:string;
     };
   };
 };
@@ -49,15 +49,15 @@ type PatchErrorResponse = {
   detail: string;
 };
 
-type PatchErrorMessageBody = {
+export type PatchErrorMessageBody = {
   errors: PatchErrorResponse[];
 };
 
 
 
 export const apiPatchMessageRequestTestData: APIPatchMessageRequestTestCase[] = [
   {
-    testCase: '200 response if record is updated and status is REJECTED',
+    testCase: '200 response if record is updated with status REJECTED',
     id: '00c61654-24f0-410e-a77e-04deef7d1eeb',
     body: {
       data: {
@@ -86,6 +86,34 @@ export const apiPatchMessageRequestTestData: APIPatchMessageRequestTestCase[] =
     },
   },
 
+  {
+    testCase: '200 response if record is updated with status ACCEPTED',
+    id: '00c61654-24f0-410e-a77e-04deef7d1eeb',
+    body: {
+      data: {
+        type: 'Letter',
+        id: '00c61654-24f0-410e-a77e-04deef7d1eeb',
+        attributes: {
+          status: 'ACCEPTED',
+        },
+      }
+    },
+    expectedStatus: 200,
+        expectedResponse: {
+      data: {
+        type: 'Letter',
+        id: '00c61654-24f0-410e-a77e-04deef7d1eeb',
+        attributes: {
+          reasonCode: 123,
+          reasonText: 'Test Reason Text',
+          status: 'ACCEPTED',
+          specificationId:'specification-id',
+          groupId:'group-id'
+        },
+      }
+    },
+  },
+
   {
     testCase: '400 response if request body is invalid',
     id: '00c61654-24f0-410e-a77e-04deef7d1eeb',
@@ -114,4 +142,31 @@ export const apiPatchMessageRequestTestData: APIPatchMessageRequestTestCase[] =
       }]
     },
   },
+
+  {
+    testCase: '500 response if id doesnt exist supplierid',
+    id: '0',
+    body: {
+      data: {
+        type: 'Letter',
+        id: '0',
+        attributes: {
+          status: 'ACCEPTED',
+        },
+      }
+    },
+    expectedStatus: 500,
+    expectedResponse: {
+      errors: [{
+          id: '1234',
+          code: 'NOTIFY_INTERNAL_SERVER_ERROR',
+          links: {
+            about:  "https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier"
+          },
+          status: '500',
+          title: 'Internal server error',
+          detail: 'Letter with id 0 not found for supplier supplier-id'
+      }]
+    },
+  },
 ];

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'),
-  //globalSetup: require.resolve('./setup/globalSetup'),
-  //globalTeardown: require.resolve('./setup/globalTeardown'),
   projects: [
     {
       name: 'component-tests',
-      testDir: 'tests/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,11 @@
-import type { PlaywrightTestConfig } from '@playwright/test';
+import { defineConfig, PlaywrightTestConfig } from '@playwright/test';
 
 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: '../tests',
-  testMatch: '**/*.spec.ts',
   /* Maximum time one test can run for. */
   timeout: 60 * 1000,
   workers: envMaxInstances,
@@ -24,19 +22,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);

tests/config/sandbox.config.ts

@@ -1,6 +1,7 @@
 import type { PlaywrightTestConfig } from '@playwright/test';
 import { config as baseConfig } from './playwright.base.config';
 import {  getReporters } from './reporters';
+import path from 'path';
 
 const localConfig: PlaywrightTestConfig = {
   /* Reporter to use. See https://playwright.dev/docs/test-reporters */
@@ -11,7 +12,8 @@ const localConfig: PlaywrightTestConfig = {
   projects: [
     {
       name: 'sandbox',
-      testMatch: '**/sandbox/get_single_letter/*.spec.ts',
+      testDir: path.resolve(__dirname, '../sandbox'),
+      testMatch: '*.spec.ts',
     },
   ],
 };

tests/constants/api_constants.ts

@@ -1,5 +1,5 @@
 export const SUPPLIER_API_GATEWAY_NAME = 'nhs-main-supapi';
 export const SUPPLIER_LETTERS = 'letters';
 export const SUPPLIER_API_URL = 'https://internal-dev.api.service.nhs.uk/nhs-notify-supplier/';
-export const SUPPLIER_API_URL_SANDBOX = 'https://internal-sandbox.api.service.nhs.uk/nhs-notify-supplier/';
+export const SUPPLIER_API_URL_SANDBOX = 'https://internal-dev-sandbox.api.service.nhs.uk/nhs-notify-supplier';
 export const AWS_REGION = 'eu-west-2';

tests/constants/request_headers.ts

@@ -30,15 +30,11 @@ export async function createHeaderWithNoCorrelationId(): Promise<RequestHeaders>
   return requestHeaders;
 }
 
-export async function createValidSandBoxRequestHeaders(): Promise<RequestSandBoxHeaders> {
-  let requestHeaders: RequestSandBoxHeaders;
-    requestHeaders = {
-      'X-Request-ID': randomUUID(),
-      'Content-Type':'application/vnd.api+json',
-      'X-Correlation-ID': randomUUID(),
-    };
-  return requestHeaders;
-}
+export const sandBoxHeader: RequestSandBoxHeaders = {
+    'X-Request-ID': randomUUID(),
+    'Content-Type': 'application/vnd.api+json',
+    'X-Correlation-ID': randomUUID(),
+};
 
 export interface RequestHeaders {
   headerauth1: string;
@@ -47,7 +43,7 @@ export interface RequestHeaders {
   [key: string]: string;
 }
 
-interface RequestSandBoxHeaders {
+export interface RequestSandBoxHeaders {
   'X-Request-ID': string;
   'Content-Type': string;
   'X-Correlation-ID': string;

tests/helpers/awsGatewayHelper.ts

@@ -13,6 +13,5 @@ export async function getRestApiGatewayBaseUrl(
   if (!api?.id) throw new Error(`API with name "${apiName}" not found.`);
 
   const url = `https://${api.id}.execute-api.${region}.amazonaws.com/main`;
-  console.log(`API Gateway URL: ${url}`);
   return url;
 }