如何使用Jest模拟TypeORM DataSource并验证initialize调用？

以下是针对你遇到的问题的具体解决步骤，都是实际项目里常用的方案：

方案1：直接Mock你自己的createDBConnection函数 #

如果你的测试目标是验证调用createDBConnection的代码逻辑，而非测试createDBConnection本身，直接mock这个函数是最简单的方式：

// 测试文件顶部
jest.mock('../app/lib/connections/createDBConnection.ts', () => ({
  createDBConnection: jest.fn().mockResolvedValue({
    // 模拟initialize方法为已调用的mock函数
    initialize: jest.fn().mockResolvedValue(undefined),
    // 直接设置isInitialized为true
    isInitialized: true
  })
}));

// 在测试用例中
import { createDBConnection } from '../app/lib/connections/createDBConnection';

test('测试数据库连接逻辑', async () => {
  const db = await createDBConnection();
  
  // 断言createDBConnection被调用
  expect(createDBConnection).toHaveBeenCalled();
  // 断言initialize被调用
  expect(db.initialize).toHaveBeenCalled();
  // 断言isInitialized为true
  expect(db.isInitialized).toBe(true);
});

方案2：Mock TypeORM的DataSource类（适合测试createDBConnection本身） #

如果你要测试createDBConnection函数的逻辑（比如它正确调用了DataSource的initialize），需要mock TypeORM的核心模块：

// 测试文件顶部
jest.mock('typeorm', () => {
  // 创建一个mock的DataSource类
  const mockDataSource = jest.fn().mockImplementation(() => ({
    initialize: jest.fn().mockResolvedValue(undefined),
    isInitialized: true
  }));

  return {
    DataSource: mockDataSource,
    // 如果你的代码用到了其他TypeORM导出，也需要在这里mock
  };
});

// 在测试用例中
import { DataSource } from 'typeorm';
import { createDBConnection } from '../app/lib/connections/createDBConnection';

test('createDBConnection正确初始化DataSource', async () => {
  // 先mock Environment.get返回测试用的数据库URL
  jest.spyOn(Environment, 'get').mockReturnValue('test-db-url');

  const db = await createDBConnection();
  
  // 断言DataSource被实例化，且传入了正确的数据库URL
  expect(DataSource).toHaveBeenCalledWith(expect.objectContaining({
    url: 'test-db-url'
  }));
  // 断言initialize方法被调用
  expect(db.initialize).toHaveBeenCalled();
  // 断言isInitialized状态正确
  expect(db.isInitialized).toBe(true);
});

常见坑点排查 #

• 异步测试未正确处理：所有涉及initialize的测试都要使用async/await，或者在测试中返回Promise，否则Jest会在异步操作完成前结束测试，导致断言失败。
• Mock作用域问题：确保mock语句在测试文件的顶部，或者在beforeAll/beforeEach中设置，避免mock未生效。
• TypeORM版本差异：不同版本的TypeORM中，DataSource的API可能略有不同，比如旧版本用createConnection而不是DataSource，确认你的代码和mock的API匹配。

内容的提问来源于stack exchange，提问作者puggyman210