brasten-ci_reporter 1.6.5

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

@@ -0,0 +1,19 @@
+# Copyright (c) 2006-2010 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-2010 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/rspec.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2006-2010 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
+  end
+end

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

@@ -0,0 +1,6 @@
+# Copyright (c) 2006-2010 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-2010 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-2010 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-2010 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,61 @@
+# Copyright (c) 2006-2010 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 = "#{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
+      #
+      def filename_for(suite)
+        basename = "#{@basename}-#{suite.name.gsub(/[^a-zA-Z0-9]+/, '-')}"
+        suffix = "xml"
+        
+        # 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
+        
+        if filename.size > 251
+          filename = "#{filename[0..209]}-#{Digest::SHA1.hexdigest(filename[209..-1])}.#{suffix}"
+        end
+        
+        "#{@basedir}/#{filename}"
+      end
+    end
+  end
+end

data/lib/ci/reporter/rspec.rb

@@ -0,0 +1,189 @@
+# Copyright (c) 2006-2010 Nick Sieger <nicksieger@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+require 'ci/reporter/core'
+
+module CI
+  module Reporter
+    module RSpecFormatters
+      begin
+        require 'rspec/core/formatters/base_formatter'
+        require 'rspec/core/formatters/progress_formatter'
+        require 'rspec/core/formatters/documentation_formatter'
+        BaseFormatter = ::RSpec::Core::Formatters::BaseFormatter
+        ProgressFormatter = ::RSpec::Core::Formatters::ProgressFormatter
+        DocFormatter = ::RSpec::Core::Formatters::DocumentationFormatter
+      rescue LoadError => first_error
+        begin
+          require 'spec/runner/formatter/progress_bar_formatter'
+          require 'spec/runner/formatter/specdoc_formatter'
+          BaseFormatter = ::Spec::Runner::Formatter::BaseFormatter
+          ProgressFormatter = ::Spec::Runner::Formatter::ProgressBarFormatter
+          DocFormatter = ::Spec::Runner::Formatter::SpecdocFormatter
+        rescue LoadError
+          raise first_error
+        end
+      end
+    end
+
+    # Wrapper around a <code>RSpec</code> error or failure to be used by the test suite to interpret results.
+    class RSpecFailure
+      attr_reader :exception
+      def initialize(failure)
+        @failure = failure
+        @exception = failure.exception
+      end
+
+      def failure?
+        @failure.expectation_not_met?
+      end
+
+      def error?
+        !failure?
+      end
+
+      def name() exception.class.name end
+      def message() exception.message end
+      def location() (exception.backtrace || ["No backtrace available"]).join("\n") end
+    end
+
+    class RSpec2Failure < RSpecFailure
+      def initialize(example)
+        @example = example
+        @exception = @example.execution_result[:exception] || @example.execution_result[:exception_encountered]
+      end
+
+      def failure?
+        exception.is_a?(::RSpec::Expectations::ExpectationNotMetError)
+      end
+    end
+
+    # Custom +RSpec+ formatter used to hook into the spec runs and capture results.
+    class RSpec < RSpecFormatters::BaseFormatter
+      attr_accessor :report_manager
+      attr_accessor :formatter
+      def initialize(*args)
+        super
+        @formatter ||= RSpecFormatters::ProgressFormatter.new(*args)
+        @report_manager = ReportManager.new("spec")
+        @suite = nil
+      end
+
+      def start(spec_count)
+        @formatter.start(spec_count)
+      end
+
+      # rspec 0.9
+      def add_behaviour(name)
+        @formatter.add_behaviour(name)
+        new_suite(name)
+      end
+
+      # Compatibility with rspec < 1.2.4
+      def add_example_group(example_group)
+        @formatter.add_example_group(example_group)
+        new_suite(description_for(example_group))
+      end
+
+      # rspec >= 1.2.4
+      def example_group_started(example_group)
+        @formatter.example_group_started(example_group)
+        new_suite(description_for(example_group))
+      end
+
+      def example_started(name_or_example)
+        @formatter.example_started(name_or_example)
+        spec = TestCase.new
+        @suite.testcases << spec
+        spec.start
+      end
+
+      def example_failed(name_or_example, *rest)
+        @formatter.example_failed(name_or_example, *rest)
+
+        # In case we fail in before(:all)
+        example_started(name_or_example) if @suite.testcases.empty?
+
+        if name_or_example.respond_to?(:execution_result) # RSpec 2
+          failure = RSpec2Failure.new(name_or_example)
+        else
+          failure = RSpecFailure.new(rest[1]) # example_failed(name, counter, failure) in RSpec 1
+        end
+
+        spec = @suite.testcases.last
+        spec.finish
+        spec.name = description_for(name_or_example)
+        spec.failures << failure
+      end
+
+      def example_passed(name_or_example)
+        @formatter.example_passed(name_or_example)
+        spec = @suite.testcases.last
+        spec.finish
+        spec.name = description_for(name_or_example)
+      end
+
+      def example_pending(*args)
+        @formatter.example_pending(*args)
+        name = description_for(args[0])
+        spec = @suite.testcases.last
+        spec.finish
+        spec.name = "#{name} (PENDING)"
+        spec.skipped = true
+      end
+
+      def start_dump
+        @formatter.start_dump
+      end
+
+      def dump_failure(*args)
+        @formatter.dump_failure(*args)
+      end
+
+      def dump_summary(*args)
+        @formatter.dump_summary(*args)
+        write_report
+      end
+
+      def dump_pending
+        @formatter.dump_pending
+      end
+
+      def close
+        @formatter.close
+      end
+
+      private
+      def description_for(name_or_example)
+        if name_or_example.respond_to?(:full_description)
+          name_or_example.full_description
+        elsif name_or_example.respond_to?(:metadata)
+          name_or_example.metadata[:example_group][:full_description]
+        elsif name_or_example.respond_to?(:description)
+          name_or_example.description
+        else
+          "UNKNOWN"
+        end
+      end
+
+      def write_report
+        @suite.finish
+        @report_manager.write_report(@suite)
+      end
+
+      def new_suite(name)
+        write_report if @suite
+        @suite = TestSuite.new name
+        @suite.start
+      end
+    end
+
+    class RSpecDoc < RSpec
+      def initialize(*args)
+        @formatter = RSpecFormatters::DocFormatter.new(*args)
+        super
+      end
+    end
+  end
+end

