spectre-core 1.12.1 → 1.12.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77d4435f515a88fa60eef0a6c43b90975fb6ae1168a60294ee2847536ff51a67
-  data.tar.gz: 1366a0d67961a565bf2020d9fa9e6724f5df4b4add1ac58712ed2cdfe992e74d
+  metadata.gz: 9d2cb2622682713c0fc37e7c0e679aa0d93f01ac9af389c8430496a272608038
+  data.tar.gz: 8b313cd7952c0b9e4baf9e8f0cec0af397d1f8cf8fc25760204714f687718df8
 SHA512:
-  metadata.gz: 7699c3e1433edc8b7b0c7886f28ef90ad3f6438b2189ebbbe8bfc40c6386f7b142bd8848809af13e9c893d8efcffc6598c595fea8bdea9ff67899a84c5394e27
-  data.tar.gz: 1b5da1f3b490dbcf2510e8a58306efe3a0924891c5004fe9862854f0700e502d81b46e8353e85b77be43f4c4aea9e67b7c4db276501f971046d47e4488c5d07f
+  metadata.gz: c3e939b9e9851ece96d27e31d19fa7f4c5b26bd9141e28e2e5964b5f20ed1f9c9b0f4a77800b87c411d1c271d0b4acf1afa1f50359e832842e241a1ba536b811
+  data.tar.gz: d105a5a9924cba80b028790a538945087ef0e19a30763e619b712c1d7b31b54259a03504a5a52d1f1cc24be6a03f1e8185d499ed9e7343a17655c4336f22dd40

data/exe/spectre

@@ -9,6 +9,11 @@ require 'ectoplasm'
 
 require_relative '../lib/spectre'
 
