如何使用jest和sequelize-typescript对sequelize数据库调用做单元测试
方案1:使用内存SQLite做轻量集成测试(最推荐,无需手动mock任何模型)
这是行业内测试Sequelize业务逻辑的主流方案,全程使用真实的模型方法执行,数据存在内存中,测试结束自动销毁,完全没有脏数据问题,同时省去了所有手动mock的工作量。
操作步骤:
- 安装SQLite依赖
npm install sqlite3 --save-dev
- 编写测试专用的Sequelize初始化工具
import { Sequelize } from 'sequelize-typescript'; // 引入你所有用到的模型,也可以配置modelPath自动加载指定目录下所有模型 import { UserModel } from '../models/UserModel'; export const initTestSequelize = async () => { const sequelize = new Sequelize({ dialect: 'sqlite', storage: ':memory:', // 所有数据存在内存,进程退出后自动清除 models: [UserModel], logging: false, // 关闭SQL日志避免测试输出杂乱 }); // 自动同步所有模型的表结构,无需执行迁移脚本 await sequelize.sync({ force: true }); return sequelize; };
- 测试用例中引入初始化工具
let testSequelize: Sequelize; // 测试套件启动前初始化一次Sequelize实例 beforeAll(async () => { testSequelize = await initTestSequelize(); }); // 测试套件结束后关闭实例释放内存 afterAll(async () => { await testSequelize.close(); }); test('1# Register user', async () => { const userService = new UserAccountService() const registerRequest: RegisterRequest = { email: 'abc@abc.com', password: '1234' } const registeredUser = await userService.register(registerRequest); // 可以直接校验真实落库的数据 expect(registeredUser.id).toBeDefined(); expect(registeredUser.email).toEqual('abc@abc.com'); });
这个方案唯一的限制是如果你的业务用到了特定数据库的独有语法(比如MySQL的JSON函数、PostgreSQL的数组类型),SQLite可能不兼容,这种情况可以换成testcontainers启动临时的真实数据库容器测试即可。
方案2:全局自动mock Sequelize模块(纯单元测试,完全不碰数据库)
如果你需要严格的单元测试,只校验业务逻辑的参数传递、分支判断,不需要测试数据库相关逻辑,可以用Jest全局自动mock整个sequelize-typescript模块,所有模型方法默认自带模拟返回,不用每个用例单独写mock。
操作步骤:
- 在项目根目录创建
__mocks__/sequelize-typescript.ts文件,内容如下:
// 模拟通用模型类,所有常用方法默认带mock返回 class MockModel { static create = jest.fn().mockImplementation(data => Promise.resolve(MockModel.build(data))); static findOne = jest.fn().mockResolvedValue(null); static findAll = jest.fn().mockResolvedValue([]); static update = jest.fn().mockResolvedValue([1]); static destroy = jest.fn().mockResolvedValue(1); static build = jest.fn(data => Object.assign(new MockModel(), data)); save = jest.fn().mockResolvedValue(this); update = jest.fn().mockResolvedValue(this); destroy = jest.fn().mockResolvedValue(true); } export const Model = MockModel; // 模拟所有用到的装饰器,返回空函数不影响模型定义 export const Table = jest.fn(() => () => {}); export const Column = jest.fn(() => () => {}); export const PrimaryKey = jest.fn(() => () => {}); export const AutoIncrement = jest.fn(() => () => {}); export const AllowNull = jest.fn(() => () => {}); export const Unique = jest.fn(() => () => {}); export const DataType = require('sequelize').DataType;
- 在测试文件顶部开启全局mock:
jest.mock('sequelize-typescript');
之后所有模型的方法都已经是Jest模拟函数,你原来的测试用例不需要修改就可以直接运行,只有需要自定义返回值的特殊场景才需要单独写mockResolvedValue覆盖默认返回。
内容的提问来源于stack exchange,提问作者Yatin Gaikwad
相关产品推荐
相关产品推荐

