sinon

What is sinon?

Sinon is a testing utility that provides functions for spies, stubs, and mocks, which are essential for behavior-driven development and testing in JavaScript. It works with any unit testing framework and is widely used for its versatile API and comprehensive feature set.

What are sinon's main functionalities?

Spies

Spies are functions that record their usage, such as how many times they were called, with what arguments, and what was returned. They can be used to wrap existing functions to add this tracking ability.

const sinon = require('sinon');
const myFunction = sinon.spy();
myFunction('Hello', 'World');
console.log(myFunction.calledOnce); // true

Stubs

Stubs are like spies, but they can replace the target function's behavior, either by returning a specific value or by throwing an exception. They are useful for controlling a function's behavior in a test.

const sinon = require('sinon');
const myObj = { myMethod: () => 'original' };
const stub = sinon.stub(myObj, 'myMethod').returns('stubbed');
console.log(myObj.myMethod()); // 'stubbed'

Mocks

Mocks are fake methods (like stubs) with pre-programmed behavior and expectations. They are used to assert that certain methods are called in certain ways.

const sinon = require('sinon');
const myObj = { myMethod: () => 'original' };
const mock = sinon.mock(myObj);
mock.expects('myMethod').once().returns('mocked');
console.log(myObj.myMethod()); // 'mocked'
mock.verify();

Other packages similar to sinon

jest

Jest is a complete testing framework that comes with spies, mocks, and stubs built-in. It is often compared to Sinon for its mocking capabilities, but Jest provides a more integrated experience with a test runner and assertion library included.

testdouble

Testdouble.js (npm package 'testdouble') is a minimalistic testing library that provides a similar API to Sinon for creating test doubles like stubs, mocks, and spies. It focuses on providing a more user-friendly experience with better error messages and simpler APIs.

chai-spies

Chai-spies is a plugin for the Chai assertion library that adds spy capabilities. While it doesn't offer as comprehensive a set of features as Sinon, it integrates well with Chai for developers who prefer that assertion style.

README

Sinon.JS

Standalone and test framework agnostic JavaScript test spies, stubs and mocks (pronounced "sigh-non").

Installation

via npm (node package manager)

$ npm install sinon

or via sinon's browser builds available for download on the homepage.

Usage

See the sinon project homepage for documentation on usage.

If you have questions that are not covered by the documentation, please post them to the Sinon.JS mailing list or drop by #sinon.js on irc.freenode.net:6667 or the Gitter channel.

Important: Sinon v1.x does not work with AMD/CommonJS Bundlers!

Sinon.JS v1.x as source doesn't work with AMD loaders / RequireJS / Webpack / Browserify. For that you will have to use a pre-built version. You can either build it yourself or get a numbered version from http://sinonjs.org.

This has been resolved in Sinon v2.x; Please don't report this as a bug.

Goals

• No global pollution
• Easy to use
• Require minimal “integration”
• Easy to embed seamlessly with any testing framework
• Easily fake any interface
• Ship with ready-to-use fakes for XMLHttpRequest, timers and more

Contribute?

See CONTRIBUTING.md for details on how you can contribute to Sinon.JS

##Licence

Sinon.js was released under BSD-3

Changelog

v2.0.0-pre.5

• 2.0.0-pre.5
• Update Changelog.txt and AUTHORS for new release
• Update changelog for pre.4
• Remove polyfill for Promise
• Remove old, unused, ci script for BusterJS
• Abort pre-commit script when no files are changed
• Check for required arguments
• Make SED in-place update switch work on BSD
• Upgrade text-encoding to the latest version
• Improve rendering of sandbox.create(config) example
• Remove sinon.test from sandbox documentation
• Use baseurl to render links correctly on github pages
• Specify same version of github-pages as github
• Remove release_id from front matter
• Update Gemfile.lock to use latest supported Jekyll
• Fix #614: Add missing documentation for sandbox methods
• Add missing documentation for stubs
• Fix #1026: stub watch method on object
• Fix invalid test for "does not walk the same property twice"
• Add test for issue #1026
• Fix 810 - Added documentation for sinon.restore()
• Add docs for new array matchers
• Array contains matcher fails when actual is not an array
• Array endsWith matcher fails when actual is not an array
• Array startsWith matcher fails when actual is not an array
• Array deepEquals matcher fails when actual is not an array
• Add .resolves and .rejects to stub (#1211)
• Accept routing DSLs on fake server
• Convert remaining calledWith methods to use diff color formatting
• Color diffs for sinon matchers
• Print diffs for multiple spy calls
• Add new spy output formatter for handling diffs
• Add contains array matcher
• Add endsWith array matcher
• Add startsWith array matcher
• Add deepEquals array matcher
• Add more array matchers
• Extract deprecated.printWarning
• Move empty stub creation to avoid unnecessary stub.create
• Fix typo on property name called 'matchingAguments'
• Soften migration path with deprecation warning
• Update docs and migration guide
• Convert 3 arg stub to callsFake
• Update format docs to refer to formatio
• Fix being able to spy Error
• Prepare documentation using site in GitHub Pages
• Add link to LICENSE in README.md
• Add documentation for accessor method support for stubs and spies
• Previous expectation failures are checked and re-thrown again in mock.verify()
• Expose XHR.setStatus to simplify asynchronous answers
• Fix typo
• Add a how-to article about using links seams for CommonJS modules
• stub() will fail if passed an empty property descriptor
• Rename func argument to funcOrDescriptor
• Add documentation for sinon.assert.match
• XHR: test for readystatechange not dispatching after .abort() in DONE state
• XHR: fix readystatechange event after .abort() in DONE state
• Add tests for xhr.readyState after abort()
• Test that demonstrates that a mock can be called more times than expected without failing (if the exception is silenced).