Handle RecursionAssignment, SwitchCase, and CaughtException statement types in CustomJavaDocCommentBuilder #888
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
amandelpie
reviewed
Sep 9, 2022
| fun testFib() { | ||
| val summary1 = "@utbot.classUnderTest {@link Recursion}\n" + | ||
| "@utbot.methodUnderTest {@link org.utbot.examples.recursion.Recursion#fib(int)}\n" + | ||
| "@utbot.executesCondition {@code (n == 0): False},\n" + |
There was a problem hiding this comment.
Just thought that in future we could have something like testing dsl
javadoc {
methodUnderTest = "org.utbot.examples.recursion.Recursion#fib(int)"
executesCondition = "(n == 0): False"
}
There was a problem hiding this comment.
yesss, it would be awesome!
amandelpie
reviewed
Sep 9, 2022
utbot-summary-tests/src/test/kotlin/examples/recursion/SummaryRecursionTest.kt
Outdated
Show resolved
Hide resolved
amandelpie
approved these changes
Sep 9, 2022
utbot-summary-tests/src/test/kotlin/examples/recursion/SummaryRecursionTest.kt
Show resolved
Hide resolved
utbot-summary/src/main/kotlin/org/utbot/summary/comment/CustomJavaDocComment.kt
Outdated
Show resolved
Hide resolved
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.
Description
Handle RecursionAssignment, SwitchCase, and CaughtException statement types in CustomJavaDocCommentBuilder to add related JavaDoc tags in summaries.
Fixes #773
Type of Change
How Has This Been Tested?
Automated Testing
I added tests for each statement type: SummaryRecursionTest, SummarySwitchTest, SummaryExceptionExampleTest.
Manual Scenario
Checklist (remove irrelevant options):