mongo 2.11.1 → 2.11.2

data/lib/mongo/server/description.rb

@@ -33,6 +33,7 @@ module Mongo
       # Constant for reading arbiter info from config.
       #
       # @since 2.0.0
+      # @deprecated
       ARBITER = 'arbiterOnly'.freeze
 
       # Constant for reading arbiters info from config.
@@ -53,16 +54,19 @@ module Mongo
       # Constant for the key for the message value.
       #
       # @since 2.0.0
+      # @deprecated
       MESSAGE = 'msg'.freeze
 
       # Constant for the message that indicates a sharded cluster.
       #
       # @since 2.0.0
+      # @deprecated
       MONGOS_MESSAGE = 'isdbgrid'.freeze
 
       # Constant for determining ghost servers.
       #
       # @since 2.0.0
+      # @deprecated
       REPLICA_SET = 'isreplicaset'.freeze
 
       # Constant for reading max bson size info from config.
@@ -129,6 +133,7 @@ module Mongo
       # Constant for reading primary info from config.
       #
       # @since 2.0.0
+      # @deprecated
       PRIMARY = 'ismaster'.freeze
 
       # Constant for reading primary host field from config.
@@ -139,6 +144,7 @@ module Mongo
       # Constant for reading secondary info from config.
       #
       # @since 2.0.0
+      # @deprecated
       SECONDARY = 'secondary'.freeze
 
       # Constant for reading replica set name info from config.
@@ -227,7 +233,7 @@ module Mongo
       # @return [ Float ] The moving average time the ismaster call took to complete.
       attr_reader :average_round_trip_time
 
-      # Will return true if the server is an arbiter.
+      # Returns whether this server is an arbiter, per the SDAM spec.
       #
       # @example Is the server an arbiter?
       #   description.arbiter?
@@ -236,7 +242,9 @@ module Mongo
       #
       # @since 2.0.0
       def arbiter?
-        ok? && !!config[ARBITER] && !replica_set_name.nil?
+        ok? &&
+        config['arbiterOnly'] == true &&
+        !!config['setName']
       end
 
       # Get a list of all arbiters in the replica set.
@@ -251,7 +259,7 @@ module Mongo
         @arbiters ||= (config[ARBITERS] || []).map { |s| s.downcase }
       end
 
-      # Is the server a ghost in a replica set?
+      # Whether this server is a ghost, per the SDAM spec.
       #
       # @example Is the server a ghost?
       #   description.ghost?
@@ -260,7 +268,8 @@ module Mongo
       #
       # @since 2.0.0
       def ghost?
-        ok? && !!config[REPLICA_SET]
+        ok? &&
+        config['isreplicaset'] == true
       end
 
       # Will return true if the server is hidden.
@@ -431,7 +440,7 @@ module Mongo
         config[LOGICAL_SESSION_TIMEOUT_MINUTES] if config[LOGICAL_SESSION_TIMEOUT_MINUTES]
       end
 
-      # Is the server a mongos?
+      # Returns whether this server is a mongos, per the SDAM spec.
       #
       # @example Is the server a mongos?
       #   description.mongos?
@@ -440,10 +449,10 @@ module Mongo
       #
       # @since 2.0.0
       def mongos?
-        ok? && config[MESSAGE] == MONGOS_MESSAGE
+        ok? && config['msg'] == 'isdbgrid'
       end
 
-      # Is the description of type other.
+      # Returns whether the server is an other, per the SDAM spec.
       #
       # @example Is the description of type other.
       #   description.other?
@@ -455,11 +464,11 @@ module Mongo
         # The SDAM spec is slightly confusing on what "other" means,
         # but it's referred to it as "RSOther" which means a non-RS member
         # cannot be "other".
-        if unknown? || replica_set_name.nil?
-          return false
-        end
-        (!primary? && !secondary? && !passive? && !arbiter?) ||
-          (hidden? && !replica_set_name.nil?)
+        ok? &&
+        !!config['setName'] && (
+          config['hidden'] == true ||
+          !primary? && !secondary? && !arbiter?
+        )
       end
 
       # Will return true if the server is passive.
@@ -498,7 +507,7 @@ module Mongo
         config[PRIMARY_HOST] && config[PRIMARY_HOST].downcase
       end
 
-      # Will return true if the server is a primary.
+      # Returns whether this server is a primary, per the SDAM spec.
       #
       # @example Is the server a primary?
       #   description.primary?
@@ -508,9 +517,8 @@ module Mongo
       # @since 2.0.0
       def primary?
         ok? &&
