Sinon.js

Sinon.js
Name	Sinon.js
Developer	Open-source community
Initial release	2010
Programming language	JavaScript
Repository	GitHub
License	BSD-style
Platform	Cross-platform

Sinon.js

Sinon.js is a JavaScript testing utility library that provides stand-alone test spies, stubs, and mocks for unit testing in environments such as Node.js, Mozilla Firefox, Google Chrome, and Microsoft Edge. It is commonly used alongside test frameworks like Mocha (software), Jest (software), and Jasmine (software) as well as assertion libraries such as Chai (software), Expect (JavaScript), and Should.js. Sinon.js helps developers write deterministic tests for applications built with frameworks including React (JavaScript library), Angular (web framework), and Vue.js.

Overview

Sinon.js was created to address challenges in isolating JavaScript code during automated testing on platforms like Node.js and browsers such as Safari (web browser). The project evolved through contributions on GitHub and discussions in communities around events like JSConf and NodeSummit. It emphasizes test isolation for projects using build tools such as Webpack, Rollup (software), and Browserify and integrates into continuous integration pipelines using systems like Jenkins, Travis CI, and GitHub Actions.

Features

Sinon.js exposes features that support unit testing across ecosystems including ECMAScript 2015 environments and legacy engines like Internet Explorer. Key capabilities include: - Spies that record function calls and work with frameworks such as Mocha (software), QUnit, and Karma (test runner). - Stubs for replacing behaviors in modules used by libraries like Lodash, Underscore.js, and Axios (software). - Mocks that assert interactions for codebases using Express (web framework), Koa (web framework), or Hapi (software). - Fake timers that simulate time for components built on setTimeout, setInterval, and APIs used in Electron (software framework). - Fake servers and XHR utilities compatible with adapters employed by jQuery, Fetch API, and SuperAgent.

Usage

Typical use patterns demonstrate Sinon.js alongside popular tools such as Mocha (software), Chai (software), and Sinon-Chai in projects managed with npm (software), Yarn (package manager), or pnpm. Example workflows include: - Isolating an asynchronous helper used in a React (JavaScript library) component test driven by Enzyme (testing utility) or React Testing Library. - Replacing HTTP calls in a Node.js microservice built with Express (web framework) when running tests under CircleCI or GitLab CI. - Controlling timers in a Vue.js animation module tested with Karma (test runner) and reported via Istanbul (code coverage).

API

The Sinon.js API provides methods and objects referenced in documentation and community guides across sites like GitHub and blog posts from authors connected to Mozilla Foundation and OpenJS Foundation. Core API elements include: - sinon.spy for observing invocations in modules like Bluebird (library) or Q (library). - sinon.stub for replacing function implementations used by adapters such as Axios (software) or SuperAgent. - sinon.mock for setting expectations in services built on Express (web framework) or Hapi (software). - sinon.useFakeTimers for manipulating clock behavior in environments including Electron (software framework) and Chrome DevTools. - sinon.fakeServer or fake XHR to simulate backend responses often implemented with RESTful APIs provided by platforms like Heroku or AWS Lambda.

Integration and Compatibility

Sinon.js integrates with ecosystems and tooling from organizations such as the OpenJS Foundation and is compatible with package registries like npm (software) and Yarn (package manager). It is used in combination with bundlers such as Webpack, Parcel (software), and Rollup (software), and CI providers including Travis CI, CircleCI, and GitHub Actions. Browser compatibility extends to engines maintained by organizations behind Blink (browser engine), Gecko (layout engine), and legacy Trident (layout engine) contexts. Language features from ECMAScript 2015 onward are supported when transpiled with tools such as Babel (software).

Development and Contribution

Sinon.js is developed in public on GitHub with contributions coordinated via issues and pull requests, and maintainers often follow governance patterns similar to projects in the OpenJS Foundation. Contributors work across environments including Node.js, browser vendors like Google LLC and Mozilla Corporation, and continuous integration providers such as Jenkins and Travis CI. Roadmaps and changelogs are discussed in repositories and at community gatherings including JSConf and local meetup chapters, while code quality leverages linters like ESLint and test coverage tools such as Istanbul (code coverage).

Category:JavaScript libraries