elasticsearch-transport 7.13.3 → 7.17.0

data/lib/elasticsearch/transport.rb

@@ -15,35 +15,24 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require "uri"
-require "time"
-require "timeout"
-require "multi_json"
-require "faraday"
+require 'uri'
+require 'time'
+require 'timeout'
+require 'zlib'
+require 'multi_json'
+require 'faraday'
 
-require "elasticsearch/transport/transport/loggable"
-require "elasticsearch/transport/transport/serializer/multi_json"
-require "elasticsearch/transport/transport/sniffer"
-require "elasticsearch/transport/transport/response"
-require "elasticsearch/transport/transport/errors"
-require "elasticsearch/transport/transport/base"
-require "elasticsearch/transport/transport/connections/selector"
-require "elasticsearch/transport/transport/connections/connection"
-require "elasticsearch/transport/transport/connections/collection"
-require "elasticsearch/transport/transport/http/faraday"
-require "elasticsearch/transport/client"
-require "elasticsearch/transport/redacted"
+require 'elasticsearch/transport/transport/loggable'
+require 'elasticsearch/transport/transport/serializer/multi_json'
+require 'elasticsearch/transport/transport/sniffer'
+require 'elasticsearch/transport/transport/response'
+require 'elasticsearch/transport/transport/errors'
+require 'elasticsearch/transport/transport/base'
+require 'elasticsearch/transport/transport/connections/selector'
+require 'elasticsearch/transport/transport/connections/connection'
+require 'elasticsearch/transport/transport/connections/collection'
+require 'elasticsearch/transport/transport/http/faraday'
+require 'elasticsearch/transport/client'
+require 'elasticsearch/transport/redacted'
 
-require "elasticsearch/transport/version"
-
-module Elasticsearch
-  module Client
-
-    # A convenience wrapper for {::Elasticsearch::Transport::Client#initialize}.
-    #
-    def new(arguments={}, &block)
-      Elasticsearch::Transport::Client.new(arguments, &block)
-    end
-    extend self
-  end
-end
+require 'elasticsearch/transport/version'

data/spec/elasticsearch/transport/base_spec.rb

@@ -32,14 +32,14 @@ describe Elasticsearch::Transport::Transport::Base do
         expect(logger).not_to receive(:error).with(/secret_password/)
 
         expect {
-          client.cluster.stats
+          client.perform_request('GET', '_cluster/stats')
         }.to raise_exception(Faraday::ConnectionFailed)
       end
 
       it 'replaces the password with the string \'REDACTED\'' do
         expect(logger).to receive(:error).with(/REDACTED/)
         expect {
-          client.cluster.stats
+          client.perform_request('GET', '_cluster/stats')
         }.to raise_exception(Faraday::ConnectionFailed)
       end
     end
@@ -65,7 +65,27 @@ describe Elasticsearch::Transport::Transport::Base do
         }
       end
 
-      it_behaves_like 'a redacted string'
+      if jruby?
+        let(:client) { Elasticsearch::Transport::Client.new(arguments) }
+        let(:logger) { double('logger', fatal?: true, fatal: '') }
+
+        it 'does not include the password in the logged string' do
+          expect(logger).not_to receive(:fatal).with(/secret_password/)
+
+          expect {
+            client.perform_request('GET', '_cluster/stats')
+          }.to raise_exception(Faraday::SSLError)
+        end
+
+        it 'replaces the password with the string \'REDACTED\'' do
+          expect(logger).to receive(:fatal).with(/REDACTED/)
+          expect {
+            client.perform_request('GET', '_cluster/stats')
+          }.to raise_exception(Faraday::SSLError)
+        end
+      else
+        it_behaves_like 'a redacted string'
+      end
     end
 
     context 'when the user and password are provided in the URI object' do
@@ -75,8 +95,27 @@ describe Elasticsearch::Transport::Transport::Base do
           logger: logger
         }
       end
