opensearch-dsl 0.1.0

data/test/integration/search_test.rb

@@ -0,0 +1,82 @@
+# 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 '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: ['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 ['1', '2'], response['hits']['hits'].map { |d| d['_id'] }
+        end
+      end
+    end
+  end
+end

data/test/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['TEST_OPENSEARCH_SERVER'] || ENV['OPENSEARCH_HOSTS']
+                        hosts.split(',').map do |host|
+                          /(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['COVERAGE'] || ENV['CI']
+  require 'simplecov'
+  SimpleCov.start { add_filter "/test|test_" }
+end
+
+require 'minitest/autorun'
+require 'shoulda-context'
+require 'mocha/setup'
+
+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_method :assert_not_nil, :refute_nil
+      alias_method :assert_raise, :assert_raises
+    end
+
+    class IntegrationTestCase < ::Minitest::Test
+      include Assertions
+      alias_method :assert_not_nil, :refute_nil
+      alias_method :assert_raise, :assert_raises
+
+      def setup
+        @port = (ENV['TEST_CLUSTER_PORT'] || 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/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 '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/unit/search_aggregation_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 '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.new { 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.new { |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

data/test/unit/search_base_aggregation_component_test.rb

@@ -0,0 +1,67 @@
+# 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 'test_helper'
+
+module OpenSearch
+  module Test
+    class BaseAggregationComponentTest < ::OpenSearch::Test::UnitTestCase
+      context "BaseAggregationComponent" do
+
+        class DummyAggregationComponent
+          include ::OpenSearch::DSL::Search::BaseAggregationComponent
+        end
+
+        class ::OpenSearch::DSL::Search::Aggregations::Dummy
+          include ::OpenSearch::DSL::Search::BaseAggregationComponent
+        end
+
+        subject { DummyAggregationComponent.new }
+
+        should "return an instance of the aggregation by name" do
+          assert_instance_of ::OpenSearch::DSL::Search::Aggregations::Dummy, subject.dummy
+        end
+
+        should "raise an exception when unknown aggregation is called" do
+          assert_raise(NoMethodError) { subject.foobar }
+        end
+
+        should "add a nested aggregation" do
+          subject.aggregation :inner do
+            dummy field: 'foo'
+          end
+
+          assert ! subject.aggregations.empty?, "#{subject.aggregations.inspect} is empty"
+
+          assert_instance_of OpenSearch::DSL::Search::Aggregation, subject.aggregations[:inner]
+          assert_equal( {:dummy=>{:field=>"foo"}}, subject.aggregations[:inner].to_hash )
+
+          assert_equal 'foo', subject.to_hash[:aggregations][:inner][:dummy][:field]
+        end
+      end
+    end
+  end
+end

data/test/unit/search_base_component_test.rb

@@ -0,0 +1,212 @@
+# 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 'test_helper'
+
+module OpenSearch
+  module Test
+    class BaseComponentTest < ::OpenSearch::Test::UnitTestCase
+      context "BaseComponent" do
+
+        class DummyComponent
+          include OpenSearch::DSL::Search::BaseComponent
+        end
+
+        class DummyComponentWithAName
+          include OpenSearch::DSL::Search::BaseComponent
+          name :foo
+        end
+
+        class DummyComponentWithNewName
+          include OpenSearch::DSL::Search::BaseComponent
+        end
+
+        class DummyCompoundFilter
+          include OpenSearch::DSL::Search::BaseCompoundFilterComponent
+        end
+
+        subject { DummyComponent.new :foo }
+
+        should "have a name" do
+          assert_equal :dummy_component, DummyComponent.new.name
+        end
+
+        should "have a custom name" do
+          assert_equal :foo, DummyComponentWithAName.new.name
+        end
+
+        should "allow to set a name" do
+          DummyComponentWithNewName.name :foo
+          assert_equal :foo, DummyComponentWithNewName.new.name
+          assert_equal :foo, DummyComponentWithNewName.name
+
+          DummyComponentWithNewName.name = :bar
+          assert_equal :bar, DummyComponentWithNewName.name
+          assert_equal :bar, DummyComponentWithNewName.new.name
+        end
+
+        should "initialize the hash" do
+          assert_instance_of Hash, subject.to_hash
+        end
+
+        should "have an empty Hash as args by default" do
+          subject = DummyComponentWithNewName.new
+          assert_equal({}, subject.instance_variable_get(:@args))
+        end
+
+        should "have an option method with args" do
+          class DummyComponentWithOptionMethod
+            include OpenSearch::DSL::Search::BaseComponent
+            option_method :bar
+          end
+
+          subject = DummyComponentWithOptionMethod.new :foo
+          assert_respond_to subject, :bar
+
+          subject.bar 'BAM'
+          assert_equal({ dummy_component_with_option_method: { foo: { bar: 'BAM' } } }, subject.to_hash)
+        end
+
+        should "keep track of option methods" do
+          class DummyComponentWithCustomOptionMethod
+            include OpenSearch::DSL::Search::BaseComponent
+            option_method :foo
+          end
+
+          subject = DummyComponentWithCustomOptionMethod
+          assert_includes subject.option_methods, :foo
+        end
+
+        should "have an option method without args" do
+          class DummyComponentWithOptionMethod
+            include OpenSearch::DSL::Search::BaseComponent
+            option_method :bar
+          end
+
+          subject = DummyComponentWithOptionMethod.new
+          assert_respond_to subject, :bar
+
+          subject.bar 'BAM'
+          assert_equal({ dummy_component_with_option_method: { bar: 'BAM' } }, subject.to_hash)
+        end
+
+        should "define a custom option method" do
+          class DummyComponentWithCustomOptionMethod
+            include OpenSearch::DSL::Search::BaseComponent
+            option_method :bar, lambda { |*args| @hash = { :foo => 'bar' } }
+          end
+
+          subject = DummyComponentWithCustomOptionMethod.new
+          subject.bar
+
+          assert_equal 'bar', subject.instance_variable_get(:@hash)[:foo]
+        end
+
+        should "execute the passed block" do
+          subject = DummyComponent.new(:foo) { @foo = 'BAR' }
+
+          assert_respond_to  subject, :call
+          assert_instance_of DummyComponent, subject.call
+          assert_equal       'BAR', subject.instance_variable_get(:@foo)
+        end
+
+        should "respond to empty?" do
+          assert DummyComponent.new.empty?
+          assert DummyComponent.new(:foo).empty?
+
+          subject = DummyComponent.new(:foo) { @hash = { foo: 'bar' } }
+          assert ! subject.empty?
+        end
+
+        context "to_hash conversion" do
+
+          should "build the hash with the block with args" do
+            subject = DummyComponent.new :foo do
+              @hash[:dummy_component][:foo].update moo: 'xoo'
+            end
+
+            assert_equal({dummy_component: { foo: { moo: 'xoo' } } }, subject.to_hash )
+          end
+
+          should "build the hash with the block without args" do
+            subject = DummyComponent.new do
+              @hash[:dummy_component].update moo: 'xoo'
+            end
+
+            assert_equal({dummy_component: { moo: 'xoo' } }, subject.to_hash )
+          end
+
+          should "build the hash with the option method" do
+            class DummyComponentWithOptionMethod
+              include OpenSearch::DSL::Search::BaseComponent
+              option_method :foo
+            end
+
+            subject = DummyComponentWithOptionMethod.new do
+              foo 'bar'
+            end
+
+            assert_equal({ dummy_component_with_option_method: { foo: 'bar' } }, subject.to_hash)
+          end
+
+          should "build the hash with the passed args" do
+            subject = DummyComponent.new foo: 'bar'
+
+            assert_equal({ dummy_component: { foo: 'bar' } }, subject.to_hash)
+          end
+
+          should "merge the top-level options to the hash" do
+            class DummyComponentWithOptionMethod
+              include OpenSearch::DSL::Search::BaseComponent
+              option_method :bar
+            end
+
+            subject = DummyComponentWithOptionMethod.new :foo, xoo: 'X' do
+              bar 'B'
+            end
+
+            assert_equal({ dummy_component_with_option_method: { xoo: 'X', foo: { bar: 'B' } } }, subject.to_hash)
+          end
+
+          should "return the already built hash" do
+            subject = DummyComponent.new
+            subject.instance_variable_set(:@hash, { foo: 'bar' })
+
+            assert_equal({ foo: 'bar' }, subject.to_hash)
+          end
+        end
+
+        context "compound filter" do
+          subject { DummyCompoundFilter.new }
+
+          should "raise an exception for unknown DSL method" do
+            assert_raise(NoMethodError) { subject.foofoo }
+          end
+        end
+      end
+    end
+  end
+end

data/test/unit/search_filter_test.rb

@@ -0,0 +1,87 @@
+# 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 'test_helper'
+
+module OpenSearch
+  module Test
+    class SearchFilterTest < ::OpenSearch::Test::UnitTestCase
+      subject { OpenSearch::DSL::Search::Filter.new }
+
+      context "Search Filter" do
+
+        should "be serializable to a Hash" do
+          assert_equal( {}, subject.to_hash )
+
+          subject = OpenSearch::DSL::Search::Filter.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.new { 1+1 }
+          subject = OpenSearch::DSL::Search::Filter.new &block
+
+          subject.expects(:instance_eval)
+          assert_instance_of OpenSearch::DSL::Search::Filter, subject.call
+        end
+
+        should "call the block and return itself" do
+          block   = Proc.new { |s| 1+1 }
+          subject = OpenSearch::DSL::Search::Filter.new &block
+
+          block.expects(:call)
+          assert_instance_of OpenSearch::DSL::Search::Filter, subject.call
+        end
+
+        should "define the value with filter methods" do
+          assert_nothing_raised do
+            subject.term foo: 'bar'
+            assert_instance_of Hash, subject.to_hash
+            assert_equal( { term: { foo: 'bar' } }, subject.to_hash )
+          end
+        end
+
+        should "redefine the value with filter methods" do
+          assert_nothing_raised do
+            subject.term foo: 'bar'
+            subject.term foo: 'bam'
+            subject.to_hash
+            subject.to_hash
+            assert_instance_of Hash, subject.to_hash
+            assert_equal({ term: { foo: 'bam' } }, subject.to_hash)
+          end
+        end
+
+        should "raise an exception for unknown filter" do
+          assert_raise(NoMethodError) { subject.foofoo }
+        end
+
+      end
+
+    end
+  end
+end