spectre-core 1.10.0 → 1.12.2

data/lib/spectre/logger/console.rb

@@ -24,12 +24,14 @@ module Spectre
 
       def start_context context
         return unless context.__desc
+
         puts (' ' * indent) + context.__desc.magenta
         @level += 1
       end
 
       def end_context context
         return unless context.__desc
+
         @level -= 1
         puts (' ' * indent) + @fmt_end_context.gsub('<desc>', context.__desc).magenta if @fmt_end_context
       end
@@ -42,7 +44,7 @@ module Spectre
         @level += 1
       end
 
-      def end_spec spec, data
+      def end_spec _spec, _data
         @level -= 1
       end
 
@@ -76,7 +78,7 @@ module Spectre
         @level += 1
       end
 
-      def log_status desc, status, annotation=nil
+      def log_status _desc, status, annotation=nil
         status = status.green if status == Status::OK
         status = status.blue if status == Status::INFO
         status = status.grey if status == Status::DEBUG
@@ -106,12 +108,12 @@ module Spectre
         print_line(message, Status::DEBUG.grey)
       end
 
-      def log_error spec, exception
+      def log_error _spec, exception
         txt = (Status::ERROR + ' - ' + exception.class.name).red
         print_line('', txt)
       end
 
-      def log_skipped spec
+      def log_skipped _spec
         print_line('', Status::SKIPPED.grey)
       end
 
@@ -136,7 +138,6 @@ module Spectre
           @process = nil
         end
       end
-
     end
   end
-end
+end

data/lib/spectre/logger/file.rb

