Generate DisplayName annotation only for JUnit 5 #576 #624
Conversation
onewhl
added
the
comp-summaries
| testFrameworkManager.addTestDescription(displayName) | ||
| } | ||
| else -> { | ||
| // nothing |
There was a problem hiding this comment.
I suggest to create a ticket to add a custom Java tag for display name as @DisplayName or @summary for JUnit 4
There was a problem hiding this comment.
It's weird that we just forget the generated display name :( for JUnit4 but generates it.
No logging in this file at all, it's sad too
| /* JUnit4 doesn't have DisplayName annotation and any other suitable for putting short description, | ||
| that's why we add a single line comment below JavaDoc with a test's short description. | ||
| */ | ||
| if (testFramework is Junit4 && displayName != null) { |
There was a problem hiding this comment.
Probably we don't need this short commented summary under the test, it looks weird and clashes with the JavaDocs
There was a problem hiding this comment.
I agree that single-line comment below JavaDoc might look weird, but it contains short useful information about the test. As you suggested in another comment, we can add a custom JavaDoc tag for it in future.
There was a problem hiding this comment.
Agreed, that the comment line does not look good. I am even not sure, that an average user will understand what it is.
There was a problem hiding this comment.
Fixed as discussed, now we don't show display name in case of JUnit4.
Description
Add a single line comment with a short description for JUnit4.
Generate
@DisplayNameannotation only for JUnit5.Add a value for
descriptionargument for TestNG.Fixes #576
Screenshots for JUnit4, JUnit5, and TestNG respectively:
UPDATE: decided to not show a display name in case of JUnit4 and to not add a single line comment.
Type of Change
How Has This Been Tested?
Automated Testing
Run summary tests.
Manual Scenario
Generate tests using different test frameworks: JUnit4, JUnit5, TestNG and check test annotations and comments.
Checklist (remove irrelevant options):