elasticsearch-api 7.13.3 → 8.14.0

data/spec/rest_api/rest_api_yaml_spec.rb

@@ -0,0 +1,82 @@
+# 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_relative 'rest_api_tests_helper'
+require_relative './run_rspec_matchers'
+
+LOGGER = Logger.new($stdout)
+
+describe 'Rest API YAML tests' do
+  LOGGER.info "Elastic Transport version: #{Elastic::Transport::VERSION}"
+
+  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
+
+  CLUSTER_FEATURES = ADMIN_CLIENT.features.get_features['features'].map { |f| f['name'] }
+
+  # 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)
+      context_name = file.gsub("#{YAML_FILES_DIRECTORY}/", '')
+    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.info e.message
+      next
+    end
+
+    context context_name do
+      let(:client) { DEFAULT_CLIENT }
+
+      test_file.tests.each do |test|
+        # To support new features skipping in YAML tests. This will go away with new YAML tests:
+        if (feature_to_skip = test.skip&.first&.[]('skip')&.[]('cluster_features'))
+          next unless CLUSTER_FEATURES.include? feature_to_skip
+        end
+        context test.description do
+          if test.skip_test?(ADMIN_CLIENT)
+            skip 'Test contains feature(s) not yet supported or version is not satisfied'
+            next
+          end
+
+          before(:all) do
+            test_file.setup
+          end
+
+          after(:all) do
+            test_file.teardown
+            Elasticsearch::RestAPIYAMLTests::WipeCluster.run(ADMIN_CLIENT)
+          end
+
+          test.task_groups.each do |task_group|
+            before do
+              task_group.run(client)
+            end
+
+            # ./run_task_groups.rb
+            run_rspec_matchers_on_task_group(task_group, test)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/rest_api/run_rspec_matchers.rb

@@ -0,0 +1,111 @@
+# 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.
+
+# 'catch' is in the task group definition
+def run_rspec_matchers_on_task_group(task_group, test)
+  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
+          regexp = if (val = match['match'].values.first.to_s).include?('\\s')
+                     Regexp.new(val.gsub('\\\\', '\\').gsub('/', ''))
+                   else
+                     Regexp.new(Regexp.escape(val))
+                   end
+          expect(task_group.exception.message).to match(regexp)
+        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

data/spec/rest_api/skipped_tests_free.yml

@@ -0,0 +1,84 @@
+# 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'
+
+# 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:        'cat.templates/10_basic.yml'
+  :description: '*'
+
+# https://github.com/elastic/elasticsearch-ruby/issues/1563
+-
+  :file:        'tsdb/80_index_resize.yml'
+  :description: 'shrink'
+-
+  :file:        'tsdb/80_index_resize.yml'
+  :description: 'clone'
+-
+  :file: 'cluster.desired_nodes/10_basic.yml'
+  :description: 'Test update desired nodes is idempotent'
+-
+  :file: 'cluster.desired_nodes/10_basic.yml'
+  :description: 'Test update desired nodes is idempotent with different order'
+-
+  :file: 'cluster.desired_nodes/10_basic.yml'
+  :description: 'Test node version must be at least the current master version'
+-
+  :file: 'cluster.desired_nodes/10_basic.yml'
+  :description: 'Test node version must have content'
+-
+  :file: 'search.vectors/40_knn_search.yml'
+  :description: 'Direct kNN queries are disallowed'
+-
+  :file: 'search.vectors/45_knn_search_byte.yml'
+  :description: 'Direct kNN queries are disallowed'
+-
+  :file: 'tsdb/25_id_generation.yml'
+  :description: 'generates a consistent id'
+-
+  :file: 'indices.resolve_cluster/10_basic_resolve_cluster.yml'
+  :description: 'Resolve cluster using alias and index that does not exist'
+-
+  :file: 'health/10_basic.yml' # Migrated to written manually
+  :description: 'cluster health basic test'
+-
+  :file: 'cat.allocation/10_basic.yml'
+  :description: 'One index'
+-
+  :file: 'cat.allocation/10_basic.yml'
+  :description: 'Node ID'
+-
+  :file: 'cat.allocation/10_basic.yml'
+  :description: 'All Nodes'
+-
+  :file: 'cat.allocation/10_basic.yml'
+  :description: 'Column headers'
+-
+  :file: 'cat.allocation/10_basic.yml'
+  :description: 'Bytes'
+-
+  :file: 'search.vectors/120_knn_query_multiple_shards.yml'
+  :description: 'Search for 2 knn queries combines scores from them'
+-
+  :file: 'search.vectors/140_knn_query_with_other_queries.yml'
+  :description: 'Function score query with knn query'
+-
+  :file: 'search.vectors/60_knn_search_filter_alias.yml'
+  :description: 'kNN filter alias'
+-
+  :file: 'cluster.desired_nodes/11_old_format.yml'
+  :description: 'Test node version must be at least the current master version'
+-
+  :file: 'cluster.desired_nodes/11_old_format.yml'
+  :description: 'Test node version must have content'

