stopdropandrew_ci_reporter 1.7.0.1

data/lib/ci/reporter/minitest.rb

@@ -0,0 +1,224 @@
+# Copyright (c) 2012 Alexander Shcherbinin <alexander.shcherbinin@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+require 'ci/reporter/core'
+
+require 'minitest/unit'
+
+module CI
+  module Reporter
+    class Failure
+      def self.new(fault, type = nil, meth = nil)
+        return MiniTestSkipped.new(fault) if type == :skip
+        return MiniTestFailure.new(fault, meth) if type == :failure
+        MiniTestError.new(fault)
+      end
+    end
+
+    class FailureCore
+      def location(e)
+        last_before_assertion = ""
+        e.backtrace.reverse_each do |s|
+          break if s =~ /in .(assert|refute|flunk|pass|fail|raise|must|wont)/
+          last_before_assertion = s
+        end
+        last_before_assertion.sub(/:in .*$/, '')
+      end
+    end
+
+    class MiniTestSkipped < FailureCore
+      def initialize(fault) @fault = fault end
+      def failure?() false end
+      def error?() false end
+      def name() @fault.class.name end
+      def message() @fault.message end
+      def location() super @fault end
+    end
+
+    class MiniTestFailure < FailureCore
+      def initialize(fault, meth) @fault = fault; @meth = meth end
+      def failure?() true end
+      def error?() false end
+      def name() @meth end
+      def message() @fault.message end
+      def location() super @fault end
+    end
+
+    class MiniTestError < FailureCore
+      def initialize(fault) @fault = fault end
+      def failure?() false end
+      def error?() true end
+      def name() @fault.exception.class.name end
+      def message() @fault.exception.message end
+      def location() @fault.exception.backtrace.join("\n") end
+    end
+
+    class Runner < MiniTest::Unit
+
+      @@out = $stdout
+
+      def initialize
+        super
+        @report_manager = ReportManager.new("test")
+      end
+
+      def _run_anything(type)
+        suites = MiniTest::Unit::TestCase.send "#{type}_suites"
+        return if suites.empty?
+
+        started_anything type
+
+        sync = output.respond_to? :"sync=" # stupid emacs
+        old_sync, output.sync = output.sync, true if sync
+
+        _run_suites(suites, type)
+
+        output.sync = old_sync if sync
+
+        finished_anything(type)
+      end
+
+      def _run_suites(suites, type)
+        suites.map { |suite| _run_suite suite, type }
+      end
+
+      def _run_suite(suite, type)
+        start_suite(suite)
+
+        header = "#{type}_suite_header"
+        puts send(header, suite) if respond_to? header
+
+        filter_suite_methods(suite, type).each do |method|
+          _run_test(suite, method)
+        end
+
+        finish_suite
+      end
+
+      def _run_test(suite, method)
+        start_case(method)
+
+        result = run_test(suite, method)
+
+        @assertion_count += result._assertions
+        @test_count += 1
+
+        finish_case
+      end
+
+      def puke(klass, meth, e)
+        e = case e
+            when MiniTest::Skip then
+              @skips += 1
+              fault(e, :skip)
+              return "S" unless @verbose
+              "Skipped:\n#{meth}(#{klass}) [#{location e}]:\n#{e.message}\n"
+            when MiniTest::Assertion then
+              @failures += 1
+              fault(e, :failure, meth)
+              "Failure:\n#{meth}(#{klass}) [#{location e}]:\n#{e.message}\n"
+            else
+              @errors += 1
+              fault(e, :error)
+              bt = MiniTest::filter_backtrace(e.backtrace).join "\n    "
+              "Error:\n#{meth}(#{klass}):\n#{e.class}: #{e.message}\n    #{bt}\n"
+            end
+        @report << e
+        e[0, 1]
+      end
+
+      private
+
+      def started_anything(type)
+        @test_count = 0
+        @assertion_count = 0
+        @last_assertion_count = 0
+        @result_assertion_count = 0
+        @start = Time.now
+
+        puts
+        puts "# Running #{type}s:"
+        puts
+      end
+
+      def finished_anything(type)
+        t = Time.now - @start
+        puts
+        puts
+        puts "Finished #{type}s in %.6fs, %.4f tests/s, %.4f assertions/s." %
+          [t, @test_count / t, @assertion_count / t]
+
+        report.each_with_index do |msg, i|
+          puts "\n%3d) %s" % [i + 1, msg]
+        end
+
+        puts
+
+        status
+      end
+
+      def filter_suite_methods(suite, type)
+        filter = options[:filter] || '/./'
+        filter = Regexp.new $1 if filter =~ /\/(.*)\//
+
+        suite.send("#{type}_methods").grep(filter)
+      end
+
+      def run_test(suite, method)
+        inst = suite.new method
+        inst._assertions = 0
+
+        print "#{suite}##{method} = " if @verbose
+
+        @start_time = Time.now
+        result = inst.run self
+        time = Time.now - @start_time
+
+        print "%.2f s = " % time if @verbose
+        print result
+        puts if @verbose
+
+        return inst
+      end
+
+      def start_suite(suite_name)
+        @current_suite = CI::Reporter::TestSuite.new(suite_name)
+        @current_suite.start
+      end
+
+      def finish_suite
+        if @current_suite
+          @current_suite.finish
+          @current_suite.assertions = @assertion_count - @last_assertion_count
+          @last_assertion_count = @assertion_count
+          @report_manager.write_report(@current_suite)
+        end
+      end
+
+      def start_case(test_name)
+        tc = CI::Reporter::TestCase.new(test_name)
+        tc.start
+        @current_suite.testcases << tc
+      end
+
+      def finish_case
+        tc = @current_suite.testcases.last
+        tc.finish
+        tc.assertions = @assertion_count - @result_assertion_count
+        @result_assertion_count = @assertion_count
+      end
+
+      def fault(fault, type = nil, meth = nil)
+        tc = @current_suite.testcases.last
+        if :skip == type
+          tc.skipped = true
+        else
+          tc.failures << Failure.new(fault, type, meth)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/ci/reporter/rake/cucumber.rb