@@ -1,96 +1,96 @@
-module Spectre
-  module Logger
-    class File
-      def initialize config
-        raise 'No log format section in config for console logger' unless config.key? 'log_format' and config['log_format'].key? 'file'
-
-        @config = config['log_format']['file']
-        @fmt_start_group = @config['start_group']
-        @fmt_end_group = @config['end_group']
-        @fmt_sep = @config['separator']
-
-        @file_log = ::Logger.new config['log_file'], progname: 'spectre'
-        @file_log.level = config['debug'] ? 'DEBUG' : 'INFO'
-      end
-
-      def start_subject subject
-        @file_log.debug "start running subject '#{subject.desc}'"
-      end
-
-      def end_subject subject
-        @file_log.debug "subject '#{subject.desc}' finished"
-      end
-
-      def start_context context
-        if context and context.__desc
-          @file_log.debug "start running context '#{context.__desc}'"
-        else
-          @file_log.debug "start running main context of #{context.__subject.desc}"
-        end
-      end
-
-      def end_context context
-        if context and context.__desc
-          @file_log.debug "context '#{context.__desc}' finished"
-        else
-          @file_log.debug "main context finished of #{context.__subject.desc}"
-        end
-      end
-
-      def start_spec spec, data=nil
-        log_msg = "start running spec [#{spec.name}] '#{spec.desc}'"
-        log_msg += " with data #{data}" if data
-        @file_log.debug log_msg
-      end
-
-      def end_spec spec, data=nil
-        log_msg = "running spec [#{spec.name}] '#{spec.desc}'"
-        log_msg += " with data #{data}" if data
-        log_msg += " finished"
-        @file_log.debug log_msg
-      end
-
-      def log_separator desc
-        desc = @fmt_sep.gsub('<desc>', desc) if @fmt_sep
-        @file_log.info desc
-      end
-
-      def start_group desc
-        desc = @fmt_start_group.gsub('<desc>', desc) if @fmt_start_group
-        @file_log.info desc
-      end
-
-      def end_group desc
-        desc = @fmt_end_group.gsub('<desc>', desc) if @fmt_end_group
-        @file_log.info desc
-      end
-
-      def log_process desc
-        @file_log.debug desc
-      end
-
-      def log_info message
-        @file_log.info "#{Status::INFO} #{message}"
-      end
-
-      def log_debug message
-        @file_log.debug "#{Status::DEBUG} #{message}"
-      end
-
-      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"}"
-      end
-
-      def log_skipped spec
-        @file_log.warn "spec '#{spec.desc}' canceled by user"
-      end
-
-      def log_status desc, status, annotation=nil
-        msg = "expected #{desc}...#{status.upcase}"
-        msg += " - #{annotation}" if annotation
-        @file_log.debug msg
-      end
-    end
-  end
-end
+module Spectre
+  module Logger
+    class File
+      def initialize config
+        raise 'No log format section in config for console logger' unless config.key? 'log_format' and config['log_format'].key? 'file'
+
+        @config = config['log_format']['file']
+        @fmt_start_group = @config['start_group']
+        @fmt_end_group = @config['end_group']
+        @fmt_sep = @config['separator']
+
+        @file_log = ::Logger.new config['log_file'], progname: 'spectre'
+        @file_log.level = config['debug'] ? 'DEBUG' : 'INFO'
+      end
+
+      def start_subject subject
+        @file_log.debug "start running subject '#{subject.desc}'"
+      end
+
+      def end_subject subject
+        @file_log.debug "subject '#{subject.desc}' finished"
+      end
+
+      def start_context context
+        if context and context.__desc
+          @file_log.debug "start running context '#{context.__desc}'"
+        else
+          @file_log.debug "start running main context of #{context.__subject.desc}"
+        end
+      end
+
+      def end_context context
+        if context and context.__desc
+          @file_log.debug "context '#{context.__desc}' finished"
+        else
+          @file_log.debug "main context finished of #{context.__subject.desc}"
+        end
+      end
+
+      def start_spec spec, data=nil
+        log_msg = "start running spec [#{spec.name}] '#{spec.desc}'"
+        log_msg += " with data #{data}" if data
+        @file_log.debug log_msg
+      end
+
+      def end_spec spec, data=nil
+        log_msg = "running spec [#{spec.name}] '#{spec.desc}'"
+        log_msg += " with data #{data}" if data
+        log_msg += " finished"
+        @file_log.debug log_msg
+      end
+
+      def log_separator desc
+        desc = @fmt_sep.gsub('<desc>', desc) if @fmt_sep
+        @file_log.info desc
+      end
+
+      def start_group desc
+        desc = @fmt_start_group.gsub('<desc>', desc) if @fmt_start_group
+        @file_log.info desc
+      end
+
+      def end_group desc
+        desc = @fmt_end_group.gsub('<desc>', desc) if @fmt_end_group
+        @file_log.info desc
+      end
+
+      def log_process desc
+        @file_log.debug desc
+      end
+
+      def log_info message
+        @file_log.info "#{Status::INFO} #{message}"
+      end
+
+      def log_debug message
+        @file_log.debug "#{Status::DEBUG} #{message}"
+      end
+
+      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"}"
+      end
+
+      def log_skipped spec
+        @file_log.warn "spec '#{spec.desc}' canceled by user"
+      end
+
+      def log_status desc, status, annotation=nil
+        msg = "expected #{desc}...#{status.upcase}"
+        msg += " - #{annotation}" if annotation
+        @file_log.debug msg
+      end
+    end
+  end
+end

data/lib/spectre/logger.rb

