elastomer-client 3.2.2 → 6.2.0

data/test/client/multi_percolate_test.rb

@@ -1,36 +1,39 @@
+# frozen_string_literal: true
+
 require_relative "../test_helper"
 
-describe Elastomer::Client::MultiPercolate do
+describe ElastomerClient::Client::MultiPercolate do
 
   before do
+    if $client.version_support.es_version_8_plus?
+      skip "Multi percolate not supported in ES version #{$client.version}"
+    end
+
     @name  = "elastomer-mpercolate-test"
     @index = $client.index(@name)
 
     unless @index.exists?
       base_mappings_settings = {
-        :settings => { "index.number_of_shards" => 1, "index.number_of_replicas" => 0 },
-        :mappings => {
-          :doc1 => {
-            :_source => { :enabled => true }, :_all => { :enabled => false },
-            :properties => {
-              :title  => $client.version_support.text(analyzer: "standard"),
-              :author => $client.version_support.keyword
+        settings: { "index.number_of_shards" => 1, "index.number_of_replicas" => 0 },
+        mappings: {
+          doc1: {
+            _source: { enabled: true }, _all: { enabled: false },
+            properties: {
+              title: { type: "text", analyzer: "standard" },
+              author: { type: "keyword" }
             }
           },
-          :doc2 => {
-            :_source => { :enabled => true }, :_all => { :enabled => false },
-            :properties => {
-              :title  => $client.version_support.text(analyzer: "standard"),
-              :author => $client.version_support.keyword
+          doc2: {
+            _source: { enabled: true }, _all: { enabled: false },
+            properties: {
+              title: { type: "text", analyzer: "standard" },
+              author: { type: "keyword" }
             }
           }
         }
       }
 
-      # COMPATIBILITY
-      if requires_percolator_mapping?
-        base_mappings_settings[:mappings][:percolator] = { :properties => { :query => { :type => "percolator" } } }
-      end
+      base_mappings_settings[:mappings][:percolator] = { properties: { query: { type: "percolator" } } }
 
       @index.create base_mappings_settings
       wait_for_index(@name)
@@ -58,6 +61,7 @@ describe Elastomer::Client::MultiPercolate do
     body = body.join "\n"
     h = $client.multi_percolate body
     response1, response2, response3 = h["responses"]
+
     assert_equal ["1", "2"], response1["matches"].map { |match| match["_id"] }.sort
     assert_equal ["1", "3"], response2["matches"].map { |match| match["_id"] }.sort
     assert_equal 2, response3["total"]
@@ -78,6 +82,7 @@ describe Elastomer::Client::MultiPercolate do
     body = body.join "\n"
     h = $client.mpercolate body
     response1, response2, response3 = h["responses"]
+
     assert_equal ["1", "2"], response1["matches"].map { |match| match["_id"] }.sort
     assert_equal ["1", "3"], response2["matches"].map { |match| match["_id"] }.sort
     assert_equal 2, response3["total"]
@@ -86,50 +91,50 @@ describe Elastomer::Client::MultiPercolate do
   it "supports a nice block syntax" do
     populate!
 
-    h = $client.multi_percolate(:index => @name, :type => "doc2") do |m|
-      m.percolate :author => "pea53"
-      m.percolate :author => "grantr"
-      m.count({ :author => "grantr" })
+    h = $client.multi_percolate(index: @name, type: "doc2") do |m|
+      m.percolate author: "pea53"
+      m.percolate author: "grantr"
+      m.count({ author: "grantr" })
     end
 
     response1, response2, response3 = h["responses"]
+
     assert_equal ["1", "2"], response1["matches"].map { |match| match["_id"] }.sort
     assert_equal ["1", "3"], response2["matches"].map { |match| match["_id"] }.sort
     assert_equal 2, response3["total"]
   end
 
-  # rubocop:disable Metrics/MethodLength
   def populate!
     @docs.index \
-      :_id    => 1,
-      :_type  => "doc1",
-      :title  => "the author of gravatar",
-      :author => "mojombo"
+      _id: 1,
+      _type: "doc1",
+      title: "the author of gravatar",
+      author: "mojombo"
 
     @docs.index \
-      :_id    => 2,
-      :_type  => "doc1",
-      :title  => "the author of resque",
-      :author => "defunkt"
+      _id: 2,
+      _type: "doc1",
+      title: "the author of resque",
+      author: "defunkt"
 
     @docs.index \
-      :_id    => 1,
-      :_type  => "doc2",
-      :title  => "the author of logging",
-      :author => "pea53"
+      _id: 1,
+      _type: "doc2",
+      title: "the author of logging",
+      author: "pea53"
 
     @docs.index \
-      :_id    => 2,
-      :_type  => "doc2",
-      :title  => "the author of rubber-band",
-      :author => "grantr"
+      _id: 2,
+      _type: "doc2",
+      title: "the author of rubber-band",
+      author: "grantr"
 
     percolator1 = @index.percolator "1"
-    percolator1.create :query => { :match_all => { } }
+    percolator1.create query: { match_all: { } }
     percolator2 = @index.percolator "2"
-    percolator2.create :query => { :match => { :author => "pea53" } }
+    percolator2.create query: { match: { author: "pea53" } }
     percolator2 = @index.percolator "3"
-    percolator2.create :query => { :match => { :author => "grantr" } }
+    percolator2.create query: { match: { author: "grantr" } }
 
     @index.refresh
   end

data/test/client/multi_search_test.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require_relative "../test_helper"
 
-describe Elastomer::Client::MultiSearch do
+describe ElastomerClient::Client::MultiSearch do
 
   before do
     @name  = "elastomer-msearch-test"
@@ -8,24 +10,14 @@ describe Elastomer::Client::MultiSearch do
 
     unless @index.exists?
       @index.create \
-        :settings => { "index.number_of_shards" => 1, "index.number_of_replicas" => 0 },
-        :mappings => {
-          :doc1 => {
-            :_source => { :enabled => true }, :_all => { :enabled => false },
-            :properties => {
-              :title  => $client.version_support.text(analyzer: "standard"),
-              :author => $client.version_support.keyword
-            }
-          },
-          :doc2 => {
-            :_source => { :enabled => true }, :_all => { :enabled => false },
-            :properties => {
-              :title  => $client.version_support.text(analyzer: "standard"),
-              :author => $client.version_support.keyword
-            }
+        settings: { "index.number_of_shards" => 1, "index.number_of_replicas" => 0 },
+        mappings: mappings_wrapper("book", {
+          _source: { enabled: true },
+          properties: {
+            title: { type: "text", analyzer: "standard" },
+            author: { type: "keyword" }
           }
-        }
-
+        }, !$client.version_support.es_version_8_plus?)
       wait_for_index(@name)
     end
 
@@ -40,28 +32,41 @@ describe Elastomer::Client::MultiSearch do
     populate!
 
     body = [
-      '{"index" : "elastomer-msearch-test", "size" : 0}',
+      '{"index" : "elastomer-msearch-test"}',
       '{"query" : {"match_all" : {}}}',
-      '{"index" : "elastomer-msearch-test", "type": "doc2"}',
-      '{"query" : {"match": {"author" : "grantr"}}}',
+      '{"index" : "elastomer-msearch-test"}',
+      '{"query" : {"match": {"author" : "Author 2"}}}',
       nil
     ]
     body = body.join "\n"
     h = $client.multi_search body
     response1, response2 = h["responses"]
-    assert_equal 4, response1["hits"]["total"]
-    assert_equal 1, response2["hits"]["total"]
+
+    if $client.version_support.es_version_8_plus?
+      assert_equal 2, response1["hits"]["total"]["value"]
+      assert_equal 1, response2["hits"]["total"]["value"]
+    else
+      assert_equal 2, response1["hits"]["total"]
+      assert_equal 1, response2["hits"]["total"]
+    end
+
     assert_equal "2", response2["hits"]["hits"][0]["_id"]
 
     body = [
       "{}",
-      '{"query" : {"match": {"author" : "grantr"}}}',
+      '{"query" : {"match": {"author" : "Author 2"}}}',
       nil
     ]
     body = body.join "\n"
-    h = $client.multi_search body, :index => @name
+    h = $client.multi_search body, index: @name
     response1 = h["responses"].first
-    assert_equal 1, response1["hits"]["total"]
+
+    if $client.version_support.es_version_8_plus?
+      assert_equal 1, response1["hits"]["total"]["value"]
+    else
+      assert_equal 1, response1["hits"]["total"]
+    end
+
     assert_equal "2", response1["hits"]["hits"][0]["_id"]
   end
 
@@ -69,28 +74,41 @@ describe Elastomer::Client::MultiSearch do
     populate!
 
     body = [
-      '{"index" : "elastomer-msearch-test", "size" : 0}',
+      '{"index" : "elastomer-msearch-test"}',
       '{"query" : {"match_all" : {}}}',
-      '{"index" : "elastomer-msearch-test", "type": "doc2"}',
-      '{"query" : {"match": {"author" : "grantr"}}}',
+      '{"index" : "elastomer-msearch-test"}',
+      '{"query" : {"match": {"author" : "Author 2"}}}',
       nil
     ]
     body = body.join "\n"
     h = $client.msearch body
     response1, response2 = h["responses"]
-    assert_equal 4, response1["hits"]["total"]
-    assert_equal 1, response2["hits"]["total"]
+
+    if $client.version_support.es_version_8_plus?
+      assert_equal 2, response1["hits"]["total"]["value"]
+      assert_equal 1, response2["hits"]["total"]["value"]
+    else
+      assert_equal 2, response1["hits"]["total"]
+      assert_equal 1, response2["hits"]["total"]
+    end
+
     assert_equal "2", response2["hits"]["hits"][0]["_id"]
 
     body = [
       "{}",
-      '{"query" : {"match": {"author" : "grantr"}}}',
+      '{"query" : {"match": {"author" : "Author 2"}}}',
       nil
     ]
     body = body.join "\n"
-    h = $client.msearch body, :index => @name
+    h = $client.msearch body, index: @name
     response1 = h["responses"].first
-    assert_equal 1, response1["hits"]["total"]
+
+    if $client.version_support.es_version_8_plus?
+      assert_equal 1, response1["hits"]["total"]["value"]
+    else
+      assert_equal 1, response1["hits"]["total"]
+    end
+
     assert_equal "2", response1["hits"]["hits"][0]["_id"]
   end
 
@@ -98,61 +116,98 @@ describe Elastomer::Client::MultiSearch do
     populate!
 
     h = $client.multi_search do |m|
-      m.search({:query => { :match_all => {}}}, :index => @name, :size => 0)
-      m.search({:query => { :match => { "title" => "author" }}}, :index => @name, :type => "doc2")
+      m.search({query: { match_all: {}}}, index: @name)
+      m.search({query: { match: { "title" => "author" }}}, index: @name)
     end
 
     response1, response2 = h["responses"]
 
-    assert_equal 4, response1["hits"]["total"]
-    assert_equal 2, response2["hits"]["total"]
+    if $client.version_support.es_version_8_plus?
+      assert_equal 2, response1["hits"]["total"]["value"]
+      assert_equal 2, response2["hits"]["total"]["value"]
+    else
+      assert_equal 2, response1["hits"]["total"]
+      assert_equal 2, response2["hits"]["total"]
+    end
 
     h = @index.multi_search do |m|
-      m.search({:query => { :match_all => {}}}, :size => 0)
-      m.search({:query => { :match => { "title" => "author" }}}, :type => "doc2")
+      m.search({query: { match_all: {}}})
+      m.search({query: { match: { "title" => "author" }}})
     end
 
     response1, response2 = h["responses"]
 
-    assert_equal 4, response1["hits"]["total"]
-    assert_equal 2, response2["hits"]["total"]
+    if $client.version_support.es_version_8_plus?
+      assert_equal 2, response1["hits"]["total"]["value"]
+      assert_equal 2, response2["hits"]["total"]["value"]
+    else
+      assert_equal 2, response1["hits"]["total"]
+      assert_equal 2, response2["hits"]["total"]
+    end
 
-    h = @index.docs("doc1").multi_search do |m|
-      m.search({:query => { :match_all => {}}}, :size => 0)
-      m.search({:query => { :match => { "title" => "logging" }}}, :type => "doc2")
+    type = $client.version_support.es_version_8_plus? ? "" : "book"
+    h = @index.docs(type).multi_search do |m|
+      m.search({query: { match_all: {}}})
+      m.search({query: { match: { "title" => "2" }}})
     end
 
     response1, response2 = h["responses"]
 
-    assert_equal 2, response1["hits"]["total"]
-    assert_equal 1, response2["hits"]["total"]
+    if $client.version_support.es_version_8_plus?
+      assert_equal 2, response1["hits"]["total"]["value"]
+      assert_equal 1, response2["hits"]["total"]["value"]
+    else
+      assert_equal 2, response1["hits"]["total"]
+      assert_equal 1, response2["hits"]["total"]
+    end
   end
 
-  # rubocop:disable Metrics/MethodLength
-  def populate!
-    @docs.index \
-      :_id    => 1,
-      :_type  => "doc1",
-      :title  => "the author of gravatar",
-      :author => "mojombo"
+  it "performs suggestion queries using the search endpoint" do
+    populate!
 
-    @docs.index \
-      :_id    => 2,
-      :_type  => "doc1",
-      :title  => "the author of resque",
-      :author => "defunkt"
+    h = @index.multi_search do |m|
+      m.search({
+        query: {
+          match: {
+            title: "by author"
+          }
+        },
+        suggest: {
+          suggestion1: {
+            text: "by author",
+            term: {
+              field: "author"
+            }
+          }
+        }
+      })
+    end
 
+    response = h["responses"][0]
+
+    if $client.version_support.es_version_8_plus?
+      assert_equal 2, response["hits"]["total"]["value"]
+    else
+      assert_equal 2, response["hits"]["total"]
+    end
+
+    refute_nil response["suggest"], "expected suggester text to be returned"
+  end
+
+  def populate!
     @docs.index \
-      :_id    => 1,
-      :_type  => "doc2",
-      :title  => "the author of logging",
-      :author => "pea53"
+      document_wrapper("book", {
+        _id: 1,
+        title: "Book 1 by author 1",
+        author: "Author 1"
+      })
 
     @docs.index \
-      :_id    => 2,
-      :_type  => "doc2",
-      :title  => "the author of rubber-band",
-      :author => "grantr"
+      document_wrapper("book", {
+        _id: 2,
+        title: "Book 2 by author 2",
+        author: "Author 2"
+      })
 
     @index.refresh
   end

data/test/client/native_delete_by_query_test.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require_relative "../test_helper"
 
-describe Elastomer::Client::NativeDeleteByQuery do
+describe ElastomerClient::Client::NativeDeleteByQuery do
   before do
     @index = $client.index "elastomer-delete-by-query-test"
     @index.delete if @index.exists?
@@ -11,113 +13,119 @@ describe Elastomer::Client::NativeDeleteByQuery do
     @index.delete if @index.exists?
   end
 
-  if supports_native_delete_by_query?
-    describe "when an index with documents exists" do
-      before do
-        @index.create(nil)
-        wait_for_index(@index.name)
-      end
+  describe "when an index with documents exists" do
+    before do
+      @index.create(nil)
+      wait_for_index(@index.name)
+    end
 
-      it "deletes by query" do
-        @docs.index({ :_id => 0, :name => "mittens" })
-        @docs.index({ :_id => 1, :name => "luna" })
+    it "deletes by query" do
+      @docs.index({ _id: 0, name: "mittens" })
+      @docs.index({ _id: 1, name: "luna" })
 
-        @index.refresh
+      @index.refresh
 
-        query = {
-          query: {
-            match: {
-              name: "mittens"
-            }
+      query = {
+        query: {
+          match: {
+            name: "mittens"
           }
         }
+      }
 
-        response = @index.native_delete_by_query(query)
-        refute_nil response["took"]
-        assert_equal(false, response["timed_out"])
-        assert_equal(1, response["batches"])
-        assert_equal(1, response["total"])
-        assert_equal(1, response["deleted"])
-        assert_empty(response["failures"])
-
-        @index.refresh
-        response = @docs.multi_get(:ids => [0, 1])
-        refute_found response.fetch("docs")[0]
-        assert_found response.fetch("docs")[1]
-      end
+      response = @index.native_delete_by_query(query)
+
+      refute_nil response["took"]
+      refute(response["timed_out"])
+      assert_equal(1, response["batches"])
+      assert_equal(1, response["total"])
+      assert_equal(1, response["deleted"])
+      assert_empty(response["failures"])
 
-      it "fails when internal version is 0" do
-        @docs.index({_id: 0, name: "mittens"})
-        # Creating a document with external version 0 also sets the internal version to 0
-        # Otherwise you can't index a document with version 0.
-        @docs.index({_id: 1, _version: 0, _version_type: "external", name: "mittens"})
-        @index.refresh
-
-        query = {
-          query: {
-            match: {
-              name: "mittens"
-            }
+      @index.refresh
+      response = @docs.multi_get(ids: [0, 1])
+
+      refute_found response.fetch("docs")[0]
+      assert_found response.fetch("docs")[1]
+    end
+
+    it "fails when internal version is 0" do
+      if $client.version_support.es_version_8_plus?
+        skip "Concurrency control with internal version is not supported in ES #{$client.version}"
+      end
+      @docs.index({_id: 0, name: "mittens"})
+      # Creating a document with external version 0 also sets the internal version to 0
+      # Otherwise you can't index a document with version 0.
+      @docs.index({_id: 1, _version: 0, _version_type: "external", name: "mittens"})
+      @index.refresh
+
+      query = {
+        query: {
+          match: {
+            name: "mittens"
           }
         }
+      }
 
-        assert_raises(Elastomer::Client::RequestError) do
-          @index.native_delete_by_query(query)
-        end
+      assert_raises(ElastomerClient::Client::RequestError) do
+        @index.native_delete_by_query(query)
       end
+    end
 
-      it "fails when an unknown parameter is provided" do
-        assert_raises(Elastomer::Client::IllegalArgument) do
-          @index.native_delete_by_query({}, foo: "bar")
-        end
+    it "fails when an unknown parameter is provided" do
+      assert_raises(ElastomerClient::Client::IllegalArgument) do
+        @index.native_delete_by_query({}, foo: "bar")
       end
+    end
 
-      it "deletes by query when routing is specified" do
-        index = $client.index "elastomer-delete-by-query-routing-test"
-        index.delete if index.exists?
-        type = "docs"
-        index.create({mappings: { type => { _routing: { required: true } } } })
-        wait_for_index(@index.name)
-        docs = index.docs(type)
-
-        docs.index({ :_id => 0, :_routing => "cat", :name => "mittens" })
-        docs.index({ :_id => 1, :_routing => "cat", :name => "luna" })
-        docs.index({ :_id => 2, :_routing => "dog", :name => "mittens" })
-
-        query = {
-          query: {
-            match: {
-              name: "mittens"
-            }
+    it "deletes by query when routing is specified" do
+      index = $client.index "elastomer-delete-by-query-routing-test"
+      index.delete if index.exists?
+      type = "docs"
+      # default number of shards in ES8 is 1, so set it to 2 shards so routing to different shards can be tested
+      settings = $client.version_support.es_version_8_plus? ? { number_of_shards: 2 } : {}
+      index.create({
+        settings:,
+        mappings: mappings_wrapper(type, {
+          properties: {
+            name: { type: "text", analyzer: "standard" },
+          },
+          _routing: { required: true }
+        })
+      })
+      wait_for_index(@index.name)
+      docs = index.docs(type)
+
+      docs.index({ _id: 0, _routing: "cat", name: "mittens" })
+      docs.index({ _id: 1, _routing: "cat", name: "luna" })
+      docs.index({ _id: 2, _routing: "dog", name: "mittens" })
+
+      query = {
+        query: {
+          match: {
+            name: "mittens"
           }
         }
+      }
 
-        index.refresh
-        response = index.native_delete_by_query(query, routing: "cat")
+      index.refresh
+      response = index.native_delete_by_query(query, routing: "cat")
 
-        assert_equal(1, response["deleted"])
+      assert_equal(1, response["deleted"])
 
-        response = docs.multi_get({
-          :docs => [
-            { :_id => 0, :_routing => "cat" },
-            { :_id => 1, :_routing => "cat" },
-            { :_id => 2, :_routing => "dog" },
-          ]
-        })
-        refute_found response["docs"][0]
-        assert_found response["docs"][1]
-        assert_found response["docs"][2]
+      response = docs.multi_get({
+        docs: [
+          { _id: 0, routing: "cat" },
+          { _id: 1, routing: "cat" },
+          { _id: 2, routing: "dog" },
+        ]
+      })
 
-        index.delete if index.exists?
-      end
-    end
-  else
-    describe "when native _delete_by_query is not supported" do
-      it "raises an error" do
-        assert_raises(Elastomer::Client::IncompatibleVersionException) do
-          @index.native_delete_by_query({query: {match_all: {}}})
-        end
-      end
+      refute_found response["docs"][0]
+      assert_found response["docs"][1]
+      assert_found response["docs"][2]
+
+      index.delete if index.exists?
     end
   end
 end