rspec_junit_formatter 0.3.0.pre5 → 0.3.0.pre6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca1245d6a6ab72821ed12421f83f5d19e160e150
-  data.tar.gz: 8adb046de7cfa63694143046bedbcff68e496637
+  metadata.gz: be30b335dd3130df8c78a8d441d353ebf8dfa763
+  data.tar.gz: 518e4ec66af2bfb1a453832d76febc9840b2c8f0
 SHA512:
-  metadata.gz: 27bf67f53a85bb7a352d0b2885e9a96f169cd28be692870a24848f04e1572ef3b7c0d0a53928b2a7ec8a709b79bbbc20c79c41090003579cfb2490d9c202a57b
-  data.tar.gz: bb2cdff147bacaa458925108244595bae509b1d26398a20b741d6057720d9759f479e8cefedff4e7bb9e80210126efa43e8f269bed5d3b8b1d4632eb1f953361
+  metadata.gz: 603786fbf12485e4eeca039736ad85f36b2fdfadb77c22506a0b3a749be3150a4e6df8f059bebe2ccbf7f016945a4bfe81c64e27bb12aadfc4e609f5dc793d5d
+  data.tar.gz: a779567c3fea19f86de5289bd72a2b21e604322b91804813812bcf318940c82a5dd1753399fd2389229708a4dac1ce6b33f1ab4ee54eeac2550eaa04b503ad0f

data/README.md

@@ -58,6 +58,13 @@ For use with `parallel_tests`, add `$TEST_ENV_NUMBER` in the output file option
 
 The formatter includes `$TEST_ENV_NUMBER` in the test suite name within the XML, too.
 
+## Caveats
+
+ * XML can only represent a [limited subset of characters][xml-charsets] which
+   excludes null bytes and most control characters. This gem will use character
+   entities where possible and fall back to replacing invalid characters with
+   Ruby-like escape codes otherwise. For example, the null byte becomes `\0`.
+
 ## Roadmap
 
  * It would be nice to split things up into individual test suites, although
@@ -78,3 +85,4 @@ The MIT License, see [LICENSE][license].
   [bundler]: http://gembundler.com/
   [fuubar]: http://jeffkreeftmeijer.com/2010/fuubar-the-instafailing-rspec-progress-bar-formatter/
   [license]: https://github.com/sj26/rspec-junit-formatter/blob/master/LICENSE
+  [xml-charsets]: https://www.w3.org/TR/xml/#charsets

data/lib/rspec_junit_formatter.rb

@@ -1,3 +1,4 @@
+require "socket"
 require "time"
 
 require "rspec/core"
@@ -15,10 +16,12 @@ private
     output << %{<testsuite}
     output << %{ name="rspec#{escape(ENV["TEST_ENV_NUMBER"].to_s)}"}
     output << %{ tests="#{example_count}"}
+    output << %{ skipped="#{pending_count}"}
     output << %{ failures="#{failure_count}"}
     output << %{ errors="0"}
     output << %{ time="#{escape("%.6f" % duration)}"}
     output << %{ timestamp="#{escape(started.iso8601)}"}
+    output << %{ hostname="#{escape(Socket.gethostname)}"}
     output << %{>\n}
     output << %{<properties>\n}
     output << %{<property}
@@ -32,14 +35,17 @@ private
 
   def xml_dump_examples
     examples.each do |example|
-      send :"xml_dump_#{result_of(example)}", example
+      case result_of(example)
+      when :pending
+        xml_dump_pending(example)
+      when :failed
+        xml_dump_failed(example)
+      else
+        xml_dump_example(example)
+      end
     end
   end
 
-  def xml_dump_passed(example)
-    xml_dump_example(example)
-  end
-
   def xml_dump_pending(example)
     xml_dump_example(example) do
       output << %{<skipped/>}
@@ -51,8 +57,8 @@ private
 
     xml_dump_example(example) do
       output << %{<failure}
-      output << %{ message="#{escape(exception.to_s)}"}
-      output << %{ type="#{escape(exception.class.name)}"}
+      output << %{ message="#{escape(failure_message_for(example))}"}
+      output << %{ type="#{escape(failure_type_for(example))}"}
       output << %{>}
       output << escape(failure_for(example))
       output << %{</failure>}

data/lib/rspec_junit_formatter/rspec2.rb

@@ -14,7 +14,7 @@ class RSpecJUnitFormatter < RSpec::Core::Formatters::BaseFormatter
 private
 
   def result_of(example)
-    example.execution_result[:status]
+    example.execution_result[:status].to_sym
   end
 
   def example_group_file_path_for(example)
@@ -42,6 +42,14 @@ private
     example.execution_result[:exception]
   end
 
+  def failure_type_for(example)
+    exception_for(example).class.name
+  end
+
+  def failure_message_for(example)
+    exception_for(example).to_s
+  end
+
   def failure_for(example)
     exception = exception_for(example)
     backtrace = format_backtrace(exception.backtrace, example)

data/lib/rspec_junit_formatter/rspec3.rb

@@ -24,11 +24,15 @@ private
   attr_reader :started
 
   def example_count
-    @summary_notification.examples.count
+    @summary_notification.example_count
+  end
+
+  def pending_count
+    @summary_notification.pending_count
   end
 
   def failure_count
-    @summary_notification.failed_examples.count
+    @summary_notification.failure_count
   end
 
   def duration
@@ -64,13 +68,37 @@ private
     notification.example.full_description
   end
 
+  def failure_type_for(example)
+    exception_for(example).class.name
+  end
+
+  def failure_message_for(example)
+    strip_diff_colors(exception_for(example).to_s)
+  end
+
   def failure_for(notification)
-    notification.message_lines.join("\n") << "\n" << notification.formatted_backtrace.join("\n")
+    strip_diff_colors(notification.message_lines.join("\n")) << "\n" << notification.formatted_backtrace.join("\n")
   end
 
   def exception_for(notification)
     notification.example.execution_result.exception
   end
+
+  STRIP_DIFF_COLORS_BLOCK_REGEXP = /^ ( [ ]* ) Diff: \e\[0m (?: \n \1 \e\[0m .* )* /x
+  STRIP_DIFF_COLORS_CODES_REGEXP = /\e\[\d+m/
+
+  def strip_diff_colors(string)
+    # XXX: RSpec diffs are appended to the message lines fairly early and will
+    # contain ANSI escape codes for colorizing terminal output if the global
+    # rspec configuration is turned on, regardless of which notification lines
+    # we ask for. We need to strip the codes from the diff part of the message
+    # for XML output here.
+    #
+    # We also only want to target the diff hunks because the failure message
+    # itself might legitimately contain ansi escape codes.
+    #
+    string.sub(STRIP_DIFF_COLORS_BLOCK_REGEXP) { |match| match.gsub(STRIP_DIFF_COLORS_CODES_REGEXP, "".freeze) }
+  end
 end
 
 # rspec-core 3.0.x forgot to mark this as a module function which causes:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_junit_formatter
 version: !ruby/object:Gem::Version
-  version: 0.3.0.pre5
+  version: 0.3.0.pre6
 platform: ruby
 authors:
 - Samuel Cochran
@@ -28,7 +28,7 @@ cert_chain:
   bn56+Lu22lsUMYD62lUEdAPyYn1/JLPfq47UEuV1p5gy/f++aTxknsAYE/z/bfmO
   EkIxoeESVQ0Kqhp754GWYv3Sfmtyk8UbGo5XCZHzvC6h2G7mplPzh6o+Edw=
   -----END CERTIFICATE-----
-date: 2017-06-14 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core