mongo 2.17.4 → 2.18.0.beta1

data/spec/mongo/client_construction_spec.rb

@@ -211,7 +211,7 @@ describe Mongo::Client do
             let(:kms_providers) { nil }
 
             it 'raises an exception' do
-              expect { client }.to raise_error(ArgumentError, /kms_providers option must not be nil/)
+              expect { client }.to raise_error(ArgumentError, /KMS providers options must not be nil/)
             end
           end
 
@@ -219,7 +219,7 @@ describe Mongo::Client do
             let(:kms_providers) { { random_key: 'hello' } }
 
             it 'raises an exception' do
-              expect { client }.to raise_error(ArgumentError, /kms_providers option must have one of the following keys: :aws, :local/)
+              expect { client }.to raise_error(ArgumentError, /KMS providers options must have one of the following keys: :aws, :azure, :gcp, :kmip, :local/)
             end
           end
 
@@ -227,7 +227,7 @@ describe Mongo::Client do
             let(:kms_providers) { { local: { wrong_key: 'hello' } } }
 
             it 'raises an exception' do
-              expect { client }.to raise_error(ArgumentError, /kms_providers with :local key must be in the format: { local: { key: 'MASTER-KEY' } }/)
+              expect { client }.to raise_error(ArgumentError, /Local KMS provider options must be in the format: { key: 'MASTER-KEY' }/)
             end
           end
 
@@ -235,7 +235,7 @@ describe Mongo::Client do
             let(:kms_providers) { { aws: { wrong_key: 'hello' } } }
 
             it 'raises an exception' do
-              expect { client }.to raise_error(ArgumentError, /kms_providers with :aws key must be in the format: { aws: { access_key_id: 'YOUR-ACCESS-KEY-ID', secret_access_key: 'SECRET-ACCESS-KEY' } }/)
+              expect { client }.to raise_error(ArgumentError, / AWS KMS provider options must be in the format: { access_key_id: 'YOUR-ACCESS-KEY-ID', secret_access_key: 'SECRET-ACCESS-KEY' }/)
             end
           end
 
@@ -285,9 +285,9 @@ describe Mongo::Client do
                 }
               end
 
-              it 'sets key_vault_client as a clone of self with no encryption options' do
+              it 'sets key_vault_client with no encryption options' do
                 key_vault_client = client.encrypter.key_vault_client
-                expect(key_vault_client).to eq(client)
+                expect(key_vault_client.options['auto_encryption_options']).to be_nil
               end
 
               it 'sets bypass_auto_encryption to false' do
@@ -447,7 +447,8 @@ describe Mongo::Client do
             end.should_not raise_error
           end
 
-          it 'fails operations due to very small timeout', retry: 3 do
+          retry_test
+          it 'fails operations due to very small timeout' do
             lambda do
               client.database.command(ping: 1)
             end.should raise_error(Mongo::Error::SocketTimeoutError)
@@ -1513,6 +1514,139 @@ describe Mongo::Client do
             end
           end
         end
