mongoid 8.1.4 → 9.0.0

data/spec/shared/share/Dockerfile.erb

@@ -13,7 +13,7 @@ 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='e8c60866f54bed7e336a37df3a97d6ae1b971b7d'
+TOOLCHAIN_VERSION='ded7ea845b08cf96f11a747d9540ba3199580dea'
 
 def ruby_toolchain_url(ruby)
   "http://boxes.10gen.com/build/toolchain-drivers/mongo-ruby-driver/#{TOOLCHAIN_VERSION}/#{distro}/#{ruby}.tar.xz"
@@ -56,7 +56,7 @@ ENV DOCKER=1
   # Ruby runtime dependencies: libyaml-0-2
   # Compiling ruby libraries: gcc make
   # Compiling python packages: python3-dev
-  # JRuby: openjdk-8-jdk-headless
+  # JRuby: openjdk-17-jdk-headless
   # Server dependencies: libsnmp30 libcurl3/libcurl4
   # Determining OS we are running on: lsb-release
   # Load balancer testing: haproxy
@@ -78,11 +78,12 @@ ENV DOCKER=1
 
   <% packages = %w(
     procps lsb-release bzip2 curl wget gpg zsh
-    git make gcc libyaml-0-2 libgmp-dev zlib1g-dev libsnappy-dev
+    git make gcc g++ libyaml-dev libgmp-dev zlib1g-dev libsnappy-dev
     krb5-user krb5-kdc krb5-admin-server libsasl2-dev libsasl2-modules-gssapi-mit
-    haproxy
+    haproxy libcurl4
     python3-pip
-    tzdata shared-mime-info software-properties-common
+    tzdata shared-mime-info software-properties-common xz-utils nodejs npm
+    openjdk-17-jdk-headless
   ) %>
 
   <% if distro =~ /ubuntu2004/ %>
@@ -101,26 +102,6 @@ ENV DOCKER=1
     <% 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
-  <% else %>
-    <% packages << 'openjdk-8-jdk-headless' %>
-  <% end %>
-
-  # ubuntu1404, ubuntu1604: libcurl3
-  # ubuntu1804, ubuntu2004, debian10: libcurl4
-  <% if distro =~ /ubuntu1804|ubuntu2004|ubuntu2204|debian10|debian11/ %>
-    <% packages << 'libcurl4' %>
-  <% else %>
-    <% packages << 'libcurl3' %>
-  <% end %>
-
-  <% if distro =~ /ubuntu1804|ubuntu2004|ubuntu2204/ %>
-    <% packages << 'nodejs' %>
-  <% end %>
-
   <% if distro =~ /ubuntu2004|ubuntu2204/ %>
     <% packages += %w(ruby bundler) %>
   <% end %>
@@ -135,29 +116,6 @@ ENV DOCKER=1
 
 <% 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
-#mirrorlist=http://mirrorlist.centos.org/?release=$releasever&arch=$basearch&repo=os
-#baseurl=http://mirror.centos.org/centos/$releasever/os/$basearch/
-baseurl=http://vault.centos.org/6.10/os/x86_64/
-gpgcheck=1
-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
@@ -166,15 +124,15 @@ CFG
   # Kerberos tests: krb5-workstation + cyrus-sasl-devel to build the
   # mongo_kerberos gem + cyrus-sasl-gssapi for authentication to work
   # Local Kerberos server: krb5-server
-  # JRuby: java-1.8.0-openjdk
+  # JRuby: java-17-openjdk
   #
   # Note: lacking cyrus-sasl-gssapi produces a cryptic message
   # "SASL(-4): no mechanism available: No worthy mechs found"
   # https://github.com/farorm/python-ad/issues/10
 
-  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 python38 python38-devel cmake nodejs
+  RUN yum --enablerepo=powertools install -y redhat-lsb-core which git gcc gcc-c++ libyaml-devel krb5-server \
+    krb5-workstation cyrus-sasl-devel cyrus-sasl-gssapi java-17-openjdk \
+    net-snmp python38 python38-devel cmake nodejs npm xz
 
 <% end %>
 
@@ -291,6 +249,8 @@ WORKDIR /app
   ENV DOCKER_PRELOAD=1
 <% end %>
 
+RUN npm install --global yarn
+
 ENV MONGO_ORCHESTRATION_HOME=/tmpfs \
   PROJECT_DIRECTORY=/app \
   <%= @env.map { |k, v| %Q`#{k}="#{v.gsub('$', "\\$").gsub('"', "\\\"")}"` }.join(" \\\n  ") %>

data/spec/shared/shlib/server.sh

@@ -104,6 +104,7 @@ 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
 }

data/spec/shared/shlib/set_env.sh

@@ -1,39 +1,16 @@
 # When changing, also update the hash in share/Dockerfile.
-TOOLCHAIN_VERSION=e8c60866f54bed7e336a37df3a97d6ae1b971b7d
+TOOLCHAIN_VERSION=ded7ea845b08cf96f11a747d9540ba3199580dea
+JDK_VERSION=jdk17
 
 set_env_java() {
   ls -l /opt || true
   ls -l /usr/lib/jvm || true
 
   # Use toolchain java if it exists
-  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
+  if [ -f /opt/java/$JDK_VERSION/bin/java ]; then
+    export JAVACMD=/opt/java/$JDK_VERSION/bin/java
   else
-    # 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
+    echo Could not find $JDK_VERSION in /opt/java
   fi
 
   if test -n "$JAVACMD"; then

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,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Expectations

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

data/spec/support/models/address.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 class Address
   include Mongoid::Document
@@ -26,6 +27,8 @@ class Address
   field :s, type: String, as: :suite
   field :name, localize: true
 
+  alias_attribute :n, :name
+
   embeds_many :locations, validate: false
   embeds_one :code, validate: false
   embeds_one :target, as: :targetable, validate: false

data/spec/support/models/address_component.rb

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

data/spec/support/models/address_number.rb

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

data/spec/support/models/agency.rb

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