spectre-core 1.10.0 → 1.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76697e95cde1f8359db1f305ba1d15869bd53903d49a0575fa1ee6f2cda7bf98
-  data.tar.gz: 72562ba547d8f8ff68e880d8f196bd31c7da8f1fd5639231bb56aa838830879a
+  metadata.gz: b85338c15a8c29d520ed02d2e6816a64c579b6edd654f3d047fbeddb4a5c0ea3
+  data.tar.gz: 7be4646412f7dd3a971b21269215cddff5398cc12a50cd42dcd78a6bb70bf012
 SHA512:
-  metadata.gz: e1ce860bd80ee58af11d506ad9e297f9a432a6f71f62b7702574c5dd52af0f6a6de7fa8bd2e35c167e387e063f86f97a77f51e0541399a866133c0a3524b22a9
-  data.tar.gz: eebfbac67335a7663f407a26094336ee9815a02ebe74789b82254a45ca6539ccc036f289a3eed37cfc581b8e178986f70cbdf5d3c1af49a657ebce4c9ce7246b
+  metadata.gz: 043d7b2bda42acf5687f09ce9468c8b3ce01566c5a61d3d1c753b9d61a126898b883f00b67be67d6d61600a85143475e8b041b31fdf42f02dee5aca48260037c
+  data.tar.gz: 890154e9fabf2664d50289f5eeb212cd9ea508a967341d9b27a2ad5dd329600542a168352274d4a0ca09dbe9aa91f3bc22e6c855d36a80e1219ccac9132dd047

data/exe/spectre

@@ -10,14 +10,6 @@ require 'ectoplasm'
 require_relative '../lib/spectre'
 
 
-class ::Hash
-  def deep_merge!(second)
-    merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge!(v2, &merger) : v2 }
-    self.merge!(second, &merger)
-  end
-end
-
-
 DEFAULT_CONFIG = {
   'config_file' => './spectre.yml',
   'environment' => 'default',
@@ -44,7 +36,7 @@ DEFAULT_CONFIG = {
       'separator' => '-- <desc>',
       'start_group' => "-- Start '<desc>'",
       'end_group' => "-- End '<desc>'",
-    }
+    },
   },
   'debug' => false,
   'out_path' => './reports',
@@ -75,7 +67,7 @@ DEFAULT_CONFIG = {
   ],
   'exclude' => [
 
-  ]
+  ],
 }
 
 
@@ -148,10 +140,9 @@ Specific options:}
 
     curr_opt = cmd_options
     (key.split '.').each do |k|
-      curr_opt[k] = {} if not curr_opt.key? k
+      curr_opt[k] = {} unless curr_opt.key? k
     end
     curr_opt = val
-
   end
 
   opts.separator "\nCommon options:"
@@ -226,7 +217,7 @@ cfg['env_partial_patterns'].each do |pattern|
   Dir.glob(pattern).each do|f|
     partial_env = YAML.load_file(f)
     name = partial_env.delete('name') || 'default'
-    next if not envs.key? name
+    next unless envs.key? name
 
     envs[name].deep_merge! partial_env
   end
@@ -238,6 +229,10 @@ cfg.merge! env if env
 
 String.colored! if cfg['colored']
 
+# Load environment exlicitly before loading specs to make it available in spec definition
+require_relative '../lib/spectre/environment' unless cfg['exclude'].include? 'spectre/environment'
+Spectre.configure(cfg)
+
 
 ###########################################
 # Load Specs
@@ -256,11 +251,11 @@ end
 ###########################################
 
 
-if action == 'list'
+if 'list' == action
   colors = [:blue, :magenta, :yellow, :green]
   specs = Spectre.specs(cfg['specs'], cfg['tags'])
 
-  exit 1 if specs.length == 0
+  exit 1 unless specs.any?
 
   counter = 0
 
@@ -285,42 +280,52 @@ end
 ###########################################
 
 
-if action == 'run'
+if 'run' == action
   # Initialize logger
   now = Time.now
 
-  cfg['log_file'] = cfg['log_file'].frmt({
-    shortdate: now.strftime('%Y-%m-%d'),
-    date: now.strftime('%Y-%m-%d_%H%M%S'),
-    timestamp: now.strftime('%s'),
-    subject: 'spectre',
-  })
+  cfg['log_file'] = cfg['log_file'].frmt(
+{
+  shortdate: now.strftime('%Y-%m-%d'),
+  date: now.strftime('%Y-%m-%d_%H%M%S'),
+  timestamp: now.strftime('%s'),
+  subject: 'spectre',
+})
 
   log_dir = File.dirname cfg['log_file']