+def load_yaml file_path
+  yaml = File.read(file_path)
+  YAML.safe_load(yaml, aliases: true)
+end
+
 
 DEFAULT_CONFIG = {
   'config_file' => './spectre.yml',
@@ -72,9 +77,10 @@ DEFAULT_CONFIG = {
 
 
 cmd_options = {}
+property_overrides = {}
 
 opt_parser = OptionParser.new do |opts|
-  opts.banner = %{Spectre #{Spectre::VERSION}
+opts.banner = %{Spectre #{Spectre::VERSION}
 
 Usage: spectre [command] [options]
 
@@ -83,6 +89,7 @@ Commands:
   run         Run specs (default)
   show        Print current environment settings
   dump        Dumps the given environment in YAML format to console
+  cleanup     Will remove all generated files (e.g. logs and reports)
   init        Initializes a new spectre project
 
 Specific options:}
@@ -132,17 +139,24 @@ Specific options:}
   end
 
   opts.on('-p KEY=VAL', '--property KEY=VAL', "Override config option. Use `spectre show` to get list of available options") do |option|
-    key, val = option.split '='
-    val = val.split ',' if DEFAULT_CONFIG[key].is_a? Array
-    val = ['true', '1'].include? val if [true, false].include? DEFAULT_CONFIG[key]
+    key, val = option.split('=')
+    val = val.split(',') if DEFAULT_CONFIG[key].is_a? Array
+    val = ['true', '1'].include? val if [true, false].include?(DEFAULT_CONFIG[key])
     val = val.to_i if DEFAULT_CONFIG[key].is_a? Integer
-    cmd_options[key] = val
 
-    curr_opt = cmd_options
-    (key.split '.').each do |k|
-      curr_opt[k] = {} unless curr_opt.key? k
+    opt_path = key.split('.')
+
+    curr_opt = property_overrides
+
+    opt_path.each_with_index do |part, i|
+      if i == opt_path.count-1
+        curr_opt[part] = val
+        break
+      end
+
+      curr_opt[part] = {} unless curr_opt.key?(part)
+      curr_opt = curr_opt[part]
     end
-    curr_opt = val
   end
 
   opts.separator "\nCommon options:"
@@ -173,21 +187,20 @@ cfg.deep_merge! DEFAULT_CONFIG
 global_config_file = File.join File.expand_path('~'), '.spectre'
 
 if File.exists? global_config_file
-  global_options = YAML.load_file(global_config_file)
+  global_options = load_yaml(global_config_file)
   cfg.deep_merge! global_options if global_options
 end
 
 config_file = cmd_options['config_file'] || cfg['config_file']
 
 if File.exists? config_file
-  file_options = YAML.load_file(config_file)
+  file_options = load_yaml(config_file)
   cfg.deep_merge! file_options
   Dir.chdir File.dirname(config_file)
 end
 
 cfg.deep_merge! cmd_options
 
-
 ###########################################
 # Load Environment
 ###########################################
@@ -197,7 +210,7 @@ envs = {}
 read_env_files = {}
 cfg['env_patterns'].each do |pattern|
   Dir.glob(pattern).each do|f|
-    spec_env = YAML.load_file(f) || {}
+    spec_env = load_yaml(f) || {}
 
     name = spec_env['name'] || 'default'
 
@@ -215,7 +228,7 @@ end
 # Merge partial environment configs with existing environments
 cfg['env_partial_patterns'].each do |pattern|
   Dir.glob(pattern).each do|f|
-    partial_env = YAML.load_file(f)
+    partial_env = load_yaml(f)
     name = partial_env.delete('name') || 'default'
     next unless envs.key? name
 
@@ -224,7 +237,10 @@ cfg['env_partial_patterns'].each do |pattern|
 end
 
 env = envs[cfg['environment']]
-cfg.merge! env if env
+cfg.deep_merge! env if env
+
+# Merge property overrides after environment load to give it higher priority
+cfg.deep_merge! property_overrides
 
 
 String.colored! if cfg['colored']
@@ -392,6 +408,24 @@ if 'dump' == action
 end
 
 
+###########################################
+# Cleanup
+###########################################
+
+
+if 'cleanup' == action
+  log_file_pattern = cfg['log_file'].gsub('<date>', '*')
+
+  Dir.glob(log_file_pattern).each do |log_file|
+    File.delete(log_file)
+  end
+
+  Dir.glob(File.join cfg['out_path'], '/*').each do |out_file|
+    File.delete(out_file)
+  end
+end
+
+
 ###########################################
 # Init
 ###########################################

data/lib/spectre/assertion.rb

@@ -52,7 +52,7 @@ module Spectre
       end
 
       def should_not_be_empty
-        raise AssertionFailure.new('The list is empty', 'nil')
+        raise AssertionFailure.new('The value does not exist', 'nil')
       end
     end
 
@@ -247,7 +247,7 @@ module Spectre
           raise AssertionFailure.new(e.message, e.expected, e.actual, desc), cause: nil
         rescue Exception => e
           Logger.log_status(desc, Logger::Status::ERROR)
-          raise AssertionFailure.new("An unexpected error occured during expectation: #{e.message}", nil, nil, desc), cause: e
+          raise AssertionFailure.new("An unexpected error occurred during expectation: #{e.message}", nil, nil, desc), cause: e
         end
       end
 

data/lib/spectre/curl.rb

@@ -301,7 +301,10 @@ module Spectre::Curl
 
       req_log = "[>] #{req_id} #{req['method']} #{uri}\n"
       req_log += header_to_s(req['headers'])
-      req_log += try_format_json(req['body'], pretty: true)
+
+      if req[:body] != nil and not req[:body].empty?
+        req_log += try_format_json(req['body'], pretty: true)
+      end
 
       @@logger.info(req_log)
 
@@ -329,7 +332,7 @@ module Spectre::Curl
 
       exit_code = wait_thr.value.exitstatus
 
-      raise Exception.new "An error occured while executing curl:\n#{debug_log.lines.map { |x| not x.empty? }}" unless exit_code == 0
+      raise Exception.new "An error occurred while executing curl:\n#{debug_log.lines.map { |x| not x.empty? }}" unless exit_code == 0
 
       # Parse protocol, version, status code and status message from response
       match = /^(?<protocol>[A-Za-z0-9]+)\/(?<version>\d+\.?\d*) (?<code>\d+) (?<message>.*)/.match result

data/lib/spectre/http.rb

@@ -21,7 +21,8 @@ module Spectre
       'query' => nil,
       'content_type' => '',
       'timeout' => 180,
-    }.freeze
+      'retries' => 0,
+    }
 
     @@modules = []
 
@@ -57,6 +58,10 @@ module Spectre
         @__req['timeout'] = seconds
       end
 
