Improve error message when working on instrumented classes #703
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
Godin
requested changes
Jun 27, 2018
| <h3>Non-functional Changes</h3> | ||
| <ul> | ||
| <li>Improved error message when already instrumented classes are used for | ||
| instrumentation or analysis. |
There was a problem hiding this comment.
Existing items consisting of one sentence use only one dot after link to GitHub.
| InstrSupport.assertNotInstrumented("run", "Foo"); | ||
| } | ||
|
|
||
| @Test(expected = IllegalStateException.class) | ||
| public void testAssertNotIntrumentedField() { | ||
| public void assertNotIntrumented_should_throw_exception_when_jacoco_data_field_is_present() { | ||
| InstrSupport.assertNotInstrumented("$jacocoData", "Foo"); |
There was a problem hiding this comment.
I think it worth to add assertion for message especially since its change originates from a user needs. In past we have examples of catching regressions thanks to assertions for error messages.
Godin
requested changes
Jun 27, 2018
| <ul> | ||
| <li>Improved error message when already instrumented classes are used for | ||
| instrumentation or analysis. | ||
| (GitHub <a href="https://github.com/jacoco/jacoco/issues/700">#700</a>).</li> |
There was a problem hiding this comment.
As we discussed in #668 (comment) - existing links point to PRs, not on original issue.
|
@Godin Thanks for the review. I hope I addressed your issues. |
Godin
approved these changes
Jun 27, 2018
|
@marchof Perfect! Thank you! 👍 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The instrumentation and analysis process expects original, uninstrumented classes. This seems to be a common configuration issue - see #700. Therefore the error message should be improved to be more helpful:
Cannot process instrumented class X. Please supply original non-instrumented classes.