GICodeWarrior-ci_reporter 1.6.1

Sign up to get free protection for your applications and to get access to all the features.
data/.gitignore ADDED
@@ -0,0 +1,4 @@
1
+ Manifest.txt
2
+ coverage
3
+ acceptance/reports
4
+ pkg
data/History.txt ADDED
@@ -0,0 +1,110 @@
1
+ == 1.5.3
2
+
3
+ - Compatibility with latest RSpec (1.2.4); (Paul Boone)
4
+
5
+ == 1.5.2
6
+
7
+ - Compatibility with latest RSpec (1.1.11 or so); use example
8
+ description method if available
9
+ - Remove dependency on rubygems when requiring builder (rescue
10
+ LoadError) (Jari Bakken)
11
+ - Source repository moved to github/git.caldersphere.net
12
+
13
+ == 1.5.1
14
+
15
+ - Fix silly load-path error that some had been seeing
16
+
17
+ == 1.5
18
+
19
+ - Support for RSpec 1.1.1 example groups (which broke ci_reporter 1.4)
20
+ - Change internal model to delegation instead of inheritance, allowing
21
+ ci_reporter to wrap different output formatters
22
+ - Add 'ci:setup:rspecdoc' task to output specdoc format instead of
23
+ progress
24
+ - Add support for pending examples; they will be listed in the report
25
+ XML as successful, but the name will have a '(PENDING)' tag appended
26
+ - Support for RSpec < 0.9 removed as promised; use 1.4 if you still
27
+ need to use an older version of RSpec
28
+
29
+ == 1.4
30
+
31
+ - Test::Unit tests that fail in multiple places (setup, test method,
32
+ and teardown) are now tracked (marcog)
33
+ - Explicit dependency requirement on Builder (>= 2.1.2)
34
+ - Use of RSpec < 0.9 is now deprecated; support will probably
35
+ disappear in the next version
36
+
37
+ == 1.3.5
38
+
39
+ - Change way we append to environment variables to appease windows
40
+ (Tracker #13998, Adam Anderson)
41
+
42
+ == 1.3.4
43
+
44
+ - Call #to_s on the object passed in as the test suite name;
45
+ compatibility fix for RSpec trunk which passes a
46
+ Spec::DSL::Description instead of a string
47
+ - Fix broken spec due to pending feature introduced in recent RSpec
48
+ - Fix compatibility for JRuby
49
+ - Add stub.rake file as another way to wrap existing Rakefile, with
50
+ note in README
51
+
52
+ == 1.3.3
53
+
54
+ - Use SPEC_OPTS instead of RSPECOPTS (Aslak Hellesøy)
55
+ - Add assertions attribute to individual test cases (Tracker #11563,
56
+ Andy Sipe)
57
+
58
+ == 1.3.2
59
+
60
+ - Fix bug trying to modify frozen environment strings
61
+ - Upgrade all specs to RSpec 1.0 style
62
+ - Add specs for rake tasks
63
+
64
+ == 1.3.1
65
+
66
+ - Fixed to be compatible with RSpec 1.0.x (added fourth parameter to
67
+ Formatter#dump_summary)
68
+
69
+ == 1.3
70
+
71
+ - Fixed to be compatible with RSpec 0.9
72
+ - Failure location text now contains both the exception message and
73
+ class name (in case the type and message attributes were truncated)
74
+
75
+ == 1.2.4
76
+
77
+ - Allow to report on RSpec specs when working with non-gem RSpec
78
+ - Note: CI::Reporter is only compatible with RSpec up to 0.8.2
79
+
80
+ == 1.2.3
81
+
82
+ - Append to TESTOPTS and RSPECOPTS environment variables (Bret
83
+ Pettichord) so that other apps can put values in them as well
84
+
85
+ == 1.2.2
86
+
87
+ - Responds to environment variable CI_CAPTURE: if set to "off",
88
+ stdout/stderr capture will be disabled.
89
+
90
+ == 1.2.1
91
+
92
+ - Add license and copyright information (finally)
93
+
94
+ == 1.2
95
+
96
+ - Capture standard output and standard error during each individual
97
+ test suite and include in the XML file in system-out and system-err
98
+ elements, respectively
99
+ (Tracker#9054[http://rubyforge.org/tracker/index.php?func=detail&aid=9054&group_id=2857&atid=11007])
100
+
101
+ == 1.1
102
+
103
+ - Add +assertions+ attribute to the +testsuite+ element that will
104
+ contain per-suite assertion counts when used with Test::Unit. Not
105
+ useful with applications that read Ant/JUnit XML, but custom
106
+ applications may wish to access it.
107
+
108
+ == 1.0
109
+
110
+ - Initial Release.
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ # (c) Copyright 2006-2007 Nick Sieger <nicksieger@gmail.com>
2
+ #
3
+ # Permission is hereby granted, free of charge, to any person
4
+ # obtaining a copy of this software and associated documentation files
5
+ # (the "Software"), to deal in the Software without restriction,
6
+ # including without limitation the rights to use, copy, modify, merge,
7
+ # publish, distribute, sublicense, and/or sell copies of the Software,
8
+ # and to permit persons to whom the Software is furnished to do so,
9
+ # subject to the following conditions:
10
+ #
11
+ # The above copyright notice and this permission notice shall be
12
+ # included in all copies or substantial portions of the Software.
13
+ #
14
+ # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
18
+ # BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
19
+ # ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20
+ # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ # SOFTWARE.
data/README.txt ADDED
@@ -0,0 +1,66 @@
1
+ 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.
2
+
3
+ == Dependencies
4
+
5
+ CI::Reporter has one required dependency on Builder, but since many will have a viable version of Builder via Rails' ActiveSupport gem, Builder is not a direct dependency of the project at the moment. Instead, ensure that you have either the +builder+ or +activesupport+ gem installed before continuing. CI::Reporter will raise an exception at runtime if it cannot locate Builder.
6
+
7
+ == Installation
8
+
9
+ CI::Reporter is available as a gem. To install the gem, use the usual gem command:
10
+
11
+ gem install ci_reporter
12
+
13
+ To use CI::Reporter as a Rails plugin, first install the gem, and then install the plugin as follows:
14
+
15
+ script/plugin install http://svn.caldersphere.net/svn/main/plugins/ci_reporter
16
+
17
+ == Usage
18
+
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 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.
20
+
21
+ 1. To use CI::Reporter, simply add the following lines to your Rakefile:
22
+
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
27
+
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.
29
+
30
+ rake ci:setup:testunit test
31
+
32
+ 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.
33
+
34
+ == Advanced Usage
35
+
36
+ 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:
37
+
38
+ rake -f GEM_PATH/stub.rake ci:setup:testunit test
39
+ rake -f GEM_PATH/stub.rake ci:setup:rspec spec
40
+
41
+ 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:
42
+
43
+ 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.
44
+ 2. If you're using +RSpec+, you'll need to pass the following arguments to the +spec+ command:
45
+ --require GEM_PATH/lib/ci/reporter/rake/rspec_loader
46
+ --format CI::Reporter::RSpec
47
+
48
+ 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.
49
+
50
+ == Environment Variables
51
+
52
+ * +CI_REPORTS+: if set, points to a directory where report files will be written.
53
+ * +CI_CAPTURE+: if set to value "off", stdout/stderr capture will be disabled.
54
+
55
+ == Source
56
+
57
+ You can get the CI::Reporter source using Git, in any of the following ways:
58
+
59
+ git clone http://git.caldersphere.net/ci_reporter.git
60
+ git clone git://github.com/nicksieger/ci_reporter.git
61
+
62
+ You can also download a tarball of the latest CI::Reporter source at http://github.com/nicksieger/ci_reporter/tree/master.
63
+
64
+ == License
65
+
66
+ 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-2007 Nick Sieger <nicksieger@gmail.com>.
data/Rakefile ADDED
@@ -0,0 +1,90 @@
1
+ require 'spec/rake/spectask'
2
+ require 'spec/rake/verify_rcov'
3
+
4
+ MANIFEST = FileList["History.txt", "Manifest.txt", "README.txt", "LICENSE.txt", "Rakefile",
5
+ "*.rake", "lib/**/*.rb", "spec/**/*.rb", "tasks/**/*.rake"]
6
+
7
+ begin
8
+ File.open("Manifest.txt", "w") {|f| MANIFEST.each {|n| f << "#{n}\n"} }
9
+ require 'hoe'
10
+ require File.dirname(__FILE__) + '/lib/ci/reporter/version'
11
+ hoe = Hoe.new("ci_reporter", CI::Reporter::VERSION) do |p|
12
+ p.rubyforge_name = "caldersphere"
13
+ p.url = "http://caldersphere.rubyforge.org/ci_reporter"
14
+ p.author = "Nick Sieger"
15
+ p.email = "nick@nicksieger.com"
16
+ p.summary = "CI::Reporter allows you to generate reams of XML for use with continuous integration systems."
17
+ p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
18
+ p.description = p.paragraphs_of('README.txt', 0...1).join("\n\n")
19
+ p.extra_deps.reject!{|d| d.first == "hoe"}
20
+ p.test_globs = ["spec/**/*_spec.rb"]
21
+ p.extra_deps << ['builder', ">= 2.1.2"]
22
+ end
23
+ hoe.spec.files = MANIFEST
24
+ hoe.spec.dependencies.delete_if { |dep| dep.name == "hoe" }
25
+ rescue LoadError
26
+ puts "You really need Hoe installed to be able to package this gem"
27
+ end
28
+
29
+ begin
30
+ require 'jeweler'
31
+ Jeweler::Tasks.new do |gemspec|
32
+ gemspec.name = "ci_reporter"
33
+ gemspec.summary = "Generate reams of XML for use with continuous integration systems."
34
+ gemspec.email = "nick@nicksieger.com"
35
+ gemspec.homepage = "http://github.com/nicksieger/ci_reporter"
36
+ gemspec.authors = ["Nick Sieger"]
37
+ end
38
+ rescue LoadError
39
+ puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
40
+ end
41
+
42
+ # Hoe insists on setting task :default => :test
43
+ # !@#$ no easy way to empty the default list of prerequisites
44
+ Rake::Task['default'].send :instance_variable_set, "@prerequisites", FileList[]
45
+
46
+ # No RCov on JRuby at the moment
47
+ if RUBY_PLATFORM =~ /java/
48
+ task :default => :spec
49
+ else
50
+ task :default => :rcov
51
+ end
52
+
53
+ Spec::Rake::SpecTask.new do |t|
54
+ t.spec_opts = ["--diff", "unified"]
55
+ end
56
+
57
+ Spec::Rake::SpecTask.new("spec:rcov") do |t|
58
+ t.rcov_opts << '--exclude gems/*'
59
+ t.rcov = true
60
+ end
61
+ # so we don't confuse autotest
62
+ RCov::VerifyTask.new(:rcov) do |t|
63
+ # Can't get threshold up to 100 unless RSpec backwards compatibility
64
+ # code is dropped
65
+ t.threshold = 98
66
+ t.require_exact_threshold = false
67
+ end
68
+ task "spec:rcov" do
69
+ rm_f "Manifest.txt"
70
+ end
71
+ task :rcov => "spec:rcov"
72
+
73
+ task :generate_output do
74
+ rm_f "acceptance/reports/*.xml"
75
+ ENV['CI_REPORTS'] = "acceptance/reports"
76
+ begin
77
+ `ruby -Ilib acceptance/test_unit_example_test.rb` rescue nil
78
+ `ruby -Ilib -S spec --require ci/reporter/rake/rspec_loader --format CI::Reporter::RSpec acceptance/rspec_example_spec.rb` rescue nil
79
+ ensure
80
+ ENV.delete 'CI_REPORTS'
81
+ end
82
+ end
83
+ task :acceptance => :generate_output
84
+
85
+ Spec::Rake::SpecTask.new(:acceptance_spec) do |t|
86
+ t.spec_files = FileList['acceptance/verification_spec.rb']
87
+ end
88
+ task :acceptance => :acceptance_spec
89
+
90
+ task :default => :acceptance
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 1.6.1
@@ -0,0 +1,18 @@
1
+ describe "RSpec example" do
2
+ it "should succeed" do
3
+ true.should be_true
4
+ nil.should be_nil
5
+ end
6
+
7
+ it "should fail" do
8
+ violated
9
+ end
10
+
11
+ it "should be pending"
12
+
13
+ describe "nested" do
14
+ it "should succeed" do
15
+ true.should be_true
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,17 @@
1
+ require 'test/unit'
2
+ require 'ci/reporter/rake/test_unit_loader'
3
+
4
+ class TestUnitExampleTestOne < Test::Unit::TestCase
5
+ def test_one
6
+ assert(false, "First failure")
7
+ end
8
+ def teardown
9
+ raise "second failure"
10
+ end
11
+ end
12
+
13
+ class TestUnitExampleTestTwo < Test::Unit::TestCase
14
+ def test_two
15
+ assert true
16
+ end
17
+ end
@@ -0,0 +1,64 @@
1
+ require 'rexml/document'
2
+
3
+ REPORTS_DIR = File.dirname(__FILE__) + '/reports'
4
+
5
+ describe "Test::Unit acceptance" do
6
+ it "should generate two XML files" do
7
+ File.exist?(File.join(REPORTS_DIR, 'TEST-TestUnitExampleTestOne.xml')).should == true
8
+ File.exist?(File.join(REPORTS_DIR, 'TEST-TestUnitExampleTestTwo.xml')).should == true
9
+ end
10
+
11
+ it "should have one error and one failure for TestUnitExampleTestOne" do
12
+ doc = File.open(File.join(REPORTS_DIR, 'TEST-TestUnitExampleTestOne.xml')) do |f|
13
+ REXML::Document.new(f)
14
+ end
15
+ doc.root.attributes["errors"].should == "1"
16
+ doc.root.attributes["failures"].should == "1"
17
+ doc.root.attributes["assertions"].should == "1"
18
+ doc.root.attributes["tests"].should == "1"
19
+ doc.root.elements.to_a("/testsuite/testcase").size.should == 1
20
+ doc.root.elements.to_a("/testsuite/testcase/failure").size.should == 2
21
+ end
22
+
23
+ it "should have no errors or failures for TestUnitExampleTestTwo" do
24
+ doc = File.open(File.join(REPORTS_DIR, 'TEST-TestUnitExampleTestTwo.xml')) do |f|
25
+ REXML::Document.new(f)
26
+ end
27
+ doc.root.attributes["errors"].should == "0"
28
+ doc.root.attributes["failures"].should == "0"
29
+ doc.root.attributes["assertions"].should == "1"
30
+ doc.root.attributes["tests"].should == "1"
31
+ doc.root.elements.to_a("/testsuite/testcase").size.should == 1
32
+ doc.root.elements.to_a("/testsuite/testcase/failure").size.should == 0
33
+ end
34
+ end
35
+
36
+ describe "RSpec acceptance" do
37
+ it "should generate two XML files" do
38
+ File.exist?(File.join(REPORTS_DIR, 'SPEC-RSpec-example.xml')).should == true
39
+ File.exist?(File.join(REPORTS_DIR, 'SPEC-RSpec-example-nested.xml')).should == true
40
+ end
41
+
42
+ it "should have two tests and one failure" do
43
+ doc = File.open(File.join(REPORTS_DIR, 'SPEC-RSpec-example.xml')) do |f|
44
+ REXML::Document.new(f)
45
+ end
46
+ doc.root.attributes["errors"].should == "0"
47
+ doc.root.attributes["failures"].should == "1"
48
+ doc.root.attributes["tests"].should == "3"
49
+ doc.root.elements.to_a("/testsuite/testcase").size.should == 3
50
+ failures = doc.root.elements.to_a("/testsuite/testcase/failure")
51
+ failures.size.should == 1
52
+ failures.first.attributes["type"].should == "Spec::Expectations::ExpectationNotMetError"
53
+ end
54
+
55
+ it "should have one test in the nested example report" do
56
+ doc = File.open(File.join(REPORTS_DIR, 'SPEC-RSpec-example-nested.xml')) do |f|
57
+ REXML::Document.new(f)
58
+ end
59
+ doc.root.attributes["errors"].should == "0"
60
+ doc.root.attributes["failures"].should == "0"
61
+ doc.root.attributes["tests"].should == "1"
62
+ doc.root.elements.to_a("/testsuite/testcase").size.should == 1
63
+ end
64
+ end
@@ -0,0 +1,6 @@
1
+ # (c) Copyright 2006-2007 Nick Sieger <nicksieger@gmail.com>
2
+ # See the file LICENSE.txt included with the distribution for
3
+ # software license details.
4
+
5
+ require 'ci/reporter/test_suite'
6
+ require 'ci/reporter/report_manager'
@@ -0,0 +1,23 @@
1
+ # (c) Copyright 2006-2007 Nick Sieger <nicksieger@gmail.com>
2
+ # See the file LICENSE.txt included with the distribution for
3
+ # software license details.
4
+
5
+ namespace :ci do
6
+ namespace :setup do
7
+ task :spec_report_cleanup do
8
+ rm_rf ENV["CI_REPORTS"] || "spec/reports"
9
+ end
10
+
11
+ task :rspec => :spec_report_cleanup do
12
+ spec_opts = ["--require", "#{File.dirname(__FILE__)}/rspec_loader.rb",
13
+ "--format", "CI::Reporter::RSpec"].join(" ")
14
+ ENV["SPEC_OPTS"] = "#{ENV['SPEC_OPTS']} #{spec_opts}"
15
+ end
16
+
17
+ task :rspecdoc => :spec_report_cleanup do
18
+ spec_opts = ["--require", "#{File.dirname(__FILE__)}/rspec_loader.rb",
19
+ "--format", "CI::Reporter::RSpecDoc"].join(" ")
20
+ ENV["SPEC_OPTS"] = "#{ENV['SPEC_OPTS']} #{spec_opts}"
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,6 @@
1
+ # (c) Copyright 2006-2007 Nick Sieger <nicksieger@gmail.com>
2
+ # See the file LICENSE.txt included with the distribution for
3
+ # software license details.
4
+
5
+ $: << File.dirname(__FILE__) + "/../../.."
6
+ require 'ci/reporter/rspec'