mongo 1.0.6 → 1.0.7

data/HISTORY

@@ -1,3 +1,9 @@
+1.0.7 2010-8-4
+
+* A few minor test/doc fixes.
+* Better tests for replica sets and replication acknowledgment.
+* Deprecated DB#error and DB#last_status
+
 1.0.6 2010-7-26
 
 * Replica set support.

data/README.rdoc

@@ -165,7 +165,7 @@ or handle reconnecting when passenger forks a new process:
   if defined?(PhusionPassenger)
     PhusionPassenger.on_event(:starting_worker_process) do |forked|
       if forked
-        # Call db.connect_to_master to reconnect here
+        # Call db.connect to reconnect here
       end
     end
   end

data/Rakefile

@@ -98,6 +98,11 @@ namespace :test do
     t.verbose    = true
   end
 
+  Rake::TestTask.new(:replica_set_ack) do |t|
+    t.test_files = FileList['test/replica_sets/replication_ack_test.rb']
+    t.verbose    = true
+  end
+
   Rake::TestTask.new(:auto_reconnect) do |t|
     t.test_files = FileList['test/auxillary/autoreconnect_test.rb']
     t.verbose    = true

data/lib/mongo.rb

@@ -3,7 +3,7 @@
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 module Mongo
-  VERSION = "1.0.6"
+  VERSION = "1.0.7"
 end
 
 module Mongo

data/lib/mongo/collection.rb

@@ -260,7 +260,7 @@ module Mongo
     #   run the operation in safe mode, which run a getlasterror command on the
     #   database to report any assertion. In addition, a hash can be provided to
     #   run an fsync and/or wait for replication of the remove (>= 1.5.1). See the options
-    #   for DB#error.
+    #   for DB#get_last_error.
     #
     # @example remove all documents from the 'users' collection:
     #   users.remove

data/lib/mongo/connection.rb

@@ -119,7 +119,7 @@ module Mongo
       @logger   = options[:logger] || nil
       @options  = options
 
-      should_connect = options[:connect].nil? ? true : options[:connect]
+      should_connect = options.fetch(:connect, true)
       connect if should_connect
     end
 
@@ -376,7 +376,7 @@ module Mongo
     # @param [BSON::ByteBuffer] message a message to send to the database.
     # @param [String] log_message text version of +message+ for logging.
     #
-    # @return [True]
+    # @return [Integer] number of bytes sent
     def send_message(operation, message, log_message=nil)
       @logger.debug("  MONGODB #{log_message || message}") if @logger
       begin
@@ -398,7 +398,7 @@ module Mongo
     # @param [Hash] last_error_params parameters to be sent to getLastError. See DB#error for
     #   available options.
     #
-    # @see DB#error for valid last error params.
+    # @see DB#get_last_error for valid last error params.
     #
     # @return [Array]
     #   An array whose indexes include [0] documents returned, [1] number of document received,
@@ -812,12 +812,17 @@ module Mongo
 
     # Low-level method for sending a message on a socket.
     # Requires a packed message and an available socket,
+    #
+    # @return [Integer] number of bytes sent
     def send_message_on_socket(packed_message, socket)
       begin
+      total_bytes_sent = 0
       while packed_message.size > 0
         byte_sent = socket.send(packed_message, 0)
+        total_bytes_sent += byte_sent
         packed_message.slice!(0, byte_sent)
       end
+      total_bytes_sent
       rescue => ex
         close
         raise ConnectionFailure, "Operation failed with the following exception: #{ex}"

data/lib/mongo/db.rb

@@ -122,7 +122,7 @@ module Mongo
         }
       )
     end
-    
+
     # Removes stored Javascript function from the database.  Returns
     # false if the function does not exist
     #
@@ -136,7 +136,7 @@ module Mongo
         return false
       end
     end
-    
+
     # Adds a user to this database for use with authentication. If the user already
     # exists in the system, the password will be updated.
     #
