Support Spring projects with main xml config in utbot-spring-analyzer (#2087)

Author: tepa46

utbot-spring-analyzer/src/main/kotlin/org/utbot/spring/ApplicationRunner.kt

@@ -1,13 +1,15 @@
 package org.utbot.spring
 
 import org.utbot.spring.analyzers.SpringApplicationAnalyzer
+import org.utbot.spring.data.ApplicationData
 import org.utbot.spring.utils.PathsUtils
-import java.nio.file.Path
+import java.io.File
+import java.net.URL
 
 /**
  * To run this app, arguments must be passed in the following way:
  * args[0] - classpath of current project
- * args[1] - fully qualified name of configuration class
+ * args[1] - fully qualified name of configuration class or main .xml configuration file path
  * args[2] - `.properties` file paths, separated via `;`, empty string if no files exist
  * args[3] - `.xml` configuration file paths
  *
@@ -18,17 +20,29 @@ fun main(args: Array<String>) {
 
     /* FOR EXAMPLE
     val arg0 = "/Users/kirillshishin/IdeaProjects/spring-starter-lesson-28/build/classes/java/main"
+
     val arg1 = "com.dmdev.spring.config.ApplicationConfiguration"
+    or
+    val arg1 = "/Users/kirillshishin/IdeaProjects/spring-starter-lesson-28/src/main/resources/application.xml"
+
     val arg2 = "/Users/kirillshishin/IdeaProjects/spring-starter-lesson-28/src/main/resources/application.properties;/Users/kirillshishin/IdeaProjects/spring-starter-lesson-28/src/main/resources/application-web.properties"
     val arg3 = "/Users/kirillshishin/IdeaProjects/spring-starter-lesson-28/src/main/resources/application.xml;/Users/kirillshishin/IdeaProjects/spring-starter-lesson-28/src/main/resources/application2.xml"
     */
 
-    val springApplicationAnalyzer = SpringApplicationAnalyzer(
-        applicationUrl = Path.of(args[0]).toUri().toURL(),
-        configurationClassFqn = args[1],
-        propertyFilesPaths = args[2].split(";").filter { it != PathsUtils.EMPTY_PATH },
-        xmlConfigurationPaths = args[3].split(";").filter { it != PathsUtils.EMPTY_PATH },
-    )
+    val applicationData =
+        ApplicationData(
+            applicationUrlArray = parseApplicationUrls(args[0]),
+            configurationFile = args[1],
+            propertyFilesPaths = args[2].split(";").filter { it != PathsUtils.EMPTY_PATH },
+            xmlConfigurationPaths = args[3].split(";").filter { it != PathsUtils.EMPTY_PATH },
+        )
+
+    SpringApplicationAnalyzer(applicationData).analyze()
+}
 
-    springApplicationAnalyzer.analyze()
-}
+fun parseApplicationUrls(urlString: String): Array<URL> =
+    urlString
+        .split(';')
+        .filter { it != PathsUtils.EMPTY_PATH }
+        .map { File(it).toURI().toURL() }
+        .toTypedArray()

utbot-spring-analyzer/src/main/kotlin/org/utbot/spring/analyzers/SpringApplicationAnalyzer.kt

@@ -1,46 +1,35 @@
 package org.utbot.spring.analyzers
 
-import org.utbot.spring.utils.FakeFileManager
-import org.utbot.spring.configurators.PropertiesConfigurator
-import org.utbot.spring.configurators.XmlFilesConfigurator
-import org.utbot.spring.config.TestApplicationConfiguration
 import org.springframework.boot.builder.SpringApplicationBuilder
 import org.springframework.context.ApplicationContextException
