opensearch-ruby 2.1.0 → 3.0.0

data/test/dsl/integration/search_query_test.rb

@@ -0,0 +1,98 @@
+# 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'
+
+module OpenSearch
+  module Test
+    class QueryIntegrationTest < ::OpenSearch::Test::IntegrationTestCase
+      include OpenSearch::DSL::Search
+
+      context 'Queries integration' do
+        setup do
+          @client.indices.create index: 'test'
+          @client.index index: 'test', id: '1', body: { title: 'Test', tags: ['one'] }
+          @client.index index: 'test', id: '2', body: { title: 'Rest', tags: %w[one two] }
+          @client.indices.refresh index: 'test'
+        end
+
+        context 'for match query' do
+          should 'find the document' do
+            response = @client.search index: 'test', body: search { query { match title: 'test' } }.to_hash
+
+            assert_equal 1, response['hits']['total']['value']
+          end
+        end
+
+        context 'for match_phrase_prefix query' do
+          should 'find the document' do
+            response = @client.search index: 'test', body: search { query { match_phrase_prefix title: 'te' } }.to_hash
+
+            assert_equal 1, response['hits']['total']['value']
+          end
+        end
+
+        context 'for query_string query' do
+          should 'find the document' do
+            response = @client.search index: 'test', body: search { query { query_string { query 'te*' } } }.to_hash
+
+            assert_equal 1, response['hits']['total']['value']
+          end
+        end
+
+        context 'for the bool query' do
+          should 'find the document' do
+            response = @client.search index: 'test', body: search {
+                                                             query do
+                                                               bool do
+                                                                 must   { terms tags: ['one'] }
+                                                                 should { match title: 'Test' }
+                                                               end
+                                                             end
+                                                           }.to_hash
+
+            assert_equal 2, response['hits']['total']['value']
+            assert_equal 'Test', response['hits']['hits'][0]['_source']['title']
+          end
+
+          should 'find the document with a filter' do
+            response = @client.search index: 'test', body: search {
+                                                             query do
+                                                               bool do
+                                                                 filter  { terms tags: ['one'] }
+                                                                 filter  { terms tags: ['two'] }
+                                                               end
+                                                             end
+                                                           }.to_hash
+
+            assert_equal 1, response['hits']['total']['value']
+            assert_equal 'Rest', response['hits']['hits'][0]['_source']['title']
+          end
+        end
+      end
+    end
+  end
+end

data/test/dsl/integration/search_size_from_test.rb

@@ -0,0 +1,71 @@
+# 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'
+
+module OpenSearch
+  module Test
+    class SizeIntegrationTest < ::OpenSearch::Test::IntegrationTestCase
+      include OpenSearch::DSL::Search
+
+      context 'Search results pagination' do
+        setup do
+          @client.indices.create index: 'test', body: {
+            mappings: { properties: { title: { type: 'text', fields: { keyword: { type: 'keyword' } } } } }
+          }
+
+          25.times { |i| @client.index index: 'test', id: i, body: { title: "Test #{format('%03d', i)}" } }
+
+          @client.indices.refresh index: 'test'
+        end
+
+        should 'find the correct number of documents' do
+          response = @client.search index: 'test', body: search {
+            query { match title: 'test' }
+            size 15
+          }.to_hash
+
+          assert_equal 25, response['hits']['total']['value']
+          assert_equal 15, response['hits']['hits'].size
+        end
+
+        should 'move the offset' do
+          response = @client.search index: 'test', body: search {
+            query { match(:title) { query 'test' } }
+            size 5
+            from 5
+            sort { by 'title.keyword' }
+          }.to_hash
+
+          assert_equal 25, response['hits']['total']['value']
+          assert_equal 5,  response['hits']['hits'].size
+          assert_equal 'Test 005', response['hits']['hits'][0]['_source']['title']
+          assert_equal 'Test 009', response['hits']['hits'][4]['_source']['title']
+        end
+      end
+    end
+  end
+end

data/test/dsl/integration/search_sort_test.rb

@@ -0,0 +1,57 @@
+# 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'
+
+module OpenSearch
+  module Test
+    class SortingIntegrationTest < ::OpenSearch::Test::IntegrationTestCase
+      include OpenSearch::DSL::Search
+
+      context 'Sorting integration' do
+        setup do
+          @client.indices.create index: 'test'
+          @client.index index: 'test', id: '1', body: { tags: ['one'], clicks: 15 }
+          @client.index index: 'test', id: '2', body: { tags: %w[one two], clicks: 5 }
+          @client.index index: 'test', id: '3', body: { tags: %w[one three], clicks: 20 }
+          @client.indices.refresh index: 'test'
+        end
+
+        context 'sorting by clicks' do
+          should 'return documents in order' do
+            response = @client.search index: 'test', body: search {
+              sort do
+                by :clicks, order: 'desc'
+              end
+            }.to_hash
+
+            assert_same_elements %w[3 1 2], response['hits']['hits'].map { |d| d['_id'] }
+          end
+        end
+      end
+    end
+  end
+end

