mongoid 7.0.12 → 7.3.3

data/spec/shared/shlib/server.sh

@@ -10,21 +10,21 @@ set_fcv() {
 
 add_uri_option() {
   opt=$1
-  
+
   if ! echo $MONGODB_URI |sed -e s,//,, |grep -q /; then
     MONGODB_URI="$MONGODB_URI/"
   fi
-  
+
   if ! echo $MONGODB_URI |grep -q '?'; then
     MONGODB_URI="$MONGODB_URI?"
   fi
-  
+
   MONGODB_URI="$MONGODB_URI&$opt"
 }
 
 prepare_server() {
   arch=$1
-  
+
   if test -n "$USE_OPT_MONGODB"; then
     export BINDIR=/opt/mongodb/bin
     export PATH=$BINDIR:$PATH
@@ -39,7 +39,7 @@ prepare_server() {
   else
     download_version="$MONGODB_VERSION"
   fi
-  
+
   url=`$(dirname $0)/get-mongodb-download-url $download_version $arch`
 
   prepare_server_from_url $url
@@ -57,13 +57,22 @@ prepare_server_from_url() {
 
 install_mlaunch_virtualenv() {
   python2 -V || true
-  # Current virtualenv fails with
-  # https://github.com/pypa/virtualenv/issues/1630
-  python -m pip install 'virtualenv<20' --user
-  venvpath="$MONGO_ORCHESTRATION_HOME"/venv
-  python2 -m virtualenv -p python2 $venvpath
-  . $venvpath/bin/activate
-  pip install 'mtools-legacy[mlaunch]'
+  if ! python2 -m virtualenv -h >/dev/null; then
+    # Current virtualenv fails with
+    # https://github.com/pypa/virtualenv/issues/1630
+    python2 -m pip install 'virtualenv<20' --user
+  fi
+  if test "$USE_SYSTEM_PYTHON_PACKAGES" = 1 &&
+    python2 -m pip list |grep mtools-legacy
+  then
+    # Use the existing mtools-legacy
+    :
+  else
+    venvpath="$MONGO_ORCHESTRATION_HOME"/venv
+    python2 -m virtualenv -p python2 $venvpath
+    . $venvpath/bin/activate
+    pip install 'mtools-legacy[mlaunch]'
+  fi
 }
 
 install_mlaunch_pip() {
@@ -71,7 +80,7 @@ install_mlaunch_pip() {
     # mlaunch is preinstalled in the docker image, do not install it here
     return
   fi
-  
+
   python -V || true
   python3 -V || true
   pythonpath="$MONGO_ORCHESTRATION_HOME"/python
@@ -87,20 +96,20 @@ install_mlaunch_git() {
   python3 -V || true
   which pip || true
   which pip3 || true
-  
+
   if false; then
     if ! virtualenv --version; then
       python3 `which pip3` install --user virtualenv
       export PATH=$HOME/.local/bin:$PATH
       virtualenv --version
     fi
-    
+
     venvpath="$MONGO_ORCHESTRATION_HOME"/venv
     virtualenv -p python3 $venvpath
     . $venvpath/bin/activate
-    
+
     pip3 install psutil pymongo
-    
+
     git clone $repo mlaunch
     cd mlaunch
     git checkout origin/$branch
@@ -109,13 +118,13 @@ install_mlaunch_git() {
   else
     pip install --user 'virtualenv==13'
     export PATH=$HOME/.local/bin:$PATH
-    
+
     venvpath="$MONGO_ORCHESTRATION_HOME"/venv
     virtualenv $venvpath
     . $venvpath/bin/activate
-  
+
     pip install psutil pymongo
-    
+
     git clone $repo mlaunch
     (cd mlaunch &&
       git checkout origin/$branch &&
@@ -124,13 +133,32 @@ install_mlaunch_git() {
   fi
 }
 
+# This function sets followong global variables:
+#   server_cert_path
+#   server_ca_path
+#   server_client_cert_path
+#
+# These variables are used later to connect to processes via mongo client.
 calculate_server_args() {
   local mongo_version=`echo $MONGODB_VERSION |tr -d .`
+
+  if test -z "$mongo_version"; then
+    echo "$MONGODB_VERSION must be set and not contain only dots" 1>&2
+    exit 3
+  fi
+
   if test $mongo_version = latest; then
-    mongo_version=44
+    mongo_version=49
   fi
 
   local args="--setParameter enableTestCommands=1"
+
+  if test $mongo_version -ge 50; then
+    args="$args --setParameter acceptApiVersion2=1"
+  elif test $mongo_version -ge 47; then
+    args="$args --setParameter acceptAPIVersion2=1"
+  fi
+
   # diagnosticDataCollectionEnabled is a mongod-only parameter on server 3.2,
   # and mlaunch does not support specifying mongod-only parameters:
   # https://github.com/rueckstiess/mtools/issues/696
@@ -140,15 +168,31 @@ calculate_server_args() {
   fi
   local uri_options=
   if test "$TOPOLOGY" = replica-set; then
-    args="$args --replicaset --name ruby-driver-rs --nodes 2 --arbiter"
+    args="$args --replicaset --name test-rs --nodes 2 --arbiter"
     export HAVE_ARBITER=1
   elif test "$TOPOLOGY" = sharded-cluster; then
-    args="$args --replicaset --nodes 1 --sharded 1 --name ruby-driver-rs"
+    args="$args --replicaset --nodes 2 --sharded 1 --name test-rs"
     if test -z "$SINGLE_MONGOS"; then
       args="$args --mongos 2"
     fi
-  else
+  elif test "$TOPOLOGY" = standalone; then
     args="$args --single"
+  elif test "$TOPOLOGY" = load-balanced; then
+    args="$args --replicaset --nodes 2 --sharded 1 --name test-rs --port 27117"
+    if test -z "$MRSS_ROOT"; then
+      echo "Please set MRSS_ROOT" 1>&2
+      exit 2
+    fi
+    if test -n "$SINGLE_MONGOS"; then
+      haproxy_config=$MRSS_ROOT/share/haproxy-1.conf
+    else
+      args="$args --mongos 2"
+      haproxy_config=$MRSS_ROOT/share/haproxy-2.conf
+    fi
+    uri_options="$uri_options&loadBalanced=true"
+  else
+    echo "Unknown topology: $TOPOLOGY" 1>&2
+    exit 1
   fi
   if test -n "$MMAPV1"; then
     args="$args --storageEngine mmapv1 --smallfiles --noprealloc"
@@ -171,7 +215,6 @@ calculate_server_args() {
     fi
   fi
 
-  local server_cert_path server_ca_path server_client_cert_path
   if test "$SSL" = ssl || test -n "$OCSP_ALGORITHM"; then
     if test -n "$OCSP_ALGORITHM"; then
       if test "$OCSP_MUST_STAPLE" = 1; then
@@ -250,7 +293,7 @@ calculate_server_args() {
       ocsp_args="$ocsp_args --fault $OCSP_STATUS"
     fi
   fi
-  
+
   OCSP_ARGS="$ocsp_args"
   SERVER_ARGS="$args"
   URI_OPTIONS="$uri_options"
@@ -267,4 +310,58 @@ launch_ocsp_mock() {
 launch_server() {
   local dbdir="$1"
   python -m mtools.mlaunch.mlaunch --dir "$dbdir" --binarypath "$BINDIR" $SERVER_ARGS
+
+  if test "$TOPOLOGY" = sharded-cluster && test $MONGODB_VERSION = 3.6; then
+    # On 3.6 server the sessions collection is not immediately available,
+    # so we run the refreshLogicalSessionCacheNow command on the config server
+    # and again on each mongos in order for the mongoses
+    # to correctly report logicalSessionTimeoutMinutes.
+    mongos_regex="\s*mongos\s+([0-9]+)\s+running\s+[0-9]+"
+    config_server_regex="\s*config\sserver\s+([0-9]+)\s+running\s+[0-9]+"
+    config_server=""
+    mongoses=()
+    if test "$AUTH" = auth
+    then
+      base_url="mongodb://bob:pwd123@localhost"
+    else
+      base_url="mongodb://localhost"
+    fi
+    if test "$SSL" = "ssl"
+    then
+      mongo_command="${BINDIR}/mongo --ssl --sslPEMKeyFile $server_cert_path --sslCAFile $server_ca_path"
+    else
+      mongo_command="${BINDIR}/mongo"
+    fi
+
+    while read -r line
+    do
+        if [[ $line =~ $config_server_regex ]]
+        then
+            port="${BASH_REMATCH[1]}"
+            config_server="${base_url}:${port}"
+        fi
+        if [[ $line =~ $mongos_regex ]]
+        then
+            port="${BASH_REMATCH[1]}"
+            mongoses+=("${base_url}:${port}")
+        fi
+    done < <(python -m mtools.mlaunch.mlaunch list --dir "$dbdir" --binarypath "$BINDIR")
+
+    if [ -n "$config_server" ]; then
+      ${mongo_command} "$config_server" --eval 'db.adminCommand("refreshLogicalSessionCacheNow")'
+      for mongos in ${mongoses[*]}
+      do
+        ${mongo_command} "$mongos" --eval 'db.adminCommand("refreshLogicalSessionCacheNow")'
+      done
+    fi
+  fi
+
+  if test "$TOPOLOGY" = load-balanced; then
+    if test -z "$haproxy_config"; then
+      echo haproxy_config should have been set 1>&2
+      exit 3
+    fi
+
+    haproxy -D -f $haproxy_config -p $mongodb_dir/haproxy.pid
+  fi
 }

data/spec/shared/shlib/set_env.sh

@@ -68,9 +68,12 @@ set_env_ruby() {
     export PATH=`pwd`/ruby-head/bin:`pwd`/ruby-head/lib/ruby/gems/2.6.0/bin:$PATH
     ruby --version
     ruby --version |grep dev
+  elif test "$SYSTEM_RUBY" = 1; then
+    # Nothing
+    :
   else
     if test "$USE_OPT_TOOLCHAIN" = 1; then
-      # nothing, also PATH is already set
+      # Nothing, also PATH is already set
       :
     elif true; then
 

data/spec/spec_helper.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
+# encoding: utf-8
 
 require 'lite_spec_helper'
 
-MODELS = File.join(File.dirname(__FILE__), "app/models")
+MODELS = File.join(File.dirname(__FILE__), "support/models")
 $LOAD_PATH.unshift(MODELS)
 
 require "action_controller"
@@ -17,9 +18,9 @@ else
 end
 
 # When testing locally we use the database named mongoid_test. However when
-# tests are running in parallel on Travis we need to use different database
-# names for each process running since we do not have transactions and want a
-# clean slate before each spec run.
+# tests are running in parallel in a CI environment we need to use different
+# database names for each process running since we do not have transactions
+# and want a clean slate before each spec run.
 def database_id
   "mongoid_test"
 end
@@ -28,19 +29,25 @@ def database_id_alt
   "mongoid_test_alt"
 end
 
+require 'mrss/cluster_config'
+require 'support/client_registry'
+require 'mrss/constraints'
+
+ClusterConfig = Mrss::ClusterConfig
+
 require 'support/authorization'
 require 'support/expectations'
+require 'support/helpers'
 require 'support/macros'
-require 'support/cluster_config'
 require 'support/constraints'
 
-# Give MongoDB time to start up on the travis ci environment.
-if (ENV['CI'] == 'travis' || ENV['CI'] == 'evergreen')
+# Give MongoDB servers time to start up in CI environments
+if SpecConfig.instance.ci?
   starting = true
   client = Mongo::Client.new(SpecConfig.instance.addresses)
   while starting
     begin
-      client.command(Mongo::Server::Monitor::Connection::ISMASTER)
+      client.command(ping: 1)
       break
     rescue Mongo::Error::OperationFailure => e
       sleep(2)
@@ -80,7 +87,7 @@ Mongoid.configure do |config|
   config.load_configuration(CONFIG)
 end
 
-# Autoload every model for the test suite that sits in spec/app/models.
+# Autoload every model for the test suite that sits in spec/support/models.
 Dir[ File.join(MODELS, "*.rb") ].sort.each do |file|
   name = File.basename(file, ".rb")
   autoload name.camelize.to_sym, name
@@ -109,21 +116,28 @@ end
 
 I18n.config.enforce_available_locales = false
 
+# The user must be created before any of the tests are loaded, until
+# https://jira.mongodb.org/browse/MONGOID-4827 is implemented.
+client = Mongo::Client.new(SpecConfig.instance.addresses, server_selection_timeout: 3.03)
+begin
+  # Create the root user administrator as the first user to be added to the
+  # database. This user will need to be authenticated in order to add any
+  # more users to any other databases.
+  client.database.users.create(MONGOID_ROOT_USER)
+rescue Mongo::Error::OperationFailure => e
+ensure
+  client.close
+end
+
 RSpec.configure do |config|
   config.raise_errors_for_deprecations!
+  config.include(Helpers)
   config.include(Mongoid::Expectations)
+  config.extend(Mrss::Constraints)
   config.extend(Constraints)
   config.extend(Mongoid::Macros)
 
   config.before(:suite) do
-    client = Mongo::Client.new(SpecConfig.instance.addresses, server_selection_timeout: 3.03)
-    begin
-      # Create the root user administrator as the first user to be added to the
-      # database. This user will need to be authenticated in order to add any
-      # more users to any other databases.
-      client.database.users.create(MONGOID_ROOT_USER)
-    rescue Exception => e
-    end
     Mongoid.purge!
   end
 

data/spec/support/authorization.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # Set up a root user so we can set up authentication on a database level.
 MONGOID_ROOT_USER = Mongo::Auth::User.new(
   database: Mongo::Database::ADMIN,

data/spec/support/client_registry.rb

@@ -0,0 +1,9 @@
+require 'singleton'
+
+class ClientRegistry
+  include Singleton
+
+  def global_client(name)
+    Mongoid.default_client
+  end
+end

data/spec/support/constraints.rb

@@ -4,22 +4,30 @@
 module Constraints
   RAILS_VERSION = ActiveSupport.version.to_s.split('.')[0..1].join('.').freeze
 
-  def require_driver_query_cache
+  def min_driver_version(version)
+    required_version = version.split('.').map(&:to_i)
+    actual_version = driver_version(required_version.length)
     before(:all) do
-      if !defined?(Mongo::QueryCache)
-        skip "Driver version #{Mongo::VERSION} does not support query cache"
+      if (actual_version <=> required_version) < 0
+        skip "Driver version #{version} or higher is required"
       end
     end
   end
 
-  def require_mongoid_query_cache
-    before (:all) do
-      if defined?(Mongo::QueryCache)
-        skip "Mongoid uses the driver query cache in driver versions that support it"
+  def max_driver_version(version)
+    required_version = version.split('.').map(&:to_i)
+    actual_version = driver_version(required_version.length)
+    before(:all) do
+      if (actual_version <=> required_version) > 0
+        skip "Driver version #{version} or lower is required"
       end
     end
   end
 
+  def driver_version(precision)
+    Mongo::VERSION.split('.')[0...precision].map(&:to_i)
+  end
+
   def min_rails_version(version)
     unless version =~ /\A\d+\.\d+\z/
       raise ArgumentError, "Version can only be major.minor: #{version}"
@@ -43,230 +51,4 @@ module Constraints
       end
     end
   end
-
-  def min_server_version(version)
-    unless version =~ /\A\d+\.\d+\z/
-      raise ArgumentError, "Version can only be major.minor: #{version}"
-    end
-
-    before(:all) do
-      if version > ClusterConfig.instance.server_version
-        skip "Server version #{version} or higher required, we have #{ClusterConfig.instance.server_version}"
-      end
-    end
-  end
-
-  def max_server_version(version)
-    unless version =~ /\A\d+\.\d+\z/
-      raise ArgumentError, "Version can only be major.minor: #{version}"
-    end
-
-    before(:all) do
-      if version < ClusterConfig.instance.short_server_version
-        skip "Server version #{version} or lower required, we have #{ClusterConfig.instance.server_version}"
-      end
-    end
-  end
-
-  def require_topology(*topologies)
-    invalid_topologies = topologies - [:single, :replica_set, :sharded]
-
-    unless invalid_topologies.empty?
-      raise ArgumentError, "Invalid topologies requested: #{invalid_topologies.join(', ')}"
-    end
-
-    before(:all) do
-      unless topologies.include?(topology = ClusterConfig.instance.topology)
-        skip "Topology #{topologies.join(' or ')} required, we have #{topology}"
-      end
-    end
-  end
-
-  def max_example_run_time(timeout)
-    around do |example|
-      TimeoutInterrupt.timeout(timeout, TimeoutInterrupt::Error.new("Test execution terminated after #{timeout} seconds")) do
-        example.run
-      end
-    end
-  end
-
-  def require_transaction_support
-    before(:all) do
-      case ClusterConfig.instance.topology
-      when :single
-        skip 'Transactions tests require a replica set (4.0+) or a sharded cluster (4.2+)'
-      when :replica_set
-        unless ClusterConfig.instance.server_version >= '4.0'
-          skip 'Transactions tests in a replica set topology require server 4.0+'
-        end
-      when :sharded
-        unless ClusterConfig.instance.server_version >= '4.2'
-          skip 'Transactions tests in a sharded cluster topology require server 4.2+'
-        end
-      else
-        raise NotImplementedError
-      end
-    end
-  end
-
-  def require_tls
-    before(:all) do
-      unless SpecConfig.instance.ssl?
-        skip "SSL not enabled"
-      end
-    end
-  end
-
-  def require_no_tls
-    before(:all) do
-      if SpecConfig.instance.ssl?
-        skip "SSL enabled"
-      end
-    end
-  end
-
-  def require_local_tls
-    require_tls
-  end
-
-  def require_no_retry_writes
-    before(:all) do
-      if SpecConfig.instance.retry_writes?
-        skip "Retry writes is enabled"
-      end
-    end
-  end
-
-  def require_compression
-    before(:all) do
-      if SpecConfig.instance.compressors.nil?
-        skip "Compression is not enabled"
-      end
-    end
-  end
-
-  def require_no_compression
-    before(:all) do
-      if SpecConfig.instance.compressors
-        skip "Compression is enabled"
-      end
-    end
-  end
-
-  def ruby_version_gte(version)
-    before(:all) do
-      if RUBY_VERSION < version
-        skip "Ruby version #{version} or higher required"
-      end
-    end
-  end
-
-  def ruby_version_lt(version)
-    before(:all) do
-      if RUBY_VERSION >= version
-        skip "Ruby version less than #{version} required"
-      end
-    end
-  end
-
-  def require_auth
-    before(:all) do
-      unless ENV['AUTH'] == 'auth' || SpecConfig.instance.user || ClusterConfig.instance.auth_enabled?
-        skip "Auth required"
-      end
-    end
-  end
-
-  def require_no_auth
-    before(:all) do
-      if ENV['AUTH'] == 'auth' || SpecConfig.instance.user || ClusterConfig.instance.auth_enabled?
-        skip "Auth not allowed"
-      end
-    end
-  end
-
-  def require_no_x509_auth
-    before(:all) do
-      if SpecConfig.instance.x509_auth?
-        skip "X.509 auth not allowed"
-      end
-    end
-  end
-
-  # Can the driver specify a write concern that won't be overridden?
-  # (mongos 4.0+ overrides the write concern)
-  def require_set_write_concern
-    before(:all) do
-      if ClusterConfig.instance.topology == :sharded && ClusterConfig.instance.short_server_version >= '4.0'
-        skip "mongos 4.0+ overrides write concern"
-      end
-    end
-  end
-
-  def require_multi_shard
-    before(:all) do
-      if ClusterConfig.instance.topology == :sharded && SpecConfig.instance.addresses.length == 1
-        skip 'Test requires a minimum of two shards if run in sharded topology'
-      end
-    end
-  end
-
-  def require_no_multi_shard
-    before(:all) do
-      if ClusterConfig.instance.topology == :sharded && SpecConfig.instance.addresses.length > 1
-        skip 'Test requires a single shard if run in sharded topology'
-      end
-    end
-  end
-
-  def require_wired_tiger
-    before(:all) do
-      if ClusterConfig.instance.storage_engine != :wired_tiger
-        skip 'Test requires WiredTiger storage engine'
-      end
-    end
-  end
-
-  def require_wired_tiger_on_36
-    before(:all) do
-      if ClusterConfig.instance.short_server_version >= '3.6'
-        if ClusterConfig.instance.storage_engine != :wired_tiger
-          skip 'Test requires WiredTiger storage engine on 3.6+ servers'
-        end
-      end
-    end
-  end
-
-  def require_mmapv1
-    before(:all) do
-      if ClusterConfig.instance.storage_engine != :mmapv1
-        skip 'Test requires MMAPv1 storage engine'
-      end
-    end
-  end
-
-  def require_enterprise
-    before(:all) do
-      unless ClusterConfig.instance.enterprise?
-        skip 'Test requires enterprise build of MongoDB'
-      end
-    end
-  end
-
-  # Integration tests for SRV polling require internet connectivity to
-  # look up SRV records and a sharded cluster configured on default port on
-  # localhost (localhost:27017, localhost:27018).
-  def require_default_port_deployment
-    # Because the DNS records at test1.test.build.10gen.cc point to
-    # localhost:27017 & localhost:27018, the test suite must have been
-    # configured to use these addresses
-    before(:all) do
-      have_default_port = SpecConfig.instance.addresses.any? do |address|
-        %w(127.0.0.1 127.0.0.1:27017 localhost localhost:27017).include?(address)
-      end
-      unless have_default_port
-        skip 'This test requires the test suite to be configured for localhost:27017'
-      end
-    end
-  end
 end

data/spec/support/expectations.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Expectations
 
@@ -11,14 +14,16 @@ module Mongoid
     end
 
     def expect_query(number)
+      rv = nil
       RSpec::Mocks.with_temporary_scope do
         if number > 0
           expect_any_instance_of(connection_class).to receive(:command_started).exactly(number).times.and_call_original
         else
           expect_any_instance_of(connection_class).not_to receive(:command_started)
         end
-        yield
+        rv = yield
       end
+      rv
     end
 
     def expect_no_queries(&block)

data/spec/support/helpers.rb

@@ -0,0 +1,11 @@
+module Helpers
+  # Reloads the specified model class.
+  #
+  # @param [ String | Symbol ] name Class name to reload.
+  def reload_model(name)
+    Object.class_eval do
+      remove_const(name)
+    end
+    load "spec/support/models/#{name.to_s.underscore}.rb"
+  end
+end

data/spec/support/macros.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# encoding: utf-8
 
 module Mongoid
   module Macros