mongo 2.6.4 → 2.7.0.rc0

data/spec/support/change_streams/operation.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 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/client_registry.rb

@@ -0,0 +1,170 @@
+require 'singleton'
+
+module Mongo
+  class Client
+    alias :with_without_registry :with
+    def with(*args)
+      with_without_registry(*args).tap do |client|
+        ClientRegistry.instance.register_local_client(client)
+      end
+    end
+  end
+end
+
+# Test suite uses a number of global clients (with lifetimes spanning
+# several tests) as well as local clients (created for a single example
+# or shared across several examples in one example group).
+#
+# To make client cleanup easy, all local clients are automatically closed
+# after every example. This means there is no need for an individual example
+# to worry about closing its local clients.
+#
+# In SDAM tests, having global clients is problematic because mocks can
+# be executed on global clients instead of the local clients.
+# To address this, tests can close all global clients. This kills monitoring
+# threads and SDAM on the global clients. Later tests that need one of the
+# global clients will have the respective global client reconnected
+# automatically by the client registry.
+#
+# Lastly, Client#with sometimes creates a new cluster and sometimes reuses
+# the cluster on the receiver. Client registry patches Mongo::Client to
+# track all clients returned by Client#with, and considers these clients
+# local to the example being run. This means global clients should not be
+# created via #with. Being local clients, clients created by #with will be
+# automatically closed after each example. If these clients shared their
+# cluster with a global client, this will make the global client not do
+# SDAM anymore; this situation is automatically fixed by the client registry
+# when a subsequent test requests the global client in question.
+class ClientRegistry
+  include Singleton
+
+  def initialize
+    # clients local to an example.
+    # any clients in @clients can be closed in an after hook
+    @local_clients = []
+    # clients global to the test suite, should not be closed in an after hooks
+    # but their monitoring may need to be suspended/resumed
+    @global_clients = {}
+  end
+
+  def global_client(name)
+    if client = @global_clients[name]
+      unless client.cluster.connected?
+        client.reconnect
+      end
+      return client
+    end
+
+    @global_clients[name] = new_global_client(name)
+  end
+
+  def new_global_client(name)
+    case name
+    # Provides a basic scanned client to do an ismaster check.
+    when 'basic'
+      Mongo::Client.new(
+        SpecConfig.instance.addresses,
+        SpecConfig.instance.test_options.merge(database: SpecConfig.instance.test_db),
+      )
+    # Provides an unauthorized mongo client on the default test database.
+    when 'unauthorized'
+      Mongo::Client.new(
+        SpecConfig.instance.addresses,
+        SpecConfig.instance.test_options.merge(database: SpecConfig.instance.test_db, monitoring: false),
+      )
+    # Provides an authorized mongo client on the default test database for the
+    # default test user.
+    when 'authorized'
+      Mongo::Client.new(
+        SpecConfig.instance.addresses,
+        SpecConfig.instance.test_options.merge(
+          database: SpecConfig.instance.test_db,
+          user: SpecConfig.instance.test_user.name,
+          password: SpecConfig.instance.test_user.password),
+      )
+    # Provides an authorized mongo client that retries writes.
+    when 'authorized_with_retry_writes'
+      global_client('authorized').with(retry_writes: true).tap do |client|
+        client.subscribe(Mongo::Monitoring::COMMAND, EventSubscriber)
+      end
+    # Provides an authorized mongo client that does not retry writes,
+    # overriding global test suite option to retry writes if necessary.
+    when 'authorized_without_retry_writes'
+      global_client('authorized').with(retry_writes: false).tap do |client|
+        client.subscribe(Mongo::Monitoring::COMMAND, EventSubscriber)
+      end
+    # Provides an unauthorized mongo client on the admin database, for use in
+    # setting up the first admin root user.
+    when 'admin_unauthorized'
+      Mongo::Client.new(
+        SpecConfig.instance.addresses,
+        SpecConfig.instance.test_options.merge(
+          database: Mongo::Database::ADMIN,
+          monitoring: false),
+      )
+    # Get an authorized client on the test database logged in as the admin
+    # root user.
+    when 'root_authorized'
+      Mongo::Client.new(
+        SpecConfig.instance.addresses,
+        SpecConfig.instance.test_options.merge(
+          user: SpecConfig.instance.root_user.name,
+          password: SpecConfig.instance.root_user.password,
+          database: SpecConfig.instance.test_db,
+          auth_source: SpecConfig.instance.auth_source || Mongo::Database::ADMIN,
+          monitoring: false
+        ),
+      )
+    # Get an authorized client on the admin database logged in as the admin
+    # root user.
+    when 'root_authorized_admin'
+      Mongo::Client.new(
+        SpecConfig.instance.addresses,
+        SpecConfig.instance.test_options.merge(
+          user: SpecConfig.instance.root_user.name,
+          password: SpecConfig.instance.root_user.password,
+          database: 'admin',
+          auth_source: SpecConfig.instance.auth_source || Mongo::Database::ADMIN,
+          monitoring: false
+        ),
+      )
+    # 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,
+          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
+  end
+  private :new_global_client
+
+  def new_local_client(*args)
+    Mongo::Client.new(*args).tap do |client|
+      @local_clients << client
+    end
+  end
+
+  def register_local_client(client)
+    @local_clients << client
+    client
+  end
+
+  def close_local_clients
+    @local_clients.map(&:close)
+    @local_clients = []
+  end
+
+  def close_all_clients
+    close_local_clients
+    @global_clients.each do |name, client|
+      client.close(true)
+    end
+  end
+end

