elastic-transport 8.0.0.pre1

data/spec/spec_helper.rb

@@ -0,0 +1,90 @@
+# 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.
+if ENV['COVERAGE'] && ENV['CI'].nil?
+  require 'simplecov'
+  SimpleCov.start { add_filter %r{^/test|spec/} }
+end
+
+require 'elastic-transport'
+require 'logger'
+require 'ansi/code'
+require 'hashie/mash'
+if defined?(JRUBY_VERSION)
+  require 'elastic/transport/transport/http/manticore'
+  require 'pry-nav'
+else
+  require 'pry-byebug'
+  require 'elastic/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
+                      else
+                        ['localhost:9200']
+                      end.freeze
+
+TEST_HOST, TEST_PORT = ELASTICSEARCH_HOSTS.first.split(':') if ELASTICSEARCH_HOSTS
+
+# 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.perform_request('GET', '_nodes/stats').body['nodes'].collect do |name, stats|
+    stats['name']
+  end
+end
+
+# The default client.
+#
+# @return [ Elastic::Transport::Client ] The default client.
+#
+# @since 7.0.0
+def default_client
+  $client ||= Elastic::Transport::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

@@ -0,0 +1,98 @@
+# 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 'test_helper'
+
+class Elastic::Transport::ClientIntegrationTest < Minitest::Test
+  context "Transport" do
+    setup do
+      begin; Object.send(:remove_const, :Patron);   rescue NameError; end
+      uri = URI(HOST)
+      @host = {
+        host: uri.host,
+        port: uri.port,
+        user: uri.user,
+        password: uri.password
+      }
+    end
+
+    should "allow to customize the Faraday adapter to Typhoeus" do
+      require 'typhoeus'
+      require 'typhoeus/adapters/faraday'
+
+      transport = Elastic::Transport::Transport::HTTP::Faraday.new(hosts: [@host]) do |f|
+        f.response :logger
+        f.adapter  :typhoeus
+      end
+
+      client = Elastic::Transport::Client.new(transport: transport)
+      client.perform_request 'GET', ''
+    end unless jruby?
+
+    should "allow to customize the Faraday adapter to NetHttpPersistent" do
+      require 'net/http/persistent'
+
+      transport = Elastic::Transport::Transport::HTTP::Faraday.new(hosts: [@host]) do |f|
+        f.response :logger
+        f.adapter  :net_http_persistent
+      end
+
+      client = Elastic::Transport::Client.new(transport: transport)
+      client.perform_request 'GET', ''
+    end
+
+    should "allow to define connection parameters and pass them" do
+      transport = Elastic::Transport::Transport::HTTP::Faraday.new(
+        hosts: [@host],
+        options: { transport_options: { params: { format: 'yaml' } } }
+      )
+
+      client = Elastic::Transport::Client.new transport: transport
+      response = client.perform_request 'GET', ''
+
+      assert response.body.start_with?("---\n"), "Response body should be YAML: #{response.body.inspect}"
+    end
+
+    should "use the Curb client" do
+      require 'curb'
+      require 'elastic/transport/transport/http/curb'
+
+      transport = Elastic::Transport::Transport::HTTP::Curb.new(hosts: [@host]) do |curl|
+        curl.verbose = true
+      end
+
+      client = Elastic::Transport::Client.new(transport: transport)
+      client.perform_request 'GET', ''
+    end unless JRUBY
+
+    should "deserialize JSON responses in the Curb client" do
+      require 'curb'
+      require 'elastic/transport/transport/http/curb'
+
+      transport = Elastic::Transport::Transport::HTTP::Curb.new(hosts: [@host]) do |curl|
+        curl.verbose = true
+      end
+
+      client = Elastic::Transport::Client.new(transport: transport)
+      response = client.perform_request 'GET', ''
+
+      assert_respond_to(response.body, :to_hash)
+      assert_not_nil response.body['name']
+      assert_equal 'application/json', response.headers['content-type']
+    end unless JRUBY
+  end
+end

data/test/profile/client_benchmark_test.rb