@@ -276,6 +276,8 @@ module Mongo
       ok?(command(:drop => name))
     end
 
+    # @deprecated
+    #
     # Get the error message from the most recently executed database
     # operation for this connection.
     #
@@ -286,19 +288,36 @@ module Mongo
     # @return [String, Nil] either the text describing an error or nil if no
     #   error has occurred.
     def error(opts={})
+      warn "DB#error is deprecated. Please use DB#get_last_error instead"
       opts.assert_valid_keys(:w, :wtimeout, :fsync)
+      get_last_error(opts)['err']
+    end
+
+    # Run the getlasterror command with the specified replication options.
+    #
+    # @option opts [Boolean] :fsync (false)
+    # @option opts [Integer] :w (nil)
+    # @option opts [Integer] :wtimeout (nil)
+    #
+    # @return [Hash] the entire response to getlasterror.
+    #
+    # @raise [MongoDBError] if the operation fails.
+    def get_last_error(opts={})
       cmd = BSON::OrderedHash.new
       cmd[:getlasterror] = 1
-      cmd.merge!(opts) unless opts.empty?
+      cmd.merge!(opts)
       doc = command(cmd, :check_response => false)
       raise MongoDBError, "error retrieving last error: #{doc.inspect}" unless ok?(doc)
-      doc['err']
+      doc
     end
 
+    # @deprecated
+    #
     # Get status information from the last operation on this connection.
     #
     # @return [Hash] a hash representing the status of the last db op.
     def last_status
+      warn "DB#last_status is deprecated. Please use the equivalent DB#get_last_error instead"
       command(:getlasterror => 1)
     end
 
@@ -307,7 +326,7 @@ module Mongo
     #
     # @return [Boolean]
     def error?
-      error != nil
+      get_last_error['err'] != nil
     end
 
     # Get the most recent error to have occured on this database.
@@ -360,10 +379,9 @@ module Mongo
 
       oh = BSON::OrderedHash.new
       oh[:$eval] = code
-      oh[:args] = args
+      oh[:args]  = args
       doc = command(oh)
-      return doc['retval'] if ok?(doc)
-      raise OperationFailure, "eval failed: #{doc['errmsg']}"
+      doc['retval']
     end
 
     # Rename a collection.
@@ -372,13 +390,13 @@ module Mongo
     # @param [String] to new collection name.
     #
     # @return [True] returns +true+ on success.
-    # 
+    #
     # @raise MongoDBError if there's an error renaming the collection.
     def rename_collection(from, to)
       oh = BSON::OrderedHash.new
       oh[:renameCollection] = "#{@name}.#{from}"
       oh[:to] = "#{@name}.#{to}"
-      doc = DB.new('admin', @connection).command(oh)
+      doc = DB.new('admin', @connection).command(oh, :check_response => false)
       ok?(doc) || raise(MongoDBError, "Error renaming collection: #{doc.inspect}")
     end
 
@@ -415,7 +433,6 @@ module Mongo
       info
     end
 
-
     # Return stats on this database. Uses MongoDB's dbstats command.
     #
     # @return [Hash]
@@ -445,9 +462,6 @@ module Mongo
     # key, specifying the command to be performed. In Ruby 1.9, OrderedHash isn't necessary since
     # hashes are ordered by default.
     #
-    # @param [Boolean] admin If +true+, the command will be executed on the admin
-    # collection. DEPRECATED.
-    #
     # @option opts [Boolean] :check_response (true) If +true+, raises an exception if the
     # command fails.
     # @option opts [Socket] :sock a socket to use for sending the command. This is mainly for internal use.
@@ -455,8 +469,8 @@ module Mongo
     # @return [Hash]
     #
     # @core commands command_instance-method
