mongo 2.18.2 → 2.19.3

data/spec/mongo/cluster_spec.rb

@@ -1,39 +1,54 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'spec_helper'
 
+# let these existing styles stand, rather than going in for a deep refactoring
+# of these specs.
+#
+# possible future work: re-enable these one at a time and do the hard work of
+# making them right.
+#
+# rubocop:disable RSpec/ContextWording, RSpec/VerifiedDoubles, RSpec/MessageSpies
+# rubocop:disable RSpec/ExpectInHook, RSpec/ExampleLength
 describe Mongo::Cluster do
-
   let(:monitoring) do
     Mongo::Monitoring.new(monitoring: false)
   end
 
   let(:cluster_with_semaphore) do
     register_cluster(
-      described_class.new(SpecConfig.instance.addresses, monitoring,
+      described_class.new(
+        SpecConfig.instance.addresses,
+        monitoring,
         SpecConfig.instance.test_options.merge(
-          server_selection_semaphore: Mongo::Semaphore.new)))
+          server_selection_semaphore: Mongo::Semaphore.new
+        )
+      )
+    )
   end
 
   let(:cluster_without_io) do
     register_cluster(
-      described_class.new(SpecConfig.instance.addresses, monitoring,
-        SpecConfig.instance.test_options.merge(monitoring_io: false)))
+      described_class.new(
+        SpecConfig.instance.addresses,
+        monitoring,
+        SpecConfig.instance.test_options.merge(monitoring_io: false)
+      )
+    )
   end
 
   let(:cluster) { cluster_without_io }
 
   describe 'initialize' do
-
     context 'when there are duplicate addresses' do
-
       let(:addresses) do
         SpecConfig.instance.addresses + SpecConfig.instance.addresses
       end
+
       let(:cluster_with_dup_addresses) do
         register_cluster(
-          described_class.new(addresses, monitoring, SpecConfig.instance.test_options))
+          described_class.new(addresses, monitoring, SpecConfig.instance.test_options)
+        )
       end
 
       it 'does not raise an exception' do
@@ -52,36 +67,34 @@ describe Mongo::Cluster do
             SpecConfig.instance.addresses,
             monitoring,
             SpecConfig.instance.test_options
-            )
           )
+        )
 
-          expect(monitoring).to have_received(:succeeded).with(
-            Mongo::Monitoring::TOPOLOGY_OPENING, any_args
-          )
-          expect(monitoring).to have_received(:succeeded).with(
-            Mongo::Monitoring::TOPOLOGY_CHANGED, any_args
-          ).twice
-          expect(monitoring).to have_received(:succeeded).with(
-            Mongo::Monitoring::SERVER_OPENING, any_args
-          )
-          expect(monitoring).to have_received(:succeeded).with(
-            Mongo::Monitoring::SERVER_DESCRIPTION_CHANGED, any_args
-          )
+        expect(monitoring).to have_received(:succeeded).with(
+          Mongo::Monitoring::TOPOLOGY_OPENING, any_args
+        )
+        expect(monitoring).to have_received(:succeeded).with(
+          Mongo::Monitoring::TOPOLOGY_CHANGED, any_args
+        ).twice
+        expect(monitoring).to have_received(:succeeded).with(
+          Mongo::Monitoring::SERVER_OPENING, any_args
+        )
+        expect(monitoring).to have_received(:succeeded).with(
+          Mongo::Monitoring::SERVER_DESCRIPTION_CHANGED, any_args
+        )
       end
     end
   end
 
   describe '#==' do
-
     context 'when the other is a cluster' do
-
       context 'when the addresses are the same' do
-
         context 'when the options are the same' do
-
           let(:other) do
-            described_class.new(SpecConfig.instance.addresses, monitoring,
-              SpecConfig.instance.test_options.merge(monitoring_io: false))
+            described_class.new(
+              SpecConfig.instance.addresses, monitoring,
+              SpecConfig.instance.test_options.merge(monitoring_io: false)
+            )
           end
 
           it 'returns true' do
