elasticsearch-transport 7.1.0 → 7.13.3

data/spec/elasticsearch/connections/collection_spec.rb

@@ -0,0 +1,266 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'spec_helper'
+
+describe Elasticsearch::Transport::Transport::Connections::Collection do
+
+  describe '#initialize' do
+
+    let(:collection) do
+      described_class.new
+    end
+
+    it 'has an empty list of connections as a default' do
+      expect(collection.connections).to be_empty
+    end
+
+    it 'has a default selector class' do
+      expect(collection.selector).not_to be_nil
+    end
+
+    context 'when a selector class is specified' do
+
+      let(:collection) do
+        described_class.new(selector_class: Elasticsearch::Transport::Transport::Connections::Selector::Random)
+      end
+
+      it 'sets the selector' do
+        expect(collection.selector).to be_a(Elasticsearch::Transport::Transport::Connections::Selector::Random)
+      end
+    end
+  end
+
+  describe '#get_connection' do
+
+    let(:collection) do
+      described_class.new(selector_class: Elasticsearch::Transport::Transport::Connections::Selector::Random)
+    end
+
+    before do
+      expect(collection.selector).to receive(:select).and_return('OK')
+    end
+
+    it 'uses the selector to select a connection' do
+      expect(collection.get_connection).to eq('OK')
+    end
+  end
+
+  describe '#hosts' do
+
+    let(:collection) do
+      described_class.new(connections: [ double('connection', host: 'A'),
+                                         double('connection', host: 'B') ])
+    end
+
+    it 'returns a list of hosts' do
+      expect(collection.hosts).to eq([ 'A', 'B'])
+    end
+  end
+
+  describe 'enumerable' do
+
+    let(:collection) do
+      described_class.new(connections: [ double('connection', host: 'A', dead?: false),
+                                         double('connection', host: 'B', dead?: false) ])
+    end
+
+    describe '#map' do
+
+      it 'responds to the method' do
+        expect(collection.map { |c| c.host.downcase }).to eq(['a', 'b'])
+      end
+    end
+
+    describe '#[]' do
+
+      it 'responds to the method' do
+        expect(collection[0].host).to eq('A')
+        expect(collection[1].host).to eq('B')
+      end
+    end
+
+    describe '#size' do
+
+      it 'responds to the method' do
+        expect(collection.size).to eq(2)
+      end
+    end
+
+    context 'when a connection is marked as dead' do
+
+      let(:collection) do
+        described_class.new(connections: [ double('connection', host: 'A', dead?: true),
+                                           double('connection', host: 'B', dead?: false) ])
+      end
+
+      it 'does not enumerate the dead connections' do
+        expect(collection.size).to eq(1)
+        expect(collection.collect { |c| c.host }).to eq(['B'])
+      end
+
+      context '#alive' do
+
+        it 'enumerates the alive connections' do
+          expect(collection.alive.collect { |c| c.host }).to eq(['B'])
+        end
+      end
+
+      context '#dead' do
+
+        it 'enumerates the alive connections' do
+          expect(collection.dead.collect { |c| c.host }).to eq(['A'])
+        end
+      end
+    end
+  end
+
+  describe '#add' do
+
+    let(:collection) do
+      described_class.new(connections: [ double('connection', host: 'A', dead?: false),
+                                         double('connection', host: 'B', dead?: false) ])
+    end
+
+    context 'when an array is provided' do
+
+      before do
+        collection.add([double('connection', host: 'C', dead?: false),
+                        double('connection', host: 'D', dead?: false)])
+      end
+
+      it 'adds the connections' do
+        expect(collection.size).to eq(4)
+      end
+    end
+
+    context 'when an element is provided' do
+
+      before do
+        collection.add(double('connection', host: 'C', dead?: false))
+      end
+
+      it 'adds the connection' do
+        expect(collection.size).to eq(3)
+      end
+    end
+  end
+
+  describe '#remove' do
+
+    let(:connections) do
+      [ double('connection', host: 'A', dead?: false),
+        double('connection', host: 'B', dead?: false) ]
+    end
+
+    let(:collection) do
+      described_class.new(connections: connections)
+    end
+
+    context 'when an array is provided' do
+
+      before do
+        collection.remove(connections)
+      end
+
+      it 'removes the connections' do
+        expect(collection.size).to eq(0)
+      end
+    end
+
+    context 'when an element is provided' do
+
+      let(:connections) do
+        [ double('connection', host: 'A', dead?: false),
+          double('connection', host: 'B', dead?: false) ]
+      end
+
+      before do
+        collection.remove(connections.first)
+      end
+
+      it 'removes the connection' do
+        expect(collection.size).to eq(1)
+      end
+    end
+  end
+
+  describe '#get_connection' do
+
+    context 'when all connections are dead' do
+
+      let(:connection_a) do
+        Elasticsearch::Transport::Transport::Connections::Connection.new(host: { host: 'A' })
+      end
+
+      let(:connection_b) do
+        Elasticsearch::Transport::Transport::Connections::Connection.new(host: { host: 'B' })
+      end
+
+      let(:collection) do
+        described_class.new(connections: [connection_a, connection_b])
+      end
+
+      before do
+        connection_a.dead!.dead!
+        connection_b.dead!
+      end
+
+      it 'returns the connection with the least failures' do
+        expect(collection.get_connection.host[:host]).to eq('B')
+      end
+    end
+
+    context 'when multiple threads are used' do
+
+      let(:connections) do
+        20.times.collect do |i|
+          Elasticsearch::Transport::Transport::Connections::Connection.new(host: { host: i })
+        end
+      end
+
+      let(:collection) do
+        described_class.new(connections: connections)
+      end
+
+      it 'allows threads to select connections in parallel' do
+       expect(10.times.collect do
+          threads = []
+          20.times do
+            threads << Thread.new do
+              collection.get_connection
+            end
+          end
+          threads.map { |t| t.join }
+          collection.get_connection.host[:host]
+        end).to eq((0..9).to_a)
+      end
+
+      it 'always returns a connection' do
+        threads = 20.times.map do
+          Thread.new do
+            20.times.map do
+              collection.get_connection.dead!
+            end
+          end
+        end
+
+        expect(threads.flat_map(&:value).size).to eq(400)
+      end
+    end
+  end
+end

