elasticsearch-test-runner 0.18.2 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b2a29eb379b8bc1f6d31d93add7befd179122d2dc08d19312b7cda9ebc36d95
-  data.tar.gz: 47989e967e79cc64a901d8d2e3a8e2b206134c20b48c532040cc6f79cd4586fb
+  metadata.gz: 6f353417226574d9f9f31aad08493921ff64ddc0442eb3b1c78ca810dd6d5f05
+  data.tar.gz: 8c665f93673ae59cefc2c621b37dd270acda75f1ce15e0ddacdf7b3ba8fdd0fd
 SHA512:
-  metadata.gz: 55eb04dafbb6347cce1f1125fd90e35d2fed0db9549152f39a0e6b608160822aa6ea4c69ac41ed5e49f3e9a7dd9addd38c8a998409f6fc72ac2193046ad4b0ef
-  data.tar.gz: c1c83a61546a0fcb49127b5bc5a98af5196a21ce61481445632f22b880525b46445fd4d0796fec54d125a03929d7f86e5f7e078b22dfb2bd8764d1cc54f1b4d0
+  metadata.gz: 51a23ebbdd4550e88083a38d9ae953a87cbc6555175f72e3cfb8798531e980772d6ff19d6aa075e52336355779e041dddfc87b713ddb8941816022e6d0a32340
+  data.tar.gz: a5dd823bd406475e67ddf632051d1102f981ad6b9813134d452c6eb3df8da1fec71fb0752d5ab9f24801754b00b1f57a7345fbbc7bc1c6ce1c0d2dedfca786a0

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [0.20.0] - 2026-05-20
+
+- Replaces variables in arrays, update for the latest tests update.
+
+## [0.19.0] - 2026-05-12
+
+- Adds exception to print_failure if there is one.
+- Better formatting when printing match failures.
+- Raise error if the requires section is missing from a test.
+
 ## [0.18.2] - 2026-03-06
 
 - Fixes skipping multiple tests.

data/README.md

@@ -85,6 +85,40 @@ Elasticsearch::Tests::Downloader::run(tests_path)
 
 Additionally, you can run the rake task `rake es_tests:download` included in `lib/elasticsearch/tasks`.
 
+### Environment variables
+
+You can set the following environment variables when using the test runner:
+
+#### `DEBUG`
+
+If you set `DEBUG` to `true`, you'll see debug messages for each tests, including the response status, body and headers sent from Elasticsearch:
+
+```
+🟢 cluster/put_settings.yml - is_true: acknowledged passed [200]
+┌[DEBUG]──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
+│File: cluster/remote_info.yml | Action: remote_info                                                                              │
+│Parameters: {}                                                                                                                   │
+│                                                                                                                                 │
+│Response status: 200                                                                                                             │
+│Response body:                                                                                                                   │
+│Response headers:                                                                                                                │
+│  x-elastic-product: Elasticsearch                                                                                               │
+│  content-type: application/vnd.elasticsearch+json;compatible-with=9                                                             │
+│  content-length: 2                                                                                                              │
+└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
+```
+
+#### `QUIET`
+
+If you set `QUIET` to anything other than `false` or the String `"false"`, tests will run in quiet mode, where you'll only see the green (success) and/or red (failure) output for the tests:
+
+```
+$ QUIET=1 be rake test:yaml
+🟢 🟢 🟢 🟢 🟢 🔴 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢 🟢
+ ```
+
+It will still print out the summary and information about failures and/or errors at the bottom.
+
 ## Development
 
 See [CONTRIBUTING](./CONTRIBUTING.md).

data/lib/elasticsearch/tests/code_runner.rb

@@ -62,7 +62,7 @@ module Elasticsearch
       rescue StandardError => e
         # Raise if it's an actual error:
         unless expected_exception?(catchable, e)
-          print_failure(action, @response)
+          print_failure(action, @response, e)
           raise e
         end
         # Show success if we caught an expected exception:
@@ -109,7 +109,16 @@ module Elasticsearch
       #
       def do_match(action)
         k, v = action['match'].first
-        v = instance_variable_get(v.gsub('$', '@')) if v.is_a?(String) && v.include?('$')
+
+        v = if v.is_a?(String) && v.include?('$')
+              instance_variable_get(v.gsub('$', '@'))
+            elsif v.is_a?(Array)
+              v.map do |a|
+                a.is_a?(String) && a.start_with?('$') ? instance_variable_get(a.gsub('$', '@')) : a
+              end
+            else
+              v
+            end
         result = search_in_response(k)
 
         if !result.nil? && (
@@ -236,9 +245,9 @@ module Elasticsearch
         return unless param.is_a?(String) && param.include?('$')
 
         # Param can be a single '$value' string or '{ something: $value }'
-        repleacable = param.match(/(\$[0-9a-z_-]+)/)[0]
-        value = instance_variable_get(repleacable.gsub('$', '@'))
-        content = param.gsub(repleacable, value)
+        replaceable = param.match(/(\$[0-9a-z_-]+)/)[0]
+        value = instance_variable_get(replaceable.gsub('$', '@'))
+        content = param.gsub(replaceable, value)
         params[key] = content
       end
 

data/lib/elasticsearch/tests/printer.rb

@@ -44,7 +44,7 @@ module Elasticsearch
         !ENV['QUIET'].nil? && ![false, 'false'].include?(ENV['QUIET'])
       end
 
-      def print_failure(action, response)
+      def print_failure(action, response, exception = nil)
         if quiet?
           print '🔴 '
         else
@@ -56,6 +56,7 @@ module Elasticsearch
         else
           message << response
         end
+        message << "Exception: #{exception}" if exception
       end
 
       def print_match_failure(action)
@@ -69,9 +70,9 @@ module Elasticsearch
         end
         message = <<~MSG
           #{@short_name} #{@title} failed
-          Expected: { #{keys}: #{value} }
-          Actual  : { #{keys}: #{search_in_response(action['match'].keys.first)} }
-          Response: #{@response}
+          \e[31m\e[1mExpected: { #{keys}: #{value} }\e[0m
+          \e[32m\e[1mGot     : { #{keys}: #{search_in_response(action['match'].keys.first)} }\e[0m
+          \e[1mResponse\e[0m:\n\e[36m #{@response}\e[0m
         MSG
         raise Elasticsearch::Tests::TestFailure.new(message)
       end

data/lib/elasticsearch/tests/test_runner.rb

@@ -79,7 +79,11 @@ module Elasticsearch
 
       def build_and_run_tests(test_path)
         yaml = YAML.load_stream(File.read(test_path))
-        requires = extract_requires!(yaml).compact.first['requires']
+        begin
+          requires = extract_requires!(yaml).compact.first['requires']
+        rescue StandardError => e
+          raise ArgumentError, "Could not find requires key in test file:\n #{test_path}\n#{e}"
+        end
         return unless (requires['serverless'] == true && @serverless) ||
                       (requires['stack'] == true && !@serverless)
 

data/lib/elasticsearch/tests/version.rb

@@ -19,6 +19,6 @@
 
 module Elasticsearch
   module Tests
-    VERSION = '0.18.2'
+    VERSION = '0.20.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-test-runner
 version: !ruby/object:Gem::Version
-  version: 0.18.2
+  version: 0.20.0
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
@@ -137,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Tool to test Elasticsearch clients against the YAML clients test suite.
 test_files: []