mongo 2.12.1 → 2.13.0

data/spec/support/client_registry.rb

@@ -102,9 +102,10 @@ class ClientRegistry
     when 'authorized'
       client_options = {
         database: SpecConfig.instance.test_db,
-      }.update(SpecConfig.instance.credentials_or_x509(
+      }.update(SpecConfig.instance.credentials_or_external_user(
         user: SpecConfig.instance.test_user.name,
         password: SpecConfig.instance.test_user.password,
+        auth_source: 'admin',
       ))
 
       Mongo::Client.new(
@@ -116,9 +117,7 @@ class ClientRegistry
       global_client('authorized').with(
         retry_writes: true,
         server_selection_timeout: 4.97,
-      ).tap do |client|
-        client.subscribe(Mongo::Monitoring::COMMAND, EventSubscriber)
-      end
+      )
     # Provides an authorized mongo client that uses legacy read retry logic.
     when 'authorized_without_retry_reads'
       global_client('authorized').with(
@@ -137,18 +136,14 @@ class ClientRegistry
       global_client('authorized').with(
         retry_writes: false,
         server_selection_timeout: 4.99,
-      ).tap do |client|
-        client.subscribe(Mongo::Monitoring::COMMAND, EventSubscriber)
-      end
+      )
     # Provides an authorized mongo client that does not retry writes
     # using either modern or legacy mechanisms.
     when 'authorized_without_any_retry_writes'
       global_client('authorized').with(
         retry_writes: false, max_write_retries: 0,
         server_selection_timeout: 4.99,
-      ).tap do |client|
-        client.subscribe(Mongo::Monitoring::COMMAND, EventSubscriber)
-      end
+      )
     # Provides an authorized mongo client that does not retry reads or writes
     # at all.
     when 'authorized_without_any_retries'
