sinon-chai-calls-assertion
v2.3.1
Published
A simple sinon-chai assertion to validate many aspects of stub calls
Downloads
2,069
Readme
sinon-chai-calls-assertion
A simple assertion to validate many aspects of stub calls. It is supposed to use with sinon + chai.
How it works
expect(stub).callsLike
Will validate the exactly interaction with the mocked method, which is:
- How many times has been called;
- Which parameters have been passed to it;
- In what order the calls happened.
How to use?
Just pass the stub in the first parameter and, in the others, arrays with the set of parameters each calls had received.
expect(myStub).callsLike(
['param1call1', 'param2call1', 'param3call1'],
['param1call2', 'param2call2', 'param3call2'],
);
If you want to check if the stub had never been called, pass just the stub:
expect(myStub).callsLike();
If you expect the stub to have been called with no parameters, pass empty arrays:
expect(myStub).callsLike([], [], [])
(in this example, myStub have been called three times with no parameters)
You can also use sinon matchers to validate the parameters instead of exact values:
expect(myStub).callsLike(
[sinon.match.object, sinon.match.string, sinon.match(/.+foo.+goo/)]
);
The generated log will look pretty as this: