Significantly improve modifiers processing in fields modificators seacher

Author: EgorkaKulikov

utbot-framework-test/src/main/java/org/utbot/examples/assemble/DefaultPackagePrivateField.java

@@ -0,0 +1,9 @@
+package org.utbot.examples.assemble;
+
+/**
+ * Need to be located at the same package as [AssembleTestUtils]
+ * because requires a setter for package-private field.
+ */
+public class DefaultPackagePrivateField {
+    int z = 10;
+}

utbot-framework-test/src/main/java/org/utbot/examples/assemble/defaults/DefaultFieldModifiedInConstructor.java

@@ -1,7 +1,7 @@
 package org.utbot.examples.assemble.defaults;
 
 public class DefaultFieldModifiedInConstructor {
-    int z;
+    public int z;
 
     @SuppressWarnings("Unused")
     DefaultFieldModifiedInConstructor(int z_) {

utbot-framework-test/src/main/java/org/utbot/examples/assemble/defaults/DefaultPackagePrivateField.java

@@ -35,7 +35,7 @@ import org.utbot.examples.assemble.defaults.DefaultField
 import org.utbot.examples.assemble.defaults.DefaultFieldModifiedInConstructor
 import org.utbot.examples.assemble.defaults.DefaultFieldWithDirectAccessor
 import org.utbot.examples.assemble.defaults.DefaultFieldWithSetter
-import org.utbot.examples.assemble.defaults.DefaultPackagePrivateField
+import org.utbot.examples.assemble.DefaultPackagePrivateField
 import org.utbot.examples.assemble.statics.StaticField
 import org.utbot.framework.plugin.api.ClassId
 import org.utbot.framework.plugin.api.ExecutableId
@@ -58,7 +58,6 @@ import org.utbot.framework.util.SootUtils
 import org.utbot.framework.util.instanceCounter
 import org.utbot.framework.util.modelIdCounter
 import kotlin.reflect.full.functions
-import org.utbot.examples.assemble.*
 import org.utbot.framework.codegen.model.constructor.util.arrayTypeOf
 
 /**
@@ -1448,9 +1447,9 @@ class AssembleModelGeneratorTests {
     private fun createModelsAndAssert(
         models: List<UtModel>,
         expectedModelRepresentations: List<String?>,
-        assembleTestUtils: ExecutableId = AssembleTestUtils::class.id.allMethods.first(),
+        assembleTestDummyMethod: ExecutableId = AssembleTestUtils::class.id.allMethods.first(),
     ) {
-        val modelsMap = AssembleModelGenerator(assembleTestUtils.classId.packageName).createAssembleModels(models)
+        val modelsMap = AssembleModelGenerator(assembleTestDummyMethod).createAssembleModels(models)
         //we sort values to fix order of models somehow (IdentityHashMap does not guarantee the order)
         val assembleModels = modelsMap.values
             .filterIsInstance<UtAssembleModel>()

utbot-framework-test/src/test/kotlin/org/utbot/framework/assemble/AssembleModelGeneratorTests.kt

@@ -192,7 +192,7 @@ internal class UtBotFieldModificatorsTest {
 
     //We use sorting here to make comparing with sorted in advance expected collections easier
     private fun runFieldModificatorsSearch(analysisMode: AnalysisMode) =
-        fieldsModificatorsSearcher.findModificators(analysisMode, PrimitiveModifications::class.java.packageName)
+        fieldsModificatorsSearcher.findModificators(analysisMode, null)
             .map { (key, value) ->
                 val modificatorNames = value.filterNot { it.name.startsWith("direct_set_") }.map { it.name }
                 key.name to modificatorNames.toSortedSet()

utbot-framework-test/src/test/kotlin/org/utbot/framework/modificators/UtBotFieldModificatorsTest.kt

@@ -133,7 +133,7 @@ class Resolver(
     private val instrumentation = mutableListOf<UtInstrumentation>()
     private val requiredInstanceFields = mutableMapOf<Address, Set<FieldId>>()
 
-    private val assembleModelGenerator = AssembleModelGenerator(methodUnderTest.classId.packageName)
+    private val assembleModelGenerator = AssembleModelGenerator(methodUnderTest)
 
     /**
      * Contains FieldId of the static field which is construction at the moment and null of there is no such field.

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

@@ -639,7 +639,7 @@ private suspend fun ConcreteExecutor<UtConcreteExecutionResult, UtExecutionInstr
     methodUnderTest.signature,
     arrayOf(),
     parameters = UtConcreteExecutionData(stateBefore, instrumentation)
-).convertToAssemble(methodUnderTest.classId.packageName)
+).convertToAssemble(methodUnderTest)
 
 /**
  * Before pushing our states for concrete execution, we have to be sure that every state is consistent.

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

@@ -8,6 +8,7 @@ import org.utbot.framework.plugin.api.UtArrayModel
 import org.utbot.framework.plugin.api.UtClassRefModel
 import org.utbot.framework.plugin.api.UtCompositeModel
 import org.utbot.framework.plugin.api.UtModel
+import org.utbot.framework.plugin.api.util.executableId
 import org.utbot.framework.plugin.api.util.id
 import java.lang.reflect.Field
 import java.lang.reflect.Method
@@ -48,7 +49,7 @@ class UtModelFactory(
         classUnderTest: Class<*>,
         models: List<UtModel>
     ): IdentityHashMap<UtModel, UtModel> =
-        AssembleModelGenerator(classUnderTest.packageName)
+        AssembleModelGenerator(methodUnderTest.executableId)
             .createAssembleModels(models)
 
     @JvmOverloads

utbot-framework/src/main/kotlin/org/utbot/external/api/UtModelFactory.kt

@@ -49,7 +49,7 @@ import java.util.IdentityHashMap
  *
  * Note: Caches class related information, can be reused if classes don't change.
  */
-class AssembleModelGenerator(private val methodPackageName: String) {
+class AssembleModelGenerator(private val methodUnderTest: ExecutableId) {
 
     //Instantiated models are stored to avoid cyclic references during reference graph analysis
     private val instantiatedModels: IdentityHashMap<UtModel, UtReferenceModel> =
@@ -256,7 +256,7 @@ class AssembleModelGenerator(private val methodPackageName: String) {
                     if (fieldId.isFinal) {
                         throw AssembleException("Final field $fieldId can't be set in an object of the class $classId")
                     }
-                    if (!fieldId.type.isAccessibleFrom(methodPackageName)) {
+                    if (!fieldId.type.isAccessibleFrom(methodUnderTest.classId.packageName)) {
                         throw AssembleException(
                             "Field $fieldId can't be set in an object of the class $classId because its type is inaccessible"
                         )
@@ -265,7 +265,8 @@ class AssembleModelGenerator(private val methodPackageName: String) {
                     if (fieldId in constructorInfo.affectedFields ||
                             (fieldId !in constructorInfo.setFields && !fieldModel.hasDefaultValue())
                     ) {
-                        val modifierCall = modifierCall(this, fieldId, assembleModel(fieldModel))
+                        val assembledModel = assembleModel(fieldModel)
+                        val modifierCall = modifierCall(this, fieldId, assembledModel)
                         callChain.add(modifierCall)
                     }
                 }
@@ -397,10 +398,10 @@ class AssembleModelGenerator(private val methodPackageName: String) {
     }
 
     private val ClassId.isVisible : Boolean
-        get() = this.isPublic || !this.isPrivate && this.packageName.startsWith(methodPackageName)
+        get() = this.isPublic || !this.isPrivate && this.packageName.startsWith(methodUnderTest.classId.packageName)
 
     private val Constructor<*>.isVisible : Boolean
-        get() = this.isPublic || !this.isPrivate && this.declaringClass.packageName.startsWith(methodPackageName)
+        get() = this.isPublic || !this.isPrivate && this.declaringClass.packageName.startsWith(methodUnderTest.classId.packageName)
 
     /**
      * Creates setter or direct setter call to set a field.
@@ -440,7 +441,7 @@ class AssembleModelGenerator(private val methodPackageName: String) {
      */
     private fun findSettersAndDirectAccessors(classId: ClassId): Map<FieldId, StatementId> {
         val allModificatorsOfClass =  modificatorsSearcher
-            .findModificators(SettersAndDirectAccessors, methodPackageName)
+            .findModificators(SettersAndDirectAccessors, methodUnderTest)
             .map { it.key to it.value.filter { st -> st.classId == classId } }
 
         return allModificatorsOfClass

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

@@ -8,6 +8,7 @@ import org.utbot.framework.UtSettings
 import org.utbot.framework.assemble.AssembleModelGenerator
 import org.utbot.framework.plugin.api.Coverage
 import org.utbot.framework.plugin.api.EnvironmentModels
+import org.utbot.framework.plugin.api.ExecutableId
 import org.utbot.framework.plugin.api.FieldId
 import org.utbot.framework.plugin.api.Instruction
 import org.utbot.framework.plugin.api.MissingState
@@ -98,12 +99,10 @@ class UtConcreteExecutionResult(
      *
      * @return [UtConcreteExecutionResult] with converted models.
      */
-    fun convertToAssemble(
-        packageName: String
-    ): UtConcreteExecutionResult {
+    fun convertToAssemble(methodUnderTest: ExecutableId): UtConcreteExecutionResult {
         val allModels = collectAllModels()
 
-        val modelsToAssembleModels = AssembleModelGenerator(packageName).createAssembleModels(allModels)
+        val modelsToAssembleModels = AssembleModelGenerator(methodUnderTest).createAssembleModels(allModels)
         return updateWithAssembleModels(modelsToAssembleModels)
     }
 

utbot-framework/src/main/kotlin/org/utbot/framework/concrete/UtExecutionInstrumentation.kt

@@ -1,8 +1,10 @@
 package org.utbot.framework.modifications
 
 import org.utbot.framework.plugin.api.ClassId
+import org.utbot.framework.plugin.api.ExecutableId
 import org.utbot.framework.plugin.api.FieldId
 import org.utbot.framework.plugin.api.StatementId
+import org.utbot.framework.plugin.api.util.isSubtypeOf
 
 class UtBotFieldsModificatorsSearcher {
 
@@ -16,35 +18,36 @@ class UtBotFieldsModificatorsSearcher {
      * Finds field modificators.
      *
      * @param analysisMode represents which type of modificators (e.g. setters) are considered.
-     * @param basePackageName describes a location of package-private methods that need to be considered.
+     * @param methodUnderTest describes an analyzed method an it's location.
      */
-    fun findModificators(analysisMode: AnalysisMode, basePackageName: String? = null): Map<FieldId, Set<StatementId>> {
+    fun findModificators(analysisMode: AnalysisMode, methodUnderTest: ExecutableId? = null): Map<FieldId, Set<StatementId>> {
         val modificators = findModificators(analysisMode)
 
-        if (basePackageName == null) {
+        if (methodUnderTest == null) {
             return modificators
         }
 
         val filteredModifications = mutableMapOf<FieldId, Set<StatementId>>()
         for ((fieldId, statements) in modificators) {
-            val filteredStmts = statements.filter { stmt -> fieldId.isAccessibleBy(stmt, basePackageName!!) }
+            val filteredStmts = statements.filter { stmt -> fieldId.isAccessibleBy(stmt, methodUnderTest!!) }
             filteredModifications[fieldId] = filteredStmts.toSet()
         }
 
         return filteredModifications
     }
 
-    private fun FieldId.isAccessibleBy(statementId: StatementId, basePackageName: String): Boolean {
+    /**
+     * Verifies that this field is accessible with [statementId] from the location of [methodUnderTest].
+     */
+    private fun FieldId.isAccessibleBy(statementId: StatementId, methodUnderTest: ExecutableId): Boolean {
+        val basePackageName = methodUnderTest.classId.packageName
         val classPackageName = statementId.classId.packageName
-        if (basePackageName == "") {
-            return classPackageName == ""
-        } else {
-            if (this.isPublic) return true
-            if (this.isProtected) return classPackageName.startsWith(basePackageName)
-            if (this.isPackagePrivate) return classPackageName == basePackageName
-            //for private fields no filtering based on package names is required
-            return true
-        }
+
+        if (this.isPublic) return true
+        if (this.isProtected) return classPackageName == basePackageName || statementId.classId.isSubtypeOf(methodUnderTest.classId)
+        if (this.isPackagePrivate) return classPackageName == basePackageName
+        if (this.isPrivate) methodUnderTest.classId == statementId.classId
+        return true
     }
 
     private fun findModificators(analysisMode: AnalysisMode): Map<FieldId, Set<StatementId>> {