mongoid 7.2.1 → 9.0.0

data/spec/mongoid/config_spec.rb

@@ -1,16 +1,11 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require "spec_helper"
+require "support/feature_sandbox"
 
 describe Mongoid::Config do
 
-  after(:all) do
-    if defined?(RailsTemp)
-      Rails = RailsTemp
-    end
-  end
-
   after do
     Mongoid.configure do |config|
       config.load_configuration(CONFIG)
@@ -71,11 +66,6 @@ describe Mongoid::Config do
   context "when the log level is not set in the configuration" do
 
     before do
-      if defined?(Rails)
-        RailsTemp = Rails unless defined?(RailsTemp)
-        Object.send(:remove_const, :Rails)
-      end
-
       Mongoid.configure do |config|
         config.load_configuration(CONFIG)
       end
@@ -205,7 +195,7 @@ describe Mongoid::Config do
 
         Mongoid.configure { |config| config.load_configuration(configuration) }
 
-        expect(Mongoid::Config.discriminator_key).to be("_type")
+        expect(Mongoid::Config.discriminator_key).to eq("_type")
       end
     end
 
@@ -216,24 +206,161 @@ describe Mongoid::Config do
 
         Mongoid.configure { |config| config.load_configuration(configuration) }
 
-        expect(Mongoid::Config.discriminator_key).to be("test")
+        expect(Mongoid::Config.discriminator_key).to eq("test")
       end
 
-      it 'is set globally' do 
-        expect(Mongoid.discriminator_key).to be("test")
+      it 'is set globally' do
+        expect(Mongoid.discriminator_key).to eq("test")
       end
     end
   end
 
-  describe "#load!" do
+  context 'async_query_executor option' do
+    let(:option) { :async_query_executor }
+
+    before do
+      Mongoid::Config.reset
+      Mongoid.configure do |config|
+        config.load_configuration(conf)
+      end
+    end
+
+    context "when it is not set in the config" do
+
+      let(:conf) { CONFIG }
+
+      it "it is set to its default" do
+        expect(Mongoid.send(option)).to eq(:immediate)
+      end
+    end
+
+    context 'when the value is :immediate' do
+
+      let(:conf) do
+        CONFIG.merge(options: { option => :immediate })
+      end
+
+      it "is set to false" do
+        expect(Mongoid.send(option)).to be(:immediate)
+      end
+    end
+
+    context 'when the value is :global_thread_pool' do
+
+      let(:conf) do
+        CONFIG.merge(options: { option => :global_thread_pool })
+      end
+
+      it "is set to false" do
+        expect(Mongoid.send(option)).to be(:global_thread_pool)
+      end
+    end
+  end
+
+  context 'global_executor_concurrency option' do
+    let(:option) { :global_executor_concurrency }
+
+    before do
+      Mongoid::Config.reset
+      Mongoid.configure do |config|
+        config.load_configuration(conf)
+      end
+    end
+
+    context "when it is not set in the config" do
+
+      let(:conf) { CONFIG }
+
+      it "it is set to its default" do
+        expect(Mongoid.send(option)).to eq(nil)
+      end
+    end
+
+    context 'when the value is set to a number' do
+
+      let(:conf) do
+        CONFIG.merge(options: { option => 5 })
+      end
+
+      it "is set to the number" do
+        expect(Mongoid.send(option)).to be(5)
+      end
+    end
+  end
+
+  shared_examples "a config option" do
+
+    before do
+      Mongoid::Config.reset
+      Mongoid.configure do |config|
+        config.load_configuration(conf)
+      end
+    end
+
+    context 'when the value is false' do
+
+      let(:conf) do
+        CONFIG.merge(options: { option => false })
+      end
 
-    before(:all) do
-      if defined?(Rails)
-        RailsTemp = Rails
-        Object.send(:remove_const, :Rails)
+      it "is set to false" do
+        expect(Mongoid.send(option)).to be(false)
       end
     end
 
+    context 'when the value is true' do
+
+      let(:conf) do
+        CONFIG.merge(options: { option => true })
+      end
+
+      it "is set to true" do
+        expect(Mongoid.send(option)).to be(true)
+      end
+    end
+
+    context "when it is not set in the config" do
+
+      let(:conf) { CONFIG }
+
+      it "it is set to its default" do
+        expect(Mongoid.send(option)).to eq(default)
+      end
+    end
+  end
+
+  context 'when setting the map_big_decimal_to_decimal128 option in the config' do
+    let(:option) { :map_big_decimal_to_decimal128 }
+    let(:default) { true }
+
+    it_behaves_like "a config option"
+  end
+
+  context 'when setting the allow_bson5_decimal128 option in the config' do
+    min_bson_version '5.0'
+
+    let(:option) { :allow_bson5_decimal128 }
+    let(:default) { false }
+
+    it_behaves_like "a config option"
+  end
+
+  context 'when setting the legacy_readonly option in the config' do
+    let(:option) { :legacy_readonly }
+    let(:default) { false }
+
+    it_behaves_like "a config option"
+  end
+
+  context 'when setting the legacy_persistence_context_behavior option in the config' do
+    let(:option) { :legacy_persistence_context_behavior }
+    let(:default) { false }
+
+    it_behaves_like "a config option"
+  end
+
+  describe "#load!" do
+
     let(:file) do
       File.join(File.dirname(__FILE__), "..", "config", "mongoid.yml")
     end
