elasticsearch-test-runner 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d09d996ce00f24cbdd34e54d447eff53c19a0a023fa55a61043a5215626e21a8
-  data.tar.gz: 77fc59d5846f32c165dcb3ac72bf475c0e572a12f03e7aab80a85030b6e6d7c0
+  metadata.gz: 74628e9c64f4c668f6e4ef87c94afa47ee6539b22ab3a28ce4fd25e8ae69d457
+  data.tar.gz: e9fc240ffa3a200f1e3cb257ba73b297145117a75c19c38e4a7194695e3e5ddb
 SHA512:
-  metadata.gz: 69587a3c06c098c03c74e2b26f114228012ee97d73267a5623e44e0d689e776d0c9dc85a1cc503a0ac397c68d9939c338bd6a88bcaf0ffacf2cbf77a31d0cc17
-  data.tar.gz: 4b4e6315e953fbc534b8fdbc06db5462e7656cee80c1f5edfbd21cbede0956513e2f7d45faff87c77b5cf61a34526d89d9a9b907d4887ff8e9d4cbf4258b6b1b
+  metadata.gz: 27b6f144c51341b040891a80a23353b328f1378a3ba33503e3dfbe6f6cf86dc501f45717fb4af9a3b7dd72fe8fa21eae2c5ce91d7e4764a7a877e3fd48ef0590
+  data.tar.gz: e94c3308a4733421362d13af89915db5b010ec72d76218ccd7d8efa25a3bf1c8f9e0ea1a19b0e798ba44655b7e8a2df2feab8cc7642c4d97ed1f8aeb353901ff

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.10.0] - 2024-11-13
+
+- Using tar.gz file for downloaded tests instead of zip file.
+- Updates logging and debug information. More information being logged for different levels of Logger.
+
+## [0.9.0] - 2024-08-15
+
+- Better display of action and response when `ENV['DEBUG']` is true.
+- Checks for more error types when catching exceptions.
+- Better matching for regular expressions.
+- Refactors `set_param_variable` for better substitution.
+
 ## [0.8.0] - 2024-08-14
 
 - Adds support for variable keys (`$`).

data/lib/elasticsearch/tests/code_runner.rb

@@ -54,10 +54,14 @@ module Elasticsearch
           method = arrayed_method.last
         end
         @response = client.send(method.to_sym, process_params(params))
-        puts @response if ENV['DEBUG']
+        puts "Action: #{action}\nResponse: #{@response}\n\n" if ENV['DEBUG']
         @response
       rescue StandardError => e
-        raise e unless expected_exception?(catchable, e)
+        if expected_exception?(catchable, e)
+          puts "Catchable: #{e}\nResponse: #{@response}\n" if ENV['DEBUG']
+        else
+          raise e
+        end
       end
 
       def expected_exception?(error_type, e)
@@ -66,7 +70,7 @@ module Elasticsearch
         case error_type
         when 'request_timeout'
           e.is_a?(Elastic::Transport::Transport::Errors::RequestTimeout)
-        when 'missing'
+        when 'missing', /resource_not_found_exception/
           e.is_a?(Elastic::Transport::Transport::Errors::NotFound)
         when 'conflict'
           e.is_a?(Elastic::Transport::Transport::Errors::Conflict)
@@ -85,6 +89,8 @@ module Elasticsearch
             e.is_a?(Elastic::Transport::Transport::Errors::BadRequest)
         when /NullPointerException/
           e.message =~ /\[400\]/
+        when /status_exception/
+          e.message =~ /\[409\]/
         else
           e.message =~ /#{error_type}/
         end
@@ -109,7 +115,9 @@ module Elasticsearch
       end
 
       def match_regexp(expected, result)
