Merge pull request #3 from BeerMoneyDev/AddTests

refactor(Nest-Monk): Add Unit tests.

Author: benMain

package.json

@@ -188,4 +188,4 @@
       ]
     ]
   }
-}
+}

src/lib/class-transformer.middleware.ts

@@ -11,7 +11,10 @@ export function classTransformerMiddlewareFactory<T>(type: ModelType<T>) {
         } catch (ex) {
           res = null;
           const error = ex as Error;
-          new Logger('classTransformerMiddlewareFactory').error(ex.message, ex.stack);
+          new Logger('classTransformerMiddlewareFactory').error(
+            error.message,
+            error.stack,
+          );
         }
       }
       return res;

src/lib/decorators.ts

@@ -1,4 +1,4 @@
-import { Inject, Type } from '@nestjs/common';
+import { Inject } from '@nestjs/common';
 import { createMonkCollectionToken, createMonkRepositoryToken } from './tokens';
 import { ModelType, ModelOptions } from './types';
 

src/lib/monk.module.ts

@@ -146,15 +146,15 @@ export class MonkModule {
   private static createCollectionProviders = (
     collections?: Array<ModelType<any>>,
   ): FactoryProvider<Promise<ICollection<any>>>[] => {
-    return (collections ?? []).map((f) => {
+    return (collections ?? []).map(f => {
       return {
         provide: createMonkCollectionToken(f),
         useFactory: async (database: string, options: MonkOptions) => {
           const modelOptions = ModelRegistrations.get(f);
           const collectionName = modelOptions?.collectionName?.length
             ? ModelRegistrations.get(f).collectionName
             : `${snakeCase(f.name)}s`;
-          return await monk(database, options).then((db) => {
+          return await monk(database, options).then(db => {
             db.addMiddleware(classTransformerMiddlewareFactory(f));
             const collection = db.get(collectionName);
             if (collection) {

src/lib/repository.service.spec.ts

@@ -0,0 +1,130 @@
+import { ICollection, id as convertToMongoId } from 'monk';
+import { Repository } from './repository.service';
+
+describe('Repository', () => {
+  let repo: Repository<PersonTest>;
+  let collection: ICollection<PersonTest>;
+  let findOneMock: jest.SpyInstance<Promise<PersonTest>, any[]>;
+  let findMock: jest.SpyInstance<Promise<PersonTest[]>, any[]>;
+  let insertMock: jest.SpyInstance<Promise<PersonTest>, any[]>;
+  let removeMock: jest.SpyInstance<
+    Promise<{
+      deletedCount: number;
+      result: {
+        n: number;
+        ok: 0 | 1;
+      };
+    }>,
+    any[]
+  >;
+  let findOneAndUpdateMock: jest.SpyInstance<Promise<PersonTest>, any[]>;
+
+  beforeEach(async () => {
+    collection = {
+      findOne: () => null,
+      find: () => null,
+      insert: () => null,
+      remove: () => null,
+      findOneAndUpdate: () => null,
+    } as any;
+    findOneMock = jest.spyOn(collection, 'findOne') as any;
+    findMock = jest.spyOn(collection, 'find') as any;
+    insertMock = jest.spyOn(collection, 'insert') as any;
+    removeMock = jest.spyOn(collection, 'remove') as any;
+    findOneAndUpdateMock = jest.spyOn(collection, 'findOneAndUpdate') as any;
+    repo = new Repository(collection);
+  });
+
+  it('getById() should invoke monk collection.findOne()', async () => {
+    const id = '507f191e810c19729de860ea';
+    findOneMock.mockReturnValue(Promise.resolve(getMockPersonTest()));
+    const response = await repo.getById(id);
+    expect(response).toEqual(getMockPersonTest());
+    expect(findOneMock).toHaveBeenCalledTimes(1);
+    expect(findOneMock).toHaveBeenCalledWith({
+      _id: convertToMongoId(id).toHexString(),
+    });
+  });
+
+  it('list() should invoke monk collection.find()', async () => {
+    const id = '507f191e810c19729de860ea';
+    findMock.mockReturnValue(Promise.resolve([getMockPersonTest()]));
+    const response = await repo.list({
+      _id: convertToMongoId(id).toHexString(),
+    });
+    expect(response).toEqual([getMockPersonTest()]);
+    expect(findMock).toHaveBeenCalledTimes(1);
+    expect(findMock).toHaveBeenCalledWith({
+      _id: convertToMongoId(id).toHexString(),
+    });
+  });
+
+  it('add() should invoke monk collection.insert()', async () => {
+    const personTest = getMockPersonTest();
+    insertMock.mockReturnValue(Promise.resolve(personTest));
+    const response = await repo.add(personTest);
+    expect(response).toEqual(getMockPersonTest());
+    expect(insertMock).toHaveBeenCalledTimes(1);
+    expect(insertMock).toHaveBeenCalledWith(personTest);
+  });
+
+  it('delete() should invoke monk collection.remove()', async () => {
+    const mockDeleteResponse = {
+      deletedCount: 1,
+      result: {
+        n: 1,
+        ok: 1 as any,
+      },
+    };
+    removeMock.mockReturnValue(Promise.resolve(mockDeleteResponse));
+    const id = '507f191e810c19729de860ea';
+    const response = await repo.delete(id);
+    expect(response).toEqual(mockDeleteResponse);
+    expect(removeMock).toHaveBeenCalledTimes(1);
+    expect(removeMock).toHaveBeenCalledWith({
+      _id: convertToMongoId(id).toHexString(),
+    });
+  });
+
+  it('edit() should invoke monk collection.findOneAndUpdateMock() and only set certain properties', async () => {
+    const personTest = getMockPersonTest();
+    const id = '507f191e810c19729de860ea';
+    findOneAndUpdateMock.mockReturnValue(Promise.resolve(personTest));
+    const response = await repo.edit(id, personTest, ['profession', 'sex']);
+    expect(response).toEqual(personTest);
+    expect(findOneAndUpdateMock).toHaveBeenCalledTimes(1);
+    expect(findOneAndUpdateMock).toHaveBeenCalledWith(
+      { _id: convertToMongoId(id).toHexString() },
+      { $set: { profession: 'Software Engineer', sex: 'M' } },
+    );
+  });
+
+  it('edit() should invoke monk collection.findOneAndUpdateMock() and set all properties', async () => {
+    const personTest = getMockPersonTest();
+    const id = '507f191e810c19729de860ea';
+    findOneAndUpdateMock.mockReturnValue(Promise.resolve(personTest));
+    const response = await repo.edit(id, personTest);
+    expect(response).toEqual(personTest);
+    expect(findOneAndUpdateMock).toHaveBeenCalledTimes(1);
+    expect(findOneAndUpdateMock).toHaveBeenCalledWith(
+      { _id: convertToMongoId(id).toHexString() },
+      { $set: personTest },
+    );
+  });
+});
+
+function getMockPersonTest(): PersonTest {
+  return {
+    name: 'Ben',
+    dob: new Date('1988-12-30'),
+    sex: 'M',
+    profession: 'Software Engineer',
+  };
+}
+
+class PersonTest {
+  name: string;
+  dob: Date;
+  sex: 'M' | 'F';
+  profession: string;
+}

src/lib/repository.service.ts

@@ -7,7 +7,7 @@ export class Repository<T> {
     return this.collection.findOne({ _id: convertToMongoId(id).toHexString() });
   }
 
-  list(query: string | Object) {
+  list(query: string | { [key: string]: any }) {
     return this.collection.find(query);
   }
 

src/lib/types.ts

@@ -19,7 +19,7 @@ export type AsyncProvider<T> =
   | Omit<ValueProvider<T>, 'provide'>;
 
 export interface MonkOptions {
-  collectionOptions?: Object;
+  collectionOptions?: any;
   poolSize?: number;
   ssl?: boolean;
   sslValidate?: boolean;
@@ -50,8 +50,8 @@ export interface MonkOptions {
   raw?: boolean;
   promoteLongs?: boolean;
   bufferMaxEntries?: number;
-  readPreference?: Object | null;
-  pkFactory?: Object | null;
-  promiseLibrary?: Object | null;
-  readConcern?: Object | null;
+  readPreference?: any;
+  pkFactory?: any;
+  promiseLibrary?: any;
+  readConcern?: any;
 }

test/coverage/clover.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<coverage generated="1615482828422" clover="3.2.0">
+  <project timestamp="1615482828422" name="All files">
+    <metrics statements="0" coveredstatements="0" conditionals="0" coveredconditionals="0" methods="0" coveredmethods="0" elements="0" coveredelements="0" complexity="0" loc="0" ncloc="0" packages="0" files="0" classes="0"/>
+  </project>
+</coverage>

test/coverage/coverage-final.json

@@ -0,0 +1 @@
+{}