API with NestJS #167. Unit tests with the Drizzle ORM

September 23, 2024

This entry is part 167 of 174 in the API with NestJS

Unit tests play a significant role in ensuring the reliability of our NestJS application. In this article, we’ll explain the concept behind unit testing and learn how to apply it to a NestJS application with the Drizzle ORM.

Introduction to unit tests

Unit tests allow us to verify that individual parts of our codebase function as expected on their own.

NestJS is configured to handle tests using the Jest framework out of the box. When we run the npm run test command, Jest finds files that follow a specific naming pattern. By default, NestJS is set up to look for files that end with .spec.ts. Alternatively, we can configure it to handle files that end with .test.ts. To do that, we need to adjust the package.json file.

{

// ...

"jest": {

"testRegex": ".*\\.(spec|test)\\.ts$",

// ...

}

Thanks to the above regular expression, Jest will pick up files that end with eiter .spec.ts or .test.ts.

Writing our first unit test

Let’s take a look at the getCookieForLogOut function in our AuthenticationService.

authentication.service.ts

import { Injectable } from '@nestjs/common';

@Injectable()

export class AuthenticationService {

getCookieForLogOut() {

return `Authentication=; HttpOnly; Path=/; Max-Age=0`;

}

// ...

}

Let’s write a test ensuring our method returns a valid string.

authentication.service.test.ts

import { AuthenticationService } from './authentication.service';

import { JwtService } from '@nestjs/jwt';

import { ConfigService } from '@nestjs/config';

import { UsersService } from '../users/users.service';

import { DrizzleService } from '../database/drizzle.service';

import { Pool } from 'pg';

describe('The AuthenticationService', () => {

let authenticationService: AuthenticationService;

beforeEach(() => {

const configService = new ConfigService();

authenticationService = new AuthenticationService(

new UsersService(

new DrizzleService(

new Pool({

host: configService.get('POSTGRES_HOST'),

port: configService.get('POSTGRES_PORT'),

user: configService.get('POSTGRES_USER'),

password: configService.get('POSTGRES_PASSWORD'),

database: configService.get('POSTGRES_DB'),

}),

new JwtService({

secretOrPrivateKey: 'Secret key',

}),

new ConfigService(),

);

});

describe('when calling the getCookieForLogOut method', () => {

it('should return a correct string', () => {

const result = authenticationService.getCookieForLogOut();

expect(result).toBe('Authentication=; HttpOnly; Path=/; Max-Age=0');

});

PASS src/authentication/authentication.service.test.ts
The AuthenticationService
when calling the getCookieForLogOut method
✓ should return a correct string

In our approach above, we call the AuthenticationService constructor manually. Alternatively, we can use the NestJS test utilities to handle that instead. To achieve that, we need the Test.createTestingModule method from the @nestjs/testing library.

authentication.service.test.ts

import { AuthenticationService } from './authentication.service';

import { JwtModule } from '@nestjs/jwt';

import { ConfigModule, ConfigService } from '@nestjs/config';

import { Test } from '@nestjs/testing';

import { UsersModule } from '../users/users.module';

import { DatabaseModule } from '../database/database.module';

describe('The AuthenticationService', () => {

let authenticationService: AuthenticationService;

beforeEach(async () => {

const module = await Test.createTestingModule({

providers: [AuthenticationService],

imports: [

UsersModule,

ConfigModule.forRoot(),

JwtModule.register({

secretOrPrivateKey: 'Secret key',

}),

DatabaseModule.forRootAsync({

imports: [ConfigModule],

inject: [ConfigService],

useFactory: (configService: ConfigService) => ({

host: configService.get('POSTGRES_HOST'),

port: configService.get('POSTGRES_PORT'),

user: configService.get('POSTGRES_USER'),

password: configService.get('POSTGRES_PASSWORD'),

database: configService.get('POSTGRES_DB'),

}),

}).compile();

authenticationService = await module.get(AuthenticationService);

});

describe('when calling the getCookieForLogOut method', () => {

it('should return a correct string', () => {

const result = authenticationService.getCookieForLogOut();

expect(result).toBe('Authentication=; HttpOnly; Path=/; Max-Age=0');

});

With this alternative solution, we create a mock of the NestJS runtime. By calling the compile() method, we set up a module with its dependencies similar to how the bootstrap function in our main.ts file works.

Avoiding a real database

It’s crucial to notice that our DatabaseModule connects to a real PostgreSQL database. If our database has any issues, our tests could fail. We don’t want that because unit tests should be independent and reliable.

One way of solving this problem is to recognize that it’s the UsersService class that uses the database under the hood. If we use a mocked version of the UsersService, we no longer need to connect to the database.

authentication.service.test.ts

import { AuthenticationService } from './authentication.service';

import { JwtModule } from '@nestjs/jwt';

import { ConfigModule } from '@nestjs/config';

import { Test } from '@nestjs/testing';

import { UsersService } from '../users/users.service';

import { SignUpDto } from './dto/sign-up.dto';

describe('The AuthenticationService', () => {

let signUpData: SignUpDto;

let authenticationService: AuthenticationService;

beforeEach(async () => {

signUpData = {

email: 'john@smith.com',

password: 'strongPassword123',

};

const module = await Test.createTestingModule({

providers: [

AuthenticationService,

{

provide: UsersService,

useValue: {

create: jest.fn().mockReturnValue(signUpData),

imports: [

ConfigModule.forRoot(),

JwtModule.register({

secretOrPrivateKey: 'Secret key',

}),

}).compile();

authenticationService = await module.get(AuthenticationService);

});

// ...

describe('when registering a new user', () => {

describe('and when the usersService returns the new user', () => {

it('should return the new user', async () => {

const result = await authenticationService.signUp(signUpData);

expect(result).toBe(signUpData);

});

Adjusting the mock for each test

In our test above, we mock the create method in the UsersService to return a valid user each time. However, a particular method can yield various results in different situations. For example, the getByEmail method:

if we provide a valid email of a user who’s signed up, it returns the user,
when a user with the provided email does not exist, it throws the NotFoundException.

Let’s create a mock that can cover both cases. To do that, let’s create the getByEmailMock variable and use it in the mocked UsersService.

Then, let’s use getByEmailMock.mockResolvedValue function when we want the getByEmail method to return a value successfully. When we want it to fail, we have to use getByEmailMock.mockRejectedValue.

authentication.service.test.ts

import { AuthenticationService } from './authentication.service';

import { JwtModule } from '@nestjs/jwt';

import { ConfigModule } from '@nestjs/config';

import { Test } from '@nestjs/testing';

import { UsersService } from '../users/users.service';

import { SignUpDto } from './dto/sign-up.dto';

import * as bcrypt from 'bcrypt';

import { NotFoundException } from '@nestjs/common';

import { InferSelectModel } from 'drizzle-orm';

import { databaseSchema } from '../database/database-schema';

import { WrongCredentialsException } from './wrong-credentials-exception';

describe('The AuthenticationService', () => {

let signUpData: SignUpDto;

let authenticationService: AuthenticationService;

let getByEmailMock: jest.Mock;

let password: string;

beforeEach(async () => {

getByEmailMock = jest.fn();

password = 'strongPassword123';

signUpData = {

email: 'john@smith.com',

password: 'strongPassword123',

};

const module = await Test.createTestingModule({

providers: [

AuthenticationService,

{

provide: UsersService,

useValue: {

create: jest.fn().mockReturnValue(signUpData),

getByEmail: getByEmailMock,

imports: [

ConfigModule.forRoot(),

JwtModule.register({

secretOrPrivateKey: 'Secret key',

}),

}).compile();

authenticationService = await module.get(AuthenticationService);

});

// ...

describe('when the getAuthenticatedUser method is called', () => {

describe('and a valid email and password are provided', () => {

let userData: InferSelectModel<typeof databaseSchema.users>;

beforeEach(async () => {

const hashedPassword = await bcrypt.hash(password, 10);

userData = {

id: 1,

email: 'john@smith.com',

password: hashedPassword,

addressId: null,

};

getByEmailMock.mockResolvedValue(userData);

});

it('should return the new user', async () => {

const result = await authenticationService.getAuthenticatedUser({

email: userData.email,

password,

});

expect(result).toBe(userData);

});

describe('and an invalid email is provided', () => {

beforeEach(() => {

getByEmailMock.mockRejectedValue(new NotFoundException());

});

it('should throw the BadRequestException', () => {

return expect(async () => {

await authenticationService.getAuthenticatedUser({

email: 'john@smith.com',

password,

});

}).rejects.toThrow(WrongCredentialsException);

});

PASS src/authentication/authentication.service.test.ts
The AuthenticationService
when calling the getCookieForLogOut method
✓ should return a correct string
when registering a new user
and when the usersService returns the new user
✓ should return the new user
when the getAuthenticatedUser method is called
and a valid email and password are provided
✓ should return the new user
and an invalid email is provided
✓ should throw the BadRequestException

Focusing on a single class or function is an essential aspect of unit testing. Therefore, we must focus on testing the methods of the AuthenticationService and ensure our tests don’t rely on the code of the UsersService. We must make sure the classes work as expected in isolation instead of checking how they work together.

Mocking the Drizzle ORM

We haven’t yet tested a class that uses the Drizzle ORM directly. Let’s take a look at the getById method in our UsersService.

users.service.ts

import { Injectable, NotFoundException } from '@nestjs/common';

import { DrizzleService } from '../database/drizzle.service';

import { databaseSchema } from '../database/database-schema';

import { eq } from 'drizzle-orm';

@Injectable()

export class UsersService {

constructor(private readonly drizzleService: DrizzleService) {}

async getById(id: number) {

const user = await this.drizzleService.db.query.users.findFirst({

with: {

address: true,

where: eq(databaseSchema.users.id, id),

});

if (!user) {

throw new NotFoundException();

}

return user;

}

// ...

}

There are two major cases in our getById method:

if the findFirst method returns the user, the getById should return it too,
if the findFirst method returns undefined, getById should throw the NotFoundException.

To test both situations, we need to mock the DrizzleService.

users.service.test.ts

import { UsersService } from './users.service';

import { Test } from '@nestjs/testing';

import { NotFoundException } from '@nestjs/common';

import { DrizzleService } from '../database/drizzle.service';

import { InferSelectModel } from 'drizzle-orm';

import { databaseSchema } from '../database/database-schema';

describe('The UsersService', () => {

let usersService: UsersService;

let findFirstMock: jest.Mock;

beforeEach(async () => {

findFirstMock = jest.fn();

const module = await Test.createTestingModule({

providers: [

UsersService,

{

provide: DrizzleService,

useValue: {

db: {

query: {

users: {

findFirst: findFirstMock,

}).compile();

usersService = await module.get(UsersService);

});

describe('when the getById function is called', () => {

describe('and the findFirst method returns the user', () => {

let user: InferSelectModel<typeof databaseSchema.users>;

beforeEach(() => {

user = {

id: 1,

email: 'john@smith.com',

password: 'strongPassword123',

addressId: null,

};

findFirstMock.mockResolvedValue(user);

});

it('should return the user', async () => {

const result = await usersService.getById(user.id);

expect(result).toBe(user);

});

describe('and the findFirst method does not return the user', () => {

beforeEach(() => {

findFirstMock.mockResolvedValue(undefined);

});

it('should throw the NotFoundException', async () => {

return expect(async () => {

await usersService.getById(1);

}).rejects.toThrow(NotFoundException);

});

Thanks to adjusting the mock for each case using findFirstMock.mockResolvedValue, we can cover both cases.

PASS src/users/users.service.test.ts
The UsersService
when the getById function is called
and the findFirst method returns the user
✓ should return the user
and the findFirst method does not return the user
✓ should throw the NotFoundException

Summary

In this article, we’ve covered the basics of unit testing and how to apply it in a NestJS application. To practice, we’ve used services that use Drizzle ORM under the hood to connect to the database. Since unit tests should not rely on a real database connection, we learned how to mock services, including the Drizzle Service. While this provides a solid foundation for testing a NestJS application with Drizzle ORM, there is still more to learn. Stay tuned!

Series Navigation<< API with NestJS #166. Logging with the Drizzle ORMAPI with NestJS #168. Integration tests with the Drizzle ORM >>