@@ -90,59 +103,61 @@ describe Mongo::Cluster do
         end
 
         context 'when the options are not the same' do
-
           let(:other) do
-            described_class.new([ '127.0.0.1:27017' ], monitoring,
-              SpecConfig.instance.test_options.merge(replica_set: 'test', monitoring_io: false))
+            described_class.new(
+              [ '127.0.0.1:27017' ],
+              monitoring,
+              SpecConfig.instance.test_options.merge(replica_set: 'test', monitoring_io: false)
+            )
           end
 
           it 'returns false' do
-            expect(cluster_without_io).to_not eq(other)
+            expect(cluster_without_io).not_to eq(other)
           end
         end
       end
 
       context 'when the addresses are not the same' do
-
         let(:other) do
-          described_class.new([ '127.0.0.1:27999' ], monitoring,
-            SpecConfig.instance.test_options.merge(monitoring_io: false))
+          described_class.new(
+            [ '127.0.0.1:27999' ],
+            monitoring,
+            SpecConfig.instance.test_options.merge(monitoring_io: false)
+          )
         end
 
         it 'returns false' do
-          expect(cluster_without_io).to_not eq(other)
+          expect(cluster_without_io).not_to eq(other)
         end
       end
     end
 
     context 'when the other is not a cluster' do
-
       it 'returns false' do
-        expect(cluster_without_io).to_not eq('test')
+        expect(cluster_without_io).not_to eq('test')
       end
     end
   end
 
   describe '#has_readable_server?' do
-
     let(:selector) do
       Mongo::ServerSelector.primary
     end
 
     it 'delegates to the topology' do
-      expect(cluster_without_io.has_readable_server?).to eq(cluster_without_io.topology.has_readable_server?(cluster_without_io))
+      expect(cluster_without_io.has_readable_server?)
+        .to eq(cluster_without_io.topology.has_readable_server?(cluster_without_io))
     end
   end
 
   describe '#has_writable_server?' do
-
     it 'delegates to the topology' do
-      expect(cluster_without_io.has_writable_server?).to eq(cluster_without_io.topology.has_writable_server?(cluster_without_io))
+      expect(cluster_without_io.has_writable_server?)
+        .to eq(cluster_without_io.topology.has_writable_server?(cluster_without_io))
     end
   end
 
   describe '#inspect' do
-
     let(:preference) do
       Mongo::ServerSelector.primary
     end
@@ -154,18 +169,16 @@ describe Mongo::Cluster do
   end
 
   describe '#replica_set_name' do
-
     let(:preference) do
       Mongo::ServerSelector.primary
     end
 
     context 'when the option is provided' do
-
       let(:cluster) do
         described_class.new(
           [ '127.0.0.1:27017' ],
           monitoring,
-          {monitoring_io: false, connect: :replica_set, replica_set: 'testing'},
+          { monitoring_io: false, connect: :replica_set, replica_set: 'testing' }
         )
       end
 
@@ -175,12 +188,11 @@ describe Mongo::Cluster do
     end
 
     context 'when the option is not provided' do
-
       let(:cluster) do
         described_class.new(
           [ '127.0.0.1:27017' ],
           monitoring,
-          {monitoring_io: false, connect: :direct},
+          { monitoring_io: false, connect: :direct }
         )
       end
 
@@ -191,7 +203,6 @@ describe Mongo::Cluster do
   end
 
   describe '#scan!' do
-
     let(:preference) do
       Mongo::ServerSelector.primary
     end
@@ -224,9 +235,7 @@ describe Mongo::Cluster do
 
     context 'when topology is single' do
       before do
-        unless ClusterConfig.instance.single_server?
-          skip 'Topology is not a single server'
-        end
+        skip 'Topology is not a single server' unless ClusterConfig.instance.single_server?
       end
 
       context 'when the server is a mongos' do
@@ -247,7 +256,6 @@ describe Mongo::Cluster do
     end
 
     context 'when the cluster has no servers' do
-
       let(:servers) do
         []
       end