+
+        context 'srv_max_hosts > 0 and load_balanced: true' do
+          let(:client) do
+            new_local_client_nmio(['127.0.0.1:27017'],
+               srv_max_hosts: 1, load_balanced: true)
+          end
+
+          it 'it is rejected' do
+            expect do
+              client
+            end.to raise_error(ArgumentError, /:srv_max_hosts > 0 cannot be used with :load_balanced=true/)
+          end
+        end
+
+        context 'srv_max_hosts > 0 and replica_set' do
+          let(:client) do
+            new_local_client_nmio(['127.0.0.1:27017'],
+              srv_max_hosts: 1, replica_set: 'rs')
+          end
+
+          it 'it is rejected' do
+            expect do
+              client
+            end.to raise_error(ArgumentError, /:srv_max_hosts > 0 cannot be used with :replica_set option/)
+          end
+        end
+
+        context 'srv_max_hosts < 0' do
+          let(:client) do
+            new_local_client_nmio(['127.0.0.1:27017'],
+               srv_max_hosts: -1)
+          end
+
+          it 'is accepted and does not add the srv_max_hosts to uri_options' do
+            lambda do
+              client
+            end.should_not raise_error
+            expect(client.options).to_not have_key(:srv_max_hosts)
+          end
+        end
+
+        context 'srv_max_hosts invalid type' do
+          let(:client) do
+            new_local_client_nmio(['127.0.0.1:27017'],
+               srv_max_hosts: 'foo')
+          end
+
+          it 'is accepted and does not add the srv_max_hosts to uri_options' do
+            lambda do
+              client
+            end.should_not raise_error
+            expect(client.options).to_not have_key(:srv_max_hosts)
+          end
+        end
+
+        context 'srv_max_hosts with non-SRV URI' do
+          let(:client) do
+            new_local_client_nmio(['127.0.0.1:27017'],
+               srv_max_hosts: 1)
+          end
+
+          it 'is rejected' do
+            lambda do
+              client
+            end.should raise_error(ArgumentError, /:srv_max_hosts cannot be used on non-SRV URI/)
+          end
+        end
+
+        context 'srv_service_name with non-SRV URI' do
+          let(:client) do
+            new_local_client_nmio(['127.0.0.1:27017'],
+               srv_service_name: "customname")
+          end
+
+          it 'is rejected' do
+            lambda do
+              client
+            end.should raise_error(ArgumentError, /:srv_service_name cannot be used on non-SRV URI/)
+          end
+        end
+      end
+
+      context 'with SRV lookups mocked at Resolver' do
+        let(:srv_result) do
+          double('srv result').tap do |result|
+            allow(result).to receive(:empty?).and_return(false)
+            allow(result).to receive(:address_strs).and_return(
+              [ClusterConfig.instance.primary_address_str])
+          end
+        end
+
+        let(:client) do
+          allow_any_instance_of(Mongo::Srv::Resolver).to receive(:get_records).and_return(srv_result)
+          allow_any_instance_of(Mongo::Srv::Resolver).to receive(:get_txt_options_string)
+
+          new_local_client_nmio('mongodb+srv://foo.a.b', options)
+        end
+
+        context "when setting srv_max_hosts" do
+          let(:srv_max_hosts) { 1 }
+          let(:options) { { srv_max_hosts: srv_max_hosts } }
+
+          it 'is accepted and sets srv_max_hosts' do
+            lambda do
+              client
+            end.should_not raise_error
+            expect(client.options[:srv_max_hosts]).to eq(srv_max_hosts)
+          end
+        end
+
+        context "when setting srv_max_hosts to 0" do
+          let(:srv_max_hosts) { 0 }
+          let(:options) { { srv_max_hosts: srv_max_hosts } }
+
+          it 'is accepted sets srv_max_hosts' do
+            lambda do
+              client
+            end.should_not raise_error
+            expect(client.options[:srv_max_hosts]).to eq(srv_max_hosts)
+          end
+        end
+
+        context "when setting srv_service_name" do
+          let(:srv_service_name) { 'customname' }
+          let(:options) { { srv_service_name: srv_service_name } }
+
+          it 'is accepted and sets srv_service_name' do
+            lambda do
+              client
+            end.should_not raise_error
+            expect(client.options[:srv_service_name]).to eq(srv_service_name)
+          end
+        end
       end
 
       context ':bg_error_backtrace option' do

data/spec/mongo/client_encryption_spec.rb

@@ -68,7 +68,7 @@ describe Mongo::ClientEncryption do
       it 'raises an exception' do
         expect do
           client_encryption
-        end.to raise_error(ArgumentError, /kms_providers option must have one of the following keys/)
+        end.to raise_error(ArgumentError, /KMS providers options must have one of the following keys/)
       end
     end
   end
@@ -144,7 +144,7 @@ describe Mongo::ClientEncryption do
         it 'raises an exception' do
           expect do
             data_key_id
