elasticsearch-test-runner 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 736ee5a6506aad22d554ba00880706b6641192297e69c42a815050e4e6d784fd
-  data.tar.gz: 2faea7eacfc8c421675cbae4783fcce40866daf380a8d5fd417b297cd9de7e51
+  metadata.gz: fbe5745c193f66b9d4d16ca8402a9aba8d87068c43a328b565ac094e3dc679ae
+  data.tar.gz: b2fa5da01e5fa321c3b050dfd6cd08d1caf8f80fa5c5a903a5822e1dc88fb58a
 SHA512:
-  metadata.gz: '0529c7247fe886df1ac6f99f95b45f2fd576dce42bcc80e01d032d57e3adda91f0556da62000201fa447fe7895b7799844c4479077f7136df382bcabb69f5ab8'
-  data.tar.gz: 90f5be281f003fb63ad11bb1180d47d5b3d50ab3db4914ff7652e2eb89cbfc828a78f2118ebf665e60e688f0e065011154b3bf7c4703b562d9f7a3f3256cc3e1
+  metadata.gz: e153228ccd3fc6a7900c8744fef31c23e8b27ebda3bdbda682a4d1dca0ae720568144a30c90e199e417281d676bccaa45acdff6fd482b98039b20ab8b7ad9eb5
+  data.tar.gz: 4abc093012f30303cc8afaed96dea471cef8a6e4bd9ada4c7844ab35fe77f0593c9f850718c51f482068363d3998c715b5d9fc1e8fc4ab8905f478aafc88fc3b

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [0.4.0] - 2024-07-08
+
+- Refactors display of errors/passing tests. Adds `QUIET` environment variable parsing. If `true`, display for passing tests will be more compact (not showing file/test names).
+- Updates count for better accuracy in test results.
+- Rescues SystemExit, Interrupt to actually exit the script
+- Adds support for catch in tests: If the arguments to `do` include `catch`, then we are expecting an error, which should be caught and tested.
+
+## [0.3.1] - 2024-06-27
+
+- Fixes in error handling.
+
 ## [0.3.0] - 2024-06-27
 
 - Fixes exit code.

data/lib/elasticsearch/tests/code_runner.rb

@@ -35,6 +35,7 @@ module Elasticsearch
       # specifications. These are function calls to the Elasticsearch clients.
       #
       def do_action(action)
+        catchable = action.delete('catch')
         client = @client
         action = action.first if action.is_a?(Array)
         method, params = action.is_a?(String) ? [action, {}] : action.first
@@ -47,9 +48,40 @@ module Elasticsearch
         end
 
         @response = client.send(method.to_sym, process_params(params))
+        puts @response if ENV['DEBUG']
         @response
       rescue StandardError => e
-        raise e
+        raise e unless expected_exception?(catchable, e)
+
+        @response
+      end
+
+      def expected_exception?(error_type, e)
+        case error_type
+        when 'request_timeout'
+          e.is_a?(Elastic::Transport::Transport::Errors::RequestTimeout)
+        when 'missing'
+          e.is_a?(Elastic::Transport::Transport::Errors::NotFound)
+        when 'conflict'
+          e.is_a?(Elastic::Transport::Transport::Errors::Conflict)
+        when 'request'
+          e.is_a?(Elastic::Transport::Transport::Errors::InternalServerError)
+        when 'bad_request'
+          e.is_a?(Elastic::Transport::Transport::Errors::BadRequest)
+        when 'param'
+          actual_error.is_a?(ArgumentError)
+        when 'unauthorized'
+          e.is_a?(Elastic::Transport::Transport::Errors::Unauthorized)
+        when 'forbidden'
+          e.is_a?(Elastic::Transport::Transport::Errors::Forbidden)
+        when /error parsing field/, /illegal_argument_exception/
+          e.message =~ /\[400\]/ ||
+            e.is_a?(Elastic::Transport::Transport::Errors::BadRequest)
+        when /NullPointerException/
+          e.message =~ /\[400\]/
+        else
+          e.message =~ /#{error_type}/
+        end
       end
 
       # Code for matching expectations and response

data/lib/elasticsearch/tests/printer.rb

@@ -28,24 +28,31 @@ module Elasticsearch
                    else
                      @response.status
                    end
-        puts "🟢 #{@file} #{@title} passed. Response: #{response}"
+        if ENV['QUIET']
+          print "🟢 "
+        else
+          puts "🟢 #{@file} #{@title} passed. Response: #{response}"
+        end
       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)
+        if defined?(ElasticsearchServerless) &&
+           response.is_a?(ElasticsearchServerless::API::Response) ||
+           defined?(Elasticsearch::API) && response.is_a?(Elasticsearch::API::Response)
           puts 'Response:'
           pp response.body
         else
           pp response
         end
-        raise Elasticsearch::Tests::ActionError.new('ERROR', @file, action)
+        raise Elasticsearch::Tests::ActionError.new(response.body, @file, action)
       end
 
       def print_match_failure(action)
         keys = action['match'].keys.first
         value = action['match'].values.first
+
         message = <<~MSG
           🔴 #{@file} #{@title} failed
           Expected: { #{keys}: #{value} }
@@ -66,14 +73,15 @@ module Elasticsearch
         puts "+++ ❌ Errors/Failures: #{errors.count}"
         errors.map do |error|
           puts "🧪 Test: #{error[:file]}"
-          puts "▶ Action: #{error[:action]['do']}" if error[:action]
-          puts "🔬 #{error[:error].message}"
+          puts "▶ Action: #{error[:action].first}" if error[:action]
+          puts "🔬 #{error.class} - #{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
         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

data/lib/elasticsearch/tests/test.rb

@@ -90,7 +90,7 @@ module Elasticsearch
       end
 
       def count
-        @actions.length
+        @actions.select { |a| a.keys.first == 'do' }.count
       end
 
       def test_filename(file)

data/lib/elasticsearch/tests/test_runner.rb

@@ -65,6 +65,8 @@ module Elasticsearch
         rescue StandardError => e
           @errors << { error: e, file: test_file }
           @logger.debug e
+        rescue SystemExit, Interrupt
+          exit
         end
       end
 

data/lib/elasticsearch/tests/version.rb

@@ -19,6 +19,6 @@
 
 module Elasticsearch
   module Tests
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-test-runner
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Elastic Client Library Maintainers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-27 00:00:00.000000000 Z
+date: 2024-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch