spectre-core 1.12.2 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b85338c15a8c29d520ed02d2e6816a64c579b6edd654f3d047fbeddb4a5c0ea3
-  data.tar.gz: 7be4646412f7dd3a971b21269215cddff5398cc12a50cd42dcd78a6bb70bf012
+  metadata.gz: fd2c5dd03f2ded27246d351696a749bf0f0fbb06ff87ecc27363873202ecb1ac
+  data.tar.gz: a17d75c2581c6f64f58664b78c68449936610f8fa9c6c313dc73011da59094c6
 SHA512:
-  metadata.gz: 043d7b2bda42acf5687f09ce9468c8b3ce01566c5a61d3d1c753b9d61a126898b883f00b67be67d6d61600a85143475e8b041b31fdf42f02dee5aca48260037c
-  data.tar.gz: 890154e9fabf2664d50289f5eeb212cd9ea508a967341d9b27a2ad5dd329600542a168352274d4a0ca09dbe9aa91f3bc22e6c855d36a80e1219ccac9132dd047
+  metadata.gz: 941692c923f0437410ad99376a1df249c81dd970c527445e9a4e3721554e35e2f6d10cca4f23293894df212f7bd5dc4b36ab1610b3351919a88dc9a6fdd8cd18
+  data.tar.gz: 7245b35708dc29ee1c0d2ec60ec10cbd39125f7302aa3e84962037e2e30824793290b59f70c51e8a7892d79780747697f8635c90b48e3ba4d2276015538bb8b3

data/exe/spectre

@@ -9,8 +9,14 @@ 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 = {
+  'project' => nil,
   'config_file' => './spectre.yml',
   'environment' => 'default',
   'specs' => [],
@@ -21,8 +27,8 @@ DEFAULT_CONFIG = {
     'Spectre::Reporter::Console',
   ],
   'loggers' => [
-    'Spectre::Logger::Console',
-    'Spectre::Logger::File',
+    'Spectre::Logging::Console',
+    'Spectre::Logging::File',
   ],
   'log_file' => './logs/spectre_<date>.log',
   'log_format' => {
@@ -50,6 +56,8 @@ DEFAULT_CONFIG = {
     'spectre/helpers',
     'spectre/reporter/console',
     'spectre/reporter/junit',
+    'spectre/reporter/vstest',
+    'spectre/reporter/html',
     'spectre/logger/console',
     'spectre/logger/file',
     'spectre/assertion',
@@ -61,6 +69,7 @@ DEFAULT_CONFIG = {
     'spectre/http/basic_auth',
     'spectre/http/keystone',
     'spectre/resources',
+    'spectre/async',
   ],
   'include' => [
 
@@ -72,20 +81,24 @@ DEFAULT_CONFIG = {
 
 
 cmd_options = {}
+property_overrides = {}
+
+$COMMAND = ['spectre'].concat(ARGV.clone).join(' ')
 
-opt_parser = OptionParser.new do |opts|
+OptionParser.new do |opts|
   opts.banner = %{Spectre #{Spectre::VERSION}
 
-Usage: spectre [command] [options]
+  Usage: spectre [command] [options]
 
-Commands:
-  list        List specs
-  run         Run specs (default)
-  show        Print current environment settings
-  dump        Dumps the given environment in YAML format to console
-  init        Initializes a new spectre project
+  Commands:
+    list        List specs
+    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:}
+  Specific options:}
 
   opts.on('-s SPEC,SPEC', '--specs SPEC,SPEC', Array, 'The specs to run') do |specs|
     cmd_options['specs'] = specs
@@ -132,17 +145,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,20 +193,21 @@ 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
+cfg['project'] = File.basename(Dir.pwd) unless cfg['project']
 
+cfg.deep_merge! cmd_options
 
 ###########################################
 # Load Environment
@@ -197,7 +218,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 +236,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 +245,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']
@@ -284,16 +308,15 @@ 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 unless Dir.exists? log_dir
+  log_dir = File.dirname(cfg['log_file'])
+  FileUtils.makedirs(log_dir)
 
   # Load Modules
 
@@ -330,11 +353,11 @@ if 'run' == action
 
   Spectre.configure(cfg)
 
-  Spectre::Logger.debug! if cfg['debug']
+  Spectre::Logging.debug! if cfg['debug']
 
   cfg['loggers'].each do |logger_name|
     logger = Kernel.const_get(logger_name).new(cfg)
-    Spectre::Logger.add(logger)
+    Spectre::Logging.add(logger)
   end if cfg['loggers']
 
   specs = Spectre.specs(cfg['specs'], cfg['tags'])
@@ -392,6 +415,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

@@ -8,23 +8,23 @@ 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("'#{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("'#{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("'#{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("'#{self.to_s.trim}' should not exist, but it does", val, self) unless self.to_s != nil
       end
 
       def should_not_be_empty
-        raise AssertionFailure.new('The value is empty', 'nothing', self) unless self != nil
+        raise AssertionFailure.new('empty value', 'nothing', self) unless self != nil
       end
 
       def or other
@@ -38,7 +38,7 @@ module Spectre
 
     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
+        raise AssertionFailure.new("Value is empty, but it should be '#{val.to_s.trim}'", val, nil) unless val == nil
       end
 
       def should_be_empty
@@ -52,7 +52,7 @@ module Spectre
       end
 
       def should_not_be_empty
-        raise AssertionFailure.new('The list is empty', 'nil')
+        raise AssertionFailure.new('Value is empty', 'nil')
       end
     end
 
@@ -66,21 +66,21 @@ module Spectre
       end
 
       def should_be_empty
-        raise AssertionFailure.new('The object should be empty', nil, self) unless self.empty?
+        raise AssertionFailure.new('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?
+        raise AssertionFailure.new('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?
+        raise AssertionFailure.new('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?
+        raise AssertionFailure.new('Object should not be empty', nil, self) if self.to_h.empty?
       end
     end
 
@@ -93,7 +93,7 @@ module Spectre
           val = OpenStruct.new(val)
         end
 
-        raise AssertionFailure.new("The list [#{list.join(', ').trim}] should contain '#{val.to_s.trim}'", val, list) unless list.include? val
+        raise AssertionFailure.new("[#{list.join(', ').trim}] should contain '#{val.to_s.trim}'", val, list) unless list.include? val
       end
 
       def should_not_contain(val)
@@ -104,37 +104,37 @@ module Spectre
           val = OpenStruct.new(val)
         end
 
-        raise AssertionFailure.new("The list [#{list.join(', ').trim}] should not contain '#{val.to_s.trim}'", val, list) if list.include? val
+        raise AssertionFailure.new("[#{list.join(', ').trim}] should not contain '#{val.to_s.trim}'", val, list) if list.include? val
       end
 
       def should_be_empty
-        raise AssertionFailure.new('The list is not empty', self) unless self.empty?
+        raise AssertionFailure.new('List is not empty', self) unless self.empty?
       end
 
       def should_not_be_empty
-        raise AssertionFailure.new('The list is empty', self) if self.empty?
+        raise AssertionFailure.new('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
+        raise AssertionFailure.new("'#{self.trim}' should be '#{val.to_s.trim}'", val, self) unless self == val
       end
 
       def should_be_empty
-        raise AssertionFailure.new("The text '#{self.trim}' should be empty", nil, self) unless self.empty?
+        raise AssertionFailure.new("'#{self.trim}' should be empty", nil, self) unless self.empty?
       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("'#{self.trim}' should not be '#{val.to_s.trim}'", val, self) unless self != val
       end
 
       def should_not_be_empty
-        raise AssertionFailure.new('The text should not be empty', 'nothing', self) unless not self.empty?
+        raise AssertionFailure.new('Text should not be empty', 'nothing', self) unless not self.empty?
       end
 
       def should_contain(value)
-        raise AssertionFailure.new("The value is nil") if value.nil?
+        raise AssertionFailure.new("Value is nil") if value.nil?
 
         predicate = proc { |x| self.include? x.to_s }
         evaluation = SingleEvaluation.new(value)
@@ -142,19 +142,19 @@ module Spectre
 
         return if success
 
-        raise AssertionFailure.new("The text '#{self.to_s.trim}' should contain #{evaluation.to_s}", evaluation, self)
+        raise AssertionFailure.new("'#{self.to_s.trim}' should contain #{evaluation.to_s}", evaluation, self)
       end
 
       def should_not_contain(val)
-        raise AssertionFailure.new("The text '#{self.trim}' should not contain '#{val.trim}'", val, self) if self.include? val
+        raise AssertionFailure.new("'#{self.trim}' should not contain '#{val.trim}'", val, self) if self.include? val
       end
 
       def should_match(regex)
-        raise AssertionFailure.new("The text '#{self.trim}' should match '#{val}'", regex, self) unless self.match(regex)
+        raise AssertionFailure.new("'#{self.trim}' should match '#{val}'", regex, self) unless self.match(regex)
       end
 
       def should_not_match(regex)
-        raise AssertionFailure.new("The text '#{self.trim}' should not match '#{val}'", regex, self) if self.match(regex)
+        raise AssertionFailure.new("'#{self.trim}' should not match '#{val}'", regex, self) if self.match(regex)
       end
 
       alias :| :or
@@ -194,10 +194,6 @@ module Spectre
     end
 
     class OrEvaluation < Evaluation
-      def initialize value, other
-        super(value, other)
-      end
-
       def call predicate
         eval_assertion(predicate, @value) or eval_assertion(predicate, @other)
       end
@@ -208,10 +204,6 @@ module Spectre
     end
 
     class AndEvaluation < Evaluation
-      def initialize value, other
-        super(value, other)
-      end
-
       def call predicate
         eval_assertion(predicate, @value) and eval_assertion(predicate, @other)
       end
@@ -236,18 +228,26 @@ module Spectre
       @@success = nil
 
       def expect desc
+        status = 'unknown'
+
         begin
-          Logger.log_process("expect #{desc}")
+          Logging.log_process("expect #{desc}")
           yield
-          Logger.log_status(desc, Logger::Status::OK)
+          Logging.log_status(desc, Logging::Status::OK)
+          status = 'ok'
         rescue Interrupt => e
+          status = 'skipped'
           raise e
         rescue AssertionFailure => e
-          Logger.log_status(desc, Logger::Status::FAILED)
+          Logging.log_status(desc, Logging::Status::FAILED)
+          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
+          Logging.log_status(desc, Logging::Status::ERROR)
+          status = 'error'
+          raise AssertionFailure.new("An unexpected error occurred during expectation: #{e.message}", nil, nil, desc), cause: e
+        ensure
+          Spectre::Runner.current.expectations.append([desc, status])
         end
       end
 
@@ -256,7 +256,7 @@ module Spectre
         prefix += " '#{desc}'" if desc
 
         begin
-          Logger.log_info(prefix) if desc
+          Logging.log_info(prefix) if desc
           yield
           @@success = true
           @@logger.info("#{prefix} finished with success")
@@ -281,7 +281,7 @@ module Spectre
     end
 
     Spectre.register do |config|
-      @@logger = ::Logger.new(config['log_file'], progname: 'spectre/assertion')
+      @@logger = Spectre::Logging::ModuleLogger.new(config, 'spectre/assertion')
       @@debug = config['debug']
     end
 

data/lib/spectre/async.rb

@@ -0,0 +1,31 @@
+require_relative '../spectre'
+
+Thread.abort_on_exception = true
+
+module Spectre
+  module Async
+    class << self
+      @@threads = {}
+
+      def async name='default', &block
+        unless @@threads.key? name
+          @@threads[name] = []
+        end
+
+        @@threads[name] << Thread.new(&block)
+      end
+
+      def await name='default'
+        return unless @@threads.key? name
+
+        threads = @@threads[name].map { |x| x.join() }
+
+        @@threads.delete(name)
+
+        threads.map { |x| x.value }
+      end
+    end
+
+    Spectre.delegate :async, :await, to: self
+  end
+end

data/lib/spectre/bag.rb

@@ -12,7 +12,7 @@ module Spectre
       end
     end
 
-    Spectre.register do |config|
+    Spectre.register do |_config|
       @@bag = OpenStruct.new
     end
 

data/lib/spectre/curl.rb

@@ -301,13 +301,16 @@ 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)
 
       start_time = Time.now
 
-      stdin, stdout, stderr, wait_thr = Open3.popen3(sys_cmd)
+      _, stdout, stderr, wait_thr = Open3.popen3(sys_cmd)
 
       end_time = Time.now
 
@@ -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
@@ -356,8 +359,8 @@ module Spectre::Curl
       end
 
       res_log = "[<] #{req_id} #{res[:code]} #{res[:message]} (#{end_time - start_time}s)\n"
-      res_headers.each do |header|
-        res_log += "#{header[0].to_s.ljust(30, '.')}: #{header[1].to_s}\n"
+      res_headers.each do |http_header|
+        res_log += "#{http_header[0].to_s.ljust(30, '.')}: #{http_header[1].to_s}\n"
       end
 
       if res[:body] != nil and not res[:body].empty?
@@ -377,11 +380,9 @@ module Spectre::Curl
   Spectre.register do |config|
     @@debug = config['debug']
 
-    @@logger = ::Logger.new(config['log_file'], progname: 'spectre/curl')
-    @@logger.level = @@debug ? Logger::DEBUG : Logger::INFO
+    @@logger = Spectre::Logging::ModuleLogger.new(config, 'spectre/curl')
 
     @@secure_keys = config['secure_keys'] || []
-
     @@curl_path = config['curl_path'] || 'curl'
 
     if config.key? 'http'

data/lib/spectre/helpers.rb

@@ -119,6 +119,10 @@ class ::Hash
 end
 
 class ::Array
+  def first_element
+    self[0]
+  end
+
   def last_element
     self[-1]
   end

data/lib/spectre/http/keystone.rb

@@ -42,8 +42,6 @@ module Spectre::Http
       net_req['X-Auth-Token'] = token
     end
 
-    private
-
     def self.authenticate keystone_url, username, password, project, domain, cert
       auth_data = {
         auth: {

data/lib/spectre/http.rb

@@ -27,9 +27,6 @@ module Spectre
     @@modules = []
 
     class HttpError < Exception
-      def initialize message
-        super message
-      end
     end
 
     class SpectreHttpRequest < Spectre::DslClass
@@ -112,6 +109,10 @@ module Spectre
         @__req['use_ssl'] = true
       end
 
+      def no_log!
+        @__req['no_log'] = true
+      end
+
       def to_s
         @__req.to_s
       end
@@ -230,6 +231,10 @@ module Spectre
           # do nothing
         end
 
+        if str.length > 1000
+          str = str[0...1000] + "\n[...]"
+        end
+
         str
       end
 
@@ -314,7 +319,14 @@ module Spectre
 
         req_log = "[>] #{req_id} #{req['method']} #{uri}\n"
         req_log += header_to_s(net_req)
-        req_log += try_format_json(req['body'], pretty: true) if req['body'] != nil and not req['body'].empty?
+
+        unless req['body'].nil? or req['body'].empty?
+          unless req['no_log']
+            req_log += try_format_json(req['body'], pretty: true)
+          else
+            req_log += '[...]'
+          end
+        end
 
         @@logger.info(req_log)
 
@@ -345,7 +357,14 @@ module Spectre
 
         res_log = "[<] #{req_id} #{net_res.code} #{net_res.message} (#{end_time - start_time}s)\n"
         res_log += header_to_s(net_res)
-        res_log += try_format_json(net_res.body, pretty: true) unless net_res.body.nil? or net_res.body.empty?
+
+        unless net_res.body.nil? or net_res.body.empty?
+          unless req['no_log']
+            res_log += try_format_json(net_res.body, pretty: true)
+          else
+            res_log += '[...]'
+          end
+        end
 
         @@logger.info(res_log)
 
@@ -361,7 +380,7 @@ module Spectre
     end
 
     Spectre.register do |config|
-      @@logger = ::Logger.new(config['log_file'], progname: 'spectre/http')
+      @@logger = Spectre::Logging::ModuleLogger.new(config, 'spectre/http')
       @@secure_keys = config['secure_keys'] || []
       @@debug = config['debug']
 

data/lib/spectre/logger/console.rb

@@ -1,7 +1,7 @@
 require 'ectoplasm'
 
 module Spectre
-  module Logger
+  module Logging
     class Console
       def initialize config
         raise 'No log format section in config for console logger' unless config.key? 'log_format' and config['log_format'].key? 'console'
@@ -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