cursor_test.js

var mongodb = process.env['TEST_NATIVE'] != null ? require('../lib/mongodb').native() : require('../lib/mongodb').pure();
var useSSL = process.env['USE_SSL'] != null ? true : false;

var testCase = require('nodeunit').testCase,
  debug = require('util').debug,
  inspect = require('util').inspect,
  nodeunit = require('nodeunit'),
  gleak = require('../dev/tools/gleak'),
  Db = mongodb.Db,
  Cursor = mongodb.Cursor,
  Collection = mongodb.Collection,
  Step = require('step'),
  fs = require('fs'),
  Server = mongodb.Server;

var MONGODB = 'integration_tests';
var native_parser = (process.env['TEST_NATIVE'] != null);
var client = null;

/**
 * Retrieve the server information for the current
 * instance of the db client
 *
 * @ignore
 */
exports.setUp = function(callback) {
  var self = exports;
  client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: true, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)});
  client.open(function(err, db_p) {
    if(numberOfTestsRun == (Object.keys(self).length)) {
      // If first test drop the db
      client.dropDatabase(function(err, done) {
        callback();
      });
    } else {
      return callback();
    }
  });
}

/**
 * Retrieve the server information for the current
 * instance of the db client
 *
 * @ignore
 */
exports.tearDown = function(callback) {
  var self = this;
  numberOfTestsRun = numberOfTestsRun - 1;
  // Close connection
  client.close();
  callback();
}

/**
 * An example showing the information returned by indexInformation
 *
 * @_class cursor
 * @_function toArray
 */