data/spec/elasticsearch/connections/selector_spec.rb

@@ -0,0 +1,174 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require 'spec_helper'
+
+describe Elasticsearch::Transport::Transport::Connections::Selector do
+
+  before do
+    class BackupStrategySelector
+      include Elasticsearch::Transport::Transport::Connections::Selector::Base
+
+      def select(options={})
+        connections.reject do |c|
+          c.host[:attributes] && c.host[:attributes][:backup]
+        end.sample
+      end
+    end
+  end
+
+  after do
+    Object.send(:remove_const, :BackupStrategySelector)
+  end
+
+  let(:backup_strategy_selector) do
+    BackupStrategySelector.new
+  end
+
+  describe 'the Random selector' do
+
+    let(:connections) do
+      [1, 2]
+    end
+
+    let(:selector) do
+      described_class::Random.new(connections: connections)
+    end
+
+    it 'is initialized with connections' do
+      expect(selector.connections).to eq(connections)
+    end
+
+    describe '#select' do
+
+      let(:connections) do
+        (0..19).to_a
+      end
+
+      it 'returns a connection' do
+        expect(selector.select).to be_a(Integer)
+      end
+
+      context 'when multiple threads are used' do
+
+        it 'allows threads to select connections in parallel' do
+          expect(10.times.collect do
+            threads = []
+            20.times do
+              threads << Thread.new do
+                selector.select
+              end
+            end
+            threads.map { |t| t.join }
+            selector.select
+          end).to all(be_a(Integer))
+        end
+      end
+    end
+  end
+
+  describe 'the RoundRobin selector' do
+
+    let(:connections) do
+      ['A', 'B', 'C']
+    end
+
+    let(:selector) do
+      described_class::RoundRobin.new(connections: connections)
+    end
+
+    it 'is initialized with connections' do
+      expect(selector.connections).to eq(connections)
+    end
+
+    describe '#select' do
+
+      it 'rotates over the connections' do
+        expect(selector.select).to eq('A')
+        expect(selector.select).to eq('B')
+        expect(selector.select).to eq('C')
+        expect(selector.select).to eq('A')
+      end
+
+      context 'when multiple threads are used' do
+
+        let(:connections) do
+          (0..19).to_a
+        end
+
+        it 'returns a connection' do
+          expect(selector.select).to be_a(Integer)
+        end
+
+        it 'allows threads to select connections in parallel' do
+          expect(10.times.collect do
+            threads = []
+            20.times do
+              threads << Thread.new do
+                selector.select
+              end
+            end
+            threads.map { |t| t.join }
+            selector.select
+          end).to eq((0..9).to_a)
+        end
+      end
+    end
+  end
+
+  describe 'a custom selector' do
+
+    let(:connections) do
+      [ double(host: { hostname: 'host1' }),
+        double(host: { hostname: 'host2', attributes: { backup: true } }) ]
+    end
+
+    let(:selector) do
+      BackupStrategySelector.new(connections: connections)
+    end
+
+    it 'is initialized with connections' do
+      expect(selector.connections).to eq(connections)
+    end
+
+    describe '#select' do
+
+      it 'applies the custom strategy' do
+        10.times { expect(selector.select.host[:hostname]).to eq('host1') }
+      end
+    end
+  end
+
+  context 'when the Base module is included in a class' do
+
+    before do
+      class ExampleSelector
+        include Elasticsearch::Transport::Transport::Connections::Selector::Base
+      end
+    end
+
+    after do
+      Object.send(:remove_const, :ExampleSelector)
+    end
+
+    it 'requires the #select method to be redefined' do
+      expect {
+        ExampleSelector.new.select
+      }.to raise_exception(NoMethodError)
+    end
+  end
+end

