NestJS 在用玩笑测试方法之前访问私有类字段

Question

假设有以下嵌套服务类，其中 private 字段 myCache 和公共方法 myFunction：

import * as NodeCache from 'node-cache'
class MyService{
    private myCache = new NodeCache();

    myFunction() {
        let data = this.myCache.get('data');
        if(data === undefined){
            // get data with an http request and store it in this.myCache with the key 'data'
        } 
        return data;
    }
}

我想针对两种不同的情况测试函数 myFunction。 第一种情况：如果条件为真。第二种情况：如果条件为假。

这是缺少两个测试的测试类：

import { Test, TestingModule } from '@nestjs/testing';
import { MyService} from './myService';

describe('MyService', () => {
  let service: MyService;

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

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

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

  describe('myFunction', () => {
      it('should return chached data', () => {
          // first test
      }),
      it('should return new mocked data', () => {
          // second test
      })
   })
});

因此我想我必须访问或模拟 myCache 私有类字段。 因为它是私有的，所以我无法在测试类中访问它。

我的问题是：实现这一目标的最佳和正确方法是什么？

Answer 1

如果你只是想模拟它，你总是可以使用 as any 告诉 Typescript 不要警告你访问私有值。

jest.spyOn((service as any).myCache, 'get').mockReturnValueOnce(someValue);

但是，必须一遍又一遍地做这有点烦人，这并不是最佳实践。相反，我要做的是将您的缓存移动为可注入的提供程序，以便可以立即将其换出，并且您的MyService 不再对node-cache 有硬依赖。像这样的：

// my.module.ts
@Module({
  providers: [
    MyService,
    {
      provide: 'CACHE',
      useClass: NodeCache
    }
  ]
})
export class MyModule {}

// my.service.ts
@Injectable()
export class MyService {
  constructor(@Inject('CACHE') private readonly myCache: NodeCache) {}
...

现在在您的测试中，您可以将 CACHE 令牌换成一个模拟实现，该实现也可以在您的 beforeEach 块中检索，这意味着不再有任何。

describe('MyService', () => {
  let service: MyService;
  let cache: { get; set; }; // you can change the type here
  
  beforeEach(async () => {
    const modRef = await Test.createTestingModule({
      providers: [
        MyService,
        {
          provide: 'CACHE',
          useValue: { get: jest.fn(), set: jest.fn() }
        }
      ]
    }).compile();
    service = modRef.get(MyService);
    cache = modRef.get<{ get; set; }>('CACHE');
  });
});

现在您可以在不使用as any 的情况下拨打jest.spyOn(cache, 'get')。