Skip to content

noopkat/testdouble.js

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code
This branch is 681 commits behind testdouble:main.

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

testdouble.js

Build Status npmjs Test Coverage

Welcome! Are you writing JavaScript tests and in the market for a mocking library to fake out real things for you? testdouble.js is an opinionated, carefully-designed test double library maintained by, oddly enough, a software agency that's also named Test Double.

If you practice test-driven development, testdouble.js was designed to promote terse, clear, and easy-to-understand tests. There's an awful lot to cover, so please take some time and enjoy our documentation, which itself is designed to show you how to make the most out of test doubles in your tests.

The pitch

Interested in learning what testdouble.js is, why it exists, and what the API offers? The quickest path is this fast-paced 20-minute talk:

screenshot of testdouble.js talk

Coming from Sinon.js?

Right now, Sinon.js is the test double incumbent in JavaScript, with over 1.7 million downloads in the last month. If you've got experience with Sinon, check out our side-by-side comparison to see why we wrote testdouble.js and how some of the API translates.

The Very Basics

Before diving into our in-depth docs, here is a quick intro of the basic uses:

Stubbing return values for functions

var td = require('testdouble');

var fetch = td.function();
td.when(fetch(42)).thenReturn('Jane User');

fetch(42); // -> 'Jane User'

Verifying a function was invoked

var td = require('testdouble');

var save = td.function('.save');
save(41, 'Jane');

td.verify(save(41, 'Jill'));
//
// Error: Unsatisfied verification on test double `.save`.
//
//   Wanted:
//     - called with `(41, "Jill")`.
//
//   But was actually called:
//     - called with `(41, "Jane")`.

Docs

All of our docs are in the docs/ directory inside this repository and numbered for easy reading in the priority-order we anticipate people needing them. Here's a rough outline:

  1. Installation
  2. for Node.js
  3. for browsers
  4. initial configuration
  5. Purpose of testdouble.js
  6. in unit tests
  7. in integration tests
  8. Getting started tutorial
  9. Creating test doubles
  10. test double functions with td.function()
  11. test double objects with td.object()
  12. test double constructors with td.constructor()
  13. Stubbing responses
  14. td.when() API
  15. equality argument matching
  16. one-liner stubbings
  17. stubbing sequential return values
  18. argument matchers 1. td.matchers.anything() 2. td.matchers.isA() 3. td.matchers.contains()
    1. matching strings
    2. matching arrays
    3. matching objects 4. td.matchers.argThat() 5. td.matchers.not()
  19. Stubbing callback APIs
  20. Stub exceptions with thenThrow
  21. Stub promises with thenResolve and thenReject
  22. Stub side effects with thenDo
  23. Configuring stubbings 1. ignoreExtraArgs 2. times 3. defer 4. delay
  24. Verifying invocations
  25. td.verify() API
  26. equality argument matching
  27. argument matchers 1. td.matchers.anything() 2. td.matchers.isA() 3. td.matchers.contains()
    1. matching strings
    2. matching arrays
    3. matching objects 4. td.matchers.argThat()
  28. Argument captors
  29. Configuring verifications 1. ignoreExtraArgs 2. times
  30. Replacing dependencies with test doubles
  31. for Node.js
  32. for Browser JS
  33. td.replace() API
  34. Writing custom argument matchers
  35. Debugging with testdouble.js
  36. td.explain() API
  37. Plugins
  38. testdouble-chai
  39. testdouble-jasmine
  40. Frequently Asked Questions
  41. Why doesn't td.replace() work with external CommonJS modules?
  42. Configuration
  43. td.config

About

A minimal test double library for TDD with JavaScript

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 49.3%
  • CoffeeScript 48.1%
  • Shell 1.4%
  • TypeScript 1.2%