-
Notifications
You must be signed in to change notification settings - Fork 45
Added simple custom JavaDocs for the tests produced by Fuzzer #1069
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 11 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
fe4c6d1
Added an initial solution
amandelpie 20bf0ab
Merge branch 'main' into amandelpie/feature-601-2
amandelpie b92b198
Merge branch 'main' into amandelpie/feature-601-2
amandelpie 6ada057
Added a method and class references
amandelpie 408e87e
Merge branch 'main' into amandelpie/feature-601-2
amandelpie a5ca42b
Refactor to avoid bugs with private methods
amandelpie bd2fdbb
Merge branch 'main' into amandelpie/feature-601-2
amandelpie f94554a
Handled empty values
amandelpie 326da42
Merge branch 'main' into amandelpie/feature-601-2
amandelpie 51ca8de
Fixed tests and add a TODO ticket
amandelpie 8829071
Merge branch 'main' into amandelpie/feature-601-2
amandelpie 0a95f29
Fixed review comments
amandelpie 92b8da0
Merge remote-tracking branch 'origin/amandelpie/feature-601-2' into a…
amandelpie 983fce9
Merge branch 'main' into amandelpie/feature-601-2
amandelpie File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
70 changes: 0 additions & 70 deletions
70
utbot-summary/src/main/kotlin/org/utbot/summary/comment/CustomJavaDocTagProvider.kt
This file was deleted.
Oops, something went wrong.
18 changes: 18 additions & 0 deletions
18
...n/org/utbot/summary/comment/classic/fuzzer/SimpleCommentForTestProducedByFuzzerBuilder.kt
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| package org.utbot.summary.comment.classic.fuzzer | ||
|
|
||
| import org.utbot.framework.plugin.api.DocPreTagStatement | ||
| import org.utbot.framework.plugin.api.DocStatement | ||
| import org.utbot.framework.plugin.api.UtExecutionResult | ||
| import org.utbot.fuzzer.FuzzedMethodDescription | ||
| import org.utbot.fuzzer.FuzzedValue | ||
|
|
||
| // TODO: https://github.com/UnitTestBot/UTBotJava/issues/1127 | ||
| class SimpleCommentForTestProducedByFuzzerBuilder( | ||
| description: FuzzedMethodDescription, | ||
| values: List<FuzzedValue>, | ||
| result: UtExecutionResult? | ||
| ) { | ||
| fun buildDocStatements(): List<DocStatement> { | ||
| return listOf<DocStatement>(DocPreTagStatement(emptyList())) | ||
| } | ||
| } |
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
File renamed without changes.
5 changes: 3 additions & 2 deletions
5
...SymbolicExecutionClusterCommentBuilder.kt → ...SymbolicExecutionClusterCommentBuilder.kt
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
68 changes: 68 additions & 0 deletions
68
utbot-summary/src/main/kotlin/org/utbot/summary/comment/customtags/CustomTagsUtil.kt
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| package org.utbot.summary.comment.customtags | ||
|
|
||
| import org.utbot.framework.plugin.api.ClassId | ||
| import soot.Type | ||
|
|
||
| /** | ||
| * Returns a reference to the invoked method. IDE can't resolve references to private methods in comments, | ||
| * so we add @link tag only if the invoked method is not private. | ||
| * | ||
| * It looks like {@link packageName.className#methodName(type1, type2)}. | ||
| * | ||
| * In case when an enclosing class in nested, we need to replace '$' with '.' | ||
| * to render the reference. | ||
| */ | ||
| fun getMethodReference( | ||
| className: String, | ||
| methodName: String, | ||
| methodParameterTypes: List<Type>, | ||
| isPrivate: Boolean | ||
| ): String { | ||
| val prettyClassName: String = className.replace("$", ".") | ||
|
|
||
| val text = if (methodParameterTypes.isEmpty()) { | ||
| "$prettyClassName#$methodName()" | ||
| } else { | ||
| val methodParametersAsString = methodParameterTypes.joinToString(",") | ||
| "$prettyClassName#$methodName($methodParametersAsString)" | ||
| } | ||
|
|
||
| return if (isPrivate) { | ||
| text | ||
| } else { | ||
| "{@link $text}" | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Returns a reference to the class. | ||
| * Replaces '$' with '.' in case a class is nested. | ||
| */ | ||
| fun getClassReference(fullClassName: String): String { | ||
| return "{@link ${fullClassName.replace("$", ".")}}" | ||
| } | ||
|
|
||
| /** | ||
| * Returns a reference to the invoked method. | ||
| * | ||
| * It looks like {@link packageName.className#methodName(type1, type2)}. | ||
| * | ||
| * In case when an enclosing class in nested, we need to replace '$' with '.' | ||
| * to render the reference. | ||
| */ | ||
| fun getMethodReferenceForFuzzingTest(className: String, methodName: String, methodParameterTypes: List<ClassId>, isPrivate: Boolean): String { | ||
| val prettyClassName: String = className.replace("$", ".") | ||
|
|
||
| val text = if (methodParameterTypes.isEmpty()) { | ||
| "$prettyClassName#$methodName()" | ||
| } else { | ||
| val methodParametersAsString = methodParameterTypes.joinToString(",") { it.canonicalName } | ||
| "$prettyClassName#$methodName($methodParametersAsString)" | ||
| } | ||
|
|
||
| return if (isPrivate) { | ||
| text | ||
| } else { | ||
| "{@link $text}" | ||
| } | ||
| } | ||
13 changes: 13 additions & 0 deletions
13
...rg/utbot/summary/comment/customtags/fuzzer/CommentWithCustomTagForTestProducedByFuzzer.kt
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| package org.utbot.summary.comment.customtags.fuzzer | ||
|
|
||
| /** | ||
| * Represents a set of plugin's custom JavaDoc tags. | ||
| */ | ||
| data class CommentWithCustomTagForTestProducedByFuzzer( | ||
| val classUnderTest: String = "", | ||
amandelpie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| val methodUnderTest: String = "", | ||
| val expectedResult: String = "", | ||
| val actualResult: String = "", | ||
| var returnsFrom: String = "", | ||
| var throwsException: String = "" | ||
| ) | ||
56 changes: 56 additions & 0 deletions
56
...t/summary/comment/customtags/fuzzer/CommentWithCustomTagForTestProducedByFuzzerBuilder.kt
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| package org.utbot.summary.comment.customtags.fuzzer | ||
|
|
||
| import org.utbot.framework.plugin.api.DocCustomTagStatement | ||
| import org.utbot.framework.plugin.api.DocStatement | ||
| import org.utbot.framework.plugin.api.UtExecutionResult | ||
| import org.utbot.fuzzer.FuzzedMethodDescription | ||
| import org.utbot.fuzzer.FuzzedValue | ||
| import org.utbot.summary.SummarySentenceConstants.CARRIAGE_RETURN | ||
| import org.utbot.summary.comment.customtags.getClassReference | ||
| import org.utbot.summary.comment.customtags.getMethodReferenceForFuzzingTest | ||
| import org.utbot.summary.comment.customtags.symbolic.CustomJavaDocTagProvider | ||
|
|
||
| /** | ||
| * Builds JavaDoc comments for generated tests using plugin's custom JavaDoc tags. | ||
| */ | ||
| class CommentWithCustomTagForTestProducedByFuzzerBuilder( | ||
| val methodDescription: FuzzedMethodDescription, | ||
| val values: List<FuzzedValue>, | ||
| val result: UtExecutionResult? | ||
| ) { | ||
| /** | ||
| * Collects statements for final JavaDoc comment. | ||
| */ | ||
| fun buildDocStatements(): List<DocStatement> { | ||
| val comment = buildCustomJavaDocComment() | ||
| val docStatementList = | ||
| CustomJavaDocTagProvider().getPluginCustomTags().mapNotNull { it.generateDocStatementForTestProducedByFuzzer(comment) } | ||
| return listOf(DocCustomTagStatement(docStatementList)) | ||
| } | ||
|
|
||
| private fun buildCustomJavaDocComment(): CommentWithCustomTagForTestProducedByFuzzer { | ||
| val packageName = methodDescription.packageName | ||
| val className = methodDescription.className | ||
| val methodName = methodDescription.compilableName | ||
|
|
||
| return if(packageName!=null && className!=null && methodName!=null) { | ||
amandelpie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| val fullClassName = "$packageName.$className" | ||
|
|
||
| val methodReference = getMethodReferenceForFuzzingTest( | ||
| fullClassName, | ||
| methodName, | ||
| methodDescription.parameters, | ||
| false | ||
| ).replace(CARRIAGE_RETURN, "") | ||
|
|
||
| val classReference = getClassReference(fullClassName).replace(CARRIAGE_RETURN, "") | ||
|
|
||
| CommentWithCustomTagForTestProducedByFuzzer( | ||
| classUnderTest = classReference, | ||
| methodUnderTest = methodReference, | ||
| ) | ||
| } else { | ||
| CommentWithCustomTagForTestProducedByFuzzer() | ||
| } | ||
| } | ||
| } | ||
4 changes: 3 additions & 1 deletion
4
...t/summary/comment/CustomJavaDocComment.kt → ...stomtags/symbolic/CustomJavaDocComment.kt
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
5 changes: 4 additions & 1 deletion
5
...ry/comment/CustomJavaDocCommentBuilder.kt → ...s/symbolic/CustomJavaDocCommentBuilder.kt
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.