@@ -1,144 +1,146 @@
-require 'date'
-
-module Spectre
-  module Logger
-    module Status
-      OK = '[ok]'
-      FAILED = '[failed]'
-      ERROR = '[error]'
-      INFO = '[info]'
-      SKIPPED = '[skipped]'
-      DEBUG = '[debug]'
-    end
-
-    class << self
-      @@debug = false
-      @@logger = []
-
-      def debug!
-        @@debug = true
-      end
-
-      def debug?
-        @@debug
-      end
-
-      def add logger
-        @@logger.append logger
-      end
-
-      def start_subject subject
-        delegate(:start_subject, subject)
-      end
-
-      def end_subject subject
-        delegate(:end_subject, subject)
-      end
-
-      def start_context context
-        delegate(:start_context, context)
-      end
-
-      def end_context context
-        delegate(:end_context, context)
-      end
-
-      def start_spec spec, data=nil
-        delegate(:start_spec, spec, data)
-      end
-
-      def end_spec spec, data=nil
-        delegate(:end_spec, spec, data)
-      end
-
-      def log_subject subject
-        begin
-          start_subject(subject)
-          yield
-        ensure
-          end_subject(subject)
-        end
-      end
-
-      def log_context context
-        begin
-          start_context(context)
-          yield
-        ensure
-          end_context(context)
-        end
-      end
-
-      def log_spec spec, data=nil
-        start_spec(spec, data)
-        yield
-        end_spec(spec, data)
-      end
-
-      def log_separator desc
-        delegate(:log_separator, desc)
-      end
-
-      def start_group desc
-        delegate(:start_group, desc)
-      end
-
-      def end_group desc
-        delegate(:end_group, desc)
-      end
-
-      def log_process desc
-        delegate(:log_process, desc)
-      end
-
-      def log_info message
-        add_log(message)
-        delegate(:log_info, message)
-      end
-
-      def log_debug message
-        return unless @@debug
-        add_log(message)
-        delegate(:log_debug, message)
-      end
-
-      def log_error spec, exception
-        add_log(exception)
-        delegate(:log_error, spec, exception)
-      end
-
-      def log_skipped spec
-        delegate(:log_skipped, spec)
-      end
-
-      def log_status desc, status, annotation=nil
-        delegate(:log_status, desc, status, annotation)
-      end
-
-      def group desc
-        Logger.start_group desc
-        yield
-        Logger.end_group desc
-      end
-
-      alias_method :info, :log_info
-      alias_method :log, :log_info
-      alias_method :debug, :log_debug
-      alias_method :separate, :log_separator
-
-      private
-
-      def delegate method, *args
-        @@logger.each do |logger|
-          logger.send(method, *args) if logger.respond_to? method
-        end
-      end
-
-      def add_log message
-        Spectre::Runner.current.log.append([DateTime.now, message])
-      end
-    end
-
-    Spectre.delegate :log, :info, :debug, :group, :separate, to: self
-  end
-end
+require_relative '../spectre'
+require 'date'
+
+module Spectre
+  module Logger
+    module Status
+      OK = '[ok]'
+      FAILED = '[failed]'
+      ERROR = '[error]'
+      INFO = '[info]'
+      SKIPPED = '[skipped]'
+      DEBUG = '[debug]'
+    end
+
+    class << self
+      @@debug = false
+      @@logger = []
+
+      def debug!
+        @@debug = true
+      end
+
+      def debug?
+        @@debug
+      end
+
+      def add logger
+        @@logger.append logger
+      end
+
+      def start_subject subject
+        delegate(:start_subject, subject)
+      end
+
+      def end_subject subject
+        delegate(:end_subject, subject)
+      end
+
+      def start_context context
+        delegate(:start_context, context)
+      end
+
+      def end_context context
+        delegate(:end_context, context)
+      end
+
+      def start_spec spec, data=nil
+        delegate(:start_spec, spec, data)
+      end
+
+      def end_spec spec, data=nil
+        delegate(:end_spec, spec, data)
+      end
+
+      def log_subject subject
+        begin
+          start_subject(subject)
+          yield
+        ensure
+          end_subject(subject)
+        end
+      end
+
+      def log_context context
+        begin
+          start_context(context)
+          yield
+        ensure
+          end_context(context)
+        end
+      end
+
+      def log_spec spec, data=nil
+        start_spec(spec, data)
+        yield
+        end_spec(spec, data)
+      end
+
+      def log_separator desc
+        delegate(:log_separator, desc)
+      end
+
+      def start_group desc
+        delegate(:start_group, desc)
+      end
+
+      def end_group desc
+        delegate(:end_group, desc)
+      end
+
+      def log_process desc
+        delegate(:log_process, desc)
+      end
+
+      def log_info message
+        add_log(message)
+        delegate(:log_info, message)
+      end
+
+      def log_debug message
+        return unless @@debug
+
+        add_log(message)
+        delegate(:log_debug, message)
+      end
+
+      def log_error spec, exception
+        add_log(exception)
+        delegate(:log_error, spec, exception)
+      end
+
+      def log_skipped spec
+        delegate(:log_skipped, spec)
+      end
+
+      def log_status desc, status, annotation=nil
+        delegate(:log_status, desc, status, annotation)
+      end
+
+      def group desc
+        Logger.start_group desc
+        yield
+        Logger.end_group desc
+      end
+
+      alias_method :info, :log_info
+      alias_method :log, :log_info
+      alias_method :debug, :log_debug
+      alias_method :separate, :log_separator
+
+      private
+
+      def delegate method, *args
+        @@logger.each do |logger|
+          logger.send(method, *args) if logger.respond_to? method
+        end
+      end
+
+      def add_log message
+        Spectre::Runner.current.log.append([DateTime.now, message])
+      end
+    end
+
+    Spectre.delegate :log, :info, :debug, :group, :separate, to: self
+  end
+end

