-
Notifications
You must be signed in to change notification settings - Fork 83
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
1 addition
and
101 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,101 +1 @@ | ||
| [](https://travis-ci.org/mccormicka/Mockgoose) | ||
|
|
||
| Please Share on Twitter if you like #mockgoose | ||
| <a href="https://twitter.com/intent/tweet?hashtags=mockgoose&&text=Check%20out%20this%20%23Mongoose%20%23MongoDB%20Mocking%20Framework&tw_p=tweetbutton&url=http%3A%2F%2Fbit.ly%2F19gcHwm&via=omnipitence" style="float:right"> | ||
| <img src="https://raw.github.com/mccormicka/Mockgoose/master/twittershare.png"> | ||
| </a> | ||
|
|
||
| ## What is Mockgoose? | ||
|
|
||
| Mockgoose provides test database by spinning up mongod on the back when mongoose.connect call is made. By default it is using in memory store which does not have persistence. | ||
|
|
||
| ## Install | ||
| To install the latest official version, use NPM: | ||
|
|
||
| npm install mockgoose --save-dev | ||
|
|
||
|
|
||
| ## Usage | ||
| You simply require Mongoose and Mockgoose and wrap Mongoose with Mockgoose. | ||
|
|
||
| var mongoose = require('mongoose'); | ||
| var mockgoose = require('mockgoose'); | ||
|
|
||
| mockgoose(mongoose).then(function() { | ||
| // mongoose connection | ||
| }); | ||
|
|
||
| Once Mongoose has been wrapped by Mockgoose connect() will be intercepted by Mockgoose so that no MongoDB instance is created. | ||
|
|
||
| ## Mocha | ||
|
|
||
| ```javascript | ||
| var Mongoose = require('mongoose').Mongoose; | ||
| var mongoose = new Mongoose(); | ||
|
|
||
| var mockgoose = require('mockgoose'); | ||
|
|
||
| before(function(done) { | ||
| mockgoose(mongoose).then(function() { | ||
| mongoose.connect('mongodb://example.com/TestingDB', function(err) { | ||
| done(err); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('...', function() { | ||
| it("...", function(done) { | ||
| // ... | ||
| done(); | ||
| }); | ||
| }); | ||
| ``` | ||
|
|
||
| ## Helper methods and variables | ||
|
|
||
| ### reset(callback) | ||
| Reset method will remove **ALL** of the collections from a temporary store, | ||
| note that this method is part of **mockgoose** object, and not defined under | ||
| **mongoose** | ||
|
|
||
| ```javascript | ||
| mockgoose.reset(function() { | ||
| done() | ||
| }); | ||
| ``` | ||
|
|
||
| ### isMocked | ||
| Returns **TRUE** from **mongoose** object if Mockgoose is applied | ||
|
|
||
| ```javascript | ||
| if ( mongoose.isMocked === true ) { | ||
| // mongoose object is mocked | ||
| } | ||
| ``` | ||
|
|
||
| ## unmock(callback) | ||
| Method that can be applied on **mongoose** to remove modifications added | ||
| by **mockgoose**, it will perform disconnect on temporary store that was | ||
| created, and **will not reconnect** | ||
|
|
||
| ## unmockAndReconnect(callback) | ||
| Same as **unmock**, however it will reconnect to original URI that was | ||
| passed during **connect** | ||
|
|
||
| ## Development | ||
|
|
||
| This section contains instructions for developers working on the Mockgoose codebase. | ||
| It is not relevant if you just want to use Mockgoose as a library in your project. | ||
|
|
||
| ### Pre-requisites | ||
|
|
||
| * Node.js >= 0.10.0 | ||
|
|
||
| ### Setup | ||
|
|
||
| ``` | ||
| git clone git@github.com:mccormicka/Mockgoose.git | ||
| cd Mockgoose | ||
| npm install | ||
| npm test | ||
| ``` | ||
| ## Project was moved to https://github.com/mockgoose/mockgoose |