Add support for class fields rendering with annotations

sofurihafe · sofurihafe · commit 5df5bc2f39e2 · 2023-02-18T18:35:38.000+03:00
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/domain/Domain.kt b/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/domain/Domain.kt
@@ -290,6 +290,23 @@ object TestNg : TestFramework(id = "TestNG",displayName = "TestNG") {
         simpleName = "ThrowingRunnable"
     )
 
+    val beforeMethodAnnotation: String = "@$mainPackage.BeforeMethod"
+    val beforeMethodAnnotationFqn: String = "$mainPackage.BeforeMethod"
+    val afterMethodAnnotation: String = "@$mainPackage.AfterMethod"
+    val afterMethodAnnotationFqn: String = "$mainPackage.AfterMethod"
+
+    val beforeMethodAnnotationId: ClassId =
+        BuiltinClassId(
+            canonicalName = "$mainPackage.annotations.BeforeMethod",
+            simpleName = "BeforeMethod"
+        )
+
+    val afterMethodAnnotationId: ClassId =
+        BuiltinClassId(
+            canonicalName = "$mainPackage.annotations.AfterMethod",
+            simpleName = "AfterMethod"
+        )
+
     val assertThrows = builtinStaticMethodId(
         classId = assertionsClass,
         name = "assertThrows",
@@ -370,7 +387,7 @@ object Junit4 : TestFramework(id = "JUnit4",displayName = "JUnit 4") {
         get() = error("Parametrized tests are not supported for JUnit 4")
 
     override val mainPackage: String = JUNIT4_PACKAGE
-    override val testAnnotation = "@$mainPackage.Test"
+    override val testAnnotation: String = "@$mainPackage.Test"
     override val testAnnotationFqn: String = "$mainPackage.Test"
 
     override val parameterizedTestAnnotation
@@ -395,6 +412,23 @@ object Junit4 : TestFramework(id = "JUnit4",displayName = "JUnit 4") {
         simpleName = "RunWith"
     )
 
+    val beforeAnnotation: String = "@$mainPackage.Before"
+    val beforeAnnotationFqn: String = "$mainPackage.Before"
+    val afterAnnotation: String = "@$mainPackage.After"
+    val afterAnnotationFqn: String = "$mainPackage.After"
+
+    val beforeAnnotationId: ClassId =
+        BuiltinClassId(
+            canonicalName = "$JUNIT4_PACKAGE.Before",
+            simpleName = "Before"
+        )
+
+    val afterAnnotationId: ClassId =
+        BuiltinClassId(
+            canonicalName = "$JUNIT4_PACKAGE.After",
+            simpleName = "After"
+        )
+
     override val assertionsClass = BuiltinClassId(
         canonicalName = JUNIT4_ASSERTIONS,
         simpleName = "Assert"
@@ -431,13 +465,30 @@ 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"
 
+    val beforeEachAnnotation: String = "@$mainPackage.BeforeEach"
+    val beforeEachAnnotationFqn: String = "$mainPackage.BeforeEach"
+    val afterEachAnnotation: String = "@$mainPackage.AfterEach"
+    val afterEachAnnotationFqn: String = "$mainPackage.AfterEach"
+
+    val beforeEachAnnotationId: ClassId =
+        BuiltinClassId(
+            canonicalName = "$JUNIT5_PACKAGE.BeforeEach",
+            simpleName = "BeforeEach"
+        )
+
+    val afterEachAnnotationId: ClassId =
+        BuiltinClassId(
+            canonicalName = "$JUNIT5_PACKAGE.AfterEach",
+            simpleName = "AfterEach"
+        )
+
     val executableClassId = BuiltinClassId(
         canonicalName = "$JUNIT5_PACKAGE.function.Executable",
         simpleName = "Executable"
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/domain/builtin/MockitoBuiltins.kt b/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",
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/domain/models/CgElement.kt b/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)
@@ -155,8 +156,19 @@ 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: List<CgFieldDeclaration> = emptyList(),
+) : CgElement
+
+/**
+ * Field of a class.
+ * @property classId [ClassId] of the field owner class.
+ * @property declaration declaration itself.
+ * @property annotation optional annotation.
+ */
+class CgFieldDeclaration(
+    val classId: ClassId,
+    val declaration: CgDeclaration,
+    val annotation: CgAnnotation? = null,
 ) : CgElement
 
 /**
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/domain/models/TestClassModel.kt b/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/domain/models/TestClassModel.kt
@@ -13,7 +13,7 @@ abstract class TestClassModel(
     val nestedClasses: List<SimpleTestClassModel>,
 )
 
-open class SimpleTestClassModel(
+class SimpleTestClassModel(
     classUnderTest: ClassId,
     methodTestSets: List<CgMethodTestSet>,
     nestedClasses: List<SimpleTestClassModel> = listOf(),
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/renderer/CgAbstractRenderer.kt b/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.CgGreaterThan
@@ -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)
 
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/renderer/CgJavaRenderer.kt b/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 ")
@@ -376,7 +376,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 ")
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/renderer/CgKotlinRenderer.kt b/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
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/renderer/CgVisitor.kt b/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/renderer/CgVisitor.kt
@@ -76,6 +76,7 @@ import org.utbot.framework.codegen.domain.models.CgSwitchCaseLabel
 import org.utbot.framework.codegen.domain.models.CgClass
 import org.utbot.framework.codegen.domain.models.CgClassBody
 import org.utbot.framework.codegen.domain.models.CgDocRegularLineStmt
+import org.utbot.framework.codegen.domain.models.CgFieldDeclaration
 import org.utbot.framework.codegen.domain.models.CgFormattedString
 import org.utbot.framework.codegen.domain.models.CgNestedClassesRegion
 import org.utbot.framework.codegen.domain.models.CgTestMethod
@@ -183,6 +184,9 @@ interface CgVisitor<R> {
     // Variable declaration
     fun visit(element: CgDeclaration): R
 
+    // Field declaration
+    fun visit(element: CgFieldDeclaration): R
+
     // Variable assignment
     fun visit(element: CgAssignment): R
 
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/codegen/tree/Builders.kt b/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
@@ -66,7 +67,7 @@ class CgClassBodyBuilder(val classId: ClassId) : CgBuilder<CgClassBody> {
     val methodRegions: MutableList<CgMethodsCluster> = mutableListOf()
     val staticDeclarationRegions: MutableList<CgStaticsRegion> = mutableListOf()
     val nestedClassRegions: MutableList<CgNestedClassesRegion<*>> = mutableListOf()
-    val fields: MutableList<CgDeclaration> = mutableListOf()
+    val fields: MutableList<CgFieldDeclaration> = mutableListOf()
 
     override fun build() = CgClassBody(classId, methodRegions, staticDeclarationRegions, nestedClassRegions, fields)
 }
diff --git a/utbot-python/src/main/kotlin/org/utbot/python/framework/codegen/model/constructor/visitor/CgPythonRenderer.kt b/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()
     }
 

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ abstract class TestClassModel(`
`13`	`13`	`val nestedClasses: List<SimpleTestClassModel>,`
`14`	`14`	`)`
`15`	`15`
`16`		`-open class SimpleTestClassModel(`
	`16`	`+class SimpleTestClassModel(`
`17`	`17`	`classUnderTest: ClassId,`
`18`	`18`	`methodTestSets: List<CgMethodTestSet>,`
`19`	`19`	`nestedClasses: List<SimpleTestClassModel> = listOf(),`
Original file line number	Diff line number	Diff line change
`@@ -415,7 +415,7 @@ internal class CgPythonRenderer(`
`415`	`415`	`}`
`416`	`416`
`417`	`417`	`override fun escapeNamePossibleKeywordImpl(s: String): String = s`
`418`		`- override fun renderClassVisibility(classId: ClassId) {`
	`418`	`+ override fun renderVisibility(classId: ClassId) {`
`419`	`419`	`throw UnsupportedOperationException()`
`420`	`420`	`}`
`421`	`421`