Replace all Spring specific models with models expressed in terms of UtSpringContextModel (#2279)

Author: IlyaMuravjov

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

@@ -59,6 +59,7 @@ import org.utbot.common.isAbstract
 import org.utbot.common.isStatic
 import org.utbot.framework.isFromTrustedLibrary
 import org.utbot.framework.plugin.api.TypeReplacementMode.*
+import org.utbot.framework.plugin.api.util.SpringModelUtils
 import org.utbot.framework.plugin.api.util.allDeclaredFieldIds
 import org.utbot.framework.plugin.api.util.fieldId
 import org.utbot.framework.plugin.api.util.isSubtypeOf
@@ -657,44 +658,16 @@ class UtLambdaModel(
     }
 }
 
-abstract class UtAutowiredBaseModel(
-    override val id: Int?,
-    override val classId: ClassId,
-    val origin: UtModel,
-    modelName: String
-) : UtReferenceModel(
-    id, classId, modelName
+class UtSpringContextModel : UtReferenceModel(
+    id = null,
+    classId = SpringModelUtils.applicationContextClassId,
+    modelName = "applicationContext"
 )
 
-class UtAutowiredStateBeforeModel(
-    id: Int?,
-    classId: ClassId,
-    origin: UtModel,
-    val beanName: String,
-    val repositoriesContent: List<RepositoryContentModel>,
-) : UtAutowiredBaseModel(
-    id, classId, origin, modelName = "@Autowired $beanName#$id"
-)
-
-data class RepositoryContentModel(
+data class SpringRepositoryId(
     val repositoryBeanName: String,
-    val entityModels: List<UtModel>,
-)
-
-class UtAutowiredStateAfterModel(
-    id: Int?,
-    classId: ClassId,
-    origin: UtModel,
-    val repositoryInteractions: List<RepositoryInteractionModel>,
-) : UtAutowiredBaseModel(
-    id, classId, origin, modelName = "@Autowired ${classId.name}#$id"
-)
-
-data class RepositoryInteractionModel(
-    val beanName: String,
-    val executableId: ExecutableId,
-    val args: List<UtModel>,
-    val result: UtExecutionResult
+    val repositoryClassId: ClassId,
+    val entityClassId: ClassId,
 )
 
 /**
@@ -1146,6 +1119,14 @@ sealed class ExecutableId : StatementId() {
     abstract val returnType: ClassId
     abstract val parameters: List<ClassId>
 
+    /**
+     * Normally during concrete execution every executable is executed in a
+     * [sandbox](https://github.com/UnitTestBot/UTBotJava/blob/main/docs/Sandboxing.md).
+     *
+     * However, if this flag is set to `true`, then `this` particular executable is executed without a sandbox.
+     */
+    abstract val bypassesSandbox: Boolean
+
     abstract val modifiers: Int
 
     val signature: String
@@ -1186,14 +1167,16 @@ open class MethodId(
     override val name: String,
     override val returnType: ClassId,
     override val parameters: List<ClassId>,
+    override val bypassesSandbox: Boolean = false,
 ) : ExecutableId() {
     override val modifiers: Int
         get() = method.modifiers
 }
 
 open class ConstructorId(
     override val classId: ClassId,
-    override val parameters: List<ClassId>
+    override val parameters: List<ClassId>,
+    override val bypassesSandbox: Boolean = false,
 ) : ExecutableId() {
     final override val name: String = "<init>"
     final override val returnType: ClassId = voidClassId
@@ -1208,12 +1191,13 @@ class BuiltinMethodId(
     name: String,
     returnType: ClassId,
     parameters: List<ClassId>,
+    bypassesSandbox: Boolean = false,
     // by default we assume that the builtin method is non-static and public
     isStatic: Boolean = false,
     isPublic: Boolean = true,
     isProtected: Boolean = false,
     isPrivate: Boolean = false
-) : MethodId(classId, name, returnType, parameters) {
+) : MethodId(classId, name, returnType, parameters, bypassesSandbox) {
     override val modifiers: Int = ModifierFactory {
         static = isStatic
         public = isPublic
@@ -1225,11 +1209,12 @@ class BuiltinMethodId(
 class BuiltinConstructorId(
     classId: ClassId,
     parameters: List<ClassId>,
+    bypassesSandbox: Boolean = false,
     // by default, we assume that the builtin constructor is public
     isPublic: Boolean = true,
     isProtected: Boolean = false,
     isPrivate: Boolean = false
-) : ConstructorId(classId, parameters) {
+) : ConstructorId(classId, parameters, bypassesSandbox) {
     override val modifiers: Int = ModifierFactory {
         public = isPublic
         private = isPrivate

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

@@ -76,7 +76,7 @@ fun Class<*>.singleConstructor(signature: String): Constructor<*> =
 
 fun Class<*>.singleMethodOrNull(signature: String): Method? =
         generateSequence(this) { it.superclass }.mapNotNull { clazz ->
-            clazz.declaredMethods.firstOrNull { it.signature == signature }
+            (clazz.methods + clazz.declaredMethods).firstOrNull { it.signature == signature }
         }.firstOrNull()
 
 /**

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

@@ -0,0 +1,53 @@
+package org.utbot.framework.plugin.api.util
+
+import org.utbot.framework.plugin.api.ClassId
+import org.utbot.framework.plugin.api.MethodId
+import org.utbot.framework.plugin.api.SpringRepositoryId
+import org.utbot.framework.plugin.api.UtAssembleModel
+import org.utbot.framework.plugin.api.UtExecutableCallModel
+import org.utbot.framework.plugin.api.UtModel
+import org.utbot.framework.plugin.api.UtPrimitiveModel
+import org.utbot.framework.plugin.api.UtSpringContextModel
+
+object SpringModelUtils {
+    val applicationContextClassId = ClassId("org.springframework.context.ApplicationContext")
+    val crudRepositoryClassId = ClassId("org.springframework.data.repository.CrudRepository")
+
+    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(
+        classId = crudRepositoryClassId,
+        name = "save",
+        returnType = Any::class.id,
+        parameters = listOf(Any::class.id)
+    )
+
+
+    fun createBeanModel(beanName: String, id: Int, classId: ClassId) = UtAssembleModel(
+        id = id,
+        classId = classId,
+        modelName = "@Autowired $beanName",
+        instantiationCall = UtExecutableCallModel(
+            instance = UtSpringContextModel(),
+            executable = getBeanMethodId,
+            params = listOf(UtPrimitiveModel(beanName))
+        ),
+        modificationsChainProvider = { mutableListOf() }
+    )
+
+    fun createSaveCallModel(repositoryId: SpringRepositoryId, id: Int, entityModel: UtModel) = UtExecutableCallModel(
+        instance = createBeanModel(
+            beanName = repositoryId.repositoryBeanName,
+            id = id,
+            classId = repositoryId.repositoryClassId,
+        ),
+        executable = saveMethodId,
+        params = listOf(entityModel)
+    )
+}

utbot-framework/src/main/kotlin/org/utbot/engine/UtBotSymbolicEngine.kt

@@ -386,21 +386,25 @@ class UtBotSymbolicEngine(
             .letIf(applicationContext is SpringApplicationContext
                         && applicationContext.typeReplacementApproach is TypeReplacementApproach.ReplaceIfPossible
             ) { provider ->
+                // TODO #2274 properly detect relevant repositories (right now orderRepository is hardcoded)
+                val relevantRepositories = listOf(
+                    SpringRepositoryId(
+                        repositoryBeanName = "orderRepository",
+                        repositoryClassId = ClassId("com.rest.order.repositories.OrderRepository"),
+                        entityClassId = ClassId("com.rest.order.models.Order")
+                    )
+                )
+                logger.info { "Relevant repositories: $relevantRepositories" }
                 // spring should try to generate bean values, but if it fails, then object value provider is used for it
                 val springBeanValueProvider = SpringBeanValueProvider(
                     defaultIdGenerator,
-                    beanProvider = { classId ->
+                    beanNameProvider = { classId ->
                         (applicationContext as SpringApplicationContext).beanDefinitions
                             .filter { it.beanTypeFqn == classId.name }
                             .map { it.beanName }
                     },
-                    autowiredModelOriginCreator = { beanName ->
-                        runBlocking {
-                            logger.info { "Getting bean: $beanName" }
-                            concreteExecutor.withProcess { getBean(beanName) }
-                        }
-                    }).withFallback(ObjectValueProvider(defaultIdGenerator))
-
+                    relevantRepositories = relevantRepositories
+                ).withFallback(ObjectValueProvider(defaultIdGenerator))
                 provider.except { p -> p is ObjectValueProvider }.with(springBeanValueProvider)
             }.let(transform)
         runJavaFuzzing(

utbot-framework/src/main/kotlin/org/utbot/framework/assemble/AssembleModelGenerator.kt

@@ -204,7 +204,7 @@ class AssembleModelGenerator(private val basePackageName: String) {
                     is UtArrayModel -> assembleArrayModel(utModel)
                     is UtCompositeModel -> assembleCompositeModel(utModel)
                     is UtAssembleModel -> assembleAssembleModel(utModel)
-                    // Python, JavaScript are supposed to be here as well
+                    // Python, JavaScript, UtSpringContextModel are supposed to be here as well
                     else -> utModel
                 }
             } catch (e: AssembleException) {

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

@@ -16,6 +16,7 @@ import org.utbot.framework.plugin.api.UtLambdaModel
 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.UtSpringContextModel
 import org.utbot.framework.plugin.api.UtStatementCallModel
 import org.utbot.framework.plugin.api.UtVoidModel
 import org.utbot.framework.plugin.api.isMockModel
@@ -95,7 +96,8 @@ class SpringTestClassModelBuilder(val context: CgContext): TestClassModelBuilder
             is UtPrimitiveModel,
             is UtClassRefModel,
             is UtVoidModel,
-            is UtEnumConstantModel -> {}
+            is UtEnumConstantModel,
+            is UtSpringContextModel -> {}
             is UtLambdaModel -> {
                 currentModel.capturedValues.forEach { collectRecursively(it, allModels) }
             }

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

@@ -1,5 +1,6 @@
 package org.utbot.framework.codegen.tree
 
+import mu.KotlinLogging
 import org.utbot.common.WorkaroundReason
 import org.utbot.common.isStatic
 import org.utbot.common.workaround
@@ -162,6 +163,10 @@ open class CgMethodConstructor(val context: CgContext) : CgContextOwner by conte
     CgCallableAccessManager by getCallableAccessManagerBy(context),
     CgStatementConstructor by getStatementConstructorBy(context) {
 
+    companion object {
+        private val logger = KotlinLogging.logger {}
+    }
+
     protected val nameGenerator = getNameGeneratorBy(context)
     protected val testFrameworkManager = getTestFrameworkManagerBy(context)
 
@@ -470,6 +475,8 @@ open class CgMethodConstructor(val context: CgContext) : CgContextOwner by conte
                 neededStackTraceLines += TAB + line
             }
         }
+        if (!executableCallFound)
+            logger.warn(exception) { "Failed to find executable call in stack trace" }
 
         +CgMultilineComment(warningLine + neededStackTraceLines.reversed())
     }

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

@@ -5,36 +5,19 @@ import org.utbot.framework.codegen.domain.context.CgContext
 import org.utbot.framework.codegen.domain.models.CgValue
 import org.utbot.framework.codegen.domain.models.CgVariable
 import org.utbot.framework.plugin.api.UtAssembleModel
-import org.utbot.framework.plugin.api.UtAutowiredBaseModel
-import org.utbot.framework.plugin.api.UtAutowiredStateBeforeModel
 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.jClass
 
 class CgSpringVariableConstructor(context: CgContext) : CgVariableConstructor(context) {
     val injectedMocksModelsVariables: MutableSet<UtModelWrapper> = mutableSetOf()
     val mockedModelsVariables: MutableSet<UtModelWrapper> = mutableSetOf()
 
     override fun getOrCreateVariable(model: UtModel, name: String?): CgValue {
-        if (model is UtAutowiredBaseModel) {
+        if (model is UtSpringContextModel) {
             // TODO also, properly render corresponding @Autowired field(s), and make sure name isn't taken
-            if (model is UtAutowiredStateBeforeModel) {
-                comment("begin repository fill up")
-                model.repositoriesContent.forEach { repositoryContent ->
-                    repositoryContent.entityModels.forEach { entity ->
-                        // TODO actually fill up repositories
-                        getOrCreateVariable(entity)
-                        emptyLine()
-                    }
-                }
-                comment("end repository fill up")
-            }
-            emptyLine()
-            return CgVariable(
-                name ?: model.classId.jClass.simpleName.let { it[0].lowercase() + it.drop(1) },
-                model.classId
-            )
+            return CgVariable(model.modelName, model.classId)
         }
 
         val alreadyCreatedInjectMocks = findCgValueByModel(model, injectedMocksModelsVariables)

utbot-framework/src/main/kotlin/org/utbot/framework/fields/ExecutionStateAnalyzer.kt

@@ -8,7 +8,6 @@ import org.utbot.framework.plugin.api.ClassId
 import org.utbot.framework.plugin.api.MissingState
 import org.utbot.framework.plugin.api.UtArrayModel
 import org.utbot.framework.plugin.api.UtAssembleModel
-import org.utbot.framework.plugin.api.UtAutowiredBaseModel
 import org.utbot.framework.plugin.api.UtClassRefModel
 import org.utbot.framework.plugin.api.UtCompositeModel
 import org.utbot.framework.plugin.api.UtEnumConstantModel
@@ -18,6 +17,7 @@ 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.UtSymbolicExecution
 import org.utbot.framework.plugin.api.UtVoidModel
 import org.utbot.framework.util.UtModelVisitor
@@ -238,8 +238,8 @@ private class FieldStateVisitor : UtModelVisitor<FieldData>() {
         recordFieldState(data, element)
     }
 
-    override fun visit(element: UtAutowiredBaseModel, data: FieldData) {
-        element.origin.accept(this, data)
+    override fun visit(element: UtSpringContextModel, data: FieldData) {
+        recordFieldState(data, element)
     }
 
     private fun recordFieldState(data: FieldData, model: UtModel) {

utbot-framework/src/main/kotlin/org/utbot/framework/minimization/Minimization.kt

@@ -235,7 +235,7 @@ private fun UtModel.calculateSize(used: MutableSet<UtModel> = mutableSetOf()): I
         }
         is UtCompositeModel -> 1 + fields.values.sumOf { it.calculateSize(used) }
         is UtLambdaModel -> 1 + capturedValues.sumOf { it.calculateSize(used) }
-        // PythonModel, JsUtModel may be here
+        // PythonModel, JsUtModel, UtSpringContextModel may be here
         else -> 0
     }
 }