New option --display-only-failed for junit format #8050
Merged
Conversation
This file contains 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
bbatsov
reviewed
May 31, 2020
spec/rubocop/options_spec.rb
Outdated
| .to raise_error(RuboCop::OptionArgumentError) | ||
| end | ||
|
|
||
| it 'works if given with --format json' do |
There was a problem hiding this comment.
I guess you meant to write junit here.
bbatsov
reviewed
May 31, 2020
spec/rubocop/options_spec.rb
Outdated
| @@ -92,6 +92,8 @@ def abs(path) | |||
| This option applies to the previously | |||
| specified --format, or the default format | |||
| if no format is specified. | |||
| --display-only-failed Only output offense messages. Omit passing | |||
| cops. Only valid for --format junit | |||
|
I'm fine with the proposed change. I think it'd be a good idea to also mention it here https://docs.rubocop.org/rubocop/formatters.html#junit-style-formatter |
|
Corrected the two specific issues and updated the relevant documentation. I love this tool, @bbatsov, thank you! |
burnettk
force-pushed
the
add-display-only-failed-option-for-format-junit
branch
from
e839032
to
7600a3c
Compare
Speeds up test report processing for large codebases and helps address the sorts of concerns raised at mikian/rubocop-junit-formatter#18. Refactors file_finished method in junit_formatter.rb to reduce complexity. Fixes buggy error message when --disable-uncorrectable is run without --auto-correct, which I noticed because I added similar error messaging when you try to run --display-only-failed without --format junit Tests, CHANGELOG.md, doc updates, and help message updates to accompany new option.
burnettk
force-pushed
the
add-display-only-failed-option-for-format-junit
branch
from
7600a3c
to
b6f775a
Compare
bbatsov
reviewed
Jun 1, 2020
| @@ -242,7 +242,7 @@ The JSON structure is like the following example: | |||
| **Machine-parsable** | |||
|
|
|||
| The `junit` style formatter provides the JUnit formatting. | |||
| This formatter is based on [rubocop-junit-formatter gem](https://github.com/mikian/rubocop-junit-formatter). | |||
| This formatter is based on the [rubocop-junit-formatter gem](https://github.com/mikian/rubocop-junit-formatter). | |||
There was a problem hiding this comment.
You didn't make the same edit to the actual docs. There's no need to touch the markdown files - they will be removed as soon as we setup permanent redirects between the old docs site that used them (powered by RTD) and the new one (docs.rubocop.org).
|
Thanks for tackling this! I'll do the small doc change I mentioned myself. |
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.
Speeds up test report processing for large codebases and helps address
the sorts of concerns raised at
mikian/rubocop-junit-formatter#18.
In one case for me, this reduced the number of
testcasexml elements from 66,000 to 1, which made a material difference in terms of jenkins test report load times.Refactors file_finished method in junit_formatter.rb to reduce
complexity.
Fixes buggy error message when --disable-uncorrectable is run without
--auto-correct, which I noticed because I added similar error messaging
when you try to run --display-only-failed without --format junit.
Tests, CHANGELOG.md, and help message updates to accompany new option