mongoid 8.0.5 → 8.1.0

data/spec/shared/lib/mrss/utils.rb

@@ -3,13 +3,35 @@
 
 module Mrss
   module Utils
+    extend self
 
-    module_function def print_backtrace(dest=STDERR)
-      begin
-        hello world
-      rescue => e
-        dest.puts e.backtrace.join("\n")
-      end
+    def print_backtrace(dest=STDERR)
+      raise
+    rescue => e
+      dest.puts e.backtrace.join("\n")
+    end
+
+    # Parses the given version string, accounting for suffix information that
+    # Gem::Version cannot successfully parse.
+    #
+    # @param [ String ] version the version to parse
+    #
+    # @return [ Gem::Version ] the parsed version
+    #
+    # @raise [ ArgumentError ] if the string cannot be parsed.
+    def parse_version(version)
+      Gem::Version.new(version)
+    rescue ArgumentError
+      match = version.match(/\A(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)?(-[A-Za-z\+\d]+)?\z/)
+      raise ArgumentError.new("Malformed version number string #{version}") if match.nil?
+
+      Gem::Version.new(
+        [
+          match[:major],
+          match[:minor],
+          match[:patch]
+        ].join('.')
+      )
     end
   end
 end

data/spec/shared/share/Dockerfile.erb

@@ -7,13 +7,13 @@
 <%
 
 python_toolchain_url = "https://s3.amazonaws.com//mciuploads/mongo-python-driver-toolchain/#{distro}/ba92de2700c04ee2d4f82c3ffdfc33105140cb04/mongo_python_driver_toolchain_#{distro.gsub('-', '_')}_ba92de2700c04ee2d4f82c3ffdfc33105140cb04_19_11_14_15_33_33.tar.gz"
-server_version = '4.3.3'
+# server_version = '4.3.3'
 server_url = "http://downloads.10gen.com/linux/mongodb-linux-x86_64-enterprise-#{distro}-#{server_version}.tgz"
 server_archive_basename = File.basename(server_url)
 server_extracted_dir = server_archive_basename.sub(/\.(tar\.gz|tgz)$/, '')
 
 # When changing, also update the hash in shlib/set_env.sh.
-TOOLCHAIN_VERSION='219833abad4d9d3bf43c0fef101a8ca082ac4ae9'
+TOOLCHAIN_VERSION='e8c60866f54bed7e336a37df3a97d6ae1b971b7d'
 
 def ruby_toolchain_url(ruby)
   "http://boxes.10gen.com/build/toolchain-drivers/mongo-ruby-driver/#{TOOLCHAIN_VERSION}/#{distro}/#{ruby}.tar.xz"
@@ -77,25 +77,31 @@ ENV DOCKER=1
   # therefore install python-pip in all configurations here.
 
   <% packages = %w(
-    procps lsb-release bzip2 curl zsh
+    procps lsb-release bzip2 curl wget gpg zsh
     git make gcc libyaml-0-2 libgmp-dev zlib1g-dev libsnappy-dev
     krb5-user krb5-kdc krb5-admin-server libsasl2-dev libsasl2-modules-gssapi-mit
     haproxy
     python3-pip
-    tzdata shared-mime-info
+    tzdata shared-mime-info software-properties-common
   ) %>
 
   <% if distro =~ /ubuntu2004/ %>
     <% packages << 'libsnmp35' %>
+  <% elsif distro =~ /ubuntu2204|debian11/ %>
+    <% packages << 'libsnmp40' %>
   <% else %>
     <% packages << 'libsnmp30' %>
   <% end %>
 
-  <% if distro !~ /ubuntu2004/ %>
+  <% if distro !~ /ubuntu2004|ubuntu2204|debian11/ %>
     <% packages << 'python-pip' %>
   <% end %>
 
-  <% if distro =~ /debian10/ %>
+  <% if distro =~ /ubuntu2204|debian11/ %>
+    <% packages << 'python3-venv' %>
+  <% end %>
+
+  <% if distro =~ /debian10|ubuntu2204|debian11/ %>
     <% packages << 'openjdk-11-jdk-headless' %>
   <% elsif distro =~ /ubuntu1404/ %>
     # Ubuntu 14.04 only has openjdk 7, this is too old to be useful
@@ -105,31 +111,37 @@ ENV DOCKER=1
 
   # ubuntu1404, ubuntu1604: libcurl3
   # ubuntu1804, ubuntu2004, debian10: libcurl4
-  <% if distro =~ /ubuntu1804|ubuntu2004|debian10/ %>
+  <% if distro =~ /ubuntu1804|ubuntu2004|ubuntu2204|debian10|debian11/ %>
     <% packages << 'libcurl4' %>
   <% else %>
     <% packages << 'libcurl3' %>
   <% end %>
 
