opensearch-dsl 0.1.0

data/test/unit/search_highlight_test.rb

@@ -0,0 +1,103 @@
+# 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 HighlightTest < ::OpenSearch::Test::UnitTestCase
+      context "Search highlight" do
+        subject { OpenSearch::DSL::Search::Highlight.new }
+
+        should "take a Hash" do
+          subject  = OpenSearch::DSL::Search::Highlight.new fields: { 'foo' => {} }, pre_tags: ['*'], post_tags: ['*']
+
+          assert_equal({ fields: { 'foo' => {} }, pre_tags: ['*'], post_tags: ['*'] }, subject.to_hash)
+        end
+
+        should "encode fields as an array" do
+          subject.fields ['foo', 'bar']
+          assert_equal({ fields: { foo: {}, bar: {} } }, subject.to_hash)
+        end
+
+        should "encode fields as a Hash" do
+          subject.fields foo: { bar: 1 }, xoo: { bar: 2 }
+          assert_equal({ fields: { foo: { bar: 1 }, xoo: { bar: 2 } } }, subject.to_hash)
+        end
+
+        should "encode a field" do
+          subject.field 'foo'
+          assert_equal({ fields: { foo: {} } }, subject.to_hash)
+        end
+
+        should "be additive on multiple calls" do
+          subject.fields ['foo', 'bar']
+          subject.field  'bam'
+          subject.field  'baz', { xoo: 10 }
+          assert_equal({ fields: { foo: {}, bar: {}, bam: {}, baz: { xoo: 10 } } }, subject.to_hash)
+        end
+
+        should "encode pre_tags" do
+          subject.pre_tags '*'
+          assert_equal({ pre_tags: ['*'] }, subject.to_hash)
+        end
+
+        should "encode post_tags" do
+          subject.post_tags '*'
+          assert_equal({ post_tags: ['*'] }, subject.to_hash)
+        end
+
+        should "encode pre_tags as an array" do
+          subject.pre_tags ['*', '**']
+          assert_equal({ pre_tags: ['*', '**'] }, subject.to_hash)
+        end
+
+        should "encode post_tags as an array" do
+          subject.post_tags ['*', '**']
+          assert_equal({ post_tags: ['*', '**'] }, subject.to_hash)
+        end
+
+        should "encode the encoder option" do
+          subject.encoder 'foo'
+          assert_equal({ encoder: 'foo' }, subject.to_hash)
+        end
+
+        should "encode the tags_schema option" do
+          subject.tags_schema 'foo'
+          assert_equal({ tags_schema: 'foo' }, subject.to_hash)
+        end
+
+        should "combine the options" do
+          subject.fields ['foo', 'bar']
+          subject.field  'bam'
+          subject.pre_tags '*'
+          subject.post_tags '*'
+          assert_equal({ fields: { foo: {}, bar: {}, bam: {} }, pre_tags: ['*'], post_tags: ['*'] }, subject.to_hash)
+        end
+      end
+    end
+  end
+end

data/test/unit/search_options_test.rb

@@ -0,0 +1,114 @@
+# 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 SearchOptionsTest < ::OpenSearch::Test::UnitTestCase
+      subject { OpenSearch::DSL::Search::Options.new }
+
+      context "Search options" do
+        should "combine different options" do
+          subject.version true
+          subject.min_score 0.5
+
+          assert_equal({version: true, min_score: 0.5}, subject.to_hash)
+        end
+
+        should "encode _source" do
+          subject._source false
+          assert_equal( { _source: false }, subject.to_hash )
+
+          subject._source 'foo.*'
+          assert_equal( { _source: 'foo.*' }, subject.to_hash )
+
+          subject._source ['foo', 'bar']
+          assert_equal( { _source: ['foo', 'bar'] }, subject.to_hash )
+
+          subject._source include: ['foo.*'], exclude: ['bar.*']
+          assert_equal( { _source: { include: ['foo.*'], exclude: ['bar.*'] } }, subject.to_hash )
+
+          subject.source false
+          assert_equal( { _source: false }, subject.to_hash )
+        end
+
+        should "encode fields" do
+          subject.fields ['foo']
+          assert_equal( { fields: ['foo'] }, subject.to_hash )
+        end
+
+        should "encode script_fields" do
+          subject.script_fields ['foo']
+          assert_equal( { script_fields: ['foo'] }, subject.to_hash )
+        end
+
+        should "encode fielddata_fields" do
+          subject.fielddata_fields ['foo']
+          assert_equal( { fielddata_fields: ['foo'] }, subject.to_hash )
+        end
+
+        should "encode rescore" do
+          subject.rescore foo: 'bar'
+          assert_equal( { rescore: { foo: 'bar' } }, subject.to_hash )
+        end
+
+        should "encode explain" do
+          subject.explain true
+          assert_equal( { explain: true }, subject.to_hash )
+        end
+
+        should "encode version" do
+          subject.version true
+          assert_equal( { version: true }, subject.to_hash )
+        end
+
+        should "encode track_total_hits" do
+          subject.track_total_hits 123
+          assert_equal( { track_total_hits: 123 }, subject.to_hash )
+
+          subject.track_total_hits true
+          assert_equal( { track_total_hits: true }, subject.to_hash )
+        end
+
+        should "encode indices_boost" do
+          subject.indices_boost foo: 'bar'
+          assert_equal( { indices_boost: { foo: 'bar' } }, subject.to_hash )
+        end
+
+        should "encode track_scores" do
+          subject.track_scores true
+          assert_equal( { track_scores: true }, subject.to_hash )
+        end
+
+        should "encode min_score" do
+          subject.min_score 0.5
+          assert_equal( { min_score: 0.5 }, subject.to_hash )
+        end
+      end
+    end
+  end
+end

