mongoid 7.1.10 → 7.1.11

data/spec/mongoid/clients/options_spec.rb

@@ -83,9 +83,11 @@ describe Mongoid::Clients::Options, retry: 3 do
 
         let!(:connections_and_cluster_during) do
           connections = nil
-          cluster = Minim.with(options) do |klass|
+          cluster = nil
+          Minim.with(options) do |klass|
             klass.where(name: 'emily').to_a
             connections = Minim.mongo_client.database.command(serverStatus: 1).first['connections']['current']
+            cluster = Minim.collection.cluster
           end
           [ connections, cluster ]
         end
@@ -124,7 +126,10 @@ describe Mongoid::Clients::Options, retry: 3 do
           end
 
           it 'disconnects the new cluster when the block exits' do
-            expect(connections_before).to eq(connections_after)
+            expect(cluster_after).not_to be(cluster_during)
+
+            cluster_during.connected?.should be false
+            cluster_before.connected?.should be true
           end
         end
 
@@ -138,13 +143,14 @@ describe Mongoid::Clients::Options, retry: 3 do
 
           it 'does not create a new cluster' do
             expect(connections_during).to eq(connections_before)
+
+            cluster_during.should be cluster_before
           end
 
           it 'does not disconnect the original cluster' do
-            skip 'https://jira.mongodb.org/browse/MONGOID-5130'
-
-            expect(connections_after).to eq(connections_before)
             expect(cluster_before).to be(cluster_after)
+
+            cluster_before.connected?.should be true
           end
         end
 

data/spec/mongoid/config/environment_spec.rb

@@ -5,9 +5,19 @@ require "spec_helper"
 
 describe Mongoid::Config::Environment do
 
-  after(:all) do
-    Rails = RailsTemp
-    Object.send(:remove_const, :RailsTemp)
+  around do |example|
+    if defined?(Rails)
+      SavedRails = Rails
+      example.run
+      Object.send(:remove_const, :Rails) if defined?(Rails)
+      Rails = SavedRails
+      Object.send(:remove_const, :SavedRails)
+    else
+      example.run
+      if defined?(Rails)
+        Object.send(:remove_const, :Rails)
+      end
+    end
   end
 
   describe "#env_name" do
@@ -24,11 +34,6 @@ describe Mongoid::Config::Environment do
           end
         end
 
-        after do
-          RailsTemp = Rails
-          Object.send(:remove_const, :Rails)
-        end
-
         it "returns the rails environment" do
           expect(described_class.env_name).to eq("production")
         end
@@ -86,4 +91,77 @@ describe Mongoid::Config::Environment do
       end
     end
   end
+
+  describe "#load_yaml" do
+    let(:path) { 'mongoid.yml' }
+    let(:environment) {}
+    before { allow(Rails).to receive('env').and_return('test') }
+
+    subject { described_class.load_yaml(path, environment) }
+
+    context 'when file not found' do
+      let(:path) { 'not/a/valid/path'}
+
+      it { expect { subject }.to raise_error(Errno::ENOENT) }
+    end
+
+    context 'when file found' do
+      before do
+        allow(File).to receive(:new).with('mongoid.yml').and_return(StringIO.new(file_contents))
+      end
+
+      let(:file_contents) do
+        <<~FILE
+          test:
+            clients: ['test']
+          development:
+            clients: ['dev']
+        FILE
+      end
+
+      context 'when file cannot be parsed as YAML' do
+        let(:file_contents) { "*\nbad:%123abc" }
+
+        it { expect { subject }.to raise_error(Psych::SyntaxError) }
+      end
+
+      context 'when file contains ERB errors' do
+        let(:file_contents) { '<%= foo %>' }
+
+        it { expect { subject }.to raise_error(NameError) }
+      end
+
+      context 'when file is empty' do
+        let(:file_contents) { '' }
+
+        it { expect { subject }.to raise_error(Mongoid::Errors::EmptyConfigFile) }
+      end
+
+      context 'when file does not contain a YAML Hash object' do
+        let(:file_contents) { '["this", "is", "an", "array"]' }
+
+        it { expect { subject }.to raise_error(Mongoid::Errors::InvalidConfigFile) }
+      end
+
+      context 'when environment not specified' do
+        it 'uses the rails environment' do
+          is_expected.to eq("clients"=>["test"])
+        end
+      end
+
+      context 'when environment is specified' do
+        let(:environment) { 'development' }
+
+        it 'uses the specified environment' do
+          is_expected.to eq("clients"=>["dev"])
+        end
+      end
+
+      context 'when environment is missing' do
+        let(:environment) { 'staging' }
+
+        it { is_expected.to be_nil }
+      end
+    end
+  end
 end

