elastomer-client 2.3.0 → 3.0.0

data/test/client/errors_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path("../../test_helper", __FILE__)
+require_relative "../test_helper"
 
 describe Elastomer::Client::Error do
 
@@ -72,4 +72,24 @@ describe Elastomer::Client::Error do
     assert !Elastomer::Client::ConnectionFailed.fatal, "Connection failures are not fatal"
     assert !Elastomer::Client::ServerError.fatal, "Server errors are not fatal"
   end
+
+  if parameter_validation?
+    it "wraps illegal argument exceptions" do
+      begin
+        $client.get("/_cluster/health?consistency=all")
+        assert false, "IllegalArgument exception was not raised"
+      rescue Elastomer::Client::IllegalArgument => err
+        assert_match(/request \[\/_cluster\/health\] contains unrecognized parameter: \[consistency\]/, err.message)
+      end
+    end
+  else
+    it "does not raise illegal argument exceptions" do
+      begin
+        $client.get("/_cluster/health?consistency=all")
+        assert true, "Exception was not raised"
+      rescue Elastomer::Client::Error => err
+        assert false, "Exception #{err} was raised"
+      end
+    end
+  end
 end

data/test/client/es_5_x_warmer_test.rb

@@ -0,0 +1,13 @@
+require_relative "../test_helper"
+
+describe "Elastomer::Client::Warmer under ES 5.x" do
+  it "cannot be instantiated" do
+    if $client.version_support.supports_warmers?
+      skip "warmers are still supported in ES #{$client.version}."
+    end
+
+    assert_raises(Elastomer::Client::IncompatibleVersionException) do
+      Elastomer::Client::Warmer.new($client, "index", "warmer")
+    end
+  end
+end

data/test/client/index_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path("../../test_helper", __FILE__)
+require_relative "../test_helper"
 
 describe Elastomer::Client::Index do
 
@@ -55,8 +55,8 @@ describe Elastomer::Client::Index do
             :_source => { :enabled => false },
             :_all    => { :enabled => false },
             :properties => {
-              :title  => { :type => "string", :analyzer => "standard" },
-              :author => { :type => "string", :index => "not_analyzed" }
+              :title  => $client.version_support.text(analyzer: "standard"),
+              :author => $client.version_support.keyword
             }
           }
         }
@@ -74,8 +74,8 @@ describe Elastomer::Client::Index do
             :_source => { :enabled => false },
             :_all    => { :enabled => false },
             :properties => {
-              :title  => { :type => "string", :analyzer => "standard" },
-              :author => { :type => "string", :index => "not_analyzed" }
+              :title  => $client.version_support.text(analyzer: "standard"),
+              :author => $client.version_support.keyword
             }
           }
         }
@@ -110,7 +110,7 @@ describe Elastomer::Client::Index do
         :doco => {
           :_source => { :enabled => false },
           :_all    => { :enabled => false },
-          :properties => {:title  => { :type => "string", :analyzer => "standard" }}
+          :properties => {:title  => $client.version_support.text(analyzer: "standard")}
         }
       }
     )
@@ -118,14 +118,14 @@ describe Elastomer::Client::Index do
     assert_property_exists @index.mapping[@name], "doco", "title"
 
     @index.update_mapping "doco", { :doco => { :properties => {
-      :author => { :type => "string", :index => "not_analyzed" }
+      :author => $client.version_support.keyword
     }}}
 
     assert_property_exists @index.mapping[@name], "doco", "author"
     assert_property_exists @index.mapping[@name], "doco", "title"
 
     @index.update_mapping "mux_mool", { :mux_mool => { :properties => {
-      :song => { :type => "string", :index => "not_analyzed" }
+      :song => $client.version_support.keyword
     }}}
 
     assert_property_exists @index.mapping[@name], "mux_mool", "song"
@@ -137,7 +137,7 @@ describe Elastomer::Client::Index do
         :doco => {
           :_source => { :enabled => false },
           :_all    => { :enabled => false },
-          :properties => {:title  => { :type => "string", :analyzer => "standard" }}
+          :properties => {:title  => $client.version_support.text(analyzer: "standard")}
         }
       }
     )
