将TypeORM存储库注入NestJS服务以进行模拟数据测试

Question

关于如何在这个issue中做到这一点有一个很长的讨论。

我已经尝试了一些建议的解决方案，但我没有太多运气。

任何人都可以提供如何使用注入的存储库和模拟数据测试服务的具体示例吗？

Answer 1

假设我们有一个非常简单的服务，它通过id找到一个用户实体：

export class UserService {
  constructor(@InjectRepository(UserEntity) private userRepository: Repository<UserEntity>) {
  }

  async findUser(userId: string): Promise<UserEntity> {
    return this.userRepository.findOne(userId);
  }
}

然后你可以使用以下模拟工厂模拟UserRepository（根据需要添加更多方法）：

// @ts-ignore
export const repositoryMockFactory: () => MockType<Repository<any>> = jest.fn(() => ({
  findOne: jest.fn(entity => entity),
  // ...
}));

使用工厂可确保每次测试都使用新的模拟。

describe('UserService', () => {
  let service: UserService;
  let repositoryMock: MockType<Repository<UserEntity>>;

  beforeEach(async () => {
    const module: TestingModule = await Test.createTestingModule({
      providers: [
        UserService,
        // Provide your mock instead of the actual repository
        { provide: getRepositoryToken(UserEntity), useFactory: repositoryMockFactory },
      ],
    }).compile();
    service = module.get<UserService>(UserService);
    repositoryMock = module.get(getRepositoryToken(UserEntity));
  });

  it('should find a user', async () => {
    const user = {name: 'Alni', id: '123'};
    // Now you can control the return value of your mock's methods
    repositoryMock.findOne.mockReturnValue(user);
    expect(service.findUser(user.id)).toEqual(user);
    // And make assertions on how often and with what params your mock's methods are called
    expect(repositoryMock.findOne).toHaveBeenCalledWith(user.id);
  });
});

对于类型安全和舒适，您可以使用以下键入您的模拟（远非完美，当jest本身在即将发布的主要版本中开始使用typescript时可能有更好的解决方案）：

export type MockType<T> = {
  [P in keyof T]: jest.Mock<{}>;
};

Answer 2

我还发现这对我有用：

export const mockRepository = jest.fn(() => ({
  metadata: {
    columns: [],
    relations: [],
  },
}));

和

const module: TestingModule = await Test.createTestingModule({
      providers: [{ provide: getRepositoryToken(Entity), useClass: mockRepository }],
    }).compile();