-          end.to raise_error(ArgumentError, /options cannot be nil/)
+          end.to raise_error(ArgumentError, /Key document options must not be nil/)
         end
       end
 
@@ -154,7 +154,7 @@ describe Mongo::ClientEncryption do
         it 'raises an exception' do
           expect do
             data_key_id
-          end.to raise_error(ArgumentError, /options Hash must contain a key named :master_key/)
+          end.to raise_error(ArgumentError, /Key document options must contain a key named :master_key with a Hash value/)
         end
       end
 
@@ -164,7 +164,7 @@ describe Mongo::ClientEncryption do
         it 'raises an exception' do
           expect do
             data_key_id
-          end.to raise_error(ArgumentError, /The :master_key option cannot be nil/)
+          end.to raise_error(ArgumentError, /Key document options must contain a key named :master_key with a Hash value/)
         end
       end
 
@@ -174,7 +174,7 @@ describe Mongo::ClientEncryption do
         it 'raises an exception' do
           expect do
             data_key_id
-          end.to raise_error(ArgumentError, /master-key is an invalid :master_key option/)
+          end.to raise_error(ArgumentError, /Key document options must contain a key named :master_key with a Hash value/)
         end
       end
 
@@ -184,7 +184,7 @@ describe Mongo::ClientEncryption do
         it 'raises an exception' do
           expect do
             data_key_id
-          end.to raise_error(ArgumentError, /The value of :region option of the :master_key options hash cannot be nil/)
+          end.to raise_error(ArgumentError, /The specified KMS provider options are invalid: {}. AWS key document  must be in the format: { region: 'REGION', key: 'KEY' }/)
         end
       end
 
@@ -194,7 +194,7 @@ describe Mongo::ClientEncryption do
         it 'raises an exception' do
           expect do
             data_key_id
-          end.to raise_error(ArgumentError, /The value of :region option of the :master_key options hash cannot be nil/)
+          end.to raise_error(ArgumentError, /The region option must be a String with at least one character; currently have nil/)
         end
       end
 
@@ -204,7 +204,7 @@ describe Mongo::ClientEncryption do
         it 'raises an exception' do
           expect do
             data_key_id
-          end.to raise_error(ArgumentError, /5 is an invalid AWS master_key region. The value of :region option of the :master_key options hash must be a String/)
+          end.to raise_error(ArgumentError, /The region option must be a String with at least one character; currently have 5/)
         end
       end
 
@@ -214,7 +214,7 @@ describe Mongo::ClientEncryption do
         it 'raises an exception' do
           expect do
             data_key_id
-          end.to raise_error(ArgumentError, /The value of :key option of the :master_key options hash cannot be nil/)
+          end.to raise_error(ArgumentError, /The key option must be a String with at least one character; currently have nil/)
         end
       end
 
@@ -224,7 +224,7 @@ describe Mongo::ClientEncryption do
         it 'raises an exception' do
           expect do
             data_key_id
-          end.to raise_error(ArgumentError, /5 is an invalid AWS master_key key. The value of :key option of the :master_key options hash must be a String/)
+          end.to raise_error(ArgumentError, /The key option must be a String with at least one character; currently have 5/)
         end
       end
 
@@ -234,7 +234,7 @@ describe Mongo::ClientEncryption do
         it 'raises an exception' do
           expect do
             data_key_id
-          end.to raise_error(ArgumentError, /5 is an invalid AWS master_key endpoint. The value of :endpoint option of the :master_key options hash must be a String/)
+          end.to raise_error(ArgumentError, /The endpoint option must be a String with at least one character; currently have 5/)
         end
       end
 

data/spec/mongo/client_spec.rb

@@ -8,6 +8,14 @@ require 'spec_helper'
 
 describe Mongo::Client do
 