-        expected.is_a?(String) && expected.match?(/^\//) && result.match?(Regexp.new(expected.gsub('/', '')))
+        expected.is_a?(String) &&
+          expected.match?(/^\//) &&
+          result.match?(Regexp.new(expected.gsub('/', '').strip))
       end
 
       def do_length(action)
@@ -200,7 +208,13 @@ module Elasticsearch
       end
 
       def set_param_variable(params, key, param)
-        params[key] = instance_variable_get(param.gsub('$', '@')) if 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("$", "@"))
+        content = param.gsub(repleacable, value)
+        params[key] = content
       end
 
       # Given a list of keys, find the value in a recursively nested document.

data/lib/elasticsearch/tests/downloader.rb

@@ -22,18 +22,18 @@ module Elasticsearch
     # Module for downloading the test files
     module Downloader
       class << self
-        FILENAME = 'tests.zip'.freeze
+        FILENAME = 'tests.tar.gz'.freeze
 
         def run(path, branch = 'main')
           delete_files(path)
-          url = "https://api.github.com/repos/elastic/serverless-clients-tests/zipball/#{branch}"
+          url = "https://api.github.com/repos/elastic/serverless-clients-tests/tarball/#{branch}"
           if download_tests(url)
             puts "Successfully downloaded #{FILENAME}"
           else
             warn "[!] Couldn't download #{FILENAME}"
             return
           end
-          unzip_file(path)
+          untar_file(path)
           File.delete(FILENAME)
         end
 
@@ -49,11 +49,11 @@ module Elasticsearch
 
         private
 
-        def unzip_file(path)
-          puts 'Unzipping files'
+        def untar_file(path)
+          puts 'Extracting tar files'
           puts path
-          `unzip #{FILENAME} -d #{path}/`
-          puts 'Removing zip file'
+          `tar -zxf #{FILENAME} --strip-components=1 -C #{path}/`
+          puts 'Removing tar file'
         end
 
         def delete_files(path)

data/lib/elasticsearch/tests/printer.rb

@@ -70,21 +70,28 @@ module Elasticsearch
         raise error
       end
 
-      def self.display_errors(errors)
+      def self.display_errors(errors, logger)
         puts "+++ ❌ Errors/Failures: #{errors.count}"
         errors.map do |error|
-          puts "🧪 Test: #{error[:file]}"
-          puts "▶ Action: #{error[:action].first}" if error[:action]
-          puts "🔬 #{error.class} - #{error[:error].message}"
-          pp error[:error].backtrace.join("$/\n") if ENV['DEBUG']
-          puts
+          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")
+          logger.error(message.join("\n"))
         end
       end
 
-      def self.display_summary(tests_count, errors_count, start_time)
+      def self.display_summary(tests_count, errors_count, start_time, logger)
         puts
-        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")}"
+        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')}"
+        logger.info duration
+        puts "--- #{duration}"
       end
     end
   end

data/lib/elasticsearch/tests/test_runner.rb

@@ -25,7 +25,7 @@ module Elasticsearch
     # Main YAML test runner
     class TestRunner
       LOGGER = Logger.new($stdout)
-      LOGGER.level = Logger::WARN unless ENV['DEBUG']
+      LOGGER.level = ENV['DEBUG'] ? Logger::DEBUG : Logger::WARN
 
       def initialize(client, path = nil, logger = nil)
         @client = client
@@ -39,8 +39,8 @@ module Elasticsearch
 
         @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)
+        Elasticsearch::Tests::Printer::display_errors(@errors, @logger) unless @errors.empty?
+        Elasticsearch::Tests::Printer::display_summary(@tests_count, @errors.count, @start_time, @logger)
         if @errors.empty?
           exit 0
         else
@@ -93,7 +93,7 @@ module Elasticsearch
         tests_path = if test_files.empty?
                        "#{@path}/**/*.yml"
                      elsif test_files.include?('yml')
-                       "#{@path}/#{test_files}"
+                       return ["#{@path}/tests/#{test_files}"]
                      else
                        "#{@path}/#{test_files}/*.yml"
                      end

data/lib/elasticsearch/tests/version.rb

@@ -19,6 +19,6 @@
 
 module Elasticsearch
   module Tests
-    VERSION = '0.8.0'
+    VERSION = '0.10.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-test-runner
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-14 00:00:00.000000000 Z
+date: 2024-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -69,7 +69,7 @@ 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -84,8 +84,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key: 
+rubygems_version: 3.5.20
+signing_key:
 specification_version: 4
 summary: Tool to test Elasticsearch clients against the YAML clients test suite.
 test_files: []