Autowire not applicationContext but actual variables (#2309)

Author: EgorkaKulikov

utbot-framework-api/src/main/kotlin/org/utbot/framework/plugin/api/Api.kt

@@ -711,11 +711,17 @@ class UtLambdaModel(
     }
 }
 
-class UtSpringContextModel : UtReferenceModel(
+object UtSpringContextModel : UtReferenceModel(
     id = null,
     classId = SpringModelUtils.applicationContextClassId,
     modelName = "applicationContext"
-)
+) {
+    // NOTE that overriding equals is required just because without it
+    // we will lose equality for objects after deserialization
+    override fun equals(other: Any?): Boolean = other is UtSpringContextModel
+
+    override fun hashCode(): Int = 0
+}
 
 data class SpringRepositoryId(
     val repositoryBeanName: String,

utbot-framework-api/src/main/kotlin/org/utbot/framework/plugin/api/util/SpringModelUtils.kt

@@ -14,15 +14,15 @@ object SpringModelUtils {
     val crudRepositoryClassId = ClassId("org.springframework.data.repository.CrudRepository")
     val entityClassId = ClassId("javax.persistence.Entity")
 
-    val getBeanMethodId = MethodId(
+    private val getBeanMethodId = MethodId(
         classId = applicationContextClassId,
         name = "getBean",
         returnType = Any::class.id,
         parameters = listOf(String::class.id),
         bypassesSandbox = true // TODO may be we can use some alternative sandbox that has more permissions
     )
 
-    val saveMethodId = MethodId(
+    private val saveMethodId = MethodId(
         classId = crudRepositoryClassId,
         name = "save",
         returnType = Any::class.id,
@@ -35,7 +35,7 @@ object SpringModelUtils {
         classId = classId,
         modelName = "@Autowired $beanName",
         instantiationCall = UtExecutableCallModel(
-            instance = UtSpringContextModel(),
+            instance = UtSpringContextModel,
             executable = getBeanMethodId,
             params = listOf(UtPrimitiveModel(beanName))
         ),
@@ -51,4 +51,7 @@ object SpringModelUtils {
         executable = saveMethodId,
         params = listOf(entityModel)
     )
+
+    fun UtModel.isAutowiredFromContext(): Boolean =
+        this is UtAssembleModel && this.instantiationCall.instance is UtSpringContextModel
 }

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

@@ -34,5 +34,5 @@ class SpringTestClassModel(
 class SpringSpecificInformation(
     val thisInstanceModels: TypedModelWrappers = mapOf(),
     val thisInstanceDependentMocks: TypedModelWrappers = mapOf(),
-    val applicationContextModels: TypedModelWrappers = mapOf(),
+    val autowiredFromContextModels: TypedModelWrappers = mapOf(),
 )

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

@@ -20,6 +20,7 @@ import org.utbot.framework.plugin.api.UtSpringContextModel
 import org.utbot.framework.plugin.api.UtStatementCallModel
 import org.utbot.framework.plugin.api.UtVoidModel
 import org.utbot.framework.plugin.api.isMockModel
+import org.utbot.framework.plugin.api.util.SpringModelUtils.isAutowiredFromContext
 
 typealias TypedModelWrappers = Map<ClassId, Set<UtModelWrapper>>
 
@@ -70,14 +71,13 @@ class SpringTestClassModelBuilder(val context: CgContext): TestClassModelBuilder
                     cgModel.model.isMockModel() && cgModel !in thisInstanceModels
                 }
 
-        val applicationContextModels = stateBeforeDependentModels
-                .filter { it.model is UtSpringContextModel }
-                .toSet()
+        val autowiredFromContextModels =
+            stateBeforeDependentModels.filterTo(HashSet()) { it.model.isAutowiredFromContext() }
 
         return SpringSpecificInformation(
             thisInstanceModels.groupByClassId(),
             dependentMockModels.groupByClassId(),
-            applicationContextModels.groupByClassId(),
+            autowiredFromContextModels.groupByClassId(),
         )
     }
 

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

@@ -1,9 +1,6 @@
 package org.utbot.framework.codegen.tree
 
 import org.utbot.framework.codegen.domain.builtin.TestClassUtilMethodProvider
-import org.utbot.framework.codegen.domain.builtin.autowiredClassId
-import org.utbot.framework.codegen.domain.builtin.injectMocksClassId
-import org.utbot.framework.codegen.domain.builtin.mockClassId
 import org.utbot.framework.codegen.domain.context.CgContext
 import org.utbot.framework.codegen.domain.models.CgClassBody
 import org.utbot.framework.codegen.domain.models.CgDeclaration
@@ -19,6 +16,7 @@ import org.utbot.framework.codegen.domain.models.CgVariable
 import org.utbot.framework.codegen.domain.models.SpringTestClassModel
 import org.utbot.framework.codegen.domain.models.builders.TypedModelWrappers
 import org.utbot.framework.plugin.api.ClassId
+import org.utbot.framework.plugin.api.UtSpringContextModel
 import org.utbot.framework.plugin.api.util.id
 import java.lang.Exception
 
@@ -111,7 +109,7 @@ abstract class CgAbstractSpringTestClassConstructor(context: CgContext):
     }
 
     /**
-     * Clears the results of variable instantiations that occured
+     * Clears the results of variable instantiations that occurred
      * when we create class variables with specific annotations.
      * Actually, only mentioned variables should be stored in `valueByModelId`.
      *
@@ -121,10 +119,11 @@ abstract class CgAbstractSpringTestClassConstructor(context: CgContext):
      * but it will take very long time to do it now.
      */
     private fun clearUnwantedVariableModels() {
-        val whiteListOfModels = variableConstructor.annotatedModelVariables.values.flatten()
+        val trustedListOfModels =
+            variableConstructor.annotatedModelVariables.values.flatten() + listOf(UtSpringContextModel.wrap())
 
         valueByUtModelWrapper
-            .filter { it.key !in whiteListOfModels }
+            .filterNot { it.key in trustedListOfModels }
             .forEach { valueByUtModelWrapper.remove(it.key) }
     }
 

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

@@ -5,12 +5,13 @@ import org.utbot.framework.codegen.domain.context.CgContext
 import org.utbot.framework.codegen.domain.models.CgFieldDeclaration
 import org.utbot.framework.codegen.domain.models.CgMethodsCluster
 import org.utbot.framework.codegen.domain.models.SpringTestClassModel
+import org.utbot.framework.plugin.api.UtSpringContextModel
 
 class CgSpringIntegrationTestClassConstructor(context: CgContext) : CgAbstractSpringTestClassConstructor(context) {
 
     override fun constructClassFields(testClassModel: SpringTestClassModel): List<CgFieldDeclaration> {
-        val applicationContextModels = testClassModel.springSpecificInformation.applicationContextModels
-        return constructFieldsWithAnnotation(autowiredClassId, applicationContextModels)
+        val autowiredFromContextModels = testClassModel.springSpecificInformation.autowiredFromContextModels
+        return constructFieldsWithAnnotation(autowiredClassId, autowiredFromContextModels)
     }
 
     override fun constructAdditionalMethods() = CgMethodsCluster(

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

@@ -5,6 +5,7 @@ import org.utbot.framework.codegen.domain.builtin.autowiredClassId
 import org.utbot.framework.codegen.domain.builtin.injectMocksClassId
 import org.utbot.framework.codegen.domain.builtin.mockClassId
 import org.utbot.framework.codegen.domain.context.CgContext
+import org.utbot.framework.codegen.domain.models.CgLiteral
 import org.utbot.framework.codegen.domain.models.CgValue
 import org.utbot.framework.codegen.domain.models.CgVariable
 import org.utbot.framework.plugin.api.ClassId
@@ -13,6 +14,9 @@ import org.utbot.framework.plugin.api.UtCompositeModel
 import org.utbot.framework.plugin.api.UtModel
 import org.utbot.framework.plugin.api.UtSpringContextModel
 import org.utbot.framework.plugin.api.isMockModel
+import org.utbot.framework.plugin.api.util.SpringModelUtils.applicationContextClassId
+import org.utbot.framework.plugin.api.util.SpringModelUtils.isAutowiredFromContext
+import org.utbot.framework.plugin.api.util.stringClassId
 
 class CgSpringVariableConstructor(context: CgContext) : CgVariableConstructor(context) {
     val annotatedModelVariables: MutableMap<ClassId, MutableSet<UtModelWrapper>> = mutableMapOf()
@@ -45,20 +49,29 @@ class CgSpringVariableConstructor(context: CgContext) : CgVariableConstructor(co
 
         val alreadyCreatedAutowired = findCgValueByModel(model, annotatedModelVariables[autowiredClassId])
         if (alreadyCreatedAutowired != null) {
-            return alreadyCreatedAutowired
+            return when  {
+                model.isAutowiredFromContext() -> {
+                    super.constructAssembleForVariable(model as UtAssembleModel)
+                }
+                else -> error("Trying to autowire model $model but it is not appropriate")
+            }
         }
 
         return when (model) {
-            is UtSpringContextModel -> constructSpringContext(model, name)
+            is UtSpringContextModel -> createApplicationContextVariable()
             else -> super.getOrCreateVariable(model, name)
         }
     }
 
-    private fun constructSpringContext(model: UtSpringContextModel, baseName: String?): CgValue {
-        val obj = newVar(model.classId, baseName) { utilsClassId[createInstance](model.classId.name) }
+    private fun createApplicationContextVariable(): CgValue {
+        // This is a kind of HACK
+        // Actually, applicationContext variable is useless as it is not used in the generated code.
+        // However, this variable existence is required for autowired fields creation process.
+        val applicationContextVariable = CgLiteral(stringClassId, "applicationContext")
 
-        valueByUtModelWrapper[model.wrap()] = obj
-        return obj
+        return applicationContextVariable.also {
+            valueByUtModelWrapper[UtSpringContextModel.wrap()] = it
+        }
     }
 
     private fun findCgValueByModel(model: UtModel, setOfModels: Set<UtModelWrapper>?): CgValue? {

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

@@ -72,6 +72,7 @@ import kotlin.reflect.KFunction
 import kotlin.reflect.jvm.kotlinFunction
 
 interface CgStatementConstructor {
+
     fun newVar(baseType: ClassId, baseName: String? = null, init: () -> CgExpression): CgVariable =
         newVar(baseType, model = null, baseName, isMutable = false, init)
 

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

@@ -37,7 +37,6 @@ import org.utbot.framework.plugin.api.BuiltinClassId
 import org.utbot.framework.plugin.api.ClassId
 import org.utbot.framework.plugin.api.CodegenLanguage
 import org.utbot.framework.plugin.api.ConstructorId
-import org.utbot.framework.plugin.api.DirectFieldAccessId
 import org.utbot.framework.plugin.api.MethodId
 import org.utbot.framework.plugin.api.UtArrayModel
 import org.utbot.framework.plugin.api.UtAssembleModel
@@ -52,7 +51,6 @@ 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.UtReferenceModel
-import org.utbot.framework.plugin.api.UtSpringContextModel
 import org.utbot.framework.plugin.api.UtStatementCallModel
 import org.utbot.framework.plugin.api.UtVoidModel
 import org.utbot.framework.plugin.api.util.classClassId
@@ -209,9 +207,27 @@ open class CgVariableConstructor(val context: CgContext) :
     }
 
     private fun constructAssemble(model: UtAssembleModel, baseName: String?): CgValue {
-        val instantiationCall = model.instantiationCall
-        processInstantiationStatement(model, instantiationCall, baseName)
+        instantiateAssembleModel(model, baseName)
+        return constructAssembleForVariable(model)
+    }
+
+    private fun instantiateAssembleModel(model: UtAssembleModel, baseName: String?) {
+        val statementCall = model.instantiationCall
+        val executable = statementCall.statement
+        val params = statementCall.params
+
+        // Don't use redundant constructors for primitives and String
+        val initExpr = if (executable is ConstructorId && isPrimitiveWrapperOrString(model.classId)) {
+            cgLiteralForWrapper(params)
+        } else {
+            createCgExecutableCallFromUtExecutableCall(statementCall)
+        }
 
+        newVar(model.classId, model, baseName) { initExpr }
+            .also { valueByUtModelWrapper[model.wrap()] = it }
+    }
+
+    protected fun constructAssembleForVariable(model: UtAssembleModel): CgValue {
         for (statementModel in model.modificationsChain) {
             when (statementModel) {
                 is UtDirectSetFieldModel -> {
@@ -233,28 +249,6 @@ open class CgVariableConstructor(val context: CgContext) :
         return valueByUtModelWrapper.getValue(model.wrap())
     }
 
-    private fun processInstantiationStatement(
-        model: UtAssembleModel,
-        statementCall: UtStatementCallModel,
-        baseName: String?
-    ) {
-        val executable = statementCall.statement
-        val params = statementCall.params
-
-        // Don't use redundant constructors for primitives and String
-        val initExpr = if (executable is ConstructorId && isPrimitiveWrapperOrString(model.classId)) {
-            cgLiteralForWrapper(params)
-        } else {
-            createCgExecutableCallFromUtExecutableCall(statementCall)
-        }
-        newVar(model.classId, model, baseName) {
-            initExpr
-        }.also {
-            valueByUtModelWrapper[model.wrap()] = it
-        }
-    }
-
-
     private fun createCgExecutableCallFromUtExecutableCall(statementModel: UtStatementCallModel): CgExecutableCall =
         when (statementModel) {
             is UtExecutableCallModel -> {