-    def command(selector, opts={}, old_check_response=false, old_sock=nil)
-      check_response = opts[:check_response].nil? ? true : opts[:check_response]
+    def command(selector, opts={})
+      check_response = opts.fetch(:check_response, true)
       sock           = opts[:sock]
       raise MongoArgumentError, "command must be given a selector" unless selector.is_a?(Hash) && !selector.empty?
       if selector.keys.length > 1 && RUBY_VERSION < '1.9' && selector.class != BSON::OrderedHash
@@ -511,7 +525,7 @@ module Mongo
     def profiling_level
       oh = BSON::OrderedHash.new
       oh[:profile] = -1
-      doc = command(oh)
+      doc = command(oh, :check_response => false)
       raise "Error with profile command: #{doc.inspect}" unless ok?(doc) && doc['was'].kind_of?(Numeric)
       case doc['was'].to_i
       when 0
@@ -541,7 +555,7 @@ module Mongo
                      else
                        raise "Error: illegal profiling level value #{level}"
                      end
-      doc = command(oh)
+      doc = command(oh, :check_response => false)
       ok?(doc) || raise(MongoDBError, "Error with profile command: #{doc.inspect}")
     end
 
@@ -561,7 +575,7 @@ module Mongo
     # @raise [MongoDBError] if the command fails or there's a problem with the validation
     #   data, or if the collection is invalid.
     def validate_collection(name)
-      doc = command(:validate => name)
+      doc = command({:validate => name}, :check_response => false)
       raise MongoDBError, "Error with validate command: #{doc.inspect}" unless ok?(doc)
       result = doc['result']
       raise MongoDBError, "Error with validation data: #{doc.inspect}" unless result.kind_of?(String)

data/mongo.gemspec

@@ -1,4 +1,4 @@
-require "lib/mongo"
+require "./lib/mongo"
 
 Gem::Specification.new do |s|
   s.name = 'mongo'

data/test/{slave_connection_test.rb → auxillary/slave_connection_test.rb}

@@ -8,22 +8,22 @@ class SlaveConnectionTest < Test::Unit::TestCase
     @@host = ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost'
     @@port = ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT
     conn = Connection.new(@@host, @@port, :slave_ok => true)
-    cmd = conn['admin'].command(:ismaster => 1)
-    cmd['ok'] == 1 && cmd['ismaster'] != 1
+    response = conn['admin'].command(:ismaster => 1)
+    Mongo::Support.ok?(response) && response['ismaster'] != 1
   end
 
   if self.connect_to_slave
     puts "Connected to slave; running slave tests."
 
     def test_connect_to_slave
-      assert_raise Mongo::ConfigurationError do 
+      assert_raise Mongo::ConnectionFailure do
         @db = Connection.new(@@host, @@port, :slave_ok => false).db('ruby-mongo-demo')
       end
     end
 
     def test_slave_ok_sent_to_queries
-      @db   = Connection.new(@@host, @@port, :slave_ok => true).db('ruby-mongo-demo')
-      assert_equal true, @db.slave_ok?
+      @con = Connection.new(@@host, @@port, :slave_ok => true)
+      assert_equal true, @con.slave_ok?
     end
   else
     puts "Not connected to slave; skipping slave connection tests."

data/test/collection_test.rb

@@ -1,4 +1,4 @@
-require 'test/test_helper'
+require './test/test_helper'
 
 class TestCollection < Test::Unit::TestCase
   @@connection ||= Connection.new(ENV['MONGO_RUBY_DRIVER_HOST'] || 'localhost', ENV['MONGO_RUBY_DRIVER_PORT'] || Connection::DEFAULT_PORT)
@@ -139,24 +139,6 @@ class TestCollection < Test::Unit::TestCase
         @@test.remove({:foo => 2}, :safe => {:w => 2, :wtime => 1, :fsync => true})
       end
     end
