brasten-ci_reporter 1.6.5

data/lib/ci/reporter/test_unit.rb

@@ -0,0 +1,143 @@
+# 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'
+require 'test/unit'
+require 'test/unit/ui/console/testrunner'
+
+module CI
+  module Reporter
+    # Factory for constructing either a CI::Reporter::TestUnitFailure or CI::Reporter::TestUnitError depending on the result
+    # of the test.
+    class Failure
+      def self.new(fault)
+        return TestUnitFailure.new(fault) if fault.kind_of?(Test::Unit::Failure)
+        return TestUnitSkipped.new(fault) if Test::Unit.constants.include?("Omission") && (fault.kind_of?(Test::Unit::Omission) || fault.kind_of?(Test::Unit::Pending))
+        return TestUnitNotification.new(fault) if Test::Unit.constants.include?("Notification") && fault.kind_of?(Test::Unit::Notification)
+        TestUnitError.new(fault)
+      end
+    end
+
+    # Wrapper around a <code>Test::Unit</code> error to be used by the test suite to interpret results.
+    class TestUnitError
+      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
+
+    # Wrapper around a <code>Test::Unit</code> failure to be used by the test suite to interpret results.
+    class TestUnitFailure
+      def initialize(fault) @fault = fault end
+      def failure?() true end
+      def error?() false end
+      def name() Test::Unit::AssertionFailedError.name end
+      def message() @fault.message end
+      def location() @fault.location.join("\n") end
+    end
+
+    # Wrapper around a <code>Test::Unit</code> 2.0 omission.
+    class TestUnitSkipped
+      def initialize(fault) @fault = fault end
+      def failure?() false end
+      def error?() false end
+      def name() Test::Unit::Omission.name end
+      def message() @fault.message end
+      def location() @fault.location.join("\n") end
+    end
+
+    # Wrapper around a <code>Test::Unit</code> 2.0 notification.
+    class TestUnitNotification
+      def initialize(fault) @fault = fault end
+      def failure?() false end
+      def error?() false end
+      def name() Test::Unit::Notification.name end
+      def message() @fault.message end
+      def location() @fault.location.join("\n") end
+    end
+
+    # Replacement Mediator that adds listeners to capture the results of the <code>Test::Unit</code> runs.
+    class TestUnit < Test::Unit::UI::TestRunnerMediator
+      def initialize(suite, report_mgr = nil)
+        super(suite)
+        @report_manager = report_mgr || ReportManager.new("test")
+        add_listener(Test::Unit::UI::TestRunnerMediator::STARTED, &method(:started))
+        add_listener(Test::Unit::TestCase::STARTED, &method(:test_started))
+        add_listener(Test::Unit::TestCase::FINISHED, &method(:test_finished))
+        add_listener(Test::Unit::TestResult::FAULT, &method(:fault))
+        add_listener(Test::Unit::UI::TestRunnerMediator::FINISHED, &method(:finished))
+      end
+
+      def started(result)
+        @suite_result = result
+        @last_assertion_count = 0
+        @current_suite = nil
+        @unknown_count = 0
+        @result_assertion_count = 0
+      end
+
+      def test_started(name)
+        test_name, suite_name = extract_names(name)
+        unless @current_suite && @current_suite.name == suite_name
+          finish_suite
+          start_suite(suite_name)
+        end
+        start_test(test_name)
+      end
+
+      def test_finished(name)
+        finish_test
+      end
+
+      def fault(fault)
+        tc = @current_suite.testcases.last
+        tc.failures << Failure.new(fault)
+      end
+
+      def finished(elapsed_time)
+        finish_suite
+      end
+
+      private
+      def extract_names(name)
+        match = name.match(/(.*)\(([^)]*)\)/)
+        if match
+          [match[1], match[2]]
+        else
+          @unknown_count += 1
+          [name, "unknown-#{@unknown_count}"]
+        end
+      end
+
+      def start_suite(suite_name)
+        @current_suite = TestSuite.new(suite_name)
+        @current_suite.start
+      end
+
+      def finish_suite
+        if @current_suite
+          @current_suite.finish
+          @current_suite.assertions = @suite_result.assertion_count - @last_assertion_count
+          @last_assertion_count = @suite_result.assertion_count
+          @report_manager.write_report(@current_suite)
+        end
+      end
+
+      def start_test(test_name)
+        tc = TestCase.new(test_name)
+        tc.start
+        @current_suite.testcases << tc
+      end
+
+      def finish_test
+        tc = @current_suite.testcases.last
+        tc.finish
+        tc.assertions = @suite_result.assertion_count - @result_assertion_count
+        @result_assertion_count = @suite_result.assertion_count
+      end
+    end
+  end
+end

