elastomer-client 3.2.2 → 6.2.0

data/test/middleware/parse_json_test.rb

@@ -1,54 +1,62 @@
+# frozen_string_literal: true
+
 require File.expand_path("../../test_helper", __FILE__)
 
-describe Elastomer::Middleware::ParseJson do
-  let(:middleware) { Elastomer::Middleware::ParseJson.new(lambda {|env| Faraday::Response.new(env)})}
+describe ElastomerClient::Middleware::ParseJson do
+  let(:middleware) { ElastomerClient::Middleware::ParseJson.new(lambda { |env| Faraday::Response.new(env) }) }
   let(:headers) { Hash.new }
 
   def process(body, content_type = nil)
-    env = { :body => body, :response_headers => Faraday::Utils::Headers.new(headers) }
+    env = { body:, response_headers: Faraday::Utils::Headers.new(headers) }
     env[:response_headers]["content-type"] = content_type if content_type
     middleware.call(env)
   end
 
   it "doesn't change nil body" do
     response = process(nil)
+
     assert_nil response.body
   end
 
   it "nullifies empty body" do
     response = process("")
+
     assert_nil response.body
   end
 
   it "nullifies blank body" do
     response = process(" ")
+
     assert_nil response.body
   end
 
   it "parses json body with empty type" do
     response = process('{"a":1}')
+
     assert_equal({"a" => 1}, response.body)
   end
 
   it "parses json body of correct type" do
     response = process('{"a":1}', "application/json; charset=utf-8")
+
     assert_equal({"a" => 1}, response.body)
   end
 
   it "ignores json body if incorrect type" do
     response = process('{"a":1}', "application/xml; charset=utf-8")
+
     assert_equal('{"a":1}', response.body)
   end
 
   it "chokes on invalid json" do
-    assert_raises(Faraday::Error::ParsingError) { process "{!"      }
-    assert_raises(Faraday::Error::ParsingError) { process "invalid" }
+    assert_raises(Faraday::ParsingError) { process "{!"      }
+    assert_raises(Faraday::ParsingError) { process "invalid" }
 
     # surprisingly these are all valid according to MultiJson
     #
-    # assert_raises(Faraday::Error::ParsingError) { process '"a"'  }
-    # assert_raises(Faraday::Error::ParsingError) { process 'true' }
-    # assert_raises(Faraday::Error::ParsingError) { process 'null' }
-    # assert_raises(Faraday::Error::ParsingError) { process '1'    }
+    # assert_raises(Faraday::ParsingError) { process '"a"'  }
+    # assert_raises(Faraday::ParsingError) { process 'true' }
+    # assert_raises(Faraday::ParsingError) { process 'null' }
+    # assert_raises(Faraday::ParsingError) { process '1'    }
   end
 end

data/test/mock_response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ElastomerClient
+  module Middleware
+    class MockResponse < Faraday::Middleware
+      def initialize(app, &block)
+        super(app)
+        @response_block = block
+      end
+
+      def call(env)
+        env.clear_body if env.needs_body?
+
+        env.status = 200
+        env.response_headers = ::Faraday::Utils::Headers.new
+        env.response_headers["Fake"] = "yes"
+        env.response = ::Faraday::Response.new
+
+        @response_block&.call(env)
+
+        env.response.finish(env) unless env.parallel?
+
+        env.response
+      end
+    end
+  end
+end
+
+Faraday::Request.register_middleware \
+  mock_response: ElastomerClient::Middleware::MockResponse

data/test/notifications_test.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require File.expand_path("../test_helper", __FILE__)
-require "elastomer/notifications"
+require "elastomer_client/notifications"
 
-describe Elastomer::Notifications do
+describe ElastomerClient::Notifications do
   before do
     @name = "elastomer-notifications-test"
     @index = $client.index @name
@@ -18,11 +20,12 @@ describe Elastomer::Notifications do
   end
 
   it "instruments timeouts" do
-    $client.stub :connection, lambda { raise Faraday::Error::TimeoutError } do
-      assert_raises(Elastomer::Client::TimeoutError) { $client.info }
+    $client.stub :connection, lambda { raise Faraday::TimeoutError } do
+      assert_raises(ElastomerClient::Client::TimeoutError) { $client.info }
       event = @events.detect { |e| e.payload[:action] == "cluster.info" }
       exception = event.payload[:exception]
-      assert_equal "Elastomer::Client::TimeoutError", exception[0]
+
+      assert_equal "ElastomerClient::Client::TimeoutError", exception[0]
       assert_match "timeout", exception[1]
     end
   end