-
-      it_behaves_like 'a redacted string'
+      if jruby?
+        let(:client) { Elasticsearch::Transport::Client.new(arguments) }
+        let(:logger) { double('logger', fatal?: true, fatal: '') }
+
+        it 'does not include the password in the logged string' do
+          expect(logger).not_to receive(:fatal).with(/secret_password/)
+
+          expect {
+            client.perform_request('GET', '_cluster/stats')
+          }.to raise_exception(Faraday::SSLError)
+        end
+
+        it 'replaces the password with the string \'REDACTED\'' do
+          expect(logger).to receive(:fatal).with(/REDACTED/)
+          expect {
+            client.perform_request('GET', '_cluster/stats')
+          }.to raise_exception(Faraday::SSLError)
+        end
+      else
+        it_behaves_like 'a redacted string'
+      end
     end
   end
 
@@ -94,7 +133,7 @@ describe Elasticsearch::Transport::Transport::Base do
     end
 
     it 'raises an exception' do
-      expect { client.info }.to raise_exception(Faraday::ConnectionFailed)
+      expect { client.perform_request('GET', '/') }.to raise_exception(Faraday::ConnectionFailed)
     end
   end
 
@@ -129,7 +168,7 @@ describe Elasticsearch::Transport::Transport::Base do
 
       let(:arguments) do
         {
-          hosts: ['http://localhost:9250'],
+          hosts: ELASTICSEARCH_HOSTS,
           retry_on_status: ['404']
         }
       end

data/spec/elasticsearch/transport/client_spec.rb

@@ -24,10 +24,6 @@ describe Elasticsearch::Transport::Client do
     end
   end
 
-  it 'is aliased as Elasticsearch::Client' do
-    expect(Elasticsearch::Client.new).to be_a(described_class)
-  end
-
   it 'has a default transport' do
     expect(client.transport).to be_a(Elasticsearch::Transport::Client::DEFAULT_TRANSPORT_CLASS)
   end
@@ -231,13 +227,14 @@ describe Elasticsearch::Transport::Client do
 
   describe 'adapter' do
     context 'when no adapter is specified' do
-      let(:adapter) do
-        client.transport.connections.all.first.connection.builder.adapter
-      end
+      fork do
+        let(:client) { described_class.new }
+        let(:adapter) { client.transport.connections.all.first.connection.builder.adapter }
 
-      it 'uses Faraday NetHttp' do
-        expect(adapter).to eq Faraday::Adapter::NetHttp
-      end
+        it 'uses Faraday NetHttp' do
+          expect(adapter).to eq Faraday::Adapter::NetHttp
+        end
+      end unless jruby?
     end
 
     context 'when the adapter is patron' do
@@ -1416,14 +1413,14 @@ describe Elasticsearch::Transport::Client do
         let(:client) { described_class.new(host: hosts) }
 
         it 'doesnae raise an ArgumentError' do
-          expect { client.search(opaque_id: 'no_error') }.not_to raise_error
+          expect { client.perform_request('GET', '_search', opaque_id: 'no_error') }.not_to raise_error
         end
 
         it 'uses X-Opaque-Id in the header' do
           allow(client).to receive(:perform_request) { OpenStruct.new(body: '') }
-          expect { client.search(opaque_id: 'opaque_id') }.not_to raise_error
+          expect { client.perform_request('GET', '_search', {}, nil, opaque_id: 'opaque_id') }.not_to raise_error
           expect(client).to have_received(:perform_request)
-                              .with('GET', '_search', { opaque_id: 'opaque_id' }, nil, {})
+                              .with('GET', '_search', {}, nil, { opaque_id: 'opaque_id' })
         end
       end
     end
@@ -1435,10 +1432,7 @@ describe Elasticsearch::Transport::Client do
         headers = client.transport.connections.first.connection.headers
 
         expect(headers['Content-Type']).to eq('application/vnd.elasticsearch+json; compatible-with=7')
-        expect(headers['Accept']).to eq('application/vnd.elasticsearch+json;compatible-with=7')
-
-        response = client.perform_request('GET', '/')
-        expect(response.headers['content-type']).to eq('application/json; charset=UTF-8')
+        expect(headers['Accept']).to eq('application/vnd.elasticsearch+json; compatible-with=7')
 
         ENV.delete('ELASTIC_CLIENT_APIVERSIONING')
       end
