opensearch-api 1.0.0

data/spec/opensearch/api/actions/tasks/get_spec.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 'spec_helper'
+
+describe 'client.tasks#get' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        '_tasks/foo1',
+        {},
+        nil,
+        {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.tasks.get(task_id: 'foo1')).to eq({})
+  end
+end

data/spec/opensearch/api/actions/tasks/list_spec.rb

@@ -0,0 +1,48 @@
+# 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 'spec_helper'
+
+describe 'client.tasks#list' do
+
+  let(:expected_args) do
+    [
+        'GET',
+        url,
+        {},
+        nil,
+        {}
+    ]
+  end
+
+  let(:url) do
+    '_tasks'
+  end
+
+  it 'performs the request' do
+    expect(client_double.tasks.list).to eq({})
+  end
+end

data/spec/opensearch/api/actions/termvectors_spec.rb

@@ -0,0 +1,75 @@
+# 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 'spec_helper'
+
+describe 'client#termvectors' do
+  let(:expected_args) do
+    [
+      'POST',
+      url,
+      params,
+      body,
+      {}
+    ]
+  end
+
+  let(:url) do
+    'foo/bar/123/_termvectors'
+  end
+
+  let(:params) do
+    {}
+  end
+
+  let(:body) do
+    {}
+  end
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  it 'requires the :index argument' do
+    expect {
+      client.termvectors(type: 'bar', id: '1')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'performs the request' do
+    expect(client_double.termvectors(index: 'foo', type: 'bar', id: '123', body: {})).to eq({})
+  end
+
+  context 'when the older api name \'termvector\' is used' do
+    let(:url) do
+      'foo/bar/123/_termvector'
+    end
+
+    it 'performs the request' do
+      expect(client_double.termvector(index: 'foo', type: 'bar', id: '123', body: {})).to eq({})
+    end
+  end
+end

data/spec/opensearch/api/actions/update_by_query_spec.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 'spec_helper'
+
+describe 'client#update_by_query' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        'foo/_update_by_query',
+        {},
+        nil,
+        {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.update_by_query(index: 'foo')).to eq({})
+  end
+end

data/spec/opensearch/api/actions/update_document_spec.rb

@@ -0,0 +1,131 @@
+# 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 'spec_helper'
+
+describe 'client#update' do
+
+  let(:expected_args) do
+    [
+        'POST',
+        url,
+        params,
+        body,
+        {}
+    ]
+  end
+
+  let(:body) do
+    { doc: { } }
+  end
+
+  let(:url) do
+    'foo/bar/1/_update'
+  end
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  let(:params) do
+    {}
+  end
+
+  it 'requires the :index argument' do
+    expect {
+      client.update(type: 'bar', id: '1')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :id argument' do
+    expect {
+      client.update(index: 'foo', type: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'performs the request' do
+    expect(client_double.update(index: 'foo', type: 'bar', id: '1', body: { doc: {} })).to eq({})
+  end
+
+  context 'when URL parameters are provided' do
+
+    let(:url) do
+      'foo/bar/1/_update'
+    end
+
+    let(:body) do
+      {}
+    end
+
+    it 'performs the request' do
+      expect(client_double.update(index: 'foo', type: 'bar', id: '1', body: {}))
+    end
+  end
+
+  context 'when invalid parameters are specified' do
+
+    it 'raises an ArgumentError' do
+      expect {
+        client.update(index: 'foo', type: 'bar', id: '1', body: { doc: {} }, qwertypoiuy: 'asdflkjhg')
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when the request needs to be URL-escaped' do
+
+    let(:url) do
+      'foo%5Ebar/bar%2Fbam/1/_update'
+    end
+
+    let(:body) do
+      {}
+    end
+
+    it 'escapes the parts' do
+      expect(client_double.update(index: 'foo^bar', type: 'bar/bam', id: '1', body: {}))
+    end
+  end
+
+  context 'when a NotFound exception is raised' do
+
+    before do
+      allow(client).to receive(:perform_request).and_raise(NotFound)
+    end
+
+    it 'raises it to the user' do
+      expect {
+        client.update(index: 'foo', type: 'bar', id: 'XXX', body: {})
+      }.to raise_exception(NotFound)
+    end
+
+    context 'when the :ignore parameter is specified' do
+
+      it 'does not raise the error to the user' do
+        expect(client.update(index: 'foo', type: 'bar', id: 'XXX', body: {}, ignore: 404)).to eq(false)
+      end
+    end
+  end
+end

data/spec/opensearch/api/api_spec.rb

@@ -0,0 +1,52 @@
+# 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 'spec_helper'
+
+describe OpenSearch::API do
+
+  describe '#settings' do
+
+    it 'allows access to settings' do
+      expect(described_class.settings).not_to be_nil
+    end
+
+    it 'has a default serializer' do
+      expect(OpenSearch::API.serializer).to eq(MultiJson)
+    end
+
+    context 'when settings are changed' do
+
+      before do
+        OpenSearch::API.settings[:foo] = 'bar'
+      end
+
+      it 'changes the settings' do
+        expect(OpenSearch::API.settings[:foo]).to eq('bar')
+      end
+    end
+  end
+end

data/spec/opensearch/api/client_spec.rb

@@ -0,0 +1,55 @@
+# 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 'spec_helper'
+
+describe 'API Client' do
+
+  let(:client) do
+    Class.new { include OpenSearch::API }.new
+  end
+
+  describe '#cluster' do
+
+    it 'responds to the method' do
+      expect(client.respond_to?(:cluster)).to be(true)
+    end
+  end
+
+  describe '#indices' do
+
+    it 'responds to the method' do
+      expect(client.respond_to?(:indices)).to be(true)
+    end
+  end
+
+  describe '#bulk' do
+
+    it 'responds to the method' do
+      expect(client.respond_to?(:bulk)).to be(true)
+    end
+  end
+end

data/spec/opensearch/api/rest_api_yaml_spec.rb

@@ -0,0 +1,169 @@
+# 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 'spec_helper'
+require 'rest_yaml_tests_helper'
+
+describe 'Rest API YAML tests' do
+  if REST_API_YAML_FILES.empty?
+    logger = Logger.new($stdout)
+    logger.error 'No test files found!'
+    logger.info 'Use rake rake opensearch:download_artifacts in the root directory of the project to download the test artifacts.'
+    exit 1
+  end
+
+  # Traverse YAML files and create TestFile object:
+  REST_API_YAML_FILES.each do |file|
+    begin
+      test_file = OpenSearch::RestAPIYAMLTests::TestFile.new(file, ADMIN_CLIENT, REST_API_YAML_SKIP_FEATURES)
+    rescue SkipTestsException => _e
+      # If the test file has a `skip` at the top level that applies to this
+      # version of Elasticsearch, continue with the next text.
+      logger = Logger.new($stdout)
+      logger.info "Skipping #{file} due to 'skip all'."
+      next
+    end
+
+    context "#{file.gsub("#{YAML_FILES_DIRECTORY}/", '')}" do
+      test_file.tests.each do |test|
+        context "#{test.description}" do
+          if test.skip_test?(ADMIN_CLIENT)
+            skip 'Test contains feature(s) not yet supported or version is not satisfied'
+          else
+            let(:client) do
+              DEFAULT_CLIENT
+            end
+
+            # Runs once before each test in a test file
+            before(:all) do
+              OpenSearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
+              test_file.setup
+            end
+
+            after(:all) do
+              test_file.teardown
+              OpenSearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
+            end
+
+            test.task_groups.each do |task_group|
+              before do
+                task_group.run(client)
+              end
+
+              # 'catch' is in the task group definition
+              if task_group.catch_exception?
+                it 'sends the request and throws the expected error' do
+                  expect(task_group.exception).to match_error(task_group.expected_exception_message)
+                end
+
+                # 'match' on error description is in the task group definition
+                if task_group.has_match_clauses?
+                  task_group.match_clauses.each do |match|
+                    it 'contains the expected error in the request response' do
+                      expect(task_group.exception.message).to match(Regexp.new(Regexp.escape(match['match'].values.first.to_s)))
+                    end
+                  end
+                end
+              else
+                # 'match' is in the task group definition
+                if task_group.has_match_clauses?
+                  task_group.match_clauses.each do |match|
+                    it "has the expected value (#{match['match'].values.join(',')}) in the response field (#{match['match'].keys.join(',')})" do
+                      expect(task_group.response).to match_response(match['match'], test)
+                    end
+                  end
+                end
+
+                # 'length' is in the task group definition
+                if task_group.has_length_match_clauses?
+                  task_group.length_match_clauses.each do |match|
+                    it "the '#{match['length'].keys.join(',')}' field have the expected length" do
+                      expect(task_group.response).to match_response_field_length(match['length'], test)
+                    end
+                  end
+                end
+
+                # 'is_true' is in the task group definition
+                if task_group.has_true_clauses?
+                  task_group.true_clauses.each do |match|
+                    it "sends the request and the '#{match['is_true']}' field is set to true" do
+                      expect(task_group.response).to match_true_field(match['is_true'], test)
+                    end
+                  end
+                end
+
+                # 'is_false' is in the task group definition
+                if task_group.has_false_clauses?
+                  task_group.false_clauses.each do |match|
+                    it "sends the request and the '#{match['is_false']}' field is set to true" do
+                      expect(task_group.response).to match_false_field(match['is_false'], test)
+                    end
+                  end
+                end
+
+                # 'gte' is in the task group definition
+                if task_group.has_gte_clauses?
+                  task_group.gte_clauses.each do |match|
+                    it "sends the request and the '#{match['gte']}' field is greater than or equal to the expected value" do
+                      expect(task_group.response).to match_gte_field(match['gte'], test)
+                    end
+                  end
+                end
+
+                # 'gt' is in the task group definition
+                if task_group.has_gt_clauses?
+                  task_group.gt_clauses.each do |match|
+                    it "sends the request and the '#{match['gt']}' field is greater than the expected value" do
+                      expect(task_group.response).to match_gt_field(match['gt'], test)
+                    end
+                  end
+                end
+
+                # 'lte' is in the task group definition
+                if task_group.has_lte_clauses?
+                  task_group.lte_clauses.each do |match|
+                    it "sends the request and the '#{match['lte']}' field is less than or equal to the expected value" do
+                      expect(task_group.response).to match_lte_field(match['lte'], test)
+                    end
+                  end
+                end
+
+                # 'lt' is in the task group definition
+                if task_group.has_lt_clauses?
+                  task_group.lt_clauses.each do |match|
+                    it "sends the request and the '#{match['lt']}' field is less than the expected value" do
+                      expect(task_group.response).to match_lt_field(match['lt'], test)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end