spectre-core 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76697e95cde1f8359db1f305ba1d15869bd53903d49a0575fa1ee6f2cda7bf98
-  data.tar.gz: 72562ba547d8f8ff68e880d8f196bd31c7da8f1fd5639231bb56aa838830879a
+  metadata.gz: 8333942c6050c7adf1bb9c238538b5364b5648514264612aefc161f715c48e58
+  data.tar.gz: 34ca46ef693108549a69c754bc3b22d5be33e642d9a6dfde040b664af47cfe58
 SHA512:
-  metadata.gz: e1ce860bd80ee58af11d506ad9e297f9a432a6f71f62b7702574c5dd52af0f6a6de7fa8bd2e35c167e387e063f86f97a77f51e0541399a866133c0a3524b22a9
-  data.tar.gz: eebfbac67335a7663f407a26094336ee9815a02ebe74789b82254a45ca6539ccc036f289a3eed37cfc581b8e178986f70cbdf5d3c1af49a657ebce4c9ce7246b
+  metadata.gz: a840c8d9afd7010e0873cf273400a8a5d82b28ad05941d1c4562c03a8aed60fabc7ed704dc2538c5960a940440204df0228d0ce77b6ee11ec68f820c3deb6954
+  data.tar.gz: f6913fa578a938341fbd15455c1e122a4c425bacb68d1353ce7c5f0c8ed96b206eba2625d28d1d8df91fec4161343a28b15db5535c3785000c88cbee914c0f2b

data/exe/spectre

@@ -238,6 +238,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
@@ -260,7 +264,7 @@ if action == 'list'
   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
 
@@ -300,6 +304,7 @@ if action == 'run'
   FileUtils.makedirs log_dir if !Dir.exists? log_dir
 
   # Load Modules
+
   cfg['modules']
     .concat(cfg['include'])
     .select { |mod| !cfg['exclude'].include? mod }
@@ -323,6 +328,14 @@ if action == 'run'
       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)
 
   Spectre::Logger.debug! if cfg['debug']
@@ -334,7 +347,7 @@ if action == 'run'
 
   specs = Spectre.specs(cfg['specs'], cfg['tags'])
 
-  if specs.length == 0
+  if not specs.any?
     puts "No specs found in #{Dir.pwd}"
     exit 1
   end
@@ -348,7 +361,7 @@ if action == 'run'
 
   errors = run_infos.select { |x| x.error != nil or x.failure != nil }
 
-  exit 0 if cfg['ignore_failure'] or errors.count == 0
+  exit 0 if cfg['ignore_failure'] or not errors.any?
 
   exit 1
 end
@@ -360,7 +373,7 @@ end
 
 
 if action == 'envs'
-  exit 1 if envs.length == 0
+  exit 1 unless envs.any?
   puts envs.pretty
   exit 0
 end

data/lib/spectre/assertion.rb

@@ -10,7 +10,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)
@@ -91,11 +91,11 @@ module Spectre
       end
 
       def should_be_empty
-        raise AssertionFailure.new('empty list', self) unless self.length == 0
+        raise AssertionFailure.new('empty list', self) unless self.empty?
       end
 
       def should_not_be_empty
-        raise AssertionFailure.new('no empty list', self) unless self.length > 0
+        raise AssertionFailure.new('no empty list', self) if self.empty?
       end
     end
 

data/lib/spectre/curl.rb

@@ -192,7 +192,8 @@ module Spectre::Curl
       return str unless str or str.empty?
 
       begin
-        json = JSON.parse str
+        json = JSON.parse(str)
+        json.obfuscate!(@@secure_keys) if not @@debug
 
         if pretty
           str = JSON.pretty_generate(json)
@@ -206,6 +207,25 @@ module Spectre::Curl
       str
     end
 
+    def is_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 is_secure?(key) and not @@debug
+        s += "#{key.ljust(30, '.')}: #{value}\n"
+      end
+
+      s
+    end
+
     def invoke req
       cmd = [@@curl_path]
 
