mongoid 7.0.2 → 8.1.1

data/spec/mongoid/config_spec.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Mongoid::Config do
@@ -195,6 +196,239 @@ describe Mongoid::Config do
     end
   end
 
+  context 'when discriminator_key override' do
+    context 'is not set in the config' do
+      it 'has the value _type by default' do
+        Mongoid::Config.reset
+        configuration = CONFIG.merge(options: {})
+
+        Mongoid.configure { |config| config.load_configuration(configuration) }
+
+        expect(Mongoid::Config.discriminator_key).to eq("_type")
+      end
+    end
+
+    context 'is set in the config' do
+      it 'sets the value' do
+        Mongoid::Config.reset
+        configuration = CONFIG.merge(options: {discriminator_key: "test"})
+
+        Mongoid.configure { |config| config.load_configuration(configuration) }
+
+        expect(Mongoid::Config.discriminator_key).to eq("test")
+      end
+
+      it 'is set globally' do
+        expect(Mongoid.discriminator_key).to eq("test")
+      end
+    end
+  end
+
+  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
+
+      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 broken_updates option in the config' do
+    let(:option) { :broken_updates }
+    let(:default) { false }
+
+    it_behaves_like "a config option"
+  end
+
+  context 'when setting the legacy_triple_equals option in the config' do
+    let(:option) { :legacy_triple_equals }
+    let(:default) { false }
+
+    it_behaves_like "a config option"
+  end
+
+  context 'when setting the broken_scoping option in the config' do
+    let(:option) { :broken_scoping }
+    let(:default) { false }
+
+    it_behaves_like "a config option"
+  end
+
+  context 'when setting the broken_aggregables option in the config' do
+    let(:option) { :broken_aggregables }
+    let(:default) { false }
+
+    it_behaves_like "a config option"
+  end
+
+  context 'when setting the broken_alias_handling option in the config' do
+    let(:option) { :broken_alias_handling }
+    let(:default) { false }
+
+    it_behaves_like "a config option"
+  end
+
+  context 'when setting the broken_and option in the config' do
+    let(:option) { :broken_and }
+    let(:default) { false }
+
+    it_behaves_like "a config option"
+  end
+
+  context 'when setting the compare_time_by_ms option in the config' do
+    let(:option) { :compare_time_by_ms }
+    let(:default) { true }
+
+    it_behaves_like "a config option"
+  end
+
+  context 'when setting the object_id_as_json_oid option in the config' do
+    let(:option) { :object_id_as_json_oid }
+    let(:default) { false }
+
+    it_behaves_like "a config option"
+  end
+
+  context 'when setting the legacy_pluck_distinct option in the config' do
+    let(:option) { :legacy_pluck_distinct }
+    let(:default) { false }
+
+    it_behaves_like "a config option"
+  end
+
+  context 'when setting the overwrite_chained_operators option in the config' do
+    let(:option) { :overwrite_chained_operators }
+    let(:default) { false }
+
+    it_behaves_like "a config option"
+  end
+
+  context 'when setting the legacy_attributes option in the config' do
+    let(:option) { :legacy_attributes }
+    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) { true }
+
+    it_behaves_like "a config option"
+  end
+
   describe "#load!" do
 
     before(:all) do
@@ -309,6 +543,44 @@ describe Mongoid::Config do
       it "sets the use utc option" do
         expect(described_class.use_utc).to be false
       end
+
+      it "sets the join_contexts default option" do
+        expect(described_class.join_contexts).to be false
+      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
@@ -355,6 +627,10 @@ describe Mongoid::Config do
         it "sets the use utc option" do
           expect(described_class.use_utc).to be false
         end
+
+        it "sets the join_contexts default option" do
+          expect(described_class.join_contexts).to be false
+        end
       end
 
       context "when client configurations are provided" do
@@ -370,7 +646,9 @@ describe Mongoid::Config do
           end
 
           it "sets the default hosts" do
-            expect(default[:hosts]).to eq(["#{HOST}:#{PORT}"])
+            expect(default[:hosts]).to eq(SpecConfig.instance.addresses)
+            # and make sure the value is not empty
+            expect(default[:hosts].first).to include(':')
           end
 
           context "when the default has options" do
@@ -387,6 +665,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
@@ -410,6 +727,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
@@ -476,4 +804,181 @@ describe Mongoid::Config do
       end
     end
   end
+
+  describe '.log_level=' do
+    around do |example|
+      saved_log_level = Mongoid::Config.log_level
+      begin
+        example.run
+      ensure
+        Mongoid::Config.log_level = saved_log_level
+      end
+    end
+
+    it 'accepts a string' do
+      Mongoid::Config.log_level = 'info'
+      expect(Mongoid::Config.log_level).to eq(1)
+
+      # set twice to ensure value changes from default, whatever the default is
+      Mongoid::Config.log_level = 'warn'
+      expect(Mongoid::Config.log_level).to eq(2)
+    end
+
+    it 'accepts an integer' do
+      Mongoid::Config.log_level = 1
+      expect(Mongoid::Config.log_level).to eq(1)
+
+      # set twice to ensure value changes from default, whatever the default is
+      Mongoid::Config.log_level = 2
+      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
+    { use_activesupport_time_zone: true,
+      broken_aggregables: false,
+      broken_alias_handling: false,
+      broken_and: false,
+      broken_scoping: false,
+      broken_updates: false,
+      compare_time_by_ms: true,
+      legacy_attributes: false,
+      legacy_pluck_distinct: false,
+      legacy_triple_equals: false,
+      object_id_as_json_oid: false,
+      overwrite_chained_operators: false }.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