elasticsearch-test-runner 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa516016a59871aaa1b443d42c4889d3e5b02ae157562c6086c13fbadb0d492d
-  data.tar.gz: 802d0d4f3806bdf979ec8e5c7a8fe90a5951622920ed917e4efe83a33d6a6b56
+  metadata.gz: 3fdc3e700cee1701fdf46ac870a082c1f2e5442ec134861153a9a7810a228769
+  data.tar.gz: 261ad436f9db8d1d13b413df5967697ae1ac1f49a7886efcb97104c46fc07839
 SHA512:
-  metadata.gz: 1614a894297a381fbb1e45a254d61b31ba42dd7a8fef54179d78866c336196b35445e5b737253b7efb226f98d1015853409c9550cd65ec966605c5ee6e980a6b
-  data.tar.gz: e28f157416ab9baac80b33b4c9584da23d333dcecbfef64191e76437b44d9ea3615be13b4006746c9fca8fa64f645ddcfaa8eb9e82b2c0736f17e0557a5fe3a3
+  metadata.gz: 8629d1d7d526dd7eee04b6fa9496d3d64d63f0da9c374c92f16c74023ff02f9a7c3a106d11a7bdd95b16e058d8c65eceecec6ba2fcdc768078640cf49417af91
+  data.tar.gz: 7bb09a1d76a6d3bf382a4e67e3c39687c29ef0b7709e0edb5f5df4ded87c6f19e931952c031b7a4fb8478ca78742ded533cb341ef77f70d0c783fae5aa3527c2

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [0.14.0] - 2026-01-29
+
+- Introduces Ruby TTY tools for better debugging when `ENV['DEBUG']` is set and general display improvements.
+- Better information for actions in passing/erroring tests, showing actions instead of the test title.
+
+## [0.13.0] - 2025-06-05
+
+- Moves download tests file to Rakefile (namespace is unchanged).
+- Updates Elasticsearch Clients Tests repo URL.
+
 ## [0.12.0] - 2025-01-14
 
 - Check TEST_SUITE variable for `serverless`.

data/Rakefile

@@ -16,5 +16,13 @@
 # under the License.
 
 require 'bundler/gem_tasks'
+require 'elasticsearch/tests/downloader'
 task default: %i[]
-Dir.glob('lib/elasticsearch/tasks/**/*.rake').each { |f| import f }
+
+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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # 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
@@ -53,15 +55,14 @@ module Elasticsearch
           client = @client.send(arrayed_method.first)
           method = arrayed_method.last
         end
-        @response = client.send(method.to_sym, process_params(params))
-        puts "Action: #{action}\nResponse: #{@response}\n\n" if ENV['DEBUG']
+        params = process_params(params)
+        @response = client.send(method.to_sym, params)
+        print_debug_message(method.to_sym, params) if ENV['DEBUG']
         @response
       rescue StandardError => e
-        if expected_exception?(catchable, e)
-          puts "Catchable: #{e}\nResponse: #{@response}\n" if ENV['DEBUG']
-        else
-          raise e
-        end
+        raise e unless expected_exception?(catchable, e)
+
+        puts "Catchable: #{e}\nResponse: #{@response}\n" if ENV['DEBUG']
       end
 
       def expected_exception?(error_type, e)
@@ -116,13 +117,14 @@ module Elasticsearch
 
       def match_regexp(expected, result)
         expected.is_a?(String) &&
-          expected.match?(/^\//) &&
+          expected.match?(%r{^/}) &&
           result.match?(Regexp.new(expected.gsub('/', '').strip))
       end
 
       def do_length(action)
         k, v = action['length'].first
-        result = search_in_response(k).count
+        result = search_in_response(k)
+        result = result.count
         if result && result == v
           print_success
         else
@@ -208,11 +210,11 @@ module Elasticsearch
       end
 
       def set_param_variable(params, key, param)
-        return unless param.is_a?(String) && param.include?("$")
+        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("$", "@"))
+        value = instance_variable_get(repleacable.gsub('$', '@'))
         content = param.gsub(repleacable, value)
         params[key] = content
       end

data/lib/elasticsearch/tests/downloader.rb

