使用 Jasmine 监视私有变量的属性/函数

Posted 2023-02-25

【中文标题】使用 Jasmine 监视私有变量的属性/函数

【英文标题】：Spy on an attribute/function of a private variable with Jasmine

【发布时间】：2020-07-16 03:21:02

【问题描述】：

我有一个基于它读取的文件具有可变功能的函数，该函数通过它保存在内存中的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);

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

我正在尝试测试doThing() 中的机制，以确定它应该使用什么key。我不想专门模拟f1、f2 和f3 - 我想展示更多选项，这些选项是我为doThing() 模拟的其他内容所指出的。但是，要检查它是否调用了 正确 假方法，我需要弄清楚它调用的是哪个假方法。我尝试的解决方案使用类型转换来尝试将私有 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()。

【问题讨论】：

我不确定这是否好用，但我相信如果你这样做spyOn(((file1 as any).myMap as any), 'get')，它应该可以工作并消除private 障碍。

@AliF50 不工作，很遗憾。有问题的 file1 是一个完整的模块，而不是一个类，所以我认为对象上甚至没有非导出的属性供我通过类型转换获得。

【参考方案1】：

总体思路：使用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);
);

为了将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);

  // ...
);

【讨论】：

作为对此的可能修改，是否可以将其保持为当前定义，并使用rewire 导入的任何内容来执行myModule.__get__('myMap') 之类的操作，然后修改生成的对象?

@GreenCloakGuy 如果您将此标记为已接受的答案，如果它回答了您的问题，我将不胜感激，谢谢！

【参考方案2】：

你能把 file1 变成一个类吗？那么你绝对可以从 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', () => 

);

【参考方案3】：

Jasmine，据我所知，不使用任何编译器类型的魔法，所以 Jasmine 不可能访问您的私有变量。

从客户的角度来看，doThing() 是它唯一关心的功能。因此，它是该文件唯一导出的一个。

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

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'
...

【讨论】：

请注意，根据您的编译器/捆绑器设置，即使这也可能无法正常工作。例如。由于某些捆绑器设置更改，此技术在 Angular 9 中停止工作：github.com/angular/angular-cli/issues/…