Code Monkey home page Code Monkey logo

node-mock-fun's Introduction

node-mock-fun Build Status Coverage Status

Mock functions

Install

npm install mock-fun

Usage

Use with mocha :3

.override(obj, prop[, glob])

Without glob function:

Returns a hook(fun) function, that can override prop in obj with a wrapper function that calls fun transparently (keeping context&parameters). The wrapper function manages the called and calledTimes property. fun defaults to noop.

With glob:

Returns a hook function that overrides prop in obj with a wrapper function that calls glob transparently. Same as above. You should use this as a before/beforeEach hook.

.restore(obj, prop[, full])

Returns a hook function that restores the original function. You should use it as an after/afterEach hook.

Set full to restore nested overrides.

Example

var override = require('mock-fun').override;
var restore = require('mock-fun').restore;

// Override per `it`
describe('My library method `fun`', function() {
  var o = override(mylib, 'otherFun');
  afterEach(restore(mylib, 'otherFun'));
  it('should call `otherFun`', function() {
    o(); // default override function is noop
    mylib.fun();
    mylib.otherFun.called.should.be.true;
  });
  it('should call `otherFun` with correct parameter', function() {
    o(function(a) {
      a.should.equal('foobar');
    });
    mylib.fun();
  });
  it('should call `otherFun` with the context of `mylib`', function() {
    o(function() {
      this.should.equal(mylib);
    });
    mylib.fun();
  });
});

// Override per `describe`
describe('My library method `fun`', function() {
  before(override(mylib, 'findById', function(id, cb) {
    cb(null, new User({ foo: 'bar' }));
  }));
  after(restore(mylib, 'findById'));
  it('should query for a user', function() {
    mylib.fun(1337, function(err, user) {
      user.foo.should.equal('bar');
    });
  });
});

License

MIT

node-mock-fun's People

Contributors

madbence avatar

Watchers

 avatar  avatar  avatar

node-mock-fun's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.