elasticsearch-api 7.11.2 → 8.6.0

data/spec/elasticsearch/api/actions/sql/get_async_stats_spec.rb

@@ -0,0 +1,46 @@
+# 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.sql#get_async_status' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_sql/async/status/foo',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  context 'when there is no id specified' do
+    let(:client) do
+      Class.new { include Elasticsearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect { client.sql.get_async_status }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when an index is specified' do
+    it 'performs the request' do
+      expect(client_double.sql.get_async_status(id: 'foo')).to be_a Elasticsearch::API::Response
+    end
+  end
+end

data/spec/elasticsearch/api/actions/tasks/cancel_spec.rb

@@ -18,14 +18,13 @@
 require 'spec_helper'
 
 describe 'client.tasks#cancel' do
-
   let(:expected_args) do
     [
-        'POST',
-        url,
-        {},
-        nil,
-        {}
+      'POST',
+      url,
+      {},
+      nil,
+      {}
     ]
   end
 
@@ -34,7 +33,7 @@ describe 'client.tasks#cancel' do
   end
 
   it 'performs the request' do
-    expect(client_double.tasks.cancel).to eq({})
+    expect(client_double.tasks.cancel).to be_a Elasticsearch::API::Response
   end
 
   context 'when a task id is specified' do
@@ -44,7 +43,7 @@ describe 'client.tasks#cancel' do
     end
 
     it 'performs the request' do
-      expect(client_double.tasks.cancel(task_id: 'foo')).to eq({})
+      expect(client_double.tasks.cancel(task_id: 'foo')).to be_a Elasticsearch::API::Response
     end
   end
 end

data/spec/elasticsearch/api/actions/tasks/get_spec.rb

@@ -30,6 +30,6 @@ describe 'client.tasks#get' do
   end
 
   it 'performs the request' do
-    expect(client_double.tasks.get(task_id: 'foo1')).to eq({})
+    expect(client_double.tasks.get(task_id: 'foo1')).to be_a Elasticsearch::API::Response
   end
 end

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

@@ -18,14 +18,13 @@
 require 'spec_helper'
 
 describe 'client.tasks#list' do
-
   let(:expected_args) do
     [
-        'GET',
-        url,
-        {},
-        nil,
-        {}
+      'GET',
+      url,
+      {},
+      nil,
+      {}
     ]
   end
 
@@ -34,6 +33,6 @@ describe 'client.tasks#list' do
   end
 
   it 'performs the request' do
-    expect(client_double.tasks.list).to eq({})
+    expect(client_double.tasks.list).to be_a Elasticsearch::API::Response
   end
 end

data/spec/elasticsearch/api/actions/terms_enum_spec.rb

@@ -0,0 +1,52 @@
+# 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#terms_enum' do
+  let(:expected_args) do
+    [
+      method,
+      'foo/_terms_enum',
+      {},
+      body,
+      {}
+    ]
+  end
+
+  context 'without a body' do
+    let(:method) { 'GET' }
+    let(:body) { nil }
+
+    it 'performs a GET request' do
+      expect(client_double.terms_enum(index: 'foo')).to be_a Elasticsearch::API::Response
+    end
+  end
+
+  context 'with a body' do
+    let(:method) { 'POST' }
+    let(:body) { {} }
+
+    it 'performs a POST request' do
+      expect(client_double.terms_enum(index: 'foo', body: body)).to be_a Elasticsearch::API::Response
+    end
+  end
+
+  it 'requires the :index argument' do
+    expect { client.terms_enum }.to raise_exception(ArgumentError)
+  end
+end

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

@@ -29,7 +29,7 @@ describe 'client#termvectors' do
   end
 
   let(:url) do
-    'foo/bar/123/_termvectors'
+    'foo/_termvectors/123'
   end
 
   let(:params) do
@@ -46,21 +46,21 @@ describe 'client#termvectors' do
 
   it 'requires the :index argument' do
     expect {
-      client.termvectors(type: 'bar', id: '1')
+      client.termvectors(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({})
+    expect(client_double.termvectors(index: 'foo', id: '123', body: {})).to be_a Elasticsearch::API::Response
   end
 
   context 'when the older api name \'termvector\' is used' do
     let(:url) do
-      'foo/bar/123/_termvector'
+      'foo/_termvectors/123'
     end
 
     it 'performs the request' do
-      expect(client_double.termvector(index: 'foo', type: 'bar', id: '123', body: {})).to eq({})
+      expect(client_double.termvector(index: 'foo', id: '123', body: {})).to be_a Elasticsearch::API::Response
     end
   end
 end

data/spec/elasticsearch/api/actions/update_by_query_spec.rb

@@ -18,18 +18,17 @@
 require 'spec_helper'
 
 describe 'client#update_by_query' do
-
   let(:expected_args) do
     [
-        'POST',
-        'foo/_update_by_query',
-        {},
-        nil,
-        {}
+      'POST',
+      'foo/_update_by_query',
+      {},
+      nil,
+      {}
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.update_by_query(index: 'foo')).to eq({})
+    expect(client_double.update_by_query(index: 'foo')).to be_a Elasticsearch::API::Response
   end
 end

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

@@ -18,14 +18,13 @@
 require 'spec_helper'
 
 describe 'client#update' do
-
   let(:expected_args) do
     [
-        'POST',
-        url,
-        params,
-        body,
-        {}
+      'POST',
+      url,
+      params,
+      body,
+      {}
     ]
   end
 
@@ -34,7 +33,7 @@ describe 'client#update' do
   end
 
   let(:url) do
-    'foo/bar/1/_update'
+    'foo/_update/1'
   end
 
   let(:client) do
@@ -47,24 +46,23 @@ describe 'client#update' do
 
   it 'requires the :index argument' do
     expect {
-      client.update(type: 'bar', id: '1')
+      client.update(id: '1')
     }.to raise_exception(ArgumentError)
   end
 
   it 'requires the :id argument' do
     expect {
-      client.update(index: 'foo', type: 'bar')
+      client.update(index: 'foo')
     }.to raise_exception(ArgumentError)
   end
 
   it 'performs the request' do
-    expect(client_double.update(index: 'foo', type: 'bar', id: '1', body: { doc: {} })).to eq({})
+    expect(client_double.update(index: 'foo', id: '1', body: { doc: {} })).to be_a Elasticsearch::API::Response
   end
 
   context 'when URL parameters are provided' do
-
     let(:url) do
-      'foo/bar/1/_update'
+      'foo/_update/1'
     end
 
     let(:body) do
@@ -72,23 +70,13 @@ describe 'client#update' 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)
+      expect(client_double.update(index: 'foo', id: '1', body: {}))
     end
   end
 
   context 'when the request needs to be URL-escaped' do
-
     let(:url) do
-      'foo%5Ebar/bar%2Fbam/1/_update'
+      'foo%5Ebar/_update/1'
     end
 
     let(:body) do
@@ -96,26 +84,24 @@ describe 'client#update' do
     end
 
     it 'escapes the parts' do
-      expect(client_double.update(index: 'foo^bar', type: 'bar/bam', id: '1', body: {}))
+      expect(client_double.update(index: 'foo^bar', 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: {})
+        client.update(index: 'foo', 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)
+        expect(client.update(index: 'foo', id: 'XXX', body: {}, ignore: 404)).to eq(false)
       end
     end
   end

data/spec/elasticsearch/api/api_response_spec.rb

@@ -0,0 +1,65 @@
+# 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 'elastic/transport'
+
+describe Elasticsearch::API::Response do
+  let(:response_body) do
+    {
+      'name' => 'instance',
+      'cluster_name' => 'elasticsearch-8-0-0',
+      'version' => {
+        'number' => '8.0.0',
+        'build_flavor' => 'default'
+      },
+      'tagline' => 'You Know, for Search'
+    }
+  end
+  let(:headers) do
+    { 'Content-Type' => 'application/json'}
+  end
+  let(:es_response) do
+    Elastic::Transport::Transport::Response.new(
+      200,
+      response_body,
+      headers
+    )
+  end
+  let(:response) { described_class.new(es_response) }
+
+  it 'behaves like a Hash' do
+    expect(response['name']).to eq 'instance'
+    expect(response['version']).to eq({ 'number' => '8.0.0', 'build_flavor' => 'default' })
+    expect(response.keys).to eq ['name', 'cluster_name', 'version', 'tagline']
+    expect(response.respond_to?('map')).to be(true)
+    expect(response.respond_to?('each')).to be(true)
+    expect(response.respond_to?('size')).to be(true)
+  end
+
+  it 'returns a status' do
+    expect(response.status).to eq 200
+  end
+
+  it 'returns the headers' do
+    expect(response.headers).to eq headers
+  end
+
+  it 'returns the body which' do
+    expect(response.body).to eq response_body
+  end
+end

data/spec/elasticsearch/api/api_spec.rb

@@ -18,9 +18,7 @@
 require 'spec_helper'
 
 describe Elasticsearch::API do
-
   describe '#settings' do
-
     it 'allows access to settings' do
       expect(described_class.settings).not_to be_nil
     end
@@ -30,7 +28,6 @@ describe Elasticsearch::API do
     end
 
     context 'when settings are changed' do
-
       before do
         Elasticsearch::API.settings[:foo] = 'bar'
       end

data/spec/elasticsearch/api/client_spec.rb

@@ -18,27 +18,23 @@
 require 'spec_helper'
 
 describe 'API Client' do
-
   let(:client) do
     Class.new { include Elasticsearch::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

data/spec/elasticsearch/api/rest_api_yaml_spec.rb

@@ -1,137 +1,67 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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'
+require 'rest_api_tests_helper'
+require_relative './run_rspec_matchers'
+
+LOGGER = Logger.new($stdout)
 
 describe 'Rest API YAML tests' do
+  if REST_API_YAML_FILES.empty?
+    LOGGER.error 'No test files found!'
+    LOGGER.info 'Use rake rake elasticsearch: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 = Elasticsearch::RestAPIYAMLTests::TestFile.new(file, ADMIN_CLIENT, REST_API_YAML_SKIP_FEATURES)
-    rescue SkipTestsException => _e
+    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'."
+      LOGGER.info e.message
       next
     end
 
-    context "#{file.gsub("#{YAML_FILES_DIRECTORY}/", '')}" do
+    context file.gsub("#{YAML_FILES_DIRECTORY}/", '') do
+      let(:client) { DEFAULT_CLIENT }
+
       test_file.tests.each do |test|
-        context "#{test.description}" do
+        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
+            next
+          end
 
-            # Runs once before each test in a test file
-            before(:all) do
-              Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
-              test_file.setup
-            end
+          before(:all) { test_file.setup }
+          after(:all) do
+            test_file.teardown
+            Elasticsearch::RestAPIYAMLTests::WipeCluster.run(ADMIN_CLIENT)
+          end
 
-            after(:all) do
-              test_file.teardown
-              Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
+          test.task_groups.each do |task_group|
+            before do
+              task_group.run(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
+            # ./run_task_groups.rb
+            run_rspec_matchers_on_task_group(task_group, test)
           end
         end
       end