+  let(:subscriber) { Mrss::EventSubscriber.new }
+
+  let(:monitored_client) do
+    root_authorized_client.tap do |client|
+      client.subscribe(Mongo::Monitoring::COMMAND, subscriber)
+    end
+  end
+
   describe '#==' do
 
     let(:client) do
@@ -584,6 +592,18 @@ describe Mongo::Client do
         expect(result.first).to eq(filter[:name])
       end
     end
+
+    context 'with comment' do
+      min_server_version '4.4'
+
+      it 'returns a list of database names and send comment' do
+        result = monitored_client.database_names({}, comment: "comment")
+        expect(result).to include('admin')
+        command = subscriber.command_started_events("listDatabases").last&.command
+        expect(command).not_to be_nil
+        expect(command["comment"]).to eq("comment")
+      end
+    end
   end
 
   describe '#list_databases' do
@@ -677,6 +697,20 @@ describe Mongo::Client do
         expect(command[:authorizedDatabases]).to be_nil
       end
     end
+
+    context 'with comment' do
+      min_server_version '4.4'
+
+      it 'returns a list of database names and send comment' do
+        result = monitored_client.list_databases({}, false, comment: "comment").collect do |i|
+          i['name']
+        end
+        expect(result).to include('admin')
+        command = subscriber.command_started_events("listDatabases").last&.command
+        expect(command).not_to be_nil
+        expect(command["comment"]).to eq("comment")
+      end
+    end
   end
 
   describe '#list_mongo_databases' do
@@ -719,6 +753,18 @@ describe Mongo::Client do
         expect(result.first.name).to eq(filter[:name])
       end
     end
+
+    context 'with comment' do
+      min_server_version '4.4'
+
+      it 'returns a list of database names and send comment' do
+        result = monitored_client.list_mongo_databases({}, comment: "comment")
+        expect(result).to all(be_a(Mongo::Database))
+        command = subscriber.command_started_events("listDatabases").last&.command
+        expect(command).not_to be_nil
+        expect(command["comment"]).to eq("comment")
+      end
+    end
   end
 
   describe '#close' do
@@ -790,7 +836,8 @@ describe Mongo::Client do
         expect(session).to be_a(Mongo::Session)
       end
 
-      it 'sets the last use field to the current time', retry: 4 do
+      retry_test 4
+      it 'sets the last use field to the current time' do
         expect(session.instance_variable_get(:@server_session).last_use).to be_within(1).of(Time.now)
       end
 
@@ -873,6 +920,255 @@ describe Mongo::Client do
           expect(before_last_use).to be < (pool.instance_variable_get(:@queue)[0].last_use)
         end
       end
