mongo 2.12.4 → 2.13.0.beta1

data/spec/support/background_thread_registry.rb

@@ -40,9 +40,13 @@ class BackgroundThreadRegistry
         alive_thread_records.each do |record|
           msg << "\n  #{record.object}"
           if record.object.respond_to?(:options)
-            msg << "\n  #{record.object.options}"
+            msg << "\n  with options: #{record.object.options}"
+          end
+          if record.example
+            msg << "\n  in #{record.example.id} #{record.example.full_description}"
+          else
+            msg << "\n  not in an example"
           end
-          msg << "\n  in #{record.example.id} #{record.example.full_description}"
         end
         raise msg
       end

data/spec/support/client_registry.rb

@@ -102,7 +102,7 @@ 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,
       ))
@@ -116,9 +116,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 +135,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 +170,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 +181,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

@@ -49,6 +49,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,120 @@
 # @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 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
+  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
+  # Cache the started event.
+  #
+  # @param [ Event ] event The event.
+  #
+  # @since 2.5.0
+  def started(event)
+    @mutex.synchronize do
+      started_events.push(event)
     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
+  # 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
 
-    # 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}"
+  def non_auth_command_started_events
+    started_events.reject do |event|
+      %w(authenticate getnonce saslSstart saslContinue).any? do |cmd|
+        event.command[cmd]
       end
-      events.first
     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)
-      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
+  end
 
-    def select_published_events(cls)
-      @published_events.select do |event|
-        event.is_a?(cls)
-      end
+  def select_started_events(cls)
+    @started_events.select do |event|
+      event.is_a?(cls)
     end
+  end
 
-    def published(event)
-      @mutex.synchronize do
-        @published_events << event
-      end
+  def select_succeeded_events(cls)
+    @succeeded_events.select do |event|
+      event.is_a?(cls)
+    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)
     end
+  end
 
-    # Clear all cached events.
-    #
-    # @since 2.5.1
-    def clear_events!
-      @started_events = []
-      @succeeded_events = []
-      @failed_events = []
-      @published_events = []
-      self
+  def select_published_events(cls)
+    @published_events.select do |event|
+      event.is_a?(cls)
     end
+  end
 
-    def initialize
-      @mutex = Mutex.new
-      clear_events!
+  def published(event)
+    @mutex.synchronize do
+      @published_events << event
     end
   end
 
-  include Impl
+  # Clear all cached events.
+  #
+  # @since 2.5.1
+  def clear_events!
+    @started_events = []
+    @succeeded_events = []
+    @failed_events = []
+    @published_events = []
+    self
+  end
 
-  class << self
-    include Impl
-    public :initialize
+  def initialize
+    @mutex = Mutex.new
+    clear_events!
   end
 end

data/spec/support/lite_constraints.rb

@@ -91,4 +91,51 @@ module LiteConstraints
       end
     end
   end
+
+  def require_aws_auth
+    before(:all) do
+      unless (ENV['AUTH'] || '') =~ /^aws/
+        skip 'This test requires AUTH=aws* and an appropriately configured runtime environment'
+      end
+    end
+  end
+
+  def require_ec2_host
+    before(:all) do
+      if $have_aws.nil?
+        $have_aws = begin
+          require 'open-uri'
+          begin
+            Timeout.timeout(3.81) do
+              URI.parse('http://169.254.169.254/latest/meta-data/profile').open.read
+            end
+            true
+          # When trying to use the EC2 metadata endpoint on ECS:
+          # Errno::EINVAL: Failed to open TCP connection to 169.254.169.254:80 (Invalid argument - connect(2) for "169.254.169.254" port 80)
+          rescue Timeout::Error, Errno::ETIMEDOUT, Errno::EINVAL, OpenURI::HTTPError => $aws_error
+            false
+          end
+        end
+      end
+      unless $have_aws
+        skip "EC2 instance metadata is not available - assuming not running on an EC2 instance: #{$aws_error.class}: #{$aws_error}"
+      end
+    end
+  end
+
+  def require_stress
+    before(:all) do
+      if !SpecConfig.instance.stress?
+        skip 'Set STRESS=1 in environment to run stress tests'
+      end
+    end
+  end
+
+  def require_fork
+    before(:all) do
+      if !SpecConfig.instance.fork?
+        skip 'Set FORK=1 in environment to run fork tests'
+      end
+    end
+  end
 end