-  FileUtils.makedirs log_dir if !Dir.exists? log_dir
+  FileUtils.makedirs log_dir unless Dir.exists? log_dir
 
   # Load Modules
+
   cfg['modules']
     .concat(cfg['include'])
     .select { |mod| !cfg['exclude'].include? mod }
     .each do |mod|
-      begin
-        spectre_lib_mod = File.join('../lib', mod)
-
-        if File.exists? mod
-          require_relative mod
+    begin
+      mod_file = mod + '.rb'
+      spectre_lib_mod = File.join(File.dirname(__dir__), 'lib', mod_file)
 
-        elsif File.exists? spectre_lib_mod
-          require_relative spectre_lib_mod
+      if File.exists? mod_file
+        require_relative mod_file
 
-        else
-          require mod
-        end
+      elsif File.exists? spectre_lib_mod
+        require_relative spectre_lib_mod
 
-      rescue LoadError => e
-        puts "Unable to load module #{mod}. Check if the module exists or remove it from your spectre config:\n#{e.message}"
-        exit 1
+      else
+        require mod
       end
+    rescue LoadError => e
+      puts "Unable to load module #{mod}. Check if the module exists or remove it from your spectre config:\n#{e.message}"
+      exit 1
+    end
+  end
+
+  # Load mixins
+
+  cfg['mixin_patterns'].each do |pattern|
+    Dir.glob(pattern).each do|f|
+      require_relative File.join(Dir.pwd, f)
+    end
   end
 
   Spectre.configure(cfg)
@@ -334,7 +339,7 @@ if action == 'run'
 
   specs = Spectre.specs(cfg['specs'], cfg['tags'])
 
-  if specs.length == 0
+  unless specs.any?
     puts "No specs found in #{Dir.pwd}"
     exit 1
   end
@@ -346,9 +351,9 @@ if action == 'run'
     reporter.report(run_infos)
   end
 
-  errors = run_infos.select { |x| x.error != nil or x.failure != nil }
+  errors = run_infos.select { |x| nil != x.error or nil != x.failure }
 
-  exit 0 if cfg['ignore_failure'] or errors.count == 0
+  exit 0 if cfg['ignore_failure'] or not errors.any?
 
   exit 1
 end
@@ -359,8 +364,8 @@ end
 ###########################################
 
 
-if action == 'envs'
-  exit 1 if envs.length == 0
+if 'envs' == action
+  exit 1 unless envs.any?
   puts envs.pretty
   exit 0
 end
@@ -371,7 +376,7 @@ end
 ###########################################
 
 
-if action == 'show'
+if 'show' == action
   puts cfg.pretty
   exit 0
 end
@@ -382,7 +387,7 @@ end
 ###########################################
 
 
-if action == 'dump'
+if 'dump' == action
   puts YAML.dump(cfg)
 end
 
@@ -487,7 +492,7 @@ gem 'spectre-core', '>= #{Spectre::VERSION}'
 # gem 'spectre-git', '>= 0.1.0'
 ]
 