data/spec/mongoid/contextual/atomic_spec.rb

@@ -801,27 +801,28 @@ describe Mongoid::Contextual::Atomic do
           context.unset(:name)
         end
 
-        it "unsets the first existing field" do
-          expect(depeche_mode.reload.name).to be_nil
-        end
-
-        it "unsets the last existing field" do
-          expect(new_order.reload.name).to be_nil
+        it "unsets the fields from all documents" do
+          depeche_mode.reload
+          new_order.reload
+          expect(depeche_mode.name).to be_nil
+          expect(depeche_mode.years).to_not be_nil
+          expect(new_order.name).to be_nil
+          expect(new_order.years).to_not be_nil
         end
       end
 
       context "when the field is aliased" do
-
         before do
           context.unset(:years)
         end
 
-        it "unsets the first existing field" do
-          expect(depeche_mode.reload.years).to be_nil
-        end
-
-        it "unsets the last existing field" do
-          expect(new_order.reload.years).to be_nil
+        it "unsets the fields from all documents" do
+          depeche_mode.reload
+          new_order.reload
+          expect(depeche_mode.name).to_not be_nil
+          expect(depeche_mode.years).to be_nil
+          expect(new_order.name).to_not be_nil
+          expect(new_order.years).to be_nil
         end
       end
     end
@@ -829,7 +830,8 @@ describe Mongoid::Contextual::Atomic do
     context "when unsetting multiple fields" do
 
       let!(:new_order) do
-        Band.create(name: "New Order", genres: [ "electro", "dub" ], years: 10)
+        Band.create(name: "New Order", genres: %w[electro dub], years: 10,
+          likes: 200, rating: 4.3, origin: 'Space')
       end
 
       let(:criteria) do
@@ -846,12 +848,13 @@ describe Mongoid::Contextual::Atomic do
           context.unset(:name, :genres)
         end
 
-        it "unsets name field" do
-          expect(new_order.reload.name).to be_nil
-        end
-
-        it "unsets genres field" do
-          expect(new_order.reload.genres).to be_nil
+        it "unsets the specified fields" do
+          new_order.reload
+          expect(new_order.name).to be_nil
+          expect(new_order.genres).to be_nil
+          expect(new_order.years).to_not be_nil
+          expect(new_order.likes).to_not be_nil
+          expect(new_order.rating).to_not be_nil
         end
       end
 
@@ -861,12 +864,46 @@ describe Mongoid::Contextual::Atomic do
           context.unset(:name, :years)
         end
 
-        it "unsets the unaliased field" do
-          expect(new_order.reload.name).to be_nil
+        it "unsets the specified fields" do
+          new_order.reload
+          expect(new_order.name).to be_nil
+          expect(new_order.genres).to_not be_nil
+          expect(new_order.years).to be_nil
+          expect(new_order.likes).to_not be_nil
+          expect(new_order.rating).to_not be_nil
+        end
+      end
+
+      context "when using Hash arguments" do
+
+        before do
+          context.unset({ years: true, likes: "" }, { rating: false, origin: nil })
+        end
+
+        it "unsets the specified fields" do
+          new_order.reload
+          expect(new_order.name).to_not be_nil
+          expect(new_order.genres).to_not be_nil
+          expect(new_order.years).to be_nil
+          expect(new_order.likes).to be_nil
+          expect(new_order.rating).to be_nil
+          expect(new_order.origin).to be_nil
+        end
+      end
+
+      context "when mixing argument types" do
+
+        before do
+          context.unset(:name, [:years], { likes: "" }, { rating: false })
         end
 
-        it "unsets the aliased field" do
-          expect(new_order.reload.years).to be_nil
+        it "unsets the specified fields" do
+          new_order.reload
+          expect(new_order.name).to be_nil
+          expect(new_order.genres).to_not be_nil
+          expect(new_order.years).to be_nil
+          expect(new_order.likes).to be_nil
+          expect(new_order.rating).to be_nil
         end
       end
     end
@@ -895,7 +932,9 @@ describe Mongoid::Contextual::Atomic do
       end
 
       it "unsets the unaliased field" do
-        expect(depeche_mode.reload.name).to be_nil
+        depeche_mode.reload
+        expect(depeche_mode.name).to be_nil
+        expect(depeche_mode.years).to_not be_nil
       end
     end
   end

data/spec/mongoid/contextual/geo_near_spec.rb

@@ -59,7 +59,7 @@ describe Mongoid::Contextual::GeoNear do
       end
 
       it "is nil except for 4.0 sharded when it is 0" do
-        expect(geo_near.average_distance).to be expected_value
+        expect(geo_near.average_distance).to eq expected_value
       end
     end
   end

