rspec_junit_formatter 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 903f156687c6fff260143332222e9950fca53b5306bcde7cf197c44f3af4acf7
-  data.tar.gz: 1d2ffca113b3cd78b3230d66ed41268609ce38f06e50da6cd196af9073670500
+  metadata.gz: 86651a64a7f810497cc1958b49c285df2aea4d912e3ad9d2cc59a791902fef4c
+  data.tar.gz: e90928c8f44a31a0dfe16344200aabede4e9b11af848de063f4786ba05feb64f
 SHA512:
-  metadata.gz: f8d32b7a3b5dec828fe29c714755b3698ad8a48b1cfc92185b6f53e5eb4a6ab47adae5cb74743cbc6b5814d0a5d61d15d49b632aadd5afdede74820628796687
-  data.tar.gz: 76537f5a365796f1e062cbfde157f8f48c163b7973ae6a1faae533cbf4684bd3c29cd26d6cb344eac8c46c0ae950f854b48f21bbf2bd28bfbf2ebab6e12b639e
+  metadata.gz: c3620be8b07588d2acd5feaf5e9f795b1c4096dbf029875518084709dc70c057c1abf5c0deaed9beec954d0ff41dc11a4c36bfea404a735648bed11bde79c458
+  data.tar.gz: 869977b6c8a97bbf1f2ba08706249463e80260e92c84fd72f4feb0a45ae882214a29430ad4f344cfb7ed5b23373a540ee99ce4729ae7e2ad3dcf01e6cdba9d3c

data/README.md