-if action == 'init'
+if 'init' == action
   DEFAULT_FILES = [
     ['./environments/default.env.yml', DEFAULT_ENV_CFG],
     ['./environments/default.env.secret.yml', DEFAULT_ENV_SECRET_CFG],
@@ -502,10 +507,10 @@ if action == 'init'
   end
 
   DEFAULT_FILES.each do |file, content|
-    if not File.exists? file
+    unless File.exists? file
       File.write(file, content)
     end
   end
 
   exit 0
-end
+end

data/lib/spectre/assertion.rb

@@ -1,3 +1,5 @@
+require_relative '../spectre'
+
 require 'ostruct'
 require_relative 'logger'
 
@@ -10,7 +12,7 @@ module Spectre
       end
 
       def should_be_empty
-        raise AssertionFailure.new("The value '#{self.to_s.trim}' should be empty", nil, self) unless self == nil
+        raise AssertionFailure.new("The value '#{self.to_s.trim}' should be empty", nil, self) unless self.nil?
       end
 
       def should_not_be(val)
@@ -22,7 +24,7 @@ module Spectre
       end
 
       def should_not_be_empty
-        raise AssertionFailure.new('The value should not be empty', 'nothing', self) unless self != nil
+        raise AssertionFailure.new('The value is empty', 'nothing', self) unless self != nil
       end
 
       def or other
@@ -34,7 +36,6 @@ module Spectre
       end
     end
 
-
     class ::NilClass
       def should_be(val)
         raise AssertionFailure.new("There is nothing, but the value should be '#{val.to_s.trim}'", val, nil) unless val == nil
@@ -51,11 +52,10 @@ module Spectre
       end
 
       def should_not_be_empty
-        raise AssertionFailure.new('not empty', 'nil')
+        raise AssertionFailure.new('The list is empty', 'nil')
       end
     end
 
-
     class ::Hash
       def should_contain(other)
         raise AssertionFailure.new(other, self) unless self.merge(other) == self
@@ -64,8 +64,25 @@ module Spectre
       def should_not_contain(other)
         raise AssertionFailure.new(other, self) unless self.merge(other) != self
       end
+
+      def should_be_empty
+        raise AssertionFailure.new('The object should be empty', nil, self) unless self.empty?
+      end
+
+      def should_not_be_empty
+        raise AssertionFailure.new('The object should not be empty', nil, self) if self.empty?
+      end
     end
 
+    class ::OpenStruct
+      def should_be_empty
+        raise AssertionFailure.new('The object should be empty', nil, self) unless self.to_h.empty?
+      end
+
+      def should_not_be_empty
+        raise AssertionFailure.new('The object should not be empty', nil, self) if self.to_h.empty?
+      end
+    end
 
     class ::Array
       def should_contain(val)
@@ -91,15 +108,14 @@ module Spectre
       end
 
       def should_be_empty
-        raise AssertionFailure.new('empty list', self) unless self.length == 0
+        raise AssertionFailure.new('The list is not empty', self) unless self.empty?
       end
 
       def should_not_be_empty
-        raise AssertionFailure.new('no empty list', self) unless self.length > 0
+        raise AssertionFailure.new('The list is empty', self) if self.empty?
       end
     end
 
-
     class ::String
       def should_be(val)
         raise AssertionFailure.new("The text '#{self.trim}' should be '#{val.to_s.trim}'", val, self) unless self == val
@@ -118,7 +134,7 @@ module Spectre
       end
 
       def should_contain(value)
-        raise AssertionFailure.new("`value' must not be nil") if value.nil?
+        raise AssertionFailure.new("The value is nil") if value.nil?
 
         predicate = proc { |x| self.include? x.to_s }
         evaluation = SingleEvaluation.new(value)
@@ -145,7 +161,6 @@ module Spectre
       alias :& :and
     end
 
-
     class Evaluation
       def initialize value, other
         @value = value
@@ -164,7 +179,6 @@ module Spectre
       alias :& :and
     end
 
-
     class SingleEvaluation < Evaluation
       def initialize value
         super(value, nil)
@@ -179,7 +193,6 @@ module Spectre
       end
     end
 
-
     class OrEvaluation < Evaluation
       def initialize value, other
         super(value, other)
@@ -194,7 +207,6 @@ module Spectre
       end
     end
 
-
     class AndEvaluation < Evaluation
       def initialize value, other
         super(value, other)
@@ -209,7 +221,6 @@ module Spectre
       end
     end
 
-
     class AssertionFailure < ExpectationFailure
       attr_reader :expected, :actual
 
@@ -229,14 +240,11 @@ module Spectre
           Logger.log_process("expect #{desc}")
           yield
           Logger.log_status(desc, Logger::Status::OK)
-
         rescue Interrupt => e
           raise e
-
         rescue AssertionFailure => e
           Logger.log_status(desc, Logger::Status::FAILED)
           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
@@ -244,15 +252,21 @@ module Spectre
       end
 
       def observe desc = nil
+        prefix = 'observing'
+        prefix += " '#{desc}'" if desc
+
         begin
-          Logger.log_info("observing #{desc}") if desc
+          Logger.log_info(prefix) if desc
           yield
           @@success = true
-
+          @@logger.info("#{prefix} finished with success")
         rescue Interrupt => e
           raise e
-
         rescue Exception => e
+          error_message = "#{prefix} finished with failure: #{e.message}"
+          error_message += "\n" + e.backtrace.join("\n") if @@debug
+
+          @@logger.info(error_message)
           @@success = false
         end
       end
@@ -266,6 +280,11 @@ module Spectre
       end
     end
 
+    Spectre.register do |config|
+      @@logger = ::Logger.new(config['log_file'], progname: 'spectre/assertion')
+      @@debug = config['debug']
+    end
+
     Spectre.delegate :expect, :observe, :success?, :fail_with, to: self
   end
 end

data/lib/spectre/bag.rb

@@ -1,3 +1,5 @@
+require_relative '../spectre'
+
 require 'ostruct'
 
 module Spectre
@@ -14,6 +16,6 @@ module Spectre
       @@bag = OpenStruct.new
     end
 
-    Spectre.delegate :bag, to: Bag
+    Spectre.delegate :bag, to: self
   end
-end
+end

data/lib/spectre/curl.rb

@@ -1,3 +1,5 @@
+require_relative '../spectre'
+
 require 'open3'
 require 'ostruct'
 
@@ -21,17 +23,17 @@ module Spectre::Curl
     end
 
     def header name, value
-      @__req['headers'] = [] if not @__req['headers']
+      @__req['headers'] = [] unless @__req['headers']
       @__req['headers'].append [name, value.to_s.strip]
     end
 
     def param name, value
-      @__req['query'] = [] if not @__req['query']
+      @__req['query'] = [] unless @__req['query']
       @__req['query'].append [name, value.to_s.strip]
     end
 
     def content_type media_type
-      @__req['headers'] = [] if not @__req['headers']
+      @__req['headers'] = [] unless @__req['headers']
       @__req['headers'].append ['Content-Type', media_type]
     end
 
@@ -111,7 +113,7 @@ module Spectre::Curl
     end
 
     def json
-      return nil if not @res[:body]
+      return nil unless @res[:body]
 
       if @data == nil
         begin
@@ -161,28 +163,31 @@ module Spectre::Curl
 
       if @@http_cfg.key? name
         req.merge! @@http_cfg[name]
-        raise "No `base_url' set for HTTP client '#{name}'. Check your HTTP config in your environment." if !req['base_url']
+        raise "No `base_url' set for HTTP client '#{name}'. Check your HTTP config in your environment." unless req['base_url']
       else
         req['base_url'] = name
       end
 
-      SpectreHttpRequest.new(req).instance_eval(&block) if block_given?
+      SpectreHttpRequest.new(req)._evaluate(&block) if block_given?
 
       invoke(req)
     end
 
     def curl_request
       raise 'No request has been invoked yet' unless @@request
+
       @@request
     end
 
     def curl_response
       raise 'There is no response. No request has been invoked yet.' unless @@response
+
       @@response
     end
 
     def register mod
       raise 'Module must not be nil' unless mod
+
       @@modules << mod
     end
 
@@ -192,7 +197,8 @@ module Spectre::Curl
       return str unless str or str.empty?
 
       begin
-        json = JSON.parse str
+        json = JSON.parse(str)
+        json.obfuscate!(@@secure_keys) unless @@debug
 
         if pretty
           str = JSON.pretty_generate(json)
@@ -206,6 +212,25 @@ module Spectre::Curl
       str
     end
 
+    def secure? key
+      @@secure_keys.any? { |x| key.to_s.downcase.include? x.downcase }
+    end
+
+    def header_to_s headers
+      s = ''
+
+      return s unless headers
+
+      headers.each do |header|
+        key = header[0].to_s
+        value = header[1].to_s
+        value = '*****' if secure?(key) and not @@debug
+        s += "#{key.ljust(30, '.')}: #{value}\n"
+      end
+
+      s
+    end
+
     def invoke req
       cmd = [@@curl_path]
 
@@ -217,12 +242,12 @@ module Spectre::Curl
 
       uri = req['base_url']
 
-      if not uri.match /http(?:s)?:\/\//
+      unless uri.match /http(?:s)?:\/\//
         uri = scheme + '://' + uri
       end
 
       if req['path']
-        uri += '/' if !uri.end_with? '/'
+        uri += '/' unless uri.end_with? '/'
         uri += req['path']
       end
 
@@ -230,11 +255,11 @@ module Spectre::Curl
         uri += '?'
         uri += req['query']
           .map { |x| x.join '='}
-          .join '&'
+          .join('&')
       end
 
-      cmd.append '"' + uri + '"'
-      cmd.append '-X', req['method'] unless req['method'] == 'GET' or (req['body'] and req['method'] == 'POST')
+      cmd.append('"' + uri + '"')
+      cmd.append('-X', req['method']) unless req['method'] == 'GET' or (req['body'] and req['method'] == 'POST')
 
       # Call all registered modules
       @@modules.each do |mod|
@@ -243,43 +268,42 @@ module Spectre::Curl
 
       # Add headers to curl command
       req['headers'].each do |header|
-        cmd.append '-H', '"' + header.join(':') + '"'
+        cmd.append('-H', '"' + header.join(':') + '"')
       end if req['headers']
 
       # Add request body
       if req['body'] != nil and not req['body'].empty?
         req_body = try_format_json(req['body']).gsub(/"/, '\\"')
-        cmd.append '-d', '"' + req_body + '"'
+        cmd.append('-d', '"' + req_body + '"')
       elsif ['POST', 'PUT', 'PATCH'].include? req['method'].upcase
-        cmd.append '-d', '"\n"'
+        cmd.append('-d', '"\n"')
       end
 
       # Add certificate path if one if given
       if req['cert']
         raise "Certificate '#{req['cert']}' does not exist" unless File.exists? req['cert']
-        cmd.append '--cacert', req['cert']
+
+        cmd.append('--cacert', req['cert'])
       elsif req['use_ssl'] or uri.start_with? 'https'
-        cmd.append '-k'
+        cmd.append('-k')
       end
 
-      cmd.append '-i'
-      cmd.append '-v'
+      cmd.append('-i')
+      cmd.append('-v')
 
-      @@request = OpenStruct.new req
+      @@request = OpenStruct.new(req)
 
-      sys_cmd = cmd.join ' '
+      sys_cmd = cmd.join(' ')
 
-      @@logger.debug sys_cmd
+      @@logger.debug(sys_cmd)
 
       req_id = SecureRandom.uuid()[0..5]
 
       req_log = "[>] #{req_id} #{req['method']} #{uri}\n"
-      req['headers'].each do |header|
-        req_log += "#{header[0].to_s.ljust(30, '.')}: #{header[1].to_s}\n"
-      end if req['headers']
-      req_log += req['body'] if req['body'] != nil and not req['body'].empty?
+      req_log += header_to_s(req['headers'])
+      req_log += try_format_json(req['body'], pretty: true)
 
-      @@logger.info req_log
+      @@logger.info(req_log)
 
       start_time = Time.now
 
@@ -295,9 +319,9 @@ module Spectre::Curl
 
       # debug_log.lines.each { |x| @@logger.debug x unless x.empty? }
 
-      raise "Unable to request #{uri}. Please check if this service is reachable." unless output
+      raise "Unable to request #{uri}. Please check if this URL is correctly configured and reachable." unless output
 
-      @@logger.debug "[<] #{req_id} stdout:\n#{output}"
+      @@logger.debug("[<] #{req_id} stdout:\n#{output}")
 
       header, body = output.split /\r?\n\r?\n/
 
@@ -323,7 +347,7 @@ module Spectre::Curl
         code: match[:code].to_i,
         message: match[:message],
         headers: Hash[res_headers],
-        body: body
+        body: body,
       }
 
       # Call all registered modules
@@ -342,7 +366,7 @@ module Spectre::Curl
 
       @@logger.info res_log
 
-      @@response = SpectreHttpResponse.new res
+      @@response = SpectreHttpResponse.new(res)
 
       raise "Response did not indicate success: #{@@response.code} #{@@response.message}" if req['ensure_success'] and not @@response.success?
 
@@ -351,7 +375,12 @@ module Spectre::Curl
   end
 
   Spectre.register do |config|
-    @@logger = ::Logger.new config['log_file'], progname: 'spectre/curl'
+    @@debug = config['debug']
+
+    @@logger = ::Logger.new(config['log_file'], progname: 'spectre/curl')
+    @@logger.level = @@debug ? Logger::DEBUG : Logger::INFO
+
+    @@secure_keys = config['secure_keys'] || []
 
     @@curl_path = config['curl_path'] || 'curl'
 
@@ -365,4 +394,4 @@ module Spectre::Curl
   end
 
   Spectre.delegate :curl, :curl_response, :curl_request, to: self
-end
+end

data/lib/spectre/diagnostic.rb

@@ -1,3 +1,5 @@
+require_relative '../spectre'
+
 module Spectre
   module Diagnostic
     module Stopwatch
@@ -21,9 +23,17 @@ module Spectre
         def duration
           @@end_time - @@start_time
         end
+
+        def started_at
+          @@start_time
+        end
+
+        def finished_at
+          @@end_time
+        end
       end
 
-      Spectre.delegate :start_watch, :stop_watch, :duration, :measure, to: Stopwatch
+      Spectre.delegate :start_watch, :stop_watch, :duration, :measure, to: self
     end
   end
-end
+end