NestJSと非同期関数を使用したJest

Aug 18 2020

私はのテスト非同期関数にしようとしているservicenestJS

この関数は非同期です...基本的にデータベースから値(JSON)を取得し(リポジトリ-TypeORMを使用)、データを正常に取得したら、別のクラス(DTO)に「変換」します...実装:

async getAppConfig(): Promise<ConfigAppDto> {
  return this.configRepository.findOne({
    key: Equal("APPLICATION"),
  }).then(config => {
    if (config == null) {
      return new class implements ConfigAppDto {
        clientId = '';
        clientSecret = '';
      };
    }
    return JSON.parse(config.value) as ConfigAppDto;
  });
}

コントローラを使用して、これが正常に機能することを確認しました。今、私はJestを使用してテストを実行しようとしていますが、成功しません...私の問題は、findOne関数をrepository..からモックする方法です。

編集:私は@golevelup/nestjs-testingモックに使用しようとしていますRepository

私はすでにを嘲笑しましたrepositoryが、何らかの理由で、resolveは決して呼び出されません。

describe('getAppConfig', () => {
  const repo = createMock<Repository<Config>>();

  beforeEach(async () => {
    await Test.createTestingModule({
      providers: [
        ConfigService,
        {
          provide: getRepositoryToken(Config),
          useValue: repo,
        }
      ],
    }).compile();
  });

  it('should return ConfigApp parameters', async () => {
    const mockedConfig = new Config('APPLICATION', '{"clientId": "foo","clientSecret": "bar"}');
    repo.findOne.mockResolvedValue(mockedConfig);
    expect(await repo.findOne()).toEqual(mockedConfig); // ok

    const expectedReturn = new class implements ConfigAppDto {
      clientId = 'foo';
      clientSecret = 'bar';
    };
    expect(await service.getAppConfig()).toEqual(expectedReturn);

    // jest documentation about async -> https://jestjs.io/docs/en/asynchronous
    // return expect(service.getAppConfig()).resolves.toBe(expectedReturn);
  });
})
  • expect(await repo.findOne()).toEqual(mockedConfig);素晴らしい作品。
  • expect(await service.getAppConfig()).toEqual(expectedReturn);タイムアウトが発生しました=> Async callback was not invoked within the 5000 ms timeout specified by jest.setTimeout;

デバッグを使用して、私がいることがわかりservice.getAppConfig()、呼ばれてrepository.findOne()も、しかし、.thenfindOneのリポジトリのが呼ばれることはありません。

更新:を使用してリポジトリをモックしようとしていますが@golevelup/nestjs-testing、何らかの理由で、モックされた結果がサービスで機能しません。jest(以下のコードのように)のみを使用してリポジトリをモックすると、テストは機能します...したがって、私の本当の問題はそれだと思います@golevelup/nestjs-testing

...
provide: getRepositoryToken(Config),
useValue: {
  find: jest.fn().mockResolvedValue([new Config()])
},
...

回答

2 RobertoCorreia Aug 21 2020 at 22:25

だから、私の本当の問題は、私はからかってる方法ですRepository上をNestJS。どういうわけか、を使ってモックすると@golevelup/nestjs-testing、変なことが起こります!

私はこれについての良いドキュメントを本当に見つけられなかった@golevelup/nestjs-testingので、私はそれを使うのをあきらめました。

質問に対する私のソリューションのみを使用したJestNestJS機能...結果コードは:

サービス

// i'm injecting Connection because I need for some transactions later;
constructor(@InjectRepository(Config) private readonly configRepo: Repository<Config>, private connection: Connection) {}

async getAppConfig(): Promise<ConfigApp> {
  return this.configRepo.findOne({
    key: Equal("APPLICATION"),
  }).then(config => {
    if (config == null) {
      return new ConfigApp();
    }
    return JSON.parse(config.value) as ConfigApp;
  })
}

テスト

describe('getAppConfig', () => {
  const configApi = new Config();
  configApi.key = 'APPLICATION';
  configApi.value = '{"clientId": "foo", "clientSecret": "bar"}';

  beforeEach(async () => {
    const module = await Test.createTestingModule({
      providers: [
        ConfigAppService,
        {
          provide: getRepositoryToken(Config),
          useValue: {
            findOne: jest.fn().mockResolvedValue(new
            Config("APPLICATION", '{"clientId": "foo", "clientSecret": "bar"}')),
          },
        },
        {
          provide: getConnectionToken(),
          useValue: {},
        }
      ],
    }).compile();

    service = module.get<ConfigAppService>(ConfigAppService);
  });

  it('should return ConfigApp parameters', async () => {
    const expectedValue: ConfigApp = new ConfigApp("foo", "bar");

    return service.getAppConfig().then(value => {
      expect(value).toEqual(expectedValue);
    })
  });
})

このソリューションに利用されるいくつかのソース: https://github.com/jmcdo29/testing-nestjs/tree/master/apps/typeorm-sample

1 Leo Aug 18 2020 at 19:53

expect(await repo.findOne()).toEqual(mockedConfig);あなたがそれを嘲笑したのでうまくいくと思うので、すぐに戻ってきます。の場合、expect(await service.getAppConfig()).toEqual(expectedReturn);モックを作成しなかったため、おそらく時間がかかるため、it関数はPromise完全に解決される前に戻ります。

への呼び出しをモックする場合は、jestドキュメントから投稿したコメントでうまくいくはずですgetAppConfig()

service.getAppConfig = jest.fn(() => Promise.resolve(someFakeValue))

または

spyOn(service, 'getAppConfig').and.mockReturnValue(Promise.resolve(fakeValue))