opensearch-transport 1.0.0

data/opensearch-transport.gemspec

@@ -0,0 +1,92 @@
+# 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.
+
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opensearch/transport/version'
+
+signing_key_path = File.expand_path("../gem-private_key.pem")
+
+Gem::Specification.new do |s|
+  s.name          = 'opensearch-transport'
+  s.version       = OpenSearch::Transport::VERSION
+  s.authors       = ['Jayesh Hathila', 'Vamshi Vijay Nakkirtha', 'Vijayan Balasubramanian' , 'Yuvraj Jaiswal']
+  s.email         = ['jayehh@amazon.com', 'vamshin@amazon.com', 'balasvij@amazon.com', 'jaiyuvra@amazon.com']
+  s.summary       = 'Ruby client for OpenSearch.'
+  s.homepage      = 'https://opensearch.org/docs/latest/'
+  s.license       = 'Apache-2.0'
+  s.metadata = {
+    'homepage_uri' => 'https://opensearch.org/docs/latest/',
+    'source_code_uri' => 'https://github.com/opensearch-project/opensearch-ruby/tree/main/opensearch-transport',
+    'bug_tracker_uri' => 'https://github.com/opensearch-project/opensearch-ruby/issues'
+  }
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+
+  if $PROGRAM_NAME.end_with?("gem") && ARGV == ["build", __FILE__] && File.exist?(signing_key_path)
+    s.signing_key = signing_key_path
+    s.cert_chain  = ['../certs/opensearch-rubygems.pem']
+  end
+
+  s.require_paths = ['lib']
+
+  s.extra_rdoc_files  = [ 'README.md', 'LICENSE' ]
+  s.rdoc_options      = [ '--charset=UTF-8' ]
+
+  s.required_ruby_version = '>= 2.4'
+
+  s.add_dependency 'multi_json'
+  s.add_dependency 'faraday', '~> 1'
+
+  s.add_development_dependency 'ansi'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'cane'
+  s.add_development_dependency 'curb' unless defined? JRUBY_VERSION
+  s.add_development_dependency 'opensearch-ruby'
+  s.add_development_dependency 'hashie'
+  s.add_development_dependency 'httpclient'
+  s.add_development_dependency 'manticore' if defined? JRUBY_VERSION
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'minitest-reporters'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'net-http-persistent'
+  s.add_development_dependency 'patron' unless defined? JRUBY_VERSION
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake', '~> 13'
+  s.add_development_dependency 'require-prof' unless defined?(JRUBY_VERSION) || defined?(Rubinius)
+  s.add_development_dependency 'ruby-prof'    unless defined?(JRUBY_VERSION) || defined?(Rubinius)
+  s.add_development_dependency 'shoulda-context'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'test-unit', '~> 2'
+  s.add_development_dependency 'typhoeus', '~> 1.4'
+  s.add_development_dependency 'yard'
+
+  s.description = <<-DESC.gsub(/^    /, '')
+    Ruby client for OpenSearch. See the `opensearch` gem for full integration.
+  DESC
+end

data/spec/opensearch/connections/collection_spec.rb

@@ -0,0 +1,275 @@
+# 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::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: OpenSearch::Transport::Transport::Connections::Selector::Random)
+      end
+
+      it 'sets the selector' do
+        expect(collection.selector).to be_a(OpenSearch::Transport::Transport::Connections::Selector::Random)
+      end
+    end
+  end
+
+  describe '#get_connection' do
+
+    let(:collection) do
+      described_class.new(selector_class: OpenSearch::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
+        OpenSearch::Transport::Transport::Connections::Connection.new(host: { host: 'A' })
+      end
+
+      let(:connection_b) do
+        OpenSearch::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|
+          OpenSearch::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/opensearch/connections/selector_spec.rb

@@ -0,0 +1,183 @@
+# 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::Connections::Selector do
+
+  before do
+    class BackupStrategySelector
+      include OpenSearch::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 OpenSearch::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