@@ -176,7 +171,7 @@ class ClientRegistry
       else
         client_options = {
           database: SpecConfig.instance.test_db,
-        }.update(SpecConfig.instance.credentials_or_x509(
+        }.update(SpecConfig.instance.credentials_or_external_user(
           user: SpecConfig.instance.root_user.name,
           password: SpecConfig.instance.root_user.password,
           auth_source: SpecConfig.instance.auth_source || Mongo::Database::ADMIN,
@@ -187,19 +182,6 @@ class ClientRegistry
         SpecConfig.instance.addresses,
         SpecConfig.instance.test_options.merge(client_options),
       )
-    # A client that has an event subscriber for commands.
-    when 'subscribed'
-      Mongo::Client.new(
-        SpecConfig.instance.addresses,
-        SpecConfig.instance.test_options.merge(
-          database: SpecConfig.instance.test_db,
-        ).merge(SpecConfig.instance.credentials_or_x509(
-          user: SpecConfig.instance.test_user.name,
-          password: SpecConfig.instance.test_user.password,
-        ))
-      ).tap do |client|
-        client.subscribe(Mongo::Monitoring::COMMAND, EventSubscriber)
-      end
     else
       raise "Don't know how to construct global client #{name}"
     end

data/spec/support/cluster_config.rb

@@ -38,6 +38,10 @@ class ClusterConfig
   # less than 3.4. This method returns FCV on 3.4+ servers when in single
   # or RS topologies, and otherwise returns the major.minor server version.
   def fcv_ish
+    if server_version.nil?
+      raise "Deployment server version not known - check that connection to deployment succeeded"
+    end
+
     if server_version >= '3.4' && topology != :sharded
       fcv
     else
@@ -49,6 +53,7 @@ class ClusterConfig
     end
   end
 
+  # @return [ Mongo::Address ] The address of the primary in the deployment.
   def primary_address
     determine_cluster_config
     @primary_address

data/spec/support/common_shortcuts.rb

@@ -53,6 +53,49 @@ module CommonShortcuts
         end
       end
     end
+
+    # Applies environment variable overrides in +env+ to the global environment
+    # (+ENV+) for the duration of each test.
+    #
+    # If a key's value in +env+ is nil, this key is removed from +ENV+.
+    #
+    # When the test finishes, the values in original +ENV+ that were overridden
+    # by +env+ are restored. If a key was not in original +ENV+ and was
+    # overridden by +env+, this key is removed from +ENV+ after the test.
+    #
+    # If the environment variables are not known at test definition time
+    # but are determined at test execution time, pass a block instead of
+    # the +env+ parameter and return the desired environment variables as
+    # a Hash from the block.
+    def local_env(env = nil, &block)
+      around do |example|
+        env ||= block.call
+
+        # This duplicates ENV.
+        # Note that ENV.dup produces an Object which does not behave like
+        # the original ENV, and hence is not usable.
+        saved_env = ENV.to_h
+        env.each do |k, v|
+          if v.nil?
+            ENV.delete(k)
+          else
+            ENV[k] = v
+          end
+        end
+
+        begin
+          example.run
+        ensure
+          env.each do |k, v|
+            if saved_env.key?(k)
+              ENV[k] = saved_env[k]
+            else
+              ENV.delete(k)
+            end
+          end
+        end
+      end
+    end
   end
 
   module InstanceMethods

data/spec/support/constraints.rb

@@ -72,6 +72,19 @@ module Constraints
     require_topology :replica_set
   end
 
+  # Fail command fail point was added to mongod in 4.0 and to mongos in 4.2.
+  def require_fail_command
+    min_server_fcv '4.0'
+
+    before(:all) do
+      if ClusterConfig.instance.topology == :sharded
+        unless ClusterConfig.instance.short_server_version >= '4.2'
+          skip 'Test requires failCommand fail point which was added to mongos in 4.2'
+        end
+      end
+    end
+  end
+
   def require_tls
     before(:all) do
       unless SpecConfig.instance.ssl?
@@ -132,17 +145,24 @@ module Constraints
     end
   end
 
-  def require_auth
+  def require_auth(*values)
     before(:all) do
-      unless ENV['AUTH'] == 'auth' || SpecConfig.instance.user || ClusterConfig.instance.auth_enabled?
-        skip "Auth required"
+      if values.any?
+        unless values.include?(ENV['AUTH'])
+          msg = values.map { |v| "AUTH=#{v}" }.join(' or ')
+          skip "This test requires #{msg}"
+        end
+      else
+        unless ENV['AUTH'] == 'auth' || SpecConfig.instance.user || ClusterConfig.instance.auth_enabled?
+          skip "Auth required"
+        end
       end
     end
   end
 
   def require_no_auth
     before(:all) do
-      if ENV['AUTH'] == 'auth' || SpecConfig.instance.user || ClusterConfig.instance.auth_enabled?
+      if (ENV['AUTH'] && ENV['AUTH'] != 'noauth') || SpecConfig.instance.user || ClusterConfig.instance.auth_enabled?
         skip "Auth not allowed"
       end
     end
@@ -156,10 +176,10 @@ module Constraints
     end
   end
 
-  def require_no_x509_auth
+  def require_no_external_user
     before(:all) do
-      if SpecConfig.instance.x509_auth?
-        skip "X.509 auth not allowed"
+      if SpecConfig.instance.external_user?
+        skip "External user configurations are not compatible with this test"
       end
     end
   end

data/spec/support/crypt.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2019 MongoDB, Inc.
+# Copyright (C) 2009-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/spec/support/event_subscriber.rb

@@ -3,110 +3,210 @@
 # @since 2.5.0
 class EventSubscriber
 
-  module Impl
-
-    # The started events.
-    #
-    # @since 2.5.0
-    attr_reader :started_events
-
-    # The succeeded events.
-    #
-    # @since 2.5.0
-    attr_reader :succeeded_events
-
-    # The failed events.
-    #
-    # @since 2.5.0
-    attr_reader :failed_events
-
-    attr_reader :published_events
-
-    # Cache the succeeded event.
-    #
-    # @param [ Event ] event The event.
-    #
-    # @since 2.5.0
-    def succeeded(event)
-      @mutex.synchronize do
-        succeeded_events.push(event)
-      end
+  # The mappings of event names to types.
+  #
+  # @since 2.4.0
+  MAPPINGS = {
+    'topology_opening_event' => Mongo::Monitoring::Event::TopologyOpening,
+    'topology_description_changed_event' => Mongo::Monitoring::Event::TopologyChanged,
+    'topology_closed_event' => Mongo::Monitoring::Event::TopologyClosed,
+    'server_opening_event' => Mongo::Monitoring::Event::ServerOpening,
+    'server_description_changed_event' => Mongo::Monitoring::Event::ServerDescriptionChanged,
+    'server_closed_event' => Mongo::Monitoring::Event::ServerClosed
+  }.freeze
+
+  # All events.
+  attr_reader :all_events
+
+  # The started events.
+  #
+  # @since 2.5.0
+  attr_reader :started_events
+
+  # The succeeded events.
+  #
+  # @since 2.5.0
+  attr_reader :succeeded_events
+
+  # The failed events.
+  #
+  # @since 2.5.0
+  attr_reader :failed_events
+
+  attr_reader :published_events
+
+  # @param [ String ] name Optional name for the event subscriber.
+  def initialize(name: nil)
+    @mutex = Mutex.new
+    clear_events!
+    @name = name
+  end
+
+  def to_s
+    %Q`#<EventSubscriber:#{@name ? "\"#{@name}\"" : '%x' % object_id} \
+started=#{started_events.length} \
+succeeded=#{succeeded_events.length} \
+failed=#{failed_events.length} \
+published=#{published_events.length}>`
+  end
+
+  alias :inspect :to_s
+
+  # Event retrieval
+
+  def select_started_events(cls)
+    started_events.select do |event|
+      event.is_a?(cls)
     end
+  end
 
-    # Cache the started event.
-    #
-    # @param [ Event ] event The event.
-    #
-    # @since 2.5.0
-    def started(event)
-      @mutex.synchronize do
-        started_events.push(event)
-      end
+  def select_succeeded_events(cls)
+    succeeded_events.select do |event|
+      event.is_a?(cls)
     end
+  end
 
-    # Filters command started events for the specified command name.
-    def command_started_events(command_name)
-      started_events.select do |event|
-        event.command[command_name]
-      end
+  def select_published_events(cls)
+    published_events.select do |event|
+      event.is_a?(cls)
     end
+  end
 
-    # Locates command stated events for the specified command name,
-    # asserts that there is exactly one such event, and returns it.
-    def single_command_started_event(command_name)
-      events = started_events.select do |event|
-        event.command[command_name]
-      end
-      if events.length != 1
-        raise "Expected a single #{command_name} event but we have #{events.length}"
-      end
-      events.first
+  # Filters command started events for the specified command name.
+  def command_started_events(command_name)
+    started_events.select do |event|
+      event.command[command_name]
     end
+  end
 
-    # Cache the failed event.
-    #
-    # @param [ Event ] event The event.
-    #
-    # @since 2.5.0
-    def failed(event)
-      @mutex.synchronize do
-        failed_events.push(event)
+  def non_auth_command_started_events
+    started_events.reject do |event|
+      %w(authenticate getnonce saslSstart saslContinue).any? do |cmd|
+        event.command[cmd]
       end
     end
+  end
 
-    def select_published_events(cls)
-      @published_events.select do |event|
-        event.is_a?(cls)
-      end
+  # Locates command stated events for the specified command name,
+  # asserts that there is exactly one such event, and returns it.
+  def single_command_started_event(command_name, include_auth: false)
+    events = if include_auth
+      started_events
+    else
+      non_auth_command_started_events
     end
+    events.select! do |event|
+      event.command[command_name]
+    end
+    if events.length != 1
+      raise "Expected a single #{command_name} event but we have #{events.length}"
+    end
+    events.first
+  end
 
-    def published(event)
-      @mutex.synchronize do
-        @published_events << event
-      end
+  # Get the first succeeded event published for the name, and then delete it.
+  #
+  # @param [ String ] name The event name.
+  #
+  # @return [ Event ] The matching event.
+  def first_event(name)
+    cls = MAPPINGS[name]
+    if cls.nil?
+      raise ArgumentError, "Bogus event name #{name}"
+    end
+    matching = succeeded_events.find do |event|
+      cls === event
     end
+    succeeded_events.delete(matching)
+    matching
+  end
 
-    # Clear all cached events.
-    #
-    # @since 2.5.1
-    def clear_events!
-      @started_events = []
-      @succeeded_events = []
-      @failed_events = []
-      @published_events = []
-      self
+  # Event recording
+
+  # Cache the started event.
+  #
+  # @param [ Event ] event The event.
+  #
+  # @since 2.5.0
+  def started(event)
+    @mutex.synchronize do
+      started_events << event
+      all_events << event
     end
+  end
 
-    def initialize
-      @mutex = Mutex.new
-      clear_events!
+  # Cache the succeeded event.
+  #
+  # @param [ Event ] event The event.
+  #
+  # @since 2.5.0
+  def succeeded(event)
+    @mutex.synchronize do
+      succeeded_events << event
+      all_events << event
     end
   end
 
-  include Impl
+  # Cache the failed event.
+  #
+  # @param [ Event ] event The event.
+  #
+  # @since 2.5.0
+  def failed(event)
+    @mutex.synchronize do
+      failed_events << event
+      all_events << event
+    end
+  end
 
-  class << self
-    include Impl
-    public :initialize
+  def published(event)
+    @mutex.synchronize do
+      published_events << event
+      all_events << event
+    end
+  end
+
+  # Clear all cached events.
+  #
+  # @since 2.5.1
+  def clear_events!
+    @all_events = []
+    @started_events = []
+    @succeeded_events = []
+    @failed_events = []
+    @published_events = []
+    self
+  end
+end
+
+# Only handles succeeded events correctly.
+class PhasedEventSubscriber < EventSubscriber
+  def initialize
+    super
+    @phase_events = {}
+  end
+
+  def phase_finished(phase_index)
+    @phase_events[phase_index] = succeeded_events
+    @succeeded_events = []
+  end
+
+  def phase_events(phase_index)
+    @phase_events[phase_index]
+  end
+
+  def event_count
+    @phase_events.inject(0) do |sum, event|
+      sum + event.length
+    end
+  end
+end
+
+class VerboseEventSubscriber < EventSubscriber
+  %w(started succeeded failed published).each do |meth|
+    define_method(meth) do |event|
+      puts event.summary
+      super(event)
+    end
   end
 end