data/test/unit/search_query_test.rb

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

data/test/unit/search_size_from_test.rb

@@ -0,0 +1,69 @@
+# 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 SearchSizeTest < ::OpenSearch::Test::UnitTestCase
+      context "Search pagination" do
+
+        should "encode the size parameter" do
+          subject = OpenSearch::DSL::Search::Search.new do
+            size 5
+          end
+          assert_equal( { size: 5 }, subject.to_hash )
+        end
+
+        should "encode the from parameter" do
+          subject = OpenSearch::DSL::Search::Search.new do
+            from 5
+          end
+          assert_equal( { from: 5 }, subject.to_hash )
+        end
+
+        should "have getter methods" do
+          subject = OpenSearch::DSL::Search::Search.new
+          assert_nil subject.size
+          assert_nil subject.from
+          subject.size = 5
+          subject.from = 5
+          assert_equal 5, subject.size
+          assert_equal 5, subject.from
+        end
+
+        should "have setter methods" do
+          subject = OpenSearch::DSL::Search::Search.new
+          subject.size = 5
+          subject.from = 5
+          assert_equal 5, subject.size
+          assert_equal 5, subject.from
+          assert_equal( { size: 5, from: 5 }, subject.to_hash )
+        end
+      end
+    end
+  end
+end

data/test/unit/search_sort_test.rb

@@ -0,0 +1,91 @@
+# 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 SearchSortTest < ::OpenSearch::Test::UnitTestCase
+      subject { OpenSearch::DSL::Search::Sort.new }
+
+      context "Search sort" do
+
+        should "add a single field" do
+          subject = OpenSearch::DSL::Search::Sort.new :foo
+          assert_equal( [:foo], subject.to_hash )
+        end
+
+        should "add multiple fields" do
+          subject = OpenSearch::DSL::Search::Sort.new [:foo, :bar]
+          assert_equal( [:foo, :bar], subject.to_hash )
+        end
+
+        should "add a field with options" do
+          subject = OpenSearch::DSL::Search::Sort.new foo: { order: 'desc', mode: 'avg' }
+          assert_equal( [ { foo: { order: 'desc', mode: 'avg' } } ], subject.to_hash )
+        end
+
+        should "add fields with the DSL method" do
+          subject = OpenSearch::DSL::Search::Sort.new do
+            by :foo
+            by :bar, order: 'desc'
+          end
+
+          assert_equal(
+            [
+              :foo,
+              { bar: { order: 'desc' } },
+            ], subject.to_hash )
+        end
+
+        should "be empty" do
+          subject = OpenSearch::DSL::Search::Sort.new
+          assert_equal subject.empty?, true
+        end
+
+        should "not be empty" do
+          subject = OpenSearch::DSL::Search::Sort.new foo: { order: 'desc' }
+          assert_equal subject.empty?, false
+        end
+
+        context "#to_hash" do
+          should "not duplicate values when defined by arguments" do
+            subject = OpenSearch::DSL::Search::Sort.new foo: { order: 'desc' }
+            assert_equal(subject.to_hash, subject.to_hash)
+          end
+
+          should "not duplicate values when defined by a block" do
+            subject = OpenSearch::DSL::Search::Sort.new do
+              by :foo
+            end
+
+            assert_equal(subject.to_hash, subject.to_hash)
+          end
+        end
+      end
+    end
+  end
+end

data/test/unit/search_suggest_test.rb

@@ -0,0 +1,46 @@
+# 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 SearchSuggestTest < ::OpenSearch::Test::UnitTestCase
+      subject { OpenSearch::DSL::Search::Suggest.new :foo }
+
+      context "Search suggest" do
+        should "be an empty hash by default" do
+          assert_equal({ foo: {} }, subject.to_hash)
+        end
+
+        should "contain options" do
+          subject = OpenSearch::DSL::Search::Suggest.new :foo, boo: 'bam'
+          assert_equal({ foo: { boo: 'bam' } }, subject.to_hash)
+        end
+      end
+    end
+  end
+end