我可以使用 Jest 模拟具有特定参数的函数吗？

Question

我想用 Jest 模拟一个函数，但前提是使用特定参数调用它，例如：

function sum(x, y) {
  return x + y;
}
    
// mock sum(1, 1) to return 4
sum(1, 1) // returns 4 (mocked)
sum(1, 2) // returns 3 (not mocked)

Ruby 的 RSpec 库中实现了类似的功能：

class Math
  def self.sum(x, y)
    return x + y
  end
end

allow(Math).to receive(:sum).with(1, 1).and_return(4)
Math.sum(1, 1) # returns 4 (mocked)
Math.sum(1, 2) # returns 3 (not mocked)

我在测试中试图实现的是更好的解耦，假设我想测试一个依赖于

sum

的函数：

function sum2(x) {
  return sum(x, 2);
}

// I don't want to depend on the sum implementation in my tests, 
// so I would like to mock sum(1, 2) to be "anything I want", 
// and so be able to test:

expect(sum2(1)).toBe("anything I want");

// If this test passes, I've the guarantee that sum2(x) is returning
// sum(x, 2), but I don't have to know what sum(x, 2) should return

我知道有一种方法可以通过执行以下操作来实现此目的：

sum = jest.fn(function (x, y) {
  if (x === 1 && y === 2) {
    return "anything I want";
  } else {
    return sum(x, y);
  }
});

expect(sum2(1)).toBe("anything I want");

但是如果我们有一些糖函数来简化它那就太好了。

听起来有道理吗？我们 Jest 中已经有这个功能了吗？

感谢您的反馈。

Answer 1

我发现了我的一位同事最近写的这个库：

jest-when

import { when } from 'jest-when';

const fn = jest.fn();
when(fn).calledWith(1).mockReturnValue('yay!');

const result = fn(1);
expect(result).toEqual('yay!');

这是库：https://github.com/timkindberg/jest-when

Answer 2

jest-when

提到的

STeve Shary

可能是最好的选择。

如果你不想安装新的库，当你不关心原来的功能时，这里有一个一行解决方案：

sum.mockImplementation((x, y) => x === 1 && y === 2 && "my-return-value")

Answer 3

import * as helper from "../helper";  //file where all functions are

jest.spyOn(helper, "function_name").mockImplementation((argument) => {

// This argument is the one passed to the function you are mocking

  if (argument === "something") {
    return "something"
  } else {
    return "something else"
  }
});

Answer 4

我认为我也需要一种用参数来模拟的方法，但对我来说，我可以通过简单地知道调用顺序来解决我的问题。

取自jest文档

const filterTestFn = jest.fn();

// Make the mock return `true` for the first call,
// and `false` for the second call
filterTestFn.mockReturnValueOnce(true).mockReturnValueOnce(false);

因此，在上面的示例中，只要您知道在第一次传递时该函数应返回 true，而在第二次传递时应返回 false，那么您就可以开始了！

Answer 5

不，在 Jest 中还没有办法做到这一点。您可以使用 sinons 存根 来实现此目的。来自文档：

stub.withArgs(arg1[, arg2, ...]);

仅对方法进行存根 提供了论据。这对于在你的作品中更具表现力很有用 断言，您可以使用相同的调用来访问间谍。这是 对于创建一个可以以不同方式响应的存根也很有用 不同的论点。

"test should stub method differently based on arguments": function () {
    var callback = sinon.stub();
    callback.withArgs(42).returns(1);
    callback.withArgs(1).throws("TypeError");

    callback(); // No return value, no exception
    callback(42); // Returns 1
    callback(1); // Throws TypeError
}

Answer 6

这可能有帮助...

我有类似的东西，我使用不同的参数调用相同的方法，需要从存根/模拟调用返回不同的结果。 当我调用模拟服务时，我使用了一个带有函数列表的变量，我从队列顶部取出函数并执行函数。它需要了解您正在测试的执行顺序，并且不能真正处理通过参数改变响应，但允许我解决开玩笑的限制。

var mockedQueue = [];
mockedQueue.push(() => {return 'A';})
mockedQueue.push(() => {return 'B';})

service.invoke = jest.fn(()=>{
    serviceFunctionToCall = mockedQueue.shift();
    return serviceFunctionToCall();
})

Answer 7

您可以在 Jest 中执行此操作，无需外部库。只需保留对原始实现的引用即可：

import * as MyModule from "./MyModule";

const originalMyFunction = MyModule.myFunction;

jest.spyOn(MyModule, "myFunction").mockImplementation((key: string) => {
 if (key === "keyIWantToMock") {
   return "someMockedValue";
 } else {
   return originalMyFunction(key);
 }
});