@@ -145,14 +145,14 @@ describe Elastomer::Client::Index do
     assert_property_exists @index.mapping[@name], "doco", "title"
 
     @index.put_mapping "doco", { :doco => { :properties => {
-      :author => { :type => "string", :index => "not_analyzed" }
+      :author => $client.version_support.keyword
     }}}
 
     assert_property_exists @index.mapping[@name], "doco", "author"
     assert_property_exists @index.mapping[@name], "doco", "title"
 
     @index.put_mapping "mux_mool", { :mux_mool => { :properties => {
-      :song => { :type => "string", :index => "not_analyzed" }
+      :song => $client.version_support.keyword
     }}}
 
     assert_property_exists @index.mapping[@name], "mux_mool", "song"
@@ -163,10 +163,29 @@ describe Elastomer::Client::Index do
     assert_equal({@name => {"aliases" => {}}}, @index.get_aliases)
 
     $client.cluster.update_aliases :add => {:index => @name, :alias => "foofaloo"}
-    assert_equal({@name => {"aliases" => {"foofaloo" => {}}}}, @index.get_aliases)
+    $client.cluster.update_aliases :add => {:index => @name, :alias => "bar"}
+
+    assert_equal({@name => {"aliases" => {"foofaloo" => {}, "bar" => {}}}}, @index.get_aliases)
 
     assert_equal({@name => {"aliases" => {"foofaloo" => {}}}}, @index.get_alias("f*"))
-    assert_equal({}, @index.get_alias("r*"))
+    assert_equal({@name => {"aliases" => {"foofaloo" => {}, "bar" => {}}}}, @index.get_alias("*"))
+
+    if fetching_non_existent_alias_returns_error?
+      exception = assert_raises(Elastomer::Client::RequestError) do
+        @index.get_alias("not-there")
+      end
+      assert_equal("alias [not-there] missing", exception.message)
+      assert_equal(404, exception.status)
+
+      exception = assert_raises(Elastomer::Client::RequestError) do
+        @index.get_alias("not*")
+      end
+      assert_equal("alias [not*] missing", exception.message)
+      assert_equal(404, exception.status)
+    else
+      assert_equal({}, @index.get_alias("not-there"))
+      assert_equal({}, @index.get_alias("not*"))
+    end
   end
 
   it "adds and deletes aliases to the index" do
@@ -186,7 +205,7 @@ describe Elastomer::Client::Index do
   end
 
   it "analyzes text and returns tokens" do
-    tokens = @index.analyze "Just a few words to analyze.", :analyzer => "standard", :index => nil
+    tokens = @index.analyze({text: "Just a few words to analyze.", analyzer: "standard"}, index: nil)
     tokens = tokens["tokens"].map { |h| h["token"] }
     assert_equal %w[just a few words to analyze], tokens
 
@@ -206,7 +225,7 @@ describe Elastomer::Client::Index do
     )
     wait_for_index(@name)
 
-    tokens = @index.analyze "Just a few words to analyze.", :analyzer => "english_standard"
+    tokens = @index.analyze({text: "Just a few words to analyze.", analyzer: "english_standard"})
     tokens = tokens["tokens"].map { |h| h["token"] }
     assert_equal %w[just few words analyze], tokens
   end
@@ -224,9 +243,12 @@ describe Elastomer::Client::Index do
         :type            => "completion",
         :analyzer        => "simple",
         :search_analyzer => "simple",
-        :payloads        => false
       }
 
