elasticsearch-api 7.13.3 → 8.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d942f82af15ad27d4ba1e43be15fa496d6136fc8c255334ef80eb5e60739f29
-  data.tar.gz: 41dd752da3a20fd4cb9fc307bea21aa5d2c86f442151702179218b3a2a3954cd
+  metadata.gz: 48a1f0762bf3581cab4b030cb4e6d7542ec46428330428200cb1bd391e189ae6
+  data.tar.gz: b308b299290fd997c9000fce4400ac0b685efc03c9a2ae681a7b5bb5ade91398
 SHA512:
-  metadata.gz: ecf05b89094afb7702755f6e314bbc29f0b4bb670c50d5540b46e8a0757752547e9a39b739613e6e356d7ca90295a7a0bd547251e474cb3b214308b684dae328
-  data.tar.gz: e61fff3d3f6a5451af2f6a6ed03f5fa8d71c0240f9c629d65f1f35d453b52de8880e86e01f8a0f0fe3f5af208e36fe0fae038d34cbffa5200d066846ca960683
+  metadata.gz: 59292fa91b9edf4d1af23eb0a73241596be0bacde69b15e567a7b61461495cc0efc9e43b287441688eb258c0f90d0d2883bf5440d3ee91a9ec22e5d1004b4c0c
+  data.tar.gz: 3469c3a62f0c2199c2f2a437b91fd2d73eb4edfb533e4d5b2a3ea450376acbfa66dbde977a40285e5a021cbea5fb441891c33619f092abb268725e4cb5d38095

data/Gemfile

@@ -21,15 +21,7 @@ source 'https://rubygems.org'
 gemspec
 
 if File.exist? File.expand_path("../../elasticsearch/elasticsearch.gemspec", __FILE__)
-  gem 'elasticsearch', path: File.expand_path("../../elasticsearch", __FILE__), require: false
-end
-
-if File.exist? File.expand_path("../../elasticsearch-transport", __FILE__)
-  gem 'elasticsearch-transport', path: File.expand_path("../../elasticsearch-transport", __FILE__), require: true
-end
-
-if File.exist? File.expand_path("../../elasticsearch-extensions", __FILE__)
-  gem 'elasticsearch-extensions', path: File.expand_path("../../elasticsearch-extensions", __FILE__), require: false
+  gem 'elasticsearch', path: File.expand_path('../../elasticsearch', __FILE__), require: false
 end
 
 group :development do
@@ -38,6 +30,6 @@ group :development do
   if defined?(JRUBY_VERSION)
     gem 'pry-nav'
   else
-    gem 'pry-byebug'
+    gem 'debug'
   end
 end

data/README.md

@@ -1,206 +1,35 @@
 # Elasticsearch::API
 