@@ -0,0 +1,132 @@
+# 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 'test_helper'
+
+class Elasticsearch::Transport::ClientProfilingTest < Minitest::Test
+  context "Elasticsearch client benchmark" do
+    setup do
+      @port = (ENV['TEST_CLUSTER_PORT'] || 9250).to_i
+      client = Elasticsearch::Client.new host: "localhost:#{@port}", adapter: ::Faraday.default_adapter
+      client.perform_request 'DELETE', 'ruby_test_benchmark' rescue nil
+      client.perform_request 'PUT',   'ruby_test_benchmark', {}, {settings: {index: {number_of_shards: 1, number_of_replicas: 0}}}
+      100.times do client.perform_request 'POST',   'ruby_test_benchmark_search/test', {}, {foo: 'bar'}; end
+      client.perform_request 'POST',   'ruby_test_benchmark_search/_refresh'
+    end
+    teardown do
+      client = Elasticsearch::Client.new host: "localhost:#{@port}"
+      client.perform_request 'DELETE', 'ruby_test_benchmark' rescue nil
+      client.perform_request 'DELETE', 'ruby_test_benchmark_search' rescue nil
+    end
+
+    context "with a single-node cluster and the default adapter" do
+      setup do
+        @client = Elasticsearch::Client.new hosts: "localhost:#{@port}", adapter: ::Faraday.default_adapter
+      end
+
+      measure "get the cluster info", count: 1_000 do
+        @client.perform_request 'GET', ''
+      end
+
+      measure "index a document" do
+        @client.perform_request 'POST', 'ruby_test_benchmark/test', {}, {foo: 'bar'}
+      end
+
+      measure "search" do
+        @client.perform_request 'GET', 'ruby_test_benchmark_search/test/_search', {}, {query: {match: {foo: 'bar'}}}
+      end
+    end
+
+    context "with a two-node cluster and the default adapter" do
+      setup do
+        @client = Elasticsearch::Client.new hosts: ["localhost:#{@port}", "localhost:#{@port+1}"], adapter: ::Faraday.default_adapter
+      end
+
+      measure "get the cluster info", count: 1_000 do
+        @client.perform_request 'GET', ''
+      end
+
+      measure "index a document"do
+        @client.perform_request 'POST', 'ruby_test_benchmark/test', {}, {foo: 'bar'}
+      end
+
+      measure "search" do
+        @client.perform_request 'GET', 'ruby_test_benchmark_search/test/_search', {}, {query: {match: {foo: 'bar'}}}
+      end
+    end
+
+    context "with a single-node cluster and the Curb client" do
+      setup do
+        require 'curb'
+        require 'elasticsearch/transport/transport/http/curb'
+        @client = Elasticsearch::Client.new host: "localhost:#{@port}",
+                                            transport_class: Elasticsearch::Transport::Transport::HTTP::Curb
+      end
+
+      measure "get the cluster info", count: 1_000 do
+        @client.perform_request 'GET', ''
+      end
+
+      measure "index a document" do
+        @client.perform_request 'POST', 'ruby_test_benchmark/test', {}, {foo: 'bar'}
+      end
+
+      measure "search" do
+        @client.perform_request 'GET', 'ruby_test_benchmark_search/test/_search', {}, {query: {match: {foo: 'bar'}}}
+      end
+    end
+
+    context "with a single-node cluster and the Typhoeus client" do
+      setup do
+        require 'typhoeus'
+        require 'typhoeus/adapters/faraday'
+        @client = Elasticsearch::Client.new host: "localhost:#{@port}", adapter: :typhoeus
+      end
+
+      measure "get the cluster info", count: 1_000 do
+        @client.perform_request 'GET', ''
+      end
+
+      measure "index a document" do
+        @client.perform_request 'POST', 'ruby_test_benchmark/test', {}, {foo: 'bar'}
+      end
+
+      measure "search" do
+        @client.perform_request 'GET', 'ruby_test_benchmark_search/test/_search', {}, {query: {match: {foo: 'bar'}}}
+      end
+    end
+
+    context "with a single-node cluster and the Patron adapter" do
+      setup do
+        require 'patron'
+        @client = Elasticsearch::Client.new host: "localhost:#{@port}", adapter: :patron
+      end
+
+      measure "get the cluster info", count: 1_000 do
+        @client.perform_request 'GET', ''
+      end
+
+      measure "index a document" do
+        @client.perform_request 'POST', 'ruby_test_benchmark/test', {}, {foo: 'bar'}
+      end
+
+      measure "search" do
+        @client.perform_request 'GET', 'ruby_test_benchmark_search/test/_search', {}, {query: {match: {foo: 'bar'}}}
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,83 @@
+# 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.
+
+password = ENV['ELASTIC_PASSWORD'] || 'changeme'
+host = ENV['TEST_ES_SERVER'] || 'http://localhost:9200'
+raise URI::InvalidURIError unless host =~ /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
+
+uri = URI.parse(host)
+HOST = "http://elastic:#{password}@#{uri.host}:#{uri.port}".freeze
+
+JRUBY = defined?(JRUBY_VERSION)
+
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start { add_filter %r{^/test/} }
+end
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'shoulda/context'
+require 'mocha/minitest'
+require 'ansi/code'
+
+require 'require-prof' if ENV["REQUIRE_PROF"]
+require 'elastic-transport'
+require 'logger'
+
+require 'hashie'
+
+RequireProf.print_timing_infos if ENV["REQUIRE_PROF"]
+
+class FixedMinitestSpecReporter < Minitest::Reporters::SpecReporter
+  def before_test(test)
+    last_test = tests.last
+
+    before_suite(test.class) unless last_test
+
+    if last_test && last_test.klass.to_s != test.class.to_s
+      after_suite(last_test.class) if last_test
+      before_suite(test.class)
+    end
+  end
+end
+
+module Minitest
+  class Test
+    def assert_nothing_raised(*args)
+      begin
+        yield
+      rescue RuntimeError => e
+        raise MiniTest::Assertion, "Exception raised:\n<#{e.class}>", e.backtrace
+      end
+      true
+    end
+
+    def assert_not_nil(object, msg=nil)
+      msg = message(msg) { "<#{object.inspect}> expected to not be nil" }
+      assert !object.nil?, msg
+    end
+
+    def assert_block(*msgs)
+      assert yield, *msgs
+    end
+
+    alias :assert_raise :assert_raises
+  end
+end
+
+Minitest::Reporters.use! FixedMinitestSpecReporter.new

