GICodeWarrior-ci_reporter 1.6.1

data/lib/ci/reporter/version.rb

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

data/spec/ci/reporter/output_capture_spec.rb

@@ -0,0 +1,57 @@
+# (c) Copyright 2006-2007 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.cdatas.first.to_s.should == "Hello\n"
+    root.elements.to_a('//system-err').first.cdatas.first.to_s.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,73 @@
+# (c) Copyright 2006-2007 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

data/spec/ci/reporter/report_manager_spec.rb

@@ -0,0 +1,39 @@
+# (c) Copyright 2006-2007 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"
+
+describe "The ReportManager" do
+  before(:each) do
+    @reports_dir = REPORTS_DIR
+  end
+
+  after(:each) do
+    FileUtils.rm_rf @reports_dir
+    ENV["CI_REPORTS"] = nil
+  end
+
+  it "should create the report directory according to the given prefix" do
+    CI::Reporter::ReportManager.new("spec")
+    File.directory?(@reports_dir).should be_true
+  end
+  
+  it "should create the report directory based on CI_REPORTS environment variable if set" do
+    @reports_dir = "#{Dir.getwd}/dummy"
+    ENV["CI_REPORTS"] = @reports_dir
+    CI::Reporter::ReportManager.new("spec")
+    File.directory?(@reports_dir).should be_true
+  end
+  
+  it "should write reports based on name and xml content of a test suite" do
+    reporter = CI::Reporter::ReportManager.new("spec")
+    suite = mock("test suite")
+    suite.should_receive(:name).and_return("some test suite name")
+    suite.should_receive(:to_xml).and_return("<xml></xml>")
+    reporter.write_report(suite)
+    filename = "#{REPORTS_DIR}/SPEC-some-test-suite-name.xml"
+    File.exist?(filename).should be_true
+    File.open(filename) {|f| f.read.should == "<xml></xml>"}
+  end
+end

data/spec/ci/reporter/rspec_spec.rb

@@ -0,0 +1,108 @@
+# (c) Copyright 2006-2008 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 'stringio'
+
+describe "The RSpec reporter" do
+  before(:each) do
+    @error = mock("error")
+    @error.stub!(:expectation_not_met?).and_return(false)
+    @error.stub!(:pending_fixed?).and_return(false)
+    @report_mgr = mock("report manager")
+    @options = mock("options")
+    @args = [@options, StringIO.new("")]
+    @args.shift if Spec::VERSION::MAJOR == 1 && Spec::VERSION::MINOR < 1
+    @fmt = CI::Reporter::RSpec.new *@args
+    @fmt.report_manager = @report_mgr
+    @formatter = mock("formatter")
+    @fmt.formatter = @formatter
+  end
+
+  it "should use a progress bar formatter by default" do
+    fmt = CI::Reporter::RSpec.new *@args
+    fmt.formatter.should be_instance_of(Spec::Runner::Formatter::ProgressBarFormatter)
+  end
+
+  it "should use a specdoc formatter for RSpecDoc" do
+    fmt = CI::Reporter::RSpecDoc.new *@args
+    fmt.formatter.should be_instance_of(Spec::Runner::Formatter::SpecdocFormatter)
+  end
+
+  it "should create a test suite with one success, one failure, and one pending" do
+    @report_mgr.should_receive(:write_report).and_return do |suite|
+      suite.testcases.length.should == 3
+      suite.testcases[0].should_not be_failure
+      suite.testcases[0].should_not be_error
+      suite.testcases[1].should be_error
+      suite.testcases[2].name.should =~ /\(PENDING\)/
+    end
+
+    example_group = mock "example group"
+    example_group.stub!(:description).and_return "A context"
+
+    @formatter.should_receive(:start).with(3)
+    @formatter.should_receive(:example_group_started).with(example_group)
+    @formatter.should_receive(:example_started).exactly(3).times
+    @formatter.should_receive(:example_passed).once
+    @formatter.should_receive(:example_failed).once
+    @formatter.should_receive(:example_pending).once
+    @formatter.should_receive(:start_dump).once
+    @formatter.should_receive(:dump_failure).once
+    @formatter.should_receive(:dump_summary).once
+    @formatter.should_receive(:dump_pending).once
+    @formatter.should_receive(:close).once
+
+    @fmt.start(3)
+    @fmt.example_group_started(example_group)
+    @fmt.example_started("should pass")
+    @fmt.example_passed("should pass")
+    @fmt.example_started("should fail")
+    @fmt.example_failed("should fail", 1, @error)
+    @fmt.example_started("should be pending")
+    @fmt.example_pending("A context", "should be pending", "Not Yet Implemented")
+    @fmt.start_dump
+    @fmt.dump_failure(1, mock("failure"))
+    @fmt.dump_summary(0.1, 3, 1, 1)
+    @fmt.dump_pending
+    @fmt.close
+  end
+
+  it "should support RSpec 1.0.8 #add_behavior" do
+    @formatter.should_receive(:start)
+    @formatter.should_receive(:add_behaviour).with("A context")
+    @formatter.should_receive(:example_started).once
+    @formatter.should_receive(:example_passed).once
+    @formatter.should_receive(:dump_summary)
+    @report_mgr.should_receive(:write_report)
+
+    @fmt.start(2)
+    @fmt.add_behaviour("A context")
+    @fmt.example_started("should pass")
+    @fmt.example_passed("should pass")
+    @fmt.dump_summary(0.1, 1, 0, 0)
+  end
+
+  it "should use the example #description method when available" do
+    group = mock "example group"
+    group.stub!(:description).and_return "group description"
+    example = mock "example"
+    example.stub!(:description).and_return "should do something"
+
+    @formatter.should_receive(:start)
+    @formatter.should_receive(:example_group_started).with(group)
+    @formatter.should_receive(:example_started).with(example).once
+    @formatter.should_receive(:example_passed).once
+    @formatter.should_receive(:dump_summary)
+    @report_mgr.should_receive(:write_report).and_return do |suite|
+      suite.testcases.last.name.should == "should do something"
+    end
+
+    @fmt.start(2)
+    @fmt.example_group_started(group)
+    @fmt.example_started(example)
+    @fmt.example_passed(example)
+    @fmt.dump_summary(0.1, 1, 0, 0)
+  end
+end