@@ -0,0 +1,19 @@
+# Copyright (c) 2006-2012 Nick Sieger <nicksieger@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+require File.expand_path('../utils', __FILE__)
+
+namespace :ci do
+  namespace :setup do
+    task :cucumber_report_cleanup do
+      rm_rf ENV["CI_REPORTS"] || "features/reports"
+    end
+
+    task :cucumber => :cucumber_report_cleanup do
+      cuke_opts = ["--require", CI::Reporter.maybe_quote_filename("#{File.dirname(__FILE__)}/cucumber_loader.rb"),
+        "--format", "CI::Reporter::Cucumber"].join(" ")
+      ENV["CUCUMBER_OPTS"] = "#{ENV['CUCUMBER_OPTS']} #{cuke_opts}"
+    end
+  end
+end

data/lib/ci/reporter/rake/cucumber_loader.rb

@@ -0,0 +1,6 @@
+# Copyright (c) 2006-2012 Nick Sieger <nicksieger@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+$: << File.dirname(__FILE__) + "/../../.."
+require 'ci/reporter/cucumber'

data/lib/ci/reporter/rake/minitest.rb

@@ -0,0 +1,15 @@
+# Copyright (c) 2012 Alexander Shcherbinin <alexander.shcherbinin@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+require File.expand_path('../utils', __FILE__)
+
+namespace :ci do
+  namespace :setup do
+    task :minitest do
+      rm_rf ENV["CI_REPORTS"] || "test/reports"
+      test_loader = CI::Reporter.maybe_quote_filename "#{File.dirname(__FILE__)}/minitest_loader.rb"
+      ENV["TESTOPTS"] = "#{ENV["TESTOPTS"]} #{test_loader}"
+    end
+  end
+end

data/lib/ci/reporter/rake/minitest_loader.rb

@@ -0,0 +1,9 @@
+# Copyright (c) 2012 Alexander Shcherbinin <alexander.shcherbinin@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+$: << File.dirname(__FILE__) + "/../../.."
+require 'ci/reporter/minitest'
+
+# set defaults
+MiniTest::Unit.runner = CI::Reporter::Runner.new

data/lib/ci/reporter/rake/rspec.rb

@@ -0,0 +1,31 @@
+# Copyright (c) 2006-2012 Nick Sieger <nicksieger@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+require File.expand_path('../utils', __FILE__)
+
+namespace :ci do
+  namespace :setup do
+    task :spec_report_cleanup do
+      rm_rf ENV["CI_REPORTS"] || "spec/reports"
+    end
+
+    task :rspec => :spec_report_cleanup do
+      spec_opts = ["--require", CI::Reporter.maybe_quote_filename("#{File.dirname(__FILE__)}/rspec_loader.rb"),
+        "--format", "CI::Reporter::RSpec"].join(" ")
+      ENV["SPEC_OPTS"] = "#{ENV['SPEC_OPTS']} #{spec_opts}"
+    end
+
+    task :rspecdoc => :spec_report_cleanup do
+      spec_opts = ["--require", CI::Reporter.maybe_quote_filename("#{File.dirname(__FILE__)}/rspec_loader.rb"),
+        "--format", "CI::Reporter::RSpecDoc"].join(" ")
+      ENV["SPEC_OPTS"] = "#{ENV['SPEC_OPTS']} #{spec_opts}"
+    end
+
+    task :rspecbase => :spec_report_cleanup do
+      spec_opts = ["--require", CI::Reporter.maybe_quote_filename("#{File.dirname(__FILE__)}/rspec_loader.rb"),
+        "--format", "CI::Reporter::RSpecBase"].join(" ")
+      ENV["SPEC_OPTS"] = "#{ENV['SPEC_OPTS']} #{spec_opts}"
+    end
+  end
+end