@@ -258,7 +266,6 @@ describe Mongo::Cluster do
       end
 
       context 'when topology is Single' do
-
         let(:topology) do
           Mongo::Cluster::Topology::Single.new({}, monitoring, cluster_without_io)
         end
@@ -269,9 +276,8 @@ describe Mongo::Cluster do
       end
 
       context 'when topology is ReplicaSetNoPrimary' do
-
         let(:topology) do
-          Mongo::Cluster::Topology::ReplicaSetNoPrimary.new({replica_set_name: 'foo'}, monitoring, cluster_without_io)
+          Mongo::Cluster::Topology::ReplicaSetNoPrimary.new({ replica_set_name: 'foo' }, monitoring, cluster_without_io)
         end
 
         it 'returns an empty array' do
@@ -280,7 +286,6 @@ describe Mongo::Cluster do
       end
 
       context 'when topology is Sharded' do
-
         let(:topology) do
           Mongo::Cluster::Topology::Sharded.new({}, monitoring, cluster_without_io)
         end
@@ -291,7 +296,6 @@ describe Mongo::Cluster do
       end
 
       context 'when topology is Unknown' do
-
         let(:topology) do
           Mongo::Cluster::Topology::Unknown.new({}, monitoring, cluster_without_io)
         end
@@ -304,7 +308,6 @@ describe Mongo::Cluster do
   end
 
   describe '#add' do
-
     context 'topology is Sharded' do
       require_topology :sharded
 
@@ -317,19 +320,19 @@ describe Mongo::Cluster do
       end
 
       it 'creates server with nil last_scan' do
-        server = cluster.servers_list.detect do |server|
-          server.address.seed == 'a'
+        server = cluster.servers_list.detect do |srv|
+          srv.address.seed == 'a'
         end
 
-        expect(server).not_to be nil
+        expect(server).not_to be_nil
 
-        expect(server.last_scan).to be nil
-        expect(server.last_scan_monotime).to be nil
+        expect(server.last_scan).to be_nil
+        expect(server.last_scan_monotime).to be_nil
       end
     end
   end
 
-  describe '#disconnect!' do
+  describe '#close' do
     let(:cluster) { cluster_with_semaphore }
 
     let(:known_servers) do
@@ -340,24 +343,20 @@ describe Mongo::Cluster do
       cluster.instance_variable_get(:@periodic_executor)
     end
 
-    describe 'disconnection' do
+    describe 'closing' do
       before do
-        known_servers.each do |server|
-          expect(server).to receive(:disconnect!).and_call_original
-        end
+        expect(known_servers).to all receive(:close).and_call_original
         expect(periodic_executor).to receive(:stop!).and_call_original
       end
 
-      it 'disconnects each server and the cursor reaper and returns true' do
-        expect(cluster.disconnect!).to be(true)
+      it 'disconnects each server and the cursor reaper and returns nil' do
+        expect(cluster.close).to be_nil
       end
     end
 
-    describe 'repeated disconnection' do
+    describe 'repeated closing' do
       before do
-        known_servers.each do |server|
-          expect(server).to receive(:disconnect!).and_call_original
-        end
+        expect(known_servers).to all receive(:close).and_call_original
         expect(periodic_executor).to receive(:stop!).and_call_original
       end
 
@@ -366,17 +365,16 @@ describe Mongo::Cluster do
 
       it 'publishes server closed event once' do
         monitoring.subscribe(Mongo::Monitoring::SERVER_CLOSED, subscriber)
-        expect(cluster.disconnect!).to be(true)
-        expect(subscriber.first_event('server_closed_event')).not_to be nil
+        expect(cluster.close).to be_nil
+        expect(subscriber.first_event('server_closed_event')).not_to be_nil
         subscriber.succeeded_events.clear
-        expect(cluster.disconnect!).to be(true)
-        expect(subscriber.first_event('server_closed_event')).to be nil
+        expect(cluster.close).to be_nil
+        expect(subscriber.first_event('server_closed_event')).to be_nil
       end
     end
   end
 
   describe '#reconnect!' do
