mongoid 8.0.12 → 8.1.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
 }
@@ -78,7 +82,7 @@ install_mlaunch_venv() {
     # Debian11/Ubuntu2204 have venv installed, but it is nonfunctional unless
     # the python3-venv package is also installed (it lacks the ensurepip
     # module).
-    sudo apt-get update && sudo apt-get install --yes python3-venv
+    sudo apt-get install --yes python3-venv
   fi
   if test "$USE_SYSTEM_PYTHON_PACKAGES" = 1 &&
     python3 -m pip list |grep mtools
@@ -100,7 +104,6 @@ install_mlaunch_venv() {
     #pip install 'mtools==1.7' 'pymongo==4.1' python-dateutil psutil
 
     # dateutil dependency is missing in mtools: https://github.com/rueckstiess/mtools/issues/864
-    pip install --upgrade setuptools
     pip install 'mtools-legacy[mlaunch]' 'pymongo<4' python-dateutil
   fi
 }
@@ -166,26 +169,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 +208,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,15 +1,39 @@
 # When changing, also update the hash in share/Dockerfile.
-JDK_VERSION=jdk21
+TOOLCHAIN_VERSION=e8c60866f54bed7e336a37df3a97d6ae1b971b7d
 
 set_env_java() {
   ls -l /opt || true
   ls -l /usr/lib/jvm || true
 
   # Use toolchain java if it exists
-  if [ -f /opt/java/$JDK_VERSION/bin/java ]; then
-    export JAVACMD=/opt/java/$JDK_VERSION/bin/java
+  if [ -f /opt/java/jdk8/bin/java ]; then
+    export JAVACMD=/opt/java/jdk8/bin/java
+    #export PATH=$PATH:/opt/java/jdk8/bin
+  fi
+
+  # ppc64le has it in a different place
+  if test -z "$JAVACMD" && [ -f /usr/lib/jvm/java-1.8.0/bin/java ]; then
+    export JAVACMD=/usr/lib/jvm/java-1.8.0/bin/java
+    #export PATH=$PATH:/usr/lib/jvm/java-1.8.0/bin
+  fi
+
+  if true; then
+    # newer
+    # rhel71-ppc, https://jira.mongodb.org/browse/BUILD-9231
+    if test -z "$JAVACMD" &&
+      (ls /opt/java || true) |grep -q java-1.8.0-openjdk-1.8.0 &&
+      test -f /opt/java/java-1.8.0-openjdk-1.8.0*/bin/java;
+    then
+      path=$(cd /opt/java && ls -d java-1.8.0-openjdk-1.8.0* |head -n 1)
+      export JAVACMD=/opt/java/"$path"/bin/java
+    fi
   else
-    echo Could not find $JDK_VERSION in /opt/java
+    # older
+    # rhel71-ppc seems to have an /opt/java/jdk8/bin/java but it doesn't work
+    if test -n "$JAVACMD" && ! exec $JAVACMD -version; then
+      JAVACMD=
+      # we will try the /usr/lib/jvm then
+    fi
   fi
 
   if test -n "$JAVACMD"; then
@@ -89,13 +113,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 +151,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

@@ -124,6 +124,11 @@ end
 
 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)

data/spec/support/expectations.rb

@@ -2,30 +2,27 @@
 
 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/immutable_ids.rb

@@ -0,0 +1,118 @@
+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
+          end
+
+          context 'when immutable_ids is true' do
+            before { Mongoid::Config.immutable_ids = true }
+            after { Mongoid::Config.immutable_ids = false }
+
+            it 'should disallow _id to be updated' 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
+            end
+          end
+        end
+
+        context 'when the field is _id' do
+          let(:new_id_value) { 1234 }
+
+          context 'when the document is top-level' do    
+            let(:legacy_behavior_expects_id_to_change) { false }
+
+            context 'when the document is new' do
+              let(:object) { Person.new }
+    
+              it 'should allow _id to be updated' do
+                invoke_operation!
+                expect(object.new_record?).to be false
+                expect(object.reload._id).to be == new_id_value
+              end
+            end
+    
+            context 'when the document has been persisted' do
+              let(:object) { Person.create }
+              let!(:original_id) { object._id }
+              let(:id_is_unchanged) { Person.exists?(original_id) }
+    
+              it_behaves_like 'a persisted document'
+            end
+          end
+    
+          context 'when the document is embedded' do
+            let(:parent) { Person.create }
+            let(:legacy_behavior_expects_id_to_change) { true }
+
+            context 'when the document is new' do
+              let(:object) { parent.favorites.new }
+    
+              it 'should allow _id to be updated' do
+                invoke_operation!
+                expect(object.new_record?).to be false
+                expect(parent.reload.favorites.first._id).to be == new_id_value
+              end
+            end
+    
+            context 'when the document has been persisted' do
+              let(:object) { parent.favorites.create }
+              let!(:original_id) { object._id }
+              let(:id_is_unchanged) { parent.favorites.where(_id: original_id).exists? }
+      
+              it_behaves_like 'a persisted document'
+
+              context 'updating embeds_one via parent' do
+                context 'when immutable_ids is false' do
+                  before { expect(Mongoid::Config.immutable_ids).to be false }
+
+                  it 'should ignore the change' do
+                    expect(Mongoid::Warnings).to receive(:warn_mutable_ids)
+
+                    parent.pet = pet = Pet.new
+                    parent.save
+
+                    original_id = pet._id
+                    new_id = BSON::ObjectId.new
+
+                    expect { parent.update(pet: { _id: new_id }) }.not_to raise_error
+                    expect(parent.reload.pet._id.to_s).to be == original_id.to_s
+                  end
+                end
+
+                context 'when immutable_ids is true' do
+                  before { Mongoid::Config.immutable_ids = true }
+                  after { Mongoid::Config.immutable_ids = false }
+
+                  it 'should raise an exception' do
+                    parent.pet = pet = Pet.new
+                    parent.save
+
+                    original_id = pet._id
+                    new_id = BSON::ObjectId.new
+
+                    expect { parent.update(pet: { _id: new_id }) }
+                      .to raise_error(Mongoid::Errors::ImmutableAttribute)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/macros.rb

@@ -2,9 +2,6 @@
 
 module Mongoid
   module Macros
-    class I18nBackendWithFallbacks < I18n::Backend::Simple
-      include I18n::Backend::Fallbacks
-    end
 
     def use_spec_mongoid_config
       around do |example|
@@ -43,18 +40,6 @@ module Mongoid
       end
     end
 
-    def with_i18n_fallbacks
-      require_fallbacks
-
-      around do |example|
-        old_backend = I18n.backend
-        I18n.backend = I18nBackendWithFallbacks.new
-        example.run
-      ensure
-        I18n.backend = old_backend
-      end
-    end
-
     def driver_config_override(key, value)
       around do |example|
         existing = Mongo.send(key)
@@ -93,5 +78,52 @@ module Mongoid
         end
       end
     end
+
+    def override_query_cache(enabled)
+      around do |example|
+        cache_enabled = Mongo::QueryCache.enabled?
+        Mongo::QueryCache.enabled = enabled
+        example.run
+        Mongo::QueryCache.enabled = cache_enabled
+      end
+    end
+
+    # Override the global persistence context.
+    #
+    # @param [ :client, :database ] component The component to override.
+    # @param [ Object ] value The value to override to.
+    def persistence_context_override(component, value)
+      around do |example|
+        meth = "#{component}_override"
+        old_value = Mongoid::Threaded.send(meth)
+        Mongoid::Threaded.send("#{meth}=", value)
+        example.run
+        Mongoid::Threaded.send("#{meth}=", old_value)
+      end
+    end
+
+    def time_zone_override(tz)
+      around do |example|
+        old_tz = Time.zone
+        Time.zone = tz
+        example.run
+        Time.zone = old_tz
+      end
+    end
+
+    def with_default_i18n_configs
+      around do |example|
+        I18n.locale = :en
+        I18n.default_locale = :en
+        I18n.try(:fallbacks=, I18n::Locale::Fallbacks.new)
+        I18n.enforce_available_locales = false
+        example.run
+      ensure
+        I18n.locale = :en
+        I18n.default_locale = :en
+        I18n.try(:fallbacks=, I18n::Locale::Fallbacks.new)
+        I18n.enforce_available_locales = false
+      end
+    end
   end
 end

data/spec/support/models/artist.rb

@@ -87,5 +87,4 @@ class Artist
   def after_remove_album(album)
     @after_remove_referenced_called = true
   end
-
 end

data/spec/support/models/band.rb

@@ -21,6 +21,7 @@ class Band
   field :founded, type: Date
   field :deleted, type: Boolean
   field :mojo, type: Object
+  field :tags, type: Hash
   field :fans
 
   embeds_many :records, cascade_callbacks: true

data/spec/support/models/building.rb

@@ -3,6 +3,8 @@
 class Building
   include Mongoid::Document
 
+  field :name, type: String
+
   embeds_one :building_address, validate: false
   embeds_many :contractors
 end

data/spec/support/models/name.rb

@@ -4,8 +4,6 @@ class Name
   include Mongoid::Document
   include Mongoid::Attributes::Dynamic
 
-  validate :is_not_jamis
-
   field :_id, type: String, overwrite: true, default: ->{
     "#{first_name}-#{last_name}"
   }
@@ -25,12 +23,4 @@ class Name
   def set_parent=(set = false)
     self.parent_title = namable.title if set
   end
-
-  private
-
-  def is_not_jamis
-    if first_name == 'Jamis' && last_name == 'Buck'
-      errors.add(:base, :invalid)
-    end
-  end
 end

data/spec/support/models/person.rb

@@ -70,7 +70,6 @@ class Person
   embeds_many :messages, validate: false
 
   embeds_one :passport, autobuild: true, store_as: :pass, validate: false
-  embeds_one :purse, store_as: "Purse"
   embeds_one :pet, class_name: "Animal", validate: false
   embeds_one :name, as: :namable, validate: false do
     def extension

data/spec/support/models/product.rb

@@ -10,6 +10,7 @@ class Product
   field :website, localize: true
   field :sku, as: :stock_keeping_unit
   field :tl, as: :tagline, localize: true
+  field :title, localize: :present
   alias_attribute :cost, :price
 
   validates :name, presence: true