Stubbing a Mongoose model with Sinon

node.js mongoose sinon
amandawulf picture amandawulf · Jul 3, 2012 · Viewed 17.1k times · Source

I want to create a stub for the Mongoose save method in a particular model, so that any instance of my model I create will call the stub instead of the normal Mongoose save method. My understanding is that the only way to do this is to stub the entire model like this:

var stub = sinon.stub(myModel.prototype);

Unfortunately, this line of code causes my tests to throw the following error:

TypeError: Cannot read property 'states' of undefined

Does anyone know what is going wrong here?

Answer

Jacob picture Jacob · Jul 19, 2012

There are two ways to accomplish this. The first is

var mongoose = require('mongoose');
var myStub = sinon.stub(mongoose.Model, METHODNAME);

If you console log mongoose.Model you will see the methods available to the model (notably this does not include lte option).

The other (model specific) way is

var myStub = sinon.stub(YOURMODEL.prototype.base.Model, 'METHODNAME');

Again, the same methods are available to stub.

EDIT: Some methods such as save are stubbed as follows:

var myStub = sinon.stub(mongoose.Model.prototype, METHODNAME);
var myStub = sinon.stub(YOURMODEL.prototype, METHODNAME);

Related questions

Mocking/stubbing Mongoose model save method

Given a simple Mongoose model: import mongoose, { Schema } from 'mongoose'; const PostSchema = Schema({ title: { type: String }, postDate: { type: Date, default: Date.now } }, { timestamps: true }); const Post = mongoose.model('Post', PostSchema); export default Post; I wish to test this model, but …

Read More
Using Sinon to stub chained Mongoose calls

I get how to stub Mongoose models (thanks to Stubbing a Mongoose model with Sinon), but I don't quite understand how to stub calls like: myModel.findOne({"id": someId}) .where("someBooleanProperty").equals(true) ... .exec(someCallback); I tried the following: var …

Read More
How do I update/upsert a document in Mongoose?

Perhaps it's the time, perhaps it's me drowning in sparse documentation and not being able to wrap my head around the concept of updating in Mongoose :) Here's the deal: I have a contact schema and model (shortened properties): var mongoose = …

Read More