exports.shouldCorrectlyExecuteToArray = function(test) {
  var db = new Db('integration_tests', new Server("127.0.0.1", 27017,
    {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser});

  // Establish connection to db
  db.open(function(err, db) {

    // Create a collection to hold our documents
    db.createCollection('test_array', function(err, collection) {

      // Insert a test document
      collection.insert({'b':[1, 2, 3]}, {safe:true}, function(err, ids) {

        // Retrieve all the documents in the collection
        collection.find().toArray(function(err, documents) {
          test.equal(1, documents.length);
          test.deepEqual([1, 2, 3], documents[0].b);

          db.close();
          test.done();
        });
      });
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyExecuteToArrayAndFailOnFurtherCursorAccess = function(test) {
  client.createCollection('test_to_a', function(err, collection) {
    test.ok(collection instanceof Collection);
    collection.insert({'a':1}, {safe:true}, function(err, ids) {
      var cursor = collection.find({});
      cursor.toArray(function(err, items) {
        // Should fail if called again (cursor should be closed)
        cursor.toArray(function(err, items) {
          test.ok(err instanceof Error);
          test.equal("Cursor is closed", err.message);

          // Should fail if called again (cursor should be closed)
          cursor.each(function(err, item) {
            test.ok(err instanceof Error);
            test.equal("Cursor is closed", err.message);
            // Let's close the db
            test.done();
          });
        });
      });
    });
  });
}

/**
 * A simple example iterating over a query using the each function of the cursor.
 *
 * @_class cursor
 * @_function each
 * @ignore
 */
exports.shouldCorrectlyFailToArrayDueToFinishedEachOperation = function(test) {
  var db = new Db('integration_tests', new Server("127.0.0.1", 27017,
   {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser});

  // Establish connection to db
  db.open(function(err, db) {

    // Create a collection
    db.createCollection('test_to_a_after_each', function(err, collection) {
      test.equal(null, err);
      test.ok(collection instanceof Collection);

      // Insert a document in the collection
      collection.insert({'a':1}, {safe:true}, function(err, ids) {

        // Grab a cursor
        var cursor = collection.find();

        // Execute the each command, triggers for each document
        cursor.each(function(err, item) {

          // If the item is null then the cursor is exhausted/empty and closed
          if(item == null) {

            // Show that the cursor is closed
            cursor.toArray(function(err, items) {
              test.ok(err != null);

              // Let's close the db
              test.done();
              db.close();
            });
          };
        });
      });
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyExecuteCursorExplain = function(test) {
  client.createCollection('test_explain', function(err, collection) {
    collection.insert({'a':1}, {safe:true}, function(err, r) {
      collection.find({'a':1}).explain(function(err, explaination) {
        test.ok(explaination.cursor != null);
        test.ok(explaination.n.constructor == Number);
        test.ok(explaination.millis.constructor == Number);
        test.ok(explaination.nscanned.constructor == Number);

        // Let's close the db
        test.done();
      });
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyExecuteCursorCount = function(test) {
  client.createCollection('test_count', function(err, collection) {
    collection.find().count(function(err, count) {
      test.equal(0, count);

      Step(
        function insert() {
          var group = this.group();

          for(var i = 0; i < 10; i++) {
            collection.insert({'x':i}, {safe:true}, group());
          }
        },

        function finished() {
          collection.find().count(function(err, count) {
            test.equal(10, count);
            test.ok(count.constructor == Number);
          });

          collection.find({}, {'limit':5}).count(function(err, count) {
            test.equal(10, count);
          });

          collection.find({}, {'skip':5}).count(function(err, count) {
            test.equal(10, count);
          });

          var cursor = collection.find();
          cursor.count(function(err, count) {
            test.equal(10, count);

            cursor.each(function(err, item) {
              if(item == null) {
                cursor.count(function(err, count2) {
                  test.equal(10, count2);
                  test.equal(count, count2);
                  // Let's close the db
                  test.done();
                });
              }
            });
          });

          client.collection('acollectionthatdoesn').count(function(err, count) {
            test.equal(0, count);
          });
        }
      )
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyExecuteSortOnCursor = function(test) {
  client.createCollection('test_sort', function(err, collection) {
    Step(
      function insert() {
        var group = this.group();

        for(var i = 0; i < 5; i++) {
          collection.insert({'a':i}, {safe:true}, group());
        }
      },

      function finished() {
        collection.find().sort(['a', 1], function(err, cursor) {
          test.ok(cursor instanceof Cursor);
          test.deepEqual(['a', 1], cursor.sortValue);
        });

        collection.find().sort('a', 1).nextObject(function(err, doc) {
          test.equal(0, doc.a);
        });

        collection.find().sort('a', -1).nextObject(function(err, doc) {
          test.equal(4, doc.a);
        });

        collection.find().sort('a', "asc").nextObject(function(err, doc) {
          test.equal(0, doc.a);
        });

        collection.find().sort([['a', -1], ['b', 1]], function(err, cursor) {
          test.ok(cursor instanceof Cursor);
          test.deepEqual([['a', -1], ['b', 1]], cursor.sortValue);
        });

        collection.find().sort('a', 1).sort('a', -1).nextObject(function(err, doc) {
          test.equal(4, doc.a);
        });

        collection.find().sort('a', -1).sort('a', 1).nextObject(function(err, doc) {
          test.equal(0, doc.a);
        });

        var cursor = collection.find();
        cursor.nextObject(function(err, doc) {
          cursor.sort(['a'], function(err, cursor) {
            test.ok(err instanceof Error);
            test.equal("Cursor is closed", err.message);
          });
        });

        var cursor = collection.find().sort('a', 25).nextObject(function(err, doc) {
          test.ok(err instanceof Error);
          test.equal("Illegal sort clause, must be of the form [['field1', '(ascending|descending)'], ['field2', '(ascending|descending)']]", err.message);
        });

        collection.find().sort(25).nextObject(function(err, doc) {
          test.ok(err instanceof Error);
          test.equal("Illegal sort clause, must be of the form [['field1', '(ascending|descending)'], ['field2', '(ascending|descending)']]", err.message);
          // Let's close the db
          test.done();
        });
      }
    );
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyThrowErrorOnToArrayWhenMissingCallback = function(test) {
  client.createCollection('test_to_array', function(err, collection) {
    Step(
      function insert() {
        var group = this.group();

        for(var i = 0; i < 2; i++) {
          collection.save({'x':1}, {safe:true}, group());
        }
      },

      function finished() {
        collection.find(function(err, cursor) {
          test.throws(function () {
            cursor.toArray();
          });
          test.done();
        });
      }
    )
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldThrowErrorOnEachWhenMissingCallback = function(test) {
  client.createCollection('test_each', function(err, collection) {
    Step(
      function insert() {
        var group = this.group();

        for(var i = 0; i < 2; i++) {
          collection.save({'x':1}, {safe:true}, group());
        }
      },

      function finished() {
        collection.find(function(err, cursor) {
          test.throws(function () {
            cursor.each();
          });
          test.done();
        });
      }
    )
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyHandleLimitOnCursor = function(test) {
  client.createCollection('test_cursor_limit', function(err, collection) {
    Step(
      function insert() {
        var group = this.group();

        for(var i = 0; i < 10; i++) {
          collection.save({'x':1}, {safe:true}, group());
        }
      },

      function finished() {
        collection.find().count(function(err, count) {
          test.equal(10, count);
        });

        collection.find().limit(5).toArray(function(err, items) {
          test.equal(5, items.length);
          // Let's close the db
          test.done();
        });
      }
    );
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyHandleNegativeOneLimitOnCursor = function(test) {
  client.createCollection('test_cursor_negative_one_limit', function(err, collection) {
    Step(
      function insert() {
        var group = this.group();

        for(var i = 0; i < 10; i++) {
          collection.save({'x':1}, {safe:true}, group());
        }
      },

      function finished() {
        collection.find().limit(-1).toArray(function(err, items) {
          test.equal(1, items.length);
          // Let's close the db
          test.done();
        });
      }
    );
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyHandleAnyNegativeLimitOnCursor = function(test) {
  client.createCollection('test_cursor_any_negative_limit', function(err, collection) {
    Step(
      function insert() {
        var group = this.group();

        for(var i = 0; i < 10; i++) {
          collection.save({'x':1}, {safe:true}, group());
        }
      },

      function finished() {
        collection.find().limit(-5).toArray(function(err, items) {
          test.equal(5, items.length);
          // Let's close the db
          test.done();
        });
      }
    );
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyReturnErrorsOnIllegalLimitValues = function(test) {
  client.createCollection('test_limit_exceptions', function(err, collection) {
    collection.insert({'a':1}, {safe:true}, function(err, docs) {});
    collection.find(function(err, cursor) {
      cursor.limit('not-an-integer', function(err, cursor) {
        test.ok(err instanceof Error);
        test.equal("limit requires an integer", err.message);
      });

      try {
        cursor.limit('not-an-integer');
        test.ok(false);
      } catch(err) {
        test.equal("limit requires an integer", err.message);
      }
    });

    collection.find(function(err, cursor) {
      cursor.nextObject(function(err, doc) {
        cursor.limit(1, function(err, cursor) {
          test.ok(err instanceof Error);
          test.equal("Cursor is closed", err.message);
        });

        try {
          cursor.limit(1);
          test.ok(false);
        } catch(err) {
          test.equal("Cursor is closed", err.message);
        }
      });
    });

    collection.find(function(err, cursor) {
      cursor.close(function(err, cursor) {
        cursor.limit(1, function(err, cursor) {
          test.ok(err instanceof Error);
          test.equal("Cursor is closed", err.message);
          test.done();
        });

        try {
          cursor.limit(1);
          test.ok(false);
        } catch(err) {
          test.equal("Cursor is closed", err.message);
        }
      });
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlySkipRecordsOnCursor = function(test) {
  client.createCollection('test_skip', function(err, collection) {
    Step(
      function insert() {
        var group = this.group();

        for(var i = 0; i < 10; i++) {
          collection.insert({'x':i}, {safe:true}, group());
        }
      },

      function finished() {
        collection.find(function(err, cursor) {
          cursor.count(function(err, count) {
            test.equal(10, count);
          });
        });

        collection.find(function(err, cursor) {
          cursor.toArray(function(err, items) {
            test.equal(10, items.length);

            collection.find().skip(2).toArray(function(err, items2) {
              test.equal(8, items2.length);

              // Check that we have the same elements
              var numberEqual = 0;
              var sliced = items.slice(2, 10);

              for(var i = 0; i < sliced.length; i++) {
                if(sliced[i].x == items2[i].x) numberEqual = numberEqual + 1;
              }
              test.equal(8, numberEqual);

              // Let's close the db
              test.done();
            });
          });
        });
      }
    )
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyReturnErrorsOnIllegalSkipValues = function(test) {
  client.createCollection('test_skip_exceptions', function(err, collection) {
    collection.insert({'a':1}, {safe:true}, function(err, docs) {});
    collection.find().skip('not-an-integer', function(err, cursor) {
      test.ok(err instanceof Error);
      test.equal("skip requires an integer", err.message);
    });

    var cursor = collection.find()
    cursor.nextObject(function(err, doc) {
      cursor.skip(1, function(err, cursor) {
        test.ok(err instanceof Error);
        test.equal("Cursor is closed", err.message);
      });
    });

    var cursor = collection.find()
    cursor.close(function(err, cursor) {
      cursor.skip(1, function(err, cursor) {
        test.ok(err instanceof Error);
        test.equal("Cursor is closed", err.message);

        test.done();
      });
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldReturnErrorsOnIllegalBatchSizes = function(test) {
  client.createCollection('test_batchSize_exceptions', function(err, collection) {
    collection.insert({'a':1}, {safe:true}, function(err, docs) {});
    var cursor = collection.find();
    cursor.batchSize('not-an-integer', function(err, cursor) {
      test.ok(err instanceof Error);
      test.equal("batchSize requires an integer", err.message);
    });

    try {
      cursor.batchSize('not-an-integer');
      test.ok(false);
    } catch (err) {
      test.equal("batchSize requires an integer", err.message);
    }

    var cursor = collection.find();
    cursor.nextObject(function(err, doc) {
      cursor.nextObject(function(err, doc) {
        cursor.batchSize(1, function(err, cursor) {
          test.ok(err instanceof Error);
          test.equal("Cursor is closed", err.message);
        });

        try {
          cursor.batchSize(1);
          test.ok(false);
        } catch (err) {
          test.equal("Cursor is closed", err.message);
        }
      });
    });

    var cursor = collection.find()
    cursor.close(function(err, cursor) {
      cursor.batchSize(1, function(err, cursor) {
        test.ok(err instanceof Error);
        test.equal("Cursor is closed", err.message);

        test.done();
      });

      try {
        cursor.batchSize(1);
        test.ok(false);
      } catch (err) {
        test.equal("Cursor is closed", err.message);
      }
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyHandleChangesInBatchSizes = function(test) {
  client.createCollection('test_not_multiple_batch_size', function(err, collection) {
    var records = 6;
    var batchSize = 2;
    var docs = [];
    for(var i = 0; i < records; i++) {
      docs.push({'a':i});
    }

    collection.insert(docs, {safe:true}, function() {
      collection.find({}, {batchSize : batchSize}, function(err, cursor) {
        //1st
        cursor.nextObject(function(err, items) {
          //cursor.items should contain 1 since nextObject already popped one
          test.equal(1, cursor.items.length);
          test.ok(items != null);

          //2nd
          cursor.nextObject(function(err, items) {
            test.equal(0, cursor.items.length);
            test.ok(items != null);

            //test batch size modification on the fly
            batchSize = 3;
            cursor.batchSize(batchSize);

            //3rd
            cursor.nextObject(function(err, items) {
              test.equal(2, cursor.items.length);
              test.ok(items != null);

              //4th
              cursor.nextObject(function(err, items) {
                test.equal(1, cursor.items.length);
                test.ok(items != null);

                //5th
                cursor.nextObject(function(err, items) {
                  test.equal(0, cursor.items.length);
                  test.ok(items != null);

                  //6th
                  cursor.nextObject(function(err, items) {
                    test.equal(0, cursor.items.length);
                    test.ok(items != null);

                    //No more
                    cursor.nextObject(function(err, items) {
                      test.ok(items == null);
                      test.ok(cursor.isClosed());

                      test.done();
                    });
                  });
                });
              });
            });
          });
        });
      });
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyHandleBatchSize = function(test) {
  client.createCollection('test_multiple_batch_size', function(err, collection) {
    //test with the last batch that is a multiple of batchSize
    var records = 4;
    var batchSize = 2;
    var docs = [];
    for(var i = 0; i < records; i++) {
      docs.push({'a':i});
    }

    collection.insert(docs, {safe:true}, function() {
      collection.find({}, {batchSize : batchSize}, function(err, cursor) {
        //1st
        cursor.nextObject(function(err, items) {
          test.equal(1, cursor.items.length);
          test.ok(items != null);

          //2nd
          cursor.nextObject(function(err, items) {
            test.equal(0, cursor.items.length);
            test.ok(items != null);

            //3rd
            cursor.nextObject(function(err, items) {
              test.equal(1, cursor.items.length);
              test.ok(items != null);

              //4th
              cursor.nextObject(function(err, items) {
                test.equal(0, cursor.items.length);
                test.ok(items != null);

                //No more
                cursor.nextObject(function(err, items) {
                  test.ok(items == null);
                  test.ok(cursor.isClosed());

                  test.done();
                });
              });
            });
          });
        });
      });
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldHandleWhenLimitBiggerThanBatchSize = function(test) {
  client.createCollection('test_limit_greater_than_batch_size', function(err, collection) {
    var limit = 4;
    var records = 10;
    var batchSize = 3;
    var docs = [];
    for(var i = 0; i < records; i++) {
      docs.push({'a':i});
    }

    collection.insert(docs, {safe:true}, function() {
      var cursor = collection.find({}, {batchSize : batchSize, limit : limit});
      //1st
      cursor.nextObject(function(err, items) {
        test.equal(2, cursor.items.length);

        //2nd
        cursor.nextObject(function(err, items) {
          test.equal(1, cursor.items.length);

          //3rd
          cursor.nextObject(function(err, items) {
            test.equal(0, cursor.items.length);

            //4th
            cursor.nextObject(function(err, items) {
              test.equal(0, cursor.items.length);

              //No more
              cursor.nextObject(function(err, items) {
                test.ok(items == null);
                test.ok(cursor.isClosed());

                test.done();
              });
            });
          });
        });
      });
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldHandleLimitLessThanBatchSize = function(test) {
  client.createCollection('test_limit_less_than_batch_size', function(err, collection) {
    var limit = 2;
    var records = 10;
    var batchSize = 4;
    var docs = [];
    for(var i = 0; i < records; i++) {
      docs.push({'a':i});
    }

    collection.insert(docs, {safe:true}, function() {
      var cursor = collection.find({}, {batchSize : batchSize, limit : limit});
      //1st
      cursor.nextObject(function(err, items) {
        test.equal(1, cursor.items.length);

        //2nd
        cursor.nextObject(function(err, items) {
          test.equal(0, cursor.items.length);

          //No more
          cursor.nextObject(function(err, items) {
            test.ok(items == null);
            test.ok(cursor.isClosed());

            test.done();
          });
        });
      });
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldHandleSkipLimitChaining = function(test) {
  client.createCollection('test_limit_skip_chaining', function(err, collection) {
    Step(
      function insert() {
        var group = this.group();

        for(var i = 0; i < 10; i++) {
          collection.insert({'x':1}, {safe:true}, group());
        }
      },

      function finished() {
        collection.find().toArray(function(err, items) {
          test.equal(10, items.length);

          collection.find().limit(5).skip(3).toArray(function(err, items2) {
            test.equal(5, items2.length);

            // Check that we have the same elements
            var numberEqual = 0;
            var sliced = items.slice(3, 8);

            for(var i = 0; i < sliced.length; i++) {
              if(sliced[i].x == items2[i].x) numberEqual = numberEqual + 1;
            }
            test.equal(5, numberEqual);

            // Let's close the db
            test.done();
          });
        });
      }
    )
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyHandleLimitSkipChainingInline = function(test) {
  client.createCollection('test_limit_skip_chaining_inline', function(err, collection) {
    Step(
      function insert() {
        var group = this.group();

        for(var i = 0; i < 10; i++) {
          collection.insert({'x':1}, {safe:true}, group());
        }
      },

      function finished() {
        collection.find().toArray(function(err, items) {
          test.equal(10, items.length);

          collection.find().limit(5).skip(3).toArray(function(err, items2) {
            test.equal(5, items2.length);

            // Check that we have the same elements
            var numberEqual = 0;
            var sliced = items.slice(3, 8);

            for(var i = 0; i < sliced.length; i++) {
              if(sliced[i].x == items2[i].x) numberEqual = numberEqual + 1;
            }
            test.equal(5, numberEqual);

            // Let's close the db
            test.done();
          });
        });
      }
    )
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCloseCursorNoQuerySent = function(test) {
  client.createCollection('test_close_no_query_sent', function(err, collection) {
    collection.find().close(function(err, cursor) {
      test.equal(true, cursor.isClosed());
      // Let's close the db
      test.done();
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyRefillViaGetMoreCommand = function(test) {
  var COUNT = 1000;

  client.createCollection('test_refill_via_get_more', function(err, collection) {
    Step(
      function insert() {
        var group = this.group();

        for(var i = 0; i < COUNT; i++) {
          collection.save({'a': i}, {safe:true}, group());
        }
      },

      function finished() {
        collection.count(function(err, count) {
          test.equal(COUNT, count);
        });

        var total = 0;
        var i = 0;
        var cursor = collection.find({}, {}).each(function(err, item) {
        if(item != null) {
          total = total + item.a;
        } else {
          test.equal(499500, total);

          collection.count(function(err, count) {
            test.equal(COUNT, count);
          });

          collection.count(function(err, count) {
            test.equal(COUNT, count);

            var total2 = 0;
            collection.find().each(function(err, item) {
              if(item != null) {
                total2 = total2 + item.a;
              } else {
                test.equal(499500, total2);
                collection.count(function(err, count) {
                  test.equal(COUNT, count);
                  test.equal(total, total2);
                  // Let's close the db
                  test.done();
                });
              }
            });
          });
        }
      })
    })
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyRefillViaGetMoreAlternativeCollection = function(test) {
  client.createCollection('test_refill_via_get_more_alt_coll', function(err, collection) {

    Step(
      function insert() {
        var group = this.group();

        for(var i = 0; i < 1000; i++) {
          collection.save({'a': i}, {safe:true}, group());
        }
      },

      function finished() {
        collection.count(function(err, count) {
          test.equal(1000, count);
        });

        var total = 0;
        collection.find().each(function(err, item) {
          if(item != null) {
            total = total + item.a;
          } else {
            test.equal(499500, total);

            collection.count(function(err, count) {
              test.equal(1000, count);
            });

            collection.count(function(err, count) {
              test.equal(1000, count);

              var total2 = 0;
              collection.find().each(function(err, item) {
                if(item != null) {
                  total2 = total2 + item.a;
                } else {
                  test.equal(499500, total2);
                  collection.count(function(err, count) {
                    test.equal(1000, count);
                    test.equal(total, total2);
                    // Let's close the db
                    test.done();
                  });
                }
              });
            });
          }
        });
      }
    )
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCloseCursorAfterQueryHasBeenSent = function(test) {
  client.createCollection('test_close_after_query_sent', function(err, collection) {
    collection.insert({'a':1}, {safe:true}, function(err, r) {
      var cursor = collection.find({'a':1});
      cursor.nextObject(function(err, item) {
        cursor.close(function(err, cursor) {
          test.equal(true, cursor.isClosed());
          // Let's close the db
          test.done();
        })
      });
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyExecuteCursorCountWithFields = function(test) {
  client.createCollection('test_count_with_fields', function(err, collection) {
    collection.save({'x':1, 'a':2}, {safe:true}, function(err, doc) {
      collection.find({}, {'fields':['a']}).toArray(function(err, items) {
        test.equal(1, items.length);
        test.equal(2, items[0].a);
        test.equal(null, items[0].x);
      });

      collection.findOne({}, {'fields':['a']}, function(err, item) {
        test.equal(2, item.a);
        test.equal(null, item.x);
        test.done();
      });
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyCountWithFieldsUsingExclude = function(test) {
  client.createCollection('test_count_with_fields_using_exclude', function(err, collection) {
    collection.save({'x':1, 'a':2}, {safe:true}, function(err, doc) {
      collection.find({}, {'fields':{'x':0}}).toArray(function(err, items) {
        test.equal(1, items.length);
        test.equal(2, items[0].a);
        test.equal(null, items[0].x);
        test.done();
      });
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyExecuteEnsureIndexWithNoCallback = function(test) {
  var docs = [];

  for(var i = 0; i < 1; i++) {
    var d = new Date().getTime() + i*1000;
    docs[i] = {createdAt:new Date(d)};
  }

  // Create collection
  client.createCollection('shouldCorrectlyExecuteEnsureIndexWithNoCallback', function(err, collection) {
    // ensure index of createdAt index
    collection.ensureIndex({createdAt:1})
    // insert all docs
    collection.insert(docs, {safe:true}, function(err, result) {
      test.equal(null, err);

      // Find with sort
      collection.find().sort(['createdAt', 'asc']).toArray(function(err, items) {
        if (err) logger.error("error in collection_info.find: " + err);
        test.equal(1, items.length);
        test.done();
      })
    })
  });
}

/**
 * @ignore
 * @api private
 */
exports.shouldCorrectlyInsert5000RecordsWithDateAndSortCorrectlyWithIndex = function(test) {
  var docs = [];

  for(var i = 0; i < 5000; i++) {
    var d = new Date().getTime() + i*1000;
    docs[i] = {createdAt:new Date(d)};
  }

  // Create collection
  client.createCollection('shouldCorrectlyInsert5000RecordsWithDateAndSortCorrectlyWithIndex', function(err, collection) {
    // ensure index of createdAt index
    collection.ensureIndex({createdAt:1}, function(err, indexName) {
      test.equal(null, err);

      // insert all docs
      collection.insert(docs, {safe:true}, function(err, result) {
        test.equal(null, err);

        // Find with sort
        collection.find().sort(['createdAt', 'asc']).toArray(function(err, items) {
          if (err) logger.error("error in collection_info.find: " + err);
          test.equal(5000, items.length);
          test.done();
        })
      })
    });
  });
}

/**
 * An example showing the information returned by indexInformation
 *
 * @_class cursor
 * @_function rewind
 */
exports['Should correctly rewind and restart cursor'] = function(test) {
  var db = new Db('integration_tests', new Server("127.0.0.1", 27017,
    {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: native_parser});

  // Establish connection to db
  db.open(function(err, db) {
    var docs = [];

    // Insert 100 documents with some data
    for(var i = 0; i < 100; i++) {
      var d = new Date().getTime() + i*1000;
      docs[i] = {'a':i, createdAt:new Date(d)};
    }

    // Create collection
    db.createCollection('Should_correctly_rewind_and_restart_cursor', function(err, collection) {
      test.equal(null, err);

      // insert all docs
      collection.insert(docs, {safe:true}, function(err, result) {
        test.equal(null, err);

        // Grab a cursor using the find
        var cursor = collection.find({});
        // Fetch the first object off the cursor
        cursor.nextObject(function(err, item) {
          test.equal(0, item.a)
          // Rewind the cursor, resetting it to point to the start of the query
          cursor.rewind();

          // Grab the first object again
          cursor.nextObject(function(err, item) {
            test.equal(0, item.a)

            db.close();
            test.done();
          })
        })
      })
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports['Should correctly execute count on cursor'] = function(test) {
  var docs = [];

  for(var i = 0; i < 1000; i++) {
    var d = new Date().getTime() + i*1000;
    docs[i] = {'a':i, createdAt:new Date(d)};
  }

  // Create collection
  client.createCollection('Should_correctly_execute_count_on_cursor', function(err, collection) {
    test.equal(null, err);

    // insert all docs
    collection.insert(docs, {safe:true}, function(err, result) {
      test.equal(null, err);
      var total = 0;
      // Create a cursor for the content
      var cursor = collection.find({});
      cursor.count(function(err, c) {
        // Ensure each returns all documents
        cursor.each(function(err, item) {
          if(item != null) {
            total++;
          } else {
            cursor.count(function(err, c) {
              test.equal(1000, c);
              test.equal(1000, total);
              test.done();
            })
          }
        });
      })
    })
  });
}

/**
 * @ignore
 * @api private
 */
exports['should be able to stream documents'] = function(test) {
  var docs = [];

  for (var i = 0; i < 1000; i++) {
    docs[i] = { a: i+1 };
  }

  // Create collection
  client.createCollection('Should_be_able_to_stream_documents', function(err, collection) {
    test.equal(null, err);

    // insert all docs
    collection.insert(docs, {safe:true}, function(err, result) {
      test.equal(null, err);

      var paused = 0
        , closed = 0
        , resumed = 0
        , i = 0
        , err

      var stream = collection.find().stream();

      stream.on('data', function (doc) {
        test.equal(true, !! doc);
        test.equal(true, !! doc.a);

        if (paused > 0 && 0 === resumed) {
          err = new Error('data emitted during pause');
          return done();
        }

        if (++i === 3) {
          test.equal(false, stream.paused);
          stream.pause();
          test.equal(true, stream.paused);
          paused++;

          setTimeout(function () {
            test.equal(true, stream.paused);
            stream.resume();
            test.equal(false, stream.paused);
            resumed++;
          }, 20);
        }
      });

      stream.on('error', function (er) {
        err = er;
        done();
      });

      stream.on('close', function () {
        closed++;
        done();
      });

      function done () {
        test.equal(undefined, err);
        test.equal(i, docs.length);
        test.equal(1, closed);
        test.equal(1, paused);
        test.equal(1, resumed);
        test.strictEqual(stream._cursor.isClosed(), true);
        test.done();
      }
    })
  })
}

/**
 * @ignore
 * @api private
 */
exports['immediately destroying a stream prevents the query from executing'] = function(test) {
  var i = 0
    , docs = [{ b: 2 }, { b: 3 }]
    , doneCalled = 0

  client.createCollection('immediately_destroying_a_stream_prevents_the_query_from_executing', function(err, collection) {
    test.equal(null, err);

    // insert all docs
    collection.insert(docs, {safe:true}, function(err, result) {
      test.equal(null, err);

      var stream = collection.find().stream();

      stream.on('data', function () {
        i++;
      })
      stream.on('close', done);
      stream.on('error', done);

      stream.destroy();

      function done (err) {
        test.equal(++doneCalled, 1);
        test.equal(undefined, err);
        test.strictEqual(0, i);
        test.strictEqual(true, stream._destroyed);
        test.done();
      }
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports['destroying a stream stops it'] = function(test) {
  client.createCollection('destroying_a_stream_stops_it', function(err, collection) {
    test.equal(null, err);

    var docs = [];
    for (var ii = 0; ii < 10; ++ii) docs.push({ b: ii+1 });

    // insert all docs
    collection.insert(docs, {safe:true}, function(err, result) {
      test.equal(null, err);

      var finished = 0
        , i = 0

      var stream = collection.find().stream();

      test.strictEqual(null, stream._destroyed);
      test.strictEqual(true, stream.readable);

      stream.on('data', function (doc) {
        if (++i === 5) {
          stream.destroy();
          test.strictEqual(false, stream.readable);
        }
      });

      stream.on('close', done);
      stream.on('error', done);

      function done (err) {
        ++finished;
        setTimeout(function () {
          test.strictEqual(undefined, err);
          test.strictEqual(5, i);
          test.strictEqual(1, finished);
          test.strictEqual(true, stream._destroyed);
          test.strictEqual(false, stream.readable);
          test.strictEqual(true, stream._cursor.isClosed());
          test.done();
        }, 150)
      }
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports['cursor stream errors']= function(test) {
  var client = new Db(MONGODB, new Server("127.0.0.1", 27017, {auto_reconnect: false, poolSize: 4, ssl:useSSL}), {native_parser: (process.env['TEST_NATIVE'] != null)});
  client.open(function(err, db_p) {
    test.equal(null, err);

    client.createCollection('cursor_stream_errors', function(err, collection) {
      test.equal(null, err);

      var docs = [];
      for (var ii = 0; ii < 10; ++ii) docs.push({ b: ii+1 });

      // insert all docs
      collection.insert(docs, {safe:true}, function(err, result) {
        test.equal(null, err);

        var finished = 0
          , closed = 0
          , i = 0

        var stream = collection.find({}, { batchSize: 5 }).stream();

        stream.on('data', function (doc) {
          if (++i === 5) {
            client.close();
          }
        });

        stream.on('close', function () {
          closed++;
        });

        stream.on('error', done);

        function done (err) {
          ++finished;
          setTimeout(function () {
            test.equal('no open connections', err.message);
            test.equal(5, i);
            test.equal(1, closed);
            test.equal(1, finished);
            test.equal(true, stream._destroyed);
            test.equal(false, stream.readable);
            test.equal(true, stream._cursor.isClosed());
            test.done();
          }, 150)
        }
      });
    });
  });
}

/**
 * @ignore
 * @api private
 */
exports['cursor stream pipe']= function(test) {
  client.createCollection('cursor_stream_pipe', function(err, collection) {
    test.equal(null, err);

    var docs = [];
    ;('Aaden Aaron Adrian Aditya Bob Joe').split(' ').forEach(function (name) {
      docs.push({ name: name });
    });

    // insert all docs
    collection.insert(docs, {safe:true}, function(err, result) {
      test.equal(null, err);

      var filename = '/tmp/_nodemongodbnative_stream_out.txt'
        , out = fs.createWriteStream(filename)

      // hack so we don't need to create a stream filter just to
      // stringify the objects (otherwise the created file would
      // just contain a bunch of [object Object])
      var toString = Object.prototype.toString;
      Object.prototype.toString = function () {
        return JSON.stringify(this);
      }

      var stream = collection.find().stream();
      stream.pipe(out);

      stream.on('error', done);
      stream.on('close', done);

      function done (err) {
        Object.prototype.toString = toString;
        test.strictEqual(undefined, err);
        var contents = fs.readFileSync(filename, 'utf8');
        test.ok(/Aaden/.test(contents));
        test.ok(/Aaron/.test(contents));
        test.ok(/Adrian/.test(contents));
        test.ok(/Aditya/.test(contents));
        test.ok(/Bob/.test(contents));
        test.ok(/Joe/.test(contents));
        fs.unlink(filename);
        test.done();
      }
    });
  });
}

/**
 * A simple example showing the count function of the cursor.
 *
 * @_class cursor
 * @_function count
 * @ignore
 */
exports.shouldCorrectlyUseCursorCountFunction = function(test) {
  var db = new Db('integration_tests', new Server("127.0.0.1", 27017,
   {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser});

  // Establish connection to db
  db.open(function(err, db) {

    // Creat collection
    db.createCollection('cursor_count_collection', function(err, collection) {
      test.equal(null, err);

      // Insert some docs
      collection.insert([{a:1}, {a:2}], {safe:true}, function(err, docs) {
        test.equal(null, err);

        // Do a find and get the cursor count
        collection.find().count(function(err, count) {
          test.equal(null, err);
          test.equal(2, count);

          db.close();
          test.done();
        })
      });
    });
  });
}

/**
 * A simple example showing the use of sort on the cursor.
 *
 * @_class cursor
 * @_function sort
 * @ignore
 */
exports.shouldCorrectlyPeformSimpleSorts = function(test) {
  var db = new Db('integration_tests', new Server("127.0.0.1", 27017,
   {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser});

  // Establish connection to db
  db.open(function(err, db) {

    // Create a collection
    db.createCollection('simple_sort_collection', function(err, collection) {
      test.equal(null, err);

      // Insert some documents we can sort on
      collection.insert([{a:1}, {a:2}, {a:3}], {safe:true}, function(err, docs) {
        test.equal(null, err);

        // Do normal ascending sort
        collection.find().sort([['a', 1]]).nextObject(function(err, item) {
          test.equal(null, err);
          test.equal(1, item.a);

          // Do normal descending sort
          collection.find().sort([['a', -1]]).nextObject(function(err, item) {
            test.equal(null, err);
            test.equal(3, item.a);

            db.close();
            test.done();
          });
        });
      });
    });
  });
}

/**
 * A simple example showing the use of limit on the cursor
 *
 * @_class cursor
 * @_function limit
 * @ignore
 */
exports.shouldCorrectlyPeformLimitOnCursor = function(test) {
  var db = new Db('integration_tests', new Server("127.0.0.1", 27017,
   {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser});

  // Establish connection to db
  db.open(function(err, db) {

    // Create a collection
    db.createCollection('simple_limit_collection', function(err, collection) {
      test.equal(null, err);

      // Insert some documents we can sort on
      collection.insert([{a:1}, {a:2}, {a:3}], {safe:true}, function(err, docs) {
        test.equal(null, err);

        // Limit to only one document returned
        collection.find().limit(1).toArray(function(err, items) {
          test.equal(null, err);
          test.equal(1, items.length);

          db.close();
          test.done();
        });
      });
    });
  });
}

/**
 * A simple example showing the use of skip on the cursor
 *
 * @_class cursor
 * @_function skip
 * @ignore
 */
exports.shouldCorrectlyPeformSkipOnCursor = function(test) {
  var db = new Db('integration_tests', new Server("127.0.0.1", 27017,
   {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser});

  // Establish connection to db
  db.open(function(err, db) {

    // Create a collection
    db.createCollection('simple_skip_collection', function(err, collection) {
      test.equal(null, err);

      // Insert some documents we can sort on
      collection.insert([{a:1}, {a:2}, {a:3}], {safe:true}, function(err, docs) {
        test.equal(null, err);

        // Skip one document
        collection.find().skip(1).nextObject(function(err, item) {
          test.equal(null, err);
          test.equal(2, item.a);

          db.close();
          test.done();
        });
      });
    });
  });
}

/**
 * A simple example showing the use of batchSize on the cursor, batchSize only regulates how many
 * documents are returned for each batch using the getMoreCommand against the MongoDB server
 *
 * @_class cursor
 * @_function batchSize
 * @ignore
 */
exports.shouldCorrectlyPeformBatchSizeOnCursor = function(test) {
  var db = new Db('integration_tests', new Server("127.0.0.1", 27017,
   {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser});

  // Establish connection to db
  db.open(function(err, db) {

    // Create a collection
    db.createCollection('simple_batch_size_collection', function(err, collection) {
      test.equal(null, err);

      // Insert some documents we can sort on
      collection.insert([{a:1}, {a:2}, {a:3}], {safe:true}, function(err, docs) {
        test.equal(null, err);

        // Do normal ascending sort
        collection.find().batchSize(1).nextObject(function(err, item) {
          test.equal(null, err);
          test.equal(1, item.a);

          db.close();
          test.done();
        });
      });
    });
  });
}

/**
 * A simple example showing the use of nextObject.
 *
 * @_class cursor
 * @_function nextObject
 * @ignore
 */
exports.shouldCorrectlyPeformNextObjectOnCursor = function(test) {
  var db = new Db('integration_tests', new Server("127.0.0.1", 27017,
   {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser});

  // Establish connection to db
  db.open(function(err, db) {

    // Create a collection
    db.createCollection('simple_next_object_collection', function(err, collection) {
      test.equal(null, err);

      // Insert some documents we can sort on
      collection.insert([{a:1}, {a:2}, {a:3}], {safe:true}, function(err, docs) {
        test.equal(null, err);

        // Do normal ascending sort
        collection.find().nextObject(function(err, item) {
          test.equal(null, err);
          test.equal(1, item.a);

          db.close();
          test.done();
        });
      });
    });
  });
}

/**
 * A simple example showing the use of the cursor explain function.
 *
 * @_class cursor
 * @_function explain
 * @ignore
 */
exports.shouldCorrectlyPeformSimpleExplainCursor = function(test) {
  var db = new Db('integration_tests', new Server("127.0.0.1", 27017,
   {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser});

  // Establish connection to db
  db.open(function(err, db) {

    // Create a collection
    db.createCollection('simple_explain_collection', function(err, collection) {
      test.equal(null, err);

      // Insert some documents we can sort on
      collection.insert([{a:1}, {a:2}, {a:3}], {safe:true}, function(err, docs) {
        test.equal(null, err);

        // Do normal ascending sort
        collection.find().explain(function(err, explaination) {
          test.equal(null, err);

          db.close();
          test.done();
        });
      });
    });
  });
}

/**
 * A simple example showing the use of the cursor streamRecords function.
 *
 * @_class cursor
 * @_function streamRecords
 * @ignore
 */
exports.shouldStreamDocumentsUsingTheStreamRecords = function(test) {
  var db = new Db('integration_tests', new Server("127.0.0.1", 27017,
   {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser});

  // Establish connection to db
  db.open(function(err, db) {

    // Create a lot of documents to insert
    var docs = []
    for(var i = 0; i < 100; i++) {
      docs.push({'a':i})
    }

    // Create a collection
    db.createCollection('test_streamingRecords_function', function(err, collection) {
      test.equal(null, err);

      // Insert documents into collection
      collection.insert(docs, {safe:true}, function(err, ids) {
        // Peform a find to get a cursor
        var stream = collection.find().streamRecords({fetchSize:1000});

        // Execute find on all the documents
        stream.on('end', function() {
          db.close();
          test.done();
        });

        stream.on('data', function(data) {
          test.ok(data != null);
        });
      });
    });
  });
}

/**
 * A simple example showing the use of the cursor stream function.
 *
 * @_class cursor
 * @_function stream
 * @ignore
 */
exports.shouldStreamDocumentsUsingTheStreamFunction = function(test) {
  var db = new Db('integration_tests', new Server("127.0.0.1", 27017,
   {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser});

  // Establish connection to db
  db.open(function(err, db) {

    // Create a lot of documents to insert
    var docs = []
    for(var i = 0; i < 100; i++) {
      docs.push({'a':i})
    }

    // Create a collection
    db.createCollection('test_stream_function', function(err, collection) {
      test.equal(null, err);

      // Insert documents into collection
      collection.insert(docs, {safe:true}, function(err, ids) {
        // Peform a find to get a cursor
        var stream = collection.find().stream();

        // Execute find on all the documents
        stream.on('close', function() {
          db.close();
          test.done();
        });

        stream.on('data', function(data) {
          test.ok(data != null);
        });
      });
    });
  });
}

/**
 * A simple example showing the use of the cursor close function.
 *
 * @_class cursor
 * @_function close
 * @ignore
 */
exports.shouldStreamDocumentsUsingTheCloseFunction = function(test) {
  var db = new Db('integration_tests', new Server("127.0.0.1", 27017,
   {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser});

  // Establish connection to db
  db.open(function(err, db) {

    // Create a lot of documents to insert
    var docs = []
    for(var i = 0; i < 100; i++) {
      docs.push({'a':i})
    }

    // Create a collection
    db.createCollection('test_close_function_on_cursor', function(err, collection) {
      test.equal(null, err);

      // Insert documents into collection
      collection.insert(docs, {safe:true}, function(err, ids) {
        // Peform a find to get a cursor
        var cursor = collection.find();

        // Fetch the first object
        cursor.nextObject(function(err, object) {
          test.equal(null, err);

          // Close the cursor, this is the same as reseting the query
          cursor.close(function(err, result) {
            test.equal(null, err);

            db.close();
            test.done();
          });
        });
      });
    });
  });
}

/**
 * A simple example showing the use of the cursor close function.
 *
 * @_class cursor
 * @_function isClosed
 * @ignore
 */
exports.shouldStreamDocumentsUsingTheIsCloseFunction = function(test) {
  var db = new Db('integration_tests', new Server("127.0.0.1", 27017,
   {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser});

  // Establish connection to db
  db.open(function(err, db) {

    // Create a lot of documents to insert
    var docs = []
    for(var i = 0; i < 100; i++) {
      docs.push({'a':i})
    }

    // Create a collection
    db.createCollection('test_is_close_function_on_cursor', function(err, collection) {
      test.equal(null, err);

      // Insert documents into collection
      collection.insert(docs, {safe:true}, function(err, ids) {
        // Peform a find to get a cursor
        var cursor = collection.find();

        // Fetch the first object
        cursor.nextObject(function(err, object) {
          test.equal(null, err);

          // Close the cursor, this is the same as reseting the query
          cursor.close(function(err, result) {
            test.equal(null, err);
            test.equal(true, cursor.isClosed());

            db.close();
            test.done();
          });
        });
      });
    });
  });
}

/**
 * @ignore
 */
exports.shouldCloseDeadTailableCursors = function (test) {
  // http://www.mongodb.org/display/DOCS/Tailable+Cursors
  var db = new Db('integration_tests', new Server("127.0.0.1", 27017,
   {auto_reconnect: false, poolSize: 1, ssl:useSSL}), {native_parser: native_parser});

  db.open(function(err, db) {

    var options = { capped: true, size: 8 };
    db.createCollection('test_if_dead_tailable_cursors_close', options, function(err, collection) {
      test.equal(null, err);

      var insertId = 0
      function insert (cb) {
        if (insert.ran) insert.ran++;
        else insert.ran = 1;

        var docs = []
        for(var end = insertId+1; insertId < end+80; insertId++) {
          docs.push({id:insertId})
        }
        collection.insert(docs, {safe:true}, function(err, ids) {
          test.equal(null, err);
          cb && cb();
        })
      }

      var lastId = 0
        , closed = false;

      insert(function query () {
        var conditions = { id: { $gte: lastId }};
        var stream = collection.find(conditions, { tailable: true }).stream();

        stream.on('data', function (doc) {
          lastId = doc.id;
          // kill the cursor on the server by inserting enough more
          // docs to overwrite the last one returned. this should
          // force the stream to close.
          if (insertId == lastId+1) insert();
        });

        stream.on('error', function (err) {
          // shouldn't happen
          test.equal(null, err);
        });

        stream.on('close', function () {
          // this is what we need
          closed = true;
        });
      });

      setTimeout(function () {
        db.close();
        test.equal(2, insert.ran);
        test.equal(true, closed);
        test.done();
      }, 800);
    });
  });
}

/**
 * @ignore
 */
exports.shouldAwaitData = function (test) {
  // http://www.mongodb.org/display/DOCS/Tailable+Cursors
  var db = new Db('integration_tests', new Server("127.0.0.1", 27017,
   {auto_reconnect: false, poolSize: 2, ssl:useSSL}), {native_parser: native_parser});

  db.open(function(err, db) {
    var options = { capped: true, size: 8};
    db.createCollection('should_await_data', options, function(err, collection) {
      collection.insert({a:1}, {safe:true}, function(err, result) {
        // Create cursor with awaitdata, and timeout after the period specified
        collection.find({}, {tailable:true, awaitdata:true, numberOfRetries:1}).each(function(err, result) {
          if(err != null) {
            db.close();
            test.done();
          }
        });
      });
    });
  })
}

/**
 * @ignore
 */
exports.shouldCorrectExecuteExplainHonoringLimit = function (test) {
  var docs = []
  docs[0] = { "_keywords" : [ "compact", "ii2gd", "led", "24-48v", "presse-etoupe", "bexbgl1d24483", "flash", "48v", "eexd", "feu", "presse", "compris", "rouge", "etoupe", "iic", "ii2gdeexdiict5", "red", "aet" ]};
  docs[1] = { "_keywords" : [ "reducteur", "06212", "d20/16", "manch", "d20", "manchon", "ard", "sable", "irl", "red" ]};
  docs[2] = { "_keywords" : [ "reducteur", "06214", "manch", "d25/20", "d25", "manchon", "ard", "sable", "irl", "red" ]};
  docs[3] = { "_keywords" : [ "bar", "rac", "boite", "6790178", "50-240/4-35", "240", "branch", "coulee", "ddc", "red", "ip2x" ]};
  docs[4] = { "_keywords" : [ "bar", "ip2x", "boite", "6790158", "ddi", "240", "branch", "injectee", "50-240/4-35?", "red" ]};
  docs[5] = { "_keywords" : [ "bar", "ip2x", "boite", "6790179", "coulee", "240", "branch", "sdc", "50-240/4-35?", "red", "rac" ]};
  docs[6] = { "_keywords" : [ "bar", "ip2x", "boite", "6790159", "240", "branch", "injectee", "50-240/4-35?", "sdi", "red" ]};
  docs[7] = { "_keywords" : [ "6000", "r-6000", "resin", "high", "739680", "red", "performance", "brd", "with", "ribbon", "flanges" ]};
  docs[8] = { "_keywords" : [ "804320", "for", "paint", "roads", "brd", "red" ]};
  docs[9] = { "_keywords" : [ "38mm", "padlock", "safety", "813594", "brd", "red" ]};
  docs[10] = { "_keywords" : [ "114551", "r6900", "for", "red", "bmp71", "brd", "ribbon" ]};
  docs[11] = { "_keywords" : [ "catena", "diameter", "621482", "rings", "brd", "legend", "red", "2mm" ]};
  docs[12] = { "_keywords" : [ "catena", "diameter", "621491", "rings", "5mm", "brd", "legend", "red" ]};
  docs[13] = { "_keywords" : [ "catena", "diameter", "621499", "rings", "3mm", "brd", "legend", "red" ]};
  docs[14] = { "_keywords" : [ "catena", "diameter", "621508", "rings", "5mm", "brd", "legend", "red" ]};
  docs[15] = { "_keywords" : [ "insert", "for", "cable", "3mm", "carrier", "621540", "blank", "brd", "ademark", "red" ]};
  docs[16] = { "_keywords" : [ "insert", "for", "cable", "621544", "3mm", "carrier", "brd", "ademark", "legend", "red" ]};
  docs[17] = { "_keywords" : [ "catena", "diameter", "6mm", "621518", "rings", "brd", "legend", "red" ]};
  docs[18] = { "_keywords" : [ "catena", "diameter", "621455", "8mm", "rings", "brd", "legend", "red" ]};
  docs[19] = { "_keywords" : [ "catena", "diameter", "621464", "rings", "5mm", "brd", "legend", "red" ]};

  // Insert all the docs
  var collection = client.collection('shouldCorrectExecuteExplainHonoringLimit');
  collection.insert(docs, {safe:true}, function(err, result) {
    test.equal(null, err);

    collection.ensureIndex({_keywords:1}, {safe:true}, function(err, result) {
      test.equal(null, err);

      // collection.find({_keywords:'red'},{}).limit(10).explain(function(err, result) {
      collection.find({_keywords:'red'}, {}, {explain:true}).limit(10).toArray(function(err, result) {
        test.equal(10, result[0].n);
        test.equal(10, result[0].nscanned);

        collection.find({_keywords:'red'},{}).limit(10).explain(function(err, result) {
          test.equal(10, result.n);
          test.equal(10, result.nscanned);
          test.done();
        });
      });
    });
  })
}

/**
 * Retrieve the server information for the current
 * instance of the db client
 *
 * @ignore
 */
exports.noGlobalsLeaked = function(test) {
  var leaks = gleak.detectNew();
  test.equal(0, leaks.length, "global var leak detected: " + leaks.join(', '));
  test.done();
}

/**
 * Retrieve the server information for the current
 * instance of the db client
 *
 * @ignore
 */
var numberOfTestsRun = Object.keys(this).length - 2;