mongo 2.11.2 → 2.13.0.beta1

data/spec/support/shared/server_selector.rb

@@ -2,6 +2,8 @@ shared_context 'server selector' do
 
   let(:max_staleness) { nil }
   let(:tag_sets) { [] }
+  let(:hedge) { nil }
+
   let(:tag_set) do
     { 'test' => 'tag' }
   end
@@ -20,7 +22,7 @@ shared_context 'server selector' do
       expect(server.unknown?).to be true
     end
   end
-  let(:options) { { :mode => name, :tag_sets => tag_sets, max_staleness: max_staleness } }
+  let(:options) { { :mode => name, :tag_sets => tag_sets, max_staleness: max_staleness, hedge: hedge } }
   let(:selector) { described_class.new(options) }
   let(:monitoring) do
     Mongo::Monitoring.new(monitoring: false)
@@ -120,6 +122,84 @@ shared_examples 'a server selector accepting tag sets' do
   end
 end
 
+shared_examples 'a server selector accepting hedge' do
+  describe '#initialize' do
+    context 'when hedge is not provided' do
+      it 'initializes successfully' do
+        expect do
+          selector
+        end.not_to raise_error
+      end
+    end
+
+    context 'when hedge is not a Hash' do
+      let(:hedge) { true }
+
+      it 'raises an exception' do
+        expect do
+          selector
+        end.to raise_error(Mongo::Error::InvalidServerPreference, /`hedge` value \(true\) is invalid/)
+      end
+    end
+
+    context 'when hedge is an empty Hash' do
+      let(:hedge) { {} }
+
+      it 'raises an exception' do
+        expect do
+          selector
+        end.to raise_error(Mongo::Error::InvalidServerPreference, /`hedge` value \({}\) is invalid/)
+      end
+    end
+
+    context 'when hedge is a Hash with data' do
+      let(:hedge) { { enabled: false } }
+
+      it 'initializes successfully' do
+        expect do
+          selector
+        end.not_to raise_error
+      end
+    end
+  end
+
+  describe '#hedge' do
+    context 'when hedge is not provided' do
+      it 'returns nil' do
+        expect(selector.hedge).to be_nil
+      end
+    end
+
+    context 'when hedge is a Hash with data' do
+      let(:hedge) { { enabled: false } }
+
+      it 'returns the same Hash' do
+        expect(selector.hedge).to eq({ enabled: false })
+      end
+    end
+  end
+
+  describe '#==' do
+    let(:other_selector) { described_class.new(hedge: { enabled: false }) }
+
+    context 'when hedges are the same' do
+      let(:hedge) { { enabled: false } }
+
+      it 'returns true' do
+        expect(selector).to eq(other_selector)
+      end
+    end
+
+    context 'when hedges are different' do
+      let(:hedge) { { enabled: true } }
+
+      it 'returns false' do
+        expect(selector).not_to eq(other_selector)
+      end
+    end
+  end
+end
+
 shared_examples 'a server selector with sensitive data in its options' do
 
   describe '#inspect' do

data/spec/support/shared/session.rb

@@ -123,10 +123,6 @@ end
 
 shared_examples 'an explicit session with an unacknowledged write' do
 
-  before do
-    EventSubscriber.clear_events!
-  end
-
   context 'when sessions are supported' do
     min_server_fcv '3.6'
 
@@ -135,8 +131,10 @@ shared_examples 'an explicit session with an unacknowledged write' do
     end
 
     it 'does not add a session id to the operation' do
+      subscriber.clear_events!
       operation
-      expect(EventSubscriber.started_events.collect(&:command).collect { |cmd| cmd['lsid'] }.compact).to be_empty
+      subscriber.non_auth_command_started_events.length.should == 1
+      expect(subscriber.non_auth_command_started_events.collect(&:command).collect { |cmd| cmd['lsid'] }.compact).to be_empty
     end
   end
 
@@ -149,24 +147,24 @@ shared_examples 'an explicit session with an unacknowledged write' do
 
     it 'does not add a session id to the operation' do
       expect(Mongo::Session).not_to receive(:new)
+      subscriber.clear_events!
       operation
