Versatile Dynamic Mocking for NodeJS
Versatile Dynamic Mocking for Node.JS
SuperMock is a very powerful, lightweight, versatile, buzzword, buzzword, mocking library for NodeJS. Influenced by Python's Mock, SuperMock allows you to write mocks with as little setup code as possible.
npm install supermock
SuperMock requires harmony-proxies to be enabled
var SuperMock = require'supermock'SuperMockassert = require'assert';//myMock is a function, but also an objectvar myMock = ;myMock'foo' 'bar';//SuperMock keeps track of how many times it has been calledmyMockassertCallCount1;//it also keeps track of what it was called withmyMockassertCalledWith'foo' 'bar';//special object SuperMock.Anything can be used as a placeholder to match//any argument SuperMock has been called withmyMock'foo' 'baz';myMockassertCalledWith'foo' SuperMockAnything 'baz';//this is useful to assert event handlers have been registered, since//normally there's no way to know what the callback wasmyMock'on-biriri' console.log'bururu'; ;myMockassertCalledWith'on-biriri' SuperMockAnything;//special object SuperMock.Etc can be used as a placeholder to match//any number of arguments at the end of the callmyMock1 2 3 4 5;myMockassertCalledWith1 2 SuperMockEtc;//SuperMock will return a new SuperMock object for everythingmyMockfoobarbazsomething = 42;assertequalmyMockfoobarbazsomething 42;myMockfoobarbazfunc;myMockfoobarbazfuncassertCallCount1;//unless you specify itvar myMock = returnValue:'42' foo:'bar';assertequalmyMock 42;assertequalmyMockfoo 'bar';//Supermock can also throw errorsvar myMock = throws: 'i haz a boo boo' ;assertthrowsmyMock Error;//You can also get the information without having to assertmyMockgetCallCount => 1myMockgetCalledWith =>//you can also access the returnValuevar myMock = ;myMock'123''456''789';myMockassertCalledWith'123';myMockreturnValueassertCalledWith'456';myMockreturnValuereturnValueassertCalledWith'789';//you can also use callbacksvar myMock = callback: null success:true ;myMockassertequalerror null;assertdeepEqualmessage success:true ;;//also, don't forget to name your SuperMocks, They chain as well!var myMock = mockName: 'myMock' ;assertequalmyMockfoobarbazquxgetName 'myMock.foo.bar().baz.qux()';
SuperMock comes with a convenient way to patch you objects, with patch, mocking becomes easier
patch uses dot
. notation to patch objects, starting with the module name:
var patch = require('supermock').patch,restore = require('supermock').restore;//This needs to run right before your test//The first argument is what to patch the second is the mock, which defaults to a new SuperMockmock = patch('events.EventEmitter.prototype.on');//do something with the mocked class or methodvar EventEmitter = require('events').EventEmitter,myEmitter = new EventEmitter();myEmitter.on('error', console.log);//run SuperMock assertionsmyEmitter.on.assertCallCount(1);//Restore it back to its original staterestore('events.EventEmitter.prototype.on');//You can patch full modules too!mock = patch('events');var EventEmitter = require('events').EventEmitter,myEmitter = new EventEmitter();myEmitter.on('error', console.log);myEmitter.on.assertCallCount(1);//Restore it back to its original staterestore('events');
(The MIT License)
Copyright (c) 2012 Russell Bradberry <email@example.com>
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.