Skip to content


Subversion checkout URL

You can clone with
Download ZIP
100644 41 lines (26 sloc) 2.44 KB
bfdcd21 @nicksieger - Prepare for 1.0 release; last set of changes in current svn location
nicksieger authored
1 CI::Reporter is an add-on to Test::Unit and RSpec that allows you to generate
2 XML reports of your test and/or spec runs. The resulting files can be read by
3 a continuous integration system that understands Ant's JUnit report XML
4 format, thus allowing your CI system to track test/spec successes and
5 failures.
7 == Installation
9 CI::Reporter is available as a gem. To install the gem, use the usual gem command:
11 gem install ci_reporter
13 To use CI::Reporter as a Rails plugin, first install the gem, and then install the plugin as follows:
15 script/plugin install
17 == Usage
19 CI::Reporter works best with projects that use a +Rakefile+ along with the standard <code>Rake::TestTask</code> or <code>Spec::Rake::SpecTask</code> tasks for running tests or specs, 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.
21 1. To use CI::Reporter, simply add the following lines to your Rakefile:
23 require 'rubygems'
24 gem 'ci_reporter'
25 require 'ci/reporter/rake/rspec' # use this if you're using RSpec
26 require 'ci/reporter/rake/test_unit' # use this if you're using Test::Unit
28 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.
30 rake ci:setup:testunit test
32 == Advanced Usage
34 If for some reason you can't use the above technique to inject CI::Reporter, you'll have to do one of these:
36 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.
37 2. If you're using +RSpec+, you'll need to pass the following arguments to the +spec+ command:
38 --require GEM_PATH/lib/ci/reporter/rake/rspec_loader
39 --format CI::Reporter::RSpec
41 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.
Something went wrong with that request. Please try again.