spectre-core 1.11.0 → 1.12.0

data/lib/spectre/mixin.rb

@@ -1,34 +1,58 @@
-require 'ostruct'
-require 'spectre/logger'
-
-module Spectre
-  module Mixin
-    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::Logger.log_debug "running mixin '#{desc}'"
-
-        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 params
-        end
-      end
-
-      alias_method :also, :run
-      alias_method :step, :run
-    end
-
-    Spectre.delegate :mixin, :run, :also, :step, to: Mixin
-  end
-end
+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 = {}
+
+      def mixin desc, &block
+        @@mixins[desc] = block
+      end
+
+      def run desc, with: []
+        raise "no mixin with desc '#{desc}' defined" unless @@mixins.key? desc
+
+        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
+          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 +1,102 @@
-module Spectre::Reporter
-  class Console
-    def initialize config
-      @config = config
-    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|
-
-        spec = run_info.spec
-
-        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 += " during #{spec.context.__desc}" if spec.context.__desc
-
-          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 occured 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 = ''
-        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.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}\n"
-      str += "       line.....: #{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
+module Spectre::Reporter
+  class Console
+    def initialize config
+      @config = config
+    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|
+        spec = run_info.spec
+
+        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 += " during #{spec.context.__desc}" if spec.context.__desc
+
+          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 occured 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 = ''
+        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.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}\n"
+      str += "       line.....: #{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

data/lib/spectre/reporter/junit.rb

