test(sample-07): added unit tests

sample/07-sequelize/package.json

@@ -32,11 +32,13 @@
     "typescript": "4.3.5"
   },
   "devDependencies": {
-    "@types/sequelize": "4.28.10",
     "@nestjs/cli": "8.1.2",
+    "@types/sequelize": "4.28.10",
     "@nestjs/schematics": "8.0.3",
     "@nestjs/testing": "8.0.11",
     "@types/express": "4.17.13",
+    "@types/jest": "^27.0.1",
+    "@types/sequelize": "4.28.10",
     "@types/node": "14.17.26",
     "@types/supertest": "2.0.11",
     "@types/ws": "7.4.7",
@@ -53,5 +55,22 @@
     "eslint-config-prettier": "8.3.0",
     "eslint-plugin-import": "2.25.2",
     "typescript": "4.3.5"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".spec.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
   }
 }

sample/07-sequelize/src/app.module.ts

@@ -1,5 +1,6 @@
 import { Module } from '@nestjs/common';
 import { SequelizeModule } from '@nestjs/sequelize';
+import { User } from './users/models/user.model';
 import { UsersModule } from './users/users.module';
 
 @Module({
@@ -13,6 +14,7 @@ import { UsersModule } from './users/users.module';
       database: 'test',
       autoLoadModels: true,
       synchronize: true,
+      models: [User],
     }),
     UsersModule,
   ],

sample/07-sequelize/src/users/user.model.ts → sample/07-sequelize/src/users/models/user.model.ts

@@ -1,7 +1,7 @@
 import { Column, Model, Table } from 'sequelize-typescript';
 
 @Table