@@ -230,11 +250,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 +263,41 @@ 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
 
@@ -297,7 +315,7 @@ module Spectre::Curl
 
       raise "Unable to request #{uri}. Please check if this service is 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/
 
@@ -342,7 +360,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 +369,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'
 

data/lib/spectre/helpers.rb

@@ -13,15 +13,8 @@ class ::String
     DateTime.parse(self)
   end
 
-  def content with: nil
-    fail "'#{self}' is not a file path, or the file does not exist." if !File.exists? self
-    file_content = File.read(self)
-
-    if with
-      file_content.with(with)
-    else
-      file_content
-    end
+  def as_timestamp
+    DateTime.parse(self).to_time.to_i
   end
 
   def with mapping
@@ -30,25 +23,15 @@ class ::String
     new_string = self
 
     mapping.each do |key, value|
-      new_string = new_string.gsub '#{' + key.to_s + '}', value.to_s
+      new_string = new_string.gsub('#{' + key.to_s + '}', value.to_s)
     end
 
     new_string
   end
 
-  def exists?
-    File.exists? self
-  end
-
-  def remove!
-    fail "'#{self}' is not a file path, or the file does not exist." if !File.exists? self
-
-    File.delete self
-  end
-
-  def trim count = 50
-    if (self.length + 3) > count
-      return self[0..count-4] + '...'
+  def trim size = 50
+    if (self.length + 3) > size
+      return self[0..size-4] + '...'
     end
 
     self
@@ -64,6 +47,33 @@ class ::String
       # do nothing and return nil
     end
   end
+
+  # File helpers
+
+  def content with: nil
+    fail "'#{self}' is not a file path, or the file does not exist." if !File.exists? self
+    file_content = File.read(self)
+
+    if with
+      file_content.with(with)
+    else
+      file_content
+    end
+  end
+
+  def file_size
+    fail "'#{self}' is not a file path, or the file does not exist." if !File.exists? self
+    File.size(self)
+  end
+
+  def exists?
+    File.exists? self
+  end
+
+  def remove!
+    fail "'#{self}' is not a file path, or the file does not exist." if !File.exists? self
+    File.delete self
+  end
 end
 
 
@@ -77,6 +87,16 @@ class ::OpenStruct
 
     JsonPath.on(self, path)
   end
+
+  def default_to! defaults
+    defaults.each_key do |key|
+      if not self[key] != nil
+        self[key] = defaults[key]
+      end
+    end
+  end
+
+  alias :defaults_to! :default_to!
 end
 
 
@@ -84,9 +104,31 @@ class ::Hash
   def symbolize_keys
     self.inject({}) { |memo, (k,v)| memo[k.to_sym] = v; memo }
   end
+
+  def default_to! defaults
+    defaults.each_key do |key|
+      if not self[key] != nil
+        self[key] = defaults[key]
+      end
+    end
+  end
+
+  alias :defaults_to! :default_to!
+end
+
+
+class ::Array
+  def last
+    self[-1]
+  end
 end
 
 
 def uuid length = 5
   SecureRandom.uuid().gsub('-', '')[0..length-1]
+end
+
+
+def now
+  Time.now
 end

data/lib/spectre/mixin.rb

@@ -1,4 +1,5 @@
 require 'ostruct'
+require 'spectre/logger'
 
 module Spectre
   module Mixin
@@ -11,12 +12,16 @@ module Spectre
 
       def run desc, with: []
         raise "no mixin with desc '#{desc}' defined" unless @@mixins.key? desc
-        Logger.log_debug "running mixin '#{desc}'"
+        Spectre::Logger.log_debug "running mixin '#{desc}'"
 
-        if with.is_a? Array
-          @@mixins[desc].call *with
+        params = with || {}
+
+        if params.is_a? Array
+          @@mixins[desc].call *params
+        elsif params.is_a? Hash
+          @@mixins[desc].call OpenStruct.new(params)
         else
-          @@mixins[desc].call with
+          @@mixins[desc].call params
         end
       end
 
