如何在NestJS测试中禁用ScheduleModule及@Cron装饰器

项目代码 #

app.module.ts #

import { Module } from '@nestjs/common';
import { CatsModule } from './cats/cats.module';

@Module({
 imports: [CatsModule, ScheduleModule.forRoot()],
})
export class AppModule {}

测试文件beforeEach代码 #

const moduleRef = await Test.createTestingModule({
  imports: [AppModule],
})
  .compile();

app = moduleRef.createNestApplication();
await app.init();

需求 #

测试时禁用所有@Cron()装饰器，完全关闭ScheduleModule，避免意外副作用。

解决方案 #

方法一：覆盖ScheduleModule核心服务 #

在测试模块中，替换SchedulerRegistry的实现为模拟空方法，让定时任务无法注册和执行：

import { SchedulerRegistry } from '@nestjs/schedule';
import { Test } from '@nestjs/testing';

// ...
const moduleRef = await Test.createTestingModule({
  imports: [AppModule],
})
  .overrideProvider(SchedulerRegistry)
  .useValue({
    addCronJob: jest.fn(),
    deleteCronJob: jest.fn(),
    getCronJob: jest.fn(),
    getCronJobs: jest.fn(),
    addInterval: jest.fn(),
    deleteInterval: jest.fn(),
    getInterval: jest.fn(),
    addTimeout: jest.fn(),
    deleteTimeout: jest.fn(),
    getTimeout: jest.fn(),
  })
  .compile();

app = moduleRef.createNestApplication();
await app.init();

方法二：通过环境变量控制ScheduleModule加载 #

修改app.module.ts，根据环境决定是否初始化ScheduleModule：

import { Module } from '@nestjs/common';
import { CatsModule } from './cats/cats.module';
import { ScheduleModule } from '@nestjs/schedule';

@Module({
  imports: [
    CatsModule,
    // 测试环境不加载ScheduleModule
    process.env.NODE_ENV !== 'test' ? ScheduleModule.forRoot() : [],
  ],
})
export class AppModule {}

测试时设置NODE_ENV=test即可跳过ScheduleModule的初始化。

方法三：构建独立测试模块 #

不直接导入完整的AppModule，只导入业务所需模块，排除ScheduleModule：

const moduleRef = await Test.createTestingModule({
  imports: [CatsModule], // 仅导入需要测试的业务模块
  // 按需添加控制器、提供者等测试依赖
})
  .compile();

app = moduleRef.createNestApplication();
await app.init();

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