mongoid 8.1.11 → 9.0.0

data/spec/shared/shlib/server.sh

@@ -35,34 +35,38 @@ add_uri_option() {
 }
 
 prepare_server() {
+  arch=$1
+
   if test -n "$USE_OPT_MONGODB"; then
     export BINDIR=/opt/mongodb/bin
     export PATH=$BINDIR:$PATH
     return
   fi
 
-  . $PROJECT_DIRECTORY/.mod/drivers-evergreen-tools/.evergreen/download-mongodb.sh
+  if test "$MONGODB_VERSION" = latest; then
+    # Test on the most recent published 4.3 release.
+    # https://jira.mongodb.org/browse/RUBY-1724
 
-  get_distro
-  arch="${1:-$DISTRO}"
+    . $PROJECT_DIRECTORY/.mod/drivers-evergreen-tools/.evergreen/download-mongodb.sh
+
+    get_distro
+    get_mongodb_download_url_for "$DISTRO" "latest"
+    prepare_server_from_url $MONGODB_DOWNLOAD_URL
+  else
+    download_version="$MONGODB_VERSION"
+    url=`$(dirname $0)/get-mongodb-download-url $download_version $arch`
+    prepare_server_from_url $url
+  fi
 
-  get_mongodb_download_url_for "$arch" "$MONGODB_VERSION"
-  prepare_server_from_url "$MONGODB_DOWNLOAD_URL" "$MONGOSH_DOWNLOAD_URL"
 }
 
 prepare_server_from_url() {
-  server_url=$1
-  mongosh_url=$2
+  url=$1
 
-  dirname=`basename $server_url |sed -e s/.tgz//`
+  dirname=`basename $url |sed -e s/.tgz//`
   mongodb_dir="$MONGO_ORCHESTRATION_HOME"/mdb/"$dirname"
   mkdir -p "$mongodb_dir"
-  curl --retry 3 $server_url | tar xz -C "$mongodb_dir" --strip-components 1 -f -
-
-  if test -n "$mongosh_url"; then
-    curl --retry 3 $mongosh_url | tar xz -C "$mongodb_dir" --strip-components 1 -f -
-  fi
-
+  curl --retry 3 $url | tar xz -C "$mongodb_dir" --strip-components 1 -f -
   BINDIR="$mongodb_dir"/bin
   export PATH="$BINDIR":$PATH
 }
@@ -166,26 +170,13 @@ install_mlaunch_git() {
   fi
 }
 
