NestJS Jest 错误：TypeError：无法读取未定义的属性（读取“[来自所需配置的任何变量]”）

Question

在尝试使用 nest 的笑话在单元测试中覆盖项目时，我遇到了一个测试模块无法从配置中提取变量的问题。

基本上，我有一个 EmailService，我想测试它，我在我的测试模块中将它用作提供者。 自然地，由于 EmailService 在其构造函数中使用 ConfigService 从配置中提取一些变量（最初来自 env），我也将 ConfigService 放入 providers 数组中......好吧，然后在初始化测试模块时丢弃 NestJS Jest 错误：TypeError：无法读取未定义的属性（阅读“区域”）

注意：区域变量取自已注册配置模块中的 env

我抛出的测试的代码示例

describe('EmailService', () => {
    let emailService: EmailService;
    let configService: ConfigService;

    beforeEach(async () => {
        const module: TestingModule = await Test.createTestingModule({
            providers: [EmailService, ConfigService],
        }).compile();

        emailService = module.get<EmailService>(EmailService);
        configService = module.get<ConfigService>(ConfigService);
    });

    it('should be defined', () => {
        expect(emailService).toBeDefined();
    });
});

我得出的结论是它会抛出一个错误，因为 EmailService 以这种方式在其构造函数中采用了 ConfigService：

export class EmailService {
    private readonly config: IAwsConfig;
    private readonly region: IRegion;

    constructor(private readonly configService: ConfigService) {
        this.config = this.configService.get('aws');
        this.region = this.config.region;
    }

附加信息：EmailService 和 ConfigService 在正常运行时都工作得很好，它只在玩笑测试时失败

似乎 this.configService.get 方法在测试运行期间返回“未定义”，我不确定为什么或如何修复它。 有任何想法吗？

Answer 1

连续 2 个小时都找不到答案，但是在提出问题 10 分钟后，go 给了你一个答案。

似乎 ConfigService 在玩笑测试期间不提供配置，因此您必须在测试模块中使用替换的 get 方法提供它，如下所示：

providers: [
        EmailService,
        {
          provide: ConfigService,
          useValue: {
            get: jest.fn((key: string) => {
              return hardcodedConfigFromWithinTheTestFile;
            }),
          },
        },
      ],

Answer 2

如果您不想导入整个 ConfigService 而只是导入配置值本身，那么您可以在测试中使用它们，如下所示：)

// my-config.ts
import { registerAs } from '@nestjs/config';

export default registerAs('myConfig', () => ({ propA: 'aa', propB: 123 }));

import { Inject } from '@nestjs/common';
import { ConfigType } from '@nestjs/config';
import myConfig from './my-config.ts';

export class EmailService {
  private propA: string;
  private propB: number;

  constructor(
    @Inject(myConfig.KEY) config: ConfigType<typeof myConfig>
  ) {
    this.propA = config.propA;
    this.propB = config.propB;
  }
}

import { ConfigModule, registerAs } from '@nestjs/config';
import { Test, TestingModule } from '@nestjs/testing';

describe('Test', () => {
  const configValues = { propA: 'aa', proprB: 123 };
  const config = registerAs('testConfig', () => configValues);

  beforeEach(async () => {
    const app: TestingModule = await Test.createTestingModule({
      imports: [ConfigModule.forFeature(config)],
      providers: [EmailService],
    }).compile();
  });

});