elasticsearch-api 7.14.1 → 7.16.3

data/spec/elasticsearch/api/actions/{benchmark_spec.rb → indices/field_usage_stats_spec.rb}

@@ -17,18 +17,30 @@
 
 require 'spec_helper'
 
-describe 'client#benchmark' do
-
+describe 'client.indices#field_usage_stats' do
   let(:expected_args) do
     [
-      'PUT',
-      '_bench',
+      'GET',
+      'foo/_field_usage_stats',
       {},
-      { name: 'foo' }
+      nil,
+      {}
     ]
   end
 
   it 'performs the request' do
-    expect(client_double.benchmark(body: { name: 'foo' }))
+    expect(client_double.indices.field_usage_stats(index: 'foo')).to eq({})
+  end
+
+  context 'when there is no index specified' do
+    let(:client) do
+      Class.new { include Elasticsearch::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.indices.field_usage_stats
+      }.to raise_exception(ArgumentError)
+    end
   end
 end

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/{snapshot/get_features_spec.rb → nodes/get_repositories_metering_info_spec.rb}

@@ -17,22 +17,28 @@
 
 require 'spec_helper'
 
-describe 'client.snapshot#get' do
+describe 'client.nodes#get_metering_info' do
   let(:expected_args) do
     [
       'GET',
-      '_snapshottable_features',
+      '_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 'performs the request' do
-    expect(client_double.snapshot.get_features).to eq({})
+  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/open_point_in_time_spec.rb

@@ -21,24 +21,14 @@ describe 'client#open_point_in_time' do
   let(:expected_args) do
     [
       'POST',
-      url,
+      'foo/_pit',
       {},
       nil,
       {}
     ]
   end
 
-  let (:url) { '_pit'}
-
   it 'performs the request' do
-    expect(client_double.open_point_in_time).to eq({})
-  end
-
-  context 'with index' do
-    let (:url) { 'foo/_pit'}
-
-    it 'performs the request' do
-      expect(client_double.open_point_in_time(index: 'foo')).to eq({})
-    end
+    expect(client_double.open_point_in_time(index: 'foo')).to eq({})
   end
 end

data/spec/elasticsearch/api/actions/{remote/info_spec.rb → search_mvt_spec.rb}

@@ -17,19 +17,36 @@
 
 require 'spec_helper'
 
-describe 'client.remote#info' do
-
+describe 'client#search_mvt' do
   let(:expected_args) do
     [
-        'GET',
-        '_remote/info',
-        {},
-        nil,
-        nil
+      'POST',
+      url,
+      params,
+      body,
+      {}
     ]
   end
 
-  it 'performs the request' do
-    expect(client_double.remote.info).to eq({})
+  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/rest_api_yaml_spec.rb

@@ -50,13 +50,12 @@ describe 'Rest API YAML tests' do
 
             # Runs once before each test in a test file
             before(:all) do
-              Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
               test_file.setup
             end
 
             after(:all) do
               test_file.teardown
-              Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
+              Elasticsearch::RestAPIYAMLTests::WipeCluster.run(ADMIN_CLIENT)
             end
 
             test.task_groups.each do |task_group|

data/spec/elasticsearch/api/utils_spec.rb

@@ -30,7 +30,7 @@ describe Elasticsearch::API::Utils do
     end
 
     it 'encodes special characters' do
-      expect(utils.__escape('foo bar')).to eq('foo+bar')
+      expect(utils.__escape('foo bar')).to eq('foo%20bar')
       expect(utils.__escape('foo/bar')).to eq('foo%2Fbar')
       expect(utils.__escape('foo^bar')).to eq('foo%5Ebar')
     end
@@ -38,18 +38,6 @@ describe Elasticsearch::API::Utils do
     it 'does not encode asterisks' do
       expect(utils.__escape('*')).to eq('*')
     end
-
-    it 'users CGI.escape by default' do
-      expect(CGI).to receive(:escape).and_call_original
-      expect(utils.__escape('foo bar')).to eq('foo+bar')
-    end
-
-    it 'uses the escape_utils gem when available', unless: defined?(JRUBY_VERSION) do
-      require 'escape_utils'
-      expect(CGI).not_to receive(:escape)
-      expect(EscapeUtils).to receive(:escape_url).and_call_original
-      expect(utils.__escape('foo bar')).to eq('foo+bar')
-    end
   end
 
   describe '#__listify' do
@@ -77,7 +65,7 @@ describe Elasticsearch::API::Utils do
     context 'when the escape option is set to false' do
 
       it 'does not escape the characters' do
-        expect(utils.__listify(['foo', 'bar^bam'], :escape => false)).to eq('foo,bar^bam')
+        expect(utils.__listify(['foo', 'bar^bam'], escape: false)).to eq('foo,bar^bam')
       end
     end
   end
@@ -107,19 +95,19 @@ describe Elasticsearch::API::Utils do
 
       let(:result) do
         utils.__bulkify [
-          { :index =>  { :_index => 'myindexA', :_type => 'mytype', :_id => '1', :data => { :title => 'Test' } } },
-          { :update => { :_index => 'myindexB', :_type => 'mytype', :_id => '2', :data => { :doc => { :title => 'Update' } } } },
-          { :delete => { :_index => 'myindexC', :_type => 'mytypeC', :_id => '3' } }
+          { index: { _index: 'myindexA', _id: '1', data: { title: 'Test' } } },
+          { update: { _index: 'myindexB', _id: '2', data: { doc: { title: 'Update' } } } },
+          { delete: { _index: 'myindexC', _id: '3' } }
         ]
       end
 
       let(:expected_string) do
         <<-PAYLOAD.gsub(/^\s+/, '')
-                {"index":{"_index":"myindexA","_type":"mytype","_id":"1"}}
+                {"index":{"_index":"myindexA","_id":"1"}}
                 {"title":"Test"}
-                {"update":{"_index":"myindexB","_type":"mytype","_id":"2"}}
+                {"update":{"_index":"myindexB","_id":"2"}}
                 {"doc":{"title":"Update"}}
-                {"delete":{"_index":"myindexC","_type":"mytypeC","_id":"3"}}
+                {"delete":{"_index":"myindexC","_id":"3"}}
         PAYLOAD
       end
 
@@ -379,7 +367,7 @@ describe Elasticsearch::API::Utils do
       end
 
       let(:unsupported_params) do
-        [ { :foo => { :explanation => 'NOT_SUPPORTED'} }, :moo ]
+        [ { foo: { explanation: 'NOT_SUPPORTED'} }, :moo ]
       end
 
 

data/spec/rest_yaml_tests_helper.rb

@@ -17,10 +17,13 @@
 
 require "#{File.expand_path(File.dirname('..'), '..')}/api-spec-testing/test_file"
 require "#{File.expand_path(File.dirname('..'), '..')}/api-spec-testing/rspec_matchers"
+require "#{File.expand_path(File.dirname('..'), '..')}/api-spec-testing/wipe_cluster"
 include Elasticsearch::RestAPIYAMLTests
 
 TRANSPORT_OPTIONS = {}
 PROJECT_PATH = File.join(File.dirname(__FILE__), '..')
+STACK_VERSION = ENV['STACK_VERSION']
+require 'elasticsearch/xpack'
 
 if (hosts = ELASTICSEARCH_URL)
   split_hosts = hosts.split(',').map do |host|
@@ -33,21 +36,69 @@ else
   TEST_HOST, TEST_PORT = 'localhost', '9200'
 end
 
+test_suite = ENV['TEST_SUITE'] || 'free'
+password = ENV['ELASTIC_PASSWORD'] || 'changeme'
+user = ENV['ELASTIC_USER'] || 'elastic'
+
 if defined?(TEST_HOST) && defined?(TEST_PORT)
-  URL = "http://#{TEST_HOST}:#{TEST_PORT}"
+  URL = "http://#{TEST_HOST}:#{TEST_PORT}".freeze
+
+  if STACK_VERSION.match?(/^8\./)
+    if ENV['TEST_SUITE'] == 'platinum'
+      raw_certificate = File.read(File.join(PROJECT_PATH, '../.ci/certs/testnode.crt'))
+      certificate = OpenSSL::X509::Certificate.new(raw_certificate)
+      raw_key = File.read(File.join(PROJECT_PATH, '../.ci/certs/testnode.key'))
+      key = OpenSSL::PKey::RSA.new(raw_key)
+      ca_file = File.expand_path(File.join(PROJECT_PATH, '/.ci/certs/ca.crt'))
+      host = "https://elastic:#{password}@#{uri.host}:#{uri.port}".freeze
+      transport_options = { ssl: { verify: false, client_cert: certificate, client_key: key, ca_file: ca_file } }
+    else
+      host = "http://elastic:#{password}@#{uri.host}:#{uri.port}".freeze
+      transport_options = {}
+    end
 
-  ADMIN_CLIENT = Elasticsearch::Client.new(host: URL, transport_options: TRANSPORT_OPTIONS)
+    ADMIN_CLIENT = Elasticsearch::Client.new(host: host, transport_options: transport_options)
 
-  if ENV['QUIET'] == 'true'
-    DEFAULT_CLIENT = Elasticsearch::Client.new(host: URL, transport_options: TRANSPORT_OPTIONS)
+    DEFAULT_CLIENT = if ENV['QUIET'] == 'true'
+                       Elasticsearch::Client.new(host: host, transport_options: transport_options)
+                     else
+                       Elasticsearch::Client.new(
+                         host: host,
+                         tracer: Logger.new($stdout),
+                         transport_options: transport_options
+                       )
+                     end
+
+    if ENV['QUIET'] == 'true'
+      DEFAULT_CLIENT = Elasticsearch::Client.new(
+        host: URL,
+        transport_options: TRANSPORT_OPTIONS,
+        user: user,
+        password: password
+      )
+    else
+      DEFAULT_CLIENT = Elasticsearch::Client.new(
+        host: URL,
+        transport_options: TRANSPORT_OPTIONS,
+        user: user,
+        password: password,
+        tracer: Logger.new($stdout)
+      )
+    end
   else
-    DEFAULT_CLIENT = Elasticsearch::Client.new(host: URL,
-                                               transport_options: TRANSPORT_OPTIONS,
-                                               tracer: Logger.new($stdout))
+    ADMIN_CLIENT = Elasticsearch::Client.new(host: URL, transport_options: TRANSPORT_OPTIONS)
+
+    if ENV['QUIET'] == 'true'
+      DEFAULT_CLIENT = Elasticsearch::Client.new(host: URL, transport_options: TRANSPORT_OPTIONS)
+    else
+      DEFAULT_CLIENT = Elasticsearch::Client.new(host: URL,
+                                                 transport_options: TRANSPORT_OPTIONS,
+                                                 tracer: Logger.new($stdout))
+    end
   end
 end
 
-YAML_FILES_DIRECTORY = "#{PROJECT_PATH}/../tmp/rest-api-spec/test/free"
+YAML_FILES_DIRECTORY = "#{PROJECT_PATH}/../tmp/rest-api-spec/#{STACK_VERSION.match?(/^8\./) ? 'compatTest' : 'test'}/free"
 
 SINGLE_TEST = if ENV['SINGLE_TEST'] && !ENV['SINGLE_TEST'].empty?
                 test_target = ENV['SINGLE_TEST']

data/spec/spec_helper.rb

@@ -25,6 +25,10 @@ else
   require 'pry-byebug'
 end
 require 'ansi'
+require 'yaml'
+require 'active_support/isolated_execution_state' unless RUBY_VERSION < '2.7.0'
+require 'jbuilder'
+require 'jsonify'
 require 'elasticsearch'
 require 'elasticsearch-api'
 require 'elasticsearch-transport'
@@ -67,7 +71,7 @@ end
 RSpec.configure do |config|
   config.include(HelperModule)
   config.formatter = 'documentation'
-  config.color = true
+  config.color_mode = :on
   config.add_formatter('RspecJunitFormatter', 'tmp/elasticsearch-api-junit.xml')
 end
 

data/utils/thor/.rubocop.yml

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

data/utils/thor/generate_source.rb

@@ -148,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'
@@ -155,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'
@@ -194,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
@@ -226,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
@@ -290,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)

data/utils/thor/generator/endpoint_specifics.rb

@@ -27,6 +27,7 @@ module Elasticsearch
         exists
         indices.exists
         indices.exists_alias
+        indices.exists_index_template
         indices.exists_template
         indices.exists_type
       ].freeze
@@ -37,8 +38,9 @@ module Elasticsearch
         delete
         get
         indices.flush_synced
-        indices.delete_template
         indices.delete
+        indices.delete_index_template
+        indices.delete_template
         security.get_role
         security.get_user
         snapshot.status

data/utils/thor/templates/_perform_request.erb

@@ -34,7 +34,7 @@ when 'mtermvectors'
 <%- end -%>
 <%- if ['bulk', 'msearch', 'msearch_template', 'find_structure'].include? @method_name -%>
   <%= self.send("#{@method_name}_body_helper".to_s) %>
-  headers.merge!("Content-Type" => "application/x-ndjson")
+  headers = <%= __utils %>.ndjson_headers(headers)
   <%= '  '*(@namespace_depth+4) %>perform_request(method, path, params, payload, headers).body
 <%- elsif @method_name == 'ping' -%>
   <%= ping_perform_request %>