Add support for class fields rendering with annotations

Author: sofurihafe

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

@@ -7,6 +7,7 @@ import org.utbot.framework.codegen.renderer.CgRendererContext
 import org.utbot.framework.codegen.renderer.CgVisitor
 import org.utbot.framework.codegen.renderer.auxiliaryClassTextById
 import org.utbot.framework.codegen.renderer.utilMethodTextById
+import org.utbot.framework.codegen.tree.VisibilityModifier
 import org.utbot.framework.plugin.api.BuiltinClassId
 import org.utbot.framework.plugin.api.ClassId
 import org.utbot.framework.plugin.api.ConstructorId
@@ -82,6 +83,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)
@@ -134,6 +136,7 @@ class CgClass(
     val body: CgClassBody,
     val isStatic: Boolean,
     val isNested: Boolean,
+    val visibility: VisibilityModifier = VisibilityModifier.PUBLIC,
 ): CgElement {
     val packageName
         get() = id.packageName
@@ -156,8 +159,21 @@ class CgClassBody(
     val methodRegions: List<CgMethodsCluster>,
     val staticDeclarationRegions: List<CgStaticsRegion>,
     val nestedClassRegions: List<CgNestedClassesRegion<*>>,
-    //TODO: use [CgFieldDeclaration] after PR-1788 merge
-    val fields: List<CgDeclaration> = emptyList(),
+    val fields: Set<CgFieldDeclaration> = emptySet(),
+) : CgElement
+
+/**
+ * Field of a class.
+ * @property ownerClassId [ClassId] of the field owner class.
+ * @property declaration declaration itself.
+ * @property annotation optional annotation.
+ * @property visibility field visibility.
+ */
+class CgFieldDeclaration(
+    val ownerClassId: ClassId,
+    val declaration: CgDeclaration,
+    val annotation: CgAnnotation? = null,
+    val visibility: VisibilityModifier = VisibilityModifier.PUBLIC,
 ) : CgElement
 
 /**
@@ -272,6 +288,7 @@ sealed class CgMethod(open val isStatic: Boolean) : CgElement {
     abstract val annotations: List<CgAnnotation>
     abstract val documentation: CgDocumentationComment
     abstract val requiredFields: List<CgParameterDeclaration>
+    abstract val visibility: VisibilityModifier
 }
 
 class CgTestMethod(
@@ -281,6 +298,7 @@ class CgTestMethod(
     override val statements: List<CgStatement>,
     override val exceptions: Set<ClassId>,
     override val annotations: List<CgAnnotation>,
+    override val visibility: VisibilityModifier = VisibilityModifier.PUBLIC,
     val type: CgTestMethodType,
     override val documentation: CgDocumentationComment = CgDocumentationComment(emptyList()),
     override val requiredFields: List<CgParameterDeclaration> = emptyList(),
@@ -291,6 +309,7 @@ class CgFrameworkUtilMethod(
     override val statements: List<CgStatement>,
     override val exceptions: Set<ClassId>,
     override val annotations: List<CgAnnotation>,
+    override val visibility: VisibilityModifier = VisibilityModifier.PUBLIC,
 ) : CgMethod(isStatic = false) {
     override val returnType: ClassId = voidClassId
     override val parameters: List<CgParameterDeclaration> = emptyList()
@@ -301,7 +320,8 @@ class CgFrameworkUtilMethod(
 class CgErrorTestMethod(
     override val name: String,
     override val statements: List<CgStatement>,
-    override val documentation: CgDocumentationComment = CgDocumentationComment(emptyList())
+    override val documentation: CgDocumentationComment = CgDocumentationComment(emptyList()),
+    override val visibility: VisibilityModifier = VisibilityModifier.PUBLIC,
 ) : CgMethod(isStatic = false) {
     override val exceptions: Set<ClassId> = emptySet()
     override val returnType: ClassId = voidClassId
@@ -316,6 +336,7 @@ class CgParameterizedTestDataProviderMethod(
     override val returnType: ClassId,
     override val annotations: List<CgAnnotation>,
     override val exceptions: Set<ClassId>,
+    override val visibility: VisibilityModifier = VisibilityModifier.PUBLIC,
 ) : CgMethod(isStatic = true) {
     override val parameters: List<CgParameterDeclaration> = emptyList()
     override val documentation: CgDocumentationComment = CgDocumentationComment(emptyList())

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

@@ -1,6 +1,7 @@
 package org.utbot.framework.codegen.domain.models
 
 import org.utbot.framework.plugin.api.ClassId
+import org.utbot.framework.plugin.api.UtModel
 
 /**
  * Stores method test sets in a structure that replicates structure of their methods in [classUnderTest].
@@ -13,7 +14,7 @@ abstract class TestClassModel(
     val nestedClasses: List<SimpleTestClassModel>,
 )
 
-open class SimpleTestClassModel(
+class SimpleTestClassModel(
     classUnderTest: ClassId,
     methodTestSets: List<CgMethodTestSet>,
     nestedClasses: List<SimpleTestClassModel> = listOf(),
@@ -29,7 +30,7 @@ class SpringTestClassModel(
     classUnderTest: ClassId,
     methodTestSets: List<CgMethodTestSet>,
     nestedClasses: List<SimpleTestClassModel>,
-    val injectingMocksClass: ClassId? = null,
-    val mockedClasses: Set<ClassId> = setOf(),
+    val injectedMockModels: Map<ClassId, Set<UtModel>> = mapOf(),
+    val mockedModels: Map<ClassId, Set<UtModel>> = mapOf(),
 ): TestClassModel(classUnderTest, methodTestSets, nestedClasses)
 

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

@@ -16,32 +16,40 @@ import org.utbot.framework.plugin.api.UtModel
 import org.utbot.framework.plugin.api.UtNullModel
 import org.utbot.framework.plugin.api.UtPrimitiveModel
 import org.utbot.framework.plugin.api.UtVoidModel
+import org.utbot.framework.plugin.api.isMockModel
 
 class SpringTestClassModelBuilder: TestClassModelBuilder() {
 
     override fun createTestClassModel(classUnderTest: ClassId, testSets: List<CgMethodTestSet>): SpringTestClassModel {
         val baseModel = SimpleTestClassModelBuilder().createTestClassModel(classUnderTest, testSets)
-        val mockedClasses = collectMockedClassIds(classUnderTest, testSets)
+        val (injectedModels, mockedModels) = collectInjectedAndMockedModels(testSets)
 
         return SpringTestClassModel(
             baseModel.classUnderTest,
             baseModel.methodTestSets,
             baseModel.nestedClasses,
-            classUnderTest,
-            mockedClasses,
+            injectedModels,
+            mockedModels,
         )
     }
 
-    private fun collectMockedClassIds(
-        classUnderTest: ClassId,
+    private fun collectInjectedAndMockedModels(
         testSets: List<CgMethodTestSet>,
-    ): Set<ClassId> {
+    ): Pair<Map<ClassId, Set<UtModel>>, Map<ClassId, Set<UtModel>>> {
+        val thisInstances = mutableSetOf<UtModel>()
         val allModelsInExecution = mutableListOf<UtModel>()
 
         for (testSet in testSets) {
             for (execution in testSet.executions) {
-                execution.stateBefore.thisInstance?.let { allModelsInExecution += it }
-                execution.stateAfter.thisInstance?.let { allModelsInExecution += it }
+                execution.stateBefore.thisInstance?.let {
+                    allModelsInExecution += it
+                    thisInstances += it
+                }
+
+                execution.stateAfter.thisInstance?.let {
+                    allModelsInExecution += it
+                    thisInstances += it
+                }
 
                 allModelsInExecution += execution.stateBefore.parameters
                 allModelsInExecution += execution.stateAfter.parameters
@@ -53,21 +61,22 @@ class SpringTestClassModelBuilder: TestClassModelBuilder() {
         val allConstructedModels = mutableSetOf<UtModel>()
         allModelsInExecution.forEach { model -> collectRecursively(model, allConstructedModels) }
 
-        return allConstructedModels
-            .filter { it.isMockComposite() || it.isMockAssemble() }
-            .map { it.classId }
-            .filter {  it != classUnderTest }
-            .toSet()
+        val mockedModels =
+            allConstructedModels
+                .filterTo(mutableSetOf()) { it.isMockModel() && it !in thisInstances }
+
+        return thisInstances.groupByClassId() to mockedModels.groupByClassId()
+    }
 
+    private fun Set<UtModel>.groupByClassId(): Map<ClassId, Set<UtModel>> {
+        return this.groupBy { it.classId }.mapValues { it.value.toSet() }
     }
 
     private fun collectRecursively(currentModel: UtModel, allModels: MutableSet<UtModel>) {
-        if (currentModel in allModels) {
+        if (!allModels.add(currentModel)) {
             return
         }
 
-        allModels += currentModel
-
         when (currentModel) {
             is UtNullModel,
             is UtPrimitiveModel,
@@ -104,9 +113,4 @@ class SpringTestClassModelBuilder: TestClassModelBuilder() {
             //Python, JavaScript, Go models are not required in Spring
         }
     }
-
-    private fun UtModel.isMockComposite(): Boolean = this is UtCompositeModel && this.isMock
-
-    //TODO: Having an assemble model often means that we do not use its origin, so is this composite mock redundant?
-    private fun UtModel.isMockAssemble(): Boolean = this is UtAssembleModel && this.origin?.isMock == true
 }

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

@@ -41,6 +41,7 @@ import org.utbot.framework.codegen.domain.models.CgExecutableCall
 import org.utbot.framework.codegen.domain.models.CgMethodsCluster
 import org.utbot.framework.codegen.domain.models.CgExpression
 import org.utbot.framework.codegen.domain.models.CgFieldAccess
+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.CgFrameworkUtilMethod
@@ -83,6 +84,7 @@ import org.utbot.framework.codegen.domain.models.CgTryCatch
 import org.utbot.framework.codegen.domain.models.CgUtilMethod
 import org.utbot.framework.codegen.domain.models.CgVariable
 import org.utbot.framework.codegen.domain.models.CgWhileLoop
+import org.utbot.framework.codegen.tree.VisibilityModifier
 import org.utbot.framework.codegen.tree.ututils.UtilClassKind
 import org.utbot.framework.plugin.api.ClassId
 import org.utbot.framework.plugin.api.CodegenLanguage
@@ -574,6 +576,14 @@ abstract class CgAbstractRenderer(
         println(statementEnding)
     }
 
+    // Class field declaration
+
+    override fun visit(element: CgFieldDeclaration) {
+        element.annotation?.accept(this)
+        renderVisibility(element.visibility)
+        element.declaration.accept(this)
+    }
+
     // Variable assignment
 
     override fun visit(element: CgAssignment) {
@@ -891,7 +901,7 @@ abstract class CgAbstractRenderer(
         }
     }
 
-    protected abstract fun renderClassVisibility(classId: ClassId)
+    protected abstract fun renderVisibility(modifier: VisibilityModifier)
 
     protected abstract fun renderClassModality(aClass: CgClass)
 

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

@@ -38,13 +38,11 @@ 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.CgVariable
+import org.utbot.framework.codegen.tree.VisibilityModifier
 import org.utbot.framework.codegen.util.nullLiteral
 import org.utbot.framework.plugin.api.ClassId
 import org.utbot.framework.plugin.api.TypeParameters
 import org.utbot.framework.plugin.api.util.isFinal
-import org.utbot.framework.plugin.api.util.isPrivate
-import org.utbot.framework.plugin.api.util.isProtected
-import org.utbot.framework.plugin.api.util.isPublic
 import org.utbot.framework.plugin.api.util.wrapperByPrimitive
 
 internal class CgJavaRenderer(context: CgRendererContext, printer: CgPrinter = CgPrinterImpl()) :
@@ -70,7 +68,7 @@ internal class CgJavaRenderer(context: CgRendererContext, printer: CgPrinter = C
             annotation.accept(this)
         }
 
-        renderClassVisibility(element.id)
+        renderVisibility(element.visibility)
         renderClassModality(element)
         if (element.isStatic) {
             print("static ")
@@ -92,6 +90,12 @@ internal class CgJavaRenderer(context: CgRendererContext, printer: CgPrinter = C
     }
 
     override fun visit(element: CgClassBody) {
+        // render class fields
+        for (field in element.fields) {
+            field.accept(this)
+            println()
+        }
+
         // render regions for test methods and utils
         val allRegions = element.methodRegions + element.nestedClassRegions + element.staticDeclarationRegions
         for ((i, region) in allRegions.withIndex()) {
@@ -230,8 +234,9 @@ internal class CgJavaRenderer(context: CgRendererContext, printer: CgPrinter = C
     }
 
     override fun renderMethodSignature(element: CgTestMethod) {
+        renderVisibility(element.visibility)
         // test methods always have void return type
-        print("public void ")
+        print("void ")
         print(element.name)
 
         print("(")
@@ -243,21 +248,25 @@ internal class CgJavaRenderer(context: CgRendererContext, printer: CgPrinter = C
     }
 
     override fun renderMethodSignature(element: CgErrorTestMethod) {
+        renderVisibility(element.visibility)
         // error test methods always have void return type
-        println("public void ${element.name}()")
+        println("void ${element.name}()")
     }
 
     override fun renderMethodSignature(element: CgParameterizedTestDataProviderMethod) {
         //we do not have a good string representation for two-dimensional array, so this strange if-else is required
         val returnType =
             if (element.returnType.simpleName == "Object[][]") "java.lang.Object[][]" else "${element.returnType}"
-        print("public static $returnType ${element.name}()")
+
+        renderVisibility(element.visibility)
+        print("static $returnType ${element.name}()")
         renderExceptions(element)
     }
 
     override fun renderMethodSignature(element: CgFrameworkUtilMethod) {
+        renderVisibility(element.visibility)
         // framework util methods always have void return type
-        print("public void ")
+        print("void ")
         print(element.name)
         print("()")
 
@@ -388,11 +397,14 @@ internal class CgJavaRenderer(context: CgRendererContext, printer: CgPrinter = C
 
     override fun escapeNamePossibleKeywordImpl(s: String): String = s
 
-    override fun renderClassVisibility(classId: ClassId) {
-        when {
-            classId.isPublic -> print("public ")
-            classId.isProtected -> print("protected ")
-            classId.isPrivate -> print("private ")
+    override fun renderVisibility(modifier: VisibilityModifier) {
+        when (modifier) {
+            VisibilityModifier.PUBLIC -> print("public ")
+            VisibilityModifier.PRIVATE -> print("private ")
+            VisibilityModifier.PROTECTED -> print("protected ")
+            VisibilityModifier.INTERNAL -> print("internal ")
+            VisibilityModifier.PACKAGEPRIVATE -> Unit
+            else -> error("Java: unexpected visibility modifier -- $modifier")
         }
     }