rspec_junit_formatter 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a808950ca0ea8273d57ec14b76e0f33326f2cf473708c8809ce7f80d5daef1f
-  data.tar.gz: 724eb19bbed6395719c2791f5661a80f5ece271bf85eb44a1d864a883f06edde
+  metadata.gz: 86651a64a7f810497cc1958b49c285df2aea4d912e3ad9d2cc59a791902fef4c
+  data.tar.gz: e90928c8f44a31a0dfe16344200aabede4e9b11af848de063f4786ba05feb64f
 SHA512:
-  metadata.gz: 9bf5b02431be19674c48a308132008bdd93d1619a1efadd197009cd67c150984cdefc918f73209535a936f53dd3847b677c9f1c4823a181cc4e18e5f33411c27
-  data.tar.gz: db0d242d4eaf205bc38c795f2313a29306d8bdc82218940058929d215a5c7650a22406406bcdd9a585b0793cfa862f62302716f21d498270116625e991b0e871
+  metadata.gz: c3620be8b07588d2acd5feaf5e9f795b1c4096dbf029875518084709dc70c057c1abf5c0deaed9beec954d0ff41dc11a4c36bfea404a735648bed11bde79c458
+  data.tar.gz: 869977b6c8a97bbf1f2ba08706249463e80260e92c84fd72f4feb0a45ae882214a29430ad4f344cfb7ed5b23373a540ee99ce4729ae7e2ad3dcf01e6cdba9d3c

data/README.md

@@ -11,24 +11,10 @@
   [circleci-junit]: https://circleci.com/docs/2.0/collect-test-data/
   [gitlab-junit]: https://docs.gitlab.com/ee/ci/unit_test_reports.html#ruby-example
 
