Extract utbot-spring-framework module from utbot-framework (#2570)

* Make `relevantFieldManagers` a dynamic property, since it's Spring-specific

Remove `CgContext.relevantFieldManagers` field

* Move `springNoConfigApplicationContext` constant from `utbot-testing` to `utbot-spring-test`

* Extract `utbot-spring-framework` module from `utbot-framework-module`

Remove duplicated `include("utbot-spring-framework")` in `settings.gradle.kts`

* Rename `DependencyInjectionFramework` to `SpringModule` and stop implementing `CodeGenerationSettingItem` as it's not a setting

* Move `SpringModule` from `utbot-framework` to `utbot-spring-framework`

* Remove unused imports, update comments

* Introduce `EngineProcessTask`

* Use `EngineProcessTask` to call spring analyzer

* Make `SpringModule` a `enum`

Author: IlyaMuravjov

settings.gradle.kts

@@ -56,6 +56,7 @@ if (includeRiderInBuild.toBoolean()) {
 
 include("utbot-ui-commons")
 
+include("utbot-spring-framework")
 include("utbot-spring-commons-api")
 include("utbot-spring-commons")
 include("utbot-spring-analyzer")

utbot-core/src/main/kotlin/org/utbot/common/DynamicProperties.kt

@@ -36,6 +36,11 @@ interface MutableDynamicProperties<TOwner> : DynamicProperties<TOwner> {
     operator fun <T> set(property: DynamicProperty<TOwner, T>, value: T)
 }
 
+fun <TOwner, T> MutableDynamicProperties<TOwner>.getOrPut(property: DynamicProperty<TOwner, T>, default: () -> T): T {
+    if (property !in this) set(property, default())
+    return getValue(property)
+}
+
 fun <TOwner> Iterable<InitialisedDynamicProperty<TOwner, *>>.toMutableDynamicProperties(): MutableDynamicProperties<TOwner> =
     DynamicPropertiesImpl<TOwner>().also { properties ->
         forEach { properties.add(it) }

utbot-framework/build.gradle

@@ -3,8 +3,6 @@ plugins {
 }
 
 configurations {
-    fetchSpringAnalyzerJar
-    fetchSpringCommonsJar
     fetchInstrumentationJar
 }
 
@@ -48,23 +46,10 @@ dependencies {
     implementation group: 'com.github.UnitTestBot.ksmt', name: 'ksmt-z3', version: ksmtVersion
 
     fetchInstrumentationJar project(path: ':utbot-instrumentation', configuration: 'instrumentationArchive')
-
-    implementation project(':utbot-spring-commons-api')
-    implementation project(':utbot-spring-analyzer')
-    fetchSpringAnalyzerJar project(path: ':utbot-spring-analyzer', configuration: 'springAnalyzerJar')
-    fetchSpringCommonsJar project(path: ':utbot-spring-commons', configuration: 'springCommonsJar')
 }
 
 processResources {
     from(configurations.fetchInstrumentationJar) {
         into "lib"
     }
-
-    from(configurations.fetchSpringAnalyzerJar) {
-        into "lib"
-    }
-
-    from(configurations.fetchSpringCommonsJar) {
-        into "lib"
-    }
 }

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

@@ -205,12 +205,12 @@ class AssembleModelGenerator(private val basePackageName: String) {
                     is UtClassRefModel,
                     is UtVoidModel,
                     is UtEnumConstantModel,
-                    is UtCustomModel -> utModel
+                    is UtCustomModel -> utModel // for example, UtSpringContextModel
                     is UtLambdaModel -> assembleLambdaModel(utModel)
                     is UtArrayModel -> assembleArrayModel(utModel)
                     is UtCompositeModel -> assembleCompositeModel(utModel)
                     is UtAssembleModel -> assembleAssembleModel(utModel)
-                    // Python, JavaScript, UtSpringContextModel are supposed to be here as well
+                    // Python, JavaScript are supposed to be here as well
                     else -> utModel
                 }
             } catch (e: AssembleException) {

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

@@ -711,47 +711,6 @@ enum class ProjectType {
     JavaScript,
 }
 
-abstract class DependencyInjectionFramework(
-    override val id: String,
-    override val displayName: String,
-    override val description: String = "Use $displayName as dependency injection framework",
-    val testFrameworkDisplayName: String,
-    /**
-     * Generation Spring specific tests requires special spring test framework being installed,
-     * so we can use `TestContextManager` from `spring-test` to configure test context in
-     * spring-analyzer and to run integration tests.
-     */
-    var testFrameworkInstalled: Boolean = false
-) : CodeGenerationSettingItem {
-    var isInstalled = false
-
-    companion object : CodeGenerationSettingBox {
-        override val defaultItem: DependencyInjectionFramework get() = SpringBoot
-        override val allItems: List<DependencyInjectionFramework> get() = listOf(SpringBoot, SpringBeans)
-
-        val installedItems get() = allItems.filter { it.isInstalled }
-
-        /**
-         * Generation Spring specific tests requires special spring test framework being installed,
-         * so we can use `TestContextManager` from `spring-test` to configure test context in
-         * spring-analyzer and to run integration tests.
-         */
-        var testFrameworkInstalled: Boolean = false
-    }
-}
-
-object SpringBeans : DependencyInjectionFramework(
-    id = "spring-beans",
-    displayName = "Spring Beans",
-    testFrameworkDisplayName = "spring-test",
-)
-
-object SpringBoot : DependencyInjectionFramework(
-    id = "spring-boot",
-    displayName = "Spring Boot",
-    testFrameworkDisplayName = "spring-boot-test",
-)
-
 /**
  * Extended [UtModel] model with testSet id and execution id.
  *

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

@@ -20,21 +20,6 @@ internal val mockitoClassId = BuiltinClassId(
     simpleName = "Mockito",
 )
 
-internal val mockClassId = BuiltinClassId(
-    canonicalName = "org.mockito.Mock",
-    simpleName = "Mock",
-)
-
-internal val spyClassId = BuiltinClassId(
-    canonicalName = "org.mockito.Spy",
-    simpleName = "Spy"
-)
-
-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/builtin/UtilMethodBuiltins.kt

@@ -278,7 +278,7 @@ internal class UtilClassFileMethodProvider(language: CodegenLanguage)
     val UTIL_CLASS_VERSION = "2.1"
 }
 
-internal class TestClassUtilMethodProvider(testClassId: ClassId) : UtilMethodProvider(testClassId)
+class TestClassUtilMethodProvider(testClassId: ClassId) : UtilMethodProvider(testClassId)
 
 internal fun selectUtilClassId(codegenLanguage: CodegenLanguage): ClassId =
     when (codegenLanguage) {

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

@@ -13,6 +13,9 @@ import kotlinx.collections.immutable.PersistentSet
 import kotlinx.collections.immutable.persistentListOf
 import kotlinx.collections.immutable.persistentMapOf
 import kotlinx.collections.immutable.persistentSetOf
+import org.utbot.common.DynamicProperty
+import org.utbot.common.MutableDynamicProperties
+import org.utbot.common.mutableDynamicPropertiesOf
 import org.utbot.framework.codegen.domain.UtModelWrapper
 import org.utbot.framework.codegen.domain.ProjectType
 import org.utbot.framework.codegen.domain.builtin.TestClassUtilMethodProvider
@@ -25,7 +28,6 @@ import org.utbot.framework.codegen.tree.importIfNeeded
 import org.utbot.framework.plugin.api.BuiltinClassId
 import org.utbot.framework.plugin.api.ClassId
 import org.utbot.framework.codegen.services.language.CgLanguageAssistant
-import org.utbot.framework.codegen.tree.fieldmanager.CgAbstractClassFieldManager
 import org.utbot.framework.plugin.api.CodegenLanguage
 import org.utbot.framework.plugin.api.ExecutableId
 import org.utbot.framework.plugin.api.FieldId
@@ -38,6 +40,9 @@ import org.utbot.framework.plugin.api.util.isCheckedException
 import org.utbot.framework.plugin.api.util.isSubtypeOf
 import org.utbot.framework.plugin.api.util.jClass
 
+typealias CgContextProperties = MutableDynamicProperties<CgContext>
+typealias CgContextProperty<T> = DynamicProperty<CgContext, T>
+
 /**
  * Interface for all code generation context aware entities
  *
@@ -243,10 +248,16 @@ interface CgContextOwner {
     var successfulExecutionsModels: List<UtModel>
 
     /**
-     * Managers to process annotated fields of the class under test
-     * relevant for the current generation type.
+     * Many of [CgContext] properties are only needed in some specific scenarios
+     * (e.g. Spring-related properties and parametrized test specific properties).
+     *
+     * To avoid overly inflating [CgContext] interface such properties should
+     * be added as dynamic properties.
+     *
+     * @see DynamicProperty
      */
-    val relevantFieldManagers: MutableList<CgAbstractClassFieldManager>
+    // TODO make parameterized test specific properties dynamic
+    val properties: CgContextProperties
 
     fun block(init: () -> Unit): Block {
         val prevBlock = currentBlock
@@ -509,8 +520,8 @@ class CgContext(
         RuntimeExceptionTestsBehaviour.defaultItem,
     override val hangingTestsTimeout: HangingTestsTimeout = HangingTestsTimeout(),
     override val enableTestsTimeout: Boolean = true,
-    override val relevantFieldManagers: MutableList<CgAbstractClassFieldManager> = mutableListOf(),
     override var containsReflectiveCall: Boolean = false,
+    override val properties: CgContextProperties = mutableDynamicPropertiesOf(),
 ) : CgContextOwner {
     override lateinit var statesCache: EnvironmentFieldStateCache
     override lateinit var actual: CgVariable
@@ -667,5 +678,6 @@ class CgContext(
         hangingTestsTimeout = this.hangingTestsTimeout,
         enableTestsTimeout = this.enableTestsTimeout,
         containsReflectiveCall = this.containsReflectiveCall,
+        properties = this.properties,
     )
 }

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/services/access/CgCallableAccessManager.kt

@@ -87,7 +87,7 @@ interface CgCallableAccessManager {
     operator fun ClassId.get(fieldId: FieldId): CgStaticFieldAccess
 }
 
-internal class CgCallableAccessManagerImpl(val context: CgContext) : CgCallableAccessManager,
+class CgCallableAccessManagerImpl(val context: CgContext) : CgCallableAccessManager,
     CgContextOwner by context {
 
     private val statementConstructor by lazy { getStatementConstructorBy(context) }

utbot-framework/src/main/kotlin/org/utbot/framework/codegen/services/framework/TestFrameworkManager.kt

@@ -25,9 +25,6 @@ import org.utbot.framework.plugin.api.BuiltinMethodId
 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.util.SpringModelUtils.extendWithClassId
-import org.utbot.framework.plugin.api.util.SpringModelUtils.runWithClassId
-import org.utbot.framework.plugin.api.util.SpringModelUtils.springExtensionClassId
 import org.utbot.framework.plugin.api.util.booleanArrayClassId
 import org.utbot.framework.plugin.api.util.byteArrayClassId
 import org.utbot.framework.plugin.api.util.charArrayClassId