data/spec/mongoid/document_spec.rb

@@ -458,7 +458,7 @@ describe Mongoid::Document do
       end
     end
 
-    context ':compact option' do
+    context 'deprecated :compact option' do
       # Since rails 6 differs in how it treats id fields,
       # run this test on one version of rails. Currently rails 6 is in beta,
       # when it is released this version should be changed to 6.
@@ -470,6 +470,26 @@ describe Mongoid::Document do
         expect(church.as_json.keys.sort).to eq(%w(_id location name))
       end
 
+      context 'deprecation' do
+        let(:church) do
+          Church.create!(name: 'St. Basil')
+        end
+
+        let(:message) do
+          '#as_json :compact option is deprecated. Please call #compact on the returned Hash object instead.'
+        end
+
+        it 'logs a deprecation warning when :compact is given' do
+          expect_any_instance_of(Logger).to receive(:warn).with(message)
+          church.as_json(compact: true)
+        end
+
+        it 'does not log a deprecation warning when :compact is not given' do
+          expect_any_instance_of(Logger).to_not receive(:warn).with(message)
+          church.as_json
+        end
+      end
+
       context 'there is a nil valued attribute' do
         let(:church) do
           Church.create!(name: 'St. Basil')

data/spec/mongoid/errors/invalid_config_file_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require "spec_helper"
+
+describe Mongoid::Errors::InvalidConfigFile do
+
+  describe "#message" do
+
+    let(:error) do
+      described_class.new('/my/path')
+    end
+
+    it "contains the problem in the message" do
+      expect(error.message).to include(
+        "Invalid configuration file: /my/path."
+      )
+    end
+
+    it "contains the summary in the message" do
+      expect(error.message).to include(
+        "Your mongoid.yml configuration file does not contain the"
+      )
+    end
+
+    it "contains the resolution in the message" do
+      expect(error.message).to include(
+        "Ensure your configuration file contains the correct contents."
+      )
+    end
+  end
+end

data/spec/mongoid/persistable/updatable_spec.rb

@@ -458,6 +458,7 @@ describe Mongoid::Persistable::Updatable do
     describe "##{method}" do
 
       context "when saving with a hash field with invalid keys" do
+        max_server_version '4.9'
 
         let(:person) do
           Person.create
@@ -494,6 +495,7 @@ describe Mongoid::Persistable::Updatable do
       end
 
       context "when the document has been destroyed" do
+        max_server_version '4.9'
 
         let(:person) do
           Person.create

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

@@ -257,22 +257,39 @@ module Mrss
       end
     end
 
-    def require_multi_shard
+    def require_multi_mongos
       before(:all) do
         if ClusterConfig.instance.topology == :sharded && SpecConfig.instance.addresses.length == 1
-          skip 'Test requires a minimum of two shards if run in sharded topology'
+          skip 'Test requires a minimum of two mongoses if run in sharded topology'
+        end
+
+        if ClusterConfig.instance.topology == :load_balanced && SpecConfig.instance.single_mongos?
+          skip 'Test requires a minimum of two mongoses if run in load-balanced topology'
         end
       end
     end
 
-    def require_no_multi_shard
+    # In sharded topology operations are distributed to the mongoses.
+    # When we set fail points, the fail point may be set on one mongos and
+    # operation may be executed on another mongos, causing failures.
+    # Tests that are not setting targeted fail points should utilize this
+    # method to restrict themselves to single mongos.
+    #
+    # In load-balanced topology, the same problem can happen when there is
+    # more than one mongos behind the load balancer.
+    def require_no_multi_mongos
       before(:all) do
         if ClusterConfig.instance.topology == :sharded && SpecConfig.instance.addresses.length > 1
-          skip 'Test requires a single shard if run in sharded topology'
+          skip 'Test requires a single mongos if run in sharded topology'
+        end
+        if ClusterConfig.instance.topology == :load_balanced && !SpecConfig.instance.single_mongos?
+          skip 'Test requires a single mongos, as indicated by SINGLE_MONGOS=1 environment variable, if run in load-balanced topology'
         end
       end
     end
 
