elasticsearch-test-runner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 139cdbecff8a7f080c63ce718ceee51b4718629d604b2a70f49e456fb898abee
+  data.tar.gz: f5917106b5f1a17c1e74b664c1a16c485e4d0e623e1e2e5293f20954fb5d0ea5
+SHA512:
+  metadata.gz: b592e11ccbeae18bb9fbd0fe5760caea1bda3ed891895073854dfc11861f6d7c386dd6b973b3807598565d6da81332be6839bcae4ad64d75b8693645bea08a2d
+  data.tar.gz: db573c22f278bef0e57a1fc3a79fd7c9ab296504d108b2b2cded3648057c2e3df5f59230ef41a14c7fe61a92e3c10cfee247734e8f45125560d4adb1a7a9c659

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-02-22
+
+- Initial release

data/CODE_OF_CONDUCT

@@ -0,0 +1 @@
+See: https://www.elastic.co/community/codeofconduct

data/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+The process for contributing to any of the [Elasticsearch](https://github.com/elasticsearch) repositories is similar:
+
+1. It is best to do your work in a separate Git branch. This makes it easier to synchronise your changes with [`rebase`](http://mislav.uniqpath.com/2013/02/merge-vs-rebase/).
+
+2. Make sure your changes don't break any existing tests, and that you add tests for both bugfixes and new functionality. If you want to examine the test coverage, you can generate a report by running `COVERAGE=true rake test:all`.
+
+3. **Sign the contributor license agreement.**
+Please make sure you have signed the [Contributor License Agreement](https://www.elastic.co/contributor-agreement/). We are not asking you to assign copyright to us, but to give us the right to distribute your code without restriction. We ask this of all contributors in order to assure our users of the origin and continuing existence of the code. You only need to sign the CLA once.
+
+4. Submit a pull request.
+Push your local changes to your forked copy of the repository and submit a pull request. In the pull request, describe what your changes do and mention the number of the issue where discussion has taken place, eg “Closes #123″.

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed 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.

data/NOTICE

@@ -0,0 +1,2 @@
+Elasticsearch Ruby Tests Runner
+Copyright 2024 Elasticsearch B.V.

data/README.md

@@ -0,0 +1,56 @@
+# Elasticsearch Tests Runner
+
+This gem is a tool for Elasticsearch Ruby clients to run the [Elasticsearch Clients Tests](https://github.com/elastic/elasticsearch-clients-tests). The Client tests project is a test suite in the YAML format. It defines a set of actions and expectations to run against Elasticsearch. The are designed to run with Elasticsearch clients, with the goal to reuse across different Elasticsearch clients in different programming languages.
+
+This is the Ruby version and is being used in the [elasticsearch](https://github.com/elastic/elasticsearch-ruby) and [elasticsearch-serverless](https://github.com/elastic/elasticsearch-serverless-ruby/) Ruby clients.
+
+## Installation
+
+Add the gem to the application's Gemfile:
+
+```ruby
+gem 'elasticsearch-test-runner', git: 'git@github.com:elastic/es-test-runner-ruby.git'
+```
+
+## Usage
+
+To start using the library, add this to your code:
+
+```ruby
+# Require the library
+require 'elasticsearch/tests/test_runner'
+# Define a path where the test files are being stored:
+tests_path = File.expand_path('./tmp', __dir__)
+# Instantiate an Elasticsearch client
+client = Elasticsearch::Client.new
+# Instantiate and run the test runner:
+Elasticsearch::Tests::TestRunner.new(client, tests_path).run
+```
+
+[The tests](https://github.com/elastic/elasticsearch-clients-tests) are designed for the Elasticsearch REST API and the Elasticsearch Serverless REST API. If you pass in an `ElasticsearchServerless::Client`, it will only run the tests that have the `requires.serverless: true` statement. Otherwise, it will only run the ones with `requires.stack: true`.
+
+You can optionally pass in an object that implements Ruby's Logger to the `TestRunner` initializer. This will log more information, particularly useful in the case of errors where it'll log stacktraces for exceptions and more:
+
+```ruby
+logger = Logger.new($stdout)
+logger.level = Logger::WARN unless ENV['DEBUG']
+
+Elasticsearch::Tests::TestRunner.new(client, tests_path, logger).run
+```
+
+You can **download the YAML test files** from [the clients tests project](https://github.com/elastic/elasticsearch-clients-tests) with the following code:
+
+```ruby
+require 'elasticsearch/tests/downloader'
+Elasticsearch::Tests::Downloader::run(tests_path)
+```
+
+Additionally, you can run the rake task `rake es_tests:download` included in `lib/elasticsearch/tasks`.
+
+## Development
+
+See [CONTRIBUTING](./CONTRIBUTING.md).
+
+## License
+
+This software is licensed under the [Apache 2 license](./LICENSE). See [NOTICE](./NOTICE).

data/Rakefile

@@ -0,0 +1,20 @@
+# 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 'bundler/gem_tasks'
+task default: %i[]
+Dir.glob('lib/elasticsearch/tasks/**/*.rake').each { |f| import f }

data/elasticsearch-tests.gemspec

@@ -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.
+
+# frozen_string_literal: true
+
+require_relative 'lib/elasticsearch/tests/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'elasticsearch-test-runner'
+  spec.email = ['client-libs@elastic.co']
+  spec.version = Elasticsearch::Tests::VERSION
+  spec.authors = ['Elastic Client Library Maintainers']
+  spec.licenses = ['Apache-2.0']
+  spec.summary = 'Tool to test Elasticsearch clients against the YAML clients test suite.'
+  spec.homepage = 'https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html'
+  spec.description = 'A test runner for the Elasticsearch clients YAML test suite, used in the elasticsearch and elasticsearch-serverless gems.'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/elastic/es-test-runner-ruby/blob/main/CHANGELOG.md'
+  spec.metadata['source_code_uri'] = 'https://github.com/elastic/es-test-runner-ruby/tree/main'
+
+  spec.required_ruby_version = '>= 3.0'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'elasticsearch'
+  spec.add_development_dependency 'elasticsearch-serverless'
+end

data/lib/elasticsearch/tasks/download_test_suite.rake

@@ -0,0 +1,25 @@
+# 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 'elasticsearch/tests/downloader'
+
+namespace :es_tests do
+  desc 'Download YAML test files'
+  task :download do |_, args|
+    tests_path = args[:path] || File.expand_path('../../tmp', __dir__)
+    Elasticsearch::Tests::Downloader::run(tests_path)
+  end
+end

data/lib/elasticsearch/tests/code_runner.rb

@@ -0,0 +1,216 @@
+# 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_relative 'printer'
+
+module Elasticsearch
+  module Tests
+    #
+    # The module in charge of actually running actions and matching expected results with actual response results.
+    #
+    module CodeRunner
+      include Elasticsearch::Tests::Printer
+
+      COMPARATORS = {
+        'lt' => '<',
+        'lte' => '<=',
+        'gt' => '>',
+        'gte' => '>='
+      }.freeze
+
+      # The main functionality in the test runner, run actions with the client from YAML `do`
+      # specifications. These are function calls to the Elasticsearch clients.
+      #
+      def do_action(action)
+        client = @client
+        action = action.first if action.is_a?(Array)
+        method, params = action.is_a?(String) ? [action, {}] : action.first
+
+        # Get the namespace client if the method is namespaced
+        if method.include?('.')
+          arrayed_method = method.split('.')
+          client = @client.send(arrayed_method.first)
+          method = arrayed_method.last
+        end
+
+        @response = client.send(method.to_sym, process_params(params))
+        @response
+      rescue StandardError => e
+        raise e
+      end
+
+      # Code for matching expectations and response
+      #
+      def do_match(action)
+        k, v = action['match'].first
+        v = instance_variable_get(v.gsub('$', '@')) if v.is_a?(String) && v.include?('$')
+        result = search_in_response(k)
+
+        if !result.nil? && (
+             result == v ||
+             (result.respond_to?(:include?) && result.include?(v)) ||
+             match_regexp(v, result)
+           )
+          print_success
+        else
+          print_match_failure(action)
+        end
+      end
+
+      def match_regexp(expected, result)
+        expected.is_a?(String) && expected.match?(/^\//) && result.match?(Regexp.new(expected.gsub('/', '')))
+      end
+
+      def do_length(action)
+        k, v = action['length'].first
+        result = search_in_response(k).count
+        if result && result == v
+          print_success
+        else
+          print_failure(action, @response)
+        end
+      end
+
+      #
+      # The specified key exists and has a true value (ie not 0, false, undefined, null)
+      # action - { 'is_true' => field } or { 'is_true' => '' }
+      #
+      def is_true(action)
+        if @response.respond_to?(:body) && !@response&.nil? && ['', []].include?(action['is_true'])
+          print_success
+          return
+        end
+
+        response_value = search_in_response(action['is_true']) unless [true, false].include?(@response)
+        if @response == true || !response_value.nil?
+          print_success
+        else
+          print_failure(action, @response)
+        end
+      end
+
+      def is_false(action)
+        response_value = search_in_response(action['is_false']) unless [true, false].include? @response
+        if @response == false || response_value.nil? || [false, 'false'].include?(response_value)
+          print_success
+        else
+          print_failure(action, @response)
+        end
+      end
+
+      #
+      # Used for comparing gte (greater or equal than), gt (greater than), lte (less or equal than)
+      # and lt (less than)
+      # action - { 'gte' => { 'key' => value } }
+      #
+      def compare(action)
+        operator, value = action.first
+        result = search_in_response(value.keys.first)
+        if result&.send(COMPARATORS[operator], value[value.keys.first])
+          print_success
+        else
+          print_failure(action, @response)
+        end
+      end
+
+      # When the yaml test has a set instruction, set an instance variable with that value coming
+      # from the response.
+      def set_variable(action)
+        k, v = action['set'].first
+        instance_variable_set("@#{v}", search_in_response(k))
+      end
+
+      private
+
+      # Given a key coming from a test definition, search the response body for a matching value.
+      #
+      def search_in_response(keys)
+        if (match = /\$([a-z]+)/.match(keys))
+          return @response.send(match[1])
+        end
+
+        if keys.include?('.')
+          key = split_and_parse_key(keys)
+          return find_value_in_document(key, @response.body)
+        end
+
+        @response[keys]
+      end
+
+      # Symbolizes keys and replaces parameters defined as dynamic in the yaml spec (e.g. $body)
+      # with the corresponding variable set in set_variable
+      #
+      def process_params(params)
+        params = params.transform_keys(&:to_sym)
+        params.map do |key, param|
+          params[key] = process_params(param) if param.is_a?(Hash)
+          set_param_variable(params, key, param)
+          param.map { |param| set_param_variable(params, key, param) } if param.is_a?(Array)
+        end
+        params
+      end
+
+      def set_param_variable(params, key, param)
+        params[key] = instance_variable_get(param.gsub('$', '@')) if param.is_a?(String) && param.include?('$')
+      end
+
+      # Given a list of keys, find the value in a recursively nested document.
+      #
+      # @param [ Array<String> ] chain The list of nested document keys.
+      # @param [ Hash ] document The document to find the value in.
+      #
+      # @return [ Object ] The value at the nested key.
+      #
+      def find_value_in_document(chain, document)
+        return document[chain] unless chain.is_a?(Array)
+        return document[chain[0]] unless chain.size > 1
+
+        # a number can be a string key in a Hash or indicate an element in a list
+        if document.is_a?(Hash)
+          find_value_in_document(chain[1..], document[chain[0].to_s]) if document[chain[0].to_s]
+        elsif document[chain[0]]
+          find_value_in_document(chain[1..], document[chain[0]]) if document[chain[0]]
+        end
+      end
+
+      # Given a string representing a nested document key using dot notation,
+      #   split it, keeping escaped dots as part of a key name and replacing
+      #   numerics with a Ruby Integer.
+      #
+      # For example:
+      #   "joe.metadata.2.key2" => ['joe', 'metadata', 2, 'key2']
+      #   "jobs.0.node.attributes.ml\\.enabled" => ["jobs", 0, "node", "attributes", "ml\\.enabled"]
+      #
+      # @param [ String ] chain The list of nested document keys.
+      # @param [ Hash ] document The document to find the value in.
+      #
+      # @return [ Array<Object> ] A list of the nested keys.
+      #
+      def split_and_parse_key(key)
+        key.split(/(?<!\\)\./).reject(&:empty?).map do |key_part|
+          case key_part
+          when /^\.\$/ # For keys in the form of .$key
+            key_part.gsub(/^\./, '')
+          when /\A[-+]?[0-9]+\z/
+            key_part.to_i
+          else
+            key_part.gsub('\\', '')
+          end
+        end.reject { |k| k == '$body' }
+      end
+    end
+  end
+end

data/lib/elasticsearch/tests/downloader.rb

@@ -0,0 +1,64 @@
+# 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 'open-uri'
+
+module Elasticsearch
+  module Tests
+    # Module for downloading the test files
+    module Downloader
+      class << self
+        FILENAME = 'tests.zip'.freeze
+
+        def run(path, branch = 'main')
+          delete_files(path)
+          url = "https://api.github.com/repos/elastic/serverless-clients-tests/zipball/#{branch}"
+          if download_tests(url)
+            puts "Successfully downloaded #{FILENAME}"
+          else
+            warn "[!] Couldn't download #{FILENAME}"
+            return
+          end
+          unzip_file(path)
+          File.delete(FILENAME)
+        end
+
+        def download_tests(url)
+          File.open(FILENAME, 'w') do |downloaded_file|
+            uri = URI.parse(url)
+            uri.open('Accept' => 'application/vnd.github+json') do |artifact_file|
+              downloaded_file.write(artifact_file.read)
+            end
+          end
+          File.exist?(FILENAME)
+        end
+
+        private
+
+        def unzip_file(path)
+          puts 'Unzipping files'
+          puts path
+          `unzip #{FILENAME} -d #{path}/`
+          puts 'Removing zip file'
+        end
+
+        def delete_files(path)
+          FileUtils.rm_rf(Dir.glob("#{path}/**/*"), secure: true)
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/tests/errors.rb

@@ -0,0 +1,23 @@
+# 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 Tests
+    class TestFailure < StandardError; end
+    class TestError < StandardError; end
+  end
+end

data/lib/elasticsearch/tests/printer.rb

@@ -0,0 +1,80 @@
+# 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_relative 'errors'
+
+module Elasticsearch
+  module Tests
+    #
+    # Functions to print out test results, errors, summary, etc.
+    #
+    module Printer
+      def print_success
+        response = if [true, false].include? @response
+                     @response
+                   else
+                     @response.status
+                   end
+        puts "🟢 #{@file} #{@title} passed. Response: #{response}"
+      end
+
+      def print_failure(action, response)
+        puts "🔴 #{@file} #{@title} failed"
+        puts "Expected result: #{action}" # TODO: Show match/length differently
+        if response.is_a?(ElasticsearchServerless::API::Response)
+          puts 'Response:'
+          pp response.body
+        else
+          pp response
+        end
+        raise Elasticsearch::Tests::TestFailure
+      end
+
+      def print_match_failure(action)
+        keys = action['match'].keys.first
+        value = action['match'].values.first
+        message = <<~MSG
+          🔴 #{@file} #{@title} failed
+          Expected: { #{keys}: #{value} }
+          Actual  : { #{keys}: #{search_in_response(action['match'].keys.first)} }
+        MSG
+        raise Elasticsearch::Tests::TestFailure.new(message)
+      end
+
+      def print_error(error)
+        puts "❌ ERROR: #{@file} #{@title} failed\n"
+        logger.error error.display
+        backtrace = error.backtrace.join("\n")
+        logger.error "#{backtrace}\n"
+        raise error
+      end
+
+      def self.display_errors(errors)
+        puts "+++ ❌ Errors/Failures: #{errors.count}"
+        errors.map do |error|
+          puts "* Test: #{error[:file]}\n #{error[:error].message}"
+          pp error[:error].backtrace.join("$/\n") if ENV['DEBUG']
+          puts
+        end
+      end
+
+      def self.display_summary(tests_count, errors_count, start_time)
+        puts "--- 🧪 Tests: #{tests_count} | Passed: #{tests_count - errors_count} | Failed: #{errors_count}"
+        puts "--- ⏲  Elapsed time: #{Time.at(Time.now - start_time).utc.strftime("%H:%M:%S")}"
+      end
+    end
+  end
+end

data/lib/elasticsearch/tests/test.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.
+
+require_relative 'code_runner'
+
+module Elasticsearch
+  module Tests
+    #
+    # Represents a test, which is initialized in the test runner when iterating through the YAML
+    # files. Each YAML file can have more than one test.
+    # When a test is executed it runs the setup, actions (and matches) and finally the teardown stage.
+    #
+    class Test
+      include Elasticsearch::Tests::CodeRunner
+
+      def initialize(yaml, file, client)
+        @setup = extract_setup!(yaml)
+        @teardown = extract_teardown!(yaml)
+        @title = yaml.first.keys.first
+        @actions = yaml.first[@title]
+        @file = test_filename(file)
+        @client = client
+      end
+
+      def execute
+        begin
+          run_setup
+          run_actions
+        ensure
+          run_teardown
+        end
+      end
+
+      def run_actions
+        return unless @actions
+
+        @actions.map { |action| run_action(action) }
+      end
+
+      def run_action(action)
+        definition = action.keys.first
+
+        case definition
+        when 'do'
+          do_action(action['do'])
+        when 'set'
+          set_variable(action)
+        when 'match'
+          do_match(action)
+        when 'length'
+          do_length(action)
+        when 'is_true'
+          is_true(action)
+        when 'is_false'
+          is_false(action)
+        when 'gt', 'gte', 'lt', 'lte'
+          compare(action)
+        end
+      end
+
+      def run_setup
+        return unless @setup
+
+        @setup.map do |step|
+          do_action(step['do']) if step['do']
+        end
+      end
+
+      def run_teardown
+        return unless @teardown
+
+        @teardown['teardown'].map { |step| do_action(step['do']) }
+      end
+
+      def count
+        @actions.length
+      end
+
+      def test_filename(file)
+        name = file.split('/')
+        "#{name[-2]}/#{name[-1]}"
+      end
+
+      def extract_setup!(yaml)
+        yaml.map.with_index do |a, i|
+          yaml.delete_at(i) if a.keys.first == 'setup'
+        end.compact.first&.[]('setup')
+      end
+
+      def extract_teardown!(yaml)
+        yaml.map.with_index do |a, i|
+          yaml.delete_at(i) if a.keys.first == 'teardown'
+        end.compact.first
+      end
+    end
+  end
+end

data/lib/elasticsearch/tests/test_runner.rb

@@ -0,0 +1,93 @@
+# 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'
+require 'yaml'
+require_relative './test'
+require_relative './printer'
+
+module Elasticsearch
+  module Tests
+    # Main YAML test runner
+    class TestRunner
+      LOGGER = Logger.new($stdout)
+      LOGGER.level = Logger::WARN unless ENV['DEBUG']
+
+      def initialize(client, path = nil, logger = nil)
+        @client = client
+        @serverless = (defined?(::ElasticsearchServerless) && client.is_a?(::ElasticsearchServerless::Client))
+        @path = path || File.expand_path('./tmp', __dir__)
+        @logger = logger || LOGGER
+      end
+
+      def run(test_files = [])
+        raise 'Couldn\'t find test files. Run `Elasticsearch::Tests::Downloader::run(tests_path)` to download the tests' unless File.directory?(@path)
+
+        @test_files = select_test_files(test_files)
+        run_the_tests
+        Elasticsearch::Tests::Printer::display_errors(@errors) unless @errors.empty?
+        Elasticsearch::Tests::Printer::display_summary(@tests_count, @errors.count, @start_time)
+      end
+
+      def run_the_tests
+        @start_time = Time.now
+        @tests_count = 0
+        @errors = []
+
+        @test_files.map do |test_file|
+          build_and_run_tests(test_file)
+        rescue Psych::SyntaxError => e
+          @errors << { error: e, file: test_file }
+          @logger.warn("YAML error in #{test_file}")
+          @logger.warn e
+        rescue StandardError => e
+          @errors << { error: e, file: test_file }
+          @logger.debug e
+        end
+      end
+
+      def build_and_run_tests(test_file)
+        yaml = YAML.load_stream(File.read(test_file))
+        requires = extract_requires!(yaml).compact.first['requires']
+        return unless (requires['serverless'] == true && @serverless) ||
+                      (requires['stack'] == true && !@serverless)
+
+        test = Elasticsearch::Tests::Test.new(yaml, test_file, @client)
+        test.execute
+        @tests_count += test.count
+      rescue StandardError => e
+        raise e
+      end
+
+      def select_test_files(test_files)
+        if test_files.empty?
+          Dir.glob("#{@path}/**/*.yml")
+        else
+          test_files.map do |test_file|
+            "#{@path}/tests/#{test_file}"
+          end
+        end
+      end
+
+      def extract_requires!(yaml)
+        yaml.map.with_index do |a, i|
+          yaml.delete_at(i) if a.keys.first == 'requires'
+        end.compact
+      end
+    end
+  end
+end

data/lib/elasticsearch/tests/version.rb

@@ -0,0 +1,23 @@
+# 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.
+# frozen_string_literal: true
+
+module Elasticsearch
+  module Tests
+    VERSION = "0.1.0"
+  end
+end

data/lib/elasticsearch/tests.rb

@@ -0,0 +1,18 @@
+# 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.
+
+Dir['./**/**.rb'].each { |f| require f }

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: elasticsearch-test-runner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elastic Client Library Maintainers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch-serverless
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A test runner for the Elasticsearch clients YAML test suite, used in
+  the elasticsearch and elasticsearch-serverless gems.
+email:
+- client-libs@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT
+- CONTRIBUTING.md
+- LICENSE
+- NOTICE
+- README.md
+- Rakefile
+- elasticsearch-tests.gemspec
+- lib/elasticsearch/tasks/download_test_suite.rake
+- lib/elasticsearch/tests.rb
+- lib/elasticsearch/tests/code_runner.rb
+- lib/elasticsearch/tests/downloader.rb
+- lib/elasticsearch/tests/errors.rb
+- lib/elasticsearch/tests/printer.rb
+- lib/elasticsearch/tests/test.rb
+- lib/elasticsearch/tests/test_runner.rb
+- lib/elasticsearch/tests/version.rb
+homepage: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html
+  changelog_uri: https://github.com/elastic/es-test-runner-ruby/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/elastic/es-test-runner-ruby/tree/main
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.13
+signing_key: 
+specification_version: 4
+summary: Tool to test Elasticsearch clients against the YAML clients test suite.
+test_files: []