@@ -1,100 +1,100 @@
-# https://llg.cubic.org/docs/junit/
-# Azure mappings: https://docs.microsoft.com/en-us/azure/devops/pipelines/tasks/test/publish-test-results?view=azure-devops&tabs=junit%2Cyaml
-
-module Spectre::Reporter
-  class JUnit
-    def initialize config
-      @config = config
-    end
-
-    def report run_infos
-      now = Time.now.getutc
-      timestamp = now.strftime('%s')
-      datetime = now.strftime('%FT%T%:z')
-
-      xml_str = '<?xml version="1.0" encoding="UTF-8" ?>'
-      xml_str += '<testsuites>'
-
-      suite_id = 0
-
-      run_infos.group_by { |x| x.spec.subject }.each do |subject, run_infos|
-        failures = run_infos.select { |x| x.failure != nil }
-        errors = run_infos.select { |x| x.error != nil }
-        skipped = run_infos.select { |x| x.skipped? }
-
-        xml_str += '<testsuite package="' + subject.desc + '" id="' + suite_id.to_s + '" name="' + subject.desc + '" timestamp="' + datetime + '" tests="' + run_infos.count.to_s + '" failures="' + failures.count.to_s + '" errors="' + errors.count.to_s + '" skipped="' + skipped.count.to_s + '">'
-        suite_id += 1
-
-        run_infos.each do |run_info|
-          xml_str += '<testcase classname="' + run_info.spec.file.to_s + '" name="' + run_info.spec.desc + '" timestamp="' + run_info.started.to_s + '"  time="' + ('%.3f' % run_info.duration) + '">'
-
-          if run_info.failure and !run_info.failure.cause
-            failure_message = "Expected #{run_info.failure.expectation}"
-            failure_message += " with #{run_info.data}" if run_info.data
-
-            if run_info.failure.message
-              failure_message += " but it failed with #{run_info.failure.message}"
-            else
-              failure_message += " but it failed"
-            end
-
-            xml_str += '<failure message="' + failure_message.gsub('"', '`') + '"></failure>'
-          end
-
-
-          if run_info.error or (run_info.failure and run_info.failure.cause)
-            error = run_info.error || run_info.failure.cause
-
-            type = error.class.name
-            failure_message = error.message
-            text = error.backtrace.join "\n"
-
-            xml_str += '<error message="' + failure_message.gsub('"', '`') + '" type="' + type + '">'
-            xml_str += '<![CDATA[' + text + ']]>'
-            xml_str += '</error>'
-          end
-
-
-          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|
-                xml_str += "#{key}: #{val}\n"
-              end
-            end
-
-            if run_info.data
-              data_str = run_info.data
-              data_str = run_info.data.inspect unless run_info.data.is_a? String or run_info.data.is_a? Integer
-              xml_str += "data: #{data_str}\n"
-            end
-
-            if run_info.log.count > 0
-              messages = run_info.log.map { |x| "[#{x[0].strftime('%F %T')}] #{x[1]}" }
-              xml_str += messages.join("\n")
-            end
-
-            xml_str += ']]>'
-            xml_str += '</system-out>'
-          end
-
-          xml_str += '</testcase>'
-        end
-
-        xml_str += '</testsuite>'
-      end
-
-      xml_str += '</testsuites>'
-
-      Dir.mkdir @config['out_path'] if not Dir.exist? @config['out_path']
-
-      file_path = File.join(@config['out_path'], "spectre-junit_#{timestamp}.xml")
-
-      File.open(file_path, 'w') do |file|
-        file.write(xml_str)
-      end
-    end
-  end
-end
+# https://llg.cubic.org/docs/junit/
+# Azure mappings: https://docs.microsoft.com/en-us/azure/devops/pipelines/tasks/test/publish-test-results?view=azure-devops&tabs=junit%2Cyaml
+
+module Spectre::Reporter
+  class JUnit
+    def initialize config
+      @config = config
+    end
+
+    def report run_infos
+      now = Time.now.getutc
+      timestamp = now.strftime('%s')
+      datetime = now.strftime('%FT%T%:z')
+
+      xml_str = '<?xml version="1.0" encoding="UTF-8" ?>'
+      xml_str += '<testsuites>'
+
+      suite_id = 0
+
+      run_infos.group_by { |x| x.spec.subject }.each do |subject, run_infos|
+        failures = run_infos.select { |x| x.failure != nil }
+        errors = run_infos.select { |x| x.error != nil }
+        skipped = run_infos.select { |x| x.skipped? }
+
+        xml_str += '<testsuite package="' + subject.desc + '" id="' + suite_id.to_s + '" name="' + subject.desc + '" timestamp="' + datetime + '" tests="' + run_infos.count.to_s + '" failures="' + failures.count.to_s + '" errors="' + errors.count.to_s + '" skipped="' + skipped.count.to_s + '">'
+        suite_id += 1
+
+        run_infos.each do |run_info|
+          xml_str += '<testcase classname="' + run_info.spec.file.to_s + '" name="' + run_info.spec.desc + '" timestamp="' + run_info.started.to_s + '"  time="' + ('%.3f' % run_info.duration) + '">'
+
+          if run_info.failure and !run_info.failure.cause
+            failure_message = "Expected #{run_info.failure.expectation}"
+            failure_message += " with #{run_info.data}" if run_info.data
+
+            if run_info.failure.message
+              failure_message += " but it failed with #{run_info.failure.message}"
+            else
+              failure_message += " but it failed"
+            end
+
+            xml_str += '<failure message="' + failure_message.gsub('"', '`') + '"></failure>'
+          end
+
+
+          if run_info.error or (run_info.failure and run_info.failure.cause)
+            error = run_info.error || run_info.failure.cause
+
+            type = error.class.name
+            failure_message = error.message
+            text = error.backtrace.join "\n"
+
+            xml_str += '<error message="' + failure_message.gsub('"', '`') + '" type="' + type + '">'
+            xml_str += '<![CDATA[' + text + ']]>'
+            xml_str += '</error>'
+          end
+
+
+          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|
+                xml_str += "#{key}: #{val}\n"
+              end
+            end
+
+            if run_info.data
+              data_str = run_info.data
+              data_str = run_info.data.inspect unless run_info.data.is_a? String or run_info.data.is_a? Integer
+              xml_str += "data: #{data_str}\n"
+            end
+
+            if run_info.log.count > 0
+              messages = run_info.log.map { |x| "[#{x[0].strftime('%F %T')}] #{x[1]}" }
+              xml_str += messages.join("\n")
+            end
+
+            xml_str += ']]>'
+            xml_str += '</system-out>'
+          end
+
+          xml_str += '</testcase>'
+        end
+
+        xml_str += '</testsuite>'
+      end
+
+      xml_str += '</testsuites>'
+
+      Dir.mkdir @config['out_path'] unless Dir.exist? @config['out_path']
+
+      file_path = File.join(@config['out_path'], "spectre-junit_#{timestamp}.xml")
+
+      File.open(file_path, 'w') do |file|
+        file.write(xml_str)
+      end
+    end
+  end
+end

data/lib/spectre/resources.rb

@@ -1,46 +1,49 @@
-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" if not @items.key? name
-        @items[name]
-      end
-    end
-
-    class << self
-      @@resources = ResourceCollection.new
-
-      def resources
-        @@resources
-      end
-    end
-
-    Spectre.register do |config|
-      return if !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: Resources
-  end
-end
+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
+    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