data/lib/spectre/mixin.rb

@@ -1,7 +1,27 @@
+require_relative '../spectre'
+require_relative 'logger'
+
 require 'ostruct'
 
 module Spectre
   module Mixin
+    class MixinContext < Spectre::DslClass
+      def initialize desc
+        @__desc = desc
+      end
+
+      def required params, *keys
+        missing_keys = keys.select { |x| !params.to_h.key? x }
+        Spectre::Logger.log_debug("required parameters for '#{@__desc}': #{keys.join ', '}")
+        raise ArgumentError, "mixin '#{@__desc}' requires #{keys.join ', '}, but only has #{missing_keys.join ', '} given" unless missing_keys.empty?
+      end
+
+      def optional params, *keys
+        Spectre::Logger.log_debug("optional parameters for '#{@__desc}': #{keys.join ', '}")
+        params
+      end
+    end
+
     class << self
       @@mixins = {}
 
@@ -11,31 +31,28 @@ module Spectre
 
       def run desc, with: []
         raise "no mixin with desc '#{desc}' defined" unless @@mixins.key? desc
-        Logger.log_debug "running mixin '#{desc}'"
 
-        if with.is_a? Array
-          @@mixins[desc].call *with
+        Spectre::Logger.log_debug "running mixin '#{desc}'"
+
+        params = with || {}
+
+        ctx = MixinContext.new(desc)
+
+        if params.is_a? Array
+          return_val = ctx._execute(*params, &@@mixins[desc])
+        elsif params.is_a? Hash
+          return_val = ctx._execute(OpenStruct.new(params), &@@mixins[desc])
         else
-          @@mixins[desc].call with
+          return_val = ctx._execute(params, &@@mixins[desc])
         end
+
+        return_val.is_a?(Hash) ? OpenStruct.new(return_val) : return_val
       end
 
       alias_method :also, :run
       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
+    Spectre.delegate :mixin, :run, :also, :step, to: self
   end
-end
+end

data/lib/spectre/reporter/console.rb

@@ -5,7 +5,6 @@ module Spectre::Reporter
     end
 
     def report run_infos
-
       report_str = ''
 
       errors = 0
@@ -15,7 +14,6 @@ module Spectre::Reporter
       run_infos
         .select { |x| x.error != nil or x.failure != nil }
         .each_with_index do |run_info, index|
-
         spec = run_info.spec
 
         report_str += "\n#{index+1}) #{format_title(run_info)}\n"
@@ -93,12 +91,11 @@ module Spectre::Reporter
       file.slice!(Dir.pwd + '/')
 
       str = ''
-      str += "       file.....: #{file}\n"
-      str += "       line.....: #{line}\n"
+      str += "       file.....: #{file}:#{line}\n"
       str += "       type.....: #{error.class}\n"
       str += "       message..: #{error.message}\n"
       str += "       backtrace: \n         #{error.backtrace.join("\n         ")}\n" if @config['debug']
       str
     end
   end
-end
+end

data/lib/spectre/reporter/junit.rb

@@ -57,8 +57,9 @@ 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
+            if run_info.properties.count > 0
               run_info.properties.each do |key, val|
                 xml_str += "#{key}: #{val}\n"
               end
@@ -75,6 +76,7 @@ module Spectre::Reporter
               xml_str += messages.join("\n")
             end
 
+            xml_str += ']]>'
             xml_str += '</system-out>'
           end
 
@@ -86,7 +88,7 @@ module Spectre::Reporter
 
       xml_str += '</testsuites>'
 
-      Dir.mkdir @config['out_path'] if not Dir.exist? @config['out_path']
+      Dir.mkdir @config['out_path'] unless Dir.exist? @config['out_path']
 
       file_path = File.join(@config['out_path'], "spectre-junit_#{timestamp}.xml")
 
@@ -95,4 +97,4 @@ module Spectre::Reporter
       end
     end
   end
-end
+end