使用 Jasmine 监视私有变量的 attribute/function

Question

我有一个基于它读取的文件具有可变功能的函数，该函数通过保存在内存中的 Map 进行控制：

file1.ts

function f1(x: number): number {
  // do far-reaching things
  return 1;
}

function f2(x: number): number {
  // do different far-reaching things
  return 2;
}

function f3(x: number): number {
  // do still-different far-reaching things
  return 3;
}

const myMap: Map<string, (number) => number> = new Map<string, () => void>([
  ['key1', f1],
  ['key2', f2],
  ['key3', f3],
]

export function doThing(filename: string): number {
  // open file, make some database calls, and figure out the name of a key
  // ...
  let fileToExecute = myMap.get(key);
  return fileToExecute(someValueDerivedFromFile);
}

f1、f2 和 f3 都比这里显示的要多得多，每个都需要大量模拟才能成功测试。

随着代码的发展和用例的不断增加，根据不断扩大的输入集，可能需要调用任意数量的函数。 doThing() 很复杂，它从很多不同的来源获取信息，包括给定文件的内容和数据库，这有助于它选择要执行的文件。从客户端的角度来看，doThing() 是它唯一关心的功能。因此，它是此文件中唯一 export 编辑的文件。

我正在尝试测试 doThing() 中的机制，以确定它应该使用什么 key。我不想具体地嘲笑 f1、f2 和 f3 - 我想提供更多选项，由我为 doThing() 嘲笑的其他事情指出.但是，要检查它是否正在调用 correct 假方法，我需要弄清楚它正在调用哪个假方法。我尝试的解决方案使用类型转换来尝试将私有 myMap 从文件中拉出，然后监视其 get() 方法：

file1.spec.ts

import * as file1 from '../src/file1'
...
it("calls the correct fake method", () => {
  // lots of other mocks
  let spies = [
    jasmine.createSpy('f1spy').and.returnValue(4),
    jasmine.createSpy('f2spy').and.returnValue(5),
    jasmine.createSpy('f3spy').and.returnValue(6),
    ...
  ]
  let mockMap = spyOn((file1 as any).myMap, 'get').and.callFake((key) => {  // this fails
    var spy;
    switch(key) {
      case 'key1': spy = spies[0]; break;
      case 'key2': spy = spies[1]; break;
      case 'key3': spy = spies[2]; break;
      ...
    }
    return spy;
  }

  result = file1.doThing(...);

  expect(spies[0]).not.toHaveBeenCalled();
  expect(spies[1]).toHaveBeenCalledWith(7);
  expect(spies[2]).not.toHaveBeenCalled();
});

但是，我在上面的注释行中收到错误：Error: <spyOn> : could not find an object to spy upon for get()。经过进一步调查（即逐步调试器），事实证明我导入的 file1 对象 只有 doThing()，而没有它的任何其他私有变量。

我如何在这里成功地模拟键值转换 - 这意味着，在这种情况下，监视私有变量的属性，这样我就可以在正确的地方找到我的间谍？如果可能的话，完全替换 myMap 或替换 myMap.get() 都是一种选择。

Answer 1

Jasmine，据我所知，没有使用任何编译器类的魔法，所以 Jasmine 以访问您的私有变量。
From a client's point of view, doThing() is the only function it cares about. Thus, it's the only one exported by this file.

但这并不意味着您应该禁止过多人员访问您的测试。相反，您可以创建两个文件

file1.ts - 对于客户
```
import { doThing } from "./file1_implementation"
export doThing
```
和file1_implementation.ts - 供您测试
```
export function f1(...) ...
export function f2(...) ...
export function f3(...) ...
export const myMap ...
export function doThing(...) ...
```
然后在 file1.spec.ts 中您可以使用 file1_implementation.ts 并且您将可以访问您需要的一切
```
import * as file1 from '../src/file1_implementation'
...
```

Answer 2

你能把 file1 变成 class 吗？那你绝对可以从jasmine访问它的私有方法/属性。

所以 file1 变成：

export class FileHelper {

  private f1 () : void {}
  private f2 () : void {}
  private f3 () : void {}

  private myMap: Map<whatever, whatever>;

  public doThing () : void {}

}

然后在您的规范中：

let mapSpy: jasmine.Spy;
let myFileHelper: FileHelper;

beforeEach(() => {
  myFileHelper = new FileHelper();
  mapSpy = spyOn(<any>myFileHelper, 'myMap').and.callFake(() => {
    //whatever you were doing
  });
});


it('should do whatever', () => {

});

Answer 3

大体思路：使用rewire.

使用 rewire，我们将用 spy 函数覆盖您的私有函数。

但是，您的const myMap需要修改。因为当您执行 ['key1', f1] - 它存储 f1 的当前实现，所以我们无法在 myMap 初始化后覆盖它。克服这个问题的方法之一 - 使用 ['key1', args => f1(args)]。这样，它不会存储 f1 函数，只会调用它的包装器。您可以使用 apply() 或 call() 来达到同样的效果。

示例实现：

file1.ts:

function f1(): number {
  // do far-reaching things
  return 1;
}

const myMap: Map<string, (x: number) => number> = new Map([
  ['key1', (...args: Parameters<typeof f1>) => f1(...args)],
]);

export function doThing(): number {
  const key = 'key1';
  const magicNumber = 7;
  const fileToExecute = myMap.get(key);
  return fileToExecute(magicNumber);
}

file1.spec.ts:

import * as rewire from 'rewire';

it('calls the correct fake method', () => {
  const spies = [jasmine.createSpy('f1spy').and.returnValue(4)];

  const myModule = rewire('./file1');

  myModule.__set__('f1', spies[0]);

  myModule.doThing();

  expect(spies[0]).toHaveBeenCalledWith(7);
});

为了在 typescript 中使用 rewire，您可能需要使用 babel 等

为了概念验证，我只是要编译它：

./node_modules/.bin/tsc rewire-example/*

和运行测试：

./node_modules/.bin/jasmine rewire-example/file1.spec.js

哪个会运行成功：

Started
.


1 spec, 0 failures

更新

不修改 myMap：

file1.spec.ts:

import * as rewire from 'rewire';

it('calls the correct fake method', () => {
  const spies = [
    jasmine.createSpy('f1spy').and.returnValue(4),
    jasmine.createSpy('f2spy').and.returnValue(5),
    // ...
  ];

  const myModule = rewire('./file1');

  const myMockedMap: Map<string, (x: number) => number> = new Map();

  (myModule.__get__('myMap') as typeof myMockedMap).forEach((value, key) =>
    myMockedMap.set(key, value)
  );

  myModule.__set__('myMap', myMockedMap);

  // ...
});

使用 Jasmine 监视私有变量的 attribute/function

Spy on an attribute/function of a private variable with Jasmine

unit-testing

private

mocking

jasmine

typescript