elasticsearch-transport 5.0.5 → 6.8.3

data/spec/elasticsearch/transport/meta_header_spec.rb

@@ -0,0 +1,214 @@
+# 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::Client do
+  context 'meta-header' do
+    let(:subject) { client.transport.connections.first.connection.headers }
+    let(:client) { described_class.new }
+    let(:regexp) { /^[a-z]{1,}=[a-z0-9.\-]{1,}(?:,[a-z]{1,}=[a-z0-9._\-]+)*$/ }
+    let(:adapter) { :net_http }
+    let(:adapter_code) { "nh=#{defined?(Net::HTTP::VERSION) ? Net::HTTP::VERSION : Net::HTTP::HTTPVersion}" }
+    let(:meta_header) do
+      if jruby?
+        "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elasticsearch::Transport::VERSION},jv=#{ENV_JAVA['java.version']},jr=#{JRUBY_VERSION},fd=#{Faraday::VERSION},#{adapter_code}"
+      else
+        "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elasticsearch::Transport::VERSION},fd=#{Faraday::VERSION},#{adapter_code}"
+      end
+    end
+
+    context 'client_meta_version_' do
+      let(:version) { ['7.1.0-alpha', '7.11.0.pre.1', '8.0.0-beta', '8.0.0.beta.2']}
+
+      it 'converts the version to X.X.Xp' do
+        expect(client.send(:client_meta_version, '7.0.0-alpha')).to eq('7.0.0p')
+        expect(client.send(:client_meta_version, '7.11.0.pre.1')).to eq('7.11.0p')
+        expect(client.send(:client_meta_version, '8.1.0-beta')).to eq('8.1.0p')
+        expect(client.send(:client_meta_version, '8.0.0.beta.2')).to eq('8.0.0p')
+        expect(client.send(:client_meta_version, '12.16.4.pre')).to eq('12.16.4p')
+      end
+    end
+
+    # We are testing this method in the previous block, so now using it inside the test to make the
+    # Elasticsearch version in the meta header string dynamic
+    def meta_version
+      client.send(:client_meta_version, Elasticsearch::VERSION)
+    end
+
+    context 'single use of meta header' do
+      let(:client) do
+        described_class.new(adapter: adapter).tap do |klient|
+          allow(klient).to receive(:__build_connections)
+        end
+      end
+
+      it 'x-elastic-client-header value matches regexp' do
+        expect(subject['x-elastic-client-meta']).to match(regexp)
+        expect(subject).to include('x-elastic-client-meta' => meta_header)
+      end
+    end
+
+    context 'when using user-agent headers' do
+      let(:client) do
+        transport_options = { headers: { user_agent: 'My Ruby App' } }
+        described_class.new(transport_options: transport_options, adapter: adapter).tap do |klient|
+          allow(klient).to receive(:__build_connections)
+        end
+      end
+
+      it 'is friendly to previously set headers' do
+        expect(subject).to include(user_agent: 'My Ruby App')
+        expect(subject['x-elastic-client-meta']).to match(regexp)
+        expect(subject).to include('x-elastic-client-meta' => meta_header)
+      end
+    end
+
+    context 'when using API Key' do
+      let(:client) do
+        described_class.new(api_key: 'an_api_key', adapter: adapter)
+      end
+
+      let(:authorization_header) do
+        client.transport.connections.first.connection.headers['Authorization']
+      end
+
+      it 'adds the ApiKey header to the connection' do
+        expect(authorization_header).to eq('ApiKey an_api_key')
+        expect(subject['x-elastic-client-meta']).to match(regexp)
+        expect(subject).to include('x-elastic-client-meta' => meta_header)
+      end
+    end
+
+    context 'adapters' do
+      let(:meta_header) do
+        if jruby?
+          "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elasticsearch::Transport::VERSION},jv=#{ENV_JAVA['java.version']},jr=#{JRUBY_VERSION},fd=#{Faraday::VERSION}"
+        else
+          "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elasticsearch::Transport::VERSION},fd=#{Faraday::VERSION}"
+        end
+      end
+      let(:client) { described_class.new(adapter: adapter) }
+      let(:headers) { client.transport.connections.first.connection.headers }
+
+      context 'using net/http/persistent' do
+        let(:adapter) { :net_http_persistent }
+
+        it 'sets adapter in the meta header' do
+          require 'net/http/persistent'
+          expect(headers['x-elastic-client-meta']).to match(regexp)
+          meta = "#{meta_header},np=#{Net::HTTP::Persistent::VERSION}"
+          expect(headers).to include('x-elastic-client-meta' => meta)
+        end
+      end
+
+      context 'using httpclient' do
+        let(:adapter) { :httpclient }
+
+        it 'sets adapter in the meta header' do
+          require 'httpclient'
+          expect(headers['x-elastic-client-meta']).to match(regexp)
+          meta = "#{meta_header},hc=#{HTTPClient::VERSION}"
+          expect(headers).to include('x-elastic-client-meta' => meta)
+        end
+      end
+
+      context 'using typhoeus' do
+        let(:adapter) { :typhoeus }
+
+        it 'sets adapter in the meta header' do
+          require 'typhoeus'
+          expect(headers['x-elastic-client-meta']).to match(regexp)
+          meta = "#{meta_header},ty=#{Typhoeus::VERSION}"
+          expect(headers).to include('x-elastic-client-meta' => meta)
+        end
+      end
+
+      unless defined?(JRUBY_VERSION)
+        let(:adapter) { :patron }
+
+        context 'using patron' do
+          it 'sets adapter in the meta header' do
+            require 'patron'
+            expect(headers['x-elastic-client-meta']).to match(regexp)
+            meta = "#{meta_header},pt=#{Patron::VERSION}"
+            expect(headers).to include('x-elastic-client-meta' => meta)
+          end
+        end
+      end
+    end
+
+    if defined?(JRUBY_VERSION)
+      context 'when using manticore' do
+        let(:client) do
+          Elasticsearch::Client.new(transport_class: Elasticsearch::Transport::Transport::HTTP::Manticore)
+        end
+        let(:subject) { client.transport.connections.first.connection.instance_variable_get("@options")[:headers]}
+
+        it 'sets manticore in the metaheader' do
+          expect(subject['x-elastic-client-meta']).to match(regexp)
+          expect(subject['x-elastic-client-meta']).to match(/mc=[0-9.]+/)
+        end
+      end
+    else
+      context 'when using curb' do
+        let(:client) do
+          Elasticsearch::Client.new(transport_class: Elasticsearch::Transport::Transport::HTTP::Curb)
+        end
+
+        it 'sets curb in the metaheader' do
+          expect(subject['x-elastic-client-meta']).to match(regexp)
+          expect(subject['x-elastic-client-meta']).to match(/cl=[0-9.]+/)
+        end
+      end
+    end
+
+    context 'when using custom transport implementation' do
+      class MyTransport
+        include Elasticsearch::Transport::Transport::Base
+        def initialize(args); end
+      end
+      let(:client) { Elasticsearch::Client.new(transport_class: MyTransport) }
+      let(:subject){ client.instance_variable_get("@arguments")[:transport_options][:headers] }
+      let(:meta_header) do
+        if jruby?
+          "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elasticsearch::Transport::VERSION},jv=#{ENV_JAVA['java.version']},jr=#{JRUBY_VERSION}"
+        else
+          "es=#{meta_version},rb=#{RUBY_VERSION},t=#{Elasticsearch::Transport::VERSION}"
+        end
+      end
+
+      it 'doesnae set any info about the implementation in the metaheader' do
+        expect(subject['x-elastic-client-meta']).to match(regexp)
+        expect(subject).to include('x-elastic-client-meta' => meta_header)
+      end
+    end
+
+    context 'when using a different service version' do
+      before do
+        stub_const("Elastic::META_HEADER_SERVICE_VERSION", [:ent, '8.0.0'])
+      end
+
+      let(:client) { Elasticsearch::Client.new }
+
+      it 'sets the service version in the metaheader' do
+        expect(subject['x-elastic-client-meta']).to match(regexp)
+        expect(subject['x-elastic-client-meta']).to start_with('ent=8.0.0')
+      end
+    end
+  end
+end

