ci_reporter 1.5.3 → 1.6.0

data/History.txt

@@ -1,3 +1,7 @@
+== 1.6.0
+
+- Add support for Cucumber (tested against 0.3.0 - 0.3.2); (Graeme Mathieson)
+
 == 1.5.3
 
 - Compatibility with latest RSpec (1.2.4); (Paul Boone)

data/Manifest.txt

@@ -5,6 +5,9 @@ LICENSE.txt
 Rakefile
 stub.rake
 lib/ci/reporter/core.rb
+lib/ci/reporter/cucumber.rb
+lib/ci/reporter/rake/cucumber.rb
+lib/ci/reporter/rake/cucumber_loader.rb
 lib/ci/reporter/rake/rspec.rb
 lib/ci/reporter/rake/rspec_loader.rb
 lib/ci/reporter/rake/test_unit.rb
@@ -14,6 +17,7 @@ lib/ci/reporter/rspec.rb
 lib/ci/reporter/test_suite.rb
 lib/ci/reporter/test_unit.rb
 lib/ci/reporter/version.rb
+spec/ci/reporter/cucumber_spec.rb
 spec/ci/reporter/output_capture_spec.rb
 spec/ci/reporter/rake/rake_tasks_spec.rb
 spec/ci/reporter/report_manager_spec.rb

data/README.txt

@@ -1,4 +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, RSpec and Cucumber that allows you to generate XML reports of your test, spec and/or feature 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
 
@@ -22,14 +22,15 @@ CI::Reporter works best with projects that use a +Rakefile+ along with the stand
 
     require 'rubygems'
     gem 'ci_reporter'
-    require 'ci/reporter/rake/rspec' # use this if you're using RSpec
+    require 'ci/reporter/rake/rspec'     # use this if you're using RSpec
+    require 'ci/reporter/rake/cucumber'  # use this if you're using Cucumber
     require 'ci/reporter/rake/test_unit' # use this if you're using Test::Unit
 
-2. Next, either modify your Rakefile to make the <code>ci:setup:rspec</code> or <code>ci:setup:testunit</code> task a dependency of your test tasks, or include them on the Rake command-line before the name of the task that runs the tests or specs.
+2. Next, either modify your Rakefile to make the <code>ci:setup:rspec</code>, <code>ci:setup:cucumber</code> or <code>ci:setup:testunit</code> task a dependency of your test tasks, or include them on the Rake command-line before the name of the task that runs the tests or specs.
 
     rake ci:setup:testunit test
 
-Report files are written, by default, to the <code>test/reports</code> or <code>spec/reports</code> subdirectory of your project.  If you wish to customize the location, simply set the environment variable CI_REPORTS (either in the environment, on the Rake command line, or in your Rakefile) to the location where they should go.
+Report files are written, by default, to the <code>test/reports</code>, <code>features/reports</code> or <code>spec/reports</code> subdirectory of your project.  If you wish to customize the location, simply set the environment variable CI_REPORTS (either in the environment, on the Rake command line, or in your Rakefile) to the location where they should go.
 
 == Advanced Usage
 
@@ -37,14 +38,21 @@ If you don't have control over the Rakefile or don't want to modify it, CI::Repo
 
     rake -f GEM_PATH/stub.rake ci:setup:testunit test
     rake -f GEM_PATH/stub.rake ci:setup:rspec spec
+    rake -f GEM_PATH/stub.rake ci:setup:cucumber features
 
 If for some reason you can't use the above technique to inject CI::Reporter (e.g., you're not using Rake), you'll have to do one of these:
 
 1. If you're using <code>Test::Unit</code>, ensure the <code>ci/reporter/rake/test_unit_loader.rb</code> file is loaded or required at some point before the tests are run.
+
 2. If you're using +RSpec+, you'll need to pass the following arguments to the +spec+ command:
+
     --require GEM_PATH/lib/ci/reporter/rake/rspec_loader
     --format CI::Reporter::RSpec
 
+3. If you're using Cucumber, you'll need to cheat slightly so that Cucumber's step definition autoloading will still work.  Instead of calling the +cucumber+ script directly, run:
+
+    ruby -r GEM_PATH/lib/ci/reporter/rake/cucumber_loader -S cucumber --format CI::Reporter::Cucumber
+
 There's a bit of a chicken and egg problem because rubygems needs to be loaded before you can require any CI::Reporter files.  If you cringe hard-coding a full path to a specific version of the gem, you can also copy the +rspec_loader+ file into your project and require it directly -- the contents are version-agnostic and are not likely to change in future releases.
 
 == Environment Variables

data/Rakefile

@@ -58,11 +58,12 @@ end
 task :rcov => "spec:rcov"
 
 task :generate_output do