@@ -1469,28 +1463,19 @@ describe Elasticsearch::Transport::Client do
     end
 
     context 'when Elasticsearch response includes a warning header' do
+      let(:logger) { double('logger', warn: '', warn?: '', info?: '', info: '', debug?: '', debug: '') }
       let(:client) do
-        Elasticsearch::Transport::Client.new(hosts: hosts)
+        Elasticsearch::Transport::Client.new(hosts: hosts, logger: logger)
       end
 
       let(:warning) { 'Elasticsearch warning: "deprecation warning"' }
 
       it 'prints a warning' do
-        allow_any_instance_of(Elasticsearch::Transport::Transport::Response).to receive(:headers) do
-          { 'warning' => warning }
-        end
-
-        begin
-          stderr      = $stderr
-          fake_stderr = StringIO.new
-          $stderr     = fake_stderr
-
-          client.perform_request('GET', '/')
-          fake_stderr.rewind
-          expect(fake_stderr.string).to eq("warning: #{warning}\n")
-        ensure
-          $stderr = stderr
+        expect_any_instance_of(Faraday::Connection).to receive(:run_request) do
+          Elasticsearch::Transport::Transport::Response.new(200, {}, { 'warning' => warning })
         end
+        client.perform_request('GET', '/')
+        expect(logger).to have_received(:warn).with(warning)
       end
     end
 
@@ -1500,7 +1485,7 @@ describe Elasticsearch::Transport::Client do
 
       it 'performs the request with the header' do
         allow(client).to receive(:perform_request) { OpenStruct.new(body: '') }
-        expect { client.search(headers: headers) }.not_to raise_error
+        expect { client.perform_request('GET', '_search', {}, nil, headers) }.not_to raise_error
         expect(client).to have_received(:perform_request)
                             .with('GET', '_search', {}, nil, headers)
       end
@@ -1514,7 +1499,7 @@ describe Elasticsearch::Transport::Client do
         )
       end
       let(:instance_headers) { { set_in_instantiation: 'header value' } }
-      let(:param_headers) {{'user-agent' => 'My Ruby Tests', 'set-on-method-call' => 'header value'}}
+      let(:param_headers) { {'user-agent' => 'My Ruby Tests', 'set-on-method-call' => 'header value'} }
 
       it 'performs the request with the header' do
         expected_headers = client.transport.connections.connections.first.connection.headers.merge(param_headers)
@@ -1523,7 +1508,7 @@ describe Elasticsearch::Transport::Client do
           .to receive(:run_request)
                 .with(:get, "http://#{hosts[0]}/_search", nil, expected_headers) { OpenStruct.new(body: '')}
 
-        client.search(headers: param_headers)
+        client.perform_request('GET', '_search', {}, nil, param_headers)
       end
     end
   end
@@ -1560,7 +1545,6 @@ describe Elasticsearch::Transport::Client do
     end
 
     context 'when a request is made' do
-
       let!(:response) do
         client.perform_request('GET', '_cluster/health')
       end
@@ -1571,9 +1555,7 @@ describe Elasticsearch::Transport::Client do
     end
 
     describe '#initialize' do
-
       context 'when options are specified' do
-
         let(:transport_options) do
           { headers: { accept: 'application/yaml', content_type: 'application/yaml' } }
         end
@@ -1589,9 +1571,8 @@ describe Elasticsearch::Transport::Client do
       end
 
       context 'when a block is provided' do
-
         let(:client) do
-          Elasticsearch::Client.new(host: ELASTICSEARCH_HOSTS.first, logger: logger) do |client|
+          described_class.new(host: ELASTICSEARCH_HOSTS.first, logger: logger) do |client|
             client.headers['Accept'] = 'application/yaml'
           end
         end
@@ -1607,7 +1588,7 @@ describe Elasticsearch::Transport::Client do
 
         context 'when the Faraday adapter is set in the block' do
           let(:client) do
-            Elasticsearch::Client.new(host: ELASTICSEARCH_HOSTS.first, logger: logger) do |client|
+            described_class.new(host: ELASTICSEARCH_HOSTS.first, logger: logger) do |client|
               client.adapter(:net_http_persistent)
             end
           end