+      def retries count
+        @__req['retries'] = count
+      end
+
       def header name, value
         @__req['headers'] ||= []
         @__req['headers'].append [name, value.to_s.strip]
@@ -173,7 +178,7 @@ module Spectre
       end
 
       def http name, secure: false, &block
-        req = {}
+        req = DEFAULT_HTTP_CONFIG.clone
 
         if @@http_cfg.key? name
           req.deep_merge! @@http_cfg[name].deep_clone
@@ -270,11 +275,12 @@ module Spectre
 
         net_http = Net::HTTP.new(uri.host, uri.port)
         net_http.read_timeout = req['timeout']
+        net_http.max_retries = req['retries']
 
         if uri.scheme == 'https'
           net_http.use_ssl = true
 
-          if req.key? 'cert'
+          if req['cert']
             raise HttpError.new("Certificate '#{req['cert']}' does not exist") unless File.exists? req['cert']
 
             net_http.verify_mode = OpenSSL::SSL::VERIFY_PEER

data/lib/spectre/logger/console.rb

@@ -113,8 +113,14 @@ module Spectre
         print_line('', txt)
       end
 
-      def log_skipped _spec
-        print_line('', Status::SKIPPED.grey)
+      def log_skipped _spec, message=nil
+        txt = Status::SKIPPED
+
+        unless message.nil?
+          txt += ' - ' + message
+        end
+
+        print_line('', txt.grey)
       end
 
       private

data/lib/spectre/logger/file.rb

@@ -79,11 +79,17 @@ module Spectre
 
       def log_error spec, exception
         file, line = exception.backtrace[0].match(/(.*\.rb):(\d+)/).captures
-        @file_log.error "An unexpected error occured at '#{file}:#{line}' while running spec '#{spec.name}': [#{exception.class}] #{exception.message}\n#{exception.backtrace.join "\n"}"
+        @file_log.error "An unexpected error occurred at '#{file}:#{line}' while running spec '#{spec.name}': [#{exception.class}] #{exception.message}\n#{exception.backtrace.join "\n"}"
       end
 
-      def log_skipped spec
-        @file_log.warn "spec '#{spec.desc}' canceled by user"
+      def log_skipped spec, message=nil
+        txt = "spec '#{spec.desc}' skipped"
+
+        unless message.nil?
+          txt += ': ' + message
+        end
+
+        @file_log.warn txt
       end
 
       def log_status desc, status, annotation=nil

data/lib/spectre/logger.rb

@@ -109,8 +109,8 @@ module Spectre
         delegate(:log_error, spec, exception)
       end
 
-      def log_skipped spec
-        delegate(:log_skipped, spec)
+      def log_skipped spec, message=nil
+        delegate(:log_skipped, spec, message)
       end
 
       def log_status desc, status, annotation=nil

data/lib/spectre/reporter/console.rb

@@ -21,7 +21,6 @@ module Spectre::Reporter
         if run_info.failure
           report_str += "     Expected #{run_info.failure.expectation}"
           report_str += " with #{run_info.data}" if run_info.data
-          report_str += " during #{spec.context.__desc}" if spec.context.__desc
 
           report_str += " but it failed"
 
@@ -40,7 +39,7 @@ module Spectre::Reporter
           failures += 1
 
         else
-          report_str += "     but an unexpected error occured during run\n"
+          report_str += "     but an unexpected error occurred during run\n"
           report_str += format_exception(run_info.error)
           errors += 1
         end
@@ -68,6 +67,7 @@ module Spectre::Reporter
 
     def format_title run_info
       title = run_info.spec.subject.desc
+      title += " #{run_info.spec.context.__desc}" if run_info.spec.context.__desc
       title += ' ' + run_info.spec.desc
       title += " (#{'%.3f' % run_info.duration}s)"
       title += " [#{run_info.spec.name}]"

data/lib/spectre/reporter/junit.rb

@@ -1,3 +1,5 @@
+require 'cgi'
+
 # https://llg.cubic.org/docs/junit/
 # Azure mappings: https://docs.microsoft.com/en-us/azure/devops/pipelines/tasks/test/publish-test-results?view=azure-devops&tabs=junit%2Cyaml
 
