Add feature to generate JUnit XML output #720
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@Morriar I think I've responded to all of your feedback; I usually leave clicking "Resolve" for the reviewer so they can confirm the change first; let me know if you have a different preference. |
|
@Morriar Would you be able to trigger workflows and re-review? |
This is particularly useful when integrating Sorbet into CI builds running on Jenkins so that Jenkins can display the output as specific failures.
Co-authored-by: Alexandre Terrasa <583144+Morriar@users.noreply.github.com>
|
@Morriar I think all of your feedback is resolved now, and I've rebased on main. |
Morriar
approved these changes
Apr 24, 2025
Morriar
reviewed
Apr 24, 2025
| @@ -11,6 +13,36 @@ class << self | |||
| def sort_errors_by_code(errors) | |||
| errors.sort_by { |e| [e.code, e.file, e.line, e.message] } | |||
| end | |||
|
|
|||
| def to_junit_xml(errors, path:) | |||
There was a problem hiding this comment.
You'll need to add a signature to this method:
Suggested change
| def to_junit_xml(errors, path:) | |
| #: (Array[Error], path: String) | |
| def to_junit_xml(errors, path:) |
But thinking about it more I think this method should return the REXML::Document considering it's name and writing to the file should be done in the client.
So:
Suggested change
| def to_junit_xml(errors, path:) | |
| #: (Array[Error]) -> REXML::Document | |
| def to_junit_xml(errors) |
| @@ -153,6 +185,34 @@ def <=>(other) | |||
| def to_s | |||
| "#{file}:#{line}: #{message} (#{code})" | |||
| end | |||
|
|
|||
| def to_junit_xml_element | |||
There was a problem hiding this comment.
Suggested change
| def to_junit_xml_element | |
| #: -> REXML::Element | |
| def to_junit_xml_element |
| @@ -37,6 +37,7 @@ Gem::Specification.new do |spec| | |||
| spec.add_dependency("rbi", ">= 0.3.1") | |||
| spec.add_dependency("sorbet-static-and-runtime", ">= 0.5.10187") | |||
| spec.add_dependency("thor", ">= 0.19.2") | |||
| spec.add_dependency("rexml") | |||
There was a problem hiding this comment.
Let's put a lower bound, possibly 3.2.6?
Suggested change
| spec.add_dependency("rexml") | |
| spec.add_dependency("rexml", ">= 3.2.6") |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
It's common to use the JUnit plugin on Jenkins to consume machine-readable output about the tests in your CI builds. For example, on our Ruby app tests we use the rspec_junit_formatter to output results from RSpec in a format that Jenkins can consume.
What
This PR adds JUnit style XML output as an option to Spoom so that running Sorbet in CI on Jenkins can output error information that can be displayed natively by Jenkins (and then, in turn, passed along to e.g. Github's interface).
With these changes Sorbet failures on a build look like this:
and a clean Sorbet build looks like this:
TODO
I'm happy to add docs for this feature as well, but I wanted to get initial review of the feature going sooner rather than later.