spectre-core 1.15.2 → 2.0.1

data/lib/spectre/logging/file.rb

@@ -1,106 +0,0 @@
-module Spectre
-  module Logging
-    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 occurred at '#{file}:#{line}' while running spec '#{spec.name}': [#{exception.class}] #{exception.message}\n#{exception.backtrace.join "\n"}")
-      end
-
-      def log_skipped spec, message=nil
-        txt = "spec '#{spec.desc}' skipped"
-
-        unless message.nil?
-          txt += ': ' + message
-        end
-
-        @file_log.warn(txt)
-      end
-
-      def log_status desc, status, annotation=nil
-        msg = "expected #{desc}...#{status.upcase}"
-        msg += " - #{annotation}" if annotation
-        @file_log.debug(msg)
-      end
-    end
-
-    Spectre.register do |config|
-      Spectre::Logging.add File.new(config)
-    end
-  end
-end

data/lib/spectre/logging.rb

@@ -1,183 +0,0 @@
-require_relative '../spectre'
-require 'date'
-require 'logger'
-
-module Spectre
-  module Logging
-    module Status
-      OK = '[ok]'
-      FAILED = '[failed]'
-      ERROR = '[error]'
-      INFO = '[info]'
-      SKIPPED = '[skipped]'
-      DEBUG = '[debug]'
-    end
-
-    class ModuleLogger
-      attr_reader :logger
-
-      def initialize config, name
-        @name = name
-        @debug = config['debug']
-        @logger = ::Logger.new(config['log_file'], progname: name)
-
-        @logger.level = @debug ? ::Logger::DEBUG : ::Logger::INFO
-      end
-
-      def info message
-        @logger.info(message)
-        Spectre::Logging.add_log(message, :info, @name)
-      end
-
-      def debug message
-        return unless @debug
-
-        @logger.debug(message)
-        Spectre::Logging.add_log(message, :debug, @name)
-      end
-
-      def warn message
-        @logger.warn(message)
-        Spectre::Logging.add_log(message, :warn, @name)
-      end
-
-      def error message
-        @logger.error(message)
-        Spectre::Logging.add_log(message, :error, @name)
-      end
-    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, :info)
-        delegate(:log_info, message)
-      end
-
-      def log_debug message
-        return unless @@debug
-
-        add_log(message, :debug)
-        delegate(:log_debug, message)
-      end
-
-      def log_error spec, exception
-        add_log(exception, :error)
-        delegate(:log_error, spec, exception)
-      end
-
-      def log_skipped spec, message=nil
-        delegate(:log_skipped, spec, message)
-      end
-
-      def log_status desc, status, annotation=nil
-        delegate(:log_status, desc, status, annotation)
-      end
-
-      def group desc
-        Spectre::Logging.start_group(desc)
-        yield
-        Spectre::Logging.end_group(desc)
-      end
-
-      def add_log message, level, logger_name='spectre'
-        return unless Spectre::Runner.current
-
-        Spectre::Runner.current.log.append([DateTime.now, message, level, logger_name])
-      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
-    end
-
-    Spectre.delegate(:log, :info, :debug, :group, :separate, to: self)
-  end
-end

data/lib/spectre/mixin.rb

@@ -1,61 +0,0 @@
-require_relative '../spectre'
-require_relative 'logging'
-
-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::Logging.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::Logging.log_debug("optional parameters for '#{@__desc}': #{keys.join ', '}")
-        params
-      end
-    end
-
-    class << self
-      @@mixins = {}
-
-      def mixin desc, &block
-        @@mixins[desc] = block
-      end
-
-      def run desc, with: []
-        raise "no mixin with desc '#{desc}' defined" unless @@mixins.key? desc
-
-        Spectre::Logging.log_debug "running mixin '#{desc}'"
-
-        params = with || {}
-        if params.empty?
-          params = {}
-        end
-
-        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
-          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.delegate :mixin, :run, :also, :step, to: self
-  end
-end

data/lib/spectre/reporter/console.rb