+
+      context 'when an implicit session is used without enough connections' do
+        require_no_multi_mongos
+        require_wired_tiger
+
+        let(:client) do
+          authorized_client.with(options).tap do |cl|
+            cl.subscribe(Mongo::Monitoring::COMMAND, subscriber)
+          end
+        end
+
+        let(:options) do
+          { :max_pool_size => 1, :retry_writes => true }
+        end
+
+        shared_examples "a single connection" do
+          # JRuby, due to being concurrent, does not like rspec setting mocks
+          # in threads while other threads are calling the methods being mocked.
+          # My theory is that rspec removes & redefines methods as part of
+          # the mocking process, but while a method is undefined JRuby is
+          # running another thread that calls it leading to this exception:
+          # NoMethodError: undefined method `with_connection' for #<Mongo::Server:0x5386 address=localhost:27017 PRIMARY>
+          fails_on_jruby
+
+          before do
+            sessions_checked_out = 0
+
+            allow_any_instance_of(Mongo::Server).to receive(:with_connection).and_wrap_original do |m, *args, &block|
+              m.call(*args) do |connection|
+                sessions_checked_out = 0
+                res = block.call(connection)
+                expect(sessions_checked_out).to be < 2
+                res
+              end
+            end
+
+            allow_any_instance_of(Mongo::Session).to receive(:materialize).and_wrap_original do |m, *args|
+              sessions_checked_out += 1
+              m.call(*args).tap do
+                checked_out_connections = args[0].connection_pool.instance_variable_get("@checked_out_connections")
+                expect(checked_out_connections.length).to eq 1
+              end
+            end
+          end
+
+          it 'doesn\'t have any live sessions' do
+            threads.each do |thread|
+              thread.join
+            end
+          end
+        end
+
+        context "when doing three inserts" do
+          let(:threads) do
+            (1..3).map do |i|
+              Thread.new do
+                client['test'].insert_one({test: "test#{i}"})
+              end
+            end
+          end
+
+          include_examples "a single connection"
+        end
+
+        context "when doing an insert and two updates" do
+          let(:threads) do
+            threads = []
+            threads << Thread.new do
+              client['test'].insert_one({test: "test"})
+            end
+            threads << Thread.new do
+              client['test'].update_one({test: "test"}, { "$set" => { test: "test2" } })
+            end
+            threads << Thread.new do
+              client['test'].update_one({test: "test"}, { "$set" => { test: "test2" } })
+            end
+            threads
+          end
+
+          include_examples "a single connection"
+        end
+
+        context "when doing an insert, update and delete" do
+          let(:threads) do
+            threads = []
+            threads << Thread.new do
+              client['test'].insert_one({test: "test"})
+            end
+            threads << Thread.new do
+              client['test'].update_one({test: "test"}, { "$set" => { test: "test2" } })
+            end
+            threads << Thread.new do
+              client['test'].delete_one({test: "test"})
+            end
+            threads
+          end
+
+          include_examples "a single connection"
+        end
+
+        context "when doing an insert, update and find" do
+          let(:threads) do
+            threads = []
+            threads << Thread.new do
+              client['test'].insert_one({test: "test"})
+            end
+            threads << Thread.new do
+              client['test'].update_one({test: "test"}, { "$set" => { test: "test2" } })
+            end
+            threads << Thread.new do
+              client['test'].find({test: "test"}).to_a
+            end
+            threads
+          end
+
+          include_examples "a single connection"
+        end
+
+        context "when doing an insert, update and bulk write" do
+          let(:threads) do
+            threads = []
+            threads << Thread.new do
+              client['test'].insert_one({test: "test"})
+            end
+            threads << Thread.new do
+              client['test'].update_one({test: "test"}, { "$set" => { test: "test2" } })
+            end
+            threads << Thread.new do
+              client['test'].bulk_write([{ insert_one: { test: "test1" } },
+                                         { update_one: { filter: { test: "test1" }, update: { "$set" => { test: "test2" } } } } ])
+            end
+            threads
+          end
+
+          include_examples "a single connection"
+        end
+
+        context "when doing an insert, update and find_one_and_delete" do
+          let(:threads) do
+            threads = []
+            threads << Thread.new do
+              client['test'].insert_one({test: "test"})
+            end
+            threads << Thread.new do
+              client['test'].update_one({test: "test"}, { "$set" => { test: "test2" } })
+            end
+            threads << Thread.new do
+              client['test'].find_one_and_delete({test: "test"})
+            end
+            threads
+          end
+
+          include_examples "a single connection"
+        end
+
+        context "when doing an insert, update and find_one_and_update" do
+          let(:threads) do
+            threads = []
+            threads << Thread.new do
+              client['test'].insert_one({test: "test"})
+            end
+            threads << Thread.new do
+              client['test'].update_one({test: "test"}, { "$set" => { test: "test2" } })
+            end
+            threads << Thread.new do
+              client['test'].find_one_and_update({test: "test"}, {test: "test2"})
+            end
+            threads
+          end
+
+          include_examples "a single connection"
+        end
+
+        context "when doing an insert, update and find_one_and_replace" do
+          let(:threads) do
+            threads = []
+            threads << Thread.new do
+              client['test'].insert_one({test: "test"})
+            end
+            threads << Thread.new do
+              client['test'].update_one({test: "test"}, { "$set" => { test: "test2" } })
+            end
+            threads << Thread.new do
+              client['test'].find_one_and_replace({test: "test"}, {test: "test2"})
+            end
+            threads
+          end
+
+          include_examples "a single connection"
+        end
+
+        context "when doing an insert, update and a replace" do
+          let(:threads) do
+            threads = []
+            threads << Thread.new do
+              client['test'].insert_one({test: "test"})
+            end
+            threads << Thread.new do
+              client['test'].update_one({test: "test"}, { "$set" => { test: "test2" } })
+            end
+            threads << Thread.new do
+              client['test'].replace_one({test: "test"}, {test: "test2"})
+            end
+            threads
+          end
+
+          include_examples "a single connection"
+        end
+
+        context "when doing all of the operations" do
+          let(:threads) do
+            threads = []
+            threads << Thread.new do
+              client['test'].insert_one({test: "test"})
+            end
+            threads << Thread.new do
+              client['test'].update_one({ test: "test" }, { "$set" => { test: 1 } })
+            end
+            threads << Thread.new do
+              client['test'].find_one_and_replace({test: "test"}, {test: "test2"})
+            end
+            threads << Thread.new do
+              client['test'].delete_one({test: "test"})
+            end
+            threads << Thread.new do
+              client['test'].find({test: "test"}).to_a
+            end
+            threads << Thread.new do
+              client['test'].bulk_write([{ insert_one: { test: "test1" } },
+                                         { update_one: { filter: { test: "test1" }, update: { "$set" => { test: "test2" } } } } ])
+            end
+            threads << Thread.new do
+              client['test'].find_one_and_delete({test: "test"})
+            end
+            threads << Thread.new do
+              client['test'].find_one_and_update({test: "test"}, {test: "test2"})
+            end
+            threads << Thread.new do
+              client['test'].find_one_and_replace({test: "test"}, {test: "test2"})
+            end
+            threads << Thread.new do
+              client['test'].replace_one({test: "test"}, {test: "test2"})
+            end
+            threads
+          end
+
+          include_examples "a single connection"
+        end
+      end
     end
 
     context 'when two clients have the same cluster' do