-## Supported versions and legacy upgrades
-
-**0.7.0 requires Ruby >= 3.3 and RSpec >= 3.13, < 4.** We support upstream-maintained stable Ruby branches, including security maintenance, and the maintained stable RSpec minor series. As of October 2026, [Ruby 3.3 is security-maintained and Ruby 3.4/4.0 are normally maintained](https://www.ruby-lang.org/en/downloads/branches/). [RSpec supports only the latest major/minor pair](https://rspec.info/blog/2024/11/introducing-the-monorepo/), currently 3.13; RSpec 4 prereleases are not supported. Future minor releases may raise these minimums when upstream maintenance ends.
-
-**[0.6.2](https://rubygems.org/gems/rspec_junit_formatter/versions/0.6.2) is the final legacy-compatible release.** It retains Ruby >= 2.3 and RSpec >= 2, < 4 (except 2.12.0), including the encoding and aggregate failure fixes. See its [compatibility table](https://github.com/sj26/rspec_junit_formatter/blob/v0.6.2/README.md#tested-versus-permitted-versions) for tested combinations and limitations. It does not make end-of-life Ruby or RSpec versions maintained again.
-
-If you must keep an older Ruby **or** an older RSpec, use:
-
-```ruby
-gem "rspec_junit_formatter", "0.6.2", require: false
-```
-
-Then run `bundle update rspec_junit_formatter`. Without Bundler, use `gem install rspec_junit_formatter -v 0.6.2`. Upgrading Ruby alone is not enough if your project must keep an older RSpec.
-
-To use 0.7.0, upgrade Ruby to a maintained version and RSpec to 3.13, remove the legacy formatter pin, and run `bundle update rspec rspec_junit_formatter`. Both Ruby and `rspec-core` requirements are recorded in the package so dependency resolution can retain 0.6.2 for older environments.
-
 ## 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
@@ -80,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
 
@@ -115,109 +141,21 @@ Note that this example captures all output from every example all the time, pote
 
   [xml-charsets]: https://www.w3.org/TR/xml/#charsets
 
-## Development
-
-Use Ruby 3.4 (see [`.ruby-version`](.ruby-version)) for maintenance. This selects the development Ruby; the installed gem's minimum is defined in the [gemspec](rspec_junit_formatter.gemspec).
-
-Install the Bundler version recorded in `Gemfile.lock`, then test the locked development bundle:
-
-```sh
-gem install bundler -v 4.0.23
-bundle install
-bundle exec rake spec
-```
+## Supported versions and legacy upgrades
 
-The [development workflow](.github/workflows/development.yml) tests this bundle separately from the [compatibility workflow](.github/workflows/ci.yml). Use `bundle update --all` to refresh the development lockfile.
+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.
 
-The supported RSpec series is also defined by [Appraisal][appraisal], with a separate Gemfile to test dependency resolution without the root lockfile:
+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:
 
-```sh
-BUNDLE_GEMFILE=gemfiles/rspec_3_13.gemfile bundle install
-BUNDLE_GEMFILE=gemfiles/rspec_3_13.gemfile bundle exec rake spec
+```ruby
+gem "rspec_junit_formatter", "0.6.2", require: false
 ```
 
-Plain `bundle exec rake` also runs the Appraisals outside CI.
+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).
 
-  [appraisal]: https://github.com/thoughtbot/appraisal
+## Contributing
 
-### Tested versus permitted versions
-
-The [gemspec](rspec_junit_formatter.gemspec) permits Ruby >= 3.3 and `rspec-core` >= 3.13, < 4. These requirements allow installation; future versions are not automatically tested or supported.
-
-The CI workflows test these combinations:
-
-| Ruby | RSpec | Bundle |
-| --- | --- | --- |
-| 3.3, 3.4 and 4.0 | 3.13, latest patch | Appraisal |
-| 3.3, 3.4 and 4.0 | 3.13, pinned by `Gemfile.lock` | Development |
-
-CI selects the latest patch of each listed Ruby branch. The locked bundle currently uses RSpec 3.13.2 and rspec-core 3.13.6. Older Ruby and RSpec combinations remain available in [0.6.2](https://github.com/sj26/rspec_junit_formatter/tree/v0.6.2), not in the current test matrix.
-
-## Releasing
-
-Releases use the [Release workflow](https://github.com/sj26/rspec_junit_formatter/actions/workflows/release.yml)
-and [RubyGems trusted publishing](https://guides.rubygems.org/trusted-publishing/).
-GitHub Actions builds **unsigned gems**: it needs no personal signing key, persistent
-RubyGems API key, or maintainer machine. Local `bundle exec rake build`, `install`,
-and `release` tasks remain available; local releases may retain the maintainer's
-traditional gem signatures. Do not publish the same version through both paths.
-
-1. Bump the gemspec version and update the changelog in a reviewed PR. Merge it
-   into `main`. Use a new stable `X.Y.Z` version; never reuse a published version.
-2. Tag that exact commit as `vX.Y.Z` and push the tag. Record its full commit SHA
-   with `git rev-parse 'vX.Y.Z^{commit}'`. Pushing a tag alone does not publish.
-3. Run the Release workflow **from `main`**, supplying the tag and full SHA. Leave
-   `publish` unchecked for validation only. It checks tag/version/commit agreement
-   and main ancestry, runs the compatibility and development suites at that SHA,
-   builds the gem, rejects embedded signatures, and tests a clean installation
-   outside the checkout. PRs also exercise the package build/install check, but
-   their artifacts can never be published by this workflow.
-4. Run again with the same tag and SHA and `publish` checked. After the checks pass,
-   review the commit and package SHA-256 in the build log, then approve the
-   `release` environment deployment. Sam can approve his own run. The publish job
-   downloads that run's exact immutable artifact, uses short-lived OIDC credentials,
-   and does not check out or build project code.
-5. The workflow verifies that RubyGems serves identical bytes before publishing a
-   GitHub release with the same gem. Check both the
-   [RubyGems version](https://rubygems.org/gems/rspec_junit_formatter/versions) and
-   [GitHub release](https://github.com/sj26/rspec_junit_formatter/releases).
-
-### One-time configuration
-
-The GitHub `release` environment must require approval by `sj26`, allow
-self-approval, disable admin bypass, and allow deployments only from the `main`
-branch. The **Immutable release tags** repository ruleset blocks updates and
-deletion of `v*` tags, with no bypass actors. Under the existing gem's
-**Trusted publishers** on RubyGems, configure:
-
-| Field | Value |
-| --- | --- |
-| Repository owner | `sj26` |
-| Repository name | `rspec_junit_formatter` |
-| Workflow filename | `release.yml` |
-| Environment | `release` |
-
-Leave reusable-workflow repository fields blank. This workflow grants
-`id-token: write` only to the environment-protected publish job. Do not add a
-RubyGems API key or personal signing key to repository secrets.
-
-### Recovery
-
-Release runs are serialized and never auto-cancel an active publication. If a
-push succeeds but a later step fails, **re-run failed jobs in the original run**
-while its `release-gem` artifact is retained (30 days). This reuses the validated
-bytes and requires environment approval again. An existing RubyGems version is
-accepted only if its SHA-256 matches, and its downloaded bytes must also match.
-An incomplete GitHub draft can resume; an existing asset must match byte-for-byte
-and is never overwritten. A published GitHub release missing its gem fails closed
-and needs manual inspection rather than silently changing a public release.
-
-If the tag moved, a digest differs, or the original artifact expired, stop and
-investigate. Do not delete/recreate tags, yank/re-push gems, or overwrite release
-assets to force a retry. A fresh run rebuilds and is safe only if it reproduces
-the same bytes; otherwise recover the original artifact or use a new version
-through the normal review process. Validation-only runs do not test OIDC exchange
-or publication; only a real, explicitly approved new release can prove those paths.
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development, testing and release instructions.
 
 ## License
 

data/lib/rspec_junit_formatter/rspec3.rb

@@ -85,11 +85,13 @@ private
   def failure_for(notification)
     exception = exception_for(notification)
 
-    if aggregate_failure?(exception)
+    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)

data/lib/rspec_junit_formatter.rb

@@ -11,10 +11,20 @@ require "rspec/core/formatters/base_formatter"
 class RSpecJUnitFormatter < RSpec::Core::Formatters::BaseFormatter
 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}"}
@@ -162,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, invalid: :replace, undef: :replace, replace: "\uFFFD").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
@@ -180,7 +194,9 @@ 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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_junit_formatter
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Samuel Cochran