@@ -22,11 +24,11 @@ module Spectre::Reporter
         errors = run_infos.select { |x| x.error != nil }
         skipped = run_infos.select { |x| x.skipped? }
 
-        xml_str += '<testsuite package="' + subject.desc + '" id="' + suite_id.to_s + '" name="' + subject.desc + '" timestamp="' + datetime + '" tests="' + run_infos.count.to_s + '" failures="' + failures.count.to_s + '" errors="' + errors.count.to_s + '" skipped="' + skipped.count.to_s + '">'
+        xml_str += '<testsuite package="' + CGI::escapeHTML(subject.desc) + '" id="' + CGI::escapeHTML(suite_id.to_s) + '" name="' + CGI::escapeHTML(subject.desc) + '" timestamp="' + datetime + '" tests="' + run_infos.count.to_s + '" failures="' + failures.count.to_s + '" errors="' + errors.count.to_s + '" skipped="' + skipped.count.to_s + '">'
         suite_id += 1
 
         run_infos.each do |run_info|
-          xml_str += '<testcase classname="' + run_info.spec.file.to_s + '" name="' + run_info.spec.desc + '" timestamp="' + run_info.started.to_s + '"  time="' + ('%.3f' % run_info.duration) + '">'
+          xml_str += '<testcase classname="' + CGI::escapeHTML(run_info.spec.file.to_s) + '" name="' + CGI::escapeHTML(run_info.spec.desc) + '" timestamp="' + run_info.started.to_s + '"  time="' + ('%.3f' % run_info.duration) + '">'
 
           if run_info.failure and !run_info.failure.cause
             failure_message = "Expected #{run_info.failure.expectation}"
@@ -38,7 +40,7 @@ module Spectre::Reporter
               failure_message += " but it failed"
             end
 
-            xml_str += '<failure message="' + failure_message.gsub('"', '`') + '"></failure>'
+            xml_str += '<failure message="' + CGI::escapeHTML(failure_message.gsub('"', '`')) + '"></failure>'
           end
 
 
@@ -49,7 +51,7 @@ module Spectre::Reporter
             failure_message = error.message
             text = error.backtrace.join "\n"
 
-            xml_str += '<error message="' + failure_message.gsub('"', '`') + '" type="' + type + '">'
+            xml_str += '<error message="' + CGI::escapeHTML(failure_message.gsub('"', '`')) + '" type="' + type + '">'
             xml_str += '<![CDATA[' + text + ']]>'
             xml_str += '</error>'
           end

data/lib/spectre.rb

@@ -2,7 +2,7 @@ module Spectre
   module Version
     MAJOR = 1
     MINOR = 12
-    TINY  = 1
+    TINY  = 4
   end
 
   VERSION = [Version::MAJOR, Version::MINOR, Version::TINY].compact * '.'
@@ -48,6 +48,12 @@ module Spectre
     end
   end
 
+  class SpectreSkip < Interrupt
+    def initialize message
+      super message
+    end
+  end
+
 
   ###########################################
   # Internal Classes
@@ -252,9 +258,12 @@ module Spectre
         spec.block.call(data)
       rescue ExpectationFailure => e
         run_info.failure = e
+      rescue SpectreSkip => e
+        run_info.skipped = true
+        Logger.log_skipped spec, e.message
       rescue Interrupt
         run_info.skipped = true
-        Logger.log_skipped spec
+        Logger.log_skipped spec, 'canceled by user'
       rescue Exception => e
         run_info.error = e
         Logger.log_error spec, e
@@ -438,9 +447,13 @@ module Spectre
     def property key, val
       Spectre::Runner.current.properties[key] = val
     end
+
+    def skip message=nil
+      raise SpectreSkip.new(message)
+    end
   end
 
-  delegate :describe, :property, to: Spectre
+  delegate :describe, :property, :skip, to: Spectre
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spectre-core
 version: !ruby/object:Gem::Version
-  version: 1.12.1
+  version: 1.12.4
 platform: ruby
 authors:
 - Christian Neubauer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-13 00:00:00.000000000 Z
+date: 2022-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ectoplasm
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: jsonpath
   requirement: !ruby/object:Gem::Requirement
@@ -80,14 +80,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Describe and run automated tests