minitest-junit 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb75f516200b3009029ae7c6244da92aefcc8894
-  data.tar.gz: c7a8236e16e84547ba2c09c290bf6b90e1506807
+  metadata.gz: 2b91b566809b95993d90be26881a2b7301965f4b
+  data.tar.gz: d3dbd54d0b1811587bfa6f8298a64e933a429e18
 SHA512:
-  metadata.gz: 3cfc3cae4fd2a4e764ad14e53f7d161c990371834867a12332f57273dc0f51c838b1f24bdd305dd394ea0de92a943c7070aafe84a722c50ffe56ee6da0d9eafc
-  data.tar.gz: f1e8609c3fb99c055d86a3e03d2d65447ac5ca40ce423d3762404e034813734025c73fe6eeeba7575400014a643dc59ac66a8a2c7c5f5cc64d67e3b35572b370
+  metadata.gz: 788bc66cc5ce34ae8fa1944e59299d38d072039dae2ef36ea8938e5eb4bdbf8364a861c6c5ed252add21f23598fd3fb1207022fdcdfa892b4876226629886c98
+  data.tar.gz: 26ebf4dbd2d4dfcdbcf0bee8f63dd5aff2fab5d20bea5468b6e6e5fdb2b6e130206993cb8fc739b147652b5ee6ef318733dfd9127da82bd442f653cf3d32d921

data/README.md

@@ -1,6 +1,6 @@
 # Minitest::Junit
 
-TODO: Write a gem description
+Generates a JUnit-compatible XML report for consumption with Jenkins.
 
 ## Installation
 