data/spec/elasticsearch/transport/base_spec.rb

@@ -6,7 +6,7 @@
 # not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
-#	http://www.apache.org/licenses/LICENSE-2.0
+#   http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
@@ -18,11 +18,8 @@
 require 'spec_helper'
 
 describe Elasticsearch::Transport::Transport::Base do
-
   context 'when a host is printed in a logged message' do
-
     shared_examples_for 'a redacted string' do
-
       let(:client) do
         Elasticsearch::Transport::Client.new(arguments)
       end
@@ -33,6 +30,7 @@ describe Elasticsearch::Transport::Transport::Base do
 
       it 'does not include the password in the logged string' do
         expect(logger).not_to receive(:error).with(/secret_password/)
+
         expect {
           client.cluster.stats
         }.to raise_exception(Faraday::ConnectionFailed)
@@ -47,35 +45,221 @@ describe Elasticsearch::Transport::Transport::Base do
     end
 
     context 'when the user and password are provided as separate arguments' do
-
       let(:arguments) do
-        { hosts: 'fake',
+        {
+          hosts: 'fake',
           logger: logger,
           password: 'secret_password',
-          user: 'test' }
+          user: 'test'
+        }
       end
 
       it_behaves_like 'a redacted string'
     end
 
     context 'when the user and password are provided in the string URI' do
-
       let(:arguments) do
-        { hosts: 'http://test:secret_password@fake.com',
-          logger: logger }
+        {
+          hosts: 'https://test:secret_password@fake_local_elasticsearch',
+          logger: logger
+        }
       end
 
       it_behaves_like 'a redacted string'
     end
 
     context 'when the user and password are provided in the URI object' do
-
       let(:arguments) do
-        { hosts: URI.parse('http://test:secret_password@fake.com'),
-          logger: logger }
+        {
+          hosts: URI.parse('https://test:secret_password@fake_local_elasticsearch'),
+          logger: logger
+        }
       end
 
       it_behaves_like 'a redacted string'
     end
   end
