mm

mock mate, mock http request, fs access and so on.

mm

An simple but flexible mock(or say stub) package, mock mate.

$ npm install mm --save-dev
var mm = require('mm');
var fs = require('fs');
 
mm(fs, 'readFileSync', function (filename) {
  return filename + ' content';
});
 
console.log(fs.readFileSync('《九评 Java》'));
// => 《九评 Java》 content 
 
mm.restore();
 
console.log(fs.readFileSync('《九评 Java》'));
// => throw `Error: ENOENT, no such file or directory '《九评 Java》` 
var foo = {
  getfunction* () {
    return 1;
  }
};
 
mm.data(foo, 'get', 2);
var data = yield* foo.get(); // data should return 2 
 
mm.error(foo, 'get', 'error boom');
yield* foo.get(); // should throw error 
var mm = require('mm');
var fs = require('fs');
 
mm.error(fs, 'readFile', 'mock fs.readFile return error');
 
fs.readFile('/etc/hosts', 'utf8', function (errcontent) {
  // err.name === 'MockError' 
  // err.message === 'mock fs.readFile return error' 
  console.log(err);
 
  mm.restore(); // remove all mock effects. 
 
  fs.readFile('/etc/hosts', 'utf8', function (errcontent) {
    console.log(err); // => null 
    console.log(content); // => your hosts 
  });
});
mm.data(fs, 'readFile', new Buffer('some content'));
 
// equals 
 
fs.readFile = function (args...callback) {
  callback(null, new Buffer('some content'))
};
mm.empty(mysql, 'query');
 
// equals 
 
mysql.query = function (args...callback) {
  callback();
}
mm.datas(urllib, 'request', [new Buffer('data'), {headers: { foo: 'bar' }}]);
 
// equals 
 
urllib.request = function (args...callback) {
  callback(null, new Buffer('data'), {headers: { foo: 'bar' }});
}
var mm = require('mm');
var fs = require('fs');
 
mm.syncError(fs, 'readFileSync', 'mock fs.readFile return error', {code: 'ENOENT'});
 
// equals 
 
fs.readFileSync = function (args...) {
  var err = new Error('mock fs.readFile return error');
  err.code = 'ENOENT';
  throw err;
};
 
mm.syncData(fs, 'readFileSync', new Buffer('some content'));
 
// equals 
 
fs.readFileSync = function (args...) {
  return new Buffer('some content');
};
mm.syncEmpty(fs, 'readFileSync');
 
// equals 
 
fs.readFileSync = function (args...) {
  return;
}
// restore all mock properties 
mm.restore();
var mm = require('mm');
var http = require('http');
 
var mockURL = '/foo';
var mockResData = 'mock data';
var mockResHeaders = { server: 'mock server' };
mm.http.request(mockURL, mockResData, mockResHeaders);
mm.https.request(mockURL, mockResData, mockResHeaders);
 
// http 
http.get({
  path: '/foo'
}, function (res) {
  console.log(res.headers); // should be mock headers 
  var body = '';
  res.on('data', function (chunk) {
    body += chunk.toString();
  });
  res.on('end', function () {
    console.log(body); // should equal 'mock data' 
  });
});
 
// https 
https.get({
  path: '/foo'
}, function (res) {
  console.log(res.headers); // should be mock headers 
  var body = '';
  res.on('data', function (chunk) {
    body += chunk.toString();
  });
  res.on('end', function () {
    console.log(body); // should equal 'mock data' 
  });
});
var mm = require('mm');
var http = require('http');
 
var mockURL = '/foo';
var reqError = null;
var resError = 'mock res error';
mm.http.requestError(mockURL, reqError, resError);
 
var req = http.get({
  path: '/foo'
}, function (res) {
  console.log(res.statusCode, res.headers); // 200 but never emit `end` event 
  res.on('end', fucntion () {
    console.log('never show this message');
  });
});
req.on('error', function (err) {
  console.log(err); // should return mock err: err.name === 'MockHttpResponseError' 
}

This software is licensed under the MIT License.

Copyright (C) 2012 - 2014 fengmk2 fengmk2@gmail.com Copyright (C) 2015 node-modules

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.