@@ -1675,6 +1656,29 @@ describe Elasticsearch::Transport::Client do
         end
       end
 
+      context 'when retry_on_failure is true and delay_on_retry is specified' do
+        context 'when a node is unreachable' do
+          let(:hosts) do
+            [ELASTICSEARCH_HOSTS.first, "foobar1", "foobar2"]
+          end
+
+          let(:options) do
+            { retry_on_failure: true, delay_on_retry: 3000 }
+          end
+
+          let(:responses) do
+            5.times.collect do
+              client.perform_request('GET', '_nodes/_local')
+            end
+          end
+
+          it 'retries on failure' do
+            allow_any_instance_of(Object).to receive(:sleep).with(3000 / 1000)
+            expect(responses.all? { true }).to be(true)
+          end
+        end
+      end
+
       context 'when reload_on_failure is true' do
 
         let(:hosts) do
@@ -1734,7 +1738,7 @@ describe Elasticsearch::Transport::Client do
             end
 
             it 'sets the Accept-Encoding header' do
-              expect(client.transport.connections[0].connection.headers['Accept-Encoding'])
+              expect(client.transport.connections[0].connection.headers['Accept-Encoding']).to eq 'gzip'
             end
 
             it 'preserves the other headers' do
@@ -1753,7 +1757,7 @@ describe Elasticsearch::Transport::Client do
             end
 
             it 'sets the Accept-Encoding header' do
-              expect(client.transport.connections[0].connection.headers['Accept-Encoding'])
+              expect(client.transport.connections[0].connection.headers['Accept-Encoding']).to eq 'gzip'
             end
 
             it 'preserves the other headers' do
@@ -1772,7 +1776,7 @@ describe Elasticsearch::Transport::Client do
             end
 
             it 'sets the Accept-Encoding header' do
-              expect(client.transport.connections[0].connection.headers['Accept-Encoding'])
+              expect(client.transport.connections[0].connection.headers['Accept-Encoding']).to eq 'gzip'
             end
 
             it 'preserves the other headers' do
@@ -1791,7 +1795,7 @@ describe Elasticsearch::Transport::Client do
             end
 
             it 'sets the Accept-Encoding header' do
-              expect(client.transport.connections[0].connection.headers['Accept-Encoding'])
+              expect(client.transport.connections[0].connection.headers['Accept-Encoding']).to eq 'gzip'
             end
 
             it 'preserves the other headers' do
@@ -1810,7 +1814,7 @@ describe Elasticsearch::Transport::Client do
             end
 
             it 'sets the Accept-Encoding header' do
-              expect(client.transport.connections[0].connection.headers['Accept-Encoding'])
+              expect(client.transport.connections[0].connection.headers['Accept-Encoding']).to eq 'gzip'
             end
 
             it 'preserves the other headers' do
@@ -1821,11 +1825,12 @@ describe Elasticsearch::Transport::Client do
       end
 
       context 'when using Curb as the transport', unless: jruby? do
-
         let(:client) do
-          described_class.new(hosts: ELASTICSEARCH_HOSTS,
-                              compression: true,
-                              transport_class: Elasticsearch::Transport::Transport::HTTP::Curb)
+          described_class.new(
+            hosts: ELASTICSEARCH_HOSTS,
+            compression: true,
+            transport_class: Elasticsearch::Transport::Transport::HTTP::Curb
+          )
         end
 
         it 'compresses the request and decompresses the response' do
@@ -1833,7 +1838,7 @@ describe Elasticsearch::Transport::Client do
         end
 
         it 'sets the Accept-Encoding header' do
-          expect(client.transport.connections[0].connection.headers['Accept-Encoding'])
+          expect(client.transport.connections[0].connection.headers['Accept-Encoding']).to eq 'gzip'
         end
 
         it 'preserves the other headers' do
@@ -1842,7 +1847,6 @@ describe Elasticsearch::Transport::Client do
       end
 
       context 'when using Manticore as the transport', if: jruby? do
