elasticsearch-api 7.13.3 → 8.14.0

data/lib/elasticsearch/api/actions/shutdown/params_registry.rb

@@ -1,60 +0,0 @@
-# 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.
-
-module Elasticsearch
-  module API
-    module Shutdown
-      module Actions
-        module ParamsRegistry
-          extend self
-
-          # A Mapping of all the actions to their list of valid params.
-          #
-          # @since 6.1.1
-          PARAMS = {}
-
-          # Register an action with its list of valid params.
-          #
-          # @example Register the action.
-          #   ParamsRegistry.register(:benchmark, [ :verbose ])
-          #
-          # @param [ Symbol ] action The action to register.
-          # @param [ Array[Symbol] ] valid_params The list of valid params.
-          #
-          # @since 6.1.1
-          def register(action, valid_params)
-            PARAMS[action.to_sym] = valid_params
-          end
-
-          # Get the list of valid params for a given action.
-          #
-          # @example Get the list of valid params.
-          #   ParamsRegistry.get(:benchmark)
-          #
-          # @param [ Symbol ] action The action.
-          #
-          # @return [ Array<Symbol> ] The list of valid params for the action.
-          #
-          # @since 6.1.1
-          def get(action)
-            PARAMS.fetch(action, [])
-          end
-        end
-      end
-    end
-  end
-end

data/lib/elasticsearch/api/actions/snapshot/params_registry.rb

@@ -1,60 +0,0 @@
-# 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.
-
-module Elasticsearch
-  module API
-    module Snapshot
-      module Actions
-        module ParamsRegistry
-          extend self
-
-          # A Mapping of all the actions to their list of valid params.
-          #
-          # @since 6.1.1
-          PARAMS = {}
-
-          # Register an action with its list of valid params.
-          #
-          # @example Register the action.
-          #   ParamsRegistry.register(:benchmark, [ :verbose ])
-          #
-          # @param [ Symbol ] action The action to register.
-          # @param [ Array[Symbol] ] valid_params The list of valid params.
-          #
-          # @since 6.1.1
-          def register(action, valid_params)
-            PARAMS[action.to_sym] = valid_params
-          end
-
-          # Get the list of valid params for a given action.
-          #
-          # @example Get the list of valid params.
-          #   ParamsRegistry.get(:benchmark)
-          #
-          # @param [ Symbol ] action The action.
-          #
-          # @return [ Array<Symbol> ] The list of valid params for the action.
-          #
-          # @since 6.1.1
-          def get(action)
-            PARAMS.fetch(action, [])
-          end
-        end
-      end
-    end
-  end
-end

data/lib/elasticsearch/api/actions/tasks/params_registry.rb

@@ -1,60 +0,0 @@
-# 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.
-
-module Elasticsearch
-  module API
-    module Tasks
-      module Actions
-        module ParamsRegistry
-          extend self
-
-          # A Mapping of all the actions to their list of valid params.
-          #
-          # @since 6.1.1
-          PARAMS = {}
-
-          # Register an action with its list of valid params.
-          #
-          # @example Register the action.
-          #   ParamsRegistry.register(:benchmark, [ :verbose ])
-          #
-          # @param [ Symbol ] action The action to register.
-          # @param [ Array[Symbol] ] valid_params The list of valid params.
-          #
-          # @since 6.1.1
-          def register(action, valid_params)
-            PARAMS[action.to_sym] = valid_params
-          end
-
-          # Get the list of valid params for a given action.
-          #
-          # @example Get the list of valid params.
-          #   ParamsRegistry.get(:benchmark)
-          #
-          # @param [ Symbol ] action The action.
-          #
-          # @return [ Array<Symbol> ] The list of valid params for the action.
-          #
-          # @since 6.1.1
-          def get(action)
-            PARAMS.fetch(action, [])
-          end
-        end
-      end
-    end
-  end
-end

data/spec/elasticsearch/api/actions/indices/exists_type_spec.rb

@@ -1,108 +0,0 @@
-# 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.indices#exists_type' do
-
-  let(:expected_args) do
-    [
-        'HEAD',
-        url,
-        params,
-        nil,
-        {}
-    ]
-  end
-
-  let(:params) do
-    {}
-  end
-
-  let(:url) do
-    'foo/_mapping/bar'
-  end
-
-  it 'performs the request' do
-    expect(client_double.indices.exists_type(index: 'foo', type: 'bar')).to eq(true)
-  end
-
-  it 'aliased to a predicate method' do
-    expect(client_double.indices.exists_type?(index: 'foo', type: 'bar')).to eq(true)
-  end
-
-  context 'when multiple indices are specified' do
-
-    let(:url) do
-      'foo,bar/_mapping/bam'
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.exists_type(index: ['foo','bar'], type: 'bam')).to eq(true)
-    end
-  end
-
-  context 'when the path needs to be URL-escaped' do
-
-    let(:url) do
-      'foo%5Ebar/_mapping/bar%2Fbam'
-    end
-
-    it 'performs the request' do
-      expect(client_double.indices.exists_type(index: 'foo^bar', type: 'bar/bam')).to eq(true)
-    end
-  end
-
-  context 'when 404 response is received' do
-
-    let(:response_double) do
-      double('response', status: 404, body: {}, headers: {})
-    end
-
-    it 'returns false' do
-      expect(client_double.indices.exists_type(index: 'foo', type: 'bar')).to eq(false)
-    end
-  end
-
-  context 'when a \'not found\' exception is raised' do
-
-    let(:client) do
-      Class.new { include Elasticsearch::API }.new.tap do |_client|
-        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(StandardError.new('404 Not Found'))
-      end
-    end
-
-    it 'returns false' do
-      expect(client.indices.exists_type(index: 'foo', type: 'bar')).to eq(false)
-    end
-  end
-
-  context 'when a generic exception is raised' do
-
-    let(:client) do
-      Class.new { include Elasticsearch::API }.new.tap do |_client|
-        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(StandardError.new)
-      end
-    end
-
-    it 'raises the exception' do
-      expect {
-        client.indices.exists_type(index: 'foo', type: 'bar')
-      }.to raise_exception(StandardError)
-    end
-  end
-end