@@ -18,11 +18,17 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    $ ruby your_test.rb --help
+    minitest options:
+    ...
+    Known extensions: junit, ...
+            --junit                      Generate a junit xml report
+            --junit-filename=OUT         Target output filename. Defaults to report.xml
+    ...
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/minitest-junit/fork )
+1. Fork it ( https://github.com/aespinosa/minitest-junit/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/minitest/junit.rb

@@ -1,12 +1,68 @@
 require 'minitest/junit/version'
+require 'minitest'
+require 'builder'
 
 # :nodoc:
 module Minitest
-  # :nodoc:
   module Junit
     # :nodoc:
     class Reporter
-      def initialize(_io)
+      def initialize(io)
+        @io = io
+        @results = []
+      end
+
+      def passed?
+        true
+      end
+
+      def start; end
+
+      def record(result)
+        @results << result
+      end
+
+      def report
+        @io.puts '<testsuite>'
+        @results.each { |result| @io.puts format(result) }
+        @io.puts '</testsuite>'
+      end
+
+      def format(result)
+        xml = Builder::XmlMarkup.new
+        xml.testcase classname: format_class(result), name: format_name(result),
+                     time: result.time, assertions: result.assertions do |t|
+          t.skipped if result.skipped?
+          result.failures.each do |failure|
+            type = classify failure
+            xml.tag! type, format_backtrace(failure), message: result
+          end
+        end
+        xml.target!
+      end
+
+      private
+
+      def classify(failure)
+        if failure.instance_of? UnexpectedError
+          'error'
+        else
+          'failure'
+        end
+      end
+
+      def format_backtrace(failure)
+        failure.backtrace.join("\n")
+      end
+
+      def format_class(result)
+        result.class.to_s.gsub(/(.*)::(.*)/, '\1.\2')
+        result.class
+      end
+
+      def format_name(result)
+        result.name.sub(/^test_/, '').gsub('_', ' ')
+        result.name
       end
     end
   end

data/lib/minitest/junit/version.rb

@@ -1,6 +1,6 @@
 module Minitest
   # :nodoc:
   module Junit
-    VERSION = '0.0.1'
+    VERSION = '0.1.0'
   end
 end

data/lib/minitest/junit_plugin.rb

@@ -13,10 +13,9 @@ module Minitest
   end
 
   def self.plugin_junit_init(options)
-    if options[:junit]
-      file_klass = options[:file_klass] || File
-      io = file_klass.new options[:junit_filename] || 'report.xml', 'w'
-      reporter << Junit::Reporter.new(io) if options[:junit]
-    end
+    return unless options[:junit]
+    file_klass = options[:file_klass] || File
+    io = file_klass.new options[:junit_filename] || 'report.xml', 'w'
+    reporter << Junit::Reporter.new(io) if options[:junit]
   end
 end

data/minitest-junit.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'minitest', '~> 5.0'
+  spec.add_dependency 'builder', '~> 3.2'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 10.3.2'

data/test/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/Documentation:
+  Enabled: false

data/test/junit_plugin_test.rb

@@ -2,7 +2,6 @@ require 'minitest/autorun'
 require 'minitest/mock'
 require 'minitest/junit_plugin'
 
-# :nodoc:
 class PluginTest < Minitest::Test
   def test_by_default_the_plugin_is_disabled
     opts = OptionParser.new

data/test/reporter_test.rb

@@ -0,0 +1,44 @@
+require 'minitest/autorun'
+require 'stringio'
+require 'time'
+
+require 'minitest/junit'
+
+class ReporterTest < Minitest::Test
+  def test_no_tests_generates_an_empty_suite
+    reporter = create_reporter
+
+    reporter.report
+
+    assert_equal "<testsuite>\n</testsuite>\n", reporter.output
+  end
+
+  def test_formats_each_result_with_a_formatter
+    reporter = create_reporter
+    results = rand(100).times.map do |i|
+      result = "test_name#{i}"
+      reporter.record result
+      result
+    end
+
+    reporter.report
+
+    expected = "<testsuite>\n#{results.join "\n"}\n</testsuite>\n"
+    assert_equal expected, reporter.output
+  end
+
+  private
+
+  def create_reporter
+    io = StringIO.new
+    reporter = Minitest::Junit::Reporter.new io
+    def reporter.output
+      @io.string
+    end
+    def reporter.format(result)
+      result
+    end
+    reporter.start
+    reporter
+  end
+end

data/test/testcase_formatter_test.rb

@@ -0,0 +1,79 @@
+require 'minitest/autorun'
+require 'stringio'
+require 'time'
+
+require 'minitest/junit'
+
+class TestCaseFormatter < Minitest::Test
+  def test_all_tests_generate_testcase_tag
+    test = create_test_result
+    reporter = create_reporter
+
+    assert_match test.name, reporter.format(test)
+  end
+
+  def test_skipped_tests_generates_skipped_tag
+    test = create_test_result
+    test.failures << create_error(Minitest::Skip)
+    reporter = create_reporter
+    reporter.record test
+
+    reporter.report
+
+    assert_match(/<skipped\/>/, reporter.output)
+  end
+
+  def test_failing_tests_creates_failure_tag
+    test = create_test_result
+    test.failures << create_error(Minitest::Assertion)
+    reporter = create_reporter
+    reporter.record test
+
+    reporter.report
+
+    assert_match(/<failure/, reporter.output)
+  end
+
+  def test_other_errors_generates_error_tag
+    test = create_test_result
+    test.failures << Minitest::UnexpectedError.new(create_error(Exception))
+    reporter = create_reporter
+    reporter.record test
+
+    reporter.report
+
+    assert_match(/<error/, reporter.output)
+  end
+
+  private
+
+  def create_error(klass)
+    fail klass, "A #{klass} failure"
+  rescue klass => e
+    e
+  end
+
+  def create_test_result
+    test = Minitest::Test.new 'passing test'
+    def test.class
+      'ATestClass'
+    end
+    test.time = a_number
+    test.assertions = a_number
+    test
+  end
+
+  def a_number
+    rand(100)
+  end
+
+  def create_reporter
+    io = StringIO.new ''
+    reporter = Minitest::Junit::Reporter.new io
+    def reporter.output
+      @io.string
+    end
+    reporter.start
+    reporter
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-junit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Allan Espinosa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-26 00:00:00.000000000 Z
+date: 2014-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +96,10 @@ files:
 - lib/minitest/junit/version.rb
 - lib/minitest/junit_plugin.rb
 - minitest-junit.gemspec
+- test/.rubocop.yml
 - test/junit_plugin_test.rb
+- test/reporter_test.rb
+- test/testcase_formatter_test.rb
 homepage: http://github.com/aespinosa/minitest-junit
 licenses:
 - MIT
@@ -103,9 +120,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Junit reporter for Minitest ~> 5.0
 test_files:
+- test/.rubocop.yml
 - test/junit_plugin_test.rb
+- test/reporter_test.rb
+- test/testcase_formatter_test.rb