Allow having YamlTestExtension include method name in test names #3253
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
When publishing to JUnit xml style files there is no hierarchy, so
some tools will just show the class name and description, making it
hard to tell what tests were run, or failed. If YamlTestExtension
is used in an environment where that is the case this can be used
to have the output include the method name. For example:
- showcasingTests(Embedded)
- showcasingTests(MultiServer (Embedded then !current_version))
...
Instead of
- YamlIntegrationTests
- showcasingTests(Runner)
- Embedded
- MultiServer (Embedded then !current_version)
I thought about making this configurable via system property, but
I think having it configured by a constructor parameter aligns more
with PRs FoundationDB#3252 and FoundationDB#3251
alecgrieser
approved these changes
Mar 18, 2025
There was a problem hiding this comment.
This looks fine to me. I'm unclear as to why we wouldn't just always include the method names. I've definitely had trouble parsing our own JUnit reports when there are test failures due to the convention of not including the method name, and I'd be fine if they were just always there.
| * Create a new extension with some configuration. | ||
| * @param clusterFile a custom cluster file to use, or {@code null} to inherit it from the environment, namely | ||
| * {@code FDB_CLUSTER_FILE}. | ||
| * @param includeMethodInDescriptions Set this to {@code true} if publishing test results to something that cannot |
There was a problem hiding this comment.
Why not just set this to true always? Does the name look bad when running in an IDE or something?
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.
When publishing to JUnit xml style files there is no hierarchy, so some tools will just show the class name and description, making it hard to tell what tests were run, or failed. If YamlTestExtension is used in an environment where that is the case this can be used to have the output include the method name. For example:
Instead of
I thought about making this configurable via system property, but I think having it configured by a constructor parameter aligns more with PRs #3252 and #3251
Note: This is a breaking change if someone is depending on
YamlTestExtension, but only if they are depending on the recently merged #3251