-          !!config[PRIMARY] &&
-          (primary_host.nil? || primary_host == address.to_s) &&
-          !replica_set_name.nil?
+        config['ismaster'] == true &&
+        !!config['setName']
       end
 
       # Get the name of the replica set the server belongs to, returns nil if
@@ -538,7 +546,7 @@ module Mongo
         hosts + arbiters + passives
       end
 
-      # Will return true if the server is a secondary.
+      # Returns whether this server is a secondary, per the SDAM spec.
       #
       # @example Is the server a secondary?
       #   description.secondary?
@@ -547,7 +555,9 @@ module Mongo
       #
       # @since 2.0.0
       def secondary?
-        ok? && !!config[SECONDARY] && !replica_set_name.nil?
+        ok? &&
+        config['secondary'] == true &&
+        !!config['setName']
       end
 
       # Returns the server type as a symbol.
@@ -569,7 +579,7 @@ module Mongo
         :unknown
       end
 
-      # Is this server a standalone server?
+      # Returns whether this server is a standalone, per the SDAM spec.
       #
       # @example Is the server standalone?
       #   description.standalone?
@@ -578,10 +588,13 @@ module Mongo
       #
       # @since 2.0.0
       def standalone?
-        replica_set_name.nil? && !mongos? && !ghost? && !unknown?
+        ok? &&
+        config['msg'] != 'isdbgrid' &&
+        config['setName'].nil? &&
+        config['isreplicaset'] != true
       end
 
-      # Is the server description currently unknown?
+      # Returns whether this server is an unknown, per the SDAM spec.
       #
       # @example Is the server description unknown?
       #   description.unknown?

data/lib/mongo/session.rb

@@ -881,21 +881,21 @@ module Mongo
       end
     end
 
-    # Validate the session.
+    # Validate the session for use by the specified client.
     #
-    # @example
-    #   session.validate!(cluster)
+    # The session must not be ended and must have been created by a client
+    # with the same cluster as the client that the session is to be used with.
     #
-    # @param [ Cluster ] cluster The cluster the session is attempted to be used with.
+    # @param [ Client ] client The client the session is to be used with.
     #
-    # @return [ nil ] nil if the session is valid.
+    # @return [ Session ] self, if the session is valid.
     #
-    # @raise [ Mongo::Error::InvalidSession ] Raise error if the session is not valid.
+    # @raise [ Mongo::Error::InvalidSession ] Exception raised if the session is not valid.
     #
     # @since 2.5.0
     # @api private
-    def validate!(cluster)
-      check_matching_cluster!(cluster)
+    def validate!(client)
+      check_matching_cluster!(client)
       check_if_ended!
       self
     end
@@ -1041,8 +1041,8 @@ module Mongo
       raise Mongo::Error::InvalidSession.new(SESSION_ENDED_ERROR_MSG) if ended?
     end
 
-    def check_matching_cluster!(cluster)
-      if @client.cluster != cluster
+    def check_matching_cluster!(client)
+      if @client.cluster != client.cluster
         raise Mongo::Error::InvalidSession.new(MISMATCHED_CLUSTER_ERROR_MSG)
       end
     end

data/lib/mongo/version.rb

@@ -17,5 +17,5 @@ module Mongo
   # The current version of the driver.
   #
   # @since 2.0.0
-  VERSION = '2.11.1'.freeze
+  VERSION = '2.11.2'.freeze
 end

data/spec/README.md

@@ -74,6 +74,19 @@ configuration is needed:
 
     rake
 
+### Replica Set With Arbiter
+
+Some tests require an arbiter to be present in the replica set. Such a
+deployment can be obtained by providing `--arbiter` argument to mlaunch:
+
+    mlaunch init --replicaset --arbiter --name ruby-driver-rs \
+      --dir /tmp/mdb-rs --setParameter enableTestCommands=1
+
+To indicate to the test suite that the deployment contains an arbiter, set
+HAVE_ARBITER environment variable as follows:
+
+    HAVE_ARBITER=1 rake
+
 ### Sharded Cluster
 
 A sharded cluster can be configured with mlaunch:

data/spec/integration/auth_spec.rb

@@ -41,7 +41,7 @@ describe 'Auth' do
           it 'indicates scram-sha-1 was used' do
             expect do
               connection.connect!