+
+  context 'when reload_on_failure is true and and hosts are unreachable' do
+    let(:client) do
+      Elasticsearch::Transport::Client.new(arguments)
+    end
+
+    let(:arguments) do
+      {
+        hosts: ['http://unavailable:9200', 'http://unavailable:9201'],
+        reload_on_failure: true,
+        sniffer_timeout: 5
+      }
+    end
+
+    it 'raises an exception' do
+      expect { client.info }.to raise_exception(Faraday::ConnectionFailed)
+    end
+  end
+
+  context 'when the client has `retry_on_failure` set to an integer' do
+    let(:client) do
+      Elasticsearch::Transport::Client.new(arguments)
+    end
+
+    let(:arguments) do
+      {
+        hosts: ['http://unavailable:9200', 'http://unavailable:9201'],
+        retry_on_failure: 2
+      }
+    end
+
+    context 'when `perform_request` is called without a `retry_on_failure` option value' do
+      before do
+        expect(client.transport).to receive(:get_connection).exactly(3).times.and_call_original
+      end
+
+      it 'uses the client `retry_on_failure` value' do
+        expect {
+          client.transport.perform_request('GET', '/info')
+        }.to raise_exception(Faraday::ConnectionFailed)
+      end
+    end
+
+    context 'when `perform_request` is called with a `retry_on_status` option value' do
+      before do
+        expect(client.transport).to receive(:__raise_transport_error).exactly(6).times.and_call_original
+      end
+
+      let(:arguments) do
+        {
+          hosts: ['http://localhost:9250'],
+          retry_on_status: ['404']
+        }
+      end
+
+      it 'retries on 404 status the specified number of max_retries' do
+        expect do
+          client.transport.perform_request('GET', 'myindex/mydoc/1?routing=FOOBARBAZ', {}, nil, nil, retry_on_failure: 5)
+        end.to raise_exception(Elasticsearch::Transport::Transport::Errors::NotFound)
+      end
+    end
+
+    context 'when `perform_request` is called with a `retry_on_failure` option value' do
+      before do
+        expect(client.transport).to receive(:get_connection).exactly(6).times.and_call_original
+      end
+
+      it 'uses the option `retry_on_failure` value' do
+        expect do
+          client.transport.perform_request('GET', '/info', {}, nil, nil, retry_on_failure: 5)
+        end.to raise_exception(Faraday::ConnectionFailed)
+      end
+    end
+  end
+
+  context 'when the client has `retry_on_failure` set to true' do
+    let(:client) do
+      Elasticsearch::Transport::Client.new(arguments)
+    end
+
+    let(:arguments) do
+      {
+          hosts: ['http://unavailable:9200', 'http://unavailable:9201'],
+          retry_on_failure: true
+      }
+    end
+
+    context 'when `perform_request` is called without a `retry_on_failure` option value' do
+      before do
+        expect(client.transport).to receive(:get_connection).exactly(4).times.and_call_original
+      end
+
+      it 'uses the default `MAX_RETRIES` value' do
+        expect {
+          client.transport.perform_request('GET', '/info')
+        }.to raise_exception(Faraday::ConnectionFailed)
+      end
+    end
+
+    context 'when `perform_request` is called with a `retry_on_failure` option value' do
+      before do
+        expect(client.transport).to receive(:get_connection).exactly(6).times.and_call_original
+      end
+
+      it 'uses the option `retry_on_failure` value' do
+        expect {
+          client.transport.perform_request('GET', '/info', {}, nil, nil, retry_on_failure: 5)
+        }.to raise_exception(Faraday::ConnectionFailed)
+      end
+    end
+  end
+
+  context 'when the client has `retry_on_failure` set to false' do
+    let(:client) do
+      Elasticsearch::Transport::Client.new(arguments)
+    end
+
+    let(:arguments) do
+      {
+          hosts: ['http://unavailable:9200', 'http://unavailable:9201'],
+          retry_on_failure: false
+      }
+    end
+
+    context 'when `perform_request` is called without a `retry_on_failure` option value' do
+      before do
+        expect(client.transport).to receive(:get_connection).once.and_call_original
+      end
+
+      it 'does not retry' do
+        expect {
+          client.transport.perform_request('GET', '/info')
+        }.to raise_exception(Faraday::ConnectionFailed)
+      end
+    end
+
+    context 'when `perform_request` is called with a `retry_on_failure` option value' do
+
+      before do
+        expect(client.transport).to receive(:get_connection).exactly(6).times.and_call_original
+      end
+
+      it 'uses the option `retry_on_failure` value' do
+        expect {
+          client.transport.perform_request('GET', '/info', {}, nil, nil, retry_on_failure: 5)
+        }.to raise_exception(Faraday::ConnectionFailed)
+      end
+    end
+  end
+
+  context 'when the client has no `retry_on_failure` set' do
+    let(:client) do
+      Elasticsearch::Transport::Client.new(arguments)
+    end
+
+    let(:arguments) do
+      { hosts: ['http://unavailable:9200', 'http://unavailable:9201'] }
+    end
+
+    context 'when `perform_request` is called without a `retry_on_failure` option value' do
+      before do
+        expect(client.transport).to receive(:get_connection).exactly(1).times.and_call_original
+      end
+
+      it 'does not retry' do
+        expect do
+          client.transport.perform_request('GET', '/info')
+        end.to raise_exception(Faraday::ConnectionFailed)
+      end
+    end
+
+    context 'when `perform_request` is called with a `retry_on_failure` option value' do
+      before do
+        expect(client.transport).to receive(:get_connection).exactly(6).times.and_call_original
+      end
+
+      it 'uses the option `retry_on_failure` value' do
+        expect do
+          client.transport.perform_request('GET', '/info', {}, nil, nil, retry_on_failure: 5)
+        end.to raise_exception(Faraday::ConnectionFailed)
+      end
+    end
+  end
 end