opensearch-transport 1.0.0

data/spec/opensearch/transport/sniffer_spec.rb

@@ -0,0 +1,284 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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 OpenSearch::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" => "opensearch_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
+
+      context 'when the address is IPv6' do
+        let(:publish_address) do
+          'example.com/[::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
+    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,99 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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 'opensearch-transport'
+require 'logger'
+require 'ansi/code'
+require 'hashie/mash'
+if defined?(JRUBY_VERSION)
+  require 'opensearch/transport/transport/http/manticore'
+  require 'pry-nav'
+else
+  require 'pry-byebug'
+  require 'opensearch/transport/transport/http/curb'
+  require 'curb'
+end
+
+# The hosts to use for creating a opensearch client.
+#
+# @since 7.0.0
+OPENSEARCH_HOSTS = if (hosts = ENV['TEST_OPENSEARCH_SERVER'] || ENV['OPENSEARCH_HOSTS'])
+                        hosts.split(',').map do |host|
+                          /(http\:\/\/)?(\S+)/.match(host)[2]
+                        end
+                      else
+                        ['localhost:9200']
+                      end.freeze
+
+TEST_HOST, TEST_PORT = OPENSEARCH_HOSTS.first.split(':') if OPENSEARCH_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_stats = default_client.perform_request('GET', '_nodes/stats').body
+  $node_names ||= node_stats['nodes'].collect do |name, stats|
+    stats['name']
+  end
+end
+
+# The default client.
+#
+# @return [ OpenSearch::Client ] The default client.
+#
+def default_client
+  $client ||= OpenSearch::Client.new(hosts: OPENSEARCH_HOSTS)
+end
+
+module Config
+  def self.included(context)
+    # Get the hosts to use to connect an opensearch client.
+    #
+    # @since 7.0.0
+    context.let(:hosts) { OPENSEARCH_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,108 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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 OpenSearch::Transport::ClientIntegrationTest < Minitest::Test
+  context "Transport" do
+    setup do
+      @host, @port = OPENSEARCH_HOSTS.first.split(':')
+      begin; Object.send(:remove_const, :Patron);   rescue NameError; end
+    end
+
+    should "allow to customize the Faraday adapter to Typhoeus" do
+      require 'typhoeus'
+      require 'typhoeus/adapters/faraday'
+
+      transport = OpenSearch::Transport::Transport::HTTP::Faraday.new \
+        :hosts => [ { host: @host, port: @port } ] do |f|
+          f.response :logger
+          f.adapter  :typhoeus
+        end
+
+      client = OpenSearch::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 = OpenSearch::Transport::Transport::HTTP::Faraday.new \
+                                                                       :hosts => [ { host: @host, port: @port } ] do |f|
+        f.response :logger
+        f.adapter  :net_http_persistent
+      end
+
+      client = OpenSearch::Transport::Client.new transport: transport
+      client.perform_request 'GET', ''
+    end
+
+    should "allow to define connection parameters and pass them" do
+      transport = OpenSearch::Transport::Transport::HTTP::Faraday.new \
+                    :hosts => [ { host: @host, port: @port } ],
+                    :options => { :transport_options => {
+                                    :params => { :format => 'yaml' }
+                                  }
+                                }
+
+      client = OpenSearch::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 'opensearch/transport/transport/http/curb'
+
+      transport = OpenSearch::Transport::Transport::HTTP::Curb.new \
+        :hosts => [ { host: @host, port: @port } ] do |curl|
+          curl.verbose = true
+        end
+
+      client = OpenSearch::Transport::Client.new transport: transport
+      client.perform_request 'GET', ''
+    end unless JRUBY
+
+    should "deserialize JSON responses in the Curb client" do
+      require 'curb'
+      require 'opensearch/transport/transport/http/curb'
+
+      transport = OpenSearch::Transport::Transport::HTTP::Curb.new \
+        :hosts => [ { host: @host, port: @port } ] do |curl|
+          curl.verbose = true
+        end
+
+      client = OpenSearch::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,141 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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 OpenSearch::Transport::ClientProfilingTest < OpenSearch::Test::ProfilingTest
+  context "OpenSearch client benchmark" do
+    setup do
+      @port = (ENV['TEST_CLUSTER_PORT'] || 9250).to_i
+      client = OpenSearch::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 = OpenSearch::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 = OpenSearch::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 = OpenSearch::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 'opensearch/transport/transport/http/curb'
+        @client = OpenSearch::Client.new host: "localhost:#{@port}",
+                                            transport_class: OpenSearch::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 = OpenSearch::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 = OpenSearch::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