-export class User extends Model<User> {
+export class User extends Model {
   @Column
   firstName: string;
 

sample/07-sequelize/src/users/users.controller.spec.ts

@@ -0,0 +1,96 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { CreateUserDto } from './dto/create-user.dto';
+import { UsersController } from './users.controller';
+import { UsersService } from './users.service';
+
+const createUserDto: CreateUserDto = {
+  firstName: 'firstName #1',
+  lastName: 'lastName #1',
+};
+
+describe('UsersController', () => {
+  let usersController: UsersController;
+  let usersService: UsersService;
+
+  beforeEach(async () => {
+    const app: TestingModule = await Test.createTestingModule({
+      controllers: [UsersController],
+      providers: [
+        UsersService,
+        {
+          provide: UsersService,
+          useValue: {
+            create: jest
+              .fn()
+              .mockImplementation((user: CreateUserDto) =>
+                Promise.resolve({ id: 'a id', ...user }),
+              ),
+            findAll: jest.fn().mockResolvedValue([
+              {
+                firstName: 'firstName #1',
+                lastName: 'lastName #1',
+              },
+              {
+                firstName: 'firstName #2',
+                lastName: 'lastName #2',
+              },
+            ]),
+            findOne: jest.fn().mockImplementation((id: string) =>
+              Promise.resolve({
+                firstName: 'firstName #1',
+                lastName: 'lastName #1',
+                id,
+              }),
+            ),
+            remove: jest.fn(),
+          },
+        },
+      ],
+    }).compile();
+
+    usersController = app.get<UsersController>(UsersController);
+    usersService = app.get<UsersService>(UsersService);
+  });
+
+  it('should be defined', () => {
+    expect(usersController).toBeDefined();
+  });
+
+  describe('create()', () => {
+    it('should create an user', () => {
+      usersController.create(createUserDto);
+      expect(usersService.create).toHaveBeenCalled();
+      expect(usersService.create).toHaveBeenCalledWith(createUserDto);
+      expect(usersController.create(createUserDto)).resolves.toEqual({
+        id: 'a id',
+        ...createUserDto,
+      });
+    });
+  });
+
+  describe('findAll()', () => {
+    it('should find all users ', () => {
+      usersController.findAll();
+      expect(usersService.findAll).toHaveBeenCalled();
+    });
+  });
+
+  describe('findOne()', () => {
+    it('should find a user', () => {
+      usersController.findOne('anyid');
+      expect(usersService.findOne).toHaveBeenCalled();
+      expect(usersController.findOne('a id')).resolves.toEqual({
+        firstName: 'firstName #1',
+        lastName: 'lastName #1',
+        id: 'a id',
+      });
+    });
+  });
+
+  describe('remove()', () => {
+    it('should remove the user', () => {
+      usersController.remove('anyid');
+      expect(usersService.remove).toHaveBeenCalled();
+    });
+  });
+});

sample/07-sequelize/src/users/users.controller.ts

@@ -1,6 +1,6 @@
 import { Body, Controller, Delete, Get, Param, Post } from '@nestjs/common';
 import { CreateUserDto } from './dto/create-user.dto';
-import { User } from './user.model';
+import { User } from './models/user.model';
 import { UsersService } from './users.service';
 
 @Controller('users')

sample/07-sequelize/src/users/users.module.ts

@@ -1,12 +1,13 @@
 import { Module } from '@nestjs/common';
 import { SequelizeModule } from '@nestjs/sequelize';
-import { User } from './user.model';
+import { User } from './models/user.model';
 import { UsersController } from './users.controller';
 import { UsersService } from './users.service';
 
 @Module({
   imports: [SequelizeModule.forFeature([User])],
   providers: [UsersService],
   controllers: [UsersController],
+  exports: [SequelizeModule],
 })
 export class UsersModule {}

sample/07-sequelize/src/users/users.service.spec.ts

@@ -0,0 +1,91 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { User } from './models/user.model';
+import { UsersService } from './users.service';
+import { getModelToken } from '@nestjs/sequelize';
+
+const userArray = [
+  {
+    firstName: 'firstName #1',
+    lastName: 'lastName #1',
+  },
+  {
+    firstName: 'firstName #2',
+    lastName: 'lastName #2',
+  },
+];
+
+const oneUser = {
+  firstName: 'firstName #1',
+  lastName: 'lastName #1',
+};
+
+describe('UserService', () => {
+  let service: UsersService;
+  let model: typeof User;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [
+        UsersService,
+        {
+          provide: getModelToken(User),
+          useValue: {
+            findAll: jest.fn(() => userArray),
+            findOne: jest.fn(),
+            create: jest.fn(() => oneUser),
+            remove: jest.fn(),
+            destroy: jest.fn(() => oneUser),
+          },
+        },
+      ],
+    }).compile();
+
+    service = module.get<UsersService>(UsersService);
+    model = module.get<typeof User>(getModelToken(User));
+  });
+
+  it('should be defined', () => {
+    expect(service).toBeDefined();
+  });
+
+  describe('create()', () => {
+    it('should successfully insert a user', () => {
+      const oneUser = {
+        firstName: 'firstName #1',
+        lastName: 'lastName #1',
+      };
+      expect(
+        service.create({
+          firstName: 'firstName #1',
+          lastName: 'lastName #1',
+        }),
+      ).toEqual(oneUser);
+    });
+  });
+
+  describe('findAll()', () => {
+    it('should return an array of users', async () => {
+      const users = await service.findAll();
+      expect(users).toEqual(userArray);
+    });
+  });
+
+  describe('findOne()', () => {
+    it('should get a single user', () => {
+      const findSpy = jest.spyOn(model, 'findOne');
+      expect(service.findOne('id'));
+      expect(findSpy).toBeCalledWith({ where: { id: 'id' } });
+    });
+  });
+
+  describe('remove()', () => {
+    it('should remove a user', async () => {
+      const findSpy = jest.spyOn(model, 'findOne').mockReturnValue({
+        destroy: jest.fn(),
+      } as any);
+      const retVal = await service.remove('id');
+      expect(findSpy).toBeCalledWith({ where: { id: 'id' } });
+      expect(retVal).toBeUndefined();
+    });
+  });
+});

sample/07-sequelize/src/users/users.service.ts

@@ -1,7 +1,7 @@
 import { Injectable } from '@nestjs/common';
 import { InjectModel } from '@nestjs/sequelize';
 import { CreateUserDto } from './dto/create-user.dto';
-import { User } from './user.model';
+import { User } from './models/user.model';
 
 @Injectable()
 export class UsersService {
@@ -11,11 +11,7 @@ export class UsersService {
   ) {}
 
   create(createUserDto: CreateUserDto): Promise<User> {
-    const user = new User();
-    user.firstName = createUserDto.firstName;
-    user.lastName = createUserDto.lastName;
-
-    return user.save();
+    return this.userModel.create(createUserDto);
   }
 
   async findAll(): Promise<User[]> {