data/spec/ci/reporter/test_suite_spec.rb

@@ -0,0 +1,150 @@
+# (c) Copyright 2006-2007 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 "A TestSuite" do
+  before(:each) do
+    @suite = CI::Reporter::TestSuite.new("example suite")
+  end
+
+  it "should collect timings when start and finish are invoked in sequence" do
+    @suite.start
+    @suite.finish
+    @suite.time.should >= 0
+  end
+  
+  it "should aggregate tests" do
+    @suite.start
+    @suite.testcases << CI::Reporter::TestCase.new("example test")
+    @suite.finish
+    @suite.tests.should == 1
+  end
+
+  it "should stringify the name for cases when the object passed in is not a string" do
+    name = Object.new
+    def name.to_s; "object name"; end
+    CI::Reporter::TestSuite.new(name).name.should == "object name"
+  end
+  
+  it "should indicate number of failures and errors" do
+    failure = mock("failure")
+    failure.stub!(:failure?).and_return true
+    failure.stub!(:error?).and_return false
+
+    error = mock("error")
+    error.stub!(:failure?).and_return false
+    error.stub!(:error?).and_return true
+
+    @suite.start
+    @suite.testcases << CI::Reporter::TestCase.new("example test")
+    @suite.testcases << CI::Reporter::TestCase.new("failure test")
+    @suite.testcases.last.failures << failure
+    @suite.testcases << CI::Reporter::TestCase.new("error test")
+    @suite.testcases.last.failures << error
+    @suite.finish
+    @suite.tests.should == 3
+    @suite.failures.should == 1
+    @suite.errors.should == 1
+  end
+end
+
+describe "TestSuite xml" do
+  before(:each) do
+    @suite = CI::Reporter::TestSuite.new("example suite")
+    @suite.assertions = 11
+    begin
+      raise StandardError, "an exception occurred"
+    rescue => e
+      @exception = e
+    end
+  end
+
+  it "should contain Ant/JUnit-formatted description of entire suite" do
+    failure = mock("failure")
+    failure.stub!(:failure?).and_return true
+    failure.stub!(:error?).and_return false
+    failure.stub!(:name).and_return "failure"
+    failure.stub!(:message).and_return "There was a failure"
+    failure.stub!(:location).and_return @exception.backtrace.join("\n")
+
+    error = mock("error")
+    error.stub!(:failure?).and_return false
+    error.stub!(:error?).and_return true
+    error.stub!(:name).and_return "error"
+    error.stub!(:message).and_return "There was a error"
+    error.stub!(:location).and_return @exception.backtrace.join("\n")
+
+    @suite.start
+    @suite.testcases << CI::Reporter::TestCase.new("example test")
+    @suite.testcases << CI::Reporter::TestCase.new("failure test")
+    @suite.testcases.last.failures << failure
+    @suite.testcases << CI::Reporter::TestCase.new("error test")
+    @suite.testcases.last.failures << error
+    @suite.finish
+
+    xml = @suite.to_xml
+    doc = REXML::Document.new(xml)
+    testsuite = doc.root.elements.to_a("/testsuite")
+    testsuite.length.should == 1
+    testsuite = testsuite.first
+    testsuite.attributes["name"].should == "example suite"
+    testsuite.attributes["assertions"].should == "11"
+
+    testcases = testsuite.elements.to_a("testcase")
+    testcases.length.should == 3
+  end
+
+  it "should contain full exception type and message in location element" do
+    failure = mock("failure")
+    failure.stub!(:failure?).and_return true
+    failure.stub!(:error?).and_return false
+    failure.stub!(:name).and_return "failure"
+    failure.stub!(:message).and_return "There was a failure"
+    failure.stub!(:location).and_return @exception.backtrace.join("\n")
+
+    @suite.start
+    @suite.testcases << CI::Reporter::TestCase.new("example test")
+    @suite.testcases << CI::Reporter::TestCase.new("failure test")
+    @suite.testcases.last.failures << failure
+    @suite.finish
+
+    xml = @suite.to_xml
+    doc = REXML::Document.new(xml)
+    elem = doc.root.elements.to_a("/testsuite/testcase[@name='failure test']/failure").first
+    location = elem.texts.join
+    location.should =~ Regexp.new(failure.message)
+    location.should =~ Regexp.new(failure.name)
+  end
+
+  it "should filter attributes properly for invalid characters" do
+    failure = mock("failure")
+    failure.stub!(:failure?).and_return true
+    failure.stub!(:error?).and_return false
+    failure.stub!(:name).and_return "failure"
+    failure.stub!(:message).and_return "There was a <failure>\nReason: blah"
+    failure.stub!(:location).and_return @exception.backtrace.join("\n")
+
+    @suite.start
+    @suite.testcases << CI::Reporter::TestCase.new("failure test")
+    @suite.testcases.last.failures << failure
+    @suite.finish
+
+    xml = @suite.to_xml
+    xml.should =~ %r/message="There was a &lt;failure&gt;\.\.\."/
+  end
+end
+
+describe "A TestCase" do
+  before(:each) do
+    @tc = CI::Reporter::TestCase.new("example test")
+  end
+
+  it "should collect timings when start and finish are invoked in sequence" do
+    @tc.start
+    @tc.finish
+    @tc.time.should >= 0
+  end
+end

