finnlabs-ci_reporter 1.6.5

data/History.txt

@@ -0,0 +1,136 @@
+== 1.6.4 (12/21/10)
+
+- RSpec 2.2+ support (thanks emi)
+
+== 1.6.3
+
+- Thanks to yairgo and tylerkovacs for their assistance and prodding
+  for RSpec 2 support this release.
+- GH #4: Updated for modern Cucumber (0.9.2 as of this writing)
+- GH #6: Capture dynamically-named RSpec examples
+- GH #7: RSpec 2.0.0 compatibility
+
+== 1.6.2
+
+- GH #1: Properly escape text in system-out and system-err tags (Matt Kanwisher)
+- GH #2: Report rspec before(:all) failures (Edgars Beigarts)
+- GH #3: Support for Omissions and Pending Tests from Test::Unit 2.0.x (Sam Hendley)
+
+== 1.6.1
+
+- Add 'skipped' flag for pending RSpec examples (Aaron Unger)
+
+== 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)
+
+== 1.5.2
+
+- Compatibility with latest RSpec (1.1.11 or so); use example
+  description method if available
+- Remove dependency on rubygems when requiring builder (rescue
+  LoadError) (Jari Bakken)
+- Source repository moved to github/git.caldersphere.net
+
+== 1.5.1
+
+- Fix silly load-path error that some had been seeing
+
+== 1.5
+
+- Support for RSpec 1.1.1 example groups (which broke ci_reporter 1.4)
+- Change internal model to delegation instead of inheritance, allowing
+  ci_reporter to wrap different output formatters
+- Add 'ci:setup:rspecdoc' task to output specdoc format instead of
+  progress
+- Add support for pending examples; they will be listed in the report
+  XML as successful, but the name will have a '(PENDING)' tag appended
+- Support for RSpec < 0.9 removed as promised; use 1.4 if you still
+  need to use an older version of RSpec
+
+== 1.4
+
+- Test::Unit tests that fail in multiple places (setup, test method,
+  and teardown) are now tracked (marcog)
+- Explicit dependency requirement on Builder (>= 2.1.2)
+- Use of RSpec < 0.9 is now deprecated; support will probably
+  disappear in the next version
+
+== 1.3.5
+
+- Change way we append to environment variables to appease windows
+  (Tracker #13998, Adam Anderson)
+
+== 1.3.4
+
+- Call #to_s on the object passed in as the test suite name;
+  compatibility fix for RSpec trunk which passes a
+  Spec::DSL::Description instead of a string
+- Fix broken spec due to pending feature introduced in recent RSpec
+- Fix compatibility for JRuby
+- Add stub.rake file as another way to wrap existing Rakefile, with
+  note in README
+
+== 1.3.3
+
+- Use SPEC_OPTS instead of RSPECOPTS (Aslak Hellesøy)
+- Add assertions attribute to individual test cases (Tracker #11563,
+  Andy Sipe)
+
+== 1.3.2
+
+- Fix bug trying to modify frozen environment strings
+- Upgrade all specs to RSpec 1.0 style
+- Add specs for rake tasks
+
+== 1.3.1
+
+- Fixed to be compatible with RSpec 1.0.x (added fourth parameter to
+  Formatter#dump_summary)
+
+== 1.3
+
+- Fixed to be compatible with RSpec 0.9
+- Failure location text now contains both the exception message and
+  class name (in case the type and message attributes were truncated)
+
+== 1.2.4
+
+- Allow to report on RSpec specs when working with non-gem RSpec
+- Note: CI::Reporter is only compatible with RSpec up to 0.8.2
+
+== 1.2.3
+
+- Append to TESTOPTS and RSPECOPTS environment variables (Bret
+  Pettichord) so that other apps can put values in them as well
+
+== 1.2.2
+
+- Responds to environment variable CI_CAPTURE: if set to "off",
+  stdout/stderr capture will be disabled.
+
+== 1.2.1
+
+- Add license and copyright information (finally)
+
+== 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.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+# Copyright (c) 2006-2010 Nick Sieger <nicksieger@gmail.com>
+# 
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation files
+# (the "Software"), to deal in the Software without restriction,
+# including without limitation the rights to use, copy, modify, merge,
+# publish, distribute, sublicense, and/or sell copies of the Software,
+# and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,29 @@
+History.txt
+Manifest.txt
+README.txt
+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
+lib/ci/reporter/rake/test_unit_loader.rb
+lib/ci/reporter/rake/utils.rb
+lib/ci/reporter/report_manager.rb
+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
+spec/ci/reporter/rspec_spec.rb
+spec/ci/reporter/test_suite_spec.rb
+spec/ci/reporter/test_unit_spec.rb
+spec/spec_helper.rb
+tasks/ci_reporter.rake

data/README.txt

@@ -0,0 +1,65 @@
+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.
+
+== Installation
+
+CI::Reporter is available as a gem. To install the gem, use the usual gem command:
+
+    gem install ci_reporter
+
+== Usage
+
+CI::Reporter works best with projects that use a +Rakefile+ along with the standard <code>Rake::TestTask</code> or <code>Spec::Rake::SpecTask/RSpec::Core::RakeTask</code> tasks for running tests or examples, respectively. In this fashion, it hooks into <code>Test::Unit</code> or +RSpec+ using environment variables recognized by these custom tasks to inject the CI::Reporter code into the test or spec runs.  If you're using the Rails plugin, step 1 is unnecessary; skip to step 2.
+
+1. To use CI::Reporter, simply add the following lines to your Rakefile:
+
+    require 'rubygems'
+    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>, <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>, <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
+
+If you don't have control over the Rakefile or don't want to modify it, CI::Reporter has a substitute rake file that you can specify on the command-line.  It assumes that the main project rake file is called +Rakefile+ and lives in the current directory.  Run like so:
+
+    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 +cucumber_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
+
+* +CI_REPORTS+: if set, points to a directory where report files will be written.
+* +CI_CAPTURE+: if set to value "off", stdout/stderr capture will be disabled.
+
+== Source
+
+You can get the CI::Reporter source using Git, in any of the following ways:
+
+    git clone git://git.caldersphere.net/ci_reporter.git
+    git clone git://github.com/nicksieger/ci_reporter.git
+
+You can also download a tarball of the latest CI::Reporter source at http://github.com/nicksieger/ci_reporter/.
+
+== License
+
+This software is released under an MIT license.  For details, see the LICENSE.txt file included with the distribution.  The software is copyright (c) 2006-2010 Nick Sieger <nicksieger@gmail.com>.

data/Rakefile

@@ -0,0 +1,101 @@
+MANIFEST = FileList["History.txt", "Manifest.txt", "README.txt", "LICENSE.txt", "Rakefile",
+  "*.rake", "lib/**/*.rb", "spec/**/*.rb", "tasks/**/*.rake"]
+
+begin
+  File.open("Manifest.txt", "w") {|f| MANIFEST.each {|n| f << "#{n}\n"} }
+  require 'hoe'
+  require File.dirname(__FILE__) + '/lib/ci/reporter/version'
+  hoe = Hoe.spec("finnlabs-ci_reporter") do |p|
+    p.version = CI::Reporter::VERSION
+    p.url = "https://github.com/finnlabs/ci_reporter"
+    p.author = ["Nick Sieger", "Gregor Schmidt"]
+    p.email = "ruby@schmidtwisser.de"
+    p.summary = "CI::Reporter allows you to generate reams of XML for use with continuous integration systems."
+    p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+    p.description = p.paragraphs_of('README.txt', 0...1).join("\n\n")
+    p.extra_deps.reject!{|d| d.first == "hoe"}
+    p.test_globs = ["spec/**/*_spec.rb"]
+    p.extra_deps << ['builder', ">= 2.1.2"]
+  end
+  hoe.spec.files = MANIFEST
+  hoe.spec.dependencies.delete_if { |dep| dep.name == "hoe" }
+  hoe.spec.rdoc_options += ["-SHN", "-f", "darkfish"]
+
+  task :gemspec do
+    File.open("#{hoe.name}.gemspec", "w") {|f| f << hoe.spec.to_ruby }
+  end
+  task :package => :gemspec
+rescue LoadError
+  puts "You really need Hoe installed to be able to package this gem"
+end
+
+# Hoe insists on setting task :default => :test
+# !@#$ no easy way to empty the default list of prerequisites
+# Leave my tasks alone, Hoe
+%w(default spec rcov).each do |task|
+  next unless Rake::Task.task_defined?(task)
+  Rake::Task[task].prerequisites.clear
+  Rake::Task[task].actions.clear
+end
+
+# No RCov on JRuby at the moment
+if RUBY_PLATFORM =~ /java/
+  task :default => :spec
+else
+  task :default => :rcov
+end
+
+RSpecTask = begin
+  require 'rspec/core/rake_task'
+  @spec_bin = 'rspec'
+  RSpec::Core::RakeTask
+rescue LoadError
+  require 'spec/rake/spectask'
+  @spec_bin = 'spec'
+  Spec::Rake::SpecTask
+end
+
+RSpecTask.new do |t|
+end
+
+RSpecTask.new("spec:rcov") do |t|
+  t.rcov_opts = ['--exclude gems/*']
+  t.rcov = true
+end
+
+begin
+  require 'spec/rake/verify_rcov'
+  # so we don't confuse autotest
+  RCov::VerifyTask.new(:rcov) do |t|
+    # Can't get threshold up to 100 unless RSpec backwards compatibility
+    # code is dropped
+    t.threshold = 95
+    t.require_exact_threshold = false
+  end
+rescue LoadError
+end
+
+task "spec:rcov" do
+  rm_f "Manifest.txt"
+end
+task :rcov => "spec:rcov"
+
+task :generate_output do
+  rm_rf "acceptance/reports"
+  ENV['CI_REPORTS'] = "acceptance/reports"
+  begin
+    `ruby -Ilib -rubygems -rci/reporter/rake/test_unit_loader acceptance/test_unit_example_test.rb` rescue puts "Warning: #{$!}"
+    `ruby -Ilib -rubygems -S #{@spec_bin} --require ci/reporter/rake/rspec_loader --format CI::Reporter::RSpec acceptance/rspec_example_spec.rb` rescue puts "Warning: #{$!}"
+    `ruby -Ilib -rubygems -rci/reporter/rake/cucumber_loader -S cucumber --format CI::Reporter::Cucumber acceptance/cucumber` rescue puts "Warning: #{$!}"
+  ensure
+    ENV.delete 'CI_REPORTS'
+  end
+end
+task :acceptance => :generate_output
+
+RSpecTask.new(:acceptance_spec) do |t|
+  t.pattern = FileList['acceptance/verification_spec.rb']
+end
+task :acceptance => :acceptance_spec
+
+task :default => :acceptance

data/lib/ci/reporter/core.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.
+
+require 'ci/reporter/test_suite'
+require 'ci/reporter/report_manager'

data/lib/ci/reporter/cucumber.rb

@@ -0,0 +1,120 @@
+# 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 'cucumber'
+begin
+  require 'cucumber/ast/visitor'
+rescue LoadError
+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
+      attr_accessor :report_manager, :test_suite, :name
+
+      def initialize(step_mother, io, options)
+        @report_manager = ReportManager.new("features")
+      end
+
+      def before_feature(feature)
+        self.test_suite = TestSuite.new(@name)
+        test_suite.start
+      end
+
+      def after_feature(feature)
+        test_suite.name = @name
+        test_suite.finish
+        report_manager.write_report(@test_suite)
+        @test_suite = nil
+      end
+
+      def before_background(*args)
+      end
+
+      def after_background(*args)
+      end
+
+      def feature_name(keyword, name)
+        @name = (name || "Unnamed feature").split("\n").first
+      end
+
+      def scenario_name(keyword, name, *args)
+        @scenario = (name || "Unnamed scenario").split("\n").first
+      end
+
+      def before_steps(steps)
+        @test_case = TestCase.new(@scenario)
+        @test_case.start
+      end
+
+      def after_steps(steps)
+        @test_case.finish
+
+        case steps.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(steps)
+        end
+
+        test_suite.testcases << @test_case
+        @test_case = nil
+      end
+
+      def before_examples(*args)
+        @header_row = true
+      end
+
+      def after_examples(*args)
+      end
+
+      def before_table_row(table_row)
+        @test_case = TestCase.new("#@scenario (outline: #{table_row.name})")
+        @test_case.start
+      end
+
+      def after_table_row(table_row)
+        if @header_row
+          @header_row = false
+          return
+        end
+        @test_case.finish
+        @test_case.failures << CucumberFailure.new(table_row) if table_row.failed?
+        test_suite.testcases << @test_case
+        @test_case = nil
+      end
+    end
+  end
+end

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,21 @@
+# 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'
+
+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

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,34 @@
+# Copyright (c) 2006-2010 Nick Sieger <nicksieger@gmail.com>
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+require 'fileutils'
+require 'digest/sha1'
+
+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(suite.name), "w") do |f|
+          f << suite.to_xml
+        end
+      end
+
+    protected
+      
+      def filename(test_name)
+        filebase = "#{@basename}-#{test_name.gsub(/[^a-zA-Z0-9]+/, '-')}"
+        if filebase.size > 251
+          filebase = "#{filebase[0..209]}-#{Digest::SHA1.hexdigest(filebase[209..-1])}"
+        end
+        "#{@basedir}/#{filebase}.xml"
+      end
+    end
+  end
+end