-
-    def test_safe_mode_with_w_failure
-      assert_raise_error OperationFailure, "timed out waiting for slaves" do
-        @@test.insert({:foo => 1}, :safe => {:w => 2, :wtimeout => 1, :fsync => true})
-      end
-      assert_raise_error OperationFailure, "timed out waiting for slaves" do
-        @@test.update({:foo => 1}, {:foo => 2}, :safe => {:w => 2, :wtimeout => 1, :fsync => true})
-      end
-      assert_raise_error OperationFailure, "timed out waiting for slaves" do
-        @@test.remove({:foo => 2}, :safe => {:w => 2, :wtimeout => 1, :fsync => true})
-      end
-    end
-
-    def test_safe_mode_with_write_and_fsync
-      assert @@test.insert({:foo => 1}, :safe => {:w => 1, :wtimeout => 1, :fsync => true})
-      assert @@test.update({:foo => 1}, {:foo => 2}, :safe => {:w => 1, :wtimeout => 1, :fsync => true})
-      assert @@test.remove({:foo => 2}, :safe => {:w => 1, :wtimeout => 1, :fsync => true})
-    end
   end
 
   def test_update
@@ -259,6 +241,11 @@ class TestCollection < Test::Unit::TestCase
     @test.drop
   end
 
+  def test_remove_return_value
+    assert_equal 50, @@test.remove({})
+    assert_equal 57, @@test.remove({"x" => 1})
+  end
+
   def test_count
     @@test.drop
 

data/test/connection_test.rb

@@ -15,7 +15,7 @@ class TestConnection < Test::Unit::TestCase
   end
 
   def teardown
-    @mongo.db(MONGO_TEST_DB).error
+    @mongo[MONGO_TEST_DB].get_last_error
   end
 
   def test_slave_ok_with_multiple_nodes

data/test/cursor_test.rb

@@ -399,18 +399,18 @@ class CursorTest < Test::Unit::TestCase
 
   def test_cursor_invalid
     @@coll.remove
-    1000.times do |n|
+    10000.times do |n|
       @@coll.insert({:a => n})
     end
 
     cursor = @@coll.find({})
-    cursor.next_document
-    cursor.close
 
-    assert_raise_error(Mongo::OperationFailure, "CURSOR_NOT_FOUND") do
-      999.times do
+    assert_raise_error Mongo::OperationFailure, "CURSOR_NOT_FOUND" do
+      9999.times do
         cursor.next_document
+        cursor.instance_variable_set(:@cursor_id, 1234567890)
       end
     end
   end
+
 end

data/test/db_api_test.rb

@@ -19,7 +19,7 @@ class DBAPITest < Test::Unit::TestCase
 
   def teardown
     @@coll.remove
-    @@db.error
+    @@db.get_last_error
   end
 
   def test_clear

data/test/db_test.rb

@@ -1,3 +1,4 @@
+$:.unshift '.'
 require 'test/test_helper'
 require 'digest/md5'
 require 'stringio'
@@ -163,52 +164,34 @@ class DBTest < Test::Unit::TestCase
 
   def test_error
     @@db.reset_error_history
-    assert_nil @@db.error
+    assert_nil @@db.get_last_error['err']
     assert !@@db.error?
     assert_nil @@db.previous_error
 
     @@db.command({:forceerror => 1}, :check_response => false)
     assert @@db.error?
-    assert_not_nil @@db.error
+    assert_not_nil @@db.get_last_error['err']
     assert_not_nil @@db.previous_error
 
     @@db.command({:forceerror => 1}, :check_response => false)
     assert @@db.error?
-    assert @@db.error
+    assert @@db.get_last_error['err']
     prev_error = @@db.previous_error
     assert_equal 1, prev_error['nPrev']
-    assert_equal prev_error["err"], @@db.error
+    assert_equal prev_error["err"], @@db.get_last_error['err']
 
     @@db.collection('test').find_one
-    assert_nil @@db.error
+    assert_nil @@db.get_last_error['err']
     assert !@@db.error?
     assert @@db.previous_error
     assert_equal 2, @@db.previous_error['nPrev']
 
     @@db.reset_error_history