-import org.utbot.spring.utils.ConfigurationManager
-import java.net.URL
-import java.net.URLClassLoader
-
+import org.utbot.spring.configurators.ApplicationConfigurationType
+import org.utbot.spring.configurators.ApplicationConfigurationType.JavaConfiguration
+import org.utbot.spring.configurators.ApplicationConfigurationType.XmlConfiguration
+import org.utbot.spring.configurators.ApplicationConfigurator
+import org.utbot.spring.data.ApplicationData
+import org.utbot.spring.utils.FakeFileManager
+import java.io.File
 
 class SpringApplicationAnalyzer(
-    private val applicationUrl: URL,
-    private val configurationClassFqn: String,
-    private val propertyFilesPaths: List<String>,
-    private val xmlConfigurationPaths: List<String>,
+    private val applicationData: ApplicationData
 ) {
 
     fun analyze() {
-        val fakeFileManager = FakeFileManager(propertyFilesPaths + xmlConfigurationPaths)
+        val fakeFileManager =
+            FakeFileManager(applicationData.propertyFilesPaths + applicationData.xmlConfigurationPaths)
         fakeFileManager.createTempFiles()
 
-        val classLoader: ClassLoader = URLClassLoader(arrayOf(applicationUrl))
-        val userConfigurationClass = classLoader.loadClass(configurationClassFqn)
-
-        val configurationManager = ConfigurationManager(classLoader, userConfigurationClass)
-        val propertiesConfigurator = PropertiesConfigurator(propertyFilesPaths, configurationManager)
-        val xmlFilesConfigurator = XmlFilesConfigurator(xmlConfigurationPaths, configurationManager)
+        val applicationBuilder = SpringApplicationBuilder(SpringApplicationAnalyzer::class.java)
+        val applicationConfigurator = ApplicationConfigurator(applicationBuilder, applicationData)
 
-        propertiesConfigurator.configure()
-        xmlFilesConfigurator.configure()
-
-        val app = SpringApplicationBuilder(SpringApplicationAnalyzer::class.java)
-        app.sources(TestApplicationConfiguration::class.java, userConfigurationClass)
-        for (prop in propertiesConfigurator.readProperties()) {
-            app.properties(prop)
+        when (findConfigurationType(applicationData)) {
+            XmlConfiguration -> applicationConfigurator.configureXmlBasedApplication()
+            else -> applicationConfigurator.configureJavaBasedApplication()
         }
 
         try {
-            app.build()
-            app.run()
+            applicationBuilder.build()
+            applicationBuilder.run()
         } catch (e: ApplicationContextException) {
             // UtBotBeanFactoryPostProcessor destroys bean definitions
             // to prevent Spring application from actually starting and
@@ -50,4 +39,13 @@ class SpringApplicationAnalyzer(
             fakeFileManager.deleteTempFiles()
         }
     }
+
+    private fun findConfigurationType(applicationData: ApplicationData): ApplicationConfigurationType {
+        //TODO: support Spring Boot Applications here.
+        val fileExtension = File(applicationData.configurationFile).extension
+        return when (fileExtension) {
+            "xml" -> XmlConfiguration
+            else -> JavaConfiguration
+        }
+    }
 }

utbot-spring-analyzer/src/main/kotlin/org/utbot/spring/config/TestApplicationConfiguration.kt

@@ -3,9 +3,11 @@ package org.utbot.spring.config
 import org.springframework.beans.factory.config.BeanFactoryPostProcessor
 import org.springframework.context.annotation.Bean
 import org.springframework.context.annotation.Configuration
+import org.springframework.context.annotation.ImportResource
 import org.utbot.spring.postProcessors.UtBotBeanFactoryPostProcessor
 
 @Configuration
+@ImportResource
 open class TestApplicationConfiguration {
 
     @Bean

utbot-spring-analyzer/src/main/kotlin/org/utbot/spring/configurators/ApplicationConfigurator.kt

@@ -0,0 +1,44 @@
+package org.utbot.spring.configurators
+
+import org.springframework.boot.builder.SpringApplicationBuilder
+import org.utbot.spring.config.TestApplicationConfiguration
+import org.utbot.spring.data.ApplicationData
+import org.utbot.spring.utils.ConfigurationManager
+import java.net.URLClassLoader
+
+open class ApplicationConfigurator(
+    private val applicationBuilder: SpringApplicationBuilder,
+    private val applicationData: ApplicationData
+) {
+    private val classLoader: ClassLoader = URLClassLoader(applicationData.applicationUrlArray)
+
+    fun configureJavaBasedApplication() {
+        configureApplication(
+            configurationClass = classLoader.loadClass(applicationData.configurationFile),
+            xmlConfigurationPaths = applicationData.xmlConfigurationPaths
+        )
+    }
+
+    fun configureXmlBasedApplication() {
+        configureApplication(
+            configurationClass = TestApplicationConfiguration::class.java,
+            xmlConfigurationPaths = listOf(applicationData.configurationFile)
+        )
+    }
+
+    private fun configureApplication(configurationClass: Class<*>, xmlConfigurationPaths: List<String>) {
+
+        val configurationManager = ConfigurationManager(classLoader, configurationClass)
+
+        val xmlFilesConfigurator = XmlFilesConfigurator(xmlConfigurationPaths, configurationManager)
+        val propertiesConfigurator = PropertiesConfigurator(applicationData.propertyFilesPaths, configurationManager)
+
+        propertiesConfigurator.configure()
+        xmlFilesConfigurator.configure()
+
+        for (prop in propertiesConfigurator.readProperties()) {
+            applicationBuilder.properties(prop)
+        }
+        applicationBuilder.sources(TestApplicationConfiguration::class.java, configurationClass)
+    }
+}

utbot-spring-analyzer/src/main/kotlin/org/utbot/spring/configurators/ApplicationType.kt

@@ -0,0 +1,10 @@
+package org.utbot.spring.configurators
+
+enum class ApplicationConfigurationType {
+
+    XmlConfiguration,
+
+    JavaConfiguration,
+
+    SpringBootConfiguration
+}

utbot-spring-analyzer/src/main/kotlin/org/utbot/spring/data/ApplicationData.kt

@@ -0,0 +1,10 @@
+package org.utbot.spring.data
+
+import java.net.URL
+
+data class ApplicationData(
+    val applicationUrlArray: Array<URL>,
+    val configurationFile: String,
+    val propertyFilesPaths: List<String>,
+    val xmlConfigurationPaths: List<String>,
+)

utbot-spring-analyzer/src/main/kotlin/org/utbot/spring/utils/FakeFileManager.kt

@@ -1,6 +1,5 @@
 package org.utbot.spring.utils
 
-import org.utbot.spring.utils.PathsUtils
 import java.io.File
 import java.io.IOException
 

utbot-spring-analyzer/src/main/kotlin/org/utbot/spring/utils/PathsUtils.kt

@@ -1,6 +1,5 @@
 package org.utbot.spring.utils
 
-import java.io.File
 import kotlin.io.path.Path
 
 object PathsUtils {