@@ -42,11 +45,13 @@ describe Elastomer::Notifications do
   it "instruments index actions" do
     @index.exists?; assert_action_event("index.exists")
     @index.create(default_index_settings)
+
     assert_action_event("index.create")
     wait_for_index(@index.name)
 
     @index.get_settings; assert_action_event("index.get_settings")
     @index.update_settings(number_of_replicas: 0)
+
     assert_action_event("index.get_settings")
     wait_for_index(@index.name)
 
@@ -58,6 +63,7 @@ describe Elastomer::Notifications do
   it "includes the response body in the payload" do
     @index.create(default_index_settings)
     event = @events.detect { |e| e.payload[:action] == "index.create" }
+
     assert event.payload[:response_body]
   end
 
@@ -66,6 +72,7 @@ describe Elastomer::Notifications do
     event = @events.detect { |e| e.payload[:action] == "index.create" }
 
     payload = event.payload
+
     assert payload[:response_body]
     assert payload[:request_body]
     assert_same payload[:body], payload[:request_body]
@@ -75,10 +82,10 @@ describe Elastomer::Notifications do
     assert @events.detect { |e| e.payload[:action] == action }, "expected #{action} event"
   end
 
-  def stub_client(method, url, status=200, body='{"acknowledged":true}')
+  def stub_client(method, url, status = 200, body = '{"acknowledged":true}')
     stubs = Faraday::Adapter::Test::Stubs.new do |stub|
-      stub.send(method, url) { |env| [status, {}, body]}
+      stub.send(method, url) { |env| [status, {}, body] }
     end
-    Elastomer::Client.new($client_params.merge(:opaque_id => false, :adapter => [:test, stubs]))
+    ElastomerClient::Client.new($client_params.merge(opaque_id: false, adapter: [:test, stubs]))
   end
 end

data/test/test_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rubygems" unless defined? Gem
 require "bundler"
 Bundler.require(:default, :development)
@@ -21,11 +23,11 @@ require "minitest/focus"
 
 # used in a couple test files, makes them available for all
 require "active_support/core_ext/enumerable"
-require 'active_support/core_ext/hash'
+require "active_support/core_ext/hash"
 
 # push the lib folder onto the load path
 $LOAD_PATH.unshift "lib"
-require "elastomer/client"
+require "elastomer_client/client"
 
 # we are going to use the same client instance everywhere!
 # the client should always be stateless
@@ -34,28 +36,18 @@ $client_params = {
   read_timeout: 10,
   open_timeout: 1,
   opaque_id: false,
-  strict_params: true
+  strict_params: true,
+  compress_body: true
 }
-$client = Elastomer::Client.new $client_params
+$client = ElastomerClient::Client.new(**$client_params)
 
 # ensure we have an Elasticsearch server to test with
 raise "No server available at #{$client.url}" unless $client.available?
 
 puts "Elasticsearch version is #{$client.version}"
 
-# COMPATIBILITY
-# Returns true if the Elasticsearch cluster defaults to supporting compression.
-def supports_compressed_bodies_by_default?
-  $client.version_support.es_version_5_x?
-end
-
-# Now that we have the version, re-create the client with compression if supported.
-if supports_compressed_bodies_by_default?
-  $client = Elastomer::Client.new $client_params.merge(compress_body: true)
-end
-
 # remove any lingering test indices from the cluster
-MiniTest.after_run do
+Minitest.after_run do
   $client.cluster.indices.keys.each do |name|
     next unless name =~ /^elastomer-/i
     $client.index(name).delete
@@ -70,7 +62,7 @@ end
 # add custom assertions
 require File.expand_path("../assertions", __FILE__)
 
-# require 'elastomer/notifications'
+# require 'elastomer_client/notifications'
 # require 'pp'
 
 # ActiveSupport::Notifications.subscribe('request.client.elastomer') do |name, start_time, end_time, transaction_id, payload|
@@ -91,13 +83,13 @@ require File.expand_path("../assertions", __FILE__)
 #            setting of 1 replica.
 #
 # Returns the cluster health response.
-# Raises Elastomer::Client::TimeoutError if requested status is not achieved
+# Raises ElastomerClient::Client::TimeoutError if requested status is not achieved
 # within 5 seconds.
-def wait_for_index(name, status="yellow")
+def wait_for_index(name, status = "yellow")
   $client.cluster.health(
-    :index           => name,
-    :wait_for_status => status,
-    :timeout         => "5s"
+    index: name,
+    wait_for_status: status,
+    timeout: "5s"
   )
 end
 
