如何通过Jest测试使用@InjectQueue注入的Nest Bull队列
解决方案
方案1:单元测试(Mock队列,推荐用于逻辑验证)
你直接用QUEUE_NAME取不到队列实例的核心原因是:Nest会对@InjectQueue装饰的依赖自动生成带前缀的注入Token,需要用官方提供的getQueueToken工具函数生成正确的Token才能匹配到对应依赖。
完整测试代码如下:
import { getQueueToken } from '@nestjs/bull'; // 使用BullMQ则导入@nestjs/bullmq import { Queue } from 'bull'; // 使用BullMQ则导入bullmq的Queue describe('EnqueuerService', () => { let module: TestingModule let enqueuerService: EnqueuerService // 定义Mock队列实例 const mockQueue: Partial<Queue> = { add: jest.fn().mockResolvedValue({ id: 'test-job-id' }) } beforeAll(async () => { module = await Test.createTestingModule({ imports: [EnqueuerModule] }) // 替换原队列依赖为Mock实例 .overrideProvider(getQueueToken(QUEUE_NAME)) .useValue(mockQueue) .compile() enqueuerService = module.get(EnqueuerService) }) afterAll(async () => await module.close()) describe('#foo', () => { it('adds a job', async () => { await enqueuerService.foo() // 直接断言Mock方法的调用次数和参数 expect(mockQueue.add).toBeCalledTimes(1) expect(mockQueue.add).toBeCalledWith('job') }) }) })
方案2:集成测试(真实队列,验证实际入队效果)
如果需要验证真实入队逻辑,只需要在测试模块中注册真实队列依赖,本地启动Redis服务即可:
import { BullModule, getQueueToken } from '@nestjs/bull'; import { Queue } from 'bull'; describe('EnqueuerService', () => { let module: TestingModule let enqueuerService: EnqueuerService let queue: Queue beforeAll(async () => { module = await Test.createTestingModule({ imports: [ // 注册Redis连接 BullModule.forRoot({ redis: { host: 'localhost', port: 6379 } }), // 注册对应名称的队列 BullModule.registerQueue({ name: QUEUE_NAME }), EnqueuerModule ] }).compile() enqueuerService = module.get(EnqueuerService) // 用正确的Token取真实队列实例 queue = module.get(getQueueToken(QUEUE_NAME)) }) // 每次测试后清空队列避免数据污染 afterEach(async () => { await queue.obliterate({ force: true }) }) afterAll(async () => await module.close()) describe('#foo', () => { it('adds a job to real queue', async () => { const beforeCount = await queue.count() await enqueuerService.foo() const afterCount = await queue.count() // 验证队列任务数增加1 expect(afterCount - beforeCount).toBe(1) // 也可以直接获取任务验证内容 const jobs = await queue.getJobs(['waiting']) expect(jobs[0].name).toBe('job') }) }) })
内容的提问来源于stack exchange,提问作者Jon Lauridsen
相关产品推荐
相关产品推荐