-      expect(EventSubscriber.started_events.collect(&:command).collect { |cmd| cmd['lsid'] }.compact).to be_empty
+      subscriber.non_auth_command_started_events.length.should == 1
+      expect(subscriber.non_auth_command_started_events.collect(&:command).collect { |cmd| cmd['lsid'] }.compact).to be_empty
     end
   end
 end
 
 shared_examples 'an implicit session with an unacknowledged write' do
 
-  before do
-    EventSubscriber.clear_events!
-  end
-
   context 'when sessions are supported' do
     min_server_fcv '3.6'
 
     it 'does not add a session id to the operation' do
+      subscriber.clear_events!
       operation
-      expect(EventSubscriber.started_events.collect(&:command).collect { |cmd| cmd['lsid'] }.compact).to be_empty
+      subscriber.non_auth_command_started_events.length.should == 1
+      expect(subscriber.non_auth_command_started_events.collect(&:command).collect { |cmd| cmd['lsid'] }.compact).to be_empty
     end
   end
 
@@ -174,16 +172,22 @@ shared_examples 'an implicit session with an unacknowledged write' do
     max_server_version '3.4'
 
     it 'does not add a session id to the operation' do
+      subscriber.clear_events!
       operation
-      expect(EventSubscriber.started_events.collect(&:command).collect { |cmd| cmd['lsid'] }.compact).to be_empty
+      subscriber.non_auth_command_started_events.length.should == 1
+      expect(subscriber.non_auth_command_started_events.collect(&:command).collect { |cmd| cmd['lsid'] }.compact).to be_empty
     end
   end
 end
 
 shared_examples 'an operation supporting causally consistent reads' do
 
+  let(:subscriber) { EventSubscriber.new }
+
   let(:client) do
-    subscribed_client
+    authorized_client.tap do |client|
+      client.subscribe(Mongo::Monitoring::COMMAND, subscriber)
+    end
   end
 
   context 'when connected to a standalone' do
@@ -615,8 +619,12 @@ shared_examples 'an operation updating cluster time' do
     client.start_session
   end
 
+  let(:subscriber) { EventSubscriber.new }
+
   let(:client) do
-    subscribed_client
+    authorized_client.tap do |client|
+      client.subscribe(Mongo::Monitoring::COMMAND, subscriber)
+    end
   end
 
   shared_examples_for 'does not update the cluster time of the cluster' do
@@ -637,7 +645,7 @@ shared_examples 'an operation updating cluster time' do
 
         let(:reply_cluster_time) do
           operation_with_session
-          EventSubscriber.succeeded_events[-1].reply['$clusterTime']
+          subscriber.succeeded_events[-1].reply['$clusterTime']
         end
 
         it 'updates the cluster time of the cluster', retry: 3 do
@@ -660,7 +668,7 @@ shared_examples 'an operation updating cluster time' do
 
         let!(:reply_cluster_time) do
           operation_with_session
-          EventSubscriber.succeeded_events[-1].reply['$clusterTime']
+          subscriber.succeeded_events[-1].reply['$clusterTime']
         end
 
         it_behaves_like 'does not update the cluster time of the cluster'
@@ -681,7 +689,7 @@ shared_examples 'an operation updating cluster time' do
 
       let(:reply_cluster_time) do
         operation
-        EventSubscriber.succeeded_events[-1].reply['$clusterTime']
+        subscriber.succeeded_events[-1].reply['$clusterTime']
       end
 
       it_behaves_like 'does not update the cluster time of the cluster'
@@ -692,7 +700,7 @@ shared_examples 'an operation updating cluster time' do
 
     let(:reply_cluster_time) do
       operation_with_session
-      EventSubscriber.succeeded_events[-1].reply['$clusterTime']
+      subscriber.succeeded_events[-1].reply['$clusterTime']
     end
 
     context 'when the cluster is sharded or a replica set' do
@@ -707,7 +715,7 @@ shared_examples 'an operation updating cluster time' do
 
         let(:second_command_cluster_time) do
           second_operation