data/spec/elasticsearch/transport/sniffer_spec.rb

@@ -0,0 +1,269 @@
+# 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::Sniffer do
+
+  let(:transport) do
+    double('transport').tap do |t|
+      allow(t).to receive(:perform_request).and_return(response)
+      allow(t).to receive(:options).and_return(sniffer_timeout: 2)
+    end
+  end
+
+  let(:sniffer) do
+    described_class.new(transport)
+  end
+
+  let(:response) do
+    double('response').tap do |r|
+      allow(r).to receive(:body).and_return(raw_response)
+    end
+  end
+
+  let(:raw_response) do
+    { 'nodes' => { 'n1' => { 'http' => { 'publish_address' => publish_address } } } }
+  end
+
+  let(:publish_address) do
+    '127.0.0.1:9250'
+  end
+
+  describe '#initialize' do
+
+    it 'has a transport instance' do
+      expect(sniffer.transport).to be(transport)
+    end
+
+    it 'inherits the sniffer timeout from the transport object' do
+      expect(sniffer.timeout).to eq(2)
+    end
+  end
+
+  describe '#timeout' do
+
+    let(:sniffer) do
+      described_class.new(double('transport', options: {}))
+    end
+
+    before do
+      sniffer.timeout = 3
+    end
+
+    it 'allows the timeout to be configured' do
+      expect(sniffer.timeout).to eq(3)
+    end
+  end
+
+  describe '#hosts' do
+
+    let(:hosts) do
+      sniffer.hosts
+    end
+
+    context 'when the entire response is parsed' do
+
+      let(:raw_response) do
+        {
+          "cluster_name" => "elasticsearch_test",
+          "nodes" => {
+              "N1" => {
+                "name" => "Node 1",
+                "transport_address" => "127.0.0.1:9300",
+                "host" => "testhost1",
+                "ip"   => "127.0.0.1",
+                "version" => "7.0.0",
+                "roles" => [
+                  "master",
+                  "data",
+                  "ingest"
+                ],
+                "attributes" => {
+                  "testattr" => "test"
+                },
+                "http" => {
+                  "bound_address" => [
+                    "[fe80::1]:9250",
+                    "[::1]:9250",
+                    "127.0.0.1:9250"
+                  ],
+                "publish_address" => "127.0.0.1:9250",
+                "max_content_length_in_bytes" => 104857600
+                }
+              }
+          }
+        }
+      end
+
+      it 'parses the id' do
+        expect(sniffer.hosts[0][:id]).to eq('N1')
+      end
+
+      it 'parses the name' do
+        expect(sniffer.hosts[0][:name]).to eq('Node 1')
+      end
+
+      it 'parses the version' do
+        expect(sniffer.hosts[0][:version]).to eq('7.0.0')
+      end
+
+      it 'parses the host' do
+        expect(sniffer.hosts[0][:host]).to eq('127.0.0.1')
+      end
+
+      it 'parses the port' do
+        expect(sniffer.hosts[0][:port]).to eq('9250')
+      end
+
+      it 'parses the roles' do
+        expect(sniffer.hosts[0][:roles]).to eq(['master',
+                                                'data',
+                                                'ingest'])
+      end
+
+      it 'parses the attributes' do
+        expect(sniffer.hosts[0][:attributes]).to eq('testattr' => 'test')
+      end
+    end
+
+    context 'when the transport protocol does not match' do
+
+      let(:raw_response) do
+        { 'nodes' => { 'n1' => { 'foo' => { 'publish_address' => '127.0.0.1:9250' } } } }
+      end
+
+      it 'does not parse the addresses' do
+        expect(hosts).to eq([])
+      end
+    end
+
+    context 'when a list of nodes is returned' do
+
+      let(:raw_response) do
+        { 'nodes' => { 'n1' => { 'http' => { 'publish_address' => '127.0.0.1:9250' } },
+                       'n2' => { 'http' => { 'publish_address' => '127.0.0.1:9251' } } } }
+      end
+
+      it 'parses the response' do
+        expect(hosts.size).to eq(2)
+      end
+
+      it 'correctly parses the hosts' do
+        expect(hosts[0][:host]).to eq('127.0.0.1')
+        expect(hosts[1][:host]).to eq('127.0.0.1')
+      end
+
+      it 'correctly parses the ports' do
+        expect(hosts[0][:port]).to eq('9250')
+        expect(hosts[1][:port]).to eq('9251')
+      end
+    end
+
+    context 'when the host and port are an ip address and port' do
+
+      it 'parses the response' do
+        expect(hosts.size).to eq(1)
+      end
+
+      it 'correctly parses the host' do
+        expect(hosts[0][:host]).to eq('127.0.0.1')
+      end
+
+      it 'correctly parses the port' do
+        expect(hosts[0][:port]).to eq('9250')
+      end
+    end
+
+    context 'when the host and port are a hostname and port' do
+
+      let(:publish_address) do
+        'testhost1.com:9250'
+      end
+
+      let(:hosts) do
+        sniffer.hosts
+      end
+
+      it 'parses the response' do
+        expect(hosts.size).to eq(1)
+      end
+
+      it 'correctly parses the host' do
+        expect(hosts[0][:host]).to eq('testhost1.com')
+      end
+
+      it 'correctly parses the port' do
+        expect(hosts[0][:port]).to eq('9250')
+      end
+    end
+
+    context 'when the host and port are in the format: hostname/ip:port' do
+
+      let(:publish_address) do
+        'example.com/127.0.0.1:9250'
+      end
+
+      it 'parses the response' do
+        expect(hosts.size).to eq(1)
+      end
+
+      it 'uses the hostname' do
+        expect(hosts[0][:host]).to eq('example.com')
+      end
+
+      it 'correctly parses the port' do
+        expect(hosts[0][:port]).to eq('9250')
+      end
+    end
+
+    context 'when the address is IPv6' do
+
+      let(:publish_address) do
+        '[::1]:9250'
+      end
+
+      it 'parses the response' do
+        expect(hosts.size).to eq(1)
+      end
+
+      it 'correctly parses the host' do
+        expect(hosts[0][:host]).to eq('::1')
+      end
+
+      it 'correctly parses the port' do
+        expect(hosts[0][:port]).to eq('9250')
+      end
+    end
+
+    context 'when the transport has :randomize_hosts option' do
+
+      let(:raw_response) do
+        { 'nodes' => { 'n1' => { 'http' => { 'publish_address' => '127.0.0.1:9250' } },
+                       'n2' => { 'http' => { 'publish_address' => '127.0.0.1:9251' } } } }
+      end
+
+      before do
+        allow(transport).to receive(:options).and_return(randomize_hosts: true)
+      end
+
+      it 'shuffles the list' do
+        expect(hosts.size).to eq(2)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,72 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
+require 'elasticsearch'
+require 'elasticsearch-transport'
+require 'logger'
+require 'ansi/code'
+require 'hashie/mash'
+require 'pry-nav'
+if defined?(JRUBY_VERSION)
+  require 'elasticsearch/transport/transport/http/manticore'
+  require 'pry-nav'
+else
+  require 'elasticsearch/transport/transport/http/curb'
+  require 'curb'
+end
+
+# The hosts to use for creating a elasticsearch client.
+#
+# @since 7.0.0
+ELASTICSEARCH_HOSTS = if hosts = ENV['TEST_ES_SERVER'] || ENV['ELASTICSEARCH_HOSTS']
+                        hosts.split(',').map do |host|
+                          /(http\:\/\/)?(\S+)/.match(host)[2]
+                        end
+                      end.freeze
+
+# Are we testing on JRuby?
+#
+# @return [ true, false ] Whether JRuby is being used.
+#
+# @since 7.0.0
+def jruby?
+  RUBY_PLATFORM =~ /\bjava\b/
+end
+
+# The names of the connected nodes.
+#
+# @return [ Array<String> ] The node names.
+#
+# @since 7.0.0
+def node_names
+  $node_names ||= default_client.nodes.stats['nodes'].collect do |name, stats|
+    stats['name']
+  end
+end
+
+# The default client.
+#
+# @return [ Elasticsearch::Client ] The default client.
+#
+# @since 7.0.0
+def default_client
+  $client ||= Elasticsearch::Client.new(hosts: ELASTICSEARCH_HOSTS)
+end
+
+module Config
+
+  def self.included(context)
+
+    # Get the hosts to use to connect an elasticsearch client.
+    #
+    # @since 7.0.0
+    context.let(:hosts) { ELASTICSEARCH_HOSTS }
+  end
+end
+
+RSpec.configure do |config|
+  config.include(Config)
+  config.formatter = 'documentation'
+  config.color = true
+end