data/lib/ci/reporter/rake/rspec_loader.rb

@@ -0,0 +1,6 @@
+# Copyright (c) 2006-2012 Nick Sieger <nicksieger@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+$: << File.dirname(__FILE__) + "/../../.."
+require 'ci/reporter/rspec'

data/lib/ci/reporter/rake/test_unit.rb

@@ -0,0 +1,15 @@
+# Copyright (c) 2006-2012 Nick Sieger <nicksieger@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+require File.expand_path('../utils', __FILE__)
+
+namespace :ci do
+  namespace :setup do
+    task :testunit do
+      rm_rf ENV["CI_REPORTS"] || "test/reports"
+      test_loader = CI::Reporter.maybe_quote_filename "#{File.dirname(__FILE__)}/test_unit_loader.rb"
+      ENV["TESTOPTS"] = "#{ENV["TESTOPTS"]} #{test_loader}"
+    end
+  end
+end

data/lib/ci/reporter/rake/test_unit_loader.rb

@@ -0,0 +1,36 @@
+# Copyright (c) 2006-2012 Nick Sieger <nicksieger@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+$: << File.dirname(__FILE__) + "/../../.."
+require 'ci/reporter/test_unit'
+
+# Intercepts mediator creation in ruby-test < 2.1
+module Test #:nodoc:all
+  module Unit
+    module UI
+      module Console
+        class TestRunner
+          def create_mediator(suite)
+            # swap in our custom mediator
+            return CI::Reporter::TestUnit.new(suite)
+          end
+        end
+      end
+    end
+  end
+end
+
+# Intercepts mediator creation in ruby-test >= 2.1
+module Test #:nodoc:all
+  module Unit
+    module UI
+      class TestRunner
+        def setup_mediator
+          # swap in our custom mediator
+          @mediator = CI::Reporter::TestUnit.new(@suite)
+        end
+      end
+    end
+  end
+end

data/lib/ci/reporter/rake/utils.rb

@@ -0,0 +1,14 @@
+# Copyright (c) 2006-2012 Nick Sieger <nicksieger@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+module CI
+  module Reporter
+    def self.maybe_quote_filename(fn)
+      if fn =~ /\s/
+        fn = %{"#{fn}"}
+      end
+      fn
+    end
+  end
+end

data/lib/ci/reporter/report_manager.rb

@@ -0,0 +1,63 @@
+# Copyright (c) 2006-2012 Nick Sieger <nicksieger@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+require 'fileutils'
+
+module CI #:nodoc:
+  module Reporter #:nodoc:
+    class ReportManager
+      def initialize(prefix)
+        @basedir = ENV['CI_REPORTS'] || File.expand_path("#{Dir.getwd}/#{prefix.downcase}/reports")
+        @basename = "#{@basedir}/#{prefix.upcase}"
+        FileUtils.mkdir_p(@basedir)
+      end
+      
+      def write_report(suite)
+        File.open(filename_for(suite), "w") do |f|
+          f << suite.to_xml
+        end
+      end
+      
+    private
+    
+
+      # creates a uniqe filename per suite
+      # to prevent results from being overwritten
+      # if a result file is already written, it appends an index
+      # e.g.
+      #   SPEC-MailsController.xml
+      #   SPEC-MailsController.0.xml
+      #   SPEC-MailsController.1.xml
+      #   SPEC-MailsController...xml
+      #   SPEC-MailsController.N.xml
+      #
+      # with N < 100000, to prevent endless sidestep loops
+      MAX_SIDESTEPS     = 100000
+      MAX_FILENAME_SIZE = 240
+      #
+      def filename_for(suite)
+        basename = "#{@basename}-#{suite.name.gsub(/[^a-zA-Z0-9]+/, '-')}"
+        suffix = "xml"
+        
+        # shorten basename if it exceeds 240 characters
+        # most filesystems have a 255 character limit
+        # so leave some room for the sidesteps
+        basename = basename[0..MAX_FILENAME_SIZE] if basename.length > MAX_FILENAME_SIZE
+        
+        # the initial filename, e.g. SPEC-MailsController.xml
+        filename = [basename, suffix].join(".")
+        
+        # if the initial filename is already in use
+        # do sidesteps, beginning with SPEC-MailsController.0.xml
+        i = 0
+        while File.exists?(filename) && i < MAX_SIDESTEPS
+          filename = [basename, i, suffix].join(".")
+          i += 1
+        end
+        
+        filename
+      end
+    end
+  end
+end