-            end.to raise_error(Mongo::Auth::Unauthorized, /User nonexistent_user \(mechanism: scram\) is not authorized to access admin.*\(used mechanism: SCRAM-SHA-1\)/)
+            end.to raise_error(Mongo::Auth::Unauthorized, /User nonexistent_user \(mechanism: scram\) is not authorized to access admin.*used mechanism: SCRAM-SHA-1/)
           end
         end
 
@@ -53,7 +53,7 @@ describe 'Auth' do
           it 'indicates scram-sha-1 was used' do
             expect do
               connection.connect!
-            end.to raise_error(Mongo::Auth::Unauthorized, /User nonexistent_user \(mechanism: scram\) is not authorized to access admin.*\(used mechanism: SCRAM-SHA-1\)/)
+            end.to raise_error(Mongo::Auth::Unauthorized, /User nonexistent_user \(mechanism: scram\) is not authorized to access admin.*used mechanism: SCRAM-SHA-1/)
           end
         end
       end
@@ -73,7 +73,7 @@ describe 'Auth' do
           it 'indicates scram-sha-1 was used' do
             expect do
               connection.connect!
-            end.to raise_error(Mongo::Auth::Unauthorized, /User existing_user \(mechanism: scram\) is not authorized to access admin.*\(used mechanism: SCRAM-SHA-1\)/)
+            end.to raise_error(Mongo::Auth::Unauthorized, /User existing_user \(mechanism: scram\) is not authorized to access admin.*used mechanism: SCRAM-SHA-1/)
           end
         end
 
@@ -85,7 +85,7 @@ describe 'Auth' do
           it 'indicates scram-sha-256 was used' do
             expect do
               connection.connect!
-            end.to raise_error(Mongo::Auth::Unauthorized, /User existing_user \(mechanism: scram256\) is not authorized to access admin.*\(used mechanism: SCRAM-SHA-256\)/)
+            end.to raise_error(Mongo::Auth::Unauthorized, /User existing_user \(mechanism: scram256\) is not authorized to access admin.*used mechanism: SCRAM-SHA-256/)
           end
         end
       end
@@ -101,7 +101,7 @@ describe 'Auth' do
         it 'indicates scram-sha-1 was requested and used' do
           expect do
             connection.connect!
-          end.to raise_error(Mongo::Auth::Unauthorized, /User nonexistent_user \(mechanism: scram\) is not authorized to access admin.*\(used mechanism: SCRAM-SHA-1\)/)
+          end.to raise_error(Mongo::Auth::Unauthorized, /User nonexistent_user \(mechanism: scram\) is not authorized to access admin.*used mechanism: SCRAM-SHA-1/)
         end
       end
 
@@ -114,7 +114,7 @@ describe 'Auth' do
         it 'indicates scram-sha-256 was requested and used' do
           expect do
             connection.connect!
-          end.to raise_error(Mongo::Auth::Unauthorized, /User nonexistent_user \(mechanism: scram256\) is not authorized to access admin.*\(used mechanism: SCRAM-SHA-256\)/)
+          end.to raise_error(Mongo::Auth::Unauthorized, /User nonexistent_user \(mechanism: scram256\) is not authorized to access admin.*used mechanism: SCRAM-SHA-256/)
         end
       end
     end
@@ -123,10 +123,29 @@ describe 'Auth' do
       let(:options) { SpecConfig.instance.ssl_options.merge(
         user: 'nonexistent_user', password: 'foo') }
 
-      it 'reports auth source used' do
+      it 'reports which server authentication was attempted against' do
         expect do
           connection.connect!