@@ -110,7 +102,7 @@ def run_snapshot_tests?
     begin
       create_repo("elastomer-client-snapshot-test")
       $run_snapshot_tests = true
-    rescue Elastomer::Client::Error
+    rescue ElastomerClient::Client::Error
       puts "Could not create a snapshot repo. Snapshot tests will be disabled."
       puts "To enable snapshot tests, add a path.repo setting to your elasticsearch.yml file."
       $run_snapshot_tests = false
@@ -123,7 +115,7 @@ end
 
 def create_repo(name, settings = {})
   location = File.join(*[ENV["SNAPSHOT_DIR"], name].compact)
-  default_settings = {:type => "fs", :settings => {:location => location}}
+  default_settings = {type: "fs", settings: {location:}}
   $client.repository(name).create(default_settings.merge(settings))
 end
 
@@ -153,7 +145,7 @@ def with_tmp_repo(name = SecureRandom.uuid, &block)
 end
 
 def create_snapshot(repo, name = SecureRandom.uuid)
-  repo.snapshot(name).create({}, :wait_for_completion => true)
+  repo.snapshot(name).create({}, wait_for_completion: true)
 end
 
 def with_tmp_snapshot(name = SecureRandom.uuid, &block)
@@ -180,9 +172,9 @@ def populate_background_index!(name)
       docs.bulk do |d|
         (1..500).each do |j|
           d.index \
-            :foo => "foo_#{i}_#{j}",
-            :bar => "bar_#{i}_#{j}",
-            :baz => "baz_#{i}_#{j}"
+            foo: "foo_#{i}_#{j}",
+            bar: "bar_#{i}_#{j}",
+            baz: "baz_#{i}_#{j}"
         end
       end
       index.refresh
@@ -208,80 +200,31 @@ end
 
 # The methods below are to support intention-revealing names about version
 # differences in the tests. If necessary for general operation they can be moved
-# into Elastomer::VersionSupport.
-
-# COMPATIBILITY
-# ES 5.x returns `index` bulk request as `index` responses whether or not the
-# document was created or updated. ES 2.x returns a `create` response if it was
-# created.
-def bulk_index_returns_create_for_new_documents?
-  $client.version_support.es_version_2_x?
-end
+# into ElastomerClient::VersionSupport.
 
 # COMPATIBILITY
-# ES 5.x drops support for index-time payloads
-def index_time_payloads?
-  $client.version_support.es_version_2_x?
-end
-
-# COMPATIBILITY
-# ES 2.x returns an empty result when an alias does not exist for a full or partial match
-# ES 5.6 returns an error when an alias does not exist for a full or partial match
-def fetching_non_existent_alias_returns_error?
-  $client.version_support.es_version_5_x?
-end
-
-# COMPATIBILITY
-# ES 5.6 includes a _nodes key in the /_cluster/stats response. Strangely
-# enough, this is not documented in the example response:
-# https://www.elastic.co/guide/en/elasticsearch/reference/5.6/cluster-stats.html
-def cluster_stats_includes_underscore_nodes?
-  $client.version_support.es_version_5_x?
-end
-
-# COMPATIBILITY
-# ES 2.0 deprecated the `filtered` query type. ES 5.0 removed it entirely.
-def filtered_query_removed?
-  $client.version_support.es_version_5_x?
-end
-
-# ES 5.6 percolator queries/document submissions require that an appropriate
-# percolator type and field within that type are defined on the index mappings
-def requires_percolator_mapping?
-  $client.version_support.es_version_5_x?
-end
-
-# COMPATIBILITY
-# ES 5 removes the `output` option for fields.
-# See: https://www.elastic.co/guide/en/elasticsearch/reference/5.6/breaking_50_suggester.html#_simpler_completion_indexing
-def supports_suggest_output?
-  $client.version_support.es_version_2_x?
-end
-
-# COMPATIBILITY
-# ES 5 returns information about the number of cleared scroll IDs
-def returns_cleared_scroll_id_info?
-  $client.version_support.es_version_5_x?
-end
-
-# COMPATIBILITY
-# Return a Hash with an unsupported indexing directive key/value to test fail-fast.
-def incompatible_indexing_directive
-  if $client.version_support.es_version_2_x?
-    {_wait_for_active_shards: 10}
+# ES8 drops mapping types, so don't wrap with a mapping type for ES8+
+def mappings_wrapper(type, body, disable_all = false)
+  if $client.version_support.es_version_8_plus?
+    body
   else
-    {_consistency: "all"}
+    mapping = {
+      _default_: {
+        dynamic: "strict"
+      }
+    }
+    mapping[type] = body
+    if disable_all then mapping[type]["_all"] = { "enabled": false } end
+    mapping
   end
 end
 
 # COMPATIBILITY
