rspec_junit_formatter 0.4.0.pre → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ad7496b872a273636e473effb145427f2cf66d94
-  data.tar.gz: b61510be2cfa388a7d450937f8bfb3f75b7c1ee1
+SHA256:
+  metadata.gz: ea46534b4275bee49fd9211ab8d702273475b2cf8ae6ec6fadf70242036b47a6
+  data.tar.gz: 1095a37248d6a758198fc605ff5306efa200051d8b1526ded3b70642169a9bc6
 SHA512:
-  metadata.gz: 18f054c82f287d788bfe67b6288f697bfdcfd2d9e568425c4443b8a507ac37e6e00f190c1f7c7bf6ca3a371d2a31c29dbc1f88ea0347b002c0daa609e596a8c8
-  data.tar.gz: d0ec6791a67eb4c740e12850d95cc13487d107bea68ae6875a4d430da13a426dd3422e60cd79129c86ecad668f453b352fb575b2e1ded75dab406ac6db41bc0a
+  metadata.gz: 87a3d85fa44c45b8721b65115636a1d3eaf53dde58077aeb1d37417136350440edf0a1e20b3260604a7135482b710f45a25ed8853755f1bf3c9ca255ab47ef52
+  data.tar.gz: '09b6904589c20fdff3470e7a243b2d018d283fff53cacc60f7c9f6a646506e2c3148e6aa08e825acf56dd4c453a0bca14d9177f6648cb5a17087dfa1fa272ada'

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Samuel Cochran
+Copyright (c) 2011-2022 Samuel Cochran
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,11 +1,15 @@
 # RSpec JUnit Formatter
 
