Fill value of utbot.iterates tag #565

Author: onewhl

utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/javadoc/UtCustomJavaDocTagProvider.kt

@@ -43,7 +43,7 @@ class UtCustomJavaDocTagProvider : CustomJavadocTagProvider {
         object MethodUnderTest : UtCustomTag("utbot.methodUnderTest", "Method under test")
         object ExpectedResult : UtCustomTag("utbot.expectedResult", "Expected result")
         object ActualResult : UtCustomTag("utbot.actualResult", "Actual result")
-        object Executes : UtCustomTag("utbot.executes", "Executes")
+        object Executes : UtCustomTag("utbot.executesCondition", "Executes condition")
         object Invokes : UtCustomTag("utbot.invokes", "Invokes")
         object Iterates : UtCustomTag("utbot.iterates", "Iterates")
         object ReturnsFrom : UtCustomTag("utbot.returnsFrom", "Returns from")

utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/javadoc/UtJavaDocInfoGenerator.kt

@@ -32,6 +32,7 @@ class UtJavaDocInfoGenerator {
         generateUtTagSection(builder, comment, UtCustomJavaDocTagProvider.UtCustomTag.MethodUnderTest)
         generateUtTagSection(builder, comment, UtCustomJavaDocTagProvider.UtCustomTag.Invokes)
         generateUtTagSection(builder, comment, UtCustomJavaDocTagProvider.UtCustomTag.Executes)
+        generateUtTagSection(builder, comment, UtCustomJavaDocTagProvider.UtCustomTag.Iterates)
         generateUtTagSection(builder, comment, UtCustomJavaDocTagProvider.UtCustomTag.ExpectedResult)
         generateUtTagSection(builder, comment, UtCustomJavaDocTagProvider.UtCustomTag.ActualResult)
         generateUtTagSection(builder, comment, UtCustomJavaDocTagProvider.UtCustomTag.ReturnsFrom)

utbot-summary/src/main/kotlin/org/utbot/summary/comment/CustomJavaDocComment.kt

@@ -8,9 +8,9 @@ data class CustomJavaDocComment(
     val methodUnderTest: String,
     val expectedResult: String?,
     val actualResult: String?,
-    var executes: String?,
+    var executesCondition: String?,
     var invokes: String?,
     var iterates: String?,
     var returnsFrom: String?,
-    val throwsException: String?
+    var throwsException: String?
 )

utbot-summary/src/main/kotlin/org/utbot/summary/comment/CustomJavaDocCommentBuilder.kt

@@ -27,8 +27,8 @@ class CustomJavaDocCommentBuilder(
             docStatementList += DocRegularStmt("@utbot.expectedResult ${comment.expectedResult}\n")
         if (comment.actualResult != null)
             docStatementList += DocRegularStmt("@utbot.actualResult ${comment.actualResult}\n")
-        if (comment.executes != null)
-            docStatementList += DocRegularStmt("@utbot.executes ${comment.executes}\n")
+        if (comment.executesCondition != null)
+            docStatementList += DocRegularStmt("@utbot.executesCondition ${comment.executesCondition}\n")
         if (comment.invokes != null)
             docStatementList += DocRegularStmt("@utbot.invokes ${comment.invokes}\n")
         if (comment.iterates != null)
@@ -46,33 +46,47 @@ class CustomJavaDocCommentBuilder(
             getMethodReference(currentMethod.declaringClass.name, currentMethod.name, currentMethod.parameterTypes)
         val classReference = getClassReference(currentMethod.declaringClass.javaStyleName)
 
-        val thrownException = traceTag.result.exceptionOrNull()
-        val exceptionThrow: String? = if (thrownException == null) {
-            traceTag.result.exceptionOrNull()?.let { it::class.qualifiedName }
-        } else {
-            val exceptionName = thrownException.javaClass.simpleName
-            val reason = findExceptionReason(currentMethod, thrownException)
-            "{@link $exceptionName} $reason"
-        }
-
         val customJavaDocComment = CustomJavaDocComment(
             classUnderTest = classReference,
             methodUnderTest = methodReference,
             expectedResult = null,
             actualResult = null,
-            executes = null,
+            executesCondition = null,
             invokes = null,
             iterates = null,
             returnsFrom = null,
-            throwsException = exceptionThrow
+            throwsException = null
         )
 
-        val rootSentenceBlock = SimpleSentenceBlock(stringTemplates = stringTemplates)
+        // build throws exception section
+        val thrownException = traceTag.result.exceptionOrNull()
+        val exceptionThrow: String? = if (thrownException == null) {
+            traceTag.result.exceptionOrNull()?.let { it::class.qualifiedName }
+        } else {
+            val exceptionName = thrownException.javaClass.simpleName
+            val reason = findExceptionReason(currentMethod, thrownException)
+            "{@link $exceptionName} $reason"
+        }
+        customJavaDocComment.throwsException = exceptionThrow
 
+        val rootSentenceBlock = SimpleSentenceBlock(stringTemplates = stringTemplates)
+        skippedIterations()
         buildSentenceBlock(traceTag.rootStatementTag, rootSentenceBlock, currentMethod)
 
+        // builds iterates section
+        rootSentenceBlock.iterationSentenceBlocks.forEach { (loopDesc, sentenceBlocks) ->
+            customJavaDocComment.iterates = stringTemplates.iterationSentence.format(
+                stringTemplates.codeSentence.format(loopDesc),
+                numberOccurrencesToText(
+                    sentenceBlocks.size
+                )
+            )
+        }
+
+        // build invokes, executes, and returns from sections
         for (stmtDescription: StmtDescription in rootSentenceBlock.stmtTexts) {
             when (stmtDescription.stmtType.name) {
+                //TODO: support multiple invokes (calls)
                 "Invoke" -> {
                     val info = stmtDescription.description
                     customJavaDocComment.invokes = "{@code $info}"
@@ -81,9 +95,10 @@ class CustomJavaDocCommentBuilder(
                     val info = stmtDescription.description
                     customJavaDocComment.returnsFrom = "{@code $info}"
                 }
+                //TODO: support multiple conditions
                 "Condition" -> {
                     val info = stmtDescription.description
-                    customJavaDocComment.executes = "{@code $info}"
+                    customJavaDocComment.executesCondition = "{@code $info}"
                 }
             }
         }

utbot-summary/src/main/kotlin/org/utbot/summary/comment/SimpleCommentBuilder.kt

@@ -154,8 +154,8 @@ open class SimpleCommentBuilder(
         if (exceptionNode == null) return ""
 
         reason += when {
-            exceptionNode is IfStmt -> exceptionNode.condition.toString()
-            isLoopStatement(exceptionNode) -> getTextIterationDescription(exceptionNode)
+            exceptionNode is IfStmt -> "{@code ${exceptionNode.condition}}"
+            isLoopStatement(exceptionNode) -> "{@code ${getTextIterationDescription(exceptionNode)}"
             exceptionNode is SwitchStmt -> textSwitchCase(step, jimpleToASTMap)
             else -> exceptionNode.toString()
         }