Add support for rendering class fields with annotations

Author: sofurihafe

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/domain/Domain.kt

@@ -191,6 +191,14 @@ abstract class TestFramework(
     abstract val nestedClassesShouldBeStatic: Boolean
     abstract val argListClassId: ClassId
 
+    abstract val beforeEachAnnotation: String
+    abstract val beforeEachAnnotationId: ClassId
+    abstract val beforeEachAnnotationFqn: String
+
+    abstract val afterEachAnnotation: String
+    abstract val afterEachAnnotationId: ClassId
+    abstract val afterEachAnnotationFqn: String
+
     open val testSuperClass: ClassId? = null
 
     open val assertEquals by lazy { assertionId("assertEquals", objectClassId, objectClassId) }
@@ -269,6 +277,11 @@ object TestNg : TestFramework(id = "TestNG",displayName = "TestNG") {
     override val methodSourceAnnotation: String = "@$mainPackage.DataProvider"
     override val methodSourceAnnotationFqn: String = "@$mainPackage.DataProvider"
 
+    override val beforeEachAnnotation: String = "@$mainPackage.BeforeMethod"
+    override val beforeEachAnnotationFqn: String = "$mainPackage.BeforeMethod"
+    override val afterEachAnnotation: String = "@$mainPackage.AfterMethod"
+    override val afterEachAnnotationFqn: String = "$mainPackage.AfterMethod"
+
     internal const val testXmlName: String = "testng.xml"
 
     override val assertionsClass: ClassId = BuiltinClassId(
@@ -321,6 +334,18 @@ object TestNg : TestFramework(id = "TestNG",displayName = "TestNG") {
     override val argListClassId: ClassId
         get() = Array<Array<Any?>?>::class.id
 
+    override val beforeEachAnnotationId: ClassId =
+        BuiltinClassId(
+            canonicalName = "$mainPackage.annotations.BeforeMethod",
+            simpleName = "BeforeMethod"
+        )
+
+    override val afterEachAnnotationId: ClassId =
+        BuiltinClassId(
+            canonicalName = "$mainPackage.annotations.AfterMethod",
+            simpleName = "AfterMethod"
+        )
+
     @OptIn(ExperimentalStdlibApi::class)
     override fun getRunTestsCommand(
         executionInvoke: String,
@@ -382,6 +407,12 @@ object Junit4 : TestFramework(id = "JUnit4",displayName = "JUnit 4") {
     override val methodSourceAnnotationFqn
         get() = parametrizedTestsNotSupportedError
 
+    override val beforeEachAnnotation: String = "@$mainPackage.Before"
+    override val beforeEachAnnotationFqn: String = "$mainPackage.Before"
+
+    override val afterEachAnnotation: String = "@$mainPackage.After"
+    override val afterEachAnnotationFqn: String = "$mainPackage.After"
+
     override val testAnnotationId = BuiltinClassId(
         canonicalName = "$JUNIT4_PACKAGE.Test",
         simpleName = "Test"
@@ -414,6 +445,19 @@ object Junit4 : TestFramework(id = "JUnit4",displayName = "JUnit 4") {
     override val argListClassId: ClassId
         get() = parametrizedTestsNotSupportedError
 
+    override val beforeEachAnnotationId: ClassId =
+        BuiltinClassId(
+            canonicalName = "$JUNIT4_PACKAGE.Before",
+            simpleName = "Before"
+        )
+
+    override val afterEachAnnotationId: ClassId =
+        BuiltinClassId(
+            canonicalName = "$JUNIT4_PACKAGE.After",
+            simpleName = "After"
+        )
+
+
     @OptIn(ExperimentalStdlibApi::class)
     override fun getRunTestsCommand(
         executionInvoke: String,
@@ -431,12 +475,16 @@ object Junit4 : TestFramework(id = "JUnit4",displayName = "JUnit 4") {
 
 object Junit5 : TestFramework(id = "JUnit5", displayName = "JUnit 5") {
     override val mainPackage: String = JUNIT5_PACKAGE
-    override val testAnnotation = "@$mainPackage.Test"
+    override val testAnnotation: String = "@$mainPackage.Test"
     override val testAnnotationFqn: String = "$mainPackage.Test"
-    override val parameterizedTestAnnotation = "$JUNIT5_PARAMETERIZED_PACKAGE.ParameterizedTest"
+    override val parameterizedTestAnnotation: String = "$JUNIT5_PARAMETERIZED_PACKAGE.ParameterizedTest"
     override val parameterizedTestAnnotationFqn: String = "$JUNIT5_PARAMETERIZED_PACKAGE.ParameterizedTest"
     override val methodSourceAnnotation: String = "$JUNIT5_PARAMETERIZED_PACKAGE.provider.MethodSource"
     override val methodSourceAnnotationFqn: String = "$JUNIT5_PARAMETERIZED_PACKAGE.provider.MethodSource"
+    override val beforeEachAnnotation: String = "@$mainPackage.BeforeEach"
+    override val beforeEachAnnotationFqn: String = "$mainPackage.BeforeEach"
+    override val afterEachAnnotation: String = "@$mainPackage.AfterEach"
+    override val afterEachAnnotationFqn: String = "$mainPackage.AfterEach"
 
     val executableClassId = BuiltinClassId(
         canonicalName = "$JUNIT5_PACKAGE.function.Executable",
@@ -543,6 +591,18 @@ object Junit5 : TestFramework(id = "JUnit5", displayName = "JUnit 5") {
             )
         }
 
+    override val beforeEachAnnotationId: ClassId =
+        BuiltinClassId(
+            canonicalName = "$JUNIT5_PACKAGE.BeforeEach",
+            simpleName = "BeforeEach"
+        )
+
+    override val afterEachAnnotationId: ClassId =
+        BuiltinClassId(
+            canonicalName = "$JUNIT5_PACKAGE.AfterEach",
+            simpleName = "AfterEach"
+        )
+
     private const val junitVersion = "1.9.0" // TODO read it from gradle.properties
     private const val platformJarName: String = "junit-platform-console-standalone-$junitVersion.jar"
 

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/domain/builtin/MockitoBuiltins.kt

@@ -20,6 +20,16 @@ internal val mockitoClassId = BuiltinClassId(
     simpleName = "Mockito",
 )
 
+internal val mockClassId = BuiltinClassId(
+    canonicalName = "org.mockito.Mock",
+    simpleName = "Mock",
+)
+
+internal val injectMocksClassId = BuiltinClassId(
+    canonicalName = "org.mockito.InjectMocks",
+    simpleName = "InjectMocks",
+)
+
 internal val ongoingStubbingClassId = BuiltinClassId(
     canonicalName = "org.mockito.stubbing.OngoingStubbing",
     simpleName = "OngoingStubbing",

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/domain/models/CgElement.kt

@@ -81,6 +81,7 @@ interface CgElement {
             is CgBreakStatement -> visit(element)
             is CgContinueStatement -> visit(element)
             is CgDeclaration -> visit(element)
+            is CgFieldDeclaration -> visit(element)
             is CgAssignment -> visit(element)
             is CgTypeCast -> visit(element)
             is CgIsInstance -> visit(element)
@@ -152,11 +153,17 @@ class CgClass(
  */
 class CgClassBody(
     val classId: ClassId,
+    val fields: List<CgElement>,
     val methodRegions: List<CgMethodsCluster>,
     val staticDeclarationRegions: List<CgStaticsRegion>,
     val nestedClassRegions: List<CgNestedClassesRegion<*>>
 ) : CgElement
 
+class CgFieldDeclaration(
+    val annotation: CgAnnotation,
+    val declaration: CgDeclaration
+) : CgElement
+
 /**
  * A class representing the IntelliJ IDEA's regions.
  * A region is a part of code between the special starting and ending comments.

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

@@ -73,6 +73,7 @@ import org.utbot.framework.codegen.domain.models.CgStatementExecutableCall
 import org.utbot.framework.codegen.domain.models.CgStaticFieldAccess
 import org.utbot.framework.codegen.domain.models.CgStaticRunnable
 import org.utbot.framework.codegen.domain.models.CgStaticsRegion
+import org.utbot.framework.codegen.domain.models.CgFieldDeclaration
 import org.utbot.framework.codegen.domain.models.CgTestMethod
 import org.utbot.framework.codegen.domain.models.CgTestMethodCluster
 import org.utbot.framework.codegen.domain.models.CgThisInstance
@@ -562,6 +563,14 @@ abstract class CgAbstractRenderer(
         println(statementEnding)
     }
 
+    // Class field declaration
+
+    override fun visit(element: CgFieldDeclaration) {
+        element.annotation.accept(this)
+        renderVisibility(element.declaration.variableType)
+        element.declaration.accept(this)
+    }
+
     // Variable assignment
 
     override fun visit(element: CgAssignment) {
@@ -878,7 +887,7 @@ abstract class CgAbstractRenderer(
         }
     }
 
-    protected abstract fun renderClassVisibility(classId: ClassId)
+    protected abstract fun renderVisibility(classId: ClassId)
 
     protected abstract fun renderClassModality(aClass: CgClass)
 

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/renderer/CgJavaRenderer.kt

@@ -69,7 +69,7 @@ internal class CgJavaRenderer(context: CgRendererContext, printer: CgPrinter = C
             annotation.accept(this)
         }
 
-        renderClassVisibility(element.id)
+        renderVisibility(element.id)
         renderClassModality(element)
         if (element.isStatic) {
             print("static ")
@@ -91,6 +91,11 @@ internal class CgJavaRenderer(context: CgRendererContext, printer: CgPrinter = C
     }
 
     override fun visit(element: CgClassBody) {
+        // render test class fields, e.g. Spring stuff
+        for (region in element.fields) {
+            region.accept(this)
+        }
+
         // render regions for test methods and utils
         val allRegions = element.methodRegions + element.nestedClassRegions + element.staticDeclarationRegions
         for ((i, region) in allRegions.withIndex()) {
@@ -376,7 +381,7 @@ internal class CgJavaRenderer(context: CgRendererContext, printer: CgPrinter = C
 
     override fun escapeNamePossibleKeywordImpl(s: String): String = s
 
-    override fun renderClassVisibility(classId: ClassId) {
+    override fun renderVisibility(classId: ClassId) {
         when {
             classId.isPublic -> print("public ")
             classId.isProtected -> print("protected ")

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/renderer/CgKotlinRenderer.kt

@@ -42,7 +42,6 @@ import org.utbot.framework.codegen.domain.models.CgFormattedString
 import org.utbot.framework.codegen.domain.models.CgLiteral
 import org.utbot.framework.codegen.domain.models.CgTestMethod
 import org.utbot.framework.codegen.domain.models.CgTypeCast
-import org.utbot.framework.codegen.domain.models.CgValue
 import org.utbot.framework.codegen.domain.models.CgVariable
 import org.utbot.framework.codegen.util.nullLiteral
 import org.utbot.framework.plugin.api.BuiltinClassId
@@ -84,7 +83,7 @@ internal class CgKotlinRenderer(context: CgRendererContext, printer: CgPrinter =
             annotation.accept(this)
         }
 
-        renderClassVisibility(element.id)
+        renderVisibility(element.id)
         renderClassModality(element)
         if (!element.isStatic && element.isNested) {
             print("inner ")
@@ -571,7 +570,7 @@ internal class CgKotlinRenderer(context: CgRendererContext, printer: CgPrinter =
     override fun escapeNamePossibleKeywordImpl(s: String): String =
         if (isLanguageKeyword(s, context.cgLanguageAssistant)) "`$s`" else s
 
-    override fun renderClassVisibility(classId: ClassId) {
+    override fun renderVisibility(classId: ClassId) {
         when {
             // Kotlin classes are public by default
             classId.isPublic -> Unit

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/renderer/CgVisitor.kt

@@ -78,6 +78,7 @@ import org.utbot.framework.codegen.domain.models.CgClassBody
 import org.utbot.framework.codegen.domain.models.CgDocRegularLineStmt
 import org.utbot.framework.codegen.domain.models.CgFormattedString
 import org.utbot.framework.codegen.domain.models.CgNestedClassesRegion
+import org.utbot.framework.codegen.domain.models.CgFieldDeclaration
 import org.utbot.framework.codegen.domain.models.CgTestMethod
 import org.utbot.framework.codegen.domain.models.CgTestMethodCluster
 import org.utbot.framework.codegen.domain.models.CgThisInstance
@@ -183,6 +184,9 @@ interface CgVisitor<R> {
     // Variable declaration
     fun visit(element: CgDeclaration): R
 
+    //
+    fun visit(element: CgFieldDeclaration): R
+
     // Variable assignment
     fun visit(element: CgAssignment): R
 

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

@@ -13,6 +13,7 @@ import org.utbot.framework.codegen.domain.models.CgElement
 import org.utbot.framework.codegen.domain.models.CgErrorTestMethod
 import org.utbot.framework.codegen.domain.models.CgExceptionHandler
 import org.utbot.framework.codegen.domain.models.CgExpression
+import org.utbot.framework.codegen.domain.models.CgFieldDeclaration
 import org.utbot.framework.codegen.domain.models.CgForEachLoop
 import org.utbot.framework.codegen.domain.models.CgForLoop
 import org.utbot.framework.codegen.domain.models.CgLoop
@@ -63,11 +64,12 @@ class CgClassBuilder : CgBuilder<CgClass> {
 fun buildClass(init: CgClassBuilder.() -> Unit) = CgClassBuilder().apply(init).build()
 
 class CgClassBodyBuilder(val classId: ClassId) : CgBuilder<CgClassBody> {
+    val fields: MutableList<CgFieldDeclaration> = mutableListOf()
     val methodRegions: MutableList<CgMethodsCluster> = mutableListOf()
     val staticDeclarationRegions: MutableList<CgStaticsRegion> = mutableListOf()
     val nestedClassRegions: MutableList<CgNestedClassesRegion<*>> = mutableListOf()
 
-    override fun build() = CgClassBody(classId, methodRegions, staticDeclarationRegions, nestedClassRegions)
+    override fun build() = CgClassBody(classId, fields, methodRegions, staticDeclarationRegions, nestedClassRegions)
 }
 
 fun buildClassBody(classId: ClassId, init: CgClassBodyBuilder.() -> Unit) = CgClassBodyBuilder(classId).apply(init).build()

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

@@ -1,14 +1,18 @@
 package org.utbot.framework.codegen.tree
 
+import com.jetbrains.rd.util.firstOrNull
 import org.utbot.framework.UtSettings
 import org.utbot.framework.codegen.domain.Junit4
 import org.utbot.framework.codegen.domain.Junit5
 import org.utbot.framework.codegen.domain.ParametrizedTestSource
 import org.utbot.framework.codegen.domain.TestNg
 import org.utbot.framework.codegen.domain.builtin.TestClassUtilMethodProvider
+import org.utbot.framework.codegen.domain.builtin.mockClassId
 import org.utbot.framework.codegen.domain.context.CgContext
 import org.utbot.framework.codegen.domain.models.CgAuxiliaryClass
 import org.utbot.framework.codegen.domain.models.CgClassBody
+import org.utbot.framework.codegen.domain.models.CgDeclaration
+import org.utbot.framework.codegen.domain.models.CgFieldDeclaration
 import org.utbot.framework.codegen.domain.models.CgMethod
 import org.utbot.framework.codegen.domain.models.CgMethodTestSet
 import org.utbot.framework.codegen.domain.models.CgMethodsCluster
@@ -29,6 +33,7 @@ import org.utbot.framework.codegen.tree.CgComponents.clearContextRelatedStorage
 import org.utbot.framework.codegen.tree.CgComponents.getMethodConstructorBy
 import org.utbot.framework.plugin.api.ClassId
 import org.utbot.framework.plugin.api.MethodId
+import org.utbot.framework.plugin.api.UtCompositeModel
 import org.utbot.framework.plugin.api.UtExecutionSuccess
 import org.utbot.framework.plugin.api.UtMethodTestSet
 import org.utbot.framework.plugin.api.UtSymbolicExecution
@@ -72,6 +77,20 @@ open class CgSimpleTestClassConstructor(context: CgContext): CgTestClassConstruc
                 }
             }
 
+            // Don't forget to delete these lines and some imports
+            // BEGIN
+            // A sample field collection. Use max method from IntExamplesTest
+            val tmpFields = (notYetConstructedTestSets[0].executions[0].stateAfter.thisInstance as UtCompositeModel).fields.firstOrNull()
+            val annotation = CgComponents
+                .getStatementConstructorBy(context)
+                .annotation(mockClassId)
+            val declaration = CgDeclaration(tmpFields!!.value.classId, tmpFields.key.name, null)
+
+            // This is the way
+            // It may be a separate REGION containing fields for each test method, not just a list of Cg little things...
+            fields += CgFieldDeclaration(annotation, declaration)
+            // END
+
             for (testSet in notYetConstructedTestSets) {
                 updateCurrentExecutable(testSet.executableId)
                 val currentMethodUnderTestRegions = constructTestSet(testSet) ?: continue

utbot-python/src/main/kotlin/org/utbot/python/framework/codegen/model/constructor/visitor/CgPythonRenderer.kt

@@ -415,7 +415,7 @@ internal class CgPythonRenderer(
     }
 
     override fun escapeNamePossibleKeywordImpl(s: String): String = s
-    override fun renderClassVisibility(classId: ClassId) {
+    override fun renderVisibility(classId: ClassId) {
         throw UnsupportedOperationException()
     }
 

utbot-sample/src/main/java/org/utbot/examples/primitives/IntExamples.java

@@ -4,6 +4,9 @@
 import java.util.List;
 
 public class IntExamples {
+    public Object kekField1;
+    public Object kekField2 = 1;
+
     public static boolean isInteger(String value) {
         try {
             return (Integer.valueOf(value) != null);