-
     let(:cluster) { cluster_with_semaphore }
 
     let(:periodic_executor) do
@@ -385,9 +383,7 @@ describe Mongo::Cluster do
 
     before do
       cluster.next_primary
-      cluster.servers.each do |server|
-        expect(server).to receive(:reconnect!).and_call_original
-      end
+      expect(cluster.servers).to all receive(:reconnect!).and_call_original
       expect(periodic_executor).to receive(:restart!).and_call_original
     end
 
@@ -397,29 +393,32 @@ describe Mongo::Cluster do
   end
 
   describe '#remove' do
-
-    let(:address_a) do
-      Mongo::Address.new('127.0.0.1:25555')
-    end
-
-    let(:address_b) do
-      Mongo::Address.new('127.0.0.1:25556')
-    end
-
-    let(:monitoring) do
-      Mongo::Monitoring.new(monitoring: false)
-    end
+    let(:address_a) { Mongo::Address.new('127.0.0.1:25555') }
+    let(:address_b) { Mongo::Address.new('127.0.0.1:25556') }
+    let(:monitoring) { Mongo::Monitoring.new(monitoring: false) }
 
     let(:server_a) do
       register_server(
-        Mongo::Server.new(address_a, cluster, monitoring, Mongo::Event::Listeners.new,
-          monitor: false))
+        Mongo::Server.new(
+          address_a,
+          cluster,
+          monitoring,
+          Mongo::Event::Listeners.new,
+          monitor: false
+        )
+      )
     end
 
     let(:server_b) do
       register_server(
-        Mongo::Server.new(address_b, cluster, monitoring, Mongo::Event::Listeners.new,
-          monitor: false))
+        Mongo::Server.new(
+          address_b,
+          cluster,
+          monitoring,
+          Mongo::Event::Listeners.new,
+          monitor: false
+        )
+      )
     end
 
     let(:servers) do
@@ -436,16 +435,15 @@ describe Mongo::Cluster do
     end
 
     it 'removes the host from the list of servers' do
-      expect(cluster.instance_variable_get(:@servers)).to eq([server_b])
+      expect(cluster.instance_variable_get(:@servers)).to eq([ server_b ])
     end
 
     it 'removes the host from the list of addresses' do
-      expect(cluster.addresses).to eq([address_b])
+      expect(cluster.addresses).to eq([ address_b ])
     end
   end
 
   describe '#next_primary' do
-
     let(:cluster) do
       # We use next_primary to wait for server selection, and this is
       # also the method we are testing.
@@ -453,12 +451,10 @@ describe Mongo::Cluster do
     end
 
     let(:primary_candidates) do
-      if cluster.single? || cluster.load_balanced?
-        cluster.servers
-      elsif cluster.sharded?
+      if cluster.single? || cluster.load_balanced? || cluster.sharded?
         cluster.servers
       else
-        cluster.servers.select { |s| s.primary? }
+        cluster.servers.select(&:primary?)
       end
     end
 
@@ -468,36 +464,32 @@ describe Mongo::Cluster do
   end
 
   describe '#app_metadata' do
-
     it 'returns an AppMetadata object' do
       expect(cluster_without_io.app_metadata).to be_a(Mongo::Server::AppMetadata)
     end
 
     context 'when the client has an app_name set' do
-
       let(:cluster) do
         authorized_client.with(app_name: 'cluster_test', monitoring_io: false).cluster
       end
 
       it 'constructs an AppMetadata object with the app_name' do
-        expect(cluster.app_metadata.send(:full_client_document)[:application]).to eq('name' => 'cluster_test')
+        expect(cluster.app_metadata.client_document[:application]).to eq('name' => 'cluster_test')
       end
     end
 
     context 'when the client does not have an app_name set' do
-
       let(:cluster) do
         authorized_client.cluster
       end
 
       it 'constructs an AppMetadata object with no app_name' do
-        expect(cluster.app_metadata.send(:full_client_document)[:application]).to be_nil
+        expect(cluster.app_metadata.client_document[:application]).to be_nil
       end
     end
   end
 
   describe '#cluster_time' do
