elastomer-client 0.3.1

data/test/client/cluster_test.rb

@@ -0,0 +1,113 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+describe Elastomer::Client::Cluster do
+
+  before do
+    @name = 'elastomer-cluster-test'
+    @index = $client.index @name
+    @index.delete if @index.exists?
+    @cluster = $client.cluster
+  end
+
+  after do
+    @index.delete if @index.exists?
+  end
+
+  it 'gets the cluster health' do
+    h = @cluster.health
+    assert h.key?('cluster_name'), 'the cluster name is returned'
+    assert h.key?('status'), 'the cluster status is returned'
+  end
+
+  it 'gets the cluster state' do
+    h = @cluster.state
+    assert h.key?('cluster_name'), 'the cluster name is returned'
+    assert h.key?('master_node'), 'the master node is returned'
+    assert_instance_of Hash, h['nodes'], 'the node list is returned'
+  end
+
+  it 'gets the cluster settings' do
+    h = @cluster.settings
+    assert_instance_of Hash, h['persistent'], 'the persistent settings are returned'
+    assert_instance_of Hash, h['transient'], 'the transient settings are returned'
+  end
+
+  it 'updates the cluster settings' do
+    @cluster.update_settings :transient => { 'indices.ttl.interval' => "30" }
+    h = @cluster.settings
+
+    #COMPATIBILITY
+    # ES 1.0 changed the default return format of cluster settings to always
+    # expand nested properties, e.g.
+    # {"indices.ttl.interval": "30"} changed to
+    # {"indices": {"ttl": {"interval":"30"}}}
+
+    # To support both versions, we check for either return format.
+    value = h['transient']['indices.ttl.interval'] ||
+            h['transient']['indices']['ttl']['interval']
+    assert_equal "30", value
+
+    @cluster.update_settings :transient => { 'indices.ttl.interval' => "60" }
+    h = @cluster.settings
+
+    value = h['transient']['indices.ttl.interval'] ||
+            h['transient']['indices']['ttl']['interval']
+    assert_equal "60", value
+  end
+
+  it 'returns the list of nodes in the cluster' do
+    nodes = @cluster.nodes
+    assert !nodes.empty?, 'we have to have some nodes'
+  end
+
+  describe 'when working with aliases' do
+    before do
+      @name = 'elastomer-cluster-test'
+      @index = $client.index @name
+      @index.create({}) unless @index.exists?
+      wait_for_index(@name)
+    end
+
+    after do
+      @index.delete if @index.exists?
+    end
+
+    it 'adds an alias' do
+      hash = @cluster.get_aliases
+      assert_empty hash[@name]['aliases']
+
+      @cluster.update_aliases \
+        :add => {:index => @name, :alias => 'elastomer-test-unikitty'}
+
+      hash = @cluster.get_aliases
+      assert_equal ['elastomer-test-unikitty'], hash[@name]['aliases'].keys
+    end
+
+    it 'removes an alias' do
+      @cluster.update_aliases \
+        :add => {:index => @name, :alias => 'elastomer-test-unikitty'}
+
+      hash = @cluster.get_aliases
+      assert_equal ['elastomer-test-unikitty'], hash[@name]['aliases'].keys
+
+      @cluster.update_aliases([
+        {:add    => {:index => @name, :alias => 'elastomer-test-SpongeBob-SquarePants'}},
+        {:remove => {:index => @name, :alias => 'elastomer-test-unikitty'}}
+      ])
+
+      hash = @cluster.get_aliases
+      assert_equal ['elastomer-test-SpongeBob-SquarePants'], hash[@name]['aliases'].keys
+    end
+
+    it 'accepts the full aliases actions hash' do
+      @cluster.update_aliases :actions => [
+        {:add => {:index => @name, :alias => 'elastomer-test-He-Man'}},
+        {:add => {:index => @name, :alias => 'elastomer-test-Skeletor'}}
+      ]
+
+      hash = @cluster.get_aliases(:index => @name)
+      assert_equal %w[elastomer-test-He-Man elastomer-test-Skeletor], hash[@name]['aliases'].keys.sort
+    end
+  end
+
+end