data/test/unit/connection_test.rb

@@ -0,0 +1,135 @@
+# 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 'test_helper'
+
+class Elastic::Transport::Transport::Connections::ConnectionTest < Minitest::Test
+  include Elastic::Transport::Transport::Connections
+
+  context "Connection" do
+    should "be initialized with :host, :connection, and :options" do
+      c = Connection.new :host => 'x', :connection => 'y', :options => {}
+      assert_equal 'x', c.host
+      assert_equal 'y', c.connection
+      assert_instance_of Hash, c.options
+    end
+
+    should "return full path" do
+      c = Connection.new
+      assert_equal '_search', c.full_path('_search')
+      assert_equal '_search', c.full_path('_search', {})
+      assert_equal '_search?foo=bar', c.full_path('_search', {:foo => 'bar'})
+      assert_equal '_search?foo=bar+bam', c.full_path('_search', {:foo => 'bar bam'})
+    end
+
+    should "return full url" do
+      c = Connection.new :host => { :protocol => 'http', :host => 'localhost', :port => '9200' }
+      assert_equal 'http://localhost:9200/_search?foo=bar', c.full_url('_search', {:foo => 'bar'})
+    end
+
+    should "return full url with credentials" do
+      c = Connection.new :host => { :protocol => 'http', :user => 'U', :password => 'P', :host => 'localhost', :port => '9200' }
+      assert_equal 'http://U:P@localhost:9200/_search?foo=bar', c.full_url('_search', {:foo => 'bar'})
+    end
+
+    should "return full url with escaped credentials" do
+      c = Connection.new :host => { :protocol => 'http', :user => 'U$$$', :password => 'P^^^', :host => 'localhost', :port => '9200' }
+      assert_equal 'http://U%24%24%24:P%5E%5E%5E@localhost:9200/_search?foo=bar', c.full_url('_search', {:foo => 'bar'})
+    end
+
+    should "return full url with path" do
+      c = Connection.new :host => { :protocol => 'http', :host => 'localhost', :port => '9200', :path => '/foo' }
+      assert_equal 'http://localhost:9200/foo/_search?foo=bar', c.full_url('_search', {:foo => 'bar'})
+    end
+
+    should "return right full url with path when path starts with /" do
+      c = Connection.new :host => { :protocol => 'http', :host => 'localhost', :port => '9200', :path => '/foo' }
+      assert_equal 'http://localhost:9200/foo/_search?foo=bar', c.full_url('/_search', {:foo => 'bar'})
+    end
+
+    should "have a string representation" do
+      c = Connection.new :host => 'x'
+      assert_match(/host: x/, c.to_s)
+      assert_match(/alive/,   c.to_s)
+    end
+
+    should "not be dead by default" do
+      c = Connection.new
+      assert ! c.dead?
+    end
+
+    should "be dead when marked" do
+      c = Connection.new.dead!
+      assert c.dead?
+      assert_equal 1, c.failures
+      assert_in_delta c.dead_since, Time.now, 1
+    end
+
+    should "be alive when marked" do
+      c = Connection.new.dead!
+      assert c.dead?
+      assert_equal 1, c.failures
+      assert_in_delta c.dead_since, Time.now, 1
+
+      c.alive!
+      assert ! c.dead?
+      assert_equal 1, c.failures
+    end
+
+    should "be healthy when marked" do
+      c = Connection.new.dead!
+      assert c.dead?
+      assert_equal 1, c.failures
+      assert_in_delta c.dead_since, Time.now, 1
+
+      c.healthy!
+      assert ! c.dead?
+      assert_equal 0, c.failures
+    end
+
+    should "be resurrected if timeout passed" do
+      c = Connection.new.dead!
+
+      now = Time.now + 60
+      Time.stubs(:now).returns(now)
+
+      assert   c.resurrect!, c.inspect
+      assert ! c.dead?,      c.inspect
+    end
+
+    should "be resurrected if timeout passed for multiple failures" do
+      c = Connection.new.dead!.dead!
+
+      now = Time.now + 60*2
+      Time.stubs(:now).returns(now)
+
+      assert   c.resurrect!, c.inspect
+      assert ! c.dead?,      c.inspect
+    end
+
+    should "implement the equality operator" do
+      c1 = Connection.new(:host => { :protocol => 'http', :host => 'foo', :port => 123 })
+      c2 = Connection.new(:host => { :protocol => 'http', :host => 'foo', :port => 123 })
+      c3 = Connection.new(:host => { :protocol => 'http', :host => 'foo', :port => 456 })
+
+      assert c1 == c2, "Connection #{c1} should be equal to #{c2}"
+      assert c2 != c3, "Connection #{c2} should NOT be equal to #{c3}"
+    end
+
+  end
+
+end