@@ -274,20 +401,12 @@ describe Mongoid::Config do
 
       context "when in a Rails environment" do
 
-        before do
-          module Rails
-            def self.logger
-              ::Logger.new($stdout)
-            end
-          end
-          Mongoid.logger = Rails.logger
-          described_class.load!(file, :test)
-        end
-
-        after do
-          if defined?(Rails)
-            RailsTemp = Rails unless defined?(RailsTemp)
-            Object.send(:remove_const, :Rails)
+        around do |example|
+          FeatureSandbox.quarantine do
+            require "support/rails_mock"
+            Mongoid.logger = Rails.logger
+            described_class.load!(file, :test)
+            example.run
           end
         end
 
@@ -332,10 +451,6 @@ describe Mongoid::Config do
         expect(described_class.raise_not_found_error).to be true
       end
 
-      it "sets the use activesupport time zone option" do
-        expect(described_class.use_activesupport_time_zone).to be true
-      end
-
       it "sets the use utc option" do
         expect(described_class.use_utc).to be false
       end
@@ -345,6 +460,40 @@ describe Mongoid::Config do
       end
     end
 
+    context "when provided an environment with driver options" do
+
+      before do
+        described_class.load!(file, :test)
+      end
+
+      after do
+        described_class.reset
+      end
+
+      it "sets the Mongo.broken_view_options option" do
+        expect(Mongo.broken_view_options).to eq(false)
+      end
+
+      it "does not override the unset Mongo.validate_update_replace option" do
+        expect(Mongo.validate_update_replace).to eq(false)
+      end
+    end
+
+    context "when provided an environment with a nil driver option" do
+
+      before do
+        described_class.load!(file, :test_nil)
+      end
+
+      after do
+        described_class.reset
+      end
+
+      it "sets the Mongo.broken_view_options option to nil" do
+        expect(Mongo.broken_view_options).to be_nil
+      end
+    end
+
     context "when the rack environment is set" do
 
       before do
@@ -382,10 +531,6 @@ describe Mongoid::Config do
           expect(described_class.raise_not_found_error).to be true
         end
 
-        it "sets the use activesupport time zone option" do
-          expect(described_class.use_activesupport_time_zone).to be true
-        end
-
         it "sets the use utc option" do
           expect(described_class.use_utc).to be false
         end
@@ -427,6 +572,45 @@ describe Mongoid::Config do
         end
       end
     end
+
+    context 'when schema map is provided with uuid' do
+      let(:file) do
+        File.join(File.dirname(__FILE__), "..", "config", "mongoid_with_schema_map_uuid.yml")
+      end
+
+      before do
+        described_class.load!(file, :test)
+      end
+
+      let(:client) { Mongoid.default_client }
+
+      it 'passes uuid to driver' do
+        Mongo::Client.should receive(:new).with(SpecConfig.instance.addresses,
+          {
+            auto_encryption_options: {
+              'key_vault_namespace' => 'admin.datakeys',
+              'kms_providers' => {'local' => {'key' => 'z7iYiYKLuYymEWtk4kfny1ESBwwFdA58qMqff96A8ghiOcIK75lJGPUIocku8LOFjQuEgeIP4xlln3s7r93FV9J5sAE7zg8U'}},
+              'schema_map' => {'blog_development.comments' => {
+                'bsonType' => 'object',
+                'properties' => {
+                  'message' => {'encrypt' => {
+                    'algorithm' => 'AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic',
+                    'bsonType' => 'string',
+                    'keyId' => [BSON::Binary.new("G\xF0 5\xCC@HX\xA2%b\x97\xA9a\xA8\xE7", :uuid)],
+                  }},
+                },
+              }}},
+            database: 'mongoid_test',
+            platform: "mongoid-#{Mongoid::VERSION}",
+            wrapping_libraries: [
+              {'name' => 'Mongoid', 'version' => Mongoid::VERSION},
+            ]
+          }
+        )
+
+        client
+      end
+    end
   end
 
   describe "#options=" do
