CCM-13135: Add tests

Author: nhsd-angel-pastor

utils/client-management/src/__test__/app/put-client.test.ts

@@ -1,26 +1,26 @@
 import { mockDeep } from 'jest-mock-extended';
 import { Client } from 'utils';
+import { ConflictException, ValidationException } from 'domain/exceptions/';
 import { PutClientCommandParameters } from '../../app/put-client';
 import { AppDependencies, createApp } from '../../app';
-import { ConflictException, ValidationException } from 'domain/exceptions/';
 
 const input: PutClientCommandParameters = {
-      clientId: 'test_client_id',
-      clientName: 'test_client_name',
-      meshMailboxSenderId: 'test_client_mesh_mailbox_id',
-      meshMailboxReportsId: 'test_client_mesh_workflow_id_suffix',
-      fallbackWaitTimeSeconds: 300,
-      routingConfigId: '1234',
-    };
+  clientId: 'test_client_id',
+  clientName: 'test_client_name',
+  meshMailboxSenderId: 'test_client_mesh_mailbox_id',
+  meshMailboxReportsId: 'test_client_mesh_workflow_id_suffix',
+  fallbackWaitTimeSeconds: 300,
+  routingConfigId: '1234',
+};
 
 const client: Client = {
-    clientId: 'test_client_id',
-      clientName: 'test_client_name',
-      meshMailboxSenderId: 'test_client_mesh_mailbox_id',
-      meshMailboxReportsId: 'test_client_mesh_workflow_id_suffix',
-      fallbackWaitTimeSeconds: 300,
-      routingConfigId: '1234',
-  };
+  clientId: 'test_client_id',
+  clientName: 'test_client_name',
+  meshMailboxSenderId: 'test_client_mesh_mailbox_id',
+  meshMailboxReportsId: 'test_client_mesh_workflow_id_suffix',
+  fallbackWaitTimeSeconds: 300,
+  routingConfigId: '1234',
+};
 
 function setup(existingClients: Client[] = [], createClientResponse = client) {
   const mocks = mockDeep<AppDependencies>({
@@ -45,7 +45,7 @@ describe('putClient', () => {
     const { data, mocks } = setup([]);
 
     const app = createApp(mocks);
-    delete(input.clientId); // simulate no clientId provided
+    delete input.clientId; // simulate no clientId provided
     const result = await app.putClient(input);
 
     expect(mocks.domain.client.createClient).toHaveBeenCalledWith(input);
@@ -58,8 +58,8 @@ describe('putClient', () => {
   it('creates a new client when existing clients, stores it in the client repository and returns it', async () => {
     const existingClient: Client = {
       ...client,
-      clientId: "existing_client_id",
-      meshMailboxSenderId: "existing_mesh_mailbox_sender_id",
+      clientId: 'existing_client_id',
+      meshMailboxSenderId: 'existing_mesh_mailbox_sender_id',
     };
     const { data, mocks } = setup([existingClient]);
 
@@ -77,7 +77,7 @@ describe('putClient', () => {
   it('Updates client when it exists, stores it in the client repository and returns it', async () => {
     const existingClient: Client = {
       ...client,
-      meshMailboxSenderId: "existing_mesh_mailbox_sender_id",
+      meshMailboxSenderId: 'existing_mesh_mailbox_sender_id',
     };
     const { data, mocks } = setup([existingClient]);
 
@@ -95,7 +95,7 @@ describe('putClient', () => {
   it('throws an error when a different existing client has the same mailbox sender ID', async () => {
     const existingClient: Client = {
       ...client,
-      clientId: "existing_client_id",
+      clientId: 'existing_client_id',
     };
     const { mocks } = setup([existingClient]);
 
@@ -111,15 +111,19 @@ describe('putClient', () => {
     const newInvalidClient: Client = {
       ...client,
     };
-    delete (newInvalidClient.meshMailboxSenderId);
+    delete (newInvalidClient as Partial<Client>).meshMailboxSenderId;
 
     const { mocks } = setup([], newInvalidClient);
 
     const app = createApp(mocks);
 
-    await expect(app.putClient(newInvalidClient)).rejects.toThrow(ValidationException);
+    await expect(app.putClient(newInvalidClient)).rejects.toThrow(
+      ValidationException,
+    );
 
-    expect(mocks.domain.client.createClient).toHaveBeenCalledWith(newInvalidClient);
+    expect(mocks.domain.client.createClient).toHaveBeenCalledWith(
+      newInvalidClient,
+    );
     expect(mocks.infra.clientRepository.putClient).toHaveBeenCalledTimes(0);
   });
 });

utils/client-management/src/__test__/infra/client-repository/ssm.test.ts

@@ -1,7 +1,6 @@
 import { Parameter, ParameterNotFound } from '@aws-sdk/client-ssm';
 import { Client, IParameterStore } from 'utils';
 import { mockDeep } from 'jest-mock-extended';
-import { ConflictException } from '../../../domain/exceptions';
 import { ClientRepository } from '../../../infra/client-repository/repository';
 
 // update name repository.test.ts

utils/client-management/src/app/put-client.ts

@@ -5,7 +5,10 @@ import { AppDependencies } from './types';
 
 export type PutClientCommandParameters = CreateClientParameters;
 
-export async function validateClient(client: Client, infra: AppDependencies['infra']): Promise<void> {
+export async function validateClient(
+  client: Client,
+  infra: AppDependencies['infra'],
+): Promise<void> {
   try {
     $Client.parse(client);
   } catch (error) {
@@ -15,7 +18,10 @@ export async function validateClient(client: Client, infra: AppDependencies['inf
   const existingClients = await infra.clientRepository.listClients();
 
   const conflicts = existingClients.filter((c) => {
-    return c.clientId !== client.clientId && c.meshMailboxSenderId === client.meshMailboxSenderId;
+    return (
+      c.clientId !== client.clientId &&
+      c.meshMailboxSenderId === client.meshMailboxSenderId
+    );
   });
 
   if (conflicts.length > 0) {

utils/utils/src/__tests__/validators/client.test.ts

@@ -0,0 +1,101 @@
+import { $Client } from "validators";
+
+describe("Client Validator", () => {
+  it("should validate a correct Client object", () => {
+    const validClient = {
+      clientId: "123e4567-e89b-12d3-a456-426614174000",
+      clientName: "Test Client",
+      meshMailboxSenderId: "SENDER123",
+      meshMailboxReportsId: "REPORTS123",
+      fallbackWaitTimeSeconds: 300,
+      routingConfigId: "ROUTE123",
+    };
+
+    expect(() => $Client.parse(validClient)).not.toThrow();
+  });
+
+  it("should throw an error when clientId is missing", () => {
+    const invalidClient = {
+      clientName: "Test Client",
+      meshMailboxSenderId: "SENDER123",
+      meshMailboxReportsId: "REPORTS123",
+      fallbackWaitTimeSeconds: 300,
+      routingConfigId: "ROUTE123",
+    };
+
+    expect(() => $Client.parse(invalidClient)).toThrow();
+  });
+
+  it("should throw an error when clientName is missing", () => {
+    const invalidClient = {
+      clientId: "123e4567-e89b-12d3-a456-426614174000",
+      meshMailboxSenderId: "SENDER123",
+      meshMailboxReportsId: "REPORTS123",
+      fallbackWaitTimeSeconds: 300,
+      routingConfigId: "ROUTE123",
+    };
+
+    expect(() => $Client.parse(invalidClient)).toThrow();
+  });
+
+  it("should throw an error when meshMailboxSenderId is missing", () => {
+    const invalidClient = {
+      clientId: "123e4567-e89b-12d3-a456-426614174000",
+      clientName: "Test Client",
+      meshMailboxReportsId: "REPORTS123",
+      fallbackWaitTimeSeconds: 300,
+      routingConfigId: "ROUTE123",
+    };
+
+    expect(() => $Client.parse(invalidClient)).toThrow();
+  });
+
+it("should throw an error when meshMailboxReportsId is missing", () => {
+    const invalidClient = {
+      clientId: "123e4567-e89b-12d3-a456-426614174000",
+      clientName: "Test Client",
+      meshMailboxSenderId: "SENDER123",
+      fallbackWaitTimeSeconds: 300,
+      routingConfigId: "ROUTE123",
+    };
+
+    expect(() => $Client.parse(invalidClient)).toThrow();
+  });
+
+  it("should throw an error when fallbackWaitTimeSeconds is missing", () => {
+    const invalidClient = {
+      clientId: "123e4567-e89b-12d3-a456-426614174000",
+      clientName: "Test Client",
+      meshMailboxSenderId: "SENDER123",
+      meshMailboxReportsId: "REPORTS123",
+      routingConfigId: "ROUTE123",
+    };
+
+    expect(() => $Client.parse(invalidClient)).toThrow();
+  });
+
+  it("should throw an error when routingConfigId is missing", () => {
+    const invalidClient = {
+      clientId: "123e4567-e89b-12d3-a456-426614174000",
+      clientName: "Test Client",
+      meshMailboxSenderId: "SENDER123",
+      meshMailboxReportsId: "REPORTS123",
+      fallbackWaitTimeSeconds: 300,
+    };
+
+    expect(() => $Client.parse(invalidClient)).toThrow();
+  });
+
+  it("should throw an error when fallbackWaitTimeSeconds has wrong type", () => {
+    const invalidClient = {
+      clientId: "123e4567-e89b-12d3-a456-426614174000",
+      clientName: "Test Client",
+      meshMailboxSenderId: "SENDER123",
+      meshMailboxReportsId: "REPORTS123",
+      fallbackWaitTimeSeconds: "300",
+      routingConfigId: "ROUTE123",
+    };
+
+    expect(() => $Client.parse(invalidClient)).toThrow();
+  });
+});