我可以使用Jest使用特定参数模拟函数吗?

时间:2017-01-17 12:42:53

标签: javascript unit-testing jestjs

我想用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中已经有这个功能吗?

感谢您的反馈。

6 个答案:

答案 0 :(得分:15)

我找到了我的同事最近写的这个图书馆: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

答案 1 :(得分:10)

jest-when提到的

STeve Shary可能是最好的选择。

如果您不想安装新的库,则在不关心原始功能的情况下,这里提供一种解决方案:

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

答案 2 :(得分:7)

在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
}

答案 3 :(得分:2)

这可能会有所帮助......

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

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

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

答案 4 :(得分:2)

您可以使用:

const mockSum = jest.fn();

mockSum.mockImplementation((x, y) => {
  // Return whatever you want based on x and y...
});

答案 5 :(得分:1)

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

取自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,那么您就可以开始了!