@@ -450,6 +634,17 @@ describe Mongoid::Config do
         }.to raise_error(Mongoid::Errors::InvalidConfigOption)
       end
     end
+
+    context 'when invalid global_executor_concurrency option provided' do
+      it "raises an error" do
+        expect do
+          described_class.options = {
+            async_query_executor: :immediate,
+            global_executor_concurrency: 5
+          }
+        end.to raise_error(Mongoid::Errors::InvalidGlobalExecutorConcurrency)
+      end
+    end
   end
 
   describe "#clients=" do
@@ -545,4 +740,141 @@ describe Mongoid::Config do
       expect(Mongoid::Config.log_level).to eq(2)
     end
   end
+
+  describe "#purge!" do
+
+    it 'deletes models' do
+      House.create!(name: '1', model: 'Big')
+      expect(House.count).to eq(1)
+      Mongoid.purge!
+      expect(House.count).to eq(0)
+    end
+
+    it 'drops collections' do
+      House.create!(name: '1', model: 'Big')
+      Band.create!(name: 'Fleet Foxes')
+
+      client = Mongoid.default_client
+      expect(client.collections.map(&:name).sort).to eq %w[bands houses]
+      Mongoid.purge!
+      expect(client.collections.map(&:name)).to eq []
+    end
+  end
+
+  describe "#truncate!" do
+
+    it 'deletes models' do
+      House.create!(name: '1', model: 'Big')
+      expect(House.count).to eq(1)
+      Mongoid.truncate!
+      expect(House.count).to eq(0)
+    end
+
+    it 'does not drop collections' do
+      House.create!(name: '1', model: 'Big')
+      Band.create!(name: 'Fleet Foxes')
+
+      client = Mongoid.default_client
+      expect(client.collections.map(&:name).sort).to eq %w[bands houses]
+      Mongoid.truncate!
+      expect(client.collections.map(&:name).sort).to eq %w[bands houses]
+    end
+
+    it 'does not drop indexes' do
+      User.create_indexes
+      expect(User.collection.indexes.map {|i| i['name'] }).to eq %w[_id_ name_1]
+      Mongoid.truncate!
+      expect(User.collection.indexes.map {|i| i['name'] }).to eq %w[_id_ name_1]
+    end
+  end
+
+  describe "#override_database" do
+    let(:database) do
+      "test_override_#{Time.now.to_i}"
+    end
+
+    after do
+      # Ensure the database override is cleared.
+      Mongoid.override_database(nil)
+    end
+
+    it 'overrides document querying and persistence' do
+      House.create!(name: '1', model: 'Big')
+      expect(House.count).to eq(1)
+
+      Mongoid.override_database(database)
+      expect(House.count).to eq(0)
+
+      expect(Band.count).to eq(0)
+      Band.create!(name: 'Wolf Alice')
+      expect(Band.count).to eq(1)
+
+      Mongoid.override_database(nil)
+      expect(House.count).to eq(1)
+      expect(Band.count).to eq(0)
+    end
+
+    context '#truncate and #purge' do
+      before do
+        House.create!(name: '1', model: 'Big')
+        expect(House.count).to eq(1)
+        Mongoid.override_database(database)
+      end
+
+      after do
+        Mongoid.override_database(nil)
+        expect(House.count).to eq(1)
+      end
+
+      context '#purge' do
+        it 'respects persistence context overrides' do
+          House.create!(name: '2', model: 'Tiny')
+          expect(House.count).to eq(1)
+          Mongoid.purge!
+          expect(House.count).to eq(0)
+        end
+      end
+
+      context '#truncate' do
+        it '#truncate! respects persistence context overrides' do
+          House.create!(name: '2', model: 'Tiny')
+          expect(House.count).to eq(1)
+          Mongoid.truncate!
+          expect(House.count).to eq(0)
+        end
+      end
+    end
+  end
+
+  describe 'deprecations' do
+    {}.each do |option, default|
+
+      context ":#{option} option" do
+
+        before do
+          Mongoid::Warnings.class_eval do
+            instance_variable_set(:"@#{option}_deprecated", false)
+          end
+        end
+
+        let(:matcher) do
+          /Config option :#{option}.+\. It will always be #{default} beginning in Mongoid 9\.0\./
+        end
+
+        context 'when set to true' do
+          it 'gives a deprecation warning' do
+            expect(Mongoid.logger).to receive(:warn).with(matcher)
+            described_class.send(:"#{option}=", true)
+          end
+        end
+
+        context 'when set to false' do
+          it 'gives a deprecation warning' do
+            expect(Mongoid.logger).to receive(:warn).with(matcher)
+            described_class.send(:"#{option}=", false)
+          end
+        end
+      end
+    end
+  end
 end