在NestJS Jest测试中覆盖提供者

Question

我想在我的NestJS应用程序中使用内存中的Mongo实例来模拟数据以进行测试。我有一个数据库提供程序，它使用mongoose连接到我的生产数据库，mongoose是我的数据库模块的一部分，后者又被导入到其他模块中。

我试图在我的Jest测试中覆盖数据库提供程序，以便我可以使用内存中的Mongo实例。

这是数据库模块：

import { Module } from '@nestjs/common';
import { databaseProviders } from './database.providers';

@Module({
  providers: [...databaseProviders],
  exports: [...databaseProviders],
})
export class DatabaseModule { }

和databaseProvider：

export const databaseProviders = [
  {
    provide: 'DbConnectionToken',
    useFactory: async (): Promise<typeof mongoose> =>
      await mongoose.connect(PRODUCTION_DATABASE_URL),
  },
];

我有一个事件模块，它导入并使用数据库模块中的数据库连接，我正在测试事件服务 - 在我的events.spec.ts中的beforeEach：

beforeEach(async () => {
    const module = await Test.createTestingModule({
      imports: [EventsModule],
      providers: [
        EventsService,
        {
          provide: 'EventModelToken',
          useValue: EventSchema
        },
      ],
    }).compile();

    eventService = module.get<EventsService>(EventsService);
  });

我尝试将DatabaseModule导入测试模块，然后添加我的自定义提供程序，假设它将覆盖数据库提供程序，但它不能按我的预期工作，所以我担心我可能会误解覆盖提供程序在此上下文中的工作原理。

这是我试过的：

beforeEach(async () => {
  const module = await Test.createTestingModule({
    imports: [EventsModule, DatabaseModule],
    providers: [
      EventsService,
      {
        provide: 'EventModelToken',
        useValue: EventSchema
      },
      {
        provide: 'DbConnectionToken',
        useFactory: async (): Promise<typeof mongoose> =>
          await mongoose.connect(IN_MEMORY_DB_URI),
      },
    ],
  }).compile();

  eventService = module.get<EventsService>(EventsService);
});

Answer 1

如文档https://docs.nestjs.com/fundamentals/unit-testing中所指定，您可以使用值，工厂或类覆盖提供程序。

beforeEach(async () => {
    const module = await Test.createTestingModule({
        imports: [EventsModule, DatabaseModule],
        providers: [
            EventsService,
        ],
    }).overrideProvider('DbConnectionToken')
    .useFactory({
        factory: async (): Promise<typeof mongoose> =>
          await mongoose.connect(IN_MEMORY_DB_URI),
    })
    .compile();

    eventService = module.get<EventsService>(EventsService);
});

另一种方法是为你的配置制作一个提供者:)就像这样！

@Module({})
export DatabaseModule {
    public static forRoot(options: DatabaseOptions): DynamicModule {
        return {
            providers: [
                {
                    provide: 'DB_OPTIONS',
                    useValue: options,
                },
                {
                    provide: 'DbConnectionToken',
                    useFactory: async (options): Promise<typeof mongoose> => await mongoose.connect(options),
                    inject: ['DB_OPTIONS']
                },
            ],
        };
    }
}

然后像这样使用

const module: TestingModule = await Test.createTestingModule({
    imports: [DatabaseModule.forRoot({ host: 'whatever'})],
});

现在，您可以在任何地方使用它来更改选项:)