@@ -3,7 +3,7 @@
 [![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 your CI can read. [Jenkins][jenkins-junit], [Buildkite][buildkite-junit], [CircleCI][circleci-junit], [Gitlab][gitlab-junit], and probably more, too.
+[RSpec][rspec] 3 results that your CI can read. [Jenkins][jenkins-junit], [Buildkite][buildkite-junit], [CircleCI][circleci-junit], [Gitlab][gitlab-junit], and probably more, too.
 
   [rspec]: http://rspec.info/
   [jenkins-junit]: https://jenkins.io/doc/pipeline/steps/junit/
@@ -13,6 +13,8 @@
 
 ## Usage
 
+Requires Ruby >= 3.3 and RSpec >= 3.13, < 4. For older versions, see [legacy support](#supported-versions-and-legacy-upgrades).
+
 Install the gem:
 
 ```sh
@@ -33,7 +35,7 @@ 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
+  [rspec-formatters]: https://rspec.info/features/3-12/rspec-core/formatters/
 
 ### Using in your project with Bundler
 
@@ -42,7 +44,7 @@ Add it to your Gemfile if you're using [Bundler][bundler]. Put it in the same gr
 ```ruby
 group :test do
   gem "rspec"
-  gem "rspec_junit_formatter"
+  gem "rspec_junit_formatter", require: false
 end
 ```
 
@@ -53,7 +55,7 @@ Put the same arguments as the commands above in [your `.rspec`][rspec-file]:
 --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
+  [rspec-file]: https://rspec.info/features/3-12/rspec-core/configuration/read-options-from-file/
 
 ### Parallel tests
 
@@ -64,7 +66,47 @@ For use with `parallel_tests`, add `$TEST_ENV_NUMBER` in the output file option
 --out tmp/rspec<%= ENV["TEST_ENV_NUMBER"] %>.xml
 ```
 
-The formatter includes `$TEST_ENV_NUMBER` in the test suite name within the XML, too.
+The formatter appends `$TEST_ENV_NUMBER` to the test suite name within the XML, too.
+An explicitly set value always wins, including the empty string that `parallel_tests`
+uses for its first worker: `TEST_ENV_NUMBER=""` keeps the name `rspec`.
+
+When `TEST_ENV_NUMBER` is **unset**, the formatter uses the first non-empty value
+from this table, in order:
+
+| Variable | Provider | Native first index |
+| --- | --- | --- |
+| `CI_NODE_INDEX` | [GitLab](https://docs.gitlab.com/ci/variables/predefined_variables/), or a user-supplied CI label | `1` on GitLab |
+| `CIRCLE_NODE_INDEX` | [CircleCI](https://circleci.com/docs/reference/variables/#built-in-environment-variables) | `0` |
+| `SEMAPHORE_JOB_INDEX` | [Semaphore](https://docs.semaphore.io/reference/env-vars#job-index) | `1` |
+| `BUILDKITE_PARALLEL_JOB` | [Buildkite](https://buildkite.com/docs/pipelines/configure/environment-variables#BUILDKITE_PARALLEL_JOB) | `0` |
+| `BITBUCKET_PARALLEL_STEP` | [Bitbucket Pipelines](https://support.atlassian.com/bitbucket-cloud/docs/parallel-step-options/) | `0` |
+
+Values are labels, not test-sharding offsets: they are XML-escaped but otherwise
+unchanged. For example, GitLab's `CI_NODE_INDEX=1` produces `rspec1`, while
+Buildkite's `BUILDKITE_PARALLEL_JOB=0` produces `rspec0`. There is no index
+conversion based on `GITLAB_CI`, and a custom `CI_NODE_INDEX` takes precedence over
+the other CI variables. If all these values are empty or unset, the name stays
+`rspec`; no default `0` is appended.
+
+The old `SEMAPHORE_CURRENT_THREAD` and `SNAP_WORKER_INDEX` variables are not
+detected: [Semaphore Classic was retired in 2023](https://semaphore.io/blog/semaphore-classic-deprecation)
+and [Snap CI in 2017](https://github.com/snap-ci/snap-ci-blog-content/blob/master/posts/2017-02-06-2017-02-06-snap-announcement.md).
+Other runners can set `TEST_ENV_NUMBER` explicitly.
+
+This changes **only the XML suite name**, not the output filename. Continue to
+choose distinct `--out` paths for processes sharing a filesystem. CI indexes are
+unique only within their parallel job group, not across steps, builds, or nested
+`parallel_tests` workers. To combine those reports, set an explicit label that
+includes each relevant dimension, and use it in the filename too. For example,
+inside each `parallel_tests` worker on Buildkite:
+
+```sh
+export TEST_ENV_NUMBER="-${BUILDKITE_STEP_KEY}-${BUILDKITE_PARALLEL_JOB}-${TEST_ENV_NUMBER}"
+bundle exec rspec --format RspecJunitFormatter --out "tmp/rspec${TEST_ENV_NUMBER}.xml"
+```
+
+Use distinct Buildkite step keys for this example; add a build identifier too if
+you combine reports across builds.
 
 ### Capturing output
 
@@ -90,23 +132,30 @@ RSpec.configure do |config|
 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).
+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://rspec.info/features/3-12/rspec-core/hooks/filtering/).
 
 ## 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`.
+ * When converting report text to UTF-8 for XML output, invalid byte sequences and characters with no UTF-8 conversion are replaced with `�` (U+FFFD REPLACEMENT CHARACTER). The formatter uses each string's declared encoding; it does not guess the encoding of binary data.
 
   [xml-charsets]: https://www.w3.org/TR/xml/#charsets
 
-## Development
+## Supported versions and legacy upgrades
 
-Run the specs with `bundle exec rake`, which uses [Appraisal][appraisal] to run the specs against all supported versions of rspec.
+We support [maintained Ruby versions](https://www.ruby-lang.org/en/downloads/branches/), including security maintenance, and [the current stable RSpec series](https://rspec.info/blog/2024/11/introducing-the-monorepo/). Minor releases may raise the minimum versions when upstream support ends.
+
+For Ruby < 3.3 or RSpec < 3.13, use [0.6.2](https://rubygems.org/gems/rspec_junit_formatter/versions/0.6.2), the final legacy release:
+
+```ruby
+gem "rspec_junit_formatter", "0.6.2", require: false
+```
 
-  [appraisal]: https://github.com/thoughtbot/appraisal
+Run `bundle update rspec_junit_formatter`, or install without Bundler using `gem install rspec_junit_formatter -v 0.6.2`. This release permits Ruby >= 2.3 and RSpec >= 2, < 4, except 2.12.0; see its [tested combinations](https://github.com/sj26/rspec_junit_formatter/blob/v0.6.2/README.md#tested-versus-permitted-versions).
 
-## Releasing
+## Contributing
 
-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.
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development, testing and release instructions.
 
 ## License
 

data/lib/rspec_junit_formatter/rspec3.rb

@@ -46,12 +46,7 @@ private
   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
+    @summary_notification.errors_outside_of_examples_count
   end
 
   def result_of(notification)
@@ -88,7 +83,15 @@ private
   end
 
   def failure_for(notification)
-    strip_diff_colors(notification.message_lines.join("\n")) << "\n" << notification.formatted_backtrace.join("\n")
+    exception = exception_for(notification)
+
+    details = if aggregate_failure?(exception)
+      strip_diff_colors(exception.message)
+    else
+      strip_diff_colors(notification.message_lines.join("\n")) << "\n" << notification.formatted_backtrace.join("\n")
+    end
+
+    details.gsub(/ +$/, '')
   end
 
   def exception_for(notification)
@@ -119,19 +122,8 @@ private
 
   # 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
+  def without_color(&block)
+    swap_rspec_configuration(:color_mode, :off, &block)
   end
 
   def stdout_for(example_notification)
@@ -141,18 +133,11 @@ private
   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:
-#
-#   NoMethodError: undefined method `wrap' for RSpec::Core::Notifications::NullColorizer:Class
-#     .../rspec-core-3.0.4/lib/rspec/core/notifications.rb:229:in `add_shared_group_line'
-#     .../rspec-core-3.0.4/lib/rspec/core/notifications.rb:157:in `message_lines'
-#
-if defined?(RSpec::Core::Notifications::NullColorizer) && RSpec::Core::Notifications::NullColorizer.is_a?(Class) && !RSpec::Core::Notifications::NullColorizer.respond_to?(:wrap)
-  RSpec::Core::Notifications::NullColorizer.class_eval do
-    def self.wrap(*args)
-      new.wrap(*args)
-    end
+  def aggregate_failure?(exception)
+    # rspec-expectations is optional; the formatter only depends on rspec-core.
+    return false unless defined?(RSpec::Expectations::MultipleExpectationsNotMetError)
+
+    exception.is_a?(RSpec::Expectations::MultipleExpectationsNotMetError)
   end
 end

data/lib/rspec_junit_formatter.rb

@@ -9,14 +9,22 @@ require "rspec/core/formatters/base_formatter"
 # Dumps rspec results as a JUnit XML file.
 # Based on XML schema: http://windyroad.org/dl/Open%20Source/JUnit.xsd
 class RSpecJUnitFormatter < RSpec::Core::Formatters::BaseFormatter
-  # rspec 2 and 3 implements are in separate files.
-
 private
 
+  def suite_name
+    # parallel_tests deliberately uses an empty label for its first worker.
+    suffix = ENV.fetch("TEST_ENV_NUMBER") do
+      %w[CI_NODE_INDEX CIRCLE_NODE_INDEX SEMAPHORE_JOB_INDEX
+         BUILDKITE_PARALLEL_JOB BITBUCKET_PARALLEL_STEP].map { |name| ENV[name] }.
+        find { |value| value && !value.empty? }
+    end
+    "rspec#{suffix}"
+  end
+
   def xml_dump
     output << %{<?xml version="1.0" encoding="UTF-8"?>\n}
     output << %{<testsuite}
-    output << %{ name="rspec#{escape(ENV["TEST_ENV_NUMBER"].to_s)}"}
+    output << %{ name="#{escape(suite_name)}"}
     output << %{ tests="#{example_count}"}
     output << %{ skipped="#{pending_count}"}
     output << %{ failures="#{failure_count}"}
@@ -164,9 +172,13 @@ private
     ?>.freeze => "&gt;".freeze,
   ).freeze
 
+  def utf8(text)
+    text.to_s.encode(Encoding::UTF_8, invalid: :replace, undef: :replace, replace: "\uFFFD")
+  end
+
   def escape(text)
     # 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)
+    utf8(text).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
@@ -182,14 +194,12 @@ private
     # 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) }
+    # Transcode before matching: the original message may be invalid or use an
+    # encoding incompatible with the ASCII regexp. Leave XML escaping until later.
+    utf8(string).sub(STRIP_DIFF_COLORS_BLOCK_REGEXP) { |match| match.gsub(STRIP_DIFF_COLORS_CODES_REGEXP, "".freeze) }
   end
 end
 
 RspecJunitFormatter = RSpecJUnitFormatter
 
-if Gem::Version.new(RSpec::Core::Version::STRING) >= Gem::Version.new("3")
-  require "rspec_junit_formatter/rspec3"
-else
-  require "rspec_junit_formatter/rspec2"
-end
+require "rspec_junit_formatter/rspec3"

metadata

@@ -1,35 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rspec_junit_formatter
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Samuel Cochran
-autorequire:
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDXDCCAkSgAwIBAgIBATANBgkqhkiG9w0BAQsFADA6MQ0wCwYDVQQDDARzajI2
-  MRQwEgYKCZImiZPyLGQBGRYEc2oyNjETMBEGCgmSJomT8ixkARkWA2NvbTAeFw0y
-  MjA3MDQwMDQwNDZaFw0yMzA3MDQwMDQwNDZaMDoxDTALBgNVBAMMBHNqMjYxFDAS
-  BgoJkiaJk/IsZAEZFgRzajI2MRMwEQYKCZImiZPyLGQBGRYDY29tMIIBIjANBgkq
-  hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsr60Eo/ttCk8GMTMFiPr3GoYMIMFvLak
-  xSmTk9YGCB6UiEePB4THSSA5w6IPyeaCF/nWkDp3/BAam0eZMWG1IzYQB23TqIM0
-  1xzcNRvFsn0aQoQ00k+sj+G83j3T5OOV5OZIlu8xAChMkQmiPd1NXc6uFv+Iacz7
-  kj+CMsI9YUFdNoU09QY0b+u+Rb6wDYdpyvN60YC30h0h1MeYbvYZJx/iZK4XY5zu
-  4O/FL2ChjL2CPCpLZW55ShYyrzphWJwLOJe+FJ/ZBl6YXwrzQM9HKnt4titSNvyU
-  KzE3L63A3PZvExzLrN9u09kuWLLJfXB2sGOlw3n9t72rJiuBr3/OQQIDAQABo20w
-  azAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU99dfRjEKFyczTeIz
-  m3ZsDWrNC80wGAYDVR0RBBEwD4ENc2oyNkBzajI2LmNvbTAYBgNVHRIEETAPgQ1z
-  ajI2QHNqMjYuY29tMA0GCSqGSIb3DQEBCwUAA4IBAQCsa7k3TABBcyXotr3yCq6f
-  xsgbMG9FR71c4wRgVNQi9O3jN64fQBbxo//BQlHfPCjs1CeU4es9xdQFfhqXAPXG
-  P7mK3+qd5jObjh6l3/rDKrTXNS+P+YO/1frlZ6xPjCA8XgGc4y0rhAjZnVBDV6t1
-  kmdtEmue1s1OxaMakr78XRZDxEuAeLM5fg8MYnlOFygEcAH6lZkTjXavY7s9MXRB
-  AAMioxgB6J5QhXQ42OSWIzwHZIbSv3DV9Lf5sde50HIW5f9u5jn29TUGDhSWYKkh
-  LDvy9dfwMMOdIZi75Q8SBBib84AuwhMHIlUv9FcHhh3dXsDDYkrVrpUAwCsG6yCm
-  -----END CERTIFICATE-----
-date: 2022-09-29 00:00:00.000000000 Z
+cert_chain: []
+date: 2026-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -37,26 +15,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.13'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 2.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3.13'
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +114,12 @@ files:
 - LICENSE
 - README.md
 - lib/rspec_junit_formatter.rb
-- lib/rspec_junit_formatter/rspec2.rb
 - lib/rspec_junit_formatter/rspec3.rb
 homepage: https://github.com/sj26/rspec_junit_formatter
 licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/sj26/rspec_junit_formatter/blob/HEAD/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -157,15 +127,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: RSpec JUnit XML formatter
 test_files: []

checksums.yaml.gz.sig

@@ -1 +0,0 @@
-��[h��bJ��9��$P�6��-�@V

data/lib/rspec_junit_formatter/rspec2.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-class RSpecJUnitFormatter < RSpec::Core::Formatters::BaseFormatter
-  attr_reader :started
-
-  def start(example_count)
-    @started = Time.now
-    super
-  end
-
-  def dump_summary(duration, example_count, failure_count, pending_count)
-    super
-    xml_dump
-  end
-
-private
-
-  def result_of(example)
-    example.execution_result[:status].to_sym
-  end
-
-  def example_group_file_path_for(example)
-    meta = example.metadata
-    while meta[:example_group]
-      meta = meta[:example_group]
-    end
-    meta[:file_path]
-  end
-
-  def classname_for(example)
-    fp = example_group_file_path_for(example)
-    fp.sub(%r{\.[^/.]+\Z}, "").gsub("/", ".").gsub(/\A\.+|\.+\Z/, "")
-  end
-
-  def duration_for(example)
-    example.execution_result[:run_time]
-  end
-
-  def description_for(example)
-    example.full_description
-  end
-
-  def exception_for(example)
-    example.execution_result[:exception]
-  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(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
-
-    "#{message}\n#{backtrace.join("\n")}"
-  end
-
-  def error_count
-    0
-  end
-
-  def find_shared_group(example)
-    group_and_parent_groups(example).find { |group| group.metadata[:shared_group_name] }
-  end
-
-  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.tar.gz.sig

@@ -1,2 +0,0 @@
-kb�u�(5����\���<F�,���u�vx��}-~rBFl���;k�;P�K1t��{<��4�rZ
+۱�H��"r��W�żi��q�ws�[����Z��T�E������D���_
-O9�&�Eh�R��:V�,����}����B
��