data/spec/support/client_registry_macros.rb

@@ -0,0 +1,14 @@
+module ClientRegistryMacros
+  def new_local_client(address, options=nil)
+    ClientRegistry.instance.new_local_client(address, options)
+  end
+
+  def new_local_client_nmio(address, options=nil)
+    new_local_client(address, Mongo::Options::Redacted.new(
+      monitoring_io: false).merge(options || {}))
+  end
+
+  def close_local_clients
+    ClientRegistry.instance.close_local_clients
+  end
+end

data/spec/support/cluster_config.rb

@@ -0,0 +1,49 @@
+require 'singleton'
+
+class ClusterConfig
+  include Singleton
+
+  def scanned_client
+    $mongo_client ||= initialize_scanned_client!
+  end
+
+  def single_server?
+    scanned_client.cluster.servers.length == 1
+  end
+
+  def server!
+    server = scanned_client.cluster.servers.first
+    if server.nil?
+      raise ScannedClientHasNoServers
+    end
+    server
+  end
+
+  def mongos?
+    server!.mongos?
+  end
+
+  def replica_set_name
+    @replica_set_name ||= server!.replica_set_name
+  end
+
+  def server_version
+    client = ClientRegistry.instance.global_client('authorized')
+    @server_version ||= client.database.command(buildInfo: 1).first['version']
+  end
+
+  def short_server_version
+    server_version.split('.')[0..1].join('.')
+  end
+
+  def primary_address
+    @primary_address ||= begin
+      client = ClientRegistry.instance.global_client('authorized')
+      if client.cluster.topology.is_a?(Mongo::Cluster::Topology::ReplicaSetWithPrimary)
+        client.cluster.servers.detect { |server| server.primary? }.address
+      else
+        client.cluster.servers.first.address
+      end.seed
+    end
+  end
+end

data/spec/support/command_monitoring.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -90,7 +90,7 @@ end
 module Mongo
   module CommandMonitoring
 
-    # Matchers common behaviour.
+    # Matchers common behavior.
     #
     # @since 2.1.0
     module Matchable
@@ -268,7 +268,7 @@ module Mongo
       end
     end
 
-    # Encapsulates expectation behaviour.
+    # Encapsulates expectation behavior.
     #
     # @since 2.1.0
     class Expectation

data/spec/support/common_shortcuts.rb

@@ -0,0 +1,12 @@
+module CommonShortcuts
+  # Declares a topology double, which is configured to accept summary
+  # calls as those are used in SDAM event creation
+  def declare_topology_double
+    let(:topology) do
+      double('topology').tap do |topology|
+        allow(topology).to receive(:summary)
+      end
+    end
+  end
+end
+

data/spec/support/connection_string.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2018 MongoDB, Inc.
+# Copyright (C) 2014-2019 MongoDB, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -142,7 +142,7 @@ module Mongo
       end
 
       def hosts
-        @hosts ||= @spec['hosts'].collect do |host|
+        @hosts ||= (@spec['hosts'] || []).collect do |host|
           Host.new(host)
         end
       end
@@ -152,7 +152,7 @@ module Mongo
       end
 
       def client
-        @client ||= Mongo::Client.new(@spec['uri'])
+        @client ||= ClientRegistry.instance.new_local_client(@spec['uri'], monitoring_io: false)
       end
 
       def uri
@@ -211,8 +211,53 @@ module Mongo
     class Options
 
       MAPPINGS = {
-          'replicaset' => :replica_set,
-          'authmechanism' => :auth_mech
+        # Replica Set Options
+        'replicaset' => :replica_set,
+
+        # Auth Source
+        'authsource' => :auth_source,
+
+        # Timeout Options
+        'connecttimeoutms' => :connect_timeout,
+        'sockettimeoutms' => :socket_timeout,
+        'serverselectiontimeoutms' => :server_selection_timeout,
+        'localthresholdms' => :local_threshold,
+        'heartbeatfrequencyms' => :heartbeat_frequency,
+        'maxidletimems' => :max_idle_time,
+
+         # Write  Options
+        'journal' => [:write, 'j'],
+        'w' => [:write, 'w'],
+        'wtimeoutms' => [:write, 'timeout'],
+
+        # Read Options
+        'readpreference' => ['read', 'mode'],
+        'readpreferencetags' => ['read', 'tag_sets'],
+        'maxstalenessseconds' => ['read', 'max_staleness'],
+
+        # Pool Options
+        'minpoolsize' => :min_pool_size,
+        'maxpoolsize' => :max_pool_size,
+
+        # Security Options
+        'tls' => :ssl,
+        'tlsallowinvalidcertificates' => :ssl_verify_certificate,
+        'tlsallowinvalidhostnames' => :ssl_verify_hostname,
+        'tlscafile' => :ssl_ca_cert,
+        'tlscertificatekeyfile' => :ssl_cert,
+        'tlscertificatekeyfilepassword' => :ssl_key_pass_phrase,
+        'tlsinsecure' => :ssl_verify,
+
+        # Auth Options
+        'authsource' => :auth_source,
+        'authmechanism' => :auth_mech,
+        'authmechanismproperties' => :auth_mech_properties,
+
+        # Client Options
+        'appname' => :app_name,
+        'readconcernlevel' => :read_concern,
+        'retrywrites' => :retry_writes,
+        'zlibcompressionlevel' => :zlib_compression_level,
       }
 
       attr_reader :options