+      # COMPATIBILITY
+      # ES 5.x drops support for index-time payloads
+      suggest[:payloads] = false if index_time_payloads?
+
       @index.create(
         :settings => { :number_of_shards => 1, :number_of_replicas => 0 },
         :mappings => {
@@ -234,8 +256,8 @@ describe Elastomer::Client::Index do
             :_source => { :enabled => false },
             :_all    => { :enabled => false },
             :properties => {
-              :title   => { :type => "string", :analyzer => "standard" },
-              :author  => { :type => "string", :index => "not_analyzed" },
+              :title   => $client.version_support.text(analyzer: "standard"),
+              :author  => $client.version_support.keyword,
               :suggest => suggest
             }
           }
@@ -270,11 +292,15 @@ describe Elastomer::Client::Index do
       assert_equal 0, response["_shards"]["failed"]
     end
 
-    it "optimizes" do
-      response = @index.optimize
+    it "force merges" do
+      response = @index.forcemerge
       assert_equal 0, response["_shards"]["failed"]
     end
 
+    it "optimizes through force merge" do
+      assert_equal @index.method(:forcemerge),  @index.method(:optimize)
+    end
+
     it "recovery" do
       response = @index.recovery
       assert_includes response, "elastomer-index-test"
@@ -304,20 +330,25 @@ describe Elastomer::Client::Index do
       @index.docs("foo").index("foo" => "bar")
       @index.refresh
       r = @index.delete_by_query(:q => "*")
-      assert_equal({
-        "_all" => {
-          "found" => 1,
-          "deleted" => 1,
-          "missing" => 0,
-          "failed" => 0,
-        },
-        @name => {
-          "found" => 1,
-          "deleted" => 1,
-          "missing" => 0,
-          "failed" => 0,
-        }
-      }, r["_indices"])
+
+      if supports_native_delete_by_query?
+        assert_equal(1, r['deleted'])
+      else
+        assert_equal({
+          "_all" => {
+            "found" => 1,
+            "deleted" => 1,
+            "missing" => 0,
+            "failed" => 0,
+          },
+          @name => {
+            "found" => 1,
+            "deleted" => 1,
+            "missing" => 0,
+            "failed" => 0,
+          }
+        }, r["_indices"])
+      end
     end
 
     it "creates a Percolator" do
@@ -327,6 +358,11 @@ describe Elastomer::Client::Index do
     end
 
     it "performs multi percolate queries" do
+      # COMPATIBILITY
+      if requires_percolator_mapping?
+        @index.update_mapping("percolator", { :properties => { :query => { :type => "percolator" } } })
+      end
+
       @index.docs.index \
         :_id    => 1,
         :_type  => "doco",
@@ -341,11 +377,12 @@ describe Elastomer::Client::Index do
 
       @index.percolator("1").create :query => { :match_all => { } }
       @index.percolator("2").create :query => { :match => { :author => "pea53" } }
+      @index.refresh
 
       h = @index.multi_percolate(:type => "doco") do |m|
         m.percolate :author => "pea53"
         m.percolate :author => "grantr"
-        m.count({}, { :author => "grantr" })
+        m.count({ :author => "grantr" }, {})
       end
 
       response1, response2, response3 = h["responses"]
@@ -360,14 +397,14 @@ describe Elastomer::Client::Index do
         :_type   => "doco",
         :title   => "the magnificent",
         :author  => "greg",
-        :suggest => {:input => %w[Greg greg], :output => "Greg", :weight => 2}
+        :suggest => {:input => "greg", :weight => 2}
 
       @index.docs.index \
         :_id    => 2,
         :_type  => "doco",
         :title  => "the author of rubber-band",
         :author => "grant",
-        :suggest => {:input => %w[Grant grant], :output => "Grant", :weight => 1}
+        :suggest => {:input => "grant", :weight => 1}
 
       @index.refresh
       response = @index.suggest({:name => {:text => "gr", :completion => {:field => :suggest}}})
@@ -378,8 +415,36 @@ describe Elastomer::Client::Index do
 
       options = hash["options"]
       assert_equal 2, options.length
-      assert_equal "Greg", options.first["text"]
-      assert_equal "Grant", options.last["text"]
+      assert_equal "greg", options.first["text"]
+      assert_equal "grant", options.last["text"]
+    end
+
+    it "handles output parameter of field" do
+      document = {
+        _id:     1,
+        _type:   "doco",
+        title:   "the magnificent",
+        author:  "greg",
+        suggest: {input: %w[Greg greg], output: "Greg", weight: 2}
+      }
+
+      if supports_suggest_output?
+        # It is not an error to index `output`...
+        @index.docs.index(document)
+
+        # ...and `output` is used in the search response
+        @index.refresh
+        response = @index.suggest({:name => {:text => "gr", :completion => {:field => :suggest}}})
+        assert_equal "Greg", response.fetch("name").first.fetch("options").first.fetch("text")
+      else
+        # Indexing the document fails when `output` is provided
+        exception = assert_raises(Elastomer::Client::RequestError) do
+          @index.docs.index(document)
+        end
+
+        assert_equal(400, exception.status)
+        assert_match(/\[output\]/, exception.message)
+      end
     end
   end
 end

data/test/client/multi_percolate_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path("../../test_helper", __FILE__)
+require_relative "../test_helper"
 
 describe Elastomer::Client::MultiPercolate do
 
@@ -7,25 +7,32 @@ describe Elastomer::Client::MultiPercolate do
     @index = $client.index(@name)
 
     unless @index.exists?
-      @index.create \
+      base_mappings_settings = {
         :settings => { "index.number_of_shards" => 1, "index.number_of_replicas" => 0 },
         :mappings => {
           :doc1 => {
             :_source => { :enabled => true }, :_all => { :enabled => false },
             :properties => {
-              :title  => { :type => "string", :analyzer => "standard" },
-              :author => { :type => "string", :index => "not_analyzed" }
+              :title  => $client.version_support.text(analyzer: "standard"),
+              :author => $client.version_support.keyword
             }
           },
           :doc2 => {
             :_source => { :enabled => true }, :_all => { :enabled => false },
             :properties => {
-              :title  => { :type => "string", :analyzer => "standard" },
-              :author => { :type => "string", :index => "not_analyzed" }
+              :title  => $client.version_support.text(analyzer: "standard"),
+              :author => $client.version_support.keyword
             }
           }
         }
+      }
 
+      # COMPATIBILITY
+      if requires_percolator_mapping?
+        base_mappings_settings[:mappings][:percolator] = { :properties => { :query => { :type => "percolator" } } }
+      end
+
+      @index.create base_mappings_settings
       wait_for_index(@name)
     end
 

data/test/client/multi_search_test.rb

@@ -1,4 +1,4 @@
-require File.expand_path("../../test_helper", __FILE__)
+require_relative "../test_helper"
 
 describe Elastomer::Client::MultiSearch do
 
@@ -13,15 +13,15 @@ describe Elastomer::Client::MultiSearch do
           :doc1 => {
             :_source => { :enabled => true }, :_all => { :enabled => false },
             :properties => {
-              :title  => { :type => "string", :analyzer => "standard" },
-              :author => { :type => "string", :index => "not_analyzed" }
+              :title  => $client.version_support.text(analyzer: "standard"),
+              :author => $client.version_support.keyword
             }
           },
           :doc2 => {
             :_source => { :enabled => true }, :_all => { :enabled => false },
             :properties => {
-              :title  => { :type => "string", :analyzer => "standard" },
-              :author => { :type => "string", :index => "not_analyzed" }
+              :title  => $client.version_support.text(analyzer: "standard"),
+              :author => $client.version_support.keyword
             }
           }
         }

data/test/client/native_delete_by_query_test.rb

@@ -0,0 +1,123 @@
+require_relative "../test_helper"
+
+describe Elastomer::Client::NativeDeleteByQuery do
+  before do
+    @index = $client.index "elastomer-delete-by-query-test"
+    @index.delete if @index.exists?
+    @docs = @index.docs("docs")
+  end
+
+  after 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
+
+      it "deletes by query" do
+        @docs.index({ :_id => 0, :name => "mittens" })
+        @docs.index({ :_id => 1, :name => "luna" })
+
+        @index.refresh
+
+        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
+
+      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"
+            }
+          }
+        }
+
+        assert_raises(Elastomer::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
+      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"
+            }
+          }
+        }
+
+        index.refresh
+        response = index.native_delete_by_query(query, routing: "cat")
+
+        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]
+
+        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
+    end
+  end
+end