data/spec/elasticsearch/api/actions/indices/flush_synced_spec.rb

@@ -1,90 +0,0 @@
-# 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.indices#flush_synced' do
-
-  let(:expected_args) do
-    [
-        'POST',
-        url,
-        params,
-        nil,
-        {}
-    ]
-  end
-
-  let(:params) do
-    {}
-  end
-
-  let(:url) do
-    'foo/_flush/synced'
-  end
-
-  it 'performs the request' do
-    expect(client_double.indices.flush_synced(index: 'foo')).to eq({})
-  end
-
-  context 'when a \'not found\' exception is raised' do
-
-    let(:client) do
-      Class.new { include Elasticsearch::API }.new.tap do |_client|
-        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(NotFound)
-      end
-    end
-
-    it 'raises the exception' do
-      expect {
-        client.indices.flush_synced(index: 'foo')
-      }.to raise_exception(NotFound)
-    end
-  end
-
-  context 'when a \'not found\' exception is raised' do
-
-    let(:client) do
-      Class.new { include Elasticsearch::API }.new.tap do |_client|
-        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(NotFound)
-      end
-    end
-
-    it 'raises the exception' do
-      expect {
-        client.indices.flush_synced(index: 'foo')
-      }.to raise_exception(NotFound)
-    end
-  end
-
-  context 'when the ignore parameter is specified' do
-
-    let(:client) do
-      Class.new { include Elasticsearch::API }.new.tap do |_client|
-        expect(_client).to receive(:perform_request).with(*expected_args).and_raise(StandardError.new('404 Not Found'))
-      end
-    end
-
-    let(:params) do
-      { ignore: 404 }
-    end
-
-    it 'does not raise the exception' do
-      expect(client.indices.flush_synced(index: 'foo', ignore: 404)).to eq(false)
-    end
-  end
-end

data/spec/elasticsearch/api/rest_api_yaml_spec.rb

@@ -1,147 +0,0 @@
-# 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
-#
-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 test: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
-      # 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
-              Elasticsearch::RestAPIYAMLTests::TestFile.wipe_cluster(ADMIN_CLIENT)
-              test_file.setup
-            end
-
-            after(:all) do
-              test_file.teardown
-              Elasticsearch::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

data/spec/rest_yaml_tests_helper.rb

@@ -1,81 +0,0 @@
-# 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 "#{File.expand_path(File.dirname('..'), '..')}/api-spec-testing/test_file"
-require "#{File.expand_path(File.dirname('..'), '..')}/api-spec-testing/rspec_matchers"
-include Elasticsearch::RestAPIYAMLTests
-
-TRANSPORT_OPTIONS = {}
-PROJECT_PATH = File.join(File.dirname(__FILE__), '..')
-
-if (hosts = ELASTICSEARCH_URL)
-  split_hosts = hosts.split(',').map do |host|
-    /(http\:\/\/)?\S+/.match(host)
-  end
-  uri = URI.parse(split_hosts.first[0])
-  TEST_HOST = uri.host
-  TEST_PORT = uri.port
-else
-  TEST_HOST, TEST_PORT = 'localhost', '9200'
-end
-
-if defined?(TEST_HOST) && defined?(TEST_PORT)
-  URL = "http://#{TEST_HOST}:#{TEST_PORT}"
-
-  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
-
-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']
-
-                if test_target.match?(/\.yml$/)
-                  ["#{PROJECT_PATH}/../tmp/rest-api-spec/test/free/#{test_target}"]
-                else
-                  Dir.glob(
-                    ["#{PROJECT_PATH}/../tmp/rest-api-spec/test/free/#{test_target}/*.yml"]
-                  )
-                end
-              end
-
-
-# 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 = 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

@@ -1,29 +0,0 @@
-# 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/utils/thor/templates/_params_registry.erb

@@ -1,12 +0,0 @@
-<%- unless @params.empty? -%>
-  <%= '  '*(@namespace_depth+3) %># Register this action with its valid params when the module is loaded.
-  <%= '  '*(@namespace_depth+3) %>#
-  <%= '  '*(@namespace_depth+3) %># @since 6.2.0
-  <%- if @endpoint_name == 'indices.stats' -%>
-    <%= indices_stats_params_registry %>
-  <%- else -%>
-    <%= '  '*(@namespace_depth+3) %>ParamsRegistry.register(:<%= @method_name %>, [
-    <%= '  '*(@namespace_depth+4) %><%= @params.keys.map { |k| ":#{k}" }.join(",\n#{'  '*(@namespace_depth+4)}") %>
-    <%= '  '*(@namespace_depth+3) %>].freeze)
-  <%- end -%>
-<%- end -%>