-        end.to raise_error(Mongo::Auth::Unauthorized, /User nonexistent_user.*is not authorized to access admin \(auth source: admin\)/)
+        end.to raise_error(Mongo::Auth::Unauthorized, /used server: #{connection.address.to_s}/)
+      end
+
+      context 'with default auth source' do
+        it 'reports auth source used' do
+          expect do
+            connection.connect!
+          end.to raise_error(Mongo::Auth::Unauthorized, /auth source: admin/)
+        end
+      end
+
+      context 'with custom auth source' do
+        let(:options) { SpecConfig.instance.ssl_options.merge(
+          user: 'nonexistent_user', password: 'foo', auth_source: 'authdb') }
+
+        it 'reports auth source used' do
+          expect do
+            connection.connect!
+          end.to raise_error(Mongo::Auth::Unauthorized, /auth source: authdb/)
+        end
       end
     end
 

data/spec/integration/client_construction_spec.rb

@@ -82,6 +82,20 @@ describe 'Client construction' do
       expect(client.cluster.topology).to be_a(Mongo::Cluster::Topology::Single)
       expect(client.options[:connect]).to eq :direct
     end
+
+    context 'direct connection with mismached me' do
+      let(:address) { ClusterConfig.instance.alternate_address.to_s }
+
+      let(:client) do
+        new_local_client([address], SpecConfig.instance.test_options)
+      end
+
+      let(:server) { client.cluster.next_primary }
+
+      it 'sets server type to primary' do
+        expect(server.description).to be_primary
+      end
+    end
   end
 
   context 'in sharded topology' do

data/spec/mongo/auth/ldap/conversation_spec.rb

@@ -17,7 +17,7 @@ describe Mongo::Auth::LDAP::Conversation do
   describe '#start' do
 
     let(:query) do
-      conversation.start
+      conversation.start(nil)
     end
 
     let(:selector) do

data/spec/mongo/auth/scram/conversation_spec.rb

@@ -7,6 +7,15 @@ describe Mongo::Auth::SCRAM::Conversation, retry: 3 do
     described_class.new(user, mechanism)
   end
 
+  let(:connection) do
+    double('connection').tap do |connection|
+      features = double('features')
+      allow(features).to receive(:op_msg_enabled?)
+      allow(connection).to receive(:features).and_return(features)
+      allow(connection).to receive(:server)
+    end
+  end
+
   context 'when SCRAM-SHA-1 is used' do
     min_server_fcv '3.0'
 
@@ -28,7 +37,7 @@ describe Mongo::Auth::SCRAM::Conversation, retry: 3 do
     describe '#start' do
 
       let(:query) do
-        conversation.start
+        conversation.start(nil)
       end
 
       before do
@@ -85,7 +94,7 @@ describe Mongo::Auth::SCRAM::Conversation, retry: 3 do
         end
 
         let(:query) do
-          conversation.continue(reply)
+          conversation.continue(reply, connection)
         end
 
         let(:selector) do
@@ -117,7 +126,7 @@ describe Mongo::Auth::SCRAM::Conversation, retry: 3 do
 
         it 'raises an error' do
           expect {
-            conversation.continue(reply)
+            conversation.continue(reply, connection)
           }.to raise_error(Mongo::Error::InvalidNonce)
         end
       end
@@ -170,8 +179,8 @@ describe Mongo::Auth::SCRAM::Conversation, retry: 3 do
         end
 
         let(:query) do
-          conversation.continue(continue_reply)
-          conversation.finalize(reply)
+          conversation.continue(continue_reply, connection)
+          conversation.finalize(reply, connection)
         end
 
         let(:selector) do
@@ -199,8 +208,8 @@ describe Mongo::Auth::SCRAM::Conversation, retry: 3 do
 
         it 'raises an error' do
           expect {
-            conversation.continue(continue_reply)
-            conversation.finalize(reply)
+            conversation.continue(continue_reply, connection)
+            conversation.finalize(reply, connection)
           }.to raise_error(Mongo::Error::InvalidSignature)
         end
       end
@@ -226,7 +235,7 @@ describe Mongo::Auth::SCRAM::Conversation, retry: 3 do
     describe '#start' do
 
       let(:query) do
-        conversation.start
+        conversation.start(nil)
       end
 
       before do
@@ -283,7 +292,7 @@ describe Mongo::Auth::SCRAM::Conversation, retry: 3 do
         end
 
         let(:query) do
-          conversation.continue(reply)
+          conversation.continue(reply, connection)
         end
 
         let(:selector) do
@@ -315,7 +324,7 @@ describe Mongo::Auth::SCRAM::Conversation, retry: 3 do
 
         it 'raises an error' do
           expect {
-            conversation.continue(reply)
+            conversation.continue(reply, connection)
           }.to raise_error(Mongo::Error::InvalidNonce)
         end
       end
@@ -368,8 +377,8 @@ describe Mongo::Auth::SCRAM::Conversation, retry: 3 do
         end
 
         let(:query) do
-          conversation.continue(continue_reply)
-          conversation.finalize(reply)
+          conversation.continue(continue_reply, connection)
+          conversation.finalize(reply, connection)
         end
 
         let(:selector) do
@@ -397,8 +406,8 @@ describe Mongo::Auth::SCRAM::Conversation, retry: 3 do
 
         it 'raises an error' do
           expect {
-            conversation.continue(continue_reply)
-            conversation.finalize(reply)
+            conversation.continue(continue_reply, connection)
+            conversation.finalize(reply, connection)
           }.to raise_error(Mongo::Error::InvalidSignature)
         end
       end