@@ -223,8 +268,55 @@ module Mongo
 
       def match?(opts)
         @options.all? do |k, v|
-          opts[MAPPINGS[k.downcase]] == v ||
-              opts[MAPPINGS[k.downcase]] == Mongo::URI::AUTH_MECH_MAP[v]
+          k = k.downcase
+
+          expected =
+            case k
+            when 'authmechanism'
+              Mongo::URI::AUTH_MECH_MAP[v].downcase.to_s
+            when 'authsource'
+              v == '$external' ? 'external' : v.downcase
+            when 'authmechanismproperties'
+              v.reduce({}) do |new_v, prop|
+                prop_key = prop.first.downcase
+                prop_val = prop.last == 'true' ? true : prop.last
+                new_v[prop_key] = prop_val
+
+                new_v
+              end
+            when 'compressors'
+              v.dup.tap do |compressors|
+                # The Ruby driver doesn't support snappy
+                compressors.delete('snappy')
+              end
+            when 'readpreference'
+              Mongo::URI::READ_MODE_MAP[v.downcase].to_s
+            when 'tlsallowinvalidcertificates', 'tlsallowinvalidhostnames', 'tlsinsecure'
+              !v
+            else
+              if k.end_with?('ms') && k != 'wtimeoutms'
+                v / 1000.0
+              elsif v.is_a?(String)
+                v.downcase
+              else
+                v
+              end
+            end
+
+          actual =
+            case MAPPINGS[k]
+            when nil
+              opts[k]
+            when Array
+              opts[MAPPINGS[k].first][MAPPINGS[k].last]
+            else
+              opts[MAPPINGS[k]]
+            end
+
+          actual = actual.to_s if actual.is_a?(Symbol)
+          actual.downcase! if actual.is_a?(String)
+
+          expected == actual
         end
       end
     end

data/spec/support/constraints.rb

@@ -5,11 +5,8 @@ module Constraints
     end
 
     before do
-      client = authorized_client
-      $server_version ||= client.database.command(buildInfo: 1).first['version']
-
-      if version > $server_version
-        skip "Server version #{version} or higher required, we have #{$server_version}"
+      if version > ClusterConfig.instance.server_version
+        skip "Server version #{version} or higher required, we have #{ClusterConfig.instance.server_version}"
       end
     end
   end
@@ -20,12 +17,8 @@ module Constraints
     end
 
     before do
-      client = authorized_client
-      $server_version ||= client.database.command(buildInfo: 1).first['version']
-      short_version = $server_version.split('.')[0..1].join('.')
-
-      if version < short_version
-        skip "Server version #{version} or lower required, we have #{$server_version}"
+      if version < ClusterConfig.instance.short_server_version
+        skip "Server version #{version} or lower required, we have #{ClusterConfig.instance.server_version}"
       end
     end
   end
@@ -47,6 +40,9 @@ module Constraints
     before do
       topology = authorized_client.cluster.topology.class.name.sub(/.*::/, '')
       topology = topology.gsub(/([A-Z])/) { |match| '_' + match.downcase }.sub(/^_/, '')
+      if topology =~ /^replica_set/
+        topology = 'replica_set'
+      end
       unless topologies.include?(topology)
         skip "Topology #{topologies.join(' or ')} required, we have #{topology}"
       end
@@ -69,12 +65,27 @@ module Constraints
   def require_scram_sha_256_support
     before do
       $mongo_server_features ||= begin
-        $mongo_client ||= initialize_scanned_client!
-        $mongo_client.cluster.servers.first.features
+        scanned_client_server!.features
       end
       unless $mongo_server_features.scram_sha_256_enabled?
         skip "SCRAM SHA 256 is not enabled on the server"
       end
     end
   end
+
+  def require_ssl
+    before do
+      unless SpecConfig.instance.ssl?
+        skip "SSL not enabled"
+      end
+    end
+  end
+
+  def require_no_retry_writes
+    before do
+      if SpecConfig.instance.retry_writes?
+        skip "Retry writes is enabled"
+      end
+    end
+  end
 end