-[![Build results](http://img.shields.io/travis/sj26/rspec_junit_formatter/master.svg)](https://travis-ci.org/sj26/rspec_junit_formatter) 
+[![Build results](https://github.com/sj26/rspec_junit_formatter/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/sj26/rspec_junit_formatter/actions/workflows/ci.yml?branch=main) 
 [![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 services, too.
+[RSpec][rspec] 2 & 3 results that your CI can read. [Jenkins][jenkins-junit], [Buildkite][buildkite-junit], [CircleCI][circleci-junit], [Gitlab][gitlab-junit], and probably more, too.
 
-Inspired by the work of [Diego Souza][dgvncsz0f] on [RSpec Formatters][dgvncsz0f/rspec_formatters] after frustration with [CI Reporter][ci_reporter].
+  [rspec]: http://rspec.info/
+  [jenkins-junit]: https://jenkins.io/doc/pipeline/steps/junit/
+  [buildkite-junit]: https://github.com/buildkite/rspec-junit-example
+  [circleci-junit]: https://circleci.com/docs/2.0/collect-test-data/
+  [gitlab-junit]: https://docs.gitlab.com/ee/ci/junit_test_reports.html#ruby-example
 
 ## Usage
 
@@ -29,6 +33,8 @@ You can use it in combination with other [formatters][rspec-formatters], too:
 rspec --format progress --format RspecJunitFormatter --out rspec.xml
 ```
 
+  [rspec-formatters]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/formatters
+
 ### 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.
@@ -46,6 +52,8 @@ Put the same arguments as the commands above in [your `.rspec`][rspec-file]:
 --format RspecJunitFormatter
 --out rspec.xml
 ```
+  [bundler]: https://bundler.io
+  [rspec-file]: https://relishapp.com/rspec/rspec-core/v/3-6/docs/configuration/read-command-line-configuration-options-from-files
 
 ### Parallel tests
 
@@ -58,31 +66,56 @@ 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.
 
+### Capturing output
+
+If you like, you can capture the standard output and error streams of each test into the `:stdout` and `:stderr` example metadata which will be added to the junit report, e.g.:
+
+```ruby
+# spec_helper.rb
+
+RSpec.configure do |config|
+  # register around filter that captures stdout and stderr
+  config.around(:each) do |example|
+    $stdout = StringIO.new
+    $stderr = StringIO.new
+
+    example.run
+
+    example.metadata[:stdout] = $stdout.string
+    example.metadata[:stderr] = $stderr.string
+
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+end
+```
+
+Note that this example captures all output from every example all the time, potentially interfering with local debugging. You might like to restrict this to only on CI, or by using [rspec filters](https://relishapp.com/rspec/rspec-core/docs/hooks/filters).
+
 ## 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`.
+ * 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`.
+
+  [xml-charsets]: https://www.w3.org/TR/xml/#charsets
+
+## Development
+
+Run the specs with `bundle exec rake`, which uses [Appraisal][appraisal] to run the specs against all supported versions of rspec.
+
+  [appraisal]: https://github.com/thoughtbot/appraisal
 
-## Roadmap
+## Releasing
 
- * 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.
+Bump the gem version in the gemspec, and commit. Then `bundle exec rake build` to build a gem package, `bundle exec rake install` to install and test it locally, then `bundle exec rake release` to tag and push the commits and gem.
 
 ## License
 
-The MIT License, see [LICENSE][license].
+The MIT License, see [LICENSE](./LICENSE).
+
+## Thanks
+
+Inspired by the work of [Diego Souza][dgvncsz0f] on [RSpec Formatters][dgvncsz0f/rspec_formatters] after frustration with [CI Reporter][ci_reporter].
 
-  [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
   [ci_reporter]: https://github.com/nicksieger/ci_reporter
-  [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/rspec2.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class RSpecJUnitFormatter < RSpec::Core::Formatters::BaseFormatter
   attr_reader :started
 
@@ -47,18 +49,23 @@ private
   end
 
   def failure_message_for(example)
-    exception_for(example).to_s
+    strip_diff_colors(exception_for(example).to_s)
   end
 
   def failure_for(example)
     exception = exception_for(example)
+    message   = strip_diff_colors(exception.message)
     backtrace = format_backtrace(exception.backtrace, example)
 
     if shared_group = find_shared_group(example)
       backtrace << "Shared Example Group: \"#{shared_group.metadata[:shared_group_name]}\" called from #{shared_group.metadata[:example_group][:location]}"
     end
 
-    "#{exception.message}\n#{backtrace.join("\n")}"
+    "#{message}\n#{backtrace.join("\n")}"
+  end
+
+  def error_count
+    0
   end
 
   def find_shared_group(example)
@@ -68,4 +75,12 @@ private
   def group_and_parent_groups(example)
     example.example_group.parent_groups + [example.example_group]
   end
+
+  def stdout_for(example)
+    example.metadata[:stdout]
+  end
+
+  def stderr_for(example)
+    example.metadata[:stderr]
+  end
 end

data/lib/rspec_junit_formatter/rspec3.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class RSpecJUnitFormatter < RSpec::Core::Formatters::BaseFormatter
   RSpec::Core::Formatters.register self,
     :start,
@@ -43,6 +45,15 @@ private
     @examples_notification.notifications
   end
 
+  def error_count
+    # Introduced in rspec 3.6
+    if @summary_notification.respond_to?(:errors_outside_of_examples_count)
+      @summary_notification.errors_outside_of_examples_count
+    else
+      0
+    end
+  end
+
   def result_of(notification)
     notification.example.execution_result.status
   end
@@ -84,47 +95,52 @@ private
     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
-
-  # Completely gross hack for forcing off colorising
-  if Gem::Version.new(RSpec::Core::Version::STRING) >= Gem::Version.new("3.6")
-    WITHOUT_COLOR_KEY = :color_mode
-    WITHOUT_COLOR_VALUE = :off
-  else
-    WITHOUT_COLOR_KEY = :color
-    WITHOUT_COLOR_VALUE = false
-  end
-  def without_color
+  # rspec makes it really difficult to swap in configuration temporarily due to
+  # the way it cascades defaults, command line arguments, and user
+  # configuration. This method makes sure configuration gets swapped in
+  # correctly, but also that the original state is definitely restored.
+  def swap_rspec_configuration(key, value)
     unset = Object.new
-    force = RSpec.configuration.send(:value_for, WITHOUT_COLOR_KEY) { unset }
+    force = RSpec.configuration.send(:value_for, key) { unset }
     if unset.equal?(force)
-      previous = RSpec.configuration.send(WITHOUT_COLOR_KEY)
-      RSpec.configuration.send(:"#{WITHOUT_COLOR_KEY}=", WITHOUT_COLOR_VALUE)
+      previous = RSpec.configuration.send(key)
+      RSpec.configuration.send(:"#{key}=", value)
     else
-      RSpec.configuration.force({WITHOUT_COLOR_KEY => WITHOUT_COLOR_VALUE})
+      RSpec.configuration.force({key => value})
     end
     yield
   ensure
     if unset.equal?(force)
-      RSpec.configuration.send(:"#{WITHOUT_COLOR_KEY}=", previous)
+      RSpec.configuration.send(:"#{key}=", previous)
     else
-      RSpec.configuration.force({WITHOUT_COLOR_KEY => force})
+      RSpec.configuration.force({key => force})
     end
   end
+
+  # Completely gross hack for absolutely forcing off colorising for the
+  # duration of a block.
+  if RSpec.configuration.respond_to?(:color_mode=)
+    def without_color(&block)
+      swap_rspec_configuration(:color_mode, :off, &block)
+    end
+  elsif RSpec.configuration.respond_to?(:color=)
+    def without_color(&block)
+      swap_rspec_configuration(:color, false, &block)
+    end
+  else
+    warn 'rspec_junit_formatter cannot prevent colorising due to an unexpected RSpec.configuration format'
+    def without_color
+      yield
+    end
+  end
+
+  def stdout_for(example_notification)
+    example_notification.example.metadata[:stdout]
+  end
+
+  def stderr_for(example_notification)
+    example_notification.example.metadata[:stderr]
+  end
 end
 
 # rspec-core 3.0.x forgot to mark this as a module function which causes:

data/lib/rspec_junit_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "socket"
 require "time"
 
@@ -18,7 +20,7 @@ private
     output << %{ tests="#{example_count}"}
     output << %{ skipped="#{pending_count}"}
     output << %{ failures="#{failure_count}"}
-    output << %{ errors="0"}
+    output << %{ errors="#{error_count}"}
     output << %{ time="#{escape("%.6f" % duration)}"}
     output << %{ timestamp="#{escape(started.iso8601)}"}
     output << %{ hostname="#{escape(Socket.gethostname)}"}
@@ -71,12 +73,27 @@ private
     output << %{ time="#{escape("%.6f" % duration_for(example))}"}
     output << %{>}
     yield if block_given?
+    xml_dump_output(example)
     output << %{</testcase>\n}
   end
 
+  def xml_dump_output(example)
+    if (stdout = stdout_for(example)) && !stdout.empty?
+      output << %{<system-out>}
+      output << escape(stdout)
+      output << %{</system-out>}
+    end
+
+    if (stderr = stderr_for(example)) && !stderr.empty?
+      output << %{<system-err>}
+      output << escape(stderr)
+      output << %{</system-err>}
+    end
+  end
+
   # Inversion of character range from https://www.w3.org/TR/xml/#charsets
   ILLEGAL_REGEXP = Regexp.new(
-    "[^" <<
+    +"[^" <<
     "\u{9}" << # => \t
     "\u{a}" << # => \n
     "\u{d}" << # => \r
@@ -108,7 +125,7 @@ private
   # Discouraged characters from https://www.w3.org/TR/xml/#charsets
   # Plus special characters with well-known entity replacements
   DISCOURAGED_REGEXP = Regexp.new(
-    "[" <<
+    +"[" <<
     "\u{22}" << # => "
     "\u{26}" << # => &
     "\u{27}" << # => '
@@ -149,6 +166,22 @@ private
     # Make sure it's utf-8, replace illegal characters with ruby-like escapes, and replace special and discouraged characters with entities
     text.to_s.encode(Encoding::UTF_8).gsub(ILLEGAL_REGEXP, ILLEGAL_REPLACEMENT).gsub(DISCOURAGED_REGEXP, DISCOURAGED_REPLACEMENTS)
   end
+
+  STRIP_DIFF_COLORS_BLOCK_REGEXP = /^ ( [ ]* ) Diff: (?: \e\[ 0 m )? (?: \n \1 \e\[ \d+ (?: ; \d+ )* m .* )* /x
+  STRIP_DIFF_COLORS_CODES_REGEXP = /\e\[ \d+ (?: ; \d+ )* m/x
+
+  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
 
 RspecJunitFormatter = RSpecJUnitFormatter

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: rspec_junit_formatter
 version: !ruby/object:Gem::Version
-  version: 0.4.0.pre
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Cochran
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDKDCCAhCgAwIBAgIBBTANBgkqhkiG9w0BAQUFADA6MQ0wCwYDVQQDDARzajI2
-  MRQwEgYKCZImiZPyLGQBGRYEc2oyNjETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0x
-  NzA3MzEwNTQ3MDVaFw0xODA3MzEwNTQ3MDVaMDoxDTALBgNVBAMMBHNqMjYxFDAS
+  MIIDKDCCAhCgAwIBAgIBCDANBgkqhkiG9w0BAQsFADA6MQ0wCwYDVQQDDARzajI2
+  MRQwEgYKCZImiZPyLGQBGRYEc2oyNjETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0y
+  MTA0MjcwMzIxMjZaFw0yMjA0MjcwMzIxMjZaMDoxDTALBgNVBAMMBHNqMjYxFDAS
   BgoJkiaJk/IsZAEZFgRzajI2MRMwEQYKCZImiZPyLGQBGRYDY29tMIIBIjANBgkq
   hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsr60Eo/ttCk8GMTMFiPr3GoYMIMFvLak
   xSmTk9YGCB6UiEePB4THSSA5w6IPyeaCF/nWkDp3/BAam0eZMWG1IzYQB23TqIM0
@@ -21,14 +21,14 @@ cert_chain:
   4O/FL2ChjL2CPCpLZW55ShYyrzphWJwLOJe+FJ/ZBl6YXwrzQM9HKnt4titSNvyU
   KzE3L63A3PZvExzLrN9u09kuWLLJfXB2sGOlw3n9t72rJiuBr3/OQQIDAQABozkw
   NzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU99dfRjEKFyczTeIz
-  m3ZsDWrNC80wDQYJKoZIhvcNAQEFBQADggEBADGiXpvK754s0zTFx3y31ZRDdvAI
-  lA209JIjUlDyr9ptCRadihyfF2l9/hb+hLemiPEYppzG6vEK1TIyzbAR36yOJ8CX
-  4vPkCXLuwHhs6UIRbwN+IEy41nsIlBxmjLYei8h3t/G2Vm2oOaLdbjDXS+Srl9U8
-  shsE8ft81PxSQfzEL7Mr9cC9XvWbHW+SyTpfGm8rAtaqZkNeke4U8a0di4oz2EfA
-  P4lSfmXxsd1C71ckIp0cyXkPhyTtpyS/5hq9HhuUNzEHkSDe36/Rd1xYKV5JxMC2
-  YAttWFUs06lor2q1wwncPaMtUtbWwW35+1IV6xhs2rFY6DD/I6ZkK3GnHdY=
+  m3ZsDWrNC80wDQYJKoZIhvcNAQELBQADggEBAInkmTwBeGEJ7Xu9jjZIuFaE197m
+  YfvrzVoE6Q1DlWXpgyhhxbPIKg2acvM/Z18A7kQrF7paYl64Ti84dC64seOFIBNx
+  Qj/lxzPHMBoAYqeXYJhnYIXnvGCZ4Fkic5Bhs+VdcDP/uwYp3adqy+4bT/XDFZQg
+  tSjrAOTg3wck5aI+Tz90ONQJ83bnCRr1UPQ0T3PbWMjnNsEa9CAxUB845Sg+9yUz
+  Tvf+pbX8JT9rawFDogxPhL7eRAbjg4MH9amp5l8HTVCAsW8vqv7wM4rtMNAaXmik
+  LJghfDEf70fTtbs4Zv57pPhn1b7wBNf8fh+TZOlYAA6dFtQXoCwfE6bWgQU=
   -----END CERTIFICATE-----
-date: 2017-12-05 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -56,20 +56,82 @@ dependencies:
     - - "!="
       - !ruby/object:Gem::Version
         version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: RSpec results that your continuous integration service can read.
 email: sj26@sj26.com
 executables: []
@@ -81,11 +143,12 @@ files:
 - lib/rspec_junit_formatter.rb
 - lib/rspec_junit_formatter/rspec2.rb
 - lib/rspec_junit_formatter/rspec3.rb
-homepage: http://github.com/sj26/rspec_junit_formatter
+homepage: https://github.com/sj26/rspec_junit_formatter
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  changelog_uri: https://github.com/sj26/rspec_junit_formatter/blob/HEAD/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -100,9 +163,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.2.26
+signing_key:
 specification_version: 4
 summary: RSpec JUnit XML formatter
 test_files: []