data/spec/ci/reporter/test_unit_spec.rb

@@ -0,0 +1,152 @@
+# (c) Copyright 2006-2007 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"
+
+describe "The TestUnit reporter" do
+  before(:each) do
+    @report_mgr = mock("report manager")
+    @testunit = CI::Reporter::TestUnit.new(nil, @report_mgr)
+    @result = mock("result")
+    @result.stub!(:assertion_count).and_return(7)
+  end
+
+  it "should build suites based on adjacent tests with the same class name" do
+    @suite = nil
+    @report_mgr.should_receive(:write_report).once.and_return {|suite| @suite = suite }
+
+    @testunit.started(@result)
+    @testunit.test_started("test_one(TestCaseClass)")
+    @testunit.test_finished("test_one(TestCaseClass)")
+    @testunit.test_started("test_two(TestCaseClass)")
+    @testunit.test_finished("test_two(TestCaseClass)")
+    @testunit.finished(10)
+
+    @suite.name.should == "TestCaseClass"
+    @suite.testcases.length.should == 2
+    @suite.testcases.first.name.should == "test_one"
+    @suite.testcases.first.should_not be_failure
+    @suite.testcases.first.should_not be_error
+    @suite.testcases.last.name.should == "test_two"
+    @suite.testcases.last.should_not be_failure
+    @suite.testcases.last.should_not be_error
+  end
+  
+  it "should build two suites when encountering different class names" do
+    @suites = []
+    @report_mgr.should_receive(:write_report).twice.and_return {|suite| @suites << suite }
+
+    @testunit.started(@result)
+    @testunit.test_started("test_one(TestCaseClass)")
+    @testunit.test_finished("test_one(TestCaseClass)")
+    @testunit.test_started("test_two(AnotherTestCaseClass)")
+    @testunit.test_finished("test_two(AnotherTestCaseClass)")
+    @testunit.finished(10)
+
+    @suites.first.name.should == "TestCaseClass"
+    @suites.first.testcases.length.should == 1
+    @suites.first.testcases.first.name.should == "test_one"
+    @suites.first.testcases.first.assertions.should == 7
+
+    @suites.last.name.should == "AnotherTestCaseClass"
+    @suites.last.testcases.length.should == 1
+    @suites.last.testcases.first.name.should == "test_two"
+    @suites.last.testcases.first.assertions.should == 0
+  end
+  
+  it "should record assertion counts during test run" do
+    @suite = nil
+    @report_mgr.should_receive(:write_report).and_return {|suite| @suite = suite }
+
+    @testunit.started(@result)
+    @testunit.test_started("test_one(TestCaseClass)")
+    @testunit.test_finished("test_one(TestCaseClass)")
+    @testunit.finished(10)
+
+    @suite.assertions.should == 7
+    @suite.testcases.last.assertions.should == 7
+  end
+  
+  it "should add failures to testcases when encountering a fault" do
+    @failure = Test::Unit::Failure.new("test_one(TestCaseClass)", "somewhere:10", "it failed")
+
+    @suite = nil
+    @report_mgr.should_receive(:write_report).once.and_return {|suite| @suite = suite }
+
+    @testunit.started(@result)
+    @testunit.test_started("test_one(TestCaseClass)")
+    @testunit.fault(@failure)
+    @testunit.test_finished("test_one(TestCaseClass)")
+    @testunit.finished(10)
+
+    @suite.name.should == "TestCaseClass"
+    @suite.testcases.length.should == 1
+    @suite.testcases.first.name.should == "test_one"
+    @suite.testcases.first.should be_failure
+  end
+
+  it "should add errors to testcases when encountering a fault" do
+    begin
+      raise StandardError, "error"
+    rescue => e
+      @error = Test::Unit::Error.new("test_two(TestCaseClass)", e)
+    end
+
+    @suite = nil
+    @report_mgr.should_receive(:write_report).once.and_return {|suite| @suite = suite }
+
+    @testunit.started(@result)
+    @testunit.test_started("test_one(TestCaseClass)")
+    @testunit.test_finished("test_one(TestCaseClass)")
+    @testunit.test_started("test_two(TestCaseClass)")
+    @testunit.fault(@error)
+    @testunit.test_finished("test_two(TestCaseClass)")
+    @testunit.finished(10)
+
+    @suite.name.should == "TestCaseClass"
+    @suite.testcases.length.should == 2
+    @suite.testcases.first.name.should == "test_one"
+    @suite.testcases.first.should_not be_failure
+    @suite.testcases.first.should_not be_error
+    @suite.testcases.last.name.should == "test_two"
+    @suite.testcases.last.should_not be_failure
+    @suite.testcases.last.should be_error
+  end
+  
+  it "should add multiple failures to a testcase" do
+    @failure1 = Test::Unit::Failure.new("test_one(TestCaseClass)", "somewhere:10", "it failed")
+    @failure2 = Test::Unit::Failure.new("test_one(TestCaseClass)", "somewhere:12", "it failed again in teardown")
+
+    @suite = nil
+    @report_mgr.should_receive(:write_report).once.and_return {|suite| @suite = suite }
+
+    @testunit.started(@result)
+    @testunit.test_started("test_one(TestCaseClass)")
+    @testunit.fault(@failure1)
+    @testunit.fault(@failure2)
+    @testunit.test_finished("test_one(TestCaseClass)")
+    @testunit.finished(10)
+
+    @suite.name.should == "TestCaseClass"
+    @suite.testcases.length.should == 1
+    @suite.testcases.first.name.should == "test_one"
+    @suite.testcases.first.should be_failure
+    @suite.testcases.first.failures.size.should == 2
+    @suite.failures.should == 2
+  end
+
+  it "should count test case names that don't conform to the standard pattern" do
+    @suite = nil
+    @report_mgr.should_receive(:write_report).once.and_return {|suite| @suite = suite }
+
+    @testunit.started(@result)
+    @testunit.test_started("some unknown test")
+    @testunit.test_finished("some unknown test")
+    @testunit.finished(10)
+
+    @suite.name.should == "unknown-1"
+    @suite.testcases.length.should == 1
+    @suite.testcases.first.name.should == "some unknown test"
+  end
+end