# mockgoose > Mockgoose is an in memory database mock to allow for testing of applications that rely on Mongoose. Latest version **8.0.4** (published 2019-10-29) · MIT license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install mockgoose pnpm add mockgoose yarn add mockgoose bun add mockgoose ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 8.0.4 | | Published | 2019-10-29 | | First published | 2013-05-12 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=6 | | Dependencies | 8 | | Unpacked size | 100.9 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 258 | | Author | Anthony McCormick | | Maintainers | mccormicka, winfinit | | Keywords | mongodb, mongoose, datastore, nosql, sql, db, database, mock, stub, in memory | ## Links - npm: https://www.npmjs.com/package/mockgoose - Repository: https://github.com/Mockgoose/Mockgoose - Issues: https://github.com/Mockgoose/Mockgoose/issues - npm.io page: https://npm.io/package/mockgoose ## Dependencies (8) - [uuid](https://npm.io/package/uuid.md) ^3.0.1 - [async](https://npm.io/package/async.md) ^2.6.1 - [debug](https://npm.io/package/debug.md) ^4.0.1 - [rimraf](https://npm.io/package/rimraf.md) ^2.6.1 - [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.0 - [portfinder](https://npm.io/package/portfinder.md) ^1.0.13 - [mongodb-prebuilt](https://npm.io/package/mongodb-prebuilt.md) ^6.4.0 - [https-proxy-agent](https://npm.io/package/https-proxy-agent.md) ^2.2.1 ## Alternatives - [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads - [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads - [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads - [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads - [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads ## Recent versions - 8.0.4 (latest) — 2019-10-29 - 8.0.3 — 2019-09-28 - 8.0.2 — 2019-05-20 - 8.0.1 — 2019-01-13 - 7.3.5 — 2018-01-29 - 7.3.4 — 2018-01-25 - 7.3.3 — 2017-06-06 - 7.3.2 — 2017-06-06 - 7.3.1 — 2017-04-20 - 7.3.0 — 2017-04-19 - 7.2.0 — 2017-04-19 - 7.1.2 — 2017-04-18 - 7.1.1 — 2017-04-03 - 7.1.0 — 2017-04-01 - 7.0.7 — 2017-03-22 - … 118 more at https://npm.io/package/mockgoose/versions ## README ## Warning: This package has been deprecated! Consider using mongodb-memory-server instead. [![Build Status](https://travis-ci.org/Mockgoose/Mockgoose.svg?branch=master)](https://travis-ci.org/Mockgoose/Mockgoose) Please Share on Twitter if you like #mockgoose ## 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: ```bash npm install mockgoose --save-dev ``` ## Usage You simply require Mongoose and Mockgoose and wrap Mongoose with Mockgoose. ```javascript var mongoose = require('mongoose'); var Mockgoose = require('mockgoose').Mockgoose; var mockgoose = new Mockgoose(mongoose); mockgoose.prepareStorage().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 Default mocha timeout is 2000ms, change it to two minutes. ```bash mocha --timeout 120000 ``` Same can be done by creating 'mocha.opts' file in your test directory with "--timeout 120000" entry. ### Example ```javascript var Mongoose = require('mongoose').Mongoose; var mongoose = new Mongoose(); var Mockgoose = require('mockgoose').Mockgoose; var mockgoose = new Mockgoose(mongoose); before(function(done) { mockgoose.prepareStorage().then(function() { mongoose.connect('mongodb://example.com/TestingDB', function(err) { done(err); }); }); }); describe('...', function() { it("...", function(done) { // ... done(); }); }); ``` ## ES6 Example without mocha ```javascript import * as mongoose from 'mongoose'; import {Mockgoose} from 'mockgoose'; let mockgoose: Mockgoose = new Mockgoose(mongoose); mockgoose.prepareStorage().then(() => { mongoose.connect('mongodb://foobar/baz'); mongoose.connection.on('connected', () => { console.log('db connection is now open'); }); }); ``` ## Helper methods and variables (mockgoose.helper) ### 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.helper.reset().then(() => { done() }); ``` ### isMocked Returns **TRUE** from **mongoose** object if Mockgoose is applied ```javascript if ( mockgoose.helper.isMocked() === true ) { // mongoose object is mocked } ``` ### setDbVersion(mongoDBVersion: string) Set version of MongoDB release ```javascript import * as mongoose from 'mongoose'; import {Mockgoose} from 'mockgoose'; let mockgoose: Mockgoose = new Mockgoose(mongoose); mockgoose.helper.setDbVersion("3.2.1"); mockgoose.prepareStorage().then(() => { mongoose.connect('mongodb://foobar/baz'); mongoose.connection.on('connected', () => { console.log('db connection is now open'); }); }); ``` ### setProxy(proxy: string) Set proxy for downloading MongoDB release ```javascript import * as mongoose from 'mongoose'; import {Mockgoose} from 'mockgoose'; let mockgoose: Mockgoose = new Mockgoose(mongoose); let proxy: string = process.env.http_proxy || 'http://example.com:8080'; mockgoose.helper.setProxy(proxy); mockgoose.prepareStorage().then(() => { mongoose.connect('mongodb://foobar/baz'); mongoose.connection.on('connected', () => { console.log('db connection is now open'); }); }); ``` ## 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 >= 6 ### Setup ```bash git clone git@github.com:Mockgoose/Mockgoose.git cd Mockgoose npm install npm test ``` --- _Source: https://npm.io/package/mockgoose · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._