spectre-core 1.8.3 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4917b9c51ecccb083b1032af33b98c2efd2a0905890d8c33d2a739f2f85e7391
-  data.tar.gz: a8800ce11d35f41dd78c4f63e3fb9f0192bd64c9ab02e436a99ac2641e13ba62
+  metadata.gz: 8333942c6050c7adf1bb9c238538b5364b5648514264612aefc161f715c48e58
+  data.tar.gz: 34ca46ef693108549a69c754bc3b22d5be33e642d9a6dfde040b664af47cfe58
 SHA512:
-  metadata.gz: d60156f1003d5cfd86d6ecb570f785979a24a192f4ca3800916eebb5ceaecdff78125ab893c61aef41a67992fedca580a6d2ff95026504358569a1abede4bdba
-  data.tar.gz: df1057c2157e65a5bcc59c84594a1ef2cc5dfc9a9db0c16a96738f952adc68d747c25801573d16cdaa0a57fe005102436ed26b6ec3b4dbce75fdbf23a0fea516
+  metadata.gz: a840c8d9afd7010e0873cf273400a8a5d82b28ad05941d1c4562c03a8aed60fabc7ed704dc2538c5960a940440204df0228d0ce77b6ee11ec68f820c3deb6954
+  data.tar.gz: f6913fa578a938341fbd15455c1e122a4c425bacb68d1353ce7c5f0c8ed96b206eba2625d28d1d8df91fec4161343a28b15db5535c3785000c88cbee914c0f2b

data/exe/spectre

@@ -48,6 +48,7 @@ DEFAULT_CONFIG = {
   },
   'debug' => false,
   'out_path' => './reports',
+  'secure_keys' => ['password', 'secret', 'token', 'secure', 'authorization'],
   'spec_patterns' => ['./specs/**/*.spec.rb'],
   'mixin_patterns' => ['../common/mixins/**/*.mixin.rb', './mixins/**/*.mixin.rb'],
   'env_patterns' => ['./environments/**/*.env.yml'],
@@ -68,10 +69,6 @@ DEFAULT_CONFIG = {
     'spectre/http/basic_auth',
     'spectre/http/keystone',
     'spectre/resources',
-    'spectre/ssh',
-    'spectre/ftp',
-    'spectre/mysql',
-    # 'spectre/postgres',
   ],
   'include' => [
 
@@ -126,11 +123,15 @@ Specific options:}
     cmd_options['colored'] = false
   end
 
+  opts.on('--ignore-failure', 'Always exit with code 0') do
+    cmd_options['ignore_failure'] = true
+  end
+
   opts.on('-o PATH', '--out PATH', 'Output directory path') do |path|
-    cmd_options['out_path'] = path
+    cmd_options['out_path'] = File.absolute_path(path)
   end
 
-  opts.on('-r NAME', '--reporter NAME', Array, "A list of reporters to use") do |reporters|
+  opts.on('-r NAME', '--reporters NAME', Array, "A list of reporters to use") do |reporters|
     cmd_options['reporters'] = reporters
   end
 
@@ -205,8 +206,9 @@ envs = {}
 read_env_files = {}
 cfg['env_patterns'].each do |pattern|
   Dir.glob(pattern).each do|f|
-    spec_env = YAML.load_file(f)
-    name = spec_env.delete('name') || 'default'
+    spec_env = YAML.load_file(f) || {}
+
+    name = spec_env['name'] || 'default'
 
     if envs.key? name
       existing_env_file = read_env_files[name]
@@ -236,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
@@ -258,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
 
@@ -298,22 +304,38 @@ 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 }
     .each do |mod|
       begin
-        if !File.exists? mod
-          require_relative File.join('../lib', mod)
-        else
+        spectre_lib_mod = File.join('../lib', mod)
+
+        if File.exists? mod
           require_relative mod
+
+        elsif File.exists? spectre_lib_mod
+          require_relative spectre_lib_mod
+
+        else
+          require mod
         end
-      rescue => e
+
+      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)
 
   Spectre::Logger.debug! if cfg['debug']
@@ -325,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
@@ -337,7 +359,11 @@ if action == 'run'
     reporter.report(run_infos)
   end
 
-  exit 0
+  errors = run_infos.select { |x| x.error != nil or x.failure != nil }
+
+  exit 0 if cfg['ignore_failure'] or not errors.any?
+
+  exit 1
 end
 
 
@@ -347,7 +373,7 @@ end
 
 
 if action == 'envs'
-  exit 1 if envs.length == 0
+  exit 1 unless envs.any?
   puts envs.pretty
   exit 0
 end