-  <% if distro =~ /ubuntu1804|ubuntu2004/ %>
+  <% if distro =~ /ubuntu1804|ubuntu2004|ubuntu2204/ %>
     <% packages << 'nodejs' %>
   <% end %>
 
-  <% if distro =~ /ubuntu2004/ %>
-    <% packages += %w(ruby ruby2.7 bundler) %>
+  <% if distro =~ /ubuntu2004|ubuntu2204/ %>
+    <% packages += %w(ruby bundler) %>
   <% end %>
 
   RUN apt-get update && apt-get install -y <%= packages.join(' ') %>
-  
+
+  <% if ubuntu? %>
+    RUN wget -O - https://apt.kitware.com/keys/kitware-archive-latest.asc 2>/dev/null | gpg --dearmor - | tee /usr/share/keyrings/kitware-archive-keyring.gpg >/dev/null
+    RUN echo "deb [signed-by=/usr/share/keyrings/kitware-archive-keyring.gpg] https://apt.kitware.com/ubuntu/ $(lsb_release -cs) main" | tee /etc/apt/sources.list.d/kitware.list >/dev/null
+  <% end %>
+  RUN apt-get update && apt-get install -y cmake
+
 <% else %>
 
   <% if distro =~ /rhel6/ %>
-  
+
     # CentOS 6 is dead - to use it retrieve the packages from vault:
     # https://stackoverflow.com/questions/53562691/error-cannot-retrieve-repository-metadata-repomd-xml-for-repository-base-pl
-  
+
     <%
-      
+
       cfg = <<-CFG
 [base]
 name=CentOS-$releasever - Base
@@ -141,11 +153,11 @@ gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-CentOS-6
 CFG
 
     %>
-  
+
     RUN printf "<%= cfg.gsub("\n", "\\n") %>" >/etc/yum.repos.d/CentOS-Base.repo
-  
+
   <% end %>
-  
+
   # Enterprise server: net-snmp
   # lsb_release: redhat-lsb-core
   # our runner scripts: which
@@ -162,23 +174,8 @@ CFG
 
   RUN yum install -y redhat-lsb-core which git gcc libyaml krb5-server \
     krb5-workstation cyrus-sasl-devel cyrus-sasl-gssapi java-1.8.0-openjdk \
-    net-snmp python3
+    net-snmp python38 python38-devel cmake nodejs
 
-  <% if distro =~ /rhel6/ %>
-
-    # RHEL 6 ships with Python 2.6.
-
-    RUN yum install -y centos-release-scl && \
-      yum install -y python27-python python27-python-devel
-    ENV PATH=/opt/rh/python27/root/usr/bin:$PATH \
-      LD_LIBRARY_PATH=/opt/rh/python27/root/usr/lib64
-
-  <% else %>
-
-    RUN yum install -y python-devel
-
-  <% end %>
-  
 <% end %>
 
 <% if preload? %>
@@ -220,7 +217,7 @@ CFG
   <% when 'git' %>
     # dateutil dependency is missing in mtools: https://github.com/rueckstiess/mtools/issues/864
     RUN python3 -m pip install virtualenv 'pymongo>=4' python-dateutil psutil
-    
+
     # Install mtools from git because released versions do not work with pymongo 4.0
     RUN git clone https://github.com/p-mongodb/mtools && \
       cd mtools && \
@@ -234,7 +231,7 @@ CFG
   <% if @env.fetch('MONGODB_VERSION') >= '4.4' %>
     # ubuntu1604 installs MarkupSafe 0.0.0 here instead of 2.0.0+
     # as specified by dependencies, causing OCSP mock to not work.
-    RUN python3 -mpip install asn1crypto oscrypto flask --upgrade
+    RUN python3 -mpip install asn1crypto oscrypto flask --upgrade --ignore-installed
   <% end %>
 
   # FLE is tested against 4.0+ servers.
@@ -243,7 +240,7 @@ CFG
     # boto3~=1.19 cryptography~=3.4.8 pykmip~=0.10.0
     # cryptography does not install due to lacking setuptools_rust
     # (either that version or anything that isn't part of system packages)
-    RUN python3 -mpip install boto3~=1.19 cryptography pykmip~=0.10.0
+    RUN python3 -mpip install boto3~=1.19 cryptography pykmip~=0.10.0 'sqlalchemy<2.0.0'
   <% end %>
 
   <% unless ruby_head? || system_ruby? %>
@@ -255,10 +252,6 @@ CFG
 
   <% end %>
 
