yarjuf 1.0

data/HISTORY.txt

@@ -0,0 +1,3 @@
+1.0
+- Initial release
+

data/LICENSE.txt

@@ -0,0 +1,29 @@
+Copyright (c) 2012, Nathaniel Ritmeyer
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+3. Neither the name Nathaniel Ritmeyer nor the names of contributors to
+this software may be used to endorse or promote products derived from this
+software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
+IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,102 @@
+# yarjuf
+
+_Yet Another RSpec JUnit Formatter_
+
+## Intro
+
+I've never found a gem that can be relied on to generate JUnit
+output from [RSpec](https://www.relishapp.com/rspec/rspec-core/docs). Previously, I'd cobbled together a [formatter](http://www.natontesting.com/2012/05/25/rspec-junit-formatter-for-jenkins/) that worked for me for a couple of years and seems to have proved
+useful to others. But it was a hack and thought I'd rewrite it, make it
+conform to the JUnit format spec a bit better, and make it
+distributable as a gem. Thus: [yet-another-rspec-junit-formatter](https://github.com/natritmeyer/yarjuf)
+
+## Installation
+
+Using rubygems:
+
+`gem install yarjuf`
+
+Using bundler:
+
+Add the following line to your `Gemfile`:
+
+`gem 'yarjuf'`
+ 
+## Usage
+
+There are a few ways to use custom formatters in RSpec; what follows is
+the 'best' way...
+
+### Loading yarjuf
+
+Before you can use yarjuf, RSpec needs to know about it. The best way to
+do that is to use the functionality that RSpec provides to load
+libraries. 
+
+#### Modifying the `.rspec` file
+
+When RSpec executes, it looks for a file in the current working
+directory (project root) called `.rspec` that contains rspec
+configuration. It is a good idea to add the following to it:
+
+`--require spec_helper`
+
+Doing so will make sure that the `spec/spec_helper.rb` file will get
+required when RSpec starts.
+
+#### Modifying the `spec/spec_helper.rb` file
+
+Add the following to your `spec/spec_helper.rb`:
+
+```ruby
+require 'yarjuf'
+```
+
+That will make sure that yarjuf is loaded when RSpec starts and can be
+used as a formatter.
+
+### Generating JUnit output using yarjuf
+
+RSpec tests can be executed in a number of ways. Here's how to get JUnit
+output for each of those different ways - assuming you've loaded yarjuf
+as specified above).
+
+#### Running rspec tests from the command line
+
+In this scenario, you just want to run `rspec` from the command line and
+get JUnit output. To do that you'll need to use the `-f JUnit` option
+to generate JUnit output and to write it to a file you can use the
+`-o results.xml` option. So to run all your tests and get JUnit output
+written to a file, execute the following:
+
+`rspec -f JUnit -o results.xml`
+
+#### Running rspec tests using Rake
+
+In this scenario, you want to run your rspec tests using rake. To do
+that you'll need to add an option to your rake task:
+
+```ruby
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[-f JUnit -o results.xml]
+end
+```
+
+That will write out JUnit formatted results to a file called
+`results.xml`. 
+
+#### Jenkins integration
+
+To use yarjuf with Jenkins(/Hudson), simply tick the 'Publish JUnit test
+result report' option in the Jenkins task configuration page and in the
+'Test report XMLs' field specify the file name that you expect the JUnit
+formatted results to be written to, ie: the file path and name specified
+in the `-o` option above.
+
+## Acknowledgements
+
+* Thanks to [@adeoke](https://github.com/adeoke) for suggesting a slightly less sucky gem name than the
+one I originally came up with
+* Thanks to [@dchamb84](https://github.com/dchamb84) for helping me debug the original hack
+* Thanks to [@nathanbain](https://github.com/nathanbain) for spurring me on to write the original hack
+

data/lib/yarjuf.rb

@@ -0,0 +1,80 @@
+require 'time'
+require 'builder'
+require 'rspec/core/formatters/base_formatter'
+
+class JUnit < RSpec::Core::Formatters::BaseFormatter
+  def initialize(output)
+    super output
+    @test_suite_results = {}
+  end
+
+  def example_passed(example)
+    add_to_test_suite_results(example)
+  end
+
+  def example_failed(example)
+    add_to_test_suite_results(example)
+  end
+
+  def example_pending(example)
+    add_to_test_suite_results(example)
+  end
+
+  def add_to_test_suite_results(example)
+    suite_name = root_group_name_for(example)
+    @test_suite_results[suite_name] = [] unless @test_suite_results.keys.include?(suite_name)
+    @test_suite_results[suite_name] << example
+  end
+
+  def root_group_name_for(example)
+    group_hierarchy_for(example).first[:description]
+  end
+
+  def group_hierarchy_for(example)
+    group_hierarchy = []
+    current_example_group = example.metadata[:example_group]
+    until current_example_group.nil? do
+      group_hierarchy.unshift current_example_group
+      current_example_group = current_example_group[:example_group]
+    end
+    group_hierarchy
+  end
+
+  def failure_details_for(example)
+    exception = example.metadata[:execution_result][:exception]
+    exception.nil? ? "" : "#{exception.message}\n#{format_backtrace(exception.backtrace, example).join("\n")}"
+  end
+
+  def fail_count_for_suite(suite)
+    suite.select {|example| example.metadata[:execution_result][:status] == "failed"}.size
+  end
+
+  def skipped_count_for_suite(suite)
+    suite.select {|example| example.metadata[:execution_result][:status] == "pending"}.size
+  end
+
+  def dump_summary(duration, example_count, failure_count, pending_count)
+    builder = Builder::XmlMarkup.new :indent => 2
+    builder.instruct! :xml, :version => "1.0", :encoding => "UTF-8"
+    builder.testsuites :errors => 0, :failures => failure_count, :skipped => pending_count, :tests => example_count, :time => duration, :timestamp => Time.now.iso8601 do
+      @test_suite_results.each do |suite_name, tests|
+        builder.testsuite :name => suite_name, :tests => tests.size, :errors => 0, :failures => fail_count_for_suite(tests), :skipped => skipped_count_for_suite(tests) do
+          builder.properties
+          tests.each do |test|
+            builder.testcase :name => test.metadata[:full_description], :time => test.metadata[:execution_result][:run_time] do
+              case test.metadata[:execution_result][:status]
+              when "pending" then builder.skipped
+              when "failed"
+                builder.failure :message => "failed #{test.metadata[:full_description]}", :type => "failed" do
+                  builder.cdata! failure_details_for test
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  output.puts builder.target!
+  end
+end
+

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: yarjuf
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Nat Ritmeyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Yet Another RSpec JUnit Formatter (for Hudson/Jenkins)
+email:
+- nat@natontesting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/yarjuf.rb
+- LICENSE.txt
+- HISTORY.txt
+- README.md
+homepage: http://github.com/natritmeyer/yarjuf
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Yet Another RSpec JUnit Formatter (for Hudson/Jenkins)
+test_files: []