jest-mock vs sinon vs testdouble
JavaScript Mocking Libraries Comparison
1 Year
jest-mocksinontestdoubleSimilar Packages:
What's JavaScript Mocking Libraries?

Mocking libraries in JavaScript are essential tools for testing, allowing developers to create simulated versions of functions, objects, or modules. These libraries help isolate the code being tested by replacing dependencies with mock implementations, ensuring that tests are focused and reliable. They enable developers to control the behavior of dependencies, assert interactions, and verify that the code behaves as expected under various scenarios. By using mocking libraries, developers can write unit tests that are faster, easier to maintain, and less prone to flakiness caused by external factors.

Package Weekly Downloads Trend
Github Stars Ranking
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
jest-mock32,995,22044,57147.5 kB337a year agoMIT
sinon6,723,4449,6995.41 MB406 months agoBSD-3-Clause
testdouble220,6931,422465 kB33a year agoMIT
Feature Comparison: jest-mock vs sinon vs testdouble

Integration

  • jest-mock:

    Jest Mock is tightly integrated with the Jest testing framework, allowing for seamless usage of mocks within Jest's test environment. This integration provides a cohesive experience, enabling features like snapshot testing and parallel test execution without additional configuration.

  • sinon:

    Sinon is a standalone library that can be used with any testing framework, such as Mocha, Jasmine, or QUnit. This flexibility allows developers to choose their preferred testing tools while still benefiting from Sinon’s powerful mocking capabilities.

  • testdouble:

    Testdouble is also framework-agnostic, designed to work with various testing frameworks. Its API is built to be intuitive, allowing for easy integration with existing test suites without requiring significant changes.

API Design

  • jest-mock:

    Jest Mock offers a straightforward API that is easy to use, especially for developers already familiar with Jest. It provides built-in functions like jest.fn() for creating mocks and jest.spyOn() for spying on existing functions, making it simple to set up and use mocks in tests.

  • sinon:

    Sinon provides a rich and flexible API for creating mocks, stubs, and spies. It allows for detailed control over the behavior of mocks, including argument matching and call tracking. This flexibility can lead to more complex setups but offers powerful capabilities for intricate testing scenarios.

  • testdouble:

    Testdouble emphasizes a clean and expressive API, focusing on readability and simplicity. Its design encourages developers to write tests that are easy to understand, reducing the cognitive load when reading test code.

Flexibility

  • jest-mock:

    Jest Mock is designed to work well within the Jest ecosystem, which may limit its use outside of Jest. However, it provides sufficient flexibility for most testing needs within that context, making it a great choice for Jest users.

  • sinon:

    Sinon offers high flexibility, allowing developers to create mocks and stubs with various configurations. It supports a wide range of use cases, from simple mocks to complex behavior simulations, making it suitable for diverse testing requirements.

  • testdouble:

    Testdouble provides flexibility in how mocks and stubs are defined and used, allowing for a variety of testing styles. Its focus on expressiveness means developers can create clear and concise tests without unnecessary complexity.

Community and Ecosystem

  • jest-mock:

    Jest Mock benefits from the large and active Jest community, which provides extensive documentation, tutorials, and plugins. This strong ecosystem supports developers in adopting and mastering Jest and its mocking capabilities.

  • sinon:

    Sinon has a long-standing presence in the JavaScript testing community, with a wealth of resources and examples available. Its established reputation makes it a reliable choice for developers looking for proven mocking solutions.

  • testdouble:

    Testdouble, while newer, has gained traction for its innovative approach to mocking. It has a growing community and offers clear documentation, making it accessible for developers looking to adopt its features.

Learning Curve

  • jest-mock:

    Jest Mock is relatively easy to learn, especially for those already familiar with Jest. Its intuitive API and extensive documentation make it accessible for new users, allowing them to quickly implement mocking in their tests.

  • sinon:

    Sinon has a moderate learning curve due to its rich feature set and flexibility. While it offers powerful capabilities, new users may need time to understand its various functions and how to best utilize them in their tests.

  • testdouble:

    Testdouble is designed with simplicity in mind, making it easy to learn and use. Its clear and expressive API helps developers quickly grasp how to create mocks and stubs, reducing the time needed to become proficient.