@@ -1,104 +0,0 @@
-require_relative '../reporter'
-
-module Spectre::Reporter
-  class Console
-    def initialize config
-      @debug = config['debug']
-    end
-
-    def report run_infos
-      report_str = ''
-
-      errors = 0
-      failures = 0
-      skipped = run_infos.select { |x| x.skipped? }.count
-
-      run_infos
-        .select { |x| x.error != nil or x.failure != nil }
-        .each_with_index do |run_info, index|
-          report_str += "\n#{index+1}) #{format_title(run_info)}\n"
-
-          if run_info.failure
-            report_str += "     Expected #{run_info.failure.expectation}"
-            report_str += " with #{run_info.data}" if run_info.data
-
-            report_str += " but it failed"
-
-            if run_info.failure.cause
-              report_str += "\n     with an unexpected error:\n"
-              report_str += format_exception(run_info.failure.cause)
-
-            elsif run_info.failure.message and not run_info.failure.message.empty?
-              report_str += " with:\n     #{run_info.failure.message}"
-
-            else
-              report_str += '.'
-            end
-
-            report_str += "\n"
-            failures += 1
-
-          else
-            report_str += "     but an unexpected error occurred during run\n"
-            report_str += format_exception(run_info.error)
-            errors += 1
-          end
-        end
-
-      if failures + errors > 0
-        summary = ''
-        summary += "#{run_infos.length - failures - errors - skipped} succeeded "
-        summary += "#{failures} failures " if failures > 0
-        summary += "#{errors} errors " if errors > 0
-        summary += "#{skipped} skipped " if skipped > 0
-        summary += "#{run_infos.length} total"
-        print "\n#{summary}\n".red
-      else
-        summary = "\nRun finished successfully"
-        summary += " (#{skipped} skipped)" if skipped > 0
-        print "#{summary}\n".green
-      end
-
-      puts report_str.red
-    end
-
-    private
-
-    def format_title run_info
-      title = run_info.spec.subject.desc
-      title += " #{run_info.spec.context.__desc}" if run_info.spec.context.__desc
-      title += ' ' + run_info.spec.desc
-      title += " (#{'%.3f' % run_info.duration}s)"
-      title += " [#{run_info.spec.name}]"
-      title
-    end
-
-    def format_exception error
-      non_spectre_files = error.backtrace.select { |x| !x.include? 'lib/spectre' }
-
-      if non_spectre_files.count > 0
-        causing_file = non_spectre_files.first
-      else
-        causing_file = error.backtrace[0]
-      end
-
-      matches = causing_file.match(/(.*\.rb):(\d+)/)
-
-      return '' unless matches
-
-      file, line = matches.captures
-      file.slice!(Dir.pwd + '/')
-
-      str = ''
-      str += "       file.....: #{file}:#{line}\n"
-      str += "       type.....: #{error.class}\n"
-      str += "       message..: #{error.message}\n"
-      str += "       backtrace: \n         #{error.backtrace.join("\n         ")}\n" if @debug
-      str
-    end
-
-    Spectre.register do |config|
-      Spectre::Reporter.add Console.new(config)
-    end
-  end
-end

data/lib/spectre/reporter.rb

@@ -1,17 +0,0 @@
-module Spectre
-  module Reporter
-    @@reporters = []
-
-    def self.add reporter
-      raise NotImplementedError.new("#{reporter} does not implement `report' method") unless reporter.respond_to? :report
-
-      @@reporters.append(reporter)
-    end
-
-    def self.report run_infos
-      @@reporters.each do |reporter|
-        reporter.report(run_infos)
-      end
-    end
-  end
-end

data/lib/spectre/resources.rb

@@ -1,53 +0,0 @@
-require_relative '../spectre'
-
-require 'ostruct'
-
-module Spectre
-  module Resources
-    class ResourceCollection
-      def initialize
-        @items = {}
-      end
-
-      def add name, path
-        @items[name] = path
-      end
-
-      def [] name
-        raise "Resource with name '#{name}' does not exist" unless @items.key? name
-
-        @items[name]
-      end
-
-      def key? name
-        @items.key? name
-      end
-    end
-
-    class << self
-      @@resources = ResourceCollection.new
-
-      def resources
-        @@resources
-      end
-    end
-
-    Spectre.register do |config|
-      return unless config.key? 'resource_paths'
-
-      config['resource_paths'].each do |resource_path|
-        resource_files = Dir.glob File.join(resource_path, '**/*')
-
-        resource_files.each do |file|
-          file.slice! resource_path
-          file = file[1..-1]
-          @@resources.add file, File.expand_path(File.join resource_path, file)
-        end
-      end
-
-      @@resources.freeze
-    end
-
-    Spectre.delegate :resources, to: self
-  end
-end