Extract `utbot-spring-framework` module from `utbot-framework` #2570

IlyaMuravjov · 2023-08-30T14:32:31Z

Description

All spring-specific logic is extracted from utbot-framework module to utbot-spring-framework module.

How to test

Regression tests, this PR should not change UtBot semantics at all.

Self-check list

I've set the proper labels for my PR (at least, for category and component).
PR title and description are clear and intelligible.
I've added enough comments to my code, particularly in hard-to-understand areas.
The functionality I've repaired, changed or added is covered with automated tests.
Manual tests have been provided optionally.
The documentation for the functionality I've been working on is up-to-date.

…ecific Remove `CgContext.relevantFieldManagers` field

… to `utbot-spring-test`

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

…ementing `CodeGenerationSettingItem` as it's not a setting

Damtev

There are some unobvious moments

Damtev · 2023-09-06T08:23:24Z

utbot-framework/src/main/kotlin/org/utbot/framework/process/EngineProcessMain.kt

+    watchdog.measureTimeForActiveCall(perform, "Performing dynamic task") { params ->
+        val task = kryoHelper.readObject<EngineProcessTask<Any?>>(params.engineProcessTask)
+        val result = task.perform(kryoHelper)
+        kryoHelper.writeObject(result)
+    }


Why do we have only one post-processing task? Perhaps it could be a list of such tasks performed consequently.

It's not a post-processing task, the order in witch callbacks are registered in the engine process has nothing to do with the order in which they are called by the IDE process. For example, callback for findMethodsInClassMatchingSelected is registered after the callback for generate, despite generate being called after findMethodsInClassMatchingSelected.

If we need to perform multiple tasks we can call perform multiple times, the same way generate is called multiple times when we generate tests for multiple classes.

Damtev · 2023-09-06T08:27:02Z

utbot-spring-framework/build.gradle.kts

@@ -0,0 +1,39 @@
+val kotlinLoggingVersion: String by rootProject
+val rdVersion: String by rootProject
+val sootVersion: String by rootProject


Do we really need Soot for this module?

Right now NonNullSpeculator accepts SootField.

I've tried making engine convert SootField to FieldId before passing it to speculativelyCannotProduceNullPointerException, but it was failing to convert declaring SootClass to a valid ClassId for some lambdas, causing ClassNotFoundException when the default implementation of the speculativelyCannotProduceNullPointerException tried to retrieve the packageName which in turned used jClass.

Damtev · 2023-09-06T08:29:01Z

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

@@ -0,0 +1,27 @@
+package org.utbot.framework.codegen.domain
+
+abstract class SpringModule(


Why not make it an enum?

Made it a enum.

Damtev · 2023-09-06T08:36:42Z

utbot-spring-framework/src/main/kotlin/org/utbot/framework/process/SpringAnalyzerTask.kt

+import org.utbot.rd.use
+import org.utbot.spring.process.SpringAnalyzerProcess
+
+class SpringAnalyzerTask(


Is it true that it does not matter will this task be performed before the symbolic analysis or after? So, can we always consider it as a post-processing task?

It's always performed before symbolic analysis and its results are later used to guide type replacement during symbolic execution.

Damtev · 2023-09-06T08:41:03Z

...ork/src/main/kotlin/org/utbot/framework/codegen/tree/fieldmanager/ClassFieldManagerFacade.kt

+object RelevantFieldManagersProperty : CgContextProperty<MutableList<CgAbstractClassFieldManager>>
+
+/**
+ * Managers to process annotated fields of the class under test
+ * relevant for the current generation type.
+ */
+val CgContextOwner.relevantFieldManagers: MutableList<CgAbstractClassFieldManager>
+    get() = properties.getOrPut(RelevantFieldManagersProperty) { mutableListOf() }
+


It's not very obvious why this object and this extension method (which seem to be common for any possible extension to the CgContext - Spring, or any other in the future) are located in this Spring-specific module

I agree, there's nothing Spring-specific in declaring class fields. However, right now adding FieldManagers won't have any effect unless CgSpringVariableConstructor is used. I've been always in favor of separating Spring-specific and field-declaration-specific logic into 2 decorators of VariableConstructor instead of one inheritor made an issue regarding that, see #2579.

Damtev · 2023-09-06T08:43:04Z

utbot-rd/src/main/rdgen/org/utbot/rd/models/EngineProcessModel.kt

-    val springAnalyzerResult = structdef {
-        field("beanDefinitions", array(beanDefinitionData))
+    val performParams = structdef {
+        field("engineProcessTask", array(PredefinedType.byte))


Based on its usage, this task seems to always be post-processing. Am I right? If so, please rename it correspondingly

No, see reply to the first comment.

Damtev

LGTM

IlyaMuravjov added ctg-refactoring Issue related to refactoring process comp-spring Issue is related to Spring projects support labels Aug 30, 2023

IlyaMuravjov force-pushed the ilya_m/spring-module branch from ef70874 to ec3beff Compare August 30, 2023 14:35

IlyaMuravjov added 8 commits September 5, 2023 21:57

Make relevantFieldManagers a dynamic property, since it's Spring-sp…

bd3ca1c

…ecific Remove `CgContext.relevantFieldManagers` field

Move springNoConfigApplicationContext constant from utbot-testing…

67995b0

… to `utbot-spring-test`

Extract utbot-spring-framework module from utbot-framework-module

afee834

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

Rename DependencyInjectionFramework to SpringModule and stop impl…

3f543d8

…ementing `CodeGenerationSettingItem` as it's not a setting

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

d329c7d

Remove unused imports, update comments

d0b898c

Introduce EngineProcessTask

ab4836a

Use EngineProcessTask to call spring analyzer

4b95114

IlyaMuravjov force-pushed the ilya_m/spring-module branch from ec3beff to 4b95114 Compare September 5, 2023 18:58

IlyaMuravjov requested review from Vassiliy-Kudryashov and Damtev September 5, 2023 20:20

Damtev requested changes Sep 6, 2023

View reviewed changes

Make SpringModule a enum

08e51f2

IlyaMuravjov requested a review from Damtev September 6, 2023 14:30

Damtev approved these changes Sep 7, 2023

View reviewed changes

Vassiliy-Kudryashov approved these changes Sep 7, 2023

View reviewed changes

IlyaMuravjov merged commit ed7d870 into main Sep 7, 2023

IlyaMuravjov deleted the ilya_m/spring-module branch September 7, 2023 20:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extract `utbot-spring-framework` module from `utbot-framework` #2570

Extract `utbot-spring-framework` module from `utbot-framework` #2570

IlyaMuravjov commented Aug 30, 2023

Damtev left a comment

Damtev Sep 6, 2023

IlyaMuravjov Sep 6, 2023

Damtev Sep 6, 2023

IlyaMuravjov Sep 6, 2023

Damtev Sep 6, 2023

IlyaMuravjov Sep 6, 2023

Damtev Sep 6, 2023

IlyaMuravjov Sep 6, 2023

Damtev Sep 6, 2023

IlyaMuravjov Sep 6, 2023

Damtev Sep 6, 2023

IlyaMuravjov Sep 6, 2023

Damtev left a comment

		@@ -0,0 +1,27 @@
		package org.utbot.framework.codegen.domain

		abstract class SpringModule(

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

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

Conversation

IlyaMuravjov commented Aug 30, 2023

Description

How to test

Self-check list

Damtev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Damtev left a comment

Choose a reason for hiding this comment

Extract `utbot-spring-framework` module from `utbot-framework` #2570

Extract `utbot-spring-framework` module from `utbot-framework` #2570