@@ -24,9 +24,9 @@ module Elasticsearch
       class << self
         FILENAME = 'tests.tar.gz'.freeze
 
-        def run(path, branch = 'main')
-          delete_files(path)
-          url = "https://api.github.com/repos/elastic/serverless-clients-tests/tarball/#{branch}"
+        def run(path, branch = 'main', delete: false)
+          delete_files(path) if delete
+          url = "https://api.github.com/repos/elastic/elasticsearch-clients-tests/tarball/#{branch}"
           if download_tests(url)
             puts "Successfully downloaded #{FILENAME}"
           else

data/lib/elasticsearch/tests/printer.rb

@@ -14,6 +14,8 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
+require 'tty-box'
+require 'tty-screen'
 require_relative 'errors'
 
 module Elasticsearch
@@ -22,29 +24,39 @@ module Elasticsearch
     # Functions to print out test results, errors, summary, etc.
     #
     module Printer
+      BOX_WIDTH = TTY::Screen.width * 0.8
+
       def print_success
         response = if [true, false].include? @response
                      @response
                    else
                      @response.status
                    end
-        if ENV['QUIET'] == 'true'
+        if quiet?
           print '🟢 '
         else
-          puts "🟢 #{@short_name} #{@title} passed. Response: #{response}"
+          puts "🟢 \e[#{33}m#{@short_name}\e[0m - #{@action}  \e[#{32}mpassed\e[0m [#{response}]"
         end
       end
 
+      def quiet?
+        !ENV['QUIET'].nil? && ![false, 'false'].include?(ENV['QUIET'])
+      end
+
       def print_failure(action, response)
-        puts "🔴 #{@short_name} #{@title} failed"
-        puts "Expected result: #{action}" # TODO: Show match/length differently
+        if quiet?
+          print '🔴 '
+        else
+          puts "🔴 \e[#{33}m#{@short_name}\e[0m - #{@action}  \e[#{31}mfailed\e[0m"
+        end
+        message = ["Expected result: #{action}"]
         if defined?(ElasticsearchServerless) &&
            response.is_a?(ElasticsearchServerless::API::Response) ||
            defined?(Elasticsearch::API) && response.is_a?(Elasticsearch::API::Response)
-          puts 'Response:'
-          pp response.body
+          message << 'Response:'
+          message << response.body
         else
-          pp response
+          message << response
         end
         raise Elasticsearch::Tests::ActionError.new(response.body, @short_name, action)
       end
@@ -63,7 +75,7 @@ module Elasticsearch
       end
 
       def print_error(error)
-        puts "❌ ERROR: #{@short_name} #{@title} failed\n"
+        print TTY::Box.error("❌ ERROR: #{@short_name} #{@title} failed", width: BOX_WIDTH)
         logger.error error.display
         backtrace = error.backtrace.join("\n")
         logger.error "#{backtrace}\n"
@@ -71,27 +83,40 @@ module Elasticsearch
       end
 
       def self.display_errors(errors, logger)
-        puts "+++ ❌ Errors/Failures: #{errors.count}"
+        print TTY::Box.frame("❌ Errors/Failures: #{errors.count}", width: BOX_WIDTH, style: { border: { fg: :red } })
         errors.map do |error|
           message = []
           message << "🧪 Test: #{error[:file]}"
           message << "▶ Action: #{error[:action].first}" if error[:action]
           message << "🔬 #{error.class} - #{error[:error].message}"
           message << error[:error].backtrace.join("$/\n") if ENV['DEBUG']
-          puts message.join("\n")
+          print TTY::Box.frame(message.join("\n"), width: BOX_WIDTH, style: { border: { fg: :red } })
           logger.error(message.join("\n"))
         end
       end
 
       def self.display_summary(tests_count, errors_count, start_time, logger)
-        puts
         summary = "🧪 Tests: #{tests_count} | Passed: #{tests_count - errors_count} | Failed: #{errors_count}"
         logger.info summary
-        puts "--- #{summary}"
-
         duration = "⏲  Elapsed time: #{Time.at(Time.now - start_time).utc.strftime('%H:%M:%S')}"