-    assert_nil @@db.error
+    assert_nil @@db.get_last_error['err']
     assert !@@db.error?
     assert_nil @@db.previous_error
   end
 
-  if @@version >= "1.5.1"
-    def test_failing_error_params
-      assert_raise_error Mongo::MongoDBError, "timed out waiting for slaves" do
-        @@db.error(:w => 2, :wtimeout => 10, :fsync => true)
-      end
-    end
-
-    def test_passing_error_params
-      assert_nil @@db.error(:w => 1, :wtimeout => 10, :fsync => true)
-    end
-
-    def test_invalid_error_params
-      assert_raise_error ArgumentError, "Unknown key(s): z" do
-        @@db.error(:z => 1, :wtimeout => 10, :fsync => true)
-      end
-    end
-  end
-
   def test_check_command_response
     command = {:forceerror => 1}
     assert_raise OperationFailure do 
@@ -256,6 +239,11 @@ class DBTest < Test::Unit::TestCase
     end
   end
 
+  def test_eval
+    @@db.eval("db.system.save({_id:'hello', value: function() { print('hello'); } })")
+    assert_equal 'hello', @@db['system'].find_one['_id']
+  end
+
   if @@version >= "1.3.5"
     def test_db_stats
       stats = @@db.stats

data/test/replica_sets/replication_ack_test.rb

@@ -0,0 +1,71 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mongo'
+require 'test/unit'
+require 'test/test_helper'
+
+# NOTE: This test expects a replica set of three nodes to be running on local host.
+class ReplicaSetAckTest < Test::Unit::TestCase
+  include Mongo
+
+  def setup
+    @conn = Mongo::Connection.multi([['localhost', 27017], ['localhost', 27018], ['localhost', 27019]])
+
+    master = [@conn.host, @conn.port]
+    @slaves = @conn.nodes - master
+
+    @slave1 = Mongo::Connection.new(@slaves[0][0], @slaves[0][1], :slave_ok => true)
+    @slave2 = Mongo::Connection.new(@slaves[1][0], @slaves[1][1], :slave_ok => true)
+
+    @db = @conn.db(MONGO_TEST_DB)
+    @db.drop_collection("test-sets")
+    @col = @db.collection("test-sets")
+  end
+
+  def test_safe_mode_with_w_failure
+    assert_raise_error OperationFailure, "timed out waiting for slaves" do
+      @col.insert({:foo => 1}, :safe => {:w => 4, :wtimeout => 1, :fsync => true})
+    end
+    assert_raise_error OperationFailure, "timed out waiting for slaves" do
+      @col.update({:foo => 1}, {:foo => 2}, :safe => {:w => 4, :wtimeout => 1, :fsync => true})
+    end
+    assert_raise_error OperationFailure, "timed out waiting for slaves" do
+      @col.remove({:foo => 2}, :safe => {:w => 4, :wtimeout => 1, :fsync => true})
+    end
+  end
+
+  def test_safe_mode_replication_ack
+    @col.insert({:baz => "bar"}, :safe => {:w => 3, :wtimeout => 1000})
+
+    assert @col.insert({:foo => "0" * 10000}, :safe => {:w => 3, :wtimeout => 1000})
+    assert_equal 2, @slave1[MONGO_TEST_DB]["test-sets"].count
+    assert_equal 2, @slave2[MONGO_TEST_DB]["test-sets"].count
+
+
+    assert @col.update({:baz => "bar"}, {:baz => "foo"}, :safe => {:w => 3, :wtimeout => 1000})
+    assert @slave1[MONGO_TEST_DB]["test-sets"].find_one({:baz => "foo"})
+    assert @slave2[MONGO_TEST_DB]["test-sets"].find_one({:baz => "foo"})
+
+    assert @col.remove({}, :safe => {:w => 3, :wtimeout => 1000})
+    assert_equal 0, @slave1[MONGO_TEST_DB]["test-sets"].count
+    assert_equal 0, @slave2[MONGO_TEST_DB]["test-sets"].count
+  end
+
+  def test_last_error_responses
+    20.times { @col.insert({:baz => "bar"}) }
+    response = @db.get_last_error(:w => 3, :wtimeout => 10000)
+    assert response['ok'] == 1
+    assert response['lastOp']
+
+    @col.update({}, {:baz => "foo"}, :multi => true)
+    response = @db.get_last_error(:w => 3, :wtimeout => 1000)
+    assert response['ok'] == 1
+    assert response['lastOp']
+
+    @col.remove({})
+    response =  @db.get_last_error(:w => 3, :wtimeout => 1000)
+    assert response['ok'] == 1
+    assert response['n'] == 20
+    assert response['lastOp']
+  end
+
+end