@@ -464,6 +490,16 @@ reports/
 **/environments/*.env.secret.yml
 ]
 
+DEFAULT_GEMFILE = %[source 'https://rubygems.org'
+
+gem 'spectre-core', '>= #{Spectre::VERSION}'
+# gem 'spectre-mysql', '>= 1.0.0'
+# gem 'spectre-ssh', '>= 1.0.0'
+# gem 'spectre-ftp', '>= 1.0.0'
+# gem 'spectre-curl', '>= 1.0.0'
+# gem 'spectre-git', '>= 0.1.0'
+]
+
 if action == 'init'
   DEFAULT_FILES = [
     ['./environments/default.env.yml', DEFAULT_ENV_CFG],
@@ -471,6 +507,7 @@ if action == 'init'
     ['./specs/sample.spec.rb', SAMPLE_SPEC],
     ['./spectre.yml', DEFAULT_SPECTRE_CFG],
     ['./.gitignore', DEFAULT_GITIGNORE],
+    ['./Gemfile', DEFAULT_GEMFILE],
   ]
 
   %w(environments logs specs).each do |dir_name|

data/lib/spectre/assertion.rb

@@ -6,19 +6,19 @@ module Spectre
   module Assertion
     class ::Object
       def should_be(val)
-          raise AssertionFailure.new("The value '#{self.to_s.trim}' should be '#{val.to_s.trim}'", val, self) unless self.to_s == val.to_s
+        raise AssertionFailure.new("The value '#{self.to_s.trim}' should be '#{val.to_s.trim}'", val, self) unless self.to_s == val.to_s
       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)
-          raise AssertionFailure.new("The value '#{self.to_s.trim}' should not be '#{val.to_s.trim}'", val, self) unless self.to_s != val.to_s
+        raise AssertionFailure.new("The value '#{self.to_s.trim}' should not be '#{val.to_s.trim}'", val, self) unless self.to_s != val.to_s
       end
 
       def should_not_exist
-          raise AssertionFailure.new("The value '#{self.to_s.trim}' should not exist, but it does", val, self) unless self.to_s != nil
+        raise AssertionFailure.new("The value '#{self.to_s.trim}' should not exist, but it does", val, self) unless self.to_s != nil
       end
 
       def should_not_be_empty
@@ -76,7 +76,7 @@ module Spectre
           val = OpenStruct.new(val)
         end
 
-        raise AssertionFailure.new("The list [#{list.join(', ').trim}] should contain '#{val.trim}'", val, list) unless list.include? val
+        raise AssertionFailure.new("The list [#{list.join(', ').trim}] should contain '#{val.to_s.trim}'", val, list) unless list.include? val
       end
 
       def should_not_contain(val)
@@ -87,15 +87,15 @@ module Spectre
           val = OpenStruct.new(val)
         end
 
-        raise AssertionFailure.new("The list [#{list.join(', ').trim}] should not contain '#{val.trim}'", val, list) if list.include? val
+        raise AssertionFailure.new("The list [#{list.join(', ').trim}] should not contain '#{val.to_s.trim}'", val, list) if list.include? val
       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
 
@@ -110,7 +110,7 @@ module Spectre
       end
 
       def should_not_be(val)
-          raise AssertionFailure.new("The text '#{self.trim}' should not be '#{val.to_s.trim}'", val, self) unless self != val
+        raise AssertionFailure.new("The text '#{self.trim}' should not be '#{val.to_s.trim}'", val, self) unless self != val
       end
 
       def should_not_be_empty
@@ -118,8 +118,10 @@ module Spectre
       end
 
       def should_contain(value)
+        raise AssertionFailure.new("`value' must not be nil") if value.nil?
+
         predicate = proc { |x| self.include? x.to_s }
-        evaluation = SingleEvaluation.new value
+        evaluation = SingleEvaluation.new(value)
         success = evaluation.call(predicate)
 
         return if success
@@ -165,7 +167,7 @@ module Spectre
 
     class SingleEvaluation < Evaluation
       def initialize value
-        super value, nil
+        super(value, nil)
       end
 
       def call predicate
@@ -180,7 +182,7 @@ module Spectre
 
     class OrEvaluation < Evaluation
       def initialize value, other
-        super value, other
+        super(value, other)
       end
 
       def call predicate
@@ -195,7 +197,7 @@ module Spectre
 
     class AndEvaluation < Evaluation
       def initialize value, other
-        super value, other
+        super(value, other)
       end
 
       def call predicate
@@ -222,14 +224,6 @@ module Spectre
     class << self
       @@success = nil
 
-      def eval_assertion predicate, val
-        if val.is_a? Proc
-          val.call(predicate)
-        else
-          predicate.call(val)
-        end
-      end
-
       def expect desc
         begin
           Logger.log_process("expect #{desc}")

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

@@ -2,6 +2,7 @@ require 'securerandom'
 require 'json'
 require 'date'
 require 'ostruct'
+require 'jsonpath'
 
 class ::String
   def as_json
@@ -12,17 +13,57 @@ class ::String
     DateTime.parse(self)
   end
 
+  def as_timestamp
+    DateTime.parse(self).to_time.to_i
+  end
+
+  def with mapping
+    return self unless mapping and mapping.is_a? Hash
+
+    new_string = self
+
+    mapping.each do |key, value|
+      new_string = new_string.gsub('#{' + key.to_s + '}', value.to_s)
+    end
+
+    new_string
+  end
+
+  def trim size = 50
+    if (self.length + 3) > size
+      return self[0..size-4] + '...'
+    end
+
+    self
+  end
+
+  def pick path
+    raise ArgumentError.new("`path' must not be nil or empty") if path.nil? or path.empty?
+
+    begin
+      JsonPath.on(self, path)
+
+    rescue MultiJson::ParseError
+      # 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
-      with.each do |key, value|
-        file_content = file_content.gsub '#{' + key.to_s + '}', value.to_s
-      end
+      file_content.with(with)
+    else
+      file_content
     end
+  end
 
-    file_content
+  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?
@@ -31,17 +72,8 @@ class ::String
 
   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] + '...'
-    end
-
-    self
-  end
 end
 
 
@@ -49,6 +81,22 @@ class ::OpenStruct
   def to_json *args, **kwargs
     self.to_h.inject({}) { |memo, (k,v)| memo[k] = v.is_a?(OpenStruct) ? v.to_h : v; memo }.to_json(*args, **kwargs)
   end
+
+  def pick path
+    raise ArgumentError.new("`path' must not be nil or empty") if path.nil? or path.empty?
+
+    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
 
 
@@ -56,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]
+  SecureRandom.uuid().gsub('-', '')[0..length-1]
+end
+
+
+def now
+  Time.now
 end