elasticsearch-api 7.8.0 → 7.10.0

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

@@ -18,14 +18,13 @@
 require 'spec_helper'
 
 describe 'client#msearch' do
-
   let(:expected_args) do
     [
-        'GET',
-        url,
-        params,
-        body,
-        headers
+      'POST',
+      url,
+      params,
+      body,
+      headers
     ]
   end
 
@@ -50,13 +49,12 @@ describe 'client#msearch' do
   end
 
   it 'requires the :body argument' do
-    expect {
+    expect do
       client.msearch
-    }.to raise_exception(ArgumentError)
+    end.to raise_exception(ArgumentError)
   end
 
   context 'when the body is an object' do
-
     let(:body) do
       <<-PAYLOAD.gsub(/^\s+/, '')
             {"index":"foo"}
@@ -69,16 +67,19 @@ describe 'client#msearch' do
     end
 
     it 'performs the request' do
-      expect(client_double.msearch body: [
-          { index: 'foo', search: { query: { match_all: {}  } } },
-          { index: 'bar', search: { query: { match: { foo: 'bar' } } } },
-          { search_type: 'count', search: { facets: { tags: {} } } }
-      ])
+      expect(
+        client_double.msearch(
+          body: [
+            { index: 'foo', search: { query: { match_all: {}  } } },
+            { index: 'bar', search: { query: { match: { foo: 'bar' } } } },
+            { search_type: 'count', search: { facets: { tags: {} } } }
+          ]
+        )
+      )
     end
   end
 
   context 'when the body is a string' do
-
     let(:body) do
       %Q|{"foo":"bar"}\n{"moo":"lam"}|
     end
@@ -89,7 +90,6 @@ describe 'client#msearch' do
   end
 
   context 'when an index is specified' do
-
     let(:url) do
       'foo/_msearch'
     end
@@ -103,10 +103,9 @@ describe 'client#msearch' do
     end
   end
 
-  context 'when a type and index are specified' do
-
+  context 'when multiple indices are specified' do
     let(:url) do
-      'foo/bar/_msearch'
+      'foo,bar/_msearch'
     end
 
     let(:body) do
@@ -114,29 +113,13 @@ describe 'client#msearch' do
     end
 
     it 'performs the request' do
-      expect(client_double.msearch(index: 'foo', type: 'bar', body: []))
-    end
-  end
-
-  context 'when multiple indices and multiple types are specified' do
-
-    let(:url) do
-      'foo,bar/lam,bam/_msearch'
-    end
-
-    let(:body) do
-      ''
-    end
-
-    it 'performs the request' do
-      expect(client_double.msearch(index: ['foo', 'bar'], type: ['lam', 'bam'], body: []))
+      expect(client_double.msearch(index: ['foo', 'bar'], body: []))
     end
   end
 
   context 'when the request needs to be URL-escaped' do
-
     let(:url) do
-      'foo%5Ebar/bar%2Fbam/_msearch'
+      'foo%5Ebar/_msearch'
     end
 
     let(:body) do
@@ -144,12 +127,11 @@ describe 'client#msearch' do
     end
 
     it 'performs the request' do
-      expect(client_double.msearch(index: 'foo^bar', type: 'bar/bam', body: [])).to eq({})
+      expect(client_double.msearch(index: 'foo^bar', body: [])).to eq({})
     end
   end
 
   context 'when the URL params need to be URL-encoded' do
-
     let(:url) do
       '_msearch'
     end

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

@@ -18,14 +18,13 @@
 require 'spec_helper'
 
 describe 'client#msearch_template' do
-
   let(:expected_args) do
     [
-        'GET',
-        url,
-        params,
-        body,
-        headers
+      'POST',
+      url,
+      params,
+      body,
+      headers
     ]
   end
 

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

@@ -18,16 +18,16 @@
 require 'spec_helper'
 
 describe 'client#mtermvectors' do
-
   let(:expected_args) do
     [
-        'GET',
-        'my-index/my-type/_mtermvectors',
-        {},
-        body,
-        {}
+      method,
+      'my-index/my-type/_mtermvectors',
+      {},
+      body,
+      {}
     ]
   end
+  let(:method) { 'POST' }
 
   let(:body) do
     { ids: [1, 2, 3] }
@@ -38,7 +38,7 @@ describe 'client#mtermvectors' do
   end
 
   context 'when a list of ids is passed instead of a body' do
-
+    let(:method) { 'GET' }
     it 'performs the request' do
       expect(client_double.mtermvectors(index: 'my-index', type: 'my-type', ids: [1, 2, 3])).to eq({})
     end

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

