rspec_junit_formatter 0.2.3 → 0.3.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aba33189eb6723f651a6d245f76fbd9c875339d8
-  data.tar.gz: 9de71e43b41fd5772143206cf51657380790042d
+  metadata.gz: f06d768eaf9e411ad68a32229073dc7aa32917e1
+  data.tar.gz: 7d90c8e0eb6e9b786c0a7057f2f6b1645803f685
 SHA512:
-  metadata.gz: 53f6734e3e839de30f60d22ed80371a458927796e46ea6b2ec2b2d8a8a9e00ef7ffd3d5dd663151de5be1aed33dd2de0e716bc79c1a84cb757292a7f943469d5
-  data.tar.gz: 50d33e7d36886ea36679b02871771c482e2d3aacd7fd94c4accb08e49c4858db2857ab90f1e5e215e2b78769a50c861e228d23a1177b863ae9d2879b03a39796
+  metadata.gz: 84ffd05878f6574d9d3e20ed9317432dbfb8f87894d5aa87264048ee8e6cd233b1f61dd28e1b1f5c9b614d7b89bc6e2627855c2cc17fd742492b2c8a2dc3946c
+  data.tar.gz: 3f9e1f4d8d3cad02103a3cb4a43446ebecc19d207ad891360d997efc2090adf9e82fa67b8db18913d4f74fd20df3855b29fa430aea3288f08b0a69b2c0df7465

data/README.md

@@ -1,9 +1,9 @@
 # RSpec JUnit Formatter
 
