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

Posted 2023-02-26

【中文标题】我可以使用 Jest 模拟具有特定参数的函数吗？

【英文标题】：Can I mock functions with specific arguments using Jest?

【发布时间】：2017-06-01 12:55:24

【问题描述】：

我想用 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 中是否已经具备此功能？

感谢您的反馈。

【问题讨论】：

我也一直在处理这个问题，但最后想出了一个非常简单的解决方案：const functionResult = myFunc(args); expect(functionResult).toBe('whatever');

【参考方案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

【参考方案2】：

STeve Shary 提到的jest-when 可能是最好的选择。

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

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

【参考方案3】：

不，在 Jest 中还没有办法做到这一点。您可以为此使用sinons stubs。来自文档：

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

【参考方案4】：

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

取自jest documentation

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，那么你就可以开始了！

【讨论】：

我认为这种测试很脆弱，因为它依赖于非常具体的实现。如果调用的顺序在实现中并不重要，我不建议使用这种方法。

否，但此解决方案适用于调用顺序很重要的场景。

好的。我只是不认为调用顺序对 OP 的情况很重要，所以我不会向 OP 建议这个解决方案。

不是具体问题，但如果你用谷歌搜索“我可以使用 Jest 模拟具有特定参数的函数吗”这个问题出现了，我的回答只是指出你可能不需要你的想法你需要。

是的，这很公平。

【参考方案5】：

这可能会有所帮助...

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

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

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

【讨论】：

你可以多次使用mockReturnValueOnce 而不是这个