RUBY-1494 Add server addresses to replica set topology summaries (#1067)

Author: p-mongo

lib/mongo/cluster/topology/replica_set_no_primary.rb

@@ -46,7 +46,18 @@ def display_name
         # @api experimental
         # @since 2.7.0
         def summary
-          "#{display_name.gsub(' ', '')}[name=#{replica_set_name},v=#{@max_set_version},e=#{@max_election_id && @max_election_id.to_s.sub(/^0+/, '')}]"
+          details = server_descriptions.keys.join(',')
+          if details != ''
+            details << ','
+          end
+          details << "name=#{replica_set_name}"
+          if max_set_version
+            details << ",v=#{max_set_version}"
+          end
+          if max_election_id
+            details << ",e=#{max_election_id && max_election_id.to_s.sub(/^0+/, '')}"
+          end
+          "#{display_name}[#{details}]"
         end
 
         # Determine if the topology would select a readable server for the

lib/mongo/cluster/topology/sharded.rb

@@ -44,7 +44,8 @@ def display_name
         # @api experimental
         # @since 2.7.0
         def summary
-          display_name.gsub(' ', '')
+          details = server_descriptions.keys.join(',')
+          "#{display_name}[#{details}]"
         end
 
         # Determine if the topology would select a readable server for the

lib/mongo/cluster/topology/single.rb

@@ -44,7 +44,8 @@ def display_name
         # @api experimental
         # @since 2.7.0
         def summary
-          display_name
+          details = server_descriptions.keys.join(',')
+          "#{display_name}[#{details}]"
         end
 
         # Determine if the topology would select a readable server for the

lib/mongo/cluster/topology/unknown.rb

@@ -44,7 +44,8 @@ def display_name
         # @api experimental
         # @since 2.7.0
         def summary
-          "#{display_name}[#{addresses.join(', ')}]"
+          details = server_descriptions.keys.join(',')
+          "#{display_name}[#{details}]"
         end
 
         # Determine if the topology would select a readable server for the

spec/mongo/cluster/topology/replica_set_spec.rb

@@ -505,4 +505,34 @@
       end
     end
   end
+
+  describe '#summary' do
+    let(:desc) do
+      Mongo::Server::Description.new(Mongo::Address.new('127.0.0.2:27017'))
+    end
+
+    let(:topology) do
+      described_class.new({replica_set_name: 'foo'}, monitoring, temp_cluster)
+    end
+
+    it 'renders correctly' do
+      expect(topology).to receive(:server_descriptions).and_return({desc.address.to_s => desc})
+      expect(topology.summary).to eq('ReplicaSetNoPrimary[127.0.0.2:27017,name=foo]')
+    end
+
+    context 'with max set version and max election id' do
+      let(:topology) do
+        described_class.new({
+          replica_set_name: 'foo',
+          max_set_version: 5,
+          max_election_id: BSON::ObjectId.from_string('7fffffff0000000000000042'),
+        }, monitoring, temp_cluster)
+      end
+
+      it 'renders correctly' do
+        expect(topology).to receive(:server_descriptions).and_return({desc.address.to_s => desc})
+        expect(topology.summary).to eq('ReplicaSetNoPrimary[127.0.0.2:27017,name=foo,v=5,e=7fffffff0000000000000042]')
+      end
+    end
+  end
 end

spec/mongo/cluster/topology/sharded_spec.rb

@@ -109,4 +109,21 @@
       expect(topology).to have_writable_server(nil)
     end
   end
+
+  describe '#summary' do
+    let(:desc1) do
+      Mongo::Server::Description.new(Mongo::Address.new('127.0.0.2:27017'))
+    end
+
+    let(:desc2) do
+      Mongo::Server::Description.new(Mongo::Address.new('127.0.0.2:27027'))
+    end
+
+    it 'renders correctly' do
+      expect(topology).to receive(:server_descriptions).and_return({
+        desc1.address.to_s => desc1, desc2.address.to_s => desc2,
+      })
+      expect(topology.summary).to eq('Sharded[127.0.0.2:27017,127.0.0.2:27027]')
+    end
+  end
 end

spec/mongo/cluster/topology/single_spec.rb

@@ -114,4 +114,15 @@
       expect(topology).to have_writable_server(nil)
     end
   end
+
+  describe '#summary' do
+    let(:desc) do
+      Mongo::Server::Description.new(Mongo::Address.new('127.0.0.2:27017'))
+    end
+
+    it 'renders correctly' do
+      expect(topology).to receive(:server_descriptions).and_return({desc.address.to_s => desc})
+      expect(topology.summary).to eq('Single[127.0.0.2:27017]')
+    end
+  end
 end

spec/mongo/cluster/topology/unknown_spec.rb

@@ -70,4 +70,15 @@
       expect(topology).to_not have_writable_server(nil)
     end
   end
+
+  describe '#summary' do
+    let(:desc) do
+      Mongo::Server::Description.new(Mongo::Address.new('127.0.0.2:27017'))
+    end
+
+    it 'renders correctly' do
+      expect(topology).to receive(:server_descriptions).and_return({desc.address.to_s => desc})
+      expect(topology.summary).to eq('Unknown[127.0.0.2:27017]')
+    end
+  end
 end

spec/mongo/monitoring/event/server_closed_spec.rb

@@ -25,6 +25,8 @@
 
   describe '#summary' do
     it 'renders correctly' do
+      expect(topology).to receive(:server_descriptions).and_return({
+        '127.0.0.1:27017' => Mongo::Server::Description.new(Mongo::Address.new('127.0.0.1:27017'))})
       expect(event.summary).to eq('#<ServerClosed address=127.0.0.1:27017 topology=Unknown[127.0.0.1:27017]>')
     end
   end

spec/mongo/monitoring/event/server_description_changed_spec.rb

@@ -28,6 +28,8 @@
 
   describe '#summary' do
     it 'renders correctly' do
+      expect(topology).to receive(:server_descriptions).and_return({
+        '127.0.0.1:27017' => Mongo::Server::Description.new(Mongo::Address.new('127.0.0.1:27017'))})
       expect(event.summary).to eq("#<ServerDescriptionChanged address=127.0.0.1:27017 topology=Unknown[127.0.0.1:27017] prev=#{previous_desc.inspect} new=#{updated_desc.inspect}>")
     end
   end