-  rm_f "acceptance/reports/*.xml"
+  rm_rf "acceptance/reports"
   ENV['CI_REPORTS'] = "acceptance/reports"
   begin
     `ruby -Ilib acceptance/test_unit_example_test.rb` rescue nil
     `ruby -Ilib -S spec --require ci/reporter/rake/rspec_loader --format CI::Reporter::RSpec acceptance/rspec_example_spec.rb` rescue nil
+    `ruby -Ilib -rci/reporter/rake/cucumber_loader -S cucumber --format CI::Reporter::Cucumber acceptance/cucumber` rescue nil
   ensure
     ENV.delete 'CI_REPORTS'
   end

data/lib/ci/reporter/cucumber.rb

@@ -0,0 +1,99 @@
+# (c) Copyright 2006-2009 Nick Sieger <nicksieger@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+require 'ci/reporter/core'
+tried_gem = false
+begin
+  require 'cucumber'
+  require 'cucumber/ast/visitor'
+rescue LoadError
+  unless tried_gem
+    tried_gem = true
+    require 'rubygems'
+    gem 'cucumber'
+    retry
+  end
+end
+
+module CI
+  module Reporter
+    class CucumberFailure
+      attr_reader :step
+
+      def initialize(step)
+        @step = step
+      end
+
+      def failure?
+        true
+      end
+
+      def error?
+        !failure?
+      end
+
+      def name
+        step.exception.class.name
+      end
+
+      def message
+        step.exception.message
+      end
+
+      def location
+        step.exception.backtrace.join("\n")
+      end
+    end
+
+    class Cucumber < ::Cucumber::Ast::Visitor
+
+      attr_accessor :test_suite, :report_manager, :feature_name
+
+      def initialize(step_mother, io, options)
+        self.report_manager = ReportManager.new("features")
+        super(step_mother)
+      end
+
+      def visit_feature_name(name)
+        self.feature_name = name.split("\n").first
+        super
+      end
+
+      def visit_feature_element(feature_element)
+        self.test_suite = TestSuite.new("#{feature_name} #{feature_element.instance_variable_get("@name")}")
+        test_suite.start
+
+        return_value = super
+
+        test_suite.finish
+        report_manager.write_report(test_suite)
+        self.test_suite = nil
+
+        return_value
+      end
+
+      def visit_step(step)
+        test_case = TestCase.new(step.name)
+        test_case.start
+
+        return_value = super
+
+        test_case.finish
+
+        case step.status
+        when :pending, :undefined
+          test_case.name = "#{test_case.name} (PENDING)"
+        when :skipped
+          test_case.name = "#{test_case.name} (SKIPPED)"
+        when :failed
+          test_case.failures << CucumberFailure.new(step)
+        end
+
+        test_suite.testcases << test_case
+
+        return_value
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# (c) Copyright 2006-2007 Nick Sieger <nicksieger@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+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
+      spec_opts = ["--require", "#{File.dirname(__FILE__)}/cucumber_loader.rb",
+        "--format", "CI::Reporter::Cucumber"].join(" ")
+      ENV["CUCUMBER_OPTS"] = "#{ENV['CUCUMBER_OPTS']} #{spec_opts}"
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+# (c) Copyright 2006-2007 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/version.rb

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

data/spec/ci/reporter/cucumber_spec.rb