@@ -21,7 +21,7 @@ describe 'client#render_search_template' do
   context 'when no id is specified' do
     let(:expected_args) do
       [
-        'GET',
+        'POST',
         '_render/template',
         {},
         { foo: 'bar' },
@@ -37,7 +37,7 @@ describe 'client#render_search_template' do
   context 'when id is specified' do
     let(:expected_args) do
       [
-        'GET',
+        'POST',
         '_render/template/foo',
         {},
         { foo: 'bar' },

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

@@ -37,7 +37,7 @@ describe 'client#scroll' do
   context 'with scroll_id in the body' do
     let(:expected_args) do
       [
-        'GET',
+        'POST',
         '_search/scroll',
         {},
         { scroll_id: 'cXVlcn...' },

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

@@ -18,16 +18,16 @@
 require 'spec_helper'
 
 describe 'client#search' do
-
   let(:expected_args) do
     [
-        'GET',
-        url,
-        params,
-        body,
-        {}
+      method,
+      url,
+      params,
+      body,
+      {}
     ]
   end
+  let(:method) { 'GET' }
 
   let(:body) do
     nil
@@ -46,10 +46,10 @@ describe 'client#search' do
   end
 
   context 'when a request definition is specified' do
-
     let(:body) do
       { query: { match: {} } }
     end
+    let(:method) { 'POST' }
 
     let(:url) do
       '_search'

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

@@ -18,14 +18,13 @@
 require 'spec_helper'
 
 describe 'client#search_template' do
-
   let(:expected_args) do
     [
-        'GET',
-        'foo/_search/template',
-        { },
-        { foo: 'bar' },
-        {}
+      'POST',
+      'foo/_search/template',
+      { },
+      { foo: 'bar' },
+      {}
     ]
   end
 

data/spec/elasticsearch/api/actions/snapshot/clone_spec.rb

@@ -0,0 +1,67 @@
+# 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.snapshot#clone' do
+  let(:expected_args) do
+    [
+        'PUT',
+        '_snapshot/foo/bar/_clone/snapshot',
+        {},
+        {},
+        {}
+    ]
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'requires the :body argument' do
+    expect {
+      client.snapshot.clone(snapshot: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :repository argument' do
+    expect {
+      client.snapshot.clone(snapshot: 'foo', body: {})
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :snapshot argument' do
+    expect {
+      client.snapshot.clone(repository: 'foo', body: {})
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'requires the :target_snapshot argument' do
+    expect {
+      client.snapshot.clone(repository: 'foo', body: {}, snapshot: 'bar')
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'performs the request' do
+    expect(client_double.snapshot.clone(
+             repository: 'foo',
+             snapshot: 'bar',
+             body: {},
+             target_snapshot: 'snapshot'
+           )).to eq({})
+  end
+end

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

@@ -18,14 +18,13 @@
 require 'spec_helper'
 
 describe 'client#termvectors' do
-
   let(:expected_args) do
     [
-        'GET',
-        url,
-        params,
-        body,
-        {}
+      'POST',
+      url,
+      params,
+      body,
+      {}
     ]
   end
 
@@ -56,7 +55,6 @@ describe 'client#termvectors' do
   end
 
   context 'when the older api name \'termvector\' is used' do
-
     let(:url) do
       'foo/bar/123/_termvector'
     end

data/spec/elasticsearch/api/rest_api_yaml_spec.rb

@@ -8,11 +8,16 @@ require 'rest_yaml_tests_helper'
 describe 'Rest API YAML tests' do
   # Traverse YAML files and create TestFile object:
   REST_API_YAML_FILES.each do |file|
-    test_file = Elasticsearch::RestAPIYAMLTests::TestFile.new(file, REST_API_YAML_SKIP_FEATURES)
+    begin
+      test_file = Elasticsearch::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.
+      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'
@@ -23,13 +28,13 @@ describe 'Rest API YAML tests' do
 
             # Runs once before each test in a test file
             before(:all) do
-              Elasticsearch::RestAPIYAMLTests::TestFile.clear_data(ADMIN_CLIENT)
-              test_file.setup(ADMIN_CLIENT)
+              Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
+              test_file.setup
             end
 
             after(:all) do
-              test_file.teardown(ADMIN_CLIENT)
-              Elasticsearch::RestAPIYAMLTests::TestFile.clear_data(ADMIN_CLIENT)
+              test_file.teardown
+              Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
             end
 
             test.task_groups.each do |task_group|
@@ -52,7 +57,6 @@ describe 'Rest API YAML tests' do
                   end
                 end
               else
-
                 # 'match' is in the task group definition
                 if task_group.has_match_clauses?
                   task_group.match_clauses.each do |match|

data/utils/thor/.rubocop.yml

@@ -0,0 +1,2 @@
+Layout/EndAlignment:
+  AutoCorrect: true

data/utils/thor/generate_source.rb

@@ -50,6 +50,7 @@ module Elasticsearch
       method_option :verbose, type: :boolean, default: false,  desc: 'Output more information'
       method_option :tests,   type: :boolean, default: false,  desc: 'Generate test files'
       method_option :api,     type: :array,   default: %w[oss xpack], desc: 'APIs to generate (oss, x-pack)'
+
       def generate
         self.class.source_root File.expand_path(__dir__)
         @xpack = options[:api].include? 'xpack'
@@ -113,12 +114,13 @@ module Elasticsearch
         names = @endpoint_name.split('.')
         if @current_api == :xpack
           names = (names.first == 'xpack' ? names : ['xpack', names].flatten)
-          # Return an array with 'ml' renamed to 'machine_learning' and 'ilm' to
-          # 'index_lifecycle_management'
+          # Return an array to expand 'ccr', 'ilm', 'ml' and 'slm'
           names.map do |name|
             name
               .gsub(/^ml$/, 'machine_learning')
               .gsub(/^ilm$/, 'index_lifecycle_management')
+              .gsub(/^ccr/, 'cross_cluster_replication')
+              .gsub(/^slm/, 'snapshot_lifecycle_management')
           end
         else
           names
@@ -146,19 +148,24 @@ module Elasticsearch
       end
 
       def __http_method
-        case @endpoint_name
-        when 'index'
-          '_id ? Elasticsearch::API::HTTP_PUT : Elasticsearch::API::HTTP_POST'
-        when 'count'
-          <<~SRC
-            if arguments[:body]
-              Elasticsearch::API::HTTP_POST
-            else
-              Elasticsearch::API::HTTP_GET
-            end
-          SRC
+        return '_id ? Elasticsearch::API::HTTP_PUT : Elasticsearch::API::HTTP_POST' if @endpoint_name == 'index'
+
+        default_method = @spec['url']['paths'].map { |a| a['methods'] }.flatten.first
+        if @spec['body'] && default_method == 'GET'
+          # When default method is GET and body is required, we should always use POST
+          if @spec['body']['required']
+            'Elasticsearch::API::HTTP_POST'
+          else
+            <<~SRC
+              if arguments[:body]
+                Elasticsearch::API::HTTP_POST
+              else
+                Elasticsearch::API::HTTP_GET
+              end
+            SRC
+          end
         else
-          "Elasticsearch::API::HTTP_#{@spec['url']['paths'].map { |a| a['methods'] }.flatten.first}"
+          "Elasticsearch::API::HTTP_#{default_method}"
         end
       end
 
@@ -222,10 +229,38 @@ module Elasticsearch
         info['type'] = 'String' if info['type'] == 'enum' # Rename 'enums' to 'strings'
         tipo = info['type'] ? info['type'].capitalize : 'String'
         description = info['description'] ? info['description'].strip : '[TODO]'
-        options = info['options'] ? "\n    #   (options: #{info['options'].join(', '.strip)})\n" : ''
-        required = info['required'] ? ' (*Required*)' : ''
-        deprecated = info['deprecated'] ? ' *Deprecated*' : ''
-        "# @option arguments [#{tipo}] :#{name} #{description} #{required} #{deprecated} #{options}\n"
+        options = info['options'] ? "(options: #{info['options'].join(', ').strip})" : nil
+        required = info['required'] ? '(*Required*)' : ''
+        deprecated = info['deprecated'] ? '*Deprecated*' : ''
+        optionals = [required, deprecated, options].join(' ').strip
+
+        "# @option arguments [#{tipo}] :#{name} #{description} #{optionals}\n"
+      end
+
+      def stability_doc_helper(stability)
+        return if stability == 'stable'
+
+        if stability == 'experimental'
+          <<~MSG
+            # This functionality is Experimental and may be changed or removed
+            # completely in a future release. Elastic will take a best effort approach
+            # to fix any issues, but experimental features are not subject to the
+            # support SLA of official GA features.
+          MSG
+        elsif stability == 'beta'
+          <<~MSG
+            # This functionality is in Beta and is subject to change. The design and
+            # code is less mature than official GA features and is being provided
+            # as-is with no warranties. Beta features are not subject to the support
+            # SLA of official GA features.
+          MSG
+        else
+          <<~MSG
+            # This functionality is subject to potential breaking changes within a
+            # minor version, meaning that your referencing code may break when this
+            # library is upgraded.
+          MSG
+        end
       end
 
       def generate_tests
@@ -260,7 +295,7 @@ module Elasticsearch
       end
 
       def run_rubocop(api)
-        system("rubocop --format autogenconf -x #{FilesHelper::output_dir(api)}")
+        system("rubocop -c ./thor/.rubocop.yml --format autogenconf -x #{FilesHelper::output_dir(api)}")
       end
     end
   end