opensearch-ruby 2.1.0 → 3.0.0

data/test/transport/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_relative '../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

data/test/transport/test_helper.rb

@@ -0,0 +1,97 @@
+# 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.
+
+
+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
+
+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 'opensearch'
+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
+        line = __LINE__
+        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 unless ENV['RM_INFO']

data/test/transport/unit/connection_test.rb

@@ -0,0 +1,145 @@
+# 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_relative '../test_helper'
+
+class OpenSearch::Transport::Transport::Connections::ConnectionTest < Minitest::Test
+  include OpenSearch::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

data/test/transport/unit/response_test.rb

@@ -0,0 +1,41 @@
+# 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_relative '../test_helper'
+
+class OpenSearch::Transport::Transport::ResponseTest < Minitest::Test
+  context "Response" do
+
+    should "force-encode the body into UTF" do
+      body = "Hello Encoding!".encode(Encoding::ISO_8859_1)
+      assert_equal 'ISO-8859-1', body.encoding.name
+
+      response = OpenSearch::Transport::Transport::Response.new 200, body
+      assert_equal 'UTF-8', response.body.encoding.name
+    end
+
+  end
+end

data/test/transport/unit/serializer_test.rb

@@ -0,0 +1,42 @@
+# 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_relative '../test_helper'
+
+class OpenSearch::Transport::Transport::SerializerTest < Minitest::Test
+
+  context "Serializer" do
+
+    should "use MultiJson by default" do
+      ::MultiJson.expects(:load)
+      ::MultiJson.expects(:dump)
+      OpenSearch::Transport::Transport::Serializer::MultiJson.new.load('{}')
+      OpenSearch::Transport::Transport::Serializer::MultiJson.new.dump({})
+    end
+
+  end
+
+end