Generate DisplayName annotation only for JUnit 5 #576

Author: onewhl

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/constructor/tree/CgMethodConstructor.kt

@@ -1599,7 +1599,23 @@ internal class CgMethodConstructor(val context: CgContext) : CgContextOwner by c
         } else {
             setOf(annotation(testFramework.testAnnotationId))
         }
-        displayName?.let { testFrameworkManager.addDisplayName(it) }
+
+        /* Add a short test's description depending on the test framework type:
+           DisplayName in case of JUni5, and description argument to Test annotation in case of TestNG.
+         */
+        if (displayName != null) {
+            when (testFramework) {
+                is Junit5 -> {
+                    displayName.let { testFrameworkManager.addDisplayName(it) }
+                }
+                is TestNg -> {
+                    testFrameworkManager.addTestDescription(displayName)
+                }
+                else -> {
+                    // nothing
+                }
+            }
+        }
 
         val result = currentExecution!!.result
         if (result is UtTimeoutException) {
@@ -1645,12 +1661,19 @@ internal class CgMethodConstructor(val context: CgContext) : CgContextOwner by c
                 }
             }
 
-            documentation = CgDocumentationComment(docComment)
-            documentation = if (parameterized) {
+            val documentationComment = if (parameterized) {
                 CgDocumentationComment(text = null)
             } else {
                 CgDocumentationComment(docComment)
             }
+            documentation.add(documentationComment)
+
+            /* 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) {
+                documentation.add(CgSingleLineComment(displayName))
+            }
         }
         testMethods += testMethod
         return testMethod

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/constructor/tree/TestFrameworkManager.kt

@@ -15,7 +15,6 @@ import org.utbot.framework.codegen.model.constructor.context.CgContextOwner
 import org.utbot.framework.codegen.model.constructor.util.CgComponents
 import org.utbot.framework.codegen.model.constructor.util.classCgClassId
 import org.utbot.framework.codegen.model.constructor.util.importIfNeeded
-import org.utbot.framework.codegen.model.tree.CgCommentedAnnotation
 import org.utbot.framework.codegen.model.tree.CgEnumConstantAccess
 import org.utbot.framework.codegen.model.tree.CgExpression
 import org.utbot.framework.codegen.model.tree.CgGetJavaClass
@@ -174,13 +173,39 @@ internal abstract class TestFrameworkManager(val context: CgContext)
         }
     }
 
+    /**
+     * Supplements TestNG @Test annotation with a description.
+     * It looks like @Test(description="...")
+     *
+     * Should be used only with TestNG.
+     * @see <a href="https://github.com/UnitTestBot/UTBotJava/issues/576">issue-576 on GitHub</a>
+     */
+    open fun addTestDescription(description: String?) {
+        if (description == null) return
+        val testAnnotation =
+            collectedMethodAnnotations.singleOrNull { it.classId == testFramework.testAnnotationId }
+
+        val descriptionArgument = CgNamedAnnotationArgument("description", stringLiteral(description))
+        if (testAnnotation is CgMultipleArgsAnnotation) {
+            testAnnotation.arguments += descriptionArgument
+        } else {
+            collectedMethodAnnotations += CgMultipleArgsAnnotation(
+                testFramework.testAnnotationId,
+                mutableListOf(descriptionArgument)
+            )
+        }
+    }
+
     abstract fun disableTestMethod(reason: String)
 
-    // We add a commented JUnit5 DisplayName annotation here by default,
-    // because other test frameworks do not support such feature.
+    /**
+     * Adds @DisplayName annotation.
+     *
+     * Should be used only with JUnit 5.
+     * @see <a href="https://github.com/UnitTestBot/UTBotJava/issues/576">issue-576 on GitHub</a>
+     */
     open fun addDisplayName(name: String) {
-        val displayName = CgSingleArgAnnotation(Junit5.displayNameClassId, stringLiteral(name))
-        collectedMethodAnnotations += CgCommentedAnnotation(displayName)
+        collectedMethodAnnotations += CgSingleArgAnnotation(Junit5.displayNameClassId, stringLiteral(name))
     }
 
     protected fun ClassId.toExceptionClass(): CgExpression =

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/tree/Builders.kt

@@ -53,7 +53,7 @@ interface CgMethodBuilder<T : CgMethod> : CgBuilder<T> {
     val statements: List<CgStatement>
     val exceptions: Set<ClassId>
     val annotations: List<CgAnnotation>
-    val documentation: CgDocumentationComment
+    val documentation: List<CgComment>
 }
 
 class CgTestMethodBuilder : CgMethodBuilder<CgTestMethod> {
@@ -64,7 +64,7 @@ class CgTestMethodBuilder : CgMethodBuilder<CgTestMethod> {
     override val exceptions: MutableSet<ClassId> = mutableSetOf()
     override val annotations: MutableList<CgAnnotation> = mutableListOf()
     lateinit var methodType: CgTestMethodType
-    override var documentation: CgDocumentationComment = CgDocumentationComment(emptyList())
+    override var documentation: MutableList<CgComment> = mutableListOf()
 
     override fun build() = CgTestMethod(
         name,
@@ -87,7 +87,7 @@ class CgErrorTestMethodBuilder : CgMethodBuilder<CgErrorTestMethod> {
     override lateinit var statements: List<CgStatement>
     override val exceptions: Set<ClassId> = emptySet()
     override val annotations: List<CgAnnotation> = emptyList()
-    override var documentation: CgDocumentationComment = CgDocumentationComment(emptyList())
+    override var documentation: List<CgComment> = emptyList()
 
     override fun build() = CgErrorTestMethod(name, statements, documentation)
 }
@@ -102,7 +102,7 @@ class CgParameterizedTestDataProviderBuilder : CgMethodBuilder<CgParameterizedTe
     override lateinit var statements: List<CgStatement>
     override val annotations: MutableList<CgAnnotation> = mutableListOf()
     override val exceptions: MutableSet<ClassId> = mutableSetOf()
-    override var documentation: CgDocumentationComment = CgDocumentationComment(emptyList())
+    override var documentation: MutableList<CgDocumentationComment> = mutableListOf()
 
     override fun build() = CgParameterizedTestDataProviderMethod(name, statements, returnType, annotations, exceptions)
 }

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/tree/CgElement.kt

@@ -190,7 +190,7 @@ sealed class CgMethod(open val isStatic: Boolean) : CgElement {
     abstract val statements: List<CgStatement>
     abstract val exceptions: Set<ClassId>
     abstract val annotations: List<CgAnnotation>
-    abstract val documentation: CgDocumentationComment
+    abstract val documentation: List<CgComment>
     abstract val requiredFields: List<CgParameterDeclaration>
 }
 
@@ -202,14 +202,14 @@ class CgTestMethod(
     override val exceptions: Set<ClassId>,
     override val annotations: List<CgAnnotation>,
     val type: CgTestMethodType,
-    override val documentation: CgDocumentationComment = CgDocumentationComment(emptyList()),
+    override val documentation: List<CgComment> = emptyList(),
     override val requiredFields: List<CgParameterDeclaration> = emptyList(),
 ) : CgMethod(false)
 
 class CgErrorTestMethod(
     override val name: String,
     override val statements: List<CgStatement>,
-    override val documentation: CgDocumentationComment = CgDocumentationComment(emptyList())
+    override val documentation: List<CgComment> = emptyList()
 ) : CgMethod(false) {
     override val exceptions: Set<ClassId> = emptySet()
     override val returnType: ClassId = voidClassId
@@ -226,7 +226,7 @@ class CgParameterizedTestDataProviderMethod(
     override val exceptions: Set<ClassId>,
 ) : CgMethod(isStatic = true) {
     override val parameters: List<CgParameterDeclaration> = emptyList()
-    override val documentation: CgDocumentationComment = CgDocumentationComment(emptyList())
+    override val documentation: List<CgDocumentationComment> = emptyList()
     override val requiredFields: List<CgParameterDeclaration> = emptyList()
 }
 

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/model/visitor/CgAbstractRenderer.kt

@@ -818,7 +818,9 @@ internal abstract class CgAbstractRenderer(val context: CgContext, val printer:
     }
 
     private fun renderMethodDocumentation(element: CgMethod) {
-        element.documentation.accept(this)
+        for (comment in element.documentation) {
+            comment.accept(this)
+        }
     }
 
     private fun Byte.toStringConstant() = when {