-          EventSubscriber.started_events[-1].command['$clusterTime']
+          subscriber.non_auth_command_started_events[-1].command['$clusterTime']
         end
 
         context 'when the advanced cluster time is greater than the existing cluster time' do
@@ -745,7 +753,7 @@ shared_examples 'an operation updating cluster time' do
 
         let(:second_command_cluster_time) do
           second_operation
-          EventSubscriber.started_events[-1].command['$clusterTime']
+          subscriber.non_auth_command_started_events[-1].command['$clusterTime']
         end
 
         it 'includes the received cluster time in the second command', retry: 3 do
@@ -765,7 +773,7 @@ shared_examples 'an operation updating cluster time' do
 
       let(:second_command_cluster_time) do
         second_operation
-        EventSubscriber.started_events[-1].command['$clusterTime']
+        subscriber.non_auth_command_started_events[-1].command['$clusterTime']
       end
 
       it 'does not update the cluster time of the cluster' do

data/spec/support/spec_config.rb

@@ -1,4 +1,5 @@
 require 'singleton'
+require 'pathname'
 
 class SpecConfig
   include Singleton
@@ -13,7 +14,7 @@ class SpecConfig
       if @uri_options[:replica_set]
         @addresses = @mongodb_uri.servers
         @connect_options = { connect: :replica_set, replica_set: @uri_options[:replica_set] }
-      elsif @uri_options[:connect] == :sharded || ENV['TOPOLOGY'] == 'sharded_cluster'
+      elsif @uri_options[:connect] == :sharded || ENV['TOPOLOGY'] == 'sharded-cluster'
         @addresses = @mongodb_uri.servers
         @connect_options = { connect: :sharded }
       elsif @uri_options[:connect] == :direct
@@ -113,14 +114,18 @@ class SpecConfig
     RUBY_PLATFORM
   end
 
-  def stress_spec?
-    !!ENV['STRESS_SPEC']
+  def stress?
+    %w(1 true yes).include?(ENV['STRESS']&.downcase)
+  end
+
+  def fork?
+    %w(1 true yes).include?(ENV['FORK']&.downcase)
   end
 
   # Test suite configuration
 
   def client_debug?
-    %w(1 true yes).include?((ENV['CLIENT_DEBUG'] || '').downcase)
+    %w(1 true yes).include?(ENV['MONGO_RUBY_DRIVER_CLIENT_DEBUG']&.downcase)
   end
 
   def drivers_tools?
@@ -133,11 +138,7 @@ class SpecConfig
 
   # What compressor to use, if any.
   def compressors
-    if ENV['COMPRESSORS']
-      ENV['COMPRESSORS'].split(',')
-    else
-      nil
-    end
+    uri_options[:compressors]
   end
 
   def retry_reads
@@ -189,7 +190,7 @@ class SpecConfig
   end
 
   def auth_source
-    @uri_options && uri_options[:auth_source]
+    uri_options[:auth_source]
   end
 
   def connect_replica_set?
@@ -311,20 +312,58 @@ EOT
     'ruby-driver'.freeze
   end
 
+  # AWS IAM user access key id
+  def fle_aws_key
+    ENV['MONGO_RUBY_DRIVER_AWS_KEY']
+  end
+
+  # AWS IAM user secret access key
+  def fle_aws_secret
+    ENV['MONGO_RUBY_DRIVER_AWS_SECRET']
+  end
+
+  # Region of AWS customer master key
+  def fle_aws_region
+    ENV['MONGO_RUBY_DRIVER_AWS_REGION']
+  end
+
+  # Amazon resource name (ARN) of AWS customer master key
+  def fle_aws_arn
+    ENV['MONGO_RUBY_DRIVER_AWS_ARN']
+  end
+
+  def mongocryptd_port
+    if ENV['MONGO_RUBY_DRIVER_MONGOCRYPTD_PORT'] &&
+      !ENV['MONGO_RUBY_DRIVER_MONGOCRYPTD_PORT'].empty?
+    then
+      ENV['MONGO_RUBY_DRIVER_MONGOCRYPTD_PORT'].to_i
+    else
+      27020
+    end
+  end
+
   # Option hashes
 
   def auth_options
     if x509_auth?
       {
-        auth_mech: @uri_options[:auth_mech],
+        auth_mech: uri_options[:auth_mech],
         auth_source: '$external',
       }
     else
       {
         user: user,
         password: password,
-        auth_source: auth_source,
-      }
+      }.tap do |options|
+        if auth_source
+          options[:auth_source] = auth_source
+        end
+        %i(auth_mech auth_mech_properties).each do |key|
+          if uri_options[key]
+            options[key] = uri_options[key]
+          end
+        end
+      end
     end
   end
 