data/lib/ci/reporter/version.rb

@@ -0,0 +1,5 @@
+module CI
+  module Reporter
+    VERSION = "1.6.4"
+  end
+end

data/spec/ci/reporter/cucumber_spec.rb

@@ -0,0 +1,230 @@
+# Copyright (c) 2006-2010 Nick Sieger <nicksieger@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+require File.dirname(__FILE__) + "/../../spec_helper.rb"
+require 'ci/reporter/cucumber'
+
+describe "The Cucumber reporter" do
+  describe CI::Reporter::CucumberFailure do
+    before(:each) do
+      @klass = mock("class")
+      @klass.stub!(:name).and_return("Exception name")
+
+      @exception = mock("exception")
+      @exception.stub!(:class).and_return(@klass)
+      @exception.stub!(:message).and_return("Exception message")
+      @exception.stub!(:backtrace).and_return(["First line", "Second line"])
+
+      @step = mock("step")
+      @step.stub!(:exception).and_return(@exception)
+
+      @cucumber_failure = CI::Reporter::CucumberFailure.new(@step)
+    end
+
+    it "should always return true for failure?" do
+      @cucumber_failure.should be_failure
+    end
+
+    it "should always return false for error?" do
+      @cucumber_failure.should_not be_error
+    end
+
+    it "should propagate the name as the underlying exception's class name" do
+      @step.should_receive(:exception)
+      @exception.should_receive(:class)
+      @klass.should_receive(:name)
+
+      @cucumber_failure.name.should == "Exception name"
+    end
+
+    it "should propagate the message as the underlying exception's message" do
+      @step.should_receive(:exception)
+      @exception.should_receive(:message)
+
+      @cucumber_failure.message.should == "Exception message"
+    end
+
+    it "should propagate and format the exception's backtrace" do
+      @step.should_receive(:exception)
+      @exception.should_receive(:backtrace)
+
+      @cucumber_failure.location.should == "First line\nSecond line"
+    end
+  end
+
+  describe CI::Reporter::Cucumber do
+    before(:each) do
+      @step_mother = mock("step_mother")
+      @io = mock("io")
+
+      @report_manager = mock("report_manager")
+      CI::Reporter::ReportManager.stub!(:new).and_return(@report_manager)
+    end
+
+    def new_instance
+      CI::Reporter::Cucumber.new(@step_mother, @io, {})
+    end
+
+    it "should create a new report manager to report on test success/failure" do
+      CI::Reporter::ReportManager.should_receive(:new)
+      new_instance
+    end
+
+    it "should record the feature name when a new feature is visited" do
+      cucumber = new_instance
+      cucumber.feature_name(nil, "Some feature name")
+      cucumber.name.should == "Some feature name"
+    end
+
+    it "should record only the first line of a feature name" do
+      cucumber = new_instance
+      cucumber.feature_name(nil, "Some feature name\nLonger description")
+      cucumber.name.should == "Some feature name"
+    end
+
+    context "applied to a feature" do
+      before(:each) do
+        @cucumber = new_instance
+        @cucumber.feature_name(nil, "Demo feature")
+
+        @test_suite = mock("test_suite", :start => nil, :finish => nil, :name= => nil)
+        CI::Reporter::TestSuite.stub!(:new).and_return(@test_suite)
+
+        @feature = mock("feature")
+
+        @report_manager.stub!(:write_report)
+      end
+
+      context "before" do
+        it "should create a new test suite" do
+          CI::Reporter::TestSuite.should_receive(:new).with(/Demo feature/)
+          @cucumber.before_feature(@feature)
+        end
+
+        it "should indicate that the test suite has started" do
+          @test_suite.should_receive(:start)
+          @cucumber.before_feature(@feature)
+        end
+      end
+
+      context "after" do
+        before :each do
+          @cucumber = new_instance
+          @cucumber.feature_name(nil, "Demo feature")
+
+          @test_suite = mock("test_suite", :start => nil, :finish => nil, :name= => nil)
+          CI::Reporter::TestSuite.stub!(:new).and_return(@test_suite)
+
+          @feature = mock("feature")
+
+          @report_manager.stub!(:write_report)
+
+          @cucumber.before_feature(@feature)
+        end
+
+        it "should indicate that the test suite has finished" do
+          @test_suite.should_receive(:finish)
+          @cucumber.after_feature(@feature)
+        end
+
+        it "should ask the report manager to write a report" do
+          @report_manager.should_receive(:write_report).with(@test_suite)
+          @cucumber.after_feature(@feature)
+        end
+      end
+    end
+
+    context "inside a scenario" do
+      before(:each) do
+        @testcases = []
+
+        @test_suite = mock("test_suite", :testcases => @testcases)
+
+        @cucumber = new_instance
+        @cucumber.stub!(:test_suite).and_return(@test_suite)
+
+        @test_case = mock("test_case", :start => nil, :finish => nil, :name => "Step Name")
+        CI::Reporter::TestCase.stub!(:new).and_return(@test_case)
+
+        @step = mock("step", :status => :passed)
+        @step.stub!(:name).and_return("Step Name")
+      end
+
+      context "before steps" do
+        it "should create a new test case" do
+          CI::Reporter::TestCase.should_receive(:new).with("Step Name")
+          @cucumber.scenario_name(nil, "Step Name")
+          @cucumber.before_steps(@step)
+        end
+
+        it "should indicate that the test case has started" do
+          @test_case.should_receive(:start)
+          @cucumber.before_steps(@step)
+        end
+      end
+
+      context "after steps" do
+        before :each do
+          @cucumber.before_steps(@step)
+        end
+
+        it "should indicate that the test case has finished" do
+          @test_case.should_receive(:finish)
+          @cucumber.after_steps(@step)
+        end
+
+        it "should add the test case to the suite's list of cases" do
+          @testcases.should be_empty
+          @cucumber.after_steps(@step)
+          @testcases.should_not be_empty
+          @testcases.first.should == @test_case
+        end
+
+        it "should alter the name of a test case that is pending to include '(PENDING)'" do
+          @step.stub!(:status).and_return(:pending)
+          @test_case.should_receive(:name=).with("Step Name (PENDING)")
+          @cucumber.after_steps(@step)
+        end
+
+        it "should alter the name of a test case that is undefined to include '(PENDING)'" do
+          @step.stub!(:status).and_return(:undefined)
+          @test_case.should_receive(:name=).with("Step Name (PENDING)")
+          @cucumber.after_steps(@step)
+        end
+
+        it "should alter the name of a test case that was skipped to include '(SKIPPED)'" do
+          @step.stub!(:status).and_return(:skipped)
+          @test_case.should_receive(:name=).with("Step Name (SKIPPED)")
+          @cucumber.after_steps(@step)
+        end
+      end
+
+      describe "that fails" do
+        before(:each) do
+          @step.stub!(:status).and_return(:failed)
+
+          @failures = []
+          @test_case.stub!(:failures).and_return(@failures)
+
+          @cucumber.before_steps(@step)
+
+          @cucumber_failure = mock("cucumber_failure")
+          CI::Reporter::CucumberFailure.stub!(:new).and_return(@cucumber_failure)
+        end
+
+        it "should create a new cucumber failure with that step" do
+          CI::Reporter::CucumberFailure.should_receive(:new).with(@step)
+          @cucumber.after_steps(@step)
+        end
+
+        it "should add the failure to the suite's list of failures" do
+          @failures.should be_empty
+          @cucumber.after_steps(@step)
+          @failures.should_not be_empty
+          @failures.first.should == @cucumber_failure
+        end
+      end
+    end
+  end
+end

