mm
An simple but flexible mock(or say stub) package, mock mate.
mm@2 only support node v4.0+.
Install
$ npm install mm --save-dev
Usage
var mm = require('mm');
var fs = require('fs');
mm(fs, 'readFileSync', function(filename) {
return filename + ' content';
});
console.log(fs.readFileSync('《九评 Java》'));
mm.restore();
console.log(fs.readFileSync('《九评 Java》'));
Support spy
If mocked property is a function, it will be spied, every time it called, mm will modify .called
, .calledArguments
and .lastCalledArguments
. For example:
const target = {
async add(a, b) {
return a + b;
},
};
mm.data(target, 'add', 3);
(await target.add(1, 1)).should.equal(3);
target.add.called.should.equal(1);
target.add.calledArguments.should.eql([[ 1, 1 ]]);
target.add.lastCalledArguments.should.eql([ 1, 1 ]);
(await target.add(2, 2)).should.equal(3);
target.add.called.should.equal(2);
target.add.calledArguments.should.eql([[ 1, 1 ], [ 2, 2 ]]);
target.add.lastCalledArguments.should.eql([ 2, 2 ]);
});
Support generator function
var foo = {
get: function* () {
return 1;
}
};
mm.data(foo, 'get', 2);
var data = yield* foo.get();
mm.error(foo, 'get', 'error boom');
yield* foo.get();
API
.error(module, propertyName, errerMessage, errorProperties)
var mm = require('mm');
var fs = require('fs');
mm.error(fs, 'readFile', 'mock fs.readFile return error');
fs.readFile('/etc/hosts', 'utf8', function (err, content) {
console.log(err);
mm.restore();
fs.readFile('/etc/hosts', 'utf8', function (err, content) {
console.log(err);
console.log(content);
});
});
.errorOnce(module, propertyName, errerMessage, errorProperties)
Just like mm.error()
, but only mock error once.
const mm = require('mm');
const fs = require('fs');
mm.errorOnce(fs, 'readFile', 'mock fs.readFile return error');
fs.readFile('/etc/hosts', 'utf8', function (err, content) {
console.log(err);
fs.readFile('/etc/hosts', 'utf8', function (err, content) {
console.log(err);
console.log(content);
});
});
.data(module, propertyName, secondCallbackArg)
mm.data(fs, 'readFile', new Buffer('some content'));
fs.readFile = function (...args, callback) {
callback(null, new Buffer('some content'))
};
.empty(module, propertyName)
mm.empty(mysql, 'query');
mysql.query = function (...args, callback) {
callback();
}
.datas(module, propertyName, argsArray)
mm.datas(urllib, 'request', [new Buffer('data'), {headers: { foo: 'bar' }}]);
urllib.request = function (...args, callback) {
callback(null, new Buffer('data'), {headers: { foo: 'bar' }});
}
.syncError(module, propertyName, errerMessage, errorProperties)
var mm = require('mm');
var fs = require('fs');
mm.syncError(fs, 'readFileSync', 'mock fs.readFile return error', {code: 'ENOENT'});
fs.readFileSync = function (...args) {
var err = new Error('mock fs.readFile return error');
err.code = 'ENOENT';
throw err;
};
.syncData(module, propertyName, value)
mm.syncData(fs, 'readFileSync', new Buffer('some content'));
fs.readFileSync = function (...args) {
return new Buffer('some content');
};
.syncEmpty
mm.syncEmpty(fs, 'readFileSync');
fs.readFileSync = function (...args) {
return;
}
.restore()
mm.restore();
.http.request(mockUrl, mockResData, mockResHeaders) and .https.request(mockUrl, mockResData, mockResHeaders)
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.get({
path: '/foo'
}, function (res) {
console.log(res.headers);
var body = '';
res.on('data', function (chunk) {
body += chunk.toString();
});
res.on('end', function () {
console.log(body);
});
});
https.get({
path: '/foo'
}, function (res) {
console.log(res.headers);
var body = '';
res.on('data', function (chunk) {
body += chunk.toString();
});
res.on('end', function () {
console.log(body);
});
});
.http.requestError(mockUrl, reqError, resError) and .https.requestError(mockUrl, reqError, resError)
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);
res.on('end', fucntion () {
console.log('never show this message');
});
});
req.on('error', function (err) {
console.log(err);
});
License
This software is licensed under the MIT License.
Copyright (C) 2012 - 2014 fengmk2 <fengmk2@gmail.com>
Copyright (C) 2015 - present 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.