-
         let(:client) do
           described_class.new(hosts: ELASTICSEARCH_HOSTS,
                               compression: true,
@@ -1856,9 +1860,7 @@ describe Elasticsearch::Transport::Client do
     end
 
     describe '#perform_request' do
-
       context 'when a request is made' do
-
         before do
           client.perform_request('DELETE', '_all')
           client.perform_request('DELETE', 'myindex') rescue
@@ -1881,7 +1883,6 @@ describe Elasticsearch::Transport::Client do
       end
 
       context 'when an invalid url is specified' do
-
         it 'raises an exception' do
           expect {
             client.perform_request('GET', 'myindex/mydoc/1?routing=FOOBARBAZ')
@@ -1890,7 +1891,6 @@ describe Elasticsearch::Transport::Client do
       end
 
       context 'when the \'ignore\' parameter is specified' do
-
         let(:response) do
           client.perform_request('PUT', '_foobar', ignore: 400)
         end
@@ -1906,7 +1906,6 @@ describe Elasticsearch::Transport::Client do
       end
 
       context 'when request headers are specified' do
-
         let(:response) do
           client.perform_request('GET', '/', {}, nil, { 'Content-Type' => 'application/yaml' })
         end
@@ -1917,9 +1916,7 @@ describe Elasticsearch::Transport::Client do
       end
 
       describe 'selector' do
-
         context 'when the round-robin selector is used' do
-
           let(:nodes) do
             3.times.collect do
               client.perform_request('GET', '_nodes/_local').body['nodes'].to_a[0][1]['name']
@@ -1927,7 +1924,7 @@ describe Elasticsearch::Transport::Client do
           end
 
           let(:node_names) do
-            client.nodes.stats['nodes'].collect do |name, stats|
+            client.perform_request('GET', '_nodes/stats').body('nodes').collect do |name, stats|
               stats['name']
             end
           end
@@ -1946,7 +1943,6 @@ describe Elasticsearch::Transport::Client do
       end
 
       context 'when patron is used as an adapter', unless: jruby? do
-
         before do
           require 'patron'
         end
@@ -2001,4 +1997,76 @@ describe Elasticsearch::Transport::Client do
       end
     end
   end
+
+  context 'CA Fingerprinting' do
+    context 'when setting a ca_fingerprint' do
+      after do
+        File.delete('./certificate.crt')
+        File.delete('./certificate.key')
+      end
+
+      let(:certificate) do
+        system(
+          'openssl req -new -newkey rsa:4096 -days 3650 -nodes -x509 -subj "/C=BE/O=Test/CN=Test"' \
+          ' -keyout certificate.key -out certificate.crt',
+          err: File::NULL
+        )
+        OpenSSL::X509::Certificate.new File.read('./certificate.crt')
+      end
+
+      let(:client) do
+        Elasticsearch::Transport::Client.new(
+          host: 'https://elastic:changeme@localhost:9200',
+          ca_fingerprint: OpenSSL::Digest::SHA256.hexdigest(certificate.to_der)
+        )
+      end
+
+      it 'validates CA fingerprints on perform request' do
+        expect(client.transport.connections.connections.map(&:verified).uniq).to eq [false]
+        allow(client.transport).to receive(:perform_request) { 'Hello' }
+
+        server = double('server').as_null_object
+        allow(TCPSocket).to receive(:new) { server }
+        socket = double('socket')
+        allow(OpenSSL::SSL::SSLSocket).to receive(:new) { socket }
+        allow(socket).to receive(:connect) { nil }
+        allow(socket).to receive(:peer_cert_chain) { [certificate] }
+
+        response = client.perform_request('GET', '/')
+        expect(client.transport.connections.connections.map(&:verified).uniq).to eq [true]
+        expect(response).to eq 'Hello'
+      end
+    end
+
+    context 'when using an http host' do
+      let(:client) do
+        Elasticsearch::Transport::Client.new(
+          host: 'http://elastic:changeme@localhost:9200',
+          ca_fingerprint: 'test'
+        )
+      end
+
+      it 'raises an error' do
+        expect do
+          client.perform_request('GET', '/')
+        end.to raise_exception(Elasticsearch::Transport::Transport::Error)
+      end
+    end
+
+    context 'when not setting a ca_fingerprint' do
+      let(:client) do
+        Elasticsearch::Transport::Client.new(
+          host: 'http://elastic:changeme@localhost:9200'
+        )
+      end
+
+      it 'has unvalidated connections' do
+        allow(client).to receive(:validate_ca_fingerprints) { nil }
+        allow(client.transport).to receive(:perform_request) { nil }
+
+        client.perform_request('GET', '/')
+        expect(client).to_not have_received(:validate_ca_fingerprints)
+      end
+    end
+  end
 end

data/spec/elasticsearch/transport/http/curb_spec.rb

@@ -0,0 +1,126 @@
+# 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.
+
+unless defined?(JRUBY_VERSION)
+  require_relative '../../../spec_helper'
+
+  describe Elasticsearch::Transport::Transport::HTTP::Curb do
+    let(:client) do
+      Elasticsearch::Transport::Client.new(transport_class: described_class)
+    end
+
+    describe '#perform_request' do
+      subject(:perform_request) { client.perform_request(*args) }
+      let(:args) do
+        ['POST', '/', {}, body, headers]
+      end
+      let(:body) { '{"foo":"bar"}' }
+      let(:headers) { { 'Content-Type' => 'application/x-ndjson' } }
+
+      before do
+        allow_any_instance_of(Curl::Easy).to receive(:http).and_return(true)
+      end
+
+      it 'convert body to json' do
+        expect(client.transport).to receive(:__convert_to_json).with(body)
+        perform_request
+      end
+
+      it 'call compress_request' do
+        expect(client.transport).to receive(:compress_request).with(body, headers)
+        perform_request
+      end
+
+      it 'return response' do
+        expect(perform_request).to be_kind_of(Elasticsearch::Transport::Transport::Response)
+      end
+
+      it 'put body' do
+        expect(client.transport.connections.first.connection).to receive('put_data=').with(body)
+        perform_request
+      end
+
+      context 'when body nil' do
+        let(:body) { nil }
+
+        it 'convert body to json' do
+          expect(client.transport).not_to receive(:__convert_to_json)
+          perform_request
+        end
+
+        it 'call compress_request' do
+          expect(client.transport).to receive(:compress_request).with(body, headers)
+          perform_request
+        end
+
+        it 'put body' do
+          expect(client.transport.connections.first.connection).not_to receive('put_data=')
+          perform_request
+        end
+      end
+
+      context 'when body is hash' do
+        let(:body) { { foo: 'bar' } }
+        let(:body_string) { '{"foo":"bar"}' }
+
+        it 'convert body to json' do
+          expect(client.transport).to receive(:__convert_to_json).with(body)
+          perform_request
+        end
+
+        it 'call compress_request' do
+          expect(client.transport).to receive(:compress_request).with(body_string, headers)
+          perform_request
+        end
+
+        it 'put body' do
+          expect(client.transport.connections.first.connection).to receive('put_data=').with(body_string)
+          perform_request
+        end
+      end
+
+      context 'when compression enabled' do
+        let(:client) do
+          Elasticsearch::Transport::Client.new(transport_class: described_class, compression: true)
+        end
+        let(:body_string) { '{"foo":"bar"}' }
+        let(:compressed_body) do
+          gzip = Zlib::GzipWriter.new(StringIO.new)
+          gzip << body_string
+          gzip.close.string
+        end
+
+        before { allow(client.transport).to receive(:decompress_response).and_return('') }
+
+        it 'put compressed body' do
+          expect(client.transport.connections.first.connection).to receive('put_data=').with(compressed_body)
+          perform_request
+        end
+
+        it 'set Content-Encoding header' do
+          perform_request
+          expect(client.transport.connections.first.connection.headers).to include('Content-Encoding')
+        end
+
+        it 'set Content-Encoding to gzip' do
+          perform_request
+          expect(client.transport.connections.first.connection.headers['Content-Encoding']).to eql('gzip')
+        end
+      end
+    end
+  end
+end