data/test/integration/transport_test.rb

@@ -1,3 +1,7 @@
+# Licensed to Elasticsearch B.V under one or more agreements.
+# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
+# See the LICENSE file in the project root for more information
+
 require 'test_helper'
 
 class Elasticsearch::Transport::ClientIntegrationTest < Elasticsearch::Test::IntegrationTestCase
@@ -11,7 +15,7 @@ class Elasticsearch::Transport::ClientIntegrationTest < Elasticsearch::Test::Int
 
   context "Transport" do
     setup do
-      @port = (ENV['TEST_CLUSTER_PORT'] || 9250).to_i
+      @host, @port = ELASTICSEARCH_HOSTS.first.split(':')
       begin; Object.send(:remove_const, :Patron);   rescue NameError; end
     end
 
@@ -20,7 +24,7 @@ class Elasticsearch::Transport::ClientIntegrationTest < Elasticsearch::Test::Int
       require 'typhoeus/adapters/faraday'
 
       transport = Elasticsearch::Transport::Transport::HTTP::Faraday.new \
-        :hosts => [ { :host => 'localhost', :port => @port } ] do |f|
+        :hosts => [ { host: @host, port: @port } ] do |f|
           f.response :logger
           f.adapter  :typhoeus
         end
@@ -31,7 +35,7 @@ class Elasticsearch::Transport::ClientIntegrationTest < Elasticsearch::Test::Int
 
     should "allow to define connection parameters and pass them" do
       transport = Elasticsearch::Transport::Transport::HTTP::Faraday.new \
-                    :hosts => [ { :host => 'localhost', :port => @port } ],
+                    :hosts => [ { host: @host, port: @port } ],
                     :options => { :transport_options => {
                                     :params => { :format => 'yaml' }
                                   }
@@ -48,7 +52,7 @@ class Elasticsearch::Transport::ClientIntegrationTest < Elasticsearch::Test::Int
       require 'elasticsearch/transport/transport/http/curb'
 
       transport = Elasticsearch::Transport::Transport::HTTP::Curb.new \
-        :hosts => [ { :host => 'localhost', :port => @port } ] do |curl|
+        :hosts => [ { host: @host, port: @port } ]  do |curl|
           curl.verbose = true
         end
 
@@ -61,7 +65,7 @@ class Elasticsearch::Transport::ClientIntegrationTest < Elasticsearch::Test::Int
       require 'elasticsearch/transport/transport/http/curb'
 
       transport = Elasticsearch::Transport::Transport::HTTP::Curb.new \
-        :hosts => [ { :host => 'localhost', :port => @port } ] do |curl|
+        :hosts => [ { host: @host, port: @port } ]  do |curl|
           curl.verbose = true
         end