@@ -24,18 +29,6 @@ module Spectre
       alias_method :step, :run
     end
 
-    Spectre.register do |config|
-      if not config.key? 'mixin_patterns'
-        return
-      end
-
-      config['mixin_patterns'].each do |pattern|
-        Dir.glob(pattern).each do|f|
-          require_relative File.join(Dir.pwd, f)
-        end
-      end
-    end
-
     Spectre.delegate :mixin, :run, :also, :step, to: Mixin
   end
 end

data/lib/spectre/reporter/junit.rb

@@ -57,6 +57,7 @@ module Spectre::Reporter
 
           if run_info.log.count > 0 or run_info.properties.count > 0 or run_info.data
             xml_str += '<system-out>'
+            xml_str += '<![CDATA['
 
             if  run_info.properties.count > 0
               run_info.properties.each do |key, val|
@@ -75,6 +76,7 @@ module Spectre::Reporter
               xml_str += messages.join("\n")
             end
 
+            xml_str += ']]>'
             xml_str += '</system-out>'
           end
 

data/lib/spectre.rb

@@ -1,7 +1,7 @@
 module Spectre
   module Version
     MAJOR = 1
-    MINOR = 10
+    MINOR = 11
     TINY  = 0
   end
 
@@ -31,20 +31,20 @@ module Spectre
   # https://www.dan-manges.com/blog/ruby-dsls-instance-eval-with-delegation
   class DslClass
     def _evaluate &block
-      @__bound_self__ = eval 'self', block.binding
+      @__bound_self__ = eval('self', block.binding)
       instance_eval(&block)
     end
 
     def _execute args, &block
-      @__bound_self__ = eval 'self', block.binding
+      @__bound_self__ = eval('self', block.binding)
       instance_exec(args, &block)
     end
 
     def method_missing method, *args, **kwargs, &block
       if @__bound_self__.respond_to? method
-        @__bound_self__.send method, *args, **kwargs, &block
+        @__bound_self__.send(method, *args, **kwargs, &block)
       else
-        Delegator.redirect method, *args, **kwargs, &block
+        Delegator.redirect(method, *args, **kwargs, &block)
       end
     end
   end
@@ -151,7 +151,7 @@ module Spectre
 
       begin
         specs.each do |spec|
-          if spec.data.length > 0
+          if spec.data.any?
             spec.data.each do |data|
               Logger.log_spec(spec, data) do
                 runs << run_spec(spec, data)
@@ -208,7 +208,7 @@ module Spectre
     end
 
     def run_spec spec, data=nil
-      run_info = RunInfo.new spec, data
+      run_info = RunInfo.new(spec, data)
 
       @@current = run_info
 
@@ -216,16 +216,16 @@ module Spectre
 
       begin
         if spec.context.__before_blocks.count > 0
-          before_ctx = SpecContext.new spec.subject, 'before'
+          before_ctx = SpecContext.new(spec.subject, 'before')
 
           Logger.log_context before_ctx do
             spec.context.__before_blocks.each do |block|
-              block.call data
+              block.call(data)
             end
           end
         end
 
-        spec.block.call data
+        spec.block.call(data)
 
       rescue ExpectationFailure => e
         run_info.failure = e
@@ -240,7 +240,7 @@ module Spectre
 
       ensure
         if spec.context.__after_blocks.count > 0
-          after_ctx = SpecContext.new spec.subject, 'after'
+          after_ctx = SpecContext.new(spec.subject, 'after')
 
           Logger.log_context after_ctx do
             begin
@@ -306,7 +306,11 @@ module Spectre
           .first
       end
 
-      @__subject.add_spec(desc, tags, with, block, self, spec_file)
+      raise "`with' has to be an Array" unless with.is_a? Array
+
+      data = with.map { |x| x.is_a?(Hash) ? OpenStruct.new(x) : x }
+
+      @__subject.add_spec(desc, tags, data, block, self, spec_file)
     end
 
     def before &block

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spectre-core
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Christian Neubauer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2021-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ectoplasm