Extract MockerContext interface

IlyaMuravjov · IlyaMuravjov · commit 5f9233bf25eb · 2023-07-13T11:53:14.000+03:00
diff --git a/utbot-framework/src/main/kotlin/org/utbot/engine/Mocks.kt b/utbot-framework/src/main/kotlin/org/utbot/engine/Mocks.kt
@@ -19,7 +19,7 @@ import kotlinx.collections.immutable.persistentListOf
 import org.utbot.common.nameOfPackage
 import org.utbot.engine.types.OBJECT_TYPE
 import org.utbot.engine.util.mockListeners.MockListenerController
-import org.utbot.framework.context.ApplicationContext
+import org.utbot.framework.context.mocker.MockerContext
 import org.utbot.framework.plugin.api.util.isInaccessibleViaReflection
 import soot.BooleanType
 import soot.RefType
@@ -168,7 +168,7 @@ class Mocker(
     private val hierarchy: Hierarchy,
     chosenClassesToMockAlways: Set<ClassId>,
     internal val mockListenerController: MockListenerController? = null,
-    private val applicationContext: ApplicationContext,
+    private val mockerContext: MockerContext,
 ) {
     private val mocksAreDesired: Boolean = strategy != MockStrategy.NO_MOCKS
 
@@ -227,10 +227,10 @@ class Mocker(
 
         val mockingIsPossible = when (mockInfo) {
             is UtFieldMockInfo,
-            is UtObjectMockInfo -> applicationContext.mockFrameworkInstalled
+            is UtObjectMockInfo -> mockerContext.mockFrameworkInstalled
             is UtNewInstanceMockInfo,
             is UtStaticMethodMockInfo,
-            is UtStaticObjectMockInfo -> applicationContext.staticsMockingIsConfigured
+            is UtStaticObjectMockInfo -> mockerContext.staticsMockingIsConfigured
         }
         val mockingIsForcedAndPossible = mockAlways(mockedValue.type) && mockingIsPossible
 
diff --git a/utbot-framework/src/main/kotlin/org/utbot/engine/UtBotSymbolicEngine.kt b/utbot-framework/src/main/kotlin/org/utbot/engine/UtBotSymbolicEngine.kt
@@ -143,7 +143,7 @@ class UtBotSymbolicEngine(
         hierarchy,
         chosenClassesToMockAlways,
         MockListenerController(controller),
-        applicationContext = applicationContext,
+        mockerContext = applicationContext.mockerContext,
     )
 
     fun attachMockListener(mockListener: MockListener) = mocker.mockListenerController?.attach(mockListener)
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/context/ApplicationContext.kt b/utbot-framework/src/main/kotlin/org/utbot/framework/context/ApplicationContext.kt
@@ -1,5 +1,6 @@
 package org.utbot.framework.context
 
+import org.utbot.framework.context.mocker.MockerContext
 import org.utbot.framework.plugin.api.ClassId
 import org.utbot.framework.plugin.api.CodeGenerationContext
 import org.utbot.framework.plugin.api.TypeReplacementMode
@@ -8,8 +9,7 @@ import soot.RefType
 import soot.SootField
 
 interface ApplicationContext : CodeGenerationContext {
-    val mockFrameworkInstalled: Boolean
-    val staticsMockingIsConfigured: Boolean
+    val mockerContext: MockerContext
 
     /**
      * Shows if there are any restrictions on type implementors.
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/context/SimpleApplicationContext.kt b/utbot-framework/src/main/kotlin/org/utbot/framework/context/SimpleApplicationContext.kt
@@ -1,6 +1,7 @@
 package org.utbot.framework.context
 
 import org.utbot.framework.UtSettings
+import org.utbot.framework.context.mocker.MockerContext
 import org.utbot.framework.isFromTrustedLibrary
 import org.utbot.framework.plugin.api.ClassId
 import org.utbot.framework.plugin.api.TypeReplacementMode
@@ -10,33 +11,10 @@ import soot.SootField
 
 /**
  * A context to use when no specific data is required.
- *
- * @param mockFrameworkInstalled shows if we have installed framework dependencies
- * @param staticsMockingIsConfigured shows if we have installed static mocking tools
  */
 class SimpleApplicationContext(
-    override val mockFrameworkInstalled: Boolean = true,
-    staticsMockingIsConfigured: Boolean = true,
+    override val mockerContext: MockerContext
 ) : ApplicationContext {
-    override var staticsMockingIsConfigured = staticsMockingIsConfigured
-        private set
-
-    init {
-        /**
-         * Situation when mock framework is not installed but static mocking is configured is semantically incorrect.
-         *
-         * However, it may be obtained in real application after this actions:
-         * - fully configure mocking (dependency installed + resource file created)
-         * - remove mockito-core dependency from project
-         * - forget to remove mock-maker file from resource directory
-         *
-         * Here we transform this configuration to semantically correct.
-         */
-        if (!mockFrameworkInstalled && staticsMockingIsConfigured) {
-            this.staticsMockingIsConfigured = false
-        }
-    }
-
     override val typeReplacementMode: TypeReplacementMode = TypeReplacementMode.AnyImplementor
 
     override fun replaceTypeIfNeeded(type: RefType): ClassId? = null
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/context/mocker/MockerContext.kt b/utbot-framework/src/main/kotlin/org/utbot/framework/context/mocker/MockerContext.kt
@@ -0,0 +1,13 @@
+package org.utbot.framework.context.mocker
+
+interface MockerContext {
+    /**
+     * Shows if we have installed framework dependencies
+     */
+    val mockFrameworkInstalled: Boolean
+
+    /**
+     * Shows if we have installed static mocking tools
+     */
+    val staticsMockingIsConfigured: Boolean
+}
diff --git a/utbot-framework/src/main/kotlin/org/utbot/framework/context/mocker/SimpleMockerContext.kt b/utbot-framework/src/main/kotlin/org/utbot/framework/context/mocker/SimpleMockerContext.kt
@@ -0,0 +1,14 @@
+package org.utbot.framework.context.mocker
+
+class SimpleMockerContext(
+    override val mockFrameworkInstalled: Boolean,
+    staticsMockingIsConfigured: Boolean
+) : MockerContext {
+    /**
+     * NOTE: Can only be `true` when [mockFrameworkInstalled], because
+     * situation when mock framework is not installed but static mocking
+     * is configured is semantically incorrect.
+     */
+    override val staticsMockingIsConfigured: Boolean =
+        mockFrameworkInstalled && staticsMockingIsConfigured
+}
diff --git a/utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/generator/UtTestsDialogProcessor.kt b/utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/generator/UtTestsDialogProcessor.kt
@@ -51,6 +51,7 @@ import org.utbot.framework.codegen.domain.ProjectType.*
 import org.utbot.framework.context.ApplicationContext
 import org.utbot.framework.context.SimpleApplicationContext
 import org.utbot.framework.context.SpringApplicationContext
+import org.utbot.framework.context.mocker.SimpleMockerContext
 import org.utbot.framework.plugin.api.*
 import org.utbot.framework.plugin.api.SpringSettings.*
 import org.utbot.framework.plugin.api.SpringConfiguration.*
@@ -263,7 +264,9 @@ object UtTestsDialogProcessor {
                         process.terminateOnException { _ ->
                             val classpathForClassLoader = buildDirs + classpathList
                             process.setupUtContext(classpathForClassLoader)
-                            val simpleApplicationContext = SimpleApplicationContext(mockFrameworkInstalled, staticMockingConfigured)
+                            val simpleApplicationContext = SimpleApplicationContext(
+                                SimpleMockerContext(mockFrameworkInstalled, staticMockingConfigured)
+                            )
                             val applicationContext = when (model.projectType) {
                                 Spring -> {
                                     val beanDefinitions =
diff --git a/utbot-testing/src/main/kotlin/org/utbot/testing/TestCodeGeneratorPipeline.kt b/utbot-testing/src/main/kotlin/org/utbot/testing/TestCodeGeneratorPipeline.kt
@@ -18,6 +18,7 @@ import org.utbot.framework.codegen.tree.ututils.UtilClassKind
 import org.utbot.framework.codegen.tree.ututils.UtilClassKind.Companion.UT_UTILS_INSTANCE_NAME
 import org.utbot.framework.context.SimpleApplicationContext
 import org.utbot.framework.context.SpringApplicationContext
+import org.utbot.framework.context.mocker.SimpleMockerContext
 import org.utbot.framework.plugin.api.*
 import org.utbot.framework.plugin.api.util.UtContext
 import org.utbot.framework.plugin.api.util.description
@@ -270,7 +271,12 @@ class TestCodeGeneratorPipeline(private val testInfrastructureConfiguration: Tes
                         runtimeExceptionTestsBehaviour = runtimeExceptionTestsBehaviour,
                         enableTestsTimeout = enableTestsTimeout,
                         springCodeGenerationContext = SpringApplicationContext(
-                            SimpleApplicationContext(mockFrameworkInstalled = true, staticsMockingIsConfigured = true),
+                            SimpleApplicationContext(
+                                SimpleMockerContext(
+                                    mockFrameworkInstalled = true,
+                                    staticsMockingIsConfigured = true
+                                )
+                            ),
                             shouldUseImplementors = false,
                             springTestType = SpringTestType.UNIT_TEST,
                             springSettings = SpringSettings.AbsentSpringSettings(),

Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,7 @@ class UtBotSymbolicEngine(`
`143`	`143`	`hierarchy,`
`144`	`144`	`chosenClassesToMockAlways,`
`145`	`145`	`MockListenerController(controller),`
`146`		`- applicationContext = applicationContext,`
	`146`	`+ mockerContext = applicationContext.mockerContext,`
`147`	`147`	`)`
`148`	`148`
`149`	`149`	`fun attachMockListener(mockListener: MockListener) = mocker.mockListenerController?.attach(mockListener)`