-**This library is part of the [`elasticsearch-ruby`](https://github.com/elasticsearch/elasticsearch-ruby/) package;
-please refer to it, unless you want to use this library standalone.**
+*This library is part of the [`elasticsearch-ruby`](https://github.com/elasticsearch/elasticsearch-ruby/) package; please refer to it, unless you want to use this library standalone.*
 
-----
+**Refer to the [official documentation on Elasticsearch API](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/api.html).**
 
-The `elasticsearch-api` library provides a Ruby implementation of
-the [Elasticsearch](http://elasticsearch.com) REST API.
+The `elasticsearch-api` library provides a Ruby implementation of the [Elasticsearch](http://elasticsearch.com) REST API. It does not provide an Elasticsearch client; see the [`elastic-transport`](https://github.com/elastic/elastic-transport-ruby/) library.
 
-It does not provide an Elasticsearch client; see the
-[`elasticsearch-transport`](https://github.com/elasticsearch/elasticsearch-ruby/tree/master/elasticsearch-transport) library.
+We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/).
 
-The library is compatible with Ruby 1.9 and higher.
+Language clients are forward compatible; meaning that clients support communicating with greater minor versions of Elasticsearch. Elastic language clients are also backwards compatible with lesser supported minor Elasticsearch versions.
 
-It is compatible with Elasticsearch's API versions from 0.90 till current, just use a release matching major version of Elasticsearch.
 
-| Ruby          |   | Elasticsearch |
-|:-------------:|:-:| :-----------: |
-| 0.90          | → | 0.90          |
-| 1.x           | → | 1.x           |
-| 2.x           | → | 2.x           |
-| 5.x           | → | 5.x           |
-| 6.x           | → | 6.x           |
-| 7.x           | → | 7.x           |
-| master        | → | master        |
-
-## Installation
-
-Install the package from [Rubygems](https://rubygems.org):
-
-    gem install elasticsearch-api
-
-To use an unreleased version, either add it to your `Gemfile` for [Bundler](http://gembundler.com):
-
-    gem 'elasticsearch-api', git: 'git://github.com/elasticsearch/elasticsearch-ruby.git'
-
-or install it from a source code checkout:
-
-    git clone https://github.com/elasticsearch/elasticsearch-ruby.git
-    cd elasticsearch-ruby/elasticsearch-api
-    bundle install
-    rake install
-
-## Usage
-
-The library is designed as a group of standalone Ruby modules, which can be mixed into a class
-providing connection to Elasticsearch -- an Elasticsearch client.
-
-### Usage with the `elasticsearch` gem
-
-**When you use the client from the [`elasticsearch-ruby`](https://github.com/elasticsearch/elasticsearch-ruby/) package,
-the library modules have been already included**, so you just call the API methods:
-
-```ruby
-require 'elasticsearch'
-
-client = Elasticsearch::Client.new log: true
-
-client.index  index: 'myindex', type: 'mytype', id: 1, body: { title: 'Test' }
-# => {"_index"=>"myindex", ... "created"=>true}
-
-client.search index: 'myindex', body: { query: { match: { title: 'test' } } }
-# => {"took"=>2, ..., "hits"=>{"total":5, ...}}
-```
-
-Full documentation and examples are included as RDoc annotations in the source code
-and available online at <http://rubydoc.info/gems/elasticsearch-api>.
-
-### Usage with a custom client
-
-When you want to mix the library into your own client, it must conform to a following _contract_:
-
-* It responds to a `perform_request(method, path, params, body, headers)` method,
-* the method returns an object with `status`, `body` and `headers` methods.
-
-A simple client could look like this (_with a dependency on `active_support` to parse the query params_):
-
-```ruby
-require 'multi_json'
-require 'faraday'
-require 'elasticsearch/api'
-require 'active_support'
-
-class MySimpleClient
-  include Elasticsearch::API
-
-  CONNECTION = ::Faraday::Connection.new url: 'http://localhost:9200'
-
-  def perform_request(method, path, params, body, headers = nil)
-    puts "--> #{method.upcase} #{path} #{params} #{body} #{headers}"
-
-    CONNECTION.run_request \
-      method.downcase.to_sym,
-      path_with_params(path, params),
-      ( body ? MultiJson.dump(body): nil ),
-      {'Content-Type' => 'application/json'}
-  end
-  
-  private
-  
-  def path_with_params(path, params)
-    return path if params.blank?
-  
-    case params
-    when String
-      "#{path}?#{params}"
-    when Hash
-      "#{path}?#{params.to_query}"
-    else
-      raise ArgumentError, "Cannot parse params: '#{params}'"
-    end
-  end
-end
-
-client = MySimpleClient.new
-
-p client.cluster.health
-# --> GET _cluster/health {}
-# => "{"cluster_name":"elasticsearch" ... }"
-
-p client.index index: 'myindex', type: 'mytype', id: 'custom', body: { title: "Indexing from my client" }
-# --> PUT myindex/mytype/custom {} {:title=>"Indexing from my client"}
-# => "{"ok":true, ... }"
-```
-
-### Using JSON Builders
-
-Instead of passing the `:body` argument as a Ruby _Hash_, you can pass it as a _String_, potentially
-taking advantage of JSON builders such as [JBuilder](https://github.com/rails/jbuilder) or
-[Jsonify](https://github.com/bsiggelkow/jsonify):
-
-```ruby
-require 'jbuilder'
-
-query = Jbuilder.encode do |json|
-  json.query do
-    json.match do
-      json.title do
-        json.query    'test 1'
-        json.operator 'and'
-      end
-    end
-  end
-end
-
-client.search index: 'myindex', body: query
-
-# 2013-06-25 09:56:05 +0200: GET http://localhost:9200/myindex/_search [status:200, request:0.015s, query:0.011s]
-# 2013-06-25 09:56:05 +0200: > {"query":{"match":{"title":{"query":"test 1","operator":"and"}}}}
-# ...
-# => {"took"=>21, ..., "hits"=>{"total"=>1, "hits"=>[{ "_source"=>{"title"=>"Test 1", ...}}]}}
-```
+## Development
 
-### Using Hash Wrappers
+Refer to [CONTRIBUTING](https://github.com/elastic/elasticsearch-ruby/blob/main/CONTRIBUTING.md).
 
-For a more comfortable access to response properties, you may wrap it in one of the _Hash_ "object access"
-wrappers, such as [`Hashie::Mash`](https://github.com/intridea/hashie):
+We run the test suite for Elasticsearch's Rest API tests. You can read more about this in [the test runner README](https://github.com/elastic/elasticsearch-ruby/tree/main/api-spec-testing#rest-api-yaml-test-runner).
 
-```ruby
-require 'hashie'
-
-response = client.search index: 'myindex',
-                         body: {
-                           query: { match: { title: 'test' } },
-                           aggregations: { tags: { terms: { field: 'tags' } } }
-                         }
-
-mash = Hashie::Mash.new response
-
-mash.hits.hits.first._source.title
-# => 'Test'
-
-mash.aggregations.tags.terms.first
-# => #<Hashie::Mash count=3 term="z">
-```
-
-### Using a Custom JSON Serializer
-
-The library uses the [MultiJson](https://rubygems.org/gems/multi_json/) gem by default,
-but allows you to set a custom JSON library, provided it uses the standard `load/dump`
-interface:
-
-```ruby
-Elasticsearch::API.settings[:serializer] = JrJackson::Json
-Elasticsearch::API.serializer.dump({foo: 'bar'})
-# => {"foo":"bar"}
-```
+The `rest_api` task needs the test files from Elasticsearch. You can run the rake task to download the test artifacts in the root folder of the project. You can pass in a version to the task as a parameter:
 
-## Development
+`rake download_artifacts[8.5.0-SNAPSHOT]`
 
-To work on the code, clone and bootstrap the main repository first -- please see instructions in the main [README](../README.md#development).
+Or it can get the version from a running cluster to determine which version and build hash of Elasticsearch to use and test against:
 
-To run tests, launch a testing cluster -- again, see instructions in the main [README](../README.md#development) -- and use the Rake tasks:
+`TEST_ES_SERVER=http://localhost:9200 rake elasticsearch:download_artifacts`
 
-```
-time rake test:unit
-time rake test:integration
-```
+This will download the necessary files used for the integration tests to `./tmp`.
 
-We run the test suite for Elasticsearch's Rest API tests. You can read more about this in [the test runner README](https://github.com/elastic/elasticsearch-ruby/tree/master/api-spec-testing#rest-api-yaml-test-runner).
+### Code generation
 
-The `rest_api` needs the test files from Elasticsearch. You can run the rake task to download the test artifacts in the root folder of the project. This task needs a running cluster to determine which version and build hash of Elasticsearch to use and test against. `TEST_ES_SERVER=http://localhost:9200 rake test:download_artifacts`. This will download the necessary files used for the integration tests to `./tmp`.
+The code for most of this library is automatically generated. See [./utils/README.md](utils/README.md) for more information.
 
 ## License
 

data/Rakefile

@@ -20,47 +20,28 @@ require 'json'
 
 task(:default) { system 'rake --tasks' }
 task test: 'test:unit'
-
-# ----- Test tasks ------------------------------------------------------------
-
 require 'rake/testtask'
 require 'rspec/core/rake_task'
 
+# Test Tasks
+
 namespace :test do
   desc 'Wait for Elasticsearch to be in a green state'
   task :wait_for_green do
     sh '../scripts/wait-cluster.sh'
   end
 
-  # Unit tests - rake test:unit
-  #
+  desc 'Run unit tests'
   task unit: :spec
   RSpec::Core::RakeTask.new(:spec) do |t|
-    t.exclude_pattern = 'spec/**{,/*/**}/rest_api_yaml_spec.rb'
+    t.pattern = 'spec/elasticsearch/api/**/*_spec.rb'
+    t.exclude_pattern = 'spec/platinum/**/*_spec.rb'
   end
 
-  desc "Run Rest API Spec tests"
+  desc 'Run Rest API Spec tests'
   RSpec::Core::RakeTask.new(:rest_api) do |t|
-    require 'elasticsearch'
-    # Check if a test cluster is running
-    begin
-      url = ENV['TEST_CLUSTER_URL'] || ENV['TEST_ES_SERVER']
-      url = "http://localhost:#{ENV['TEST_CLUSTER_PORT'] || 9200}" unless url
-      client = Elasticsearch::Client.new :url => url
-      es_version_info = client.info['version']
-      version_number = es_version_info['number']
-      build_hash      = es_version_info['build_hash']
-    rescue Faraday::ConnectionFailed
-      STDERR.puts "[!] Test cluster not running?"
-      exit 1
-    end
-
-    t.pattern = 'spec/**{,/*/**}/rest_api_yaml_spec.rb'
-  end
-
-  desc "Run integration tests"
-  task :integration do
-    Rake::Task['test:rest_api'].invoke
+    test_dir = Rake.application.original_dir
+    t.pattern = "#{test_dir}/spec/rest_api/rest_api_yaml_spec.rb"
   end
 
   desc 'Run unit and integration tests'
@@ -69,67 +50,41 @@ namespace :test do
     Rake::Task['test:integration'].invoke
   end
 
-  def refresh_artifacts(build_hash, version_number)
-    unless build_hash
-      STDERR.puts "[!] Cannot determine checkout build hash -- server not running"
-      exit(1)
+  namespace :platinum do
+    desc 'Run Platinum Rest API Spec tests'
+    RSpec::Core::RakeTask.new(:api) do
+      ENV['TEST_SUITE'] = 'platinum'
+      Rake::Task['test:rest_api'].invoke
     end
 
-    puts 'Downloading artifacts file...'
-    filename = 'tmp/artifacts.json'
-    `curl -s https://artifacts-api.elastic.co/v1/versions/#{version_number} -o #{filename}`
-
-    unless File.exists?("./#{filename}")
-      STDERR.puts '[!] Couldn\'t download artifacts file'
-      exit 1
-    end
-
-    artifacts = JSON.parse(File.read('./tmp/artifacts.json'))
-
-    build_hash_artifact = artifacts['version']['builds'].select do |a|
-      a.dig('projects', 'elasticsearch', 'commit_hash') == build_hash
-    end.first
-    # Dig into the elasticsearch packages, search for the rest-resources-zip package and catch the URL:
-    zip_url = build_hash_artifact.dig('projects', 'elasticsearch', 'packages').select { |k,v| k =~ /rest-resources-zip/ }.map { | _, v| v['url'] }.first
-
-    filename = zip_url.split('/').last
-    puts 'Downloading zip file:'
-    `curl -s #{zip_url} -o tmp/#{filename}`
-
-    unless File.exists?("./tmp/#{filename}")
-      STDERR.puts '[!] Couldn\'t download artifact'
-      exit 1
-    end
-
-    puts "Unzipping file #{filename}"
-    `unzip -o tmp/#{filename} -d tmp/`
-  end
-
-  namespace :cluster do
-    desc "Start Elasticsearch nodes for tests"
-    task :start do
-      $LOAD_PATH << File.expand_path('../../elasticsearch-transport/lib', __FILE__) << File.expand_path('../test', __FILE__)
-      require 'elasticsearch/extensions/test/cluster'
-      Elasticsearch::Extensions::Test::Cluster.start
+    desc 'Run Platinum Unit tests - DEPRECATED: Will be migrated to RSpec'
+    Rake::TestTask.new(:unit) do |test|
+      test.libs << 'spec/platinum/unit'
+      test.test_files = FileList['spec/platinum/unit/**/*_test.rb']
+      test.verbose = false
+      test.warning = false
     end
 
-    desc "Stop Elasticsearch nodes for tests"
-    task :stop do
-      $LOAD_PATH << File.expand_path('../../elasticsearch-transport/lib', __FILE__) << File.expand_path('../test', __FILE__)
-      require 'elasticsearch/extensions/test/cluster'
-      Elasticsearch::Extensions::Test::Cluster.stop
+    desc 'Run Platinum Integration Specs'
+    RSpec::Core::RakeTask.new(:integration) do |t|
+      t.pattern = if ENV['TEST_SUITE'] == 'platinum'
+                    'spec/platinum/integration/**/*_spec.rb'
+                  else
+                    'spec/free/integration/**/*_spec.rb'
+                  end
+      t.ruby_opts = '-W0'
     end
   end
 end
 
-# ----- Documentation tasks ---------------------------------------------------
+# Documentation tasks
 
 require 'yard'
 YARD::Rake::YardocTask.new(:doc) do |t|
   t.options = %w| --embed-mixins --markup=markdown |
 end
 
-# ----- Code analysis tasks ---------------------------------------------------
+# Code analysis tasks
 
 require 'cane/rake_task'
 Cane::RakeTask.new(:quality) do |cane|

data/api-spec-testing/README.md

@@ -0,0 +1,118 @@
+# Rest API YAML Test Runner
+
+The specs in `elasticsearch-api` automatically run the tests from [Elasticsearch's REST API Spec tests](https://github.com/elastic/elasticsearch/tree/main/rest-api-spec/src/main/resources/rest-api-spec/test#test-suite). The test runner is defined in the `spec` folder, starting with the `rest_api_yaml_spec.rb` file.
+
+You can run the tests with Rake. The main task is `rake test:rest_api`. This task will evaluate the `TEST_SUITE` environment variable. It will run either the `free` or `platinum` tests suites depending on the value of `TEST_SUITE`. If you don't set this value, the task will run the `free` test suite by default. To run the `platinum` test suite use:
+```
+TEST_SUITE=platinum rake test:rest_api
+```
+
+Or the shortcut:
+```
+rake test:platinum:api
+```
+
+## REST API YAML Spec
+
+The file that traverses the yaml files and loads a **TestFile** object per each of them:
+`elasticsearch-api/spec/elasticsearch/api/rest_api_yaml_spec.rb`
+
+You can use the SINGLE_TEST env variable to run just one test or one test directory. E.g.:
+```
+$ cd elasticsearch-api && SINGLE_TEST=indices.resolve_index/10_basic_resolve_index.yml TEST_ES_SERVER='http://localhost:9200' be rake test:rest_api
+```
+And:
+```
+$ cd elasticsearch-api && SINGLE_TEST=indices.resolve_index TEST_ES_SERVER='http://localhost:9200' be rake test:rest_api
+```
+
+## Skipped tests
+
+We sometimes skip tests, generally due to limitations on how we run the CI server or for stuff that hasn't been completely implemented on the client yet. Skipped tests are located in `elasticsearch-api/spec/skipped_tests.yml`. You can run just the tests which are currently being skipped by running:
+```
+$ cd elasticsearch-api && TEST_SUITE=(free|platinum) RUN_SKIPPED_TESTS=true TEST_ES_SERVER='http://localhost:9200' be rake test:rest_api
+```
+
+## TestFile
+Class representing a single test file. Contains setup, teardown and tests.   
+`../api-spec-testing/test_file.rb`
+
+## Test
+Every single test in the test file is represented in the Test object.   
+`../api-spec-testing/test_file/test.rb`
+
+## TaskGroup
+
+Tests are ordered in task groups, an array of TaskGroup objects.  
+`../api-spec-testing/test_file/task_group.rb`
+
+Task Groups are a representation of a block of actions consisting of 'do' actions and their verifications. e.g.: 
+```yaml
+ - do:
+      index:
+          index:  test-index
+          id:     1
+          body:   { foo: bar }
+
+ - match:   { _index:   test-index }
+ - match:   { _id:      "1"}
+ - match:   { _version: 1}
+```
+
+**Before** each test, the spec runner runs `clear_data` on the test_file. This clears indices, index templates, snapshots and repositories. For platinum it also clears roles, users, privileges, datafeeds, ml_jobs and more.
+
+**After** each test, it runs the test file teardown and `clear_data` again.
+
+For each TaskGroup, it sees what's in the task group definition and runs an expectation test.
+
+## Action
+
+This file is where the action is executed, where we call the client with the method from the test and save the response which is then used in the task group.
+
+## Rest YAML tests Helper
+
+`elasticsearch-api/spec/rest_yaml_tests_helper.rb`
+
+- `ADMIN_CLIENT` is defined here.
+- `SINGLE_TEST` is defined here.
+- Skipped tests are listed here
+
+## Spec Helper
+
+- `DEFAULT_CLIENT` is defined here
+
+## Enable Logging
+
+To enable logging, set the environment `QUIET` to false before running the tests. In CI, this is located in the [Dockerfile](https://github.com/elastic/elasticsearch-ruby/blob/main/.ci/Dockerfile). The environment variable is evaluated in the Rest YAML tests Helper file.
+
+# Features
+
+## RSpec Matchers
+
+The tests use custom [RSpec Matchers](https://www.rubydoc.info/gems/rspec-expectations/RSpec/Matchers) defined in `api-spec-testing/rspec_matchers.rb`.
+
+From the [Rest API test docs](https://github.com/elastic/elasticsearch/tree/main/rest-api-spec/src/main/resources/rest-api-spec/test#do):
+
+## `catch`
+
+> If the arguments to `do` include `catch`, then we are expecting an error, which should be caught and tested.
+
+In `rest_api_yaml_spec`, there's a check for `catch_exception?` per task_group. This checks if the `do` definitions have any `catch` definitions. If there is a `catch`, it'll send the request and use the `match_error` RSpec custom matcher to validate the expected error.
+
+## `warnings`
+
+>If the arguments to `do` include `warnings` then we are expecting a Warning header to come back from the request. If the arguments don’t include a warnings argument then we don’t expect the response to include a Warning header. The warnings must match exactly. Using it looks like this:
+
+```
+- do:
+    warnings:
+        - '[index] is deprecated'
+        - quotes are not required because yaml
+        - but this argument is always a list, never a single string
+        - no matter how many warnings you expect
+    get:
+        index:    test
+        type:    test
+        id:        1
+```
+

data/api-spec-testing/custom_cleanup.rb

@@ -0,0 +1,32 @@
+# 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 RestAPIYAMLTests
+    # Custom functions for wipe cluster
+    module CustomCleanup
+      class << self
+        def wipe_calendars(client)
+          calendars = client.ml.get_calendars(calendar_id: '_all').body['calendars']
+          calendars.each do |calendar|
+            client.ml.delete_calendar(calendar_id: calendar['calendar_id'])
+          end
+        end
+      end
+    end
+  end
+end

data/api-spec-testing/logging.rb

@@ -0,0 +1,28 @@
+# 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 'logger'
+
+module Elasticsearch
+  module RestAPIYAMLTests
+    module Logging
+      def logger
+        @logger ||= Logger.new($stdout)
+      end
+    end
+  end
+end