@@ -0,0 +1,204 @@
+# (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 '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.visit_feature_name("Some feature name")
+      cucumber.feature_name.should == "Some feature name"
+    end
+
+    it "should record only the first line of a feature name" do
+      cucumber = new_instance
+      cucumber.visit_feature_name("Some feature name\nLonger description")
+      cucumber.feature_name.should == "Some feature name"
+    end
+
+    describe "when visiting a new scenario" do
+      before(:each) do
+        @cucumber = new_instance
+        @cucumber.visit_feature_name("Demo feature")
+
+        @test_suite = mock("test_suite", :start => nil, :finish => nil)
+        CI::Reporter::TestSuite.stub!(:new).and_return(@test_suite)
+
+        @feature_element = mock("feature_element", :accept => true)
+
+        @report_manager.stub!(:write_report)
+      end
+
+      it "should create a new test suite" do
+        # FIXME: @name is feature_element purely as a by-product of the
+        # mocking framework implementation.  But then again, using
+        # +instance_variable_get+ in the first place is a bit icky.
+        CI::Reporter::TestSuite.should_receive(:new).with("Demo feature feature_element")
+        @cucumber.visit_feature_element(@feature_element)
+      end
+
+      it "should indicate that the test suite has started" do
+        @test_suite.should_receive(:start)
+        @cucumber.visit_feature_element(@feature_element)
+      end
+
+      it "should indicate that the test suite has finished" do
+        @test_suite.should_receive(:finish)
+        @cucumber.visit_feature_element(@feature_element)
+      end
+
+      it "should ask the report manager to write a report" do
+        @report_manager.should_receive(:write_report).with(@test_suite)
+        @cucumber.visit_feature_element(@feature_element)
+      end
+    end
+
+    describe "when visiting a step 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", :accept => true, :status => :passed)
+        @step.stub!(:name).and_return("Step Name")
+      end
+
+      it "should create a new test case" do
+        CI::Reporter::TestCase.should_receive(:new).with("Step Name")
+        @cucumber.visit_step(@step)
+      end
+
+      it "should indicate that the test case has started" do
+        @test_case.should_receive(:start)
+        @cucumber.visit_step(@step)
+      end
+
+      it "should indicate that the test case has finished" do
+        @test_case.should_receive(:finish)
+        @cucumber.visit_step(@step)
+      end
+
+      it "should add the test case to the suite's list of cases" do
+        @testcases.should be_empty
+        @cucumber.visit_step(@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.visit_step(@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.visit_step(@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.visit_step(@step)
+      end
+
+      describe "that fails" do
+        before(:each) do
+          @step.stub!(:status).and_return(:failed)
+
+          @failures = []
+          @test_case.stub!(:failures).and_return(@failures)
+
+          @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.visit_step(@step)
+        end
+
+        it "should add the failure to the suite's list of failures" do
+          @failures.should be_empty
+          @cucumber.visit_step(@step)
+          @failures.should_not be_empty
+          @failures.first.should == @cucumber_failure
+        end
+      end
+    end
+  end
+end

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

@@ -71,3 +71,30 @@ describe "ci_reporter ci:setup:rspec task" do
     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

data/stub.rake

@@ -9,5 +9,6 @@
 #
 
 load File.dirname(__FILE__) + '/lib/ci/reporter/rake/rspec.rb'
+load File.dirname(__FILE__) + '/lib/ci/reporter/rake/cucumber.rb'
 load File.dirname(__FILE__) + '/lib/ci/reporter/rake/test_unit.rb'
 load 'Rakefile'

data/tasks/ci_reporter.rake

@@ -4,13 +4,15 @@
 
 begin
   gem 'ci_reporter'
-rescue
+rescue Gem::LoadError
   $: << File.dirname(__FILE__) + "/../lib"
 end
 require 'ci/reporter/rake/rspec'
+require 'ci/reporter/rake/cucumber'
 require 'ci/reporter/rake/test_unit'
 
 namespace :ci do
   task :setup_rspec => "ci:setup:rspec"
+  task :setup_cucumber => "ci:setup:cucumber"
   task :setup_testunit => "ci:setup:testunit"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ci_reporter
 version: !ruby/object:Gem::Version 
-  version: 1.5.3
+  version: 1.6.0
 platform: ruby
 authors: 
 - Nick Sieger
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-18 00:00:00 -05:00
+date: 2009-05-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.1.2
     version: 
-description: 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.
+description: CI::Reporter is an add-on to Test::Unit, RSpec and Cucumber that allows you to generate XML reports of your test, spec and/or feature 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.
 email: nick@nicksieger.com
 executables: []
 
@@ -41,6 +41,9 @@ files:
 - Rakefile
 - stub.rake
 - lib/ci/reporter/core.rb
+- lib/ci/reporter/cucumber.rb
+- lib/ci/reporter/rake/cucumber.rb
+- lib/ci/reporter/rake/cucumber_loader.rb
 - lib/ci/reporter/rake/rspec.rb
 - lib/ci/reporter/rake/rspec_loader.rb
 - lib/ci/reporter/rake/test_unit.rb
@@ -50,6 +53,7 @@ files:
 - lib/ci/reporter/test_suite.rb
 - lib/ci/reporter/test_unit.rb
 - lib/ci/reporter/version.rb
+- spec/ci/reporter/cucumber_spec.rb
 - spec/ci/reporter/output_capture_spec.rb
 - spec/ci/reporter/rake/rake_tasks_spec.rb
 - spec/ci/reporter/report_manager_spec.rb
@@ -86,6 +90,7 @@ signing_key:
 specification_version: 2
 summary: CI::Reporter allows you to generate reams of XML for use with continuous integration systems.
 test_files: 
+- spec/ci/reporter/cucumber_spec.rb
 - spec/ci/reporter/output_capture_spec.rb
 - spec/ci/reporter/rake/rake_tasks_spec.rb
 - spec/ci/reporter/report_manager_spec.rb