data/test/dsl/integration/search_suggest_test.rb

@@ -0,0 +1,107 @@
+# 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.
+
+# encoding: UTF-8
+
+require_relative '../test_helper'
+
+module OpenSearch
+  module Test
+    class SuggestIntegrationTest < ::OpenSearch::Test::IntegrationTestCase
+      include OpenSearch::DSL::Search
+
+      context 'Suggest integration' do
+        setup do
+          @client.indices.create index: 'test', body: {
+            mappings: {
+              properties: {
+                title: { type: 'text' },
+                suggest: {
+                  type: 'object',
+                  properties: {
+                    title: { type: 'completion' },
+                    payload: { type: 'object', enabled: false }
+                  }
+                }
+              }
+            }
+          }
+
+          @client.index index: 'test', id: '1', body: {
+            title: 'One',
+            suggest: {
+              title: { input: %w[one uno jedna] },
+              payload: { id: '1' }
+            }
+          }
+          @client.index index: 'test', id: '2', body: {
+            title: 'Two',
+            suggest: {
+              title: { input: %w[two due dvě] },
+              payload: { id: '2' }
+            }
+          }
+          @client.index index: 'test', id: '3', body: {
+            title: 'Three',
+            suggest: {
+              title: { input: %w[three tres tři] },
+              payload: { id: '3' }
+            }
+          }
+          @client.indices.refresh index: 'test'
+        end
+
+        should 'return suggestions' do
+          s = search do
+            suggest :title, text: 't', completion: { field: 'suggest.title' }
+          end
+
+          response = @client.search index: 'test', body: s.to_hash
+
+          assert_equal 2, response['suggest']['title'][0]['options'].size
+
+          assert_same_elements %w[2 3], response['suggest']['title'][0]['options'].map { |d|
+                                          d['_source']['suggest']['payload']['id']
+                                        }
+        end
+
+        should 'return a single suggestion' do
+          s = search do
+            suggest :title, text: 'th', completion: { field: 'suggest.title' }
+          end
+
+          response = @client.search index: 'test', body: s.to_hash
+
+          assert_equal 1, response['suggest']['title'][0]['options'].size
+
+          assert_same_elements %w[3], response['suggest']['title'][0]['options'].map { |d|
+                                        d['_source']['suggest']['payload']['id']
+                                      }
+        end
+      end
+    end
+  end
+end

data/test/dsl/integration/search_test.rb

@@ -0,0 +1,81 @@
+# 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'
+
+module OpenSearch
+  module Test
+    class SearchIntegrationTest < ::OpenSearch::Test::IntegrationTestCase
+      include OpenSearch::DSL::Search
+
+      class MySearch
+        include OpenSearch::DSL::Search
+
+        def initialize(q)
+          @q = q
+        end
+
+        def tags
+          %w[one two]
+        end
+
+        def search_definition
+          search do |q|
+            q.query do |q|
+              q.bool do |q|
+                q.must do |q|
+                  q.match title: @q
+                end
+                q.must do |q|
+                  q.terms tags: tags
+                end
+              end
+            end
+          end
+        end
+      end
+
+      context 'The Search class' do
+        setup do
+          @client.indices.create index: 'test'
+          @client.index index: 'test', id: '1', body: { title: 'Test', tags: ['one'] }
+          @client.index index: 'test', id: '2', body: { title: 'Test', tags: %w[one two] }
+          @client.index index: 'test', id: '3', body: { title: 'Test', tags: ['three'] }
+          @client.indices.refresh index: 'test'
+        end
+
+        should 'have access to the calling context' do
+          s = MySearch.new('test')
+          response = @client.search index: 'test', body: s.search_definition.to_hash
+
+          assert_equal 2, response['hits']['total']['value']
+          assert_equal 'Test', response['hits']['hits'][0]['_source']['title']
+          assert_same_elements %w[1 2], response['hits']['hits'].map { |d| d['_id'] }
+        end
+      end
+    end
+  end
+end

data/test/dsl/test_helper.rb