+        message = <<~MSG
+                     #{summary}
+                     #{duration}
+        MSG
+        print TTY::Box.frame(message, width: BOX_WIDTH, title: { top_left: '[SUMMARY]' }, style: { border: { fg: :cyan } })
         logger.info duration
-        puts "--- #{duration}"
+      end
+
+      def print_debug_message(method, params)
+        message = <<~MSG
+          Test File: #{$test_file}
+          Action: #{method}
+          Parameters: #{params}
+          Response: #{@response.status}
+          Response headers: #{@response.headers}
+          Response body: #{@response.body}
+        MSG
+        print TTY::Box.frame(message, width: BOX_WIDTH, title: { top_left: '[DEBUG]'})
       end
     end
   end

data/lib/elasticsearch/tests/test.rb

@@ -59,18 +59,24 @@ module Elasticsearch
 
         case definition
         when 'do'
+          @action = "#{action['do'].keys.first}"
           do_action(action['do'])
         when 'set'
           set_variable(action)
         when 'match'
+          @action = "#{action.keys.first} #{format_action(action[action.keys.first])}"
           do_match(action)
         when 'length'
+          @action = format_action(action)
           do_length(action)
         when 'is_true'
+          @action = format_action(action)
           is_true(action)
         when 'is_false'
+          @action = format_action(action)
           is_false(action)
         when 'gt', 'gte', 'lt', 'lte'
+          @action = format_action(action)
           compare(action)
         end
       rescue StandardError => e
@@ -106,6 +112,17 @@ module Elasticsearch
           yaml.delete_at(i) if a.keys.first == 'teardown'
         end.compact.first
       end
+
+      private
+
+      def format_action(action)
+        action.to_s
+              .gsub(/^{/, '')
+              .gsub(' =>', ':')
+              .gsub('"', '')
+              .gsub('}', '')
+              .gsub('{', '|')
+      end
     end
   end
 end

data/lib/elasticsearch/tests/test_runner.rb

@@ -64,17 +64,17 @@ module Elasticsearch
         @errors = []
 
         @test_files.map do |test_path|
-          test_file = test_filename(test_path)
+          $test_file = test_filename(test_path)
           build_and_run_tests(test_path)
         rescue Psych::SyntaxError => e
-          @errors << { error: e, file: test_file }
-          @logger.warn("YAML error in #{test_file}")
+          @errors << { error: e, file: $test_file }
+          @logger.warn("YAML error in #{$test_file}")
           @logger.warn e
         rescue ActionError => e
-          @errors << { error: e, file: test_file, action: e.action }
+          @errors << { error: e, file: $test_file, action: e.action }
           @logger.debug e
         rescue StandardError => e
-          @errors << { error: e, file: test_file }
+          @errors << { error: e, file: $test_file }
           @logger.debug e
         rescue SystemExit, Interrupt
           exit

data/lib/elasticsearch/tests/version.rb

@@ -19,6 +19,6 @@
 
 module Elasticsearch
   module Tests
-    VERSION = '0.12.0'
+    VERSION = '0.14.0'
   end
 end

metadata

@@ -1,14 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-test-runner
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
 bindir: exe
 cert_chain: []
-date: 2025-01-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-box
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-screen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: elasticsearch
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +80,6 @@ files:
 - NOTICE
 - README.md
 - Rakefile
-- lib/elasticsearch/tasks/download_test_suite.rake
 - lib/elasticsearch/tests.rb
 - lib/elasticsearch/tests/code_runner.rb
 - lib/elasticsearch/tests/downloader.rb
@@ -82,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Tool to test Elasticsearch clients against the YAML clients test suite.
 test_files: []

data/lib/elasticsearch/tasks/download_test_suite.rake

@@ -1,25 +0,0 @@
-# Licensed to Elasticsearch B.V. under one or more contributor
-# license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright
-# ownership. Elasticsearch B.V. licenses this file to you under
-# the Apache License, Version 2.0 (the "License"); you may
-# not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#   http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing,
-# software distributed under the License is distributed on an
-# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-# KIND, either express or implied.  See the License for the
-# specific language governing permissions and limitations
-# under the License.
-require '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