Unexpected-sinon
This module extends the
Unexpected assertion
library with integration for the Sinonjs
mocking library.
Usage
Here is an example stolen from
Gary Bernhardt.
function SucksRocks(searchEngine) {
this.forTerm = function (term) {
return Promise.all([
searchEngine.countResults(term + " rocks"),
searchEngine.countResults(term + " sucks")
]).then(function (results) {
var positive = results[0];
var negative = results[1];
return positive > negative ? 'Rocks!' : 'Sucks!';
});
};
}
var searchEngine = {
countResults: sinon.stub()
};
searchEngine.countResults
.onFirstCall().returns(Promise.resolve(6920000))
.onSecondCall().returns(Promise.resolve(3400000));
var result = new SucksRocks(searchEngine).forTerm('Open source');
expect(searchEngine.countResults, 'to have calls satisfying', function () {
searchEngine.countResults('Open source rocks');
searchEngine.countResults('Open source sucks');
});
return expect(result, 'when fulfilled', 'to equal', 'Rocks!');
Amazing output when a failure happens!
var searchEngine = {
countResults: sinon.stub().named('myStub')
};
searchEngine.countResults
.onFirstCall().returns(Promise.resolve(6920000))
.onSecondCall().returns(Promise.resolve(3400000));
var score = new SucksRocks(searchEngine).forTerm('Open source');
expect(searchEngine.countResults, 'to have calls satisfying', function () {
searchEngine.countResults('Open source rocks!');
searchEngine.countResults('Open source sucks!');
});
expected myStub to have calls satisfying
myStub( 'Open source rocks!' );
myStub( 'Open source sucks!' );
myStub(
'Open source rocks'
Open source rocks
Open source rocks!
); at theFunction (theFileName:xx:yy)
myStub(
'Open source sucks'
Open source sucks
Open source sucks!
); at theFunction (theFileName:xx:yy)
Setup
Node
Install it with NPM or add it to your package.json:
$ npm install --save-dev unexpected unexpected-sinon
Then:
var expect = require('unexpected').clone();
expect.use(require('unexpected-sinon'));
Browser
Include the unexpected-sinon.js found at the lib directory of this
repository.
<script src="sinon.js"></script>
<script src="unexpected.js"></script>
<script src="unexpected-sinon.js"></script>
this will expose the expect function under the following namespace:
var expect = weknowhow.expect.clone();
expect.use(weknowhow.unexpectedSinon);
RequireJS
Include the library with RequireJS the following way:
require(['unexpected', 'unexpected-sinon', 'sinon'], function (unexpected, unexpectedSinon, sinon) {
var expect = unexpected.clone();
expect.use(unexpectedSinon);
// Your code
});
Source
The source for Unexpected can be found on
Github.
Release
6.0.0
- Introduced
to satisfy
samantics for
was called with
and
threw. Notice
that matching on types by providing the type name no longer works,
now it matches on the error message like
to throw.
- Improved the output for failing assertions a lot.
MIT License
Copyright (c) 2013 Sune Simonsen sune@we-knowhow.dk
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