-  RUN curl --retry 3 -fL <%= server_download_url %> |tar xzf - && \
-    mv mongo*/ /opt/mongodb
-  ENV USE_OPT_MONGODB=1 USE_SYSTEM_PYTHON_PACKAGES=1
-
 <% end %>
 
 <% if distro =~ /debian|ubuntu/ %>
@@ -308,6 +301,9 @@ ENV MONGO_ORCHESTRATION_HOME=/tmpfs \
 
 COPY . .
 
+RUN bash -c '. .evergreen/download-mongodb.sh && get_distro && get_mongodb_download_url_for "$DISTRO" "<%= server_version %>" && curl --retry 3 -fL $MONGODB_DOWNLOAD_URL |tar xzf - && mv mongo*/ /opt/mongodb'
+ENV USE_OPT_MONGODB=1 USE_SYSTEM_PYTHON_PACKAGES=1
+
 <% if expose? %>
 
   <% ports = [] %>

data/spec/shared/shlib/server.sh

@@ -71,12 +71,18 @@ prepare_server_from_url() {
   export PATH="$BINDIR":$PATH
 }
 
-install_mlaunch_virtualenv() {
+install_mlaunch_venv() {
   python3 -V || true
-  if ! python3 -m virtualenv -h >/dev/null; then
+  if ! python3 -m venv -h >/dev/null; then
     # Current virtualenv fails with
     # https://github.com/pypa/virtualenv/issues/1630
-    python3 -m pip install 'virtualenv<20' --user
+    python3 -m pip install venv --user
+  fi
+  if ! python3 -m ensurepip -h > /dev/null; then
+    # 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 install --yes python3-venv
   fi
   if test "$USE_SYSTEM_PYTHON_PACKAGES" = 1 &&
     python3 -m pip list |grep mtools
@@ -84,14 +90,19 @@ install_mlaunch_virtualenv() {
     # Use the existing mtools-legacy
     :
   else
-    venvpath="$MONGO_ORCHESTRATION_HOME"/venv
-    python3 -m virtualenv -p python3 $venvpath
-    . $venvpath/bin/activate
+    # Spawn a virtual environment, but only if one is not already
+    # active...
+    if test -z "$VIRTUAL_ENV"; then
+      venvpath="$MONGO_ORCHESTRATION_HOME"/venv
+      python3 -m venv $venvpath
+      . $venvpath/bin/activate
+    fi
+
     # [mlaunch] does not work:
     # https://github.com/rueckstiess/mtools/issues/856
     # dateutil dependency is missing in mtools: https://github.com/rueckstiess/mtools/issues/864
     #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 'mtools-legacy[mlaunch]' 'pymongo<4' python-dateutil
   fi
@@ -158,6 +169,19 @@ install_mlaunch_git() {
   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 install --yes cmake
+    fi
+  else
+    echo 'cmake is present'
+  fi
+}
+
 # This function sets followong global variables:
 #   server_cert_path
 #   server_ca_path
@@ -173,7 +197,7 @@ calculate_server_args() {
   fi
 
   if test $mongo_version = latest; then
-    mongo_version=60
+    mongo_version=70
   fi
 
   local args="--setParameter enableTestCommands=1"

data/spec/shared/shlib/set_env.sh

@@ -1,5 +1,5 @@
 # When changing, also update the hash in share/Dockerfile.
-TOOLCHAIN_VERSION=219833abad4d9d3bf43c0fef101a8ca082ac4ae9
+TOOLCHAIN_VERSION=e8c60866f54bed7e336a37df3a97d6ae1b971b7d
 
 set_env_java() {
   ls -l /opt || true
@@ -53,7 +53,7 @@ set_env_python() {
       curl -fL --retry 3 https://github.com/p-mongodb/deps/raw/main/"$arch"-python37.tar.xz | \
         tar xfJ - -C /opt
     fi
-    
+
     if test -d /opt/python/3.7/bin; then
       # Most Evergreen configurations.
       export PATH=/opt/python/3.7/bin:$PATH
@@ -61,7 +61,7 @@ set_env_python() {
       # Configurations that use Docker in Evergreen - these don't preload.
       export PATH=/opt/python37/bin:$PATH
     fi
-    
+
     python3 -V
   fi
 }
@@ -78,7 +78,7 @@ set_env_node() {
     # Node from toolchain in Evergreen
     export PATH=/opt/node/bin:$PATH
   fi
-  
+
   node -v
 }
 

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/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/book.rb

@@ -15,4 +15,5 @@ class Book
   end
 
   embeds_many :pages, cascade_callbacks: true
+  embeds_many :covers, cascade_callbacks: true
 end

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/cover.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Cover
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :title, type: String
+
+  embedded_in :book
+end

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