-[![Build results](http://img.shields.io/travis/sj26/rspec_junit_formatter.svg)](https://travis-ci.org/sj26/rspec_junit_formatter) 
-[![Gem version](http://img.shields.io/gem/v/rspec_junit_formatter.svg)](https://rubygems.org/gem/rspec_junit_formatter)
+[![Build results](http://img.shields.io/travis/sj26/rspec_junit_formatter/master.svg)](https://travis-ci.org/sj26/rspec_junit_formatter) 
+[![Gem version](http://img.shields.io/gem/v/rspec_junit_formatter.svg)](https://rubygems.org/gems/rspec_junit_formatter)
 
-[RSpec][rspec] 2 & 3 results that [Jenkins][jenkins] can read. Probably a few other CI servers, too.
+[RSpec][rspec] 2 & 3 results that [Jenkins][jenkins] can read. Probably a few other CI services, too.
 
 Inspired by the work of [Diego Souza][dgvncsz0f] on [RSpec Formatters][dgvncsz0f/rspec_formatters] after frustration with [CI Reporter][ci_reporter].
 
@@ -11,35 +11,55 @@ Inspired by the work of [Diego Souza][dgvncsz0f] on [RSpec Formatters][dgvncsz0f
 
 Install the gem:
 
-    gem install rspec_junit_formatter
+```sh
+gem install rspec_junit_formatter
+```
 
 Use it:
 
-    rspec --format RspecJunitFormatter  --out rspec.xml
+```sh
+rspec --format RspecJunitFormatter --out rspec.xml
+```
 
-You'll get an XML file with your results in it.
+You'll get an XML file `rspec.xml` with your results in it.
 
-## More Permanent Usage
+You can use it in combination with other [formatters][rspec-formatters], too:
+
+```sh
+rspec --format progress --format RspecJunitFormatter --out rspec.xml
+```
+
+### Using in your project with Bundler
 
 Add it to your Gemfile if you're using [Bundler][bundler]. Put it in the same groups as rspec.
 
-In your .rspec, usually alongside another formatter, add:
+```ruby
+group :test do
+  gem "rspec"
+  gem "rspec_junit_formatter"
+end
+```
 
-    --format RspecJunitFormatter
-    --out rspec.xml
+Put the same arguments as the commands above in [your `.rspec`][rspec-file]:
 
-I use it with the excellent [Fuubar formatter][fuubar].
+```
+--format RspecJunitFormatter
+--out rspec.xml
+```
 
 ## Roadmap
 
- * It would be nice to split things up into individual test suites, although would this correspond to example groups? The subject? The spec file? Not sure yet.
- * This would sit nicely in rspec-core, and has been designed to do so.
+ * It would be nice to split things up into individual test suites, although
+   would this correspond to example groups? The subject? The spec file? Not
+   sure yet.
 
 ## License
 
 The MIT License, see [LICENSE][license].
 
   [rspec]: http://rspec.info/
+  [rspec-formatters]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/formatters
+  [rspec-file]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/configuration/read-command-line-configuration-options-from-files
   [jenkins]: http://jenkins-ci.org/
   [dgvncsz0f]: https://github.com/dgvncsz0f
   [dgvncsz0f/rspec_formatters]: https://github.com/dgvncsz0f/rspec_formatters

data/lib/rspec_junit_formatter.rb

@@ -1,5 +1,4 @@
 require "time"
-require "builder"
 
 require "rspec/core"
 require "rspec/core/formatters/base_formatter"
@@ -11,17 +10,24 @@ class RSpecJUnitFormatter < RSpec::Core::Formatters::BaseFormatter
 
 private
 
-  def xml
-    @xml ||= Builder::XmlMarkup.new target: output, indent: 2
-  end
-
   def xml_dump
-    xml.instruct!
-    xml.testsuite name: "rspec#{ENV['TEST_ENV_NUMBER']}", tests: example_count, failures: failure_count, errors: 0, time: "%.6f" % duration, timestamp: started.iso8601 do
-      xml.comment! "Randomized with seed #{RSpec.configuration.seed}"
-      xml.properties
-      xml_dump_examples
-    end
+    output << %{<?xml version="1.0" encoding="UTF-8"?>\n}
+    output << %{<testsuite}
+    output << %{ name="rspec#{escape(ENV["TEST_ENV_NUMBER"].to_s)}"}
+    output << %{ tests="#{example_count}"}
+    output << %{ failures="#{failure_count}"}
+    output << %{ errors="0"}
+    output << %{ time="#{escape("%.6f" % duration)}"}
+    output << %{ timestamp="#{escape(started.iso8601)}"}
+    output << %{>\n}
+    output << %{<properties>\n}
+    output << %{<property}
+    output << %{ name="seed"}
+    output << %{ value="#{escape(RSpec.configuration.seed.to_s)}"}
+    output << %{/>\n}
+    output << %{</properties>\n}
+    xml_dump_examples
+    output << %{</testsuite>\n}
   end
 
   def xml_dump_examples
@@ -36,30 +42,85 @@ private
 
   def xml_dump_pending(example)
     xml_dump_example(example) do
-      xml.skipped
+      output << %{<skipped/>}
     end
   end
 
   def xml_dump_failed(example)
     exception = exception_for(example)
-    backtrace = formatted_backtrace_for(example)
 
     xml_dump_example(example) do
-      xml.failure message: exception.to_s, type: exception.class.name do
-        xml.cdata! "#{exception.message}\n#{backtrace.join "\n"}"
-      end
+      output << %{<failure}
+      output << %{ message="#{escape(exception.to_s)}"}
+      output << %{ type="#{escape(exception.class.name)}"}
+      output << %{>}
+      output << escape(failure_for(example))
+      output << %{</failure>}
     end
   end
 
-  def xml_dump_example(example, &block)
-    xml.testcase classname: classname_for(example), name: description_for(example), file: example_group_file_path_for(example), time: "%.6f" % duration_for(example), &block
+  def xml_dump_example(example)
+    output << %{<testcase}
+    output << %{ classname="#{escape(classname_for(example))}"}
+    output << %{ name="#{escape(description_for(example))}"}
+    output << %{ file="#{escape(example_group_file_path_for(example))}"}
+    output << %{ time="#{escape("%.6f" % duration_for(example))}"}
+    output << %{>}
+    yield if block_given?
+    output << %{</testcase>\n}
+  end
+
+  # Based on valid characters allowed in XML unescaped, with restricted and
+  # discouraged characters removed
+  #
+  # See https://www.w3.org/TR/xml/#dt-chardata
+  ESCAPE_REGEXP = Regexp.new(
+    "[^" <<
+    "\u{9}" << # => \t
+    "\u{a}" << # =>\n
+    "\u{d}" << # => \r
+    "\u{20}-\u{21}" <<
+    # "\u{22}" << # => "
+    "\u{23}-\u{25}" <<
+    # "\u{26}" << # => &
+    # "\u{27}" << # => '
+    "\u{28}-\u{3b}" <<
+    # "\u{3c}" << # => <
+    "\u{3d}" <<
+    # "\u{3e}" << # => >
+    "\u{3f}-\u{7e}" <<
+    # "\u{7f}-\u{84}" << # discouraged control characters
+    "\u{85}" <<
+    # "\u{86}-\u{9f}" << # discouraged control characters
+    "\u{a0}-\u{d7ff}" <<
+    "\u{e000}-\u{ffcf}" <<
+    # "\u{ffd0}-\u{fdef}" <<
+    "\u{fdf0}-\u{fffd}" <<
+    # things get murky from here, just escape anything with a higher codepoint
+    # "\u{10000}-\u{10ffff}" <<
+    "]"
+  )
+
+  # Translate well-known entities, or use generic unicode hex entity
+  ESCAPE_ENTITY = Hash.new { |_, c| "&##{c.ord.to_s(16)};".freeze }.update(
+    ?" => "&quot;".freeze,
+    ?& => "&amp;".freeze,
+    ?' => "&apos;".freeze,
+    ?< => "&lt;".freeze,
+    ?> => "&gt;".freeze,
+  ).freeze
+
+  def escape(text)
+    # Make sure it's utf-8 (this will throw errors for bad output, but that
+    # seems okay) and replace invalid xml characters with entities
+    text.to_s.encode(Encoding::UTF_8).gsub(ESCAPE_REGEXP, ESCAPE_ENTITY)
   end
 end
 
 RspecJunitFormatter = RSpecJUnitFormatter
 
-if RSpec::Core::Version::STRING.start_with? "3."
-  require "rspec_junit_formatter/rspec3"
-else RSpec::Core::Version::STRING.start_with? "2."
+if RSpec::Core::Version::STRING.start_with? "2."
   require "rspec_junit_formatter/rspec2"
+else
+  require "rspec_junit_formatter/rspec3"
 end

data/lib/rspec_junit_formatter/rspec2.rb

@@ -13,12 +13,6 @@ class RSpecJUnitFormatter < RSpec::Core::Formatters::BaseFormatter
 
 private
 
-  def xml_dump_examples
-    examples.each do |example|
-      send :"xml_dump_#{example.execution_result[:status]}", example
-    end
-  end
-
   def result_of(example)
     example.execution_result[:status]
   end
@@ -48,7 +42,10 @@ private
     example.execution_result[:exception]
   end
 
-  def formatted_backtrace_for(example)
-    format_backtrace exception_for(example).backtrace, example
+  def failure_for(example)
+    exception = exception_for(example)
+    backtrace = format_backtrace(exception.backtrace, example)
+
+    "#{exception.message}\n#{backtrace.join("\n")}"
   end
 end

data/lib/rspec_junit_formatter/rspec3.rb

@@ -60,11 +60,11 @@ private
     notification.example.full_description
   end
 
-  def exception_for(notification)
-    notification.example.execution_result.exception
+  def failure_for(notification)
+    notification.message_lines.join("\n") << "\n" << notification.formatted_backtrace.join("\n")
   end
 
-  def formatted_backtrace_for(notification)
-    notification.formatted_backtrace
+  def exception_for(notification)
+    notification.example.execution_result.exception
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_junit_formatter
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0.pre
 platform: ruby
 authors:
 - Samuel Cochran
@@ -10,9 +10,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDKDCCAhCgAwIBAgIBAzANBgkqhkiG9w0BAQUFADA6MQ0wCwYDVQQDDARzajI2
+  MIIDKDCCAhCgAwIBAgIBBDANBgkqhkiG9w0BAQUFADA6MQ0wCwYDVQQDDARzajI2
   MRQwEgYKCZImiZPyLGQBGRYEc2oyNjETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0x
-  NTAzMTcyMjUwMjZaFw0xNjAzMTYyMjUwMjZaMDoxDTALBgNVBAMMBHNqMjYxFDAS
+  NjA3MjYxMTIxMjZaFw0xNzA3MjYxMTIxMjZaMDoxDTALBgNVBAMMBHNqMjYxFDAS
   BgoJkiaJk/IsZAEZFgRzajI2MRMwEQYKCZImiZPyLGQBGRYDY29tMIIBIjANBgkq
   hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsr60Eo/ttCk8GMTMFiPr3GoYMIMFvLak
   xSmTk9YGCB6UiEePB4THSSA5w6IPyeaCF/nWkDp3/BAam0eZMWG1IzYQB23TqIM0
@@ -21,14 +21,14 @@ cert_chain:
   4O/FL2ChjL2CPCpLZW55ShYyrzphWJwLOJe+FJ/ZBl6YXwrzQM9HKnt4titSNvyU
   KzE3L63A3PZvExzLrN9u09kuWLLJfXB2sGOlw3n9t72rJiuBr3/OQQIDAQABozkw
   NzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU99dfRjEKFyczTeIz
-  m3ZsDWrNC80wDQYJKoZIhvcNAQEFBQADggEBAFxKLjiLkMLkUmdpsAzJad/t7Jo/
-  CGby/3n0WSXPBeZJfsnSdJ2qtG7iy/xqYDc1RjpKgX0RlMgeQRSE3ZDL/HZzBKDF
-  azaTgG9Zk1Quu59/79Z0Sltq07Z/IeccFl5j9M+1YS8VY2mOPi9g03OoOSRmhsMS
-  wpEF+zvJ0ESS5OPjtp6Sk4q1QYc0aVIthEznuVNMW6CPpTNhMAOFMaTC5AXCzJ3Q
-  52G9HuhbVSTgE/I10H9qZBOE3qdP8ka/Fk0PUrux/DuUanNZgSKJokrQvRA4H9Au
-  WpPA7HJYV6msWQiukoBEhfQ2l6Fl2HUwntvX3MCcFNHeJJ5ETERp9alo88E=
+  m3ZsDWrNC80wDQYJKoZIhvcNAQEFBQADggEBAH//VnNBPm1b6MCuqaLLkulf2rqq
+  7P8OY517doHl3uDKBeAvG0ufJ1Hk3yDCaoSnkP+JlpF3bPA9VFO/omKEMOLcEKEC
+  9X6kFHhGo2jTRBAwaJ3OXvsm5bi5ZE0oivVh/QXpNOkLM+hqozLjquXrZ8la5KL8
+  jv7OM8j53TJA004uwxjuVK+nEqiril93acOe2tKdDedd0Qb0KrObFYY/en6OV92h
+  bn56+Lu22lsUMYD62lUEdAPyYn1/JLPfq47UEuV1p5gy/f++aTxknsAYE/z/bfmO
+  EkIxoeESVQ0Kqhp754GWYv3Sfmtyk8UbGo5XCZHzvC6h2G7mplPzh6o+Edw=
   -----END CERTIFICATE-----
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2017-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -56,20 +56,6 @@ dependencies:
     - - "!="
       - !ruby/object:Gem::Version
         version: 2.12.0
-- !ruby/object:Gem::Dependency
-  name: builder
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -84,7 +70,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-description: RSpec results that Hudson can read.
+description: RSpec results that your continuous integration service can read.
 email: sj26@sj26.com
 executables: []
 extensions: []
@@ -107,15 +93,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: 2.0.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: RSpec JUnit XML formatter