data/spec/ci/reporter/output_capture_spec.rb

@@ -0,0 +1,57 @@
+# Copyright (c) 2006-2010 Nick Sieger <nicksieger@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+require File.dirname(__FILE__) + "/../../spec_helper.rb"
+require 'rexml/document'
+
+describe "Output capture" do
+  before(:each) do
+    @suite = CI::Reporter::TestSuite.new "test"
+  end
+
+  it "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
+
+  it "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.texts.first.to_s.strip.should == "Hello"
+    root.elements.to_a('//system-err').first.texts.first.to_s.strip.should == "Hi"
+  end
+
+  it "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
+  
+  it "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

data/spec/ci/reporter/rake/rake_tasks_spec.rb

@@ -0,0 +1,100 @@
+# Copyright (c) 2006-2010 Nick Sieger <nicksieger@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+require File.dirname(__FILE__) + "/../../../spec_helper.rb"
+require 'rake'
+
+def save_env(v)
+  ENV["PREV_#{v}"] = ENV[v]
+end
+def restore_env(v)
+  ENV[v] = ENV["PREV_#{v}"]
+  ENV.delete("PREV_#{v}")
+end
+
+describe "ci_reporter ci:setup:testunit task" do
+  before(:each) do
+    @rake = Rake::Application.new
+    Rake.application = @rake
+    load CI_REPORTER_LIB + '/ci/reporter/rake/test_unit.rb'
+    save_env "CI_REPORTS"
+    save_env "TESTOPTS"
+    ENV["CI_REPORTS"] = "some-bogus-nonexistent-directory-that-wont-fail-rm_rf"
+  end
+  after(:each) do
+    restore_env "TESTOPTS"
+    restore_env "CI_REPORTS"
+    Rake.application = nil
+  end
+
+  it "should set ENV['TESTOPTS'] to include test/unit setup file" do
+    @rake["ci:setup:testunit"].invoke
+    ENV["TESTOPTS"].should =~ /test_unit_loader/
+  end
+  
+  it "should append to ENV['TESTOPTS'] if it already contains a value" do
+    ENV["TESTOPTS"] = "somevalue".freeze
+    @rake["ci:setup:testunit"].invoke
+    ENV["TESTOPTS"].should =~ /somevalue.*test_unit_loader/
+  end
+end
+
+describe "ci_reporter ci:setup:rspec task" do
+  before(:each) do
+    @rake = Rake::Application.new
+    Rake.application = @rake
+    load CI_REPORTER_LIB + '/ci/reporter/rake/rspec.rb'
+    save_env "CI_REPORTS"
+    save_env "SPEC_OPTS"
+    ENV["CI_REPORTS"] = "some-bogus-nonexistent-directory-that-wont-fail-rm_rf"
+  end
+  after(:each) do
+    restore_env "SPEC_OPTS"
+    restore_env "CI_REPORTS"
+    Rake.application = nil
+  end
+  
+  it "should set ENV['SPEC_OPTS'] to include rspec formatter args" do
+    @rake["ci:setup:rspec"].invoke
+    ENV["SPEC_OPTS"].should =~ /--require.*rspec_loader.*--format.*CI::Reporter::RSpec/
+  end
+
+  it "should set ENV['SPEC_OPTS'] to include rspec doc formatter if task is ci:setup:rspecdoc" do
+    @rake["ci:setup:rspecdoc"].invoke
+    ENV["SPEC_OPTS"].should =~ /--require.*rspec_loader.*--format.*CI::Reporter::RSpecDoc/
+  end
+  
+  it "should append to ENV['SPEC_OPTS'] if it already contains a value" do
+    ENV["SPEC_OPTS"] = "somevalue".freeze
+    @rake["ci:setup:rspec"].invoke
+    ENV["SPEC_OPTS"].should =~ /somevalue.*--require.*rspec_loader.*--format.*CI::Reporter::RSpec/
+  end
+end
+
+describe "ci_reporter ci:setup:cucumber task" do
+  before(:each) do
+    @rake = Rake::Application.new
+    Rake.application = @rake
+    load CI_REPORTER_LIB + '/ci/reporter/rake/cucumber.rb'
+    save_env "CI_REPORTS"
+    save_env "CUCUMBER_OPTS"
+    ENV["CI_REPORTS"] = "some-bogus-nonexistent-directory-that-wont-fail-rm_rf"
+  end
+  after(:each) do
+    restore_env "CUCUMBER_OPTS"
+    restore_env "CI_REPORTS"
+    Rake.application = nil
+  end
+  
+  it "should set ENV['CUCUMBER_OPTS'] to include cucumber formatter args" do
+    @rake["ci:setup:cucumber"].invoke
+    ENV["CUCUMBER_OPTS"].should =~ /--require.*cucumber_loader.*--format.*CI::Reporter::Cucumber/
+  end
+
+  it "should append to ENV['CUCUMBER_OPTS'] if it already contains a value" do
+    ENV["CUCUMBER_OPTS"] = "somevalue".freeze
+    @rake["ci:setup:cucumber"].invoke
+    ENV["CUCUMBER_OPTS"].should =~ /somevalue.*--require.*cucumber_loader.*--format.*CI::Reporter::Cucumber/
+  end
+end