如何在 NestJS 中对 TypeORM 的自定义存储库进行单元测试?
How to unit test a custom repository of TypeORM in NestJS?
Class 测试
我的 TypeORM 存储库 extends
AbstractRepository:
@EntityRepository(User)
export class UsersRepository extends AbstractRepository<User> {
async findByEmail(email: string): Promise<User> {
return await this.repository.findOne({ email })
}
}
单元测试
describe('UsersRepository', () => {
let usersRepository: UsersRepository
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [UsersRepository]
}).compile()
usersRepository = module.get<UsersRepository>(UsersRepository)
})
describe('findByEmail', () => {
it(`should return the user when the user exists in database.`, async () => {
const fetchedUser = await usersRepository.findByEmail('test1@test.com')
})
})
})
在这里,我得到错误:
TypeError: Cannot read property 'getRepository' of undefined
at UsersRepository.get (repository/AbstractRepository.ts:43:29)
at UsersRepository.findByEmail (users/users.repository.ts:11:23)
at Object.<anonymous> (users/users.repository.spec.ts:55:49)
所以,我的问题是,如何模拟 repository
或 repository.findOne
?
换句话说,我如何模拟从 AbstractRepository
继承的 protected
并且无法从 UsersRepository
实例访问的字段?
有一个 ,但它是从 Repository<Entity>
而不是 AbstractRepository<Entity>
扩展而来的。他们能够嘲笑 findOne
因为它是 public
.
我试过的
我尝试以 NestJS 推荐的方式模拟它,但这是针对非自定义存储库的,在我的情况下不起作用:
{
provide: getRepositoryToken(User),
useValue: {
findOne: jest.fn().mockResolvedValue(new User())
}
}
我选择了内存数据库解决方案。这样我就不必模拟 TypeORM 的复杂查询。单元测试 运行 在不访问真实数据库的情况下同样快速。
我的生产数据库是 PostgreSQL,但我可以使用 SQLite 内存数据库进行单元测试。这是可行的,因为 TypeORM 提供了对数据库的抽象。只要我们满足存储库的接口,我们在后台使用什么数据库并不重要。
我的测试是这样的:
const testConnection = 'testConnection'
describe('UsersRepository', () => {
let usersRepository: UsersRepository
beforeEach(async () => {
const connection = await createConnection({
type: 'sqlite',
database: ':memory:',
dropSchema: true,
entities: [User],
synchronize: true,
logging: false,
name: testConnection
})
usersRepository = connection.getCustomRepository(UsersRepository)
})
afterEach(async () => {
await getConnection(testConnection).close()
})
describe('findByEmail', () => {
it(`should return the user when the user exists in database.`, async () => {
await usersRepository.createAndSave(testUser)
const fetchedUser = await usersRepository.findByEmail(testUser.email)
expect(fetchedUser.email).toEqual(testUser.email)
})
})
})
Class 测试
我的 TypeORM 存储库 extends
AbstractRepository:
@EntityRepository(User)
export class UsersRepository extends AbstractRepository<User> {
async findByEmail(email: string): Promise<User> {
return await this.repository.findOne({ email })
}
}
单元测试
describe('UsersRepository', () => {
let usersRepository: UsersRepository
beforeEach(async () => {
const module: TestingModule = await Test.createTestingModule({
providers: [UsersRepository]
}).compile()
usersRepository = module.get<UsersRepository>(UsersRepository)
})
describe('findByEmail', () => {
it(`should return the user when the user exists in database.`, async () => {
const fetchedUser = await usersRepository.findByEmail('test1@test.com')
})
})
})
在这里,我得到错误:
TypeError: Cannot read property 'getRepository' of undefined
at UsersRepository.get (repository/AbstractRepository.ts:43:29)
at UsersRepository.findByEmail (users/users.repository.ts:11:23)
at Object.<anonymous> (users/users.repository.spec.ts:55:49)
所以,我的问题是,如何模拟 repository
或 repository.findOne
?
换句话说,我如何模拟从 AbstractRepository
继承的 protected
并且无法从 UsersRepository
实例访问的字段?
有一个 Repository<Entity>
而不是 AbstractRepository<Entity>
扩展而来的。他们能够嘲笑 findOne
因为它是 public
.
我试过的
我尝试以 NestJS 推荐的方式模拟它,但这是针对非自定义存储库的,在我的情况下不起作用:
{
provide: getRepositoryToken(User),
useValue: {
findOne: jest.fn().mockResolvedValue(new User())
}
}
我选择了内存数据库解决方案。这样我就不必模拟 TypeORM 的复杂查询。单元测试 运行 在不访问真实数据库的情况下同样快速。
我的生产数据库是 PostgreSQL,但我可以使用 SQLite 内存数据库进行单元测试。这是可行的,因为 TypeORM 提供了对数据库的抽象。只要我们满足存储库的接口,我们在后台使用什么数据库并不重要。
我的测试是这样的:
const testConnection = 'testConnection'
describe('UsersRepository', () => {
let usersRepository: UsersRepository
beforeEach(async () => {
const connection = await createConnection({
type: 'sqlite',
database: ':memory:',
dropSchema: true,
entities: [User],
synchronize: true,
logging: false,
name: testConnection
})
usersRepository = connection.getCustomRepository(UsersRepository)
})
afterEach(async () => {
await getConnection(testConnection).close()
})
describe('findByEmail', () => {
it(`should return the user when the user exists in database.`, async () => {
await usersRepository.createAndSave(testUser)
const fetchedUser = await usersRepository.findByEmail(testUser.email)
expect(fetchedUser.email).toEqual(testUser.email)
})
})
})