+    alias :require_no_multi_shard :require_no_multi_mongos
+
     def require_wired_tiger
       before(:all) do
         # Storage detection fails for serverless instances. However, it is safe to

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

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module Mrss
+  # Test event subscriber.
+  class EventSubscriber
+
+    # The mappings of event names to types.
+    MAPPINGS = {
+      'topology_opening_event' => Mongo::Monitoring::Event::TopologyOpening,
+      'topology_description_changed_event' => Mongo::Monitoring::Event::TopologyChanged,
+      'topology_closed_event' => Mongo::Monitoring::Event::TopologyClosed,
+      'server_opening_event' => Mongo::Monitoring::Event::ServerOpening,
+      'server_description_changed_event' => Mongo::Monitoring::Event::ServerDescriptionChanged,
+      'server_closed_event' => Mongo::Monitoring::Event::ServerClosed
+    }.freeze
+
+    attr_reader :all_events
+
+    attr_reader :started_events
+
+    attr_reader :succeeded_events
+
+    attr_reader :failed_events
+
+    attr_reader :published_events
+
+    # @param [ String ] name Optional name for the event subscriber.
+    def initialize(name: nil)
+      @mutex = Mutex.new
+      clear_events!
+      @name = name
+    end
+
+    def to_s
+      %Q`#<EventSubscriber:#{@name ? "\"#{@name}\"" : '%x' % object_id} \
+  started=#{started_events.length} \
+  succeeded=#{succeeded_events.length} \
+  failed=#{failed_events.length} \
+  published=#{published_events.length}>`
+    end
+
+    alias :inspect :to_s
+
+    # Event retrieval
+
+    def select_started_events(cls)
+      started_events.select do |event|
+        event.is_a?(cls)
+      end
+    end
+
+    def select_succeeded_events(cls)
+      succeeded_events.select do |event|
+        event.is_a?(cls)
+      end
+    end
+
+    def select_completed_events(*classes)
+      (succeeded_events + failed_events).select do |event|
+        classes.any? { |c| c === event }
+      end
+    end
+
+    def select_published_events(cls)
+      published_events.select do |event|
+        event.is_a?(cls)
+      end
+    end
+
+    # Filters command started events for the specified command name.
+    def command_started_events(command_name)
+      started_events.select do |event|
+        event.command[command_name]
+      end
+    end
+
+    def non_auth_command_started_events
+      started_events.reject do |event|
+        %w(authenticate getnonce saslSstart saslContinue).any? do |cmd|
+          event.command[cmd]
+        end
+      end
+    end
+
+    # Locates command stated events for the specified command name,
+    # asserts that there is exactly one such event, and returns it.
+    def single_command_started_event(command_name, include_auth: false)
+      events = if include_auth
+                 started_events
+               else
+                 non_auth_command_started_events
+               end
+      events.select! do |event|
+        event.command[command_name]
+      end
+      if events.length != 1
+        raise "Expected a single #{command_name} event but we have #{events.length}"
+      end
+      events.first
+    end
+
+
+    # Get the first succeeded event published for the name, and then delete it.
+    #
+    # @param [ String ] name The event name.
+    #
+    # @return [ Event ] The matching event.
+    def first_event(name)
+      cls = MAPPINGS[name]
+      if cls.nil?
+        raise ArgumentError, "Bogus event name #{name}"
+      end
+      matching = succeeded_events.find do |event|
+        cls === event
+      end
+      succeeded_events.delete(matching)
+      matching
+    end
+
+    # Event recording
+
+    # Cache the started event.
+    #
+    # @param [ Event ] event The event.
+    def started(event)
+      @mutex.synchronize do
+        started_events << event
+        all_events << event
+      end
+    end
+
+    # Cache the succeeded event.
+    #
+    # @param [ Event ] event The event.
+    def succeeded(event)
+      @mutex.synchronize do
+        succeeded_events << event
+        all_events << event
+      end
+    end
+
+    # Cache the failed event.
+    #
+    # @param [ Event ] event The event.
+    def failed(event)
+      @mutex.synchronize do
+        failed_events << event
+        all_events << event
+      end
+    end
+
+    def published(event)
+      @mutex.synchronize do
+        published_events << event
+        all_events << event
+      end
+    end
+
+    # Clear all cached events.
+    def clear_events!
+      @all_events = []
+      @started_events = []
+      @succeeded_events = []
+      @failed_events = []
+      @published_events = []
+      self
+    end
+  end
+  # Only handles succeeded events correctly.
+  class PhasedEventSubscriber < EventSubscriber
+    def initialize
+      super
+      @phase_events = {}
+    end
+
+    def phase_finished(phase_index)
+      @phase_events[phase_index] = succeeded_events
+      @succeeded_events = []
+    end
+
+    def phase_events(phase_index)
+      @phase_events[phase_index]
+    end
+
+    def event_count
+      @phase_events.inject(0) do |sum, event|
+        sum + event.length
+      end
+    end
+  end
+
+  class VerboseEventSubscriber < EventSubscriber
+    %w(started succeeded failed published).each do |meth|
+      define_method(meth) do |event|
+        puts event.summary
+        super(event)
+      end
+    end
+  end
+end