-install_haproxy() {
-  if ! command -v haproxy &> /dev/null; then
-    if ! command -v apt-get &> /dev/null; then
-      # no apt-get; assume RHEL
-      sudo yum -y install haproxy
-    else
-      sudo apt-get update && sudo apt-get install --yes haproxy
-    fi
-  else
-    echo 'haproxy is present'
-  fi
-}
-
 install_cmake() {
   if ! command -v cmake &> /dev/null; then
     if ! command -v apt-get &> /dev/null; then
       # no apt-get; assume RHEL
       sudo yum -y install cmake libarchive
     else
-      sudo apt-get update && sudo apt-get install --yes cmake
+      sudo apt-get install --yes cmake
     fi
   else
     echo 'cmake is present'
@@ -218,14 +209,17 @@ calculate_server_args() {
     args="$args --setParameter acceptAPIVersion2=1"
   fi
 
-  args="$args --setParameter diagnosticDataCollectionEnabled=false"
-
+  # 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
+  # Pass it to 3.4 and newer servers where it is accepted by all daemons.
+  if test $mongo_version -ge 34; then
+    args="$args --setParameter diagnosticDataCollectionEnabled=false"
+  fi
   local uri_options=
   if test "$TOPOLOGY" = replica-set; then
     args="$args --replicaset --name test-rs --nodes 2 --arbiter"
     export HAVE_ARBITER=1
-  elif test "$TOPOLOGY" = replica-set-single-node; then
-    args="$args --replicaset --name test-rs --nodes 1"
   elif test "$TOPOLOGY" = sharded-cluster; then
     args="$args --replicaset --nodes 2 --sharded 1 --name test-rs"
     if test -z "$SINGLE_MONGOS"; then

data/spec/shared/shlib/set_env.sh

@@ -1,5 +1,6 @@
 # When changing, also update the hash in share/Dockerfile.
-JDK_VERSION=jdk21
+TOOLCHAIN_VERSION=ded7ea845b08cf96f11a747d9540ba3199580dea
+JDK_VERSION=jdk17
 
 set_env_java() {
   ls -l /opt || true
@@ -89,13 +90,34 @@ set_env_ruby() {
     if test "$USE_OPT_TOOLCHAIN" = 1; then
       # Nothing, also PATH is already set
       :
+    elif true; then
+
+    # For testing toolchains:
+    #toolchain_url=https://s3.amazonaws.com//mciuploads/mongo-ruby-toolchain/`host_distro`/f11598d091441ffc8d746aacfdc6c26741a3e629/mongo_ruby_driver_toolchain_`host_distro |tr - _`_patch_f11598d091441ffc8d746aacfdc6c26741a3e629_5e46f2793e8e866f36eda2c5_20_02_14_19_18_18.tar.gz
+    toolchain_url=http://boxes.10gen.com/build/toolchain-drivers/mongo-ruby-driver/$TOOLCHAIN_VERSION/`host_distro`/$RVM_RUBY.tar.xz
+    curl --retry 3 -fL $toolchain_url |tar Jxf -
+    export PATH=`pwd`/rubies/$RVM_RUBY/bin:$PATH
+    #export PATH=`pwd`/rubies/python/3/bin:$PATH
+
+    # Attempt to get bundler to report all errors - so far unsuccessful
+    #curl --retry 3 -o bundler-openssl.diff https://github.com/bundler/bundler/compare/v2.0.1...p-mongo:report-errors.diff
+    #find . -path \*/lib/bundler/fetcher.rb -exec patch {} bundler-openssl.diff \;
+
     else
-      # For testing unpublished builds:
-      #build_url=https://s3.amazonaws.com/mciuploads/mongo-ruby-toolchain/library/`host_distro`/$RVM_RUBY.tar.xz
 
-      build_url=http://boxes.10gen.com/build/toolchain-drivers/mongo-ruby-toolchain/library/`host_distro`/$RVM_RUBY.tar.xz
-      curl --retry 3 -fL $build_url |tar Jxf -
-      export PATH=`pwd`/rubies/$RVM_RUBY/bin:$PATH
+    # Normal operation
+    if ! test -d $HOME/.rubies/$RVM_RUBY/bin; then
+      echo "Ruby directory does not exist: $HOME/.rubies/$RVM_RUBY/bin" 1>&2
+      echo "Contents of /opt:" 1>&2
+      ls -l /opt 1>&2 || true
+      echo ".rubies symlink:" 1>&2
+      ls -ld $HOME/.rubies 1>&2 || true
+      echo "Our rubies:" 1>&2
+      ls -l $HOME/.rubies 1>&2 || true
+      exit 2
+    fi
+    export PATH=$HOME/.rubies/$RVM_RUBY/bin:$PATH
+
     fi
 
     ruby --version
@@ -106,5 +128,19 @@ set_env_ruby() {
 
     ruby -v |fgrep $ruby_name
     ruby -v |fgrep $ruby_version
+
+    # We shouldn't need to update rubygems, and there is value in
+    # testing on whatever rubygems came with each supported ruby version
+    #echo 'updating rubygems'
+    #gem update --system
+
+    # Only install bundler when not using ruby-head.
+    # ruby-head comes with bundler and gem complains
+    # because installing bundler would overwrite the bundler binary.
+    # We now install bundler in the toolchain, hence nothing needs to be done
+    # in the tests.
+    if false && echo "$RVM_RUBY" |grep -q jruby; then
+      gem install bundler -v '<2'
+    fi
   fi
 }

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'lite_spec_helper'
 
@@ -48,11 +49,15 @@ require 'support/expectations'
 require 'support/helpers'
 require 'support/macros'
 require 'support/constraints'
+require 'support/crypt'
+
+use_ssl = %w[ ssl 1 true ].include?(ENV['SSL'])
+ssl_options = { ssl: use_ssl }.freeze
 
 # Give MongoDB servers time to start up in CI environments
 if SpecConfig.instance.ci?
   starting = true
-  client = Mongo::Client.new(SpecConfig.instance.addresses)
+  client = Mongo::Client.new(SpecConfig.instance.addresses, ssl_options)
   while starting
     begin
       client.command(ping: 1)
@@ -69,15 +74,15 @@ CONFIG = {
     default: {
       database: database_id,
       hosts: SpecConfig.instance.addresses,
-      options: {
+      options: ssl_options.merge(
         server_selection_timeout: 3.42,
         wait_queue_timeout: 1,
         max_pool_size: 5,
         heartbeat_frequency: 180,
-        user: MONGOID_ROOT_USER.name,
-        password: MONGOID_ROOT_USER.password,
-        auth_source: Mongo::Database::ADMIN,
-      }
+        user: SpecConfig.instance.uri.client_options[:user] || MONGOID_ROOT_USER.name,
+        password: SpecConfig.instance.uri.client_options[:password] || MONGOID_ROOT_USER.password,
+        auth_source: Mongo::Database::ADMIN
+      )
     }
   },
   options: {
@@ -101,16 +106,6 @@ Dir[ File.join(MODELS, "*.rb") ].sort.each do |file|
   autoload name.camelize.to_sym, name
 end
 
-module Rails
-  class Application
-  end
-end
-
-module MyApp
-  class Application < Rails::Application
-  end
-end
-
 module Mongoid
   class Query
     include Mongoid::Criteria::Queryable
@@ -122,24 +117,27 @@ ActiveSupport::Inflector.inflections do |inflect|
   inflect.singular("address_components", "address_component")
 end
 
-I18n.config.enforce_available_locales = false
+Time.zone = 'UTC'
 
+I18n.config.enforce_available_locales = false
 
 if %w(yes true 1).include?((ENV['TEST_I18N_FALLBACKS'] || '').downcase)
   require "i18n/backend/fallbacks"
 end
 
-# 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
+unless SpecConfig.instance.atlas?
+  # 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
 end
 
 RSpec.configure do |config|

data/spec/support/authorization.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 # Set up a root user so we can set up authentication on a database level.
 MONGOID_ROOT_USER = Mongo::Auth::User.new(

data/spec/support/client_registry.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 require 'singleton'
 
 class ClientRegistry

data/spec/support/constraints.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Constraints
   RAILS_VERSION = ActiveSupport.version.to_s.split('.')[0..1].join('.').freeze

data/spec/support/crypt/models.rb

@@ -0,0 +1,50 @@
+# rubocop:todo all
+module Crypt
+  class Patient
+    include Mongoid::Document
+
+    encrypt_with key_id: "grolrnFVSSW9Gq04Q87R9Q=="
+
+    field :code, type: String
+    field :medical_records, type: Array, encrypt: { deterministic: false}
+    field :blood_type, type: String, encrypt: {
+      deterministic: false,
+      key_name_field: :blood_type_key_name
+    }
+    field :ssn, type: Integer, encrypt: { deterministic: true }
+    field :blood_type_key_name, type: String
+
+    embeds_one :insurance, class_name: "Crypt::Insurance"
+  end
+
+  class Insurance
+    include Mongoid::Document
+
+    field :policy_number, type: Integer, encrypt: { deterministic: true }
+    embedded_in :patient, class_name: "Crypt::Patient"
+  end
+
+  class User
+    include Mongoid::Document
+
+    field :name, type: String, encrypt: {
+      key_id: "grolrnFVSSW9Gq04Q87R9Q==",
+      deterministic: false
+    }
+    field :email, type: String, encrypt: {
+      key_id: "S34mE/HhSFSym3yErpER6Q==",
+      deterministic: true
+    }
+  end
+
+  class Car
+    include Mongoid::Document
+
+    store_in database: 'vehicles'
+
+    encrypt_with key_id: "grolrnFVSSW9Gq04Q87R9Q==", deterministic: true
+
+    field :vin, type: String, encrypt: true
+    field :make, type: String
+  end
+end

data/spec/support/crypt.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  # This module includes helpers for testing encryption.
+  module Crypt
+
+    shared_context 'with encryption' do
+      let(:mongocryptd_port) do
+        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
+
+      let(:extra_options) do
+        {
+          mongocryptd_spawn_args: ["--port=#{mongocryptd_port}"],
+          mongocryptd_uri: "mongodb://localhost:#{mongocryptd_port}",
+        }
+      end
+
+      let(:crypt_shared_lib_path) do
+        ENV['MONGO_RUBY_DRIVER_CRYPT_SHARED_LIB_PATH']
+      end
+
+      let(:key_vault_client) do
+        Mongo::Client.new(SpecConfig.instance.addresses, database: key_vault_database)
+      end
+
+      let(:key_vault_database) do
+        'encryption'
+      end
+
+      let(:key_vault_collection) do
+        '__keyVault'
+      end
+
+      let(:key_vault_namespace) do
+        "#{key_vault_database}.#{key_vault_collection}"
+      end
+
+      let(:local_master_key) do
+        'A' * 96
+      end
+
+      let(:kms_providers) do
+        {
+          local: {
+            key: local_master_key
+          }
+        }
+      end
+
+      let(:key_alt_name) do
+        'mongoid_test_key'
+      end
+
+      let(:client_encryption) do
+        Mongo::ClientEncryption.new(
+          key_vault_client,
+          key_vault_namespace: key_vault_namespace,
+          kms_providers: kms_providers
+        )
+      end
+
+      let(:data_key_id) do
+        if (data_key = client_encryption.get_key_by_alt_name(key_alt_name))
+          Base64.encode64(data_key['_id'].data)
+        else
+          key_id = client_encryption.create_data_key('local', key_alt_names: [key_alt_name])
+          Base64.encode64(key_id.data).strip
+        end
+      end
+    end
+  end
+end

data/spec/support/expectations.rb

@@ -1,31 +1,29 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Expectations
-    # Previously this method used RSpec::Mocks with .exactly.times(n).and_call_original,
-    # which stopped working reliably in Ruby 3.3. Now we directly wrap the target method.
-    def expect_query(number)
-      if %i[ sharded load-balanced ].include?(ClusterConfig.instance.topology) && number > 0
-        skip 'This spec requires replica set or standalone topology'
-      end
 
-      klass = Mongo::Server::ConnectionBase
-      original_method = klass.instance_method(:command_started)
-      query_count = 0
+    def connection_class
+      if defined?(Mongo::Server::ConnectionBase)
+        Mongo::Server::ConnectionBase
+      else
+        # Pre-2.8 drivers
+        Mongo::Server::Connection
+      end
+    end
 
-      begin
-        klass.define_method(:command_started) do |*args, **kwargs|
-          query_count += 1
-          original_method.bind_call(self, *args, **kwargs)
+    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
-
-        result = yield
-        expect(query_count).to eq(number)
-        result
-      ensure
-        klass.remove_method(:command_started)
-        klass.define_method(:command_started, original_method)
+        rv = yield
       end
+      rv
     end
 
     def expect_no_queries(&block)

data/spec/support/feature_sandbox.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+# A helper utility for allowing features to be loaded and constants defined
+# inside a sandbox, where they can be unloaded and undefined when finished.
+#
+# @example Quarantining a block of code.
+#   FeatureSandbox.quarantine do
+#      require "support/rails_mock"
+#      expect(defined?(Rails)).to be == "constant"
+#   end
+#   expect(defined?(Rails)).to be_nil
+module FeatureSandbox
+  extend self
+
+  # Initiates the quarantine by noting the current state of the top-level
+  # constants, the $LOADED_FEATURES array, and the $LOAD_PATH.
+  #
+  # @return Hash The current state of the environment.
+  def start_quarantine
+    { constants: Object.constants.dup,
+      features: $LOADED_FEATURES.dup,
+      load_path: $LOAD_PATH.dup }
+  end
+
+  # Terminates the quarantine indicated by the given state, by rolling back
+  # changes made since the state was created.
+  #
+  # @param [ Hash ] state The state object to roll the environment back to.
+  def end_quarantine(state)
+    restore_load_path(state[:load_path])
+    unload_features($LOADED_FEATURES - state[:features])
+    unload_constants(Object, Object.constants - state[:constants])
+  end
+
+  # A convenience method for starting a quarantine, yielding to a block, and
+  # then ending the quarantine when the block finishes.
+  #
+  # @yield The block will be executed within the quarantine, with all changes
+  #    to state rolled back upon completion.
+  def quarantine
+    state = start_quarantine
+    yield
+  ensure
+    end_quarantine(state)
+  end
+
+  private
+
+  def restore_load_path(list)
+    $LOAD_PATH.replace(list)
+  end
+
+  def unload_features(list)
+    list.each do |path|
+      $LOADED_FEATURES.delete(path)
+    end
+  end
+
+  def unload_constants(parent, list)
+    list.each do |name|
+      obj = parent.const_get(name)
+      if obj.is_a?(Module) && obj.constants(false).any?
+        unload_constants(obj, obj.constants(false))
+      end
+
+      Mongoid.deregister_model(obj) if obj.is_a?(Mongoid::Document)
+
+      parent.send(:remove_const, name)
+    end
+  end
+end

data/spec/support/helpers.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 module Helpers
   # Reloads the specified model class.
   #

data/spec/support/immutable_ids.rb

@@ -1,30 +1,31 @@
+# rubocop:todo all
 module Mongoid
   module ImmutableIds
     def immutable_id_examples_as(name)
       shared_examples_for name do
         shared_examples 'a persisted document' do
-          it 'should ignore the change and issue a warning' do
-            expect(Mongoid::Warnings).to receive(:warn_mutable_ids)
-            expect { invoke_operation! }.not_to raise_error
-            expect(id_is_unchanged).not_to be legacy_behavior_expects_id_to_change
+          it 'should disallow _id to be updated' do
+            expect { invoke_operation! }
+              .to raise_error(Mongoid::Errors::ImmutableAttribute)
+          end
+    
+          context 'when immutable_ids is false' do
+            before { Mongoid::Config.immutable_ids = false }
+            after { Mongoid::Config.immutable_ids = true }
+
+            it 'should ignore the change and issue a warning' do
+              expect(Mongoid::Warnings).to receive(:warn_mutable_ids)
+              expect { invoke_operation! }.not_to raise_error
+              expect(id_is_unchanged).not_to be legacy_behavior_expects_id_to_change
+            end
           end
 
-          context 'when immutable_ids is true' do
-            before { Mongoid::Config.immutable_ids = true }
-            after { Mongoid::Config.immutable_ids = false }
+          context 'when id is set to the existing value' do
+            let(:new_id_value) { object._id }
 
-            it 'should disallow _id to be updated' do
+            it 'should allow the update to proceed' do
               expect { invoke_operation! }
-                .to raise_error(Mongoid::Errors::ImmutableAttribute)
-            end
-      
-            context 'when id is set to the existing value' do
-              let(:new_id_value) { object._id }
-
-              it 'should allow the update to proceed' do
-                expect { invoke_operation! }
-                  .not_to raise_error
-              end
+                .not_to raise_error
             end
           end
         end
@@ -77,7 +78,8 @@ module Mongoid
 
               context 'updating embeds_one via parent' do
                 context 'when immutable_ids is false' do
-                  before { expect(Mongoid::Config.immutable_ids).to be false }
+                  before { Mongoid::Config.immutable_ids = false }
+                  after { Mongoid::Config.immutable_ids = true }
 
                   it 'should ignore the change' do
                     expect(Mongoid::Warnings).to receive(:warn_mutable_ids)
@@ -94,8 +96,7 @@ module Mongoid
                 end
 
                 context 'when immutable_ids is true' do
-                  before { Mongoid::Config.immutable_ids = true }
-                  after { Mongoid::Config.immutable_ids = false }
+                  before { expect(Mongoid::Config.immutable_ids).to be true }
 
                   it 'should raise an exception' do
                     parent.pet = pet = Pet.new

data/spec/support/macros.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Macros
@@ -73,7 +74,7 @@ module Mongoid
 
     def query_cache_enabled
       around do |example|
-        Mongoid::QueryCache.cache do
+        Mongo::QueryCache.cache do
           example.run
         end
       end
@@ -102,12 +103,9 @@ module Mongoid
       end
     end
 
-    def time_zone_override(tz)
+    def time_zone_override(time_zone)
       around do |example|
-        old_tz = Time.zone
-        Time.zone = tz
-        example.run
-        Time.zone = old_tz
+        Time.use_zone(time_zone) { example.run }
       end
     end
 

data/spec/support/models/account.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 class Account
   include Mongoid::Document

data/spec/support/models/acolyte.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 class Acolyte
   include Mongoid::Document

data/spec/support/models/actor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 class Actor
   include Mongoid::Document

data/spec/support/models/actress.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 class Actress < Actor
 end