elasticsearch-api 7.11.2 → 7.16.0

data/spec/elasticsearch/api/actions/nodes/clear_repositories_metering_archive_spec.rb

@@ -0,0 +1,51 @@
+# 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.nodes#clear_metering_archive' do
+  let(:expected_args) do
+    [
+      'DELETE',
+      '_nodes/foo/_repositories_metering/bar',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.nodes.clear_repositories_metering_archive(node_id: 'foo', max_archive_version: 'bar')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'raises an error if no node_id is provided' do
+    expect do
+      client.nodes.clear_repositories_metering_archive(max_archive_version: 'bar')
+    end.to raise_exception(ArgumentError)
+  end
+
+  it 'raises an error if no max_archive_version is provided' do
+    expect do
+      client.nodes.clear_repositories_metering_archive(node_id: 'foo')
+    end.to raise_exception(ArgumentError)
+  end
+end

data/spec/elasticsearch/api/actions/nodes/get_repositories_metering_info_spec.rb

@@ -0,0 +1,44 @@
+# 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.nodes#get_metering_info' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_nodes/foo/_repositories_metering',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.nodes.get_repositories_metering_info(node_id: 'foo', max_archive_version: 'bar')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'raises an error if no node_id is provided' do
+    expect do
+      client.nodes.get_repositories_metering_info
+    end.to raise_exception(ArgumentError)
+  end
+end

data/spec/elasticsearch/api/actions/{abort_benchmark_spec.rb → open_point_in_time_spec.rb}

@@ -17,18 +17,18 @@
 
 require 'spec_helper'
 
-describe 'client#abort_benchmark' do
-
+describe 'client#open_point_in_time' do
   let(:expected_args) do
     [
       'POST',
-      '_bench/abort/foo',
+      'foo/_pit',
       {},
-      nil
+      nil,
+      {}
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.abort_benchmark(name: 'foo'))
+    expect(client_double.open_point_in_time(index: 'foo')).to eq({})
   end
 end

data/spec/elasticsearch/api/actions/search_mvt_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#search_mvt' do
+  let(:expected_args) do
+    [
+      'POST',
+      url,
+      params,
+      body,
+      {}
+    ]
+  end
+
+  context 'with right parameters' do
+    let(:url) { 'foo/_mvt/field/10/57.2127/6.2348' }
+    let(:params) { {} }
+    let(:body) { nil }
+
+    it 'performs the request' do
+      expect(client_double.search_mvt(index: 'foo', field: 'field', zoom: 10, x: 57.2127, y: 6.2348)).to eq({})
+    end
+  end
+
+  context 'when a param is missing' do
+    let(:client) do
+      Class.new { include Elasticsearch::API }.new
+    end
+
+    it 'raises an ArgumentError' do
+      expect{
+        client.search_mvt
+      }.to raise_exception(ArgumentError)
+    end
+  end
+end

data/spec/elasticsearch/api/actions/shutdown/delete_node_spec.rb

@@ -0,0 +1,44 @@
+# 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.shutdown#delete_node' do
+  let(:expected_args) do
+    [
+      'DELETE',
+      '_nodes/id/shutdown',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.shutdown.delete_node(node_id: 'id')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'raises an error if no node_id is provided' do
+    expect {
+      client.shutdown.delete_node
+    }.to raise_exception(ArgumentError)
+  end
+end

data/spec/elasticsearch/api/actions/shutdown/get_node_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.shutdown#get_node' do
+  let(:expected_args) do
+    [
+      'GET',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  context 'when id is provided' do
+    let(:url) { '_nodes/id/shutdown' }
+
+    it 'performs the request' do
+      expect(client_double.shutdown.get_node(node_id: 'id')).to eq({})
+    end
+  end
+
+  context 'when no id is provided' do
+    let(:url) { '_nodes/shutdown' }
+
+    it 'performs the request' do
+      expect(client_double.shutdown.get_node).to eq({})
+    end
+  end
+end

data/spec/elasticsearch/api/actions/shutdown/put_node_spec.rb

@@ -0,0 +1,50 @@
+# 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.shutdown#put_node' do
+  let(:expected_args) do
+    [
+      'PUT',
+      '_nodes/id/shutdown',
+      {},
+      {},
+      {}
+    ]
+  end
+
+  it 'performs the request' do
+    expect(client_double.shutdown.put_node(body: {}, node_id: 'id')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'raises an error if no node_id is provided' do
+    expect {
+      client.shutdown.put_node(body: {})
+    }.to raise_exception(ArgumentError)
+  end
+
+  it 'raises an error if no body is provided' do
+    expect {
+      client.shutdown.put_node(node_id: 'id')
+    }.to raise_exception(ArgumentError)
+  end
+end

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

@@ -0,0 +1,48 @@
+# 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#repository_analyze' do
+  let(:expected_args) do
+    [
+      'POST',
+      url,
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  let(:url) do
+    '_snapshot/foo/_analyze'
+  end
+
+  it 'performs the request' do
+    expect(client_double.snapshot.repository_analyze(repository: 'foo')).to eq({})
+  end
+
+  let(:client) do
+    Class.new { include Elasticsearch::API }.new
+  end
+
+  it 'requires the :repository argument' do
+    expect {
+      client.snapshot.repository_analyze
+    }.to raise_exception(ArgumentError)
+  end
+end

data/spec/elasticsearch/api/rest_api_yaml_spec.rb

@@ -1,11 +1,31 @@
-# 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'
 
 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 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

data/spec/rest_yaml_tests_helper.rb

@@ -18,9 +18,10 @@
 require "#{File.expand_path(File.dirname('..'), '..')}/api-spec-testing/test_file"
 require "#{File.expand_path(File.dirname('..'), '..')}/api-spec-testing/rspec_matchers"
 include Elasticsearch::RestAPIYAMLTests
+require 'elasticsearch/xpack'
 
 TRANSPORT_OPTIONS = {}
-PROJECT_PATH = File.join(File.dirname(__FILE__), '..', '..')
+PROJECT_PATH = File.join(File.dirname(__FILE__), '..')
 
 if (hosts = ELASTICSEARCH_URL)
   split_hosts = hosts.split(',').map do |host|
@@ -47,71 +48,34 @@ if defined?(TEST_HOST) && defined?(TEST_PORT)
   end
 end
 
-
-YAML_FILES_DIRECTORY = "#{File.expand_path(File.dirname('..'), '..')}" +
-                       '/tmp/elasticsearch/rest-api-spec/src/main/resources/rest-api-spec/test'
+YAML_FILES_DIRECTORY = "#{PROJECT_PATH}/../tmp/rest-api-spec/test/free"
 
 SINGLE_TEST = if ENV['SINGLE_TEST'] && !ENV['SINGLE_TEST'].empty?
                 test_target = ENV['SINGLE_TEST']
-                path = File.expand_path(File.dirname('..'), '..')
 
                 if test_target.match?(/\.yml$/)
-                  ["#{path}/tmp/elasticsearch/rest-api-spec/src/main/resources/rest-api-spec/test/#{test_target}"]
+                  ["#{PROJECT_PATH}/../tmp/rest-api-spec/test/free/#{test_target}"]
                 else
                   Dir.glob(
-                    ["#{path}/tmp/elasticsearch/rest-api-spec/src/main/resources/rest-api-spec/test/#{test_target}/*.yml"]
+                    ["#{PROJECT_PATH}/../tmp/rest-api-spec/test/free/#{test_target}/*.yml"]
                   )
                 end
               end
 
-skipped_tests = []
-
-# Response from Elasticsearch is just a String, so it's not possible to compare using headers.
-skipped_tests << { file:        'cat.aliases/20_headers.yml',
-                   description: 'Simple alias with yaml body through Accept header' }
-
-# Check version skip logic
-skipped_tests << { file:        'create/15_without_id.yml',
-                   description: 'Create without ID' }
-
-# No error is raised
-skipped_tests << { file:        'create/15_without_id_with_types.yml',
-                   description: 'Create without ID' }
-
-# Error message doesn't match
-skipped_tests << { file:        'tasks.get/10_basic.yml',
-                   description: 'get task test' }
-
-# No error is raised
-skipped_tests << { file:        'cat.allocation/10_basic.yml',
-                   description: '*' }
-
-# Figure out how to match response when there is an error
-skipped_tests << { file:        'delete/70_mix_typeless_typeful.yml',
-                   description: '*' }
-
-# Figure out how to match response when there is an error
-skipped_tests << { file:        'cat.templates/10_basic.yml',
-                   description: '*' }
-
-# Responses are there but not equal (eg.: yellow status)
-skipped_tests << { file: 'cluster.health/10_basic.yml',
-                   description: 'cluster health with closed index (pre 7.2.0)' }
-
-# Regular expression not catching exact match:
-skipped_tests << { file: 'cat.indices/10_basic.yml',
-                   description: 'Test cat indices output for closed index (pre 7.2.0)' }
-
-# TODO
-skipped_tests << {
-  file: 'nodes.info/10_basic.yml',
-  description: 'node_info role test'
-}
-
-SKIPPED_TESTS = skipped_tests
+# Skipped tests
+file = File.expand_path("#{__dir__}/skipped_tests.yml")
+skipped_tests = YAML.load_file(file)
 
 # The directory of rest api YAML files.
-REST_API_YAML_FILES = SINGLE_TEST || Dir.glob("#{YAML_FILES_DIRECTORY}/**/*.yml")
+REST_API_YAML_FILES = if ENV['RUN_SKIPPED_TESTS'] # only run the skipped tests if true
+                        SKIPPED_TESTS = []
+                        skipped_tests.map { |test| "#{YAML_FILES_DIRECTORY}/#{test[:file]}" }
+                      else
+                        # If not, define the skipped tests constant and try the single test or all
+                        # the tests
+                        SKIPPED_TESTS = skipped_tests
+                        SINGLE_TEST || Dir.glob("#{YAML_FILES_DIRECTORY}/**/*.yml")
+                      end
 
 # The features to skip
 REST_API_YAML_SKIP_FEATURES = ['warnings', 'node_selector'].freeze

data/spec/skipped_tests.yml

@@ -0,0 +1,29 @@
+# Response from Elasticsearch is just a String, so it's not possible to compare using headers.
+-
+  :file:        'cat.aliases/20_headers.yml'
+  :description: 'Simple alias with yaml body through Accept header'
+
+# Check version skip logic
+-
+  :file:        'create/15_without_id.yml'
+  :description: 'Create without ID'
+
+# No error is raised
+-
+  :file:        'create/15_without_id_with_types.yml'
+  :description: 'Create without ID'
+
+# Error message doesn't match
+-
+  :file:        'tasks.get/10_basic.yml'
+  :description: 'get task test'
+
+# Figure out how to match response when there is an error
+-
+  :file:        'delete/70_mix_typeless_typeful.yml'
+  :description: '*'
+
+# Figure out how to match response when there is an error
+-
+  :file:        'cat.templates/10_basic.yml'
+  :description: '*'

data/spec/spec_helper.rb

@@ -14,6 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+if ENV['COVERAGE'] && ENV['CI'].nil?
+  require 'simplecov'
+  SimpleCov.start { add_filter %r{^/test|spec/} }
+end
 
 if defined?(JRUBY_VERSION)
   require 'pry-nav'
@@ -42,7 +46,6 @@ DEFAULT_CLIENT = Elasticsearch::Client.new(host: ELASTICSEARCH_URL,
 
 module HelperModule
   def self.included(context)
-
     context.let(:client_double) do
       Class.new { include Elasticsearch::API }.new.tap do |client|
         expect(client).to receive(:perform_request).with(*expected_args).and_return(response_double)

data/utils/Gemfile

@@ -18,10 +18,11 @@
 source 'https://rubygems.org'
 
 gem 'activesupport'
-gem 'rest-client'
+gem 'byebug'
 gem 'coderay'
-gem 'multi_json'
-gem 'thor'
 gem 'json'
+gem 'multi_json'
 gem 'pry'
+gem 'rest-client'
 gem 'rubocop'
+gem 'thor'

data/utils/README.md

@@ -6,7 +6,12 @@ This directory hosts The Generator, a tool that generates the classes for each A
 
 ### Generate
 
-To generate the code, you need to run (from this folder):
+To generate the code, you need to have the Elasticsearch REST API spec files in `tmp/rest-api-spec` in the root of the project. You can run a rake task from the root of the project to download the specs corresponding to the current running cluster:
+```bash
+$ rake elasticsearch:download_artifacts
+```
+
+Once the JSON files have been downloaded, you need to run (from this folder):
 ```bash
 $ thor api:code:generate
 ```

data/utils/thor/.rubocop.yml

@@ -1,2 +1,4 @@
 Layout/EndAlignment:
   AutoCorrect: true
+Metrics/LineLength:
+  Max: 160

data/utils/thor/generate_source.rb

@@ -66,11 +66,10 @@ module Elasticsearch
 
       def __generate_source(api)
         @current_api = api
-        @input = FilesHelper.input_dir(api)
         @output = FilesHelper.output_dir(api)
 
         FilesHelper.files(api).each do |filepath|
-          @path = Pathname(@input.join(filepath))
+          @path = Pathname(filepath)
           @json = MultiJson.load(File.read(@path))
           @spec = @json.values.first
           say_status 'json', @path, :yellow
@@ -149,6 +148,7 @@ module Elasticsearch
 
       def __http_method
         return '_id ? Elasticsearch::API::HTTP_PUT : Elasticsearch::API::HTTP_POST' if @endpoint_name == 'index'
+        return post_and_get if @endpoint_name == 'count'
 
         default_method = @spec['url']['paths'].map { |a| a['methods'] }.flatten.first
         if @spec['body'] && default_method == 'GET'
@@ -156,19 +156,23 @@ module Elasticsearch
           if @spec['body']['required']
             'Elasticsearch::API::HTTP_POST'
           else
-            <<~SRC
-              if arguments[:body]
-                Elasticsearch::API::HTTP_POST
-              else
-                Elasticsearch::API::HTTP_GET
-              end
-            SRC
+            post_and_get
           end
         else
           "Elasticsearch::API::HTTP_#{default_method}"
         end
       end
 
+      def post_and_get
+        <<~SRC
+          if arguments[:body]
+            Elasticsearch::API::HTTP_POST
+          else
+            Elasticsearch::API::HTTP_GET
+          end
+        SRC
+      end
+
       def __http_path
         return "\"#{__parse_path(@paths.first)}\"" if @paths.size == 1
         return termvectors_path if @method_name == 'termvectors'
@@ -195,9 +199,9 @@ module Elasticsearch
 
       def __parse_path(path)
         path.gsub(/^\//, '')
-            .gsub(/\/$/, '')
-            .gsub('{', "\#{#{__utils}.__listify(_")
-            .gsub('}', ')}')
+          .gsub(/\/$/, '')
+          .gsub('{', "\#{#{__utils}.__listify(_")
+          .gsub('}', ')}')
       end
 
       def __path_variables
@@ -227,6 +231,7 @@ module Elasticsearch
 
       def docs_helper(name, info)
         info['type'] = 'String' if info['type'] == 'enum' # Rename 'enums' to 'strings'
+        info['type'] = 'Integer' if info['type'] == 'int' # Rename 'int' to 'Integer'
         tipo = info['type'] ? info['type'].capitalize : 'String'
         description = info['description'] ? info['description'].strip : '[TODO]'
         options = info['options'] ? "(options: #{info['options'].join(', ').strip})" : nil
@@ -291,7 +296,7 @@ module Elasticsearch
       end
 
       def __utils
-        (@current_api == :xpack) ? 'Elasticsearch::API::Utils' : 'Utils'
+        @current_api == :xpack ? 'Elasticsearch::API::Utils' : 'Utils'
       end
 
       def run_rubocop(api)