API with NestJS #168. Integration tests with the Drizzle ORM

September 30, 2024

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

Writing tests for our application helps ensure it works as intended and is reliable. So far, we have written unit tests for our NestJS application that uses the Drizzle ORM. Unit tests help us check if a particular class of a single function functions properly on its own. While unit tests are important, they are not enough. Even if each piece of our system works well alone, it does not yet mean it functions together with other parts of our system.

Introducing integration tests

To test how two or more pieces of our application work together, we write integration tests. Let’s take a look at the signUp method we wrote in the previous parts of this series.

authentication.service.ts

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

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

import * as bcrypt from 'bcrypt';

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

@Injectable()

export class AuthenticationService {

constructor(private readonly usersService: UsersService) {}

async signUp(signUpData: SignUpDto) {

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

return this.usersService.create({

email: signUpData.email,

phoneNumber: signUpData.phoneNumber,

password: hashedPassword,

address: signUpData.address,

});

}

// ...

}

It hashes the provided password and calls the create method from the UsersService under the hood.

users.service.ts

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

import { UserDto } from './user.dto';

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

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

import { PostgresErrorCode } from '../database/postgres-error-code.enum';

import { UserAlreadyExistsException } from './user-already-exists.exception';

import { isDatabaseError } from '../database/databse-error';

@Injectable()