data/spec/mongo/cluster/cursor_reaper_spec.rb

@@ -38,15 +38,28 @@ describe Mongo::Cluster::CursorReaper do
         allow(server).to receive(:address).and_return(address)
       end
     end
+    let(:session) do
+      double(Mongo::Session)
+    end
     let(:cursor_id) { 1 }
     let(:cursor_kill_spec_1) do
       Mongo::Cursor::KillSpec.new(
-        cursor_id: cursor_id, coll_name: 'c', db_name: 'd', service_id: nil, server_address: address
+        cursor_id: cursor_id,
+        coll_name: 'c',
+        db_name: 'd',
+        server_address: address,
+        connection_global_id: 1,
+        session: session,
       )
     end
     let(:cursor_kill_spec_2) do
       Mongo::Cursor::KillSpec.new(
-        cursor_id: cursor_id, coll_name: 'c', db_name: 'q', service_id: nil, server_address: address
+        cursor_id: cursor_id,
+        coll_name: 'c',
+        db_name: 'q',
+        server_address: address,
+        connection_global_id: 1,
+        session: session,
       )
     end
     let(:to_kill) { reaper.instance_variable_get(:@to_kill)}
@@ -206,7 +219,12 @@ describe Mongo::Cluster::CursorReaper do
     it 'schedules the kill cursor op' do
       expect {
         cursor.to_a
-      }.to raise_exception(Mongo::Error::OperationFailure)
+        # Mongo::Error::SessionEnded is raised here because the periodic executor
+        # called in around block kills the cursor and closes the session.
+        # This code is normally scheduled in cursor finalizer, so the cursor object
+        # is garbage collected when the code is executed. So, a user won't get
+        # this exception.
+      }.to raise_exception(Mongo::Error::SessionEnded)
     end
   end
 end