-
     let(:operation) do
       client.command(ping: 1)
     end
@@ -514,10 +506,14 @@ describe Mongo::Cluster do
   end
 
   describe '#update_cluster_time' do
-
     let(:cluster) do
-      described_class.new(SpecConfig.instance.addresses, monitoring,
-        SpecConfig.instance.test_options.merge(heartbeat_frequency: 1000, monitoring_io: false))
+      described_class.new(
+        SpecConfig.instance.addresses, monitoring,
+        SpecConfig.instance.test_options.merge(
+          heartbeat_frequency: 1000,
+          monitoring_io: false
+        )
+      )
     end
 
     let(:result) do
@@ -525,14 +521,12 @@ describe Mongo::Cluster do
     end
 
     context 'when the cluster_time variable is nil' do
-
       before do
         cluster.instance_variable_set(:@cluster_time, nil)
         cluster.update_cluster_time(result)
       end
 
       context 'when the cluster time received is nil' do
-
         let(:cluster_time_doc) do
           nil
         end
@@ -543,7 +537,6 @@ describe Mongo::Cluster do
       end
 
       context 'when the cluster time received is not nil' do
-
         let(:cluster_time_doc) do
           BSON::Document.new(Mongo::Cluster::CLUSTER_TIME => BSON::Timestamp.new(1, 1))
         end
@@ -555,29 +548,32 @@ describe Mongo::Cluster do
     end
 
     context 'when the cluster_time variable has a value' do
-
       before do
-        cluster.instance_variable_set(:@cluster_time, Mongo::ClusterTime.new(
-            Mongo::Cluster::CLUSTER_TIME => BSON::Timestamp.new(1, 1)))
+        cluster.instance_variable_set(
+          :@cluster_time,
+          Mongo::ClusterTime.new(
+            Mongo::Cluster::CLUSTER_TIME => BSON::Timestamp.new(1, 1)
+          )
+        )
         cluster.update_cluster_time(result)
       end
 
       context 'when the cluster time received is nil' do
-
         let(:cluster_time_doc) do
           nil
         end
 
         it 'does not update the cluster_time variable' do
-          expect(cluster.cluster_time).to eq(BSON::Document.new(
-              Mongo::Cluster::CLUSTER_TIME => BSON::Timestamp.new(1, 1)))
+          expect(cluster.cluster_time).to eq(
+            BSON::Document.new(
+              Mongo::Cluster::CLUSTER_TIME => BSON::Timestamp.new(1, 1)
+            )
+          )
         end
       end
 
       context 'when the cluster time received is not nil' do
-
         context 'when the cluster time received is greater than the cluster_time variable' do
-
           let(:cluster_time_doc) do
             BSON::Document.new(Mongo::Cluster::CLUSTER_TIME => BSON::Timestamp.new(1, 2))
           end
@@ -588,26 +584,30 @@ describe Mongo::Cluster do
         end
 
         context 'when the cluster time received is less than the cluster_time variable' do
-
           let(:cluster_time_doc) do
             BSON::Document.new(Mongo::Cluster::CLUSTER_TIME => BSON::Timestamp.new(0, 1))
           end
 
           it 'does not set the cluster_time variable to the cluster time' do
-            expect(cluster.cluster_time).to eq(BSON::Document.new(
-                Mongo::Cluster::CLUSTER_TIME => BSON::Timestamp.new(1, 1)))
+            expect(cluster.cluster_time).to eq(
+              BSON::Document.new(
+                Mongo::Cluster::CLUSTER_TIME => BSON::Timestamp.new(1, 1)
+              )
+            )
           end
         end
 
         context 'when the cluster time received is equal to the cluster_time variable' do
-
           let(:cluster_time_doc) do
             BSON::Document.new(Mongo::Cluster::CLUSTER_TIME => BSON::Timestamp.new(1, 1))
           end
 
           it 'does not change the cluster_time variable' do