data/lib/ci/reporter/test_suite.rb

@@ -0,0 +1,151 @@
+# Copyright (c) 2006-2010 Nick Sieger <nicksieger@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+require 'delegate'
+require 'stringio'
+
+module CI
+  module Reporter
+    # Emulates/delegates IO to $stdout or $stderr in order to capture output to report in the XML file.
+    class OutputCapture < DelegateClass(IO)
+      # Start capturing IO, using the given block to assign self to the proper IO global.
+      def initialize(io, &assign)
+        super
+        @delegate_io = io
+        @captured_io = StringIO.new
+        @assign_block = assign
+        @assign_block.call self
+      end
+
+      # Finalize the capture and reset to the original IO object.
+      def finish
+        @assign_block.call @delegate_io
+        @captured_io.string
+      end
+
+      # setup tee methods
+      %w(<< print printf putc puts write).each do |m|
+        module_eval(<<-EOS, __FILE__, __LINE__)
+          def #{m}(*args, &block)
+            @delegate_io.send(:#{m}, *args, &block)
+            @captured_io.send(:#{m}, *args, &block)
+          end
+        EOS
+      end
+    end
+
+    # Basic structure representing the running of a test suite.  Used to time tests and store results.
+    class TestSuite < Struct.new(:name, :tests, :time, :failures, :errors, :skipped, :assertions)
+      attr_accessor :testcases
+      attr_accessor :stdout, :stderr
+      def initialize(name)
+        super(name.to_s) # RSpec passes a "description" object instead of a string
+        @testcases = []
+      end
+
+      # Starts timing the test suite.
+      def start
+        @start = Time.now
+        unless ENV['CI_CAPTURE'] == "off"
+          @capture_out = OutputCapture.new($stdout) {|io| $stdout = io }
+          @capture_err = OutputCapture.new($stderr) {|io| $stderr = io }
+        end
+      end
+
+      # Finishes timing the test suite.
+      def finish
+        self.tests = testcases.size
+        self.time = Time.now - @start
+        self.failures = testcases.inject(0) {|sum,tc| sum += tc.failures.select{|f| f.failure? }.size }
+        self.errors = testcases.inject(0) {|sum,tc| sum += tc.failures.select{|f| f.error? }.size }
+        self.skipped = testcases.inject(0) {|sum,tc| sum += (tc.skipped? ? 1 : 0) }
+        self.stdout = @capture_out.finish if @capture_out
+        self.stderr = @capture_err.finish if @capture_err
+      end
+
+      # Creates the xml builder instance used to create the report xml document.
+      def create_builder
+        require 'builder'
+        # :escape_attrs is obsolete in a newer version, but should do no harm
+        Builder::XmlMarkup.new(:indent => 2, :escape_attrs => true)
+      end
+
+      # Creates an xml string containing the test suite results.
+      def to_xml
+        builder = create_builder
+        # more recent version of Builder doesn't need the escaping
+        def builder.trunc!(txt)
+          txt.sub(/\n.*/m, '...')
+        end
+        builder.instruct!
+        attrs = {}
+        each_pair {|k,v| attrs[k] = builder.trunc!(v.to_s) unless v.nil? || v.to_s.empty? }
+        builder.testsuite(attrs) do
+          @testcases.each do |tc|
+            tc.to_xml(builder)
+          end
+          builder.tag! "system-out" do
+            builder.text! self.stdout
+          end
+          builder.tag! "system-err" do
+            builder.text! self.stderr
+          end
+        end
+      end
+    end
+
+    # Structure used to represent an individual test case.  Used to time the test and store the result.
+    class TestCase < Struct.new(:name, :time, :assertions)
+      attr_accessor :failures
+      attr_accessor :skipped
+
+      def initialize(*args)
+        super
+        @failures = []
+      end
+
+      # Starts timing the test.
+      def start
+        @start = Time.now
+      end
+
+      # Finishes timing the test.
+      def finish
+        self.time = Time.now - @start
+      end
+
+      # Returns non-nil if the test failed.
+      def failure?
+        !failures.empty? && failures.detect {|f| f.failure? }
+      end
+
+      # Returns non-nil if the test had an error.
+      def error?
+        !failures.empty? && failures.detect {|f| f.error? }
+      end
+
+      def skipped?
+        return skipped
+      end
+
+      # Writes xml representing the test result to the provided builder.
+      def to_xml(builder)
+        attrs = {}
+        each_pair {|k,v| attrs[k] = builder.trunc!(v.to_s) unless v.nil? || v.to_s.empty?}
+        builder.testcase(attrs) do
+          if skipped
+            builder.skipped
+          else
+            failures.each do |failure|
+              builder.failure(:type => builder.trunc!(failure.name), :message => builder.trunc!(failure.message)) do
+                builder.text!(failure.message + " (#{failure.name})\n")
+                builder.text!(failure.location)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end