export class UsersService {

constructor(private readonly drizzleService: DrizzleService) {}

async create(user: UserDto) {

try {

const createdUsers = await this.drizzleService.db

.insert(databaseSchema.users)

.values(user)

.returning();

return createdUsers.pop();

} catch (error) {

if (

isDatabaseError(error) &&

error.code === PostgresErrorCode.UniqueViolation

) {

throw new UserAlreadyExistsException(user.email);

}

throw error;

}

// ...

}

The create method creates the user in the database and handles the error that could happen when we try to sign up a new user with an email already in our database.

There are a few things in the signUp method we could test with integration tests:

whether it hashes the password,
if it returns the created user if the provided data is valid
if it throws the UserAlreadyExistsException error thrown by the create method.

Since we want to test how the AuthenticationService integrates with the UsersService, we won’t be mocking the UsersService. Instead, let’s mock the DrizzleService to ensure we’re not using the real database in our tests.

Writing integration tests does not mean we want to check how all parts of our system work together. Those tests are called end-to-end (E2E) tests and should mimic a real system as close as possible.

An important thing to notice is that we’re chaining the insert, values, and returning functions.

const createdUsers = await this.drizzleService.db

.insert(databaseSchema.users)

.values(user)

.returning();

To handle that in our tests, we can use the mockReturnThis() method.

Since hashing a password with bcrypt includes a random salt, we should mock the bcrypt library to produce the same output consistently.

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 { DrizzleService } from '../database/drizzle.service';

jest.mock('bcrypt', () => ({

hash: () => {

return Promise.resolve('hashed-password');

}));

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

let authenticationService: AuthenticationService;

let drizzleInsertReturningMock: jest.Mock;

let drizzleInsertValuesMock: jest.Mock;

let signUpData: SignUpDto;

beforeEach(async () => {

drizzleInsertValuesMock = jest.fn().mockReturnThis();

drizzleInsertReturningMock = jest.fn().mockResolvedValue([]);

signUpData = {

email: 'john@smith.com',

password: 'strongPassword123',

phoneNumber: '123456789',

};

const module = await Test.createTestingModule({

providers: [

AuthenticationService,

UsersService,

{

provide: DrizzleService,

useValue: {

db: {

insert: jest.fn().mockReturnThis(),

values: drizzleInsertValuesMock,

returning: drizzleInsertReturningMock,

imports: [

ConfigModule.forRoot(),

JwtModule.register({

secretOrPrivateKey: 'Secret key',

}),

}).compile();

authenticationService = await module.get(AuthenticationService);

});

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

it('should insert the user using the Drizzle ORM', async () => {

await authenticationService.signUp(signUpData);

expect(drizzleInsertValuesMock).toHaveBeenCalledWith({

...signUpData,

password: 'hashed-password',

});

Testing the result of the method

Now, let’s test if the signUp method returns a valid user in various cases. In the first case, the DrizzleService returns a valid user. In the second case, it throws an error because the email has already been taken.

To handle that, we must adjust our drizzleInsertReturningMock for each test using the mockResolvedValue and mockImplementation functions.

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 { DrizzleService } from '../database/drizzle.service';

import { InferSelectModel } from 'drizzle-orm';

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

import { DatabaseError } from '../database/databse-error';

import { PostgresErrorCode } from '../database/postgres-error-code.enum';

import { UserAlreadyExistsException } from '../users/user-already-exists.exception';

jest.mock('bcrypt', () => ({

hash: () => {

return Promise.resolve('hashed-password');

}));

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

let authenticationService: AuthenticationService;

let drizzleInsertReturningMock: jest.Mock;

let drizzleInsertValuesMock: jest.Mock;

let signUpData: SignUpDto;

beforeEach(async () => {

drizzleInsertValuesMock = jest.fn().mockReturnThis();

drizzleInsertReturningMock = jest.fn().mockResolvedValue([]);

signUpData = {

email: 'john@smith.com',

password: 'strongPassword123',

phoneNumber: '123456789',

};

const module = await Test.createTestingModule({

providers: [

AuthenticationService,

UsersService,

{

provide: DrizzleService,

useValue: {

db: {

insert: jest.fn().mockReturnThis(),

values: drizzleInsertValuesMock,

returning: drizzleInsertReturningMock,

imports: [

ConfigModule.forRoot(),

JwtModule.register({

secretOrPrivateKey: 'Secret key',

}),

}).compile();

authenticationService = await module.get(AuthenticationService);

});

// ...

describe('when the DrizzleService returns a valid user', () => {

let createdUser: InferSelectModel<typeof databaseSchema.users>;

beforeEach(() => {

createdUser = {

...signUpData,

id: 1,

addressId: null,

};

drizzleInsertReturningMock.mockResolvedValue([createdUser]);

});

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

const result = await authenticationService.signUp(signUpData);

expect(result).toBe(createdUser);

});

describe('when the DrizzleService throws the UniqueViolation error', () => {

beforeEach(() => {

const databaseError: DatabaseError = {

code: PostgresErrorCode.UniqueViolation,

table: 'users',

detail: 'Key (email)=(john@smith.com) already exists.',

};

drizzleInsertReturningMock.mockImplementation(() => {

throw databaseError;

});

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

return expect(async () => {

await authenticationService.signUp(signUpData);

}).rejects.toThrow(UserAlreadyExistsException);

});

Testing controllers

An alternative approach to writing integration tests is to make HTTP requests to our API. By doing that, we can test multiple layers of our application, from the controllers to the services. To do that, we need to install the SuperTest library.

1	npm install supertest @types/supertest

First, we need to initialize our NestJS application in our tests. We will need the app variable to perform the tests with the SuperTest library.

categories.controller.test.ts

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

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

import { CategoriesService } from './categories.service';

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

import { CategoriesController } from './categories.controller';

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

let app: INestApplication;

let findFirstMock: jest.Mock;

beforeEach(async () => {

findFirstMock = jest.fn();

const module = await Test.createTestingModule({

providers: [

CategoriesService,

{

provide: DrizzleService,

useValue: {

db: {

query: {

categories: {

findFirst: findFirstMock,

controllers: [CategoriesController],

imports: [],

}).compile();

app = module.createNestApplication();

await app.init();

});

// ...

});

Now, let’s use the SuperTest library to make GET requests to our API. When doing that, we can tackle various scenarios, such as categories with a given ID being available or not. To do that, we need to mock our DrizzleService accordingly.

categories.controller.test.ts

import * as request from 'supertest';

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

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

let app: INestApplication;

let findFirstMock: jest.Mock;

// ...

describe('when the GET /categories/:id endpoint is called', () => {

describe('and the category with a given id exists', () => {

beforeEach(() => {

findFirstMock.mockResolvedValue({

id: 1,

categoriesArticles: [],

});

it('should respond with the category', () => {

return request(app.getHttpServer()).get('/categories/1').expect({

id: 1,

articles: [],

});

describe('and the category with a given id does not exist', () => {

beforeEach(() => {

findFirstMock.mockResolvedValue(undefined);

});

it('should respond with the 404 status', () => {

return request(app.getHttpServer()).get('/categories/2').expect(404);

});

POST requests and authentication

We can also make POST requests and send data using the request body to add new categories. However, we must consider that our API requires the user to authenticate before doing that. To deal with that, we need to mock the JwtAuthenticationGuard.

categories.controller.test.ts

import { ExecutionContext, INestApplication } from '@nestjs/common';

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

import { CategoriesService } from './categories.service';

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

import { CategoriesController } from './categories.controller';

import { JwtAuthenticationGuard } from '../authentication/jwt-authentication.guard';

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

let app: INestApplication;

let findFirstMock: jest.Mock;

let drizzleInsertReturningMock: jest.Mock;

beforeEach(async () => {

drizzleInsertReturningMock = jest.fn().mockResolvedValue([]);

findFirstMock = jest.fn();

const module = await Test.createTestingModule({

providers: [

CategoriesService,

{

provide: DrizzleService,

useValue: {

db: {

query: {

categories: {

findFirst: findFirstMock,

insert: jest.fn().mockReturnThis(),

values: jest.fn().mockReturnThis(),

returning: drizzleInsertReturningMock,

controllers: [CategoriesController],

imports: [],

})

.overrideGuard(JwtAuthenticationGuard)

.useValue({

canActivate: (context: ExecutionContext) => {

const req = context.switchToHttp().getRequest();

req.user = {

id: 1,

};

return true;

})

.compile();

app = module.createNestApplication();

await app.init();

});

// ...

});

Thanks to the above, we can test if adding new categories works as expected.

categories.controller.test.ts

import * as request from 'supertest';

import { ExecutionContext, INestApplication } from '@nestjs/common';

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

import { CategoriesService } from './categories.service';

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

import { CategoriesController } from './categories.controller';

import { JwtAuthenticationGuard } from '../authentication/jwt-authentication.guard';

import { CategoryDto } from './dto/category.dto';

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

let app: INestApplication;

let findFirstMock: jest.Mock;

let drizzleInsertReturningMock: jest.Mock;

beforeEach(async () => {

drizzleInsertReturningMock = jest.fn().mockResolvedValue([]);

findFirstMock = jest.fn();

const module = await Test.createTestingModule({

providers: [

CategoriesService,

{

provide: DrizzleService,

useValue: {

db: {

query: {

categories: {

findFirst: findFirstMock,

insert: jest.fn().mockReturnThis(),

values: jest.fn().mockReturnThis(),

returning: drizzleInsertReturningMock,

controllers: [CategoriesController],

imports: [],

})

.overrideGuard(JwtAuthenticationGuard)

.useValue({

canActivate: (context: ExecutionContext) => {

const req = context.switchToHttp().getRequest();

req.user = {

id: 1,

};

return true;

})

.compile();

app = module.createNestApplication();

await app.init();

});

// ...

describe('when the POST /categories endpoint is called', () => {

describe('and the correct data is provided', () => {

let categoryData: CategoryDto;

beforeEach(() => {

categoryData = {

};

drizzleInsertReturningMock.mockResolvedValue([

{

id: 2,

...categoryData,

]);

});

it('should respond with the new category', () => {

return request(app.getHttpServer())

.post('/categories')

.send(categoryData)

.expect({

id: 2,

...categoryData,

});

Summary

In this article, we explored the concept of integration tests in NestJS applications using the Drizzle ORM. We discussed why they’re important and how they benefit us. We also implemented two different approaches to integration tests, one of which involved using the SuperTest library to simulate HTTP requests. Thanks to the above, we can test our API more effectively and have a more reliable, stable application.

Series Navigation<< API with NestJS #167. Unit tests with the Drizzle ORMAPI with NestJS #169. Unique IDs with UUIDs using Drizzle ORM and PostgreSQL >>