data/spec/rest_api/skipped_tests_platinum.yml

@@ -0,0 +1,120 @@
+# Response from Elasticsearch includes the ca.crt, so length doesn't match.
+-
+  :file:        'ssl/10_basic.yml'
+  :description: 'Test get SSL certificates'
+
+# TODO: Failing due to processing of regexp in test
+-
+  :file: 'ml/explain_data_frame_analytics.yml'
+  :description: 'Test non-empty data frame given body'
+
+-
+  :file: 'analytics/usage.yml'
+  :description: 'Usage stats on analytics indices'
+
+# TODO https://github.com/elastic/elasticsearch-ruby/issues/1269
+-
+  :file: 'searchable_snapshots/10_usage.yml'
+  :description: 'Tests searchable snapshots usage stats with full_copy and shared_cache indices'
+
+# TODO https://github.com/elastic/elasticsearch-ruby/issues/1291
+-
+  :file: 'service_accounts/10_basic.yml'
+  :description: 'Test service account tokens'
+
+# Migrated to manual integration test:
+-
+  :file: 'api_key/10_basic.yml'
+  :description: 'Test get api key'
+-
+  :file: 'api_key/11_invalidation.yml'
+  :description: '*'
+-
+  :file: 'api_key/20_query.yml'
+  :description: '*'
+-
+  :file: 'api_key/30_update.yml'
+  :description: '*'
+-
+  :file: 'api_key/40_view_role_descriptors.yml'
+  :description: '*'
+-
+  :file: 'api_key/50_cross_cluster.yml'
+  :description: '*'
+
+-
+  :file: 'health/10_usage.yml'
+  :description: 'Usage stats on the health API'
+
+-
+  :file: 'snapshot/10_basic.yml'
+  :description: 'Create a source only snapshot and then restore it'
+
+-
+  :file: 'token/10_basic.yml'
+  :description: "Test invalidate user's tokens"
+-
+  :file: 'token/10_basic.yml'
+  :description: "Test invalidate realm's tokens"
+
+ # Skipping due to testing conditions:
+-
+  :file: 'ml/3rd_party_deployment.yml'
+  :description: 'Test put model alias on pytorch model'
+-
+  :file: 'ml/3rd_party_deployment.yml'
+  :description: 'Test update model alias on pytorch model to undeployed model'
+-
+  :file: 'ml/3rd_party_deployment.yml'
+  :description: 'Test cannot start 2 deployments with the same Id'
+-
+  :file: 'ml/3rd_party_deployment.yml'
+  :description: 'Test cannot create model with a deployment Id'
+-
+  :file: 'ml/3rd_party_deployment.yml'
+  :description: 'Test clear deployment cache'
+- # Wrong error matching
+  :file: 'ml/3rd_party_deployment.yml'
+  :description: 'Test getting and putting Fill Mask with two mask tokens, as well as exceptions caused by requests with the wrong token'
+
+-
+  :file: 'searchable_snapshots/20_synthetic_source.yml'
+  :description: 'Tests searchable snapshots usage stats'
+-
+  :file: 'snapshot/20_operator_privileges_disabled.yml'
+  :description: '*'
+
+-
+  :file: 'token/11_invalidation.yml'
+  :description: 'Test invalidate access token return statuses'
+-
+  :file: 'token/11_invalidation.yml'
+  :description: 'Test invalidate refresh token return statuses'
+
+# Implemented manually:
+-
+  :file: 'ml/get_memory_stats.yml'
+  :description: '*'
+
+-
+  :file: 'eql/30_async_missing_events.yml'
+  :description: 'Execute async EQL with missing events'
+-
+  :file: 'api_key/60_admin_user.yml'
+  :description: 'Test get api key (with role descriptors + metadata)'
+-
+  :file: 'api_key/60_admin_user.yml'
+  :description: 'Test query api keys'
+
+-
+  :file: 'spatial/70_script_doc_values.yml'
+  :description: '*'
+-
+  :file: 'esql/60_usage.yml'
+  :description: 'Basic ESQL usage output (telemetry)'
+-
+  :file: 'users/40_query.yml'
+  :description: 'Test query user'
+-
+  :file: 'api_key/21_query_with_aggs.yml'
+  :description: 'Test composite aggs api key'

data/spec/rspec_formatter.rb

@@ -0,0 +1,31 @@
+# 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.
+
+class RSpecCustomFormatter < RSpec::Core::Formatters::JsonFormatter
+  RSpec::Core::Formatters.register self
+
+  LOGFILE = File.new("tmp/rspec-#{ENV['TEST_SUITE']}-#{RUBY_VERSION}.log", 'w')
+
+  def close(_notification)
+    @output_hash[:examples].map do |example|
+      regexp = /\S+\/\S+/
+      filename = example[:full_description].match(/\S+\/\S+/)[0]
+      log ="#{filename} | #{example[:status]} | #{example[:run_time]} | #{example[:full_description]}\n"
+      File.write(LOGFILE, log, mode: 'a')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -14,35 +14,30 @@
 # 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'
 else