-# Returns true if the Elasticsearch cluster will validate request parameters.
-def parameter_validation?
-  $client.version_support.es_version_5_x?
-end
-
-# ES 5 supports native _delete_by_query, but the output and semantics are
-# different than the plugin which we modeled our delete by query on.
-def supports_native_delete_by_query?
-  $client.version_support.native_delete_by_query?
+# ES8 drops mapping types, so append type to the document only if ES version < 8
+def document_wrapper(type, body)
+  if $client.version_support.es_version_8_plus?
+    body
+  else
+    body.merge({_type: type})
+  end
 end

data/test/version_support_test.rb

@@ -1,17 +1,19 @@
-require_relative './test_helper'
+# frozen_string_literal: true
 
-describe Elastomer::VersionSupport do
+require_relative "test_helper"
+
+describe ElastomerClient::VersionSupport do
   describe "supported versions" do
-    it "allows 2.3.0 to 5.6" do
-      two_three_series = ["2.3.0", "2.3.5", "2.4.0", "2.9.9", "2.9.100"]
-      five_series = ["5.0.0", "5.0.9", "5.2.0", "5.6.9", "5.6.100"]
+    it "allows 5.0.0 to 8.x" do
+      five_series = ["5.0.0", "5.0.9", "5.1.0", "5.9.0", "5.99.100"]
+      eight_series = ["8.0.0", "8.0.9", "8.1.0", "8.9.0", "8.99.100"]
 
-      two_three_series.each do |version|
-        assert Elastomer::VersionSupport.new(version).es_version_2_x?
+      five_series.each do |version|
+        assert ElastomerClient::VersionSupport.new(version)
       end
 
-      five_series.each do |version|
-        assert Elastomer::VersionSupport.new(version).es_version_5_x?
+      eight_series.each do |version|
+        assert_predicate ElastomerClient::VersionSupport.new(version), :es_version_8_plus?
       end
     end
   end
@@ -19,11 +21,11 @@ describe Elastomer::VersionSupport do
   describe "unsupported versions" do
     it "blow up" do
       too_low = ["0.90", "1.0.1", "2.0.0", "2.2.0"]
-      too_high = ["5.7.0", "6.0.0"]
+      too_high = ["9.0.0"]
 
       (too_low + too_high).each do |version|
         exception = assert_raises(ArgumentError, "expected #{version} to not be supported") do
-          Elastomer::VersionSupport.new(version)
+          ElastomerClient::VersionSupport.new(version)
         end
 
         assert_match version, exception.message
@@ -31,71 +33,4 @@ describe Elastomer::VersionSupport do
       end
     end
   end
-
-  describe "ES 2.x" do
-    let(:version_support) { Elastomer::VersionSupport.new("2.3.5") }
-
-    describe "#keyword" do
-      it "returns non_analyzed string" do
-        expected = {
-          type: "string",
-          index: "not_analyzed",
-          store: true
-        }
-        assert_equal(expected, version_support.keyword(store: true))
-      end
-    end
-
-    describe "#text" do
-      it "returns analyzed string" do
-        expected = {
-          type: "string",
-          term_vector: "with_positions_offsets"
-        }
-        assert_equal(expected, version_support.text(term_vector: "with_positions_offsets"))
-      end
-    end
-
-    describe "native_delete_by_query?" do
-      it "returns false" do
-        refute version_support.native_delete_by_query?, "ES 2.X does not have native delete_by_query support"
-      end
-    end
-  end
-
-  describe "ES 5.x" do
-    let(:version_support) { Elastomer::VersionSupport.new("5.6.0") }
-
-    describe "#keyword" do
-      it "returns keyword" do
-        expected = {
-          type: "keyword",
-          store: true
-        }
-        assert_equal(expected, version_support.keyword(store: true))
-      end
-    end
-
-    describe "#text" do
-      it "returns text" do
-        expected = {
-          type: "text",
-          term_vector: "with_positions_offsets"
-        }
-        assert_equal(expected, version_support.text(term_vector: "with_positions_offsets"))
-      end
-    end
-
-    describe "native_delete_by_query?" do
-      it "returns true" do
-        assert version_support.native_delete_by_query?, "ES 5.X has native delete_by_query support"
-      end
-    end
-
-    describe "#op_type_param" do
-      it "converts the supplied params key _op_type to op_type, if present" do
-        assert_equal(version_support.op_type(_op_type: "create"), {op_type: "create"})
-      end
-    end
-  end
 end