@@ -0,0 +1,95 @@
+# 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.fetch('TEST_OPENSEARCH_SERVER', nil) || ENV.fetch('OPENSEARCH_HOSTS', nil)
+                     hosts.split(',').map do |host|
+                       %r{(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.fetch('COVERAGE', nil) || ENV.fetch('CI', nil)
+  require 'simplecov'
+  SimpleCov.start { add_filter '/test|test_' }
+end
+
+require 'minitest/autorun'
+require 'shoulda-context'
+require 'mocha/minitest'
+
+require 'opensearch'
+require 'opensearch/dsl'
+require 'logger'
+require 'ansi'
+
+module OpenSearch
+  module Test
+    module Assertions
+      def assert_nothing_raised(*)
+        yield
+      end
+    end
+
+    class UnitTestCase < ::Minitest::Test
+      include Assertions
+      alias assert_not_nil refute_nil
+      alias assert_raise assert_raises
+    end
+
+    class IntegrationTestCase < ::Minitest::Test
+      include Assertions
+      alias assert_not_nil refute_nil
+      alias assert_raise assert_raises
+
+      def setup
+        @port = (ENV.fetch('TEST_CLUSTER_PORT', nil) || 9250).to_i
+
+        @logger = Logger.new(STDERR)
+        @logger.formatter = proc do |severity, _datetime, _progname, msg|
+          color = case severity
+                  when /INFO/ then :green
+                  when /ERROR|WARN|FATAL/ then :red
+                  when /DEBUG/ then :cyan
+                  else :white
+                  end
+          ANSI.ansi(severity[0] + ' ', color, :faint) + ANSI.ansi(msg, :white, :faint) + "\n"
+        end
+
+        @client = OpenSearch::Client.new(host: "#{TEST_HOST}:#{TEST_PORT}", logger: (ENV['QUIET'] ? nil : @logger))
+        @version = @client.info['version']['number']
+      end
+
+      def teardown
+        @client.indices.delete index: '_all'
+      end
+    end
+  end
+end

data/test/dsl/unit/dsl_test.rb

@@ -0,0 +1,44 @@
+# 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'
+
+module OpenSearch
+  module Test
+    class DSLTest < ::OpenSearch::Test::UnitTestCase
+      context 'The DSL' do
+        class DummyDSLReceiver
+          include OpenSearch::DSL
+        end
+
+        should 'include the module in receiver' do
+          assert_contains DummyDSLReceiver.included_modules, OpenSearch::DSL
+          assert_contains DummyDSLReceiver.included_modules, OpenSearch::DSL::Search
+        end
+      end
+    end
+  end
+end

data/test/dsl/unit/search_aggregation_test.rb

@@ -0,0 +1,96 @@
+# 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'
+
+module OpenSearch
+  module Test
+    class SearchAggregationTest < ::OpenSearch::Test::UnitTestCase
+      subject { OpenSearch::DSL::Search::Aggregation.new }
+
+      context 'Search Aggregation' do
+        should 'be serializable to a Hash' do
+          assert_equal({}, subject.to_hash)
+
+          subject = OpenSearch::DSL::Search::Aggregation.new
+          subject.instance_variable_set(:@value, { foo: 'bar' })
+          assert_equal({ foo: 'bar' }, subject.to_hash)
+        end
+
+        should 'evaluate the block and return itself' do
+          block   = proc { 1 + 1 }
+          subject = OpenSearch::DSL::Search::Aggregation.new(&block)
+
+          subject.expects(:instance_eval)
+          assert_instance_of OpenSearch::DSL::Search::Aggregation, subject.call
+        end
+
+        should 'call the block and return itself' do
+          block   = proc { |_s| 1 + 1 }
+          subject = OpenSearch::DSL::Search::Aggregation.new(&block)
+
+          block.expects(:call)
+          assert_instance_of OpenSearch::DSL::Search::Aggregation, subject.call
+        end
+
+        should 'define the value with DSL methods' do
+          assert_nothing_raised do
+            subject.terms field: 'foo'
+            assert_instance_of Hash, subject.to_hash
+            assert_equal({ terms: { field: 'foo' } }, subject.to_hash)
+          end
+        end
+
+        should 'raise an exception for unknown DSL method' do
+          assert_raise(NoMethodError) { subject.foofoo }
+        end
+
+        should 'return the aggregations' do
+          subject.expects(:call)
+          subject.instance_variable_set(:@value, mock(aggregations: { foo: 'bar' }))
+
+          subject.aggregations
+        end
+
+        should 'define a nested aggregation' do
+          subject.instance_variable_set(:@value, mock(aggregation: true))
+
+          subject.aggregation(:foo) { 1 + 1 }
+        end
+
+        should 'return a non-hashy value directly' do
+          subject.instance_variable_set(:@value, 'FOO')
+          assert_equal 'FOO', subject.to_hash
+        end
+
+        should 'return an empty Hash when it has no value set' do
+          subject.instance_variable_set(:@value, nil)
+          assert_equal({}, subject.to_hash)
+        end
+      end
+    end
+  end
+end