-  require 'pry-byebug'
+  require 'debug'
 end
-require 'ansi'
-require 'elasticsearch'
-require 'elasticsearch-api'
-require 'elasticsearch-transport'
+require 'yaml'
+require 'active_support/isolated_execution_state' unless RUBY_VERSION < '2.7.0'
 require 'jbuilder'
 require 'jsonify'
-require 'yaml'
+require 'elasticsearch'
+require 'elasticsearch-api'
+require 'openssl'
+require 'logger'
 
 tracer = ::Logger.new(STDERR)
-tracer.formatter = lambda { |s, d, p, m| "#{m.gsub(/^.*$/) { |n| '   ' + n }.ansi(:faint)}\n" }
-
-unless defined?(ELASTICSEARCH_URL)
-  ELASTICSEARCH_URL = ENV['ELASTICSEARCH_URL'] ||
-                        ENV['TEST_ES_SERVER'] ||
-                        "localhost:#{(ENV['TEST_CLUSTER_PORT'] || 9200)}"
-end
-
-DEFAULT_CLIENT = Elasticsearch::Client.new(host: ELASTICSEARCH_URL,
-                                           tracer: (tracer unless ENV['QUIET']))
+tracer.formatter = lambda { |s, d, p, m| "#{m.gsub(/^.*$/) { |n| '   ' + n } }\n" }
 
 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)
@@ -63,9 +58,17 @@ end
 
 RSpec.configure do |config|
   config.include(HelperModule)
-  config.formatter = 'documentation'
-  config.color = true
-  config.add_formatter('RspecJunitFormatter', 'tmp/elasticsearch-api-junit.xml')
+  config.add_formatter('documentation')
+  if defined?(JRUBY_VERSION)
+    config.add_formatter('RSpec::Core::Formatters::HtmlFormatter', "tmp/elasticsearch-#{ENV['TEST_SUITE']}-jruby-#{JRUBY_VERSION}.html")
+  else
+    config.add_formatter('RSpec::Core::Formatters::HtmlFormatter', "tmp/elasticsearch-#{ENV['TEST_SUITE']}-#{RUBY_VERSION}.html")
+  end
+  if ENV['BUILDKITE']
+    require_relative "./rspec_formatter.rb"
+    config.add_formatter('RSpecCustomFormatter')
+  end
+  config.color_mode = :on
 end
 
 class NotFound < StandardError; end

data/utils/Gemfile

@@ -17,12 +17,10 @@
 
 source 'https://rubygems.org'
 
-gem 'activesupport'
-gem 'byebug'
 gem 'coderay'
+gem 'debug' unless defined?(JRUBY_VERSION)
 gem 'json'
 gem 'multi_json'
 gem 'pry'
-gem 'rest-client'
 gem 'rubocop'
 gem 'thor'

data/utils/README.md

@@ -2,24 +2,31 @@
 
 ## The Generator
 
-This directory hosts The Generator, a tool that generates the classes for each API endpoint from the [Elasticsearch REST API JSON Specification](https://github.com/elastic/elasticsearch/tree/master/rest-api-spec).
+This directory hosts The Generator, a tool that generates the classes for each API endpoint from the [Elasticsearch REST API JSON Specification](https://github.com/elastic/elasticsearch/tree/main/rest-api-spec).
 
 ### 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
-$ thor api:code:generate
+$ rake elasticsearch:download_artifacts
+```
+
+Once the JSON files have been downloaded, you need to run (from this folder):
+```bash
+$ thor code:generate
 ```
 
-- The oss Ruby code will be generated in `elasticsearch-api/lib/elasticsearch/api/actions`.  
-- The xpack Ruby code will be generated in `elasticsearch-xpack/lib/elasticsearch/xpack/api/actions`.
+- The Ruby code will be generated in `elasticsearch-api/lib/elasticsearch/api/actions`.
 - The generator runs Rubocop to autolint and clean up the generated files.
+- You can use the environment variable `IGNORE_VERSION` to ignore the current version of the client when generating the source code documentation urls. This is currently used when generating code from `main`:
 
-Alternatively, you can pass in `oss` or `xpack` as parameters to generate only one of the 2 sets of endpoints:
+```bash
+$ IGNORE_VERSION=true thor code:generate
+```
 
+- You can use the environment variable `BUILD_HASH` to update the build hash for the generated code from the `tmp/rest-api-spec/build_hash` file. This file is updated every time you use the `elasticsearch:download_artifacts` Rake task is used in the root of the project to download the latest Elasticsearch specs and tests:
 ```bash
-$ thor api:code:generate --api=xpack
-$ thor api:code:generate --api=oss
+$ BUILD_HASH=true thor code:generate
 ```
 
 ### Development