ci_reporter 1.1 → 1.2

data/History.txt

@@ -1,7 +1,11 @@
+== 1.2
+
+- Capture standard output and standard error during each individual test suite and include in the XML file in system-out and system-err elements, respectively (Tracker#9054[http://rubyforge.org/tracker/index.php?func=detail&aid=9054&group_id=2857&atid=11007])
+
 == 1.1
 
 - Add +assertions+ attribute to the +testsuite+ element that will contain per-suite assertion counts when used with Test::Unit.  Not useful with applications that read Ant/JUnit XML, but custom applications may wish to access it.
 
 == 1.0
 
-Initial Release.
+- Initial Release.

data/Manifest.txt

@@ -12,6 +12,7 @@ lib/ci/reporter/rake/rspec_loader.rb
 lib/ci/reporter/rake/test_unit.rb
 lib/ci/reporter/rake/test_unit_loader.rb
 spec/spec_helper.rb
+spec/ci/reporter/output_capture_spec.rb
 spec/ci/reporter/report_manager_spec.rb
 spec/ci/reporter/rspec_spec.rb
 spec/ci/reporter/test_suite_spec.rb

data/README.txt

@@ -1,8 +1,4 @@
-CI::Reporter is an add-on to Test::Unit and RSpec that allows you to generate
-XML reports of your test and/or spec runs. The resulting files can be read by
-a continuous integration system that understands Ant's JUnit report XML
-format, thus allowing your CI system to track test/spec successes and
-failures.
+CI::Reporter is an add-on to Test::Unit and RSpec that allows you to generate XML reports of your test and/or spec runs. The resulting files can be read by a continuous integration system that understands Ant's JUnit report XML format, thus allowing your CI system to track test/spec successes and failures.
 
 == Dependencies
 
@@ -10,7 +6,7 @@ CI::Reporter has one required dependency on Builder, but since many will have a
 
 == Installation
 
-CI::Reporter is available as a gem. To install the gem, use the usual gem command: 
+CI::Reporter is available as a gem. To install the gem, use the usual gem command:
 
     gem install ci_reporter
 

data/Rakefile

@@ -4,7 +4,7 @@ require 'hoe'
 MANIFEST = FileList["History.txt", "Manifest.txt", "README.txt", "Rakefile",
   "lib/**/*.rb", "spec/**/*.rb", "tasks/**/*.rake"]
 
-Hoe.new("ci_reporter", "1.1") do |p|
+Hoe.new("ci_reporter", "1.2") do |p|
   p.rubyforge_name = "caldersphere"
   p.url = "http://caldersphere.rubyforge.org/ci_reporter"
   p.author = "Nick Sieger"

data/lib/ci/reporter/test_suite.rb

@@ -1,8 +1,40 @@
+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, :assertions)
       attr_accessor :testcases
+      attr_accessor :stdout, :stderr
       def initialize(name)
         super
         @testcases = []
@@ -11,6 +43,8 @@ module CI
       # Starts timing the test suite.
       def start
         @start = Time.now
+        @capture_out = OutputCapture.new($stdout) {|io| $stdout = io }
+        @capture_err = OutputCapture.new($stderr) {|io| $stderr = io }
       end
 
       # Finishes timing the test suite.
@@ -19,6 +53,8 @@ module CI
         self.time = Time.now - @start
         self.failures = testcases.select {|tc| tc.failure? }.size
         self.errors = testcases.select {|tc| tc.error? }.size
+        self.stdout = @capture_out.finish
+        self.stderr = @capture_err.finish
       end
 
       # Creates the xml builder instance used to create the report xml document.
@@ -58,6 +94,12 @@ module CI
           @testcases.each do |tc|
             tc.to_xml(builder)
           end
+          builder.tag! "system-out" do
+            builder.cdata! self.stdout
+          end
+          builder.tag! "system-err" do
+            builder.cdata! self.stderr
+          end
         end
       end
     end

data/spec/ci/reporter/output_capture_spec.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + "/../../spec_helper.rb"
+require 'rexml/document'
+
+context "Output capture" do
+  setup do
+    @suite = CI::Reporter::TestSuite.new "test"
+  end
+
+  specify "should save stdout and stderr messages written during the test run" do
+    @suite.start
+    puts "Hello"
+    $stderr.print "Hi"
+    @suite.finish
+    @suite.stdout.should == "Hello\n"
+    @suite.stderr.should == "Hi"
+  end
+
+  specify "should include system-out and system-err elements in the xml output" do
+    @suite.start
+    puts "Hello"
+    $stderr.print "Hi"
+    @suite.finish
+
+    root = REXML::Document.new(@suite.to_xml).root
+    root.elements.to_a('//system-out').length.should == 1
+    root.elements.to_a('//system-err').length.should == 1
+    root.elements.to_a('//system-out').first.cdatas.first.to_s.should == "Hello\n"
+    root.elements.to_a('//system-err').first.cdatas.first.to_s.should == "Hi"
+  end
+
+  specify "should return $stdout and $stderr to original value after finish" do
+    out, err = $stdout, $stderr
+    @suite.start
+    $stdout.object_id.should_not == out.object_id
+    $stderr.object_id.should_not == err.object_id
+    @suite.finish
+    $stdout.object_id.should == out.object_id
+    $stderr.object_id.should == err.object_id
+  end
+  
+  specify "should capture only during run of owner test suite" do
+    $stdout.print "A"
+    $stderr.print "A"
+    @suite.start
+    $stdout.print "B"
+    $stderr.print "B"
+    @suite.finish
+    $stdout.print "C"
+    $stderr.print "C"
+    @suite.stdout.should == "B"
+    @suite.stderr.should == "B"
+  end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: ci_reporter
 version: !ruby/object:Gem::Version 
-  version: "1.1"
-date: 2007-03-15 00:00:00 -05:00
+  version: "1.2"
+date: 2007-03-25 00:00:00 -05:00
 summary: CI::Reporter allows you to generate reams of XML for use with continuous integration systems.
 require_paths: 
 - lib
@@ -43,12 +43,14 @@ files:
 - lib/ci/reporter/rake/test_unit.rb
 - lib/ci/reporter/rake/test_unit_loader.rb
 - spec/spec_helper.rb
+- spec/ci/reporter/output_capture_spec.rb
 - spec/ci/reporter/report_manager_spec.rb
 - spec/ci/reporter/rspec_spec.rb
 - spec/ci/reporter/test_suite_spec.rb
 - spec/ci/reporter/test_unit_spec.rb
 - tasks/ci_reporter.rake
 test_files: 
+- spec/ci/reporter/output_capture_spec.rb
 - spec/ci/reporter/report_manager_spec.rb
 - spec/ci/reporter/rspec_spec.rb
 - spec/ci/reporter/test_suite_spec.rb