How to Choose: jest-mock vs sinon vs testdouble
  • jest-mock:

    Choose Jest Mock if you are already using Jest as your testing framework. It integrates seamlessly with Jest's testing utilities, providing a simple and powerful API for creating mocks and spies. Jest Mock is particularly beneficial for projects that require a comprehensive testing solution with built-in mocking capabilities.

  • sinon:

    Choose Sinon if you need a standalone library that offers flexible and powerful mocking, stubbing, and spying features. Sinon is framework-agnostic, making it suitable for various testing frameworks. It provides a rich set of features for controlling and asserting behavior, making it ideal for complex testing scenarios.

  • testdouble:

    Choose Testdouble if you prefer a more expressive and fluent API for creating mocks and stubs. Testdouble emphasizes simplicity and readability, making it easier to write and understand tests. It is a good choice for developers who value clarity in their test code and want to avoid boilerplate.

README for jest-mock

jest-mock

Note: More details on user side API can be found in Jest documentation.

API

import {ModuleMocker} from 'jest-mock';

constructor(global)

Creates a new module mocker that generates mocks as if they were created in an environment with the given global object.

generateFromMetadata(metadata)

Generates a mock based on the given metadata (Metadata for the mock in the schema returned by the getMetadata() method of this module). Mocks treat functions specially, and all mock functions have additional members, described in the documentation for fn() in this module.

One important note: function prototypes are handled specially by this mocking framework. For functions with prototypes, when called as a constructor, the mock will install mocked function members on the instance. This allows different instances of the same constructor to have different values for its mocks member and its return values.

getMetadata(component)

Inspects the argument and returns its schema in the following recursive format:

{
  type: ...
  members: {}
}

Where type is one of array, object, function, or ref, and members is an optional dictionary where the keys are member names and the values are metadata objects. Function prototypes are defined by defining metadata for the member.prototype of the function. The type of a function prototype should always be object. For instance, a class might be defined like this:

const classDef = {
  type: 'function',
  members: {
    staticMethod: {type: 'function'},
    prototype: {
      type: 'object',
      members: {
        instanceMethod: {type: 'function'},
      },
    },
  },
};

Metadata may also contain references to other objects defined within the same metadata object. The metadata for the referent must be marked with refID key and an arbitrary value. The referrer must be marked with a ref key that has the same value as object with refID that it refers to. For instance, this metadata blob:

const refID = {
  type: 'object',
  refID: 1,
  members: {
    self: {ref: 1},
  },
};

Defines an object with a slot named self that refers back to the object.

fn(implementation?)

Generates a stand-alone function with members that help drive unit tests or confirm expectations. Specifically, functions returned by this method have the following members:

.mock

An object with three members, calls, instances and invocationCallOrder, which are all lists. The items in the calls list are the arguments with which the function was called. The "instances" list stores the value of 'this' for each call to the function. This is useful for retrieving instances from a constructor. The invocationCallOrder lists the order in which the mock was called in relation to all mock calls, starting at 1.

.mockReturnValueOnce(value)

Pushes the given value onto a FIFO queue of return values for the function.

.mockReturnValue(value)

Sets the default return value for the function.

.mockImplementationOnce(function)

Pushes the given mock implementation onto a FIFO queue of mock implementations for the function.

.mockImplementation(function)

Sets the default mock implementation for the function.

.mockReturnThis()

Syntactic sugar for:

mockFn.mockImplementation(function () {
  return this;
});

In case both .mockImplementationOnce() / .mockImplementation() and .mockReturnValueOnce() / .mockReturnValue() are called. The priority of which to use is based on what is the last call:

  • if the last call is .mockReturnValueOnce() or .mockReturnValue(), use the specific return value or default return value. If specific return values are used up or no default return value is set, fall back to try .mockImplementation();
  • if the last call is .mockImplementationOnce() or .mockImplementation(), run the specific implementation and return the result or run default implementation and return the result.
.withImplementation(function, callback)

Temporarily overrides the default mock implementation within the callback, then restores it's previous implementation.

If the callback is async or returns a thenable, withImplementation will return a promise. Awaiting the promise will await the callback and reset the implementation.