@@ -356,10 +395,19 @@ EOT
 
   # Base test options.
   def base_test_options
-    uri_options = @uri_options || {}
     {
-      max_pool_size: 1,
+      # Automatic encryption tests require a minimum of three connections:
+      # - The driver checks out a connection to build a command.
+      # - It may need to encrypt the command, which could require a query to
+      #   the key vault collection triggered by libmongocrypt.
+      # - If the key vault client has auto encryption options, it will also
+      #   attempt to encrypt this query, resulting in a third connection.
+      # In the worst case using FLE may end up tripling the number of
+      # connections that the driver uses at any one time.
+      max_pool_size: 3,
+
       heartbeat_frequency: 20,
+
       # The test suite seems to perform a number of operations
       # requiring server selection. Hence a timeout of 1 here,
       # together with e.g. a misconfigured replica set,
@@ -367,8 +415,13 @@ EOT
       # failing.
       # Server selection timeout of 1 is insufficient for evergreen.
       server_selection_timeout: uri_options[:server_selection_timeout] || (ssl? ? 4.01 : 2.01),
-      wait_queue_timeout: 2,
+
+      # Since connections are established under the wait queue timeout,
+      # the wait queue timeout should be at least as long as the
+      # connect timeout.
+      wait_queue_timeout: 4,
       connect_timeout: 3,
+      socket_timeout: 3,
       max_idle_time: 5
    }
   end
@@ -428,14 +481,31 @@ EOT
   end
 
   def x509_auth?
-    @uri_options[:auth_mech] == :mongodb_x509
+    uri_options[:auth_mech] == :mongodb_x509
   end
 
-  # When we use x.509 authentication, omit all of the users we normally create
-  # and authenticate with x.509.
-  def credentials_or_x509(creds)
-    if x509_auth?
-      {auth_mech: :mongodb_x509}
+  # When we authenticate with a username & password mechanism (scram, cr)
+  # we create a variety of users in the test suite for different purposes.
+  # When we authenticate with passwordless mechanisms (x509, aws) we use
+  # the globally specified user for all operations.
+  def external_user?
+    case uri_options[:auth_mech]
+    when :mongodb_x509, :aws
+      true
+    when nil, :scram, :scram256
+      false
+    else
+      raise "Unknown auth mechanism value: #{uri_options[:auth_mech]}"
+    end
+  end
+
+  # When we use external authentication, omit all of the users we normally
+  # create and authenticate with the external mechanism. This also ensures
+  # our various helpers work correctly when the only users available are
+  # the external ones.
+  def credentials_or_external_user(creds)
+    if external_user?
+      auth_options
     else
       creds
     end

data/spec/support/spec_setup.rb

@@ -3,8 +3,8 @@ require_relative './client_registry'
 
 class SpecSetup
   def run
-    if SpecConfig.instance.x509_auth?
-      warn 'Skipping user creation because X.509 auth appears to be enabled'
+    if SpecConfig.instance.external_user?
+      warn 'Skipping user creation because the set of users is fixed'
       return
     end
 
@@ -57,10 +57,14 @@ class SpecSetup
   end
 
   def admin_unauthorized_client
-    ClientRegistry.instance.global_client('admin_unauthorized')
+    ClientRegistry.instance.global_client('admin_unauthorized').with(
+      socket_timeout: 5, connect_timeout: 5,
+    )
   end
 
   def admin_authorized_test_client
-    ClientRegistry.instance.global_client('root_authorized')
+    ClientRegistry.instance.global_client('root_authorized').with(
+      socket_timeout: 5, connect_timeout: 5,
+    )
   end
 end