data/test/test_helper.rb

@@ -48,6 +48,8 @@ class Test::Unit::TestCase
     rescue => e
       assert_equal klass, e.class
       assert e.message.include?(message), "#{e.message} does not include #{message}."
+    else
+      flunk "Expected assertion #{klass} but none was raised."
     end
   end
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: mongo
 version: !ruby/object:Gem::Version 
-  hash: 27
   prerelease: false
   segments: 
   - 1
   - 0
-  - 6
-  version: 1.0.6
+  - 7
+  version: 1.0.7
 platform: ruby
 authors: 
 - Jim Menard
@@ -17,18 +16,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-26 00:00:00 -04:00
+date: 2010-08-05 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bson
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 31
         segments: 
         - 1
         - 0
@@ -76,38 +73,6 @@ files:
 - examples/types.rb
 - bin/bson_benchmark.rb
 - bin/fail_if_no_c.rb
-- test/auxillary/1.4_features.rb
-- test/auxillary/authentication_test.rb
-- test/auxillary/autoreconnect_test.rb
-- test/collection_test.rb
-- test/connection_test.rb
-- test/conversions_test.rb
-- test/cursor_fail_test.rb
-- test/cursor_message_test.rb
-- test/cursor_test.rb
-- test/db_api_test.rb
-- test/db_connection_test.rb
-- test/db_test.rb
-- test/grid_file_system_test.rb
-- test/grid_io_test.rb
-- test/grid_test.rb
-- test/replica_pairs/count_test.rb
-- test/replica_pairs/insert_test.rb
-- test/replica_pairs/pooled_insert_test.rb
-- test/replica_pairs/query_test.rb
-- test/replica_sets/count_test.rb
-- test/replica_sets/insert_test.rb
-- test/replica_sets/pooled_insert_test.rb
-- test/replica_sets/query_test.rb
-- test/slave_connection_test.rb
-- test/support_test.rb
-- test/test_helper.rb
-- test/threading/test_threading_large_pool.rb
-- test/threading_test.rb
-- test/unit/collection_test.rb
-- test/unit/connection_test.rb
-- test/unit/cursor_test.rb
-- test/unit/db_test.rb
 has_rdoc: true
 homepage: http://www.mongodb.org
 licenses: []
@@ -120,27 +85,23 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ruby driver for the MongoDB
@@ -148,6 +109,7 @@ test_files:
 - test/auxillary/1.4_features.rb
 - test/auxillary/authentication_test.rb
 - test/auxillary/autoreconnect_test.rb
+- test/auxillary/slave_connection_test.rb
 - test/collection_test.rb
 - test/connection_test.rb
 - test/conversions_test.rb
@@ -168,7 +130,7 @@ test_files:
 - test/replica_sets/insert_test.rb
 - test/replica_sets/pooled_insert_test.rb
 - test/replica_sets/query_test.rb
-- test/slave_connection_test.rb
+- test/replica_sets/replication_ack_test.rb
 - test/support_test.rb
 - test/test_helper.rb
 - test/threading/test_threading_large_pool.rb