data/test/client/docs_test.rb

@@ -0,0 +1,394 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+describe Elastomer::Client::Docs do
+
+  before do
+    @name  = 'elastomer-docs-test'
+    @index = $client.index(@name)
+
+    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  => { :type => 'string', :analyzer => 'standard' },
+              :author => { :type => 'string', :index => 'not_analyzed' }
+            }
+          },
+          :doc2 => {
+            :_source => { :enabled => true }, :_all => { :enabled => false },
+            :properties => {
+              :title  => { :type => 'string', :analyzer => 'standard' },
+              :author => { :type => 'string', :index => 'not_analyzed' }
+            }
+          }
+        }
+
+      wait_for_index(@name)
+    end
+
+    @docs = @index.docs
+  end
+
+  after do
+    @index.delete if @index.exists?
+  end
+
+  it 'autogenerates IDs for documents' do
+    h = @docs.index \
+          :_type  => 'doc2',
+          :title  => 'the author of logging',
+          :author => 'pea53'
+
+    assert_created h
+    assert_match %r/^\S{22}$/, h['_id']
+
+    h = @docs.index \
+          :_id    => nil,
+          :_type  => 'doc3',
+          :title  => 'the author of rubber-band',
+          :author => 'grantr'
+
+    assert_created h
+    assert_match %r/^\S{22}$/, h['_id']
+
+    h = @docs.index \
+          :_id    => '',
+          :_type  => 'doc4',
+          :title  => 'the author of toml',
+          :author => 'mojombo'
+
+    assert_created h
+    assert_match %r/^\S{22}$/, h['_id']
+  end
+
+  it 'uses the provided document ID' do
+    h = @docs.index \
+          :_id    => '42',
+          :_type  => 'doc2',
+          :title  => 'the author of logging',
+          :author => 'pea53'
+
+    assert_created h
+    assert_equal '42', h['_id']
+  end
+
+  it 'accepts JSON encoded document strings' do
+    h = @docs.index \
+          '{"author":"pea53", "title":"the author of logging"}',
+          :id   => '42',
+          :type => 'doc2'
+
+    assert_created h
+    assert_equal '42', h['_id']
+
+    h = @docs.index \
+          '{"author":"grantr", "title":"the author of rubber-band"}',
+          :type => 'doc2'
+
+    assert_created h
+    assert_match %r/^\S{22}$/, h['_id']
+  end
+
+  it 'gets documents from the search index' do
+    h = @docs.get :id => '1', :type => 'doc1'
+    refute_found h
+
+    populate!
+
+    h = @docs.get :id => '1', :type => 'doc1'
+    assert_found h
+    assert_equal 'mojombo', h['_source']['author']
+  end
+
+  it 'gets multiple documents from the search index' do
+    populate!
+
+    h = @docs.multi_get :docs => [
+      { :_id => 1, :_type => 'doc1' },
+      { :_id => 1, :_type => 'doc2' }
+    ]
+    authors = h['docs'].map { |d| d['_source']['author'] }
+    assert_equal %w[mojombo pea53], authors
+
+    h = @docs.multi_get :ids => [2, 1], :_type => 'doc1'
+    authors = h['docs'].map { |d| d['_source']['author'] }
+    assert_equal %w[defunkt mojombo], authors
+
+    h = @index.docs('doc1').multi_get :ids => [1, 2, 3, 4]
+    assert_found h['docs'][0]
+    assert_found h['docs'][1]
+    refute_found h['docs'][2]
+    refute_found h['docs'][3]
+  end
+
+  it 'deletes documents from the search index' do
+    populate!
+    @docs = @index.docs('doc2')
+
+    h = @docs.multi_get :ids => [1, 2]
+    authors = h['docs'].map { |d| d['_source']['author'] }
+    assert_equal %w[pea53 grantr], authors
+
+    h = @docs.delete :id => 1
+    assert h['found'], "expected document to be found"
+    h = @docs.multi_get :ids => [1, 2]
+    refute_found h['docs'][0]
+    assert_found h['docs'][1]
+
+    assert_raises(ArgumentError) { @docs.delete :id => nil }
+    assert_raises(ArgumentError) { @docs.delete :id => '' }
+    assert_raises(ArgumentError) { @docs.delete :id => "\t" }
+  end
+
+  it 'does not care if you delete a document that is not there' do
+    @docs = @index.docs('doc2')
+    h = @docs.delete :id => 42
+
+    refute h['found'], 'expected document to not be found'
+  end
+
+  it 'deletes documents by query' do
+    populate!
+    @docs = @index.docs('doc2')
+
+    h = @docs.multi_get :ids => [1, 2]
+    authors = h['docs'].map { |d| d['_source']['author'] }
+    assert_equal %w[pea53 grantr], authors
+
+    h = @docs.delete_by_query(:q => "author:grantr")
+    @index.refresh
+    h = @docs.multi_get :ids => [1, 2]
+    assert_found h['docs'][0]
+    refute_found h['docs'][1]
+
+    #COMPATIBILITY
+    # ES 1.0 normalized all search APIs to use a :query top level element.
+    # This broke compatibility with the ES 0.90 delete_by_query api. Since
+    # the query hash version of this api never worked with 0.90 in the first
+    # place, only test it if running 1.0.
+    if es_version_1_x?
+      h = @docs.delete_by_query(
+            :query => {
+              :filtered => {
+                :query => {:match_all => {}},
+                :filter => {:term => {:author => 'pea53'}}
+              }
+            }
+          )
+      @index.refresh
+      h = @docs.multi_get :ids => [1, 2]
+      refute_found h['docs'][0]
+      refute_found h['docs'][1]
+    end
+  end
+
+  it 'searches for documents' do
+    h = @docs.search :q => '*:*'
+    assert_equal 0, h['hits']['total']
+
+    populate!
+
+    h = @docs.search :q => '*:*'
+    assert_equal 4, h['hits']['total']
+
+    h = @docs.search :q => '*:*', :type => 'doc1'
+    assert_equal 2, h['hits']['total']
+
+    h = @docs.search({
+      :query => {:match_all => {}},
+      :filter => {:term => {:author => 'defunkt'}}
+    }, :type => %w[doc1 doc2] )
+    assert_equal 1, h['hits']['total']
+
+    hit = h['hits']['hits'].first
+    assert_equal 'the author of resque', hit['_source']['title']
+  end
+
+  it 'counts documents' do
+    h = @docs.count :q => '*:*'
+    assert_equal 0, h['count']
+
+    populate!
+
+    h = @docs.count :q => '*:*'
+    assert_equal 4, h['count']
+
+    h = @docs.count :q => '*:*', :type => 'doc1'
+    assert_equal 2, h['count']
+
+    h = @docs.count :q => '*:*', :type => 'doc1,doc2'
+    assert_equal 4, h['count']
+
+    #COMPATIBILITY
+    # ES 1.0 normalized all search APIs to use a :query top level element.
+    # This broke compatibility with the ES 0.90 count api.
+    if es_version_1_x?
+      h = @docs.count({
+        :query => {
+          :filtered => {
+            :query => {:match_all => {}},
+            :filter => {:term => {:author => 'defunkt'}}
+          }
+        }
+      }, :type => %w[doc1 doc2] )
+    else
+      h = @docs.count({
+        :filtered => {
+          :query => {:match_all => {}},
+          :filter => {:term => {:author => 'defunkt'}}
+        }
+      }, :type => %w[doc1 doc2] )
+    end
+    assert_equal 1, h['count']
+  end
+
+  it 'searches for more like this' do
+    populate!
+
+    # for some reason, if there's no document indexed here all the mlt
+    # queries return zero results
+    @docs.add \
+      :_id    => 3,
+      :_type  => 'doc1',
+      :title  => 'the author of faraday',
+      :author => 'technoweenie'
+
+    @index.refresh
+
+    h = @docs.more_like_this({
+      :type => 'doc1',
+      :id   => 1,
+      :mlt_fields    => 'title',
+      :min_term_freq => 1
+    })
+    assert_equal 2, h["hits"]["total"]
+
+    h = @docs.more_like_this({
+      :facets => {
+        "author" => {
+          :terms => {
+            :field => "author"
+          }
+        }
+      }
+    }, {
+      :type => 'doc1',
+      :id   => 1,
+      :mlt_fields    => 'title,author',
+      :min_term_freq => 1
+    })
+    assert_equal 2, h["hits"]["total"]
+    assert_equal 2, h["facets"]["author"]["total"]
+  end
+
+  it 'explains scoring' do
+    populate!
+
+    h = @docs.explain({
+      :query => {
+        :match => {
+          "author" => "defunkt"
+        }
+      }
+    }, :type => 'doc1', :id => 2)
+    assert_equal true, h["matched"]
+
+    h = @docs.explain(:type => 'doc2', :id => 2, :q => "pea53")
+    assert_equal false, h["matched"]
+  end
+
+  it 'validates queries' do
+    populate!
+
+    h = @docs.validate :q => '*:*'
+    assert_equal true, h["valid"]
+
+    #COMPATIBILITY
+    # ES 1.0 normalized all search APIs to use a :query top level element.
+    # This broke compatibility with the ES 0.90 validate api.
+    if es_version_1_x?
+      h = @docs.validate({
+        :query => {
+          :filtered => {
+            :query => {:match_all => {}},
+            :filter => {:term => {:author => 'defunkt'}}
+          }
+        }
+      }, :type => %w[doc1 doc2] )
+    else
+      h = @docs.validate({
+        :filtered => {
+          :query => {:match_all => {}},
+          :filter => {:term => {:author => 'defunkt'}}
+        }
+      }, :type => %w[doc1 doc2] )
+    end
+    assert_equal true, h["valid"]
+  end
+
+  it 'updates documents' do
+    populate!
+
+    h = @docs.get :id => '1', :type => 'doc1'
+    assert_found h
+    assert_equal 'mojombo', h['_source']['author']
+
+    @docs.update({
+      :_id   => '1',
+      :_type => 'doc1',
+      :doc   => {:author => 'TwP'}
+    })
+    h = @docs.get :id => '1', :type => 'doc1'
+    assert_found h
+    assert_equal 'TwP', h['_source']['author']
+
+    if $client.version >= "0.90"
+      @docs.update({
+        :_id   => '42',
+        :_type => 'doc1',
+        :doc   => {
+          :author => 'TwP',
+          :title  => 'the ineffable beauty of search'
+        },
+        :doc_as_upsert => true
+      })
+
+      h = @docs.get :id => '42', :type => 'doc1'
+      assert_found h
+      assert_equal 'TwP', h['_source']['author']
+      assert_equal 'the ineffable beauty of search', h['_source']['title']
+    end
+  end
+
+  def populate!
+    @docs.add \
+      :_id    => 1,
+      :_type  => 'doc1',
+      :title  => 'the author of gravatar',
+      :author => 'mojombo'
+
+    @docs.add \
+      :_id    => 2,
+      :_type  => 'doc1',
+      :title  => 'the author of resque',
+      :author => 'defunkt'
+
+    @docs.add \
+      :_id    => 1,
+      :_type  => 'doc2',
+      :title  => 'the author of logging',
+      :author => 'pea53'
+
+    @docs.add \
+      :_id    => 2,
+      :_type  => 'doc2',
+      :title  => 'the author of rubber-band',
+      :author => 'grantr'
+
+    @index.refresh
+  end
+
+end