-            expect(cluster.cluster_time).to eq(BSON::Document.new(
-                Mongo::Cluster::CLUSTER_TIME => BSON::Timestamp.new(1, 1)))
+            expect(cluster.cluster_time).to eq(
+              BSON::Document.new(
+                Mongo::Cluster::CLUSTER_TIME => BSON::Timestamp.new(1, 1)
+              )
+            )
           end
         end
       end
@@ -617,17 +617,15 @@ describe Mongo::Cluster do
   describe '#validate_session_support!' do
     shared_examples 'supports sessions' do
       it 'supports sessions' do
-        lambda do
-          cluster.validate_session_support!
-        end.should_not raise_error
+        expect { cluster.validate_session_support! }
+          .not_to raise_error
       end
     end
 
     shared_examples 'does not support sessions' do
       it 'does not support sessions' do
-        lambda do
-          cluster.validate_session_support!
-        end.should raise_error(Mongo::Error::SessionsNotSupported)
+        expect { cluster.validate_session_support! }
+          .to raise_error(Mongo::Error::SessionsNotSupported)
       end
     end
 
@@ -648,9 +646,13 @@ describe Mongo::Cluster do
         require_topology :replica_set
 
         let(:client) do
-          new_local_client([SpecConfig.instance.addresses.first],
+          new_local_client(
+            [ SpecConfig.instance.addresses.first ],
             SpecConfig.instance.test_options.merge(
-              connect: :direct, replica_set: ClusterConfig.instance.replica_set_name))
+              connect: :direct,
+              replica_set: ClusterConfig.instance.replica_set_name
+            )
+          )
         end
 
         it_behaves_like 'does not support sessions'
@@ -693,9 +695,13 @@ describe Mongo::Cluster do
         require_topology :replica_set
 
         let(:client) do
-          new_local_client([SpecConfig.instance.addresses.first],
+          new_local_client(
+            [ SpecConfig.instance.addresses.first ],
             SpecConfig.instance.test_options.merge(
-              connect: :direct, replica_set: ClusterConfig.instance.replica_set_name))
+              connect: :direct,
+              replica_set: ClusterConfig.instance.replica_set_name
+            )
+          )
         end
 
         it_behaves_like 'supports sessions'
@@ -719,15 +725,12 @@ describe Mongo::Cluster do
     end
   end
 
-  [
-    [:max_read_retries, 1],
-    [:read_retry_interval, 5],
-  ].each do |opt, default|
+  { max_read_retries: 1, read_retry_interval: 5 }.each do |opt, default|
     describe "##{opt}" do
       let(:client_options) { {} }
 
       let(:client) do
-        new_local_client_nmio(['127.0.0.1:27017'], client_options)
+        new_local_client_nmio([ '127.0.0.1:27017' ], client_options)
       end
 
       let(:cluster) do
@@ -735,13 +738,13 @@ describe Mongo::Cluster do
       end
 
       it "defaults to #{default}" do
-        expect(default).not_to be nil
-        expect(client.options[opt]).to be nil
+        expect(default).not_to be_nil
+        expect(client.options[opt]).to be_nil
         expect(cluster.send(opt)).to eq(default)
       end
 
       context 'specified on client' do
-        let(:client_options) { {opt => 2} }
+        let(:client_options) { { opt => 2 } }
 
         it 'inherits from client' do
           expect(client.options[opt]).to eq(2)
@@ -759,10 +762,7 @@ describe Mongo::Cluster do
       require_topology :single, :replica_set, :sharded
 
       it 'includes unknown servers' do
-        cluster.servers_list.each do |server|
-          expect(server).to be_unknown
-        end
-
+        expect(cluster.servers_list).to all be_unknown
         expect(cluster.summary).to match(/Server address=#{default_address}/)
       end
     end
@@ -785,3 +785,5 @@ describe Mongo::Cluster do
     end
   end
 end
+# rubocop:enable RSpec/ContextWording, RSpec/VerifiedDoubles, RSpec/MessageSpies
+# rubocop:enable RSpec/ExpectInHook, RSpec/ExampleLength