Spring analyzer improvements (fix uncaught exception, add shadowJar task, fix dynamic resources not being found on the classpath) (#1984)

Author: IlyaMuravjov

utbot-spring-analyzer/build.gradle.kts

@@ -1,7 +1,12 @@
+import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
+import com.github.jengelman.gradle.plugins.shadow.transformers.PropertiesFileTransformer
+
 plugins {
     id("org.springframework.boot") version "2.7.8"
     id("io.spring.dependency-management") version "1.1.0"
+    id("com.github.johnrengelman.shadow") version "7.1.2"
     id("java")
+    application
 }
 
 java {
@@ -12,4 +17,22 @@ java {
 dependencies {
     implementation("org.springframework.boot:spring-boot-starter")
     implementation("org.springframework.boot:spring-boot-starter-web")
-}
+}
+
+application {
+    mainClass.set("org.utbot.spring.ApplicationRunnerKt")
+}
+
+// see more details about this task -- https://github.com/spring-projects/spring-boot/issues/1828
+tasks.withType(ShadowJar::class.java) {
+    isZip64 = true
+    // Required for Spring
+    mergeServiceFiles()
+    append("META-INF/spring.handlers")
+    append("META-INF/spring.schemas")
+    append("META-INF/spring.tooling")
+    transform(PropertiesFileTransformer().apply {
+        paths = listOf("META-INF/spring.factories")
+        mergeStrategy = "append"
+    })
+}

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

@@ -5,7 +5,7 @@ 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.utbot.spring.postProcessors.UtBotSpringShutdownException
+import org.springframework.context.ApplicationContextException
 import org.utbot.spring.utils.ConfigurationManager
 import java.net.URL
 import java.net.URLClassLoader
@@ -41,10 +41,13 @@ class SpringApplicationAnalyzer(
         try {
             app.build()
             app.run()
-        } catch (e: UtBotSpringShutdownException) {
+        } catch (e: ApplicationContextException) {
+            // UtBotBeanFactoryPostProcessor destroys bean definitions
+            // to prevent Spring application from actually starting and
+            // that causes it to throw ApplicationContextException
             println("Bean analysis finished successfully")
-        }finally {
+        } finally {
             fakeFileManager.deleteTempFiles()
         }
     }
-}
+}

utbot-spring-analyzer/src/main/kotlin/org/utbot/spring/postProcessors/UtBotBeanFactoryPostProcessor.kt

@@ -29,7 +29,6 @@ class UtBotBeanFactoryPostProcessor : BeanFactoryPostProcessor, PriorityOrdered
         destroyBeanDefinitions(beanFactory)
 
         println("Finished post-processing bean factory in UtBot")
-        throw UtBotSpringShutdownException("Finished post-processing bean factory in UtBot")
     }
 
     private fun findBeanClassNames(beanFactory: ConfigurableListableBeanFactory): ArrayList<String> {
@@ -84,4 +83,4 @@ class UtBotBeanFactoryPostProcessor : BeanFactoryPostProcessor, PriorityOrdered
             println("Storing bean information failed with exception $e")
         }
     }
-}
+}

utbot-spring-analyzer/src/main/kotlin/org/utbot/spring/postProcessors/UtBotSpringShutdownException.kt

@@ -14,10 +14,10 @@ class ConfigurationManager(private val classLoader: ClassLoader, private val use
     fun clearImportResourceAnnotation() = patchAnnotation(ImportResource::class, null)
 
     fun patchPropertySourceAnnotation(userPropertiesFileName: Path) =
-        patchAnnotation(PropertySource::class, String.format("classpath:%s", "fake_$userPropertiesFileName"))
+        patchAnnotation(PropertySource::class, String.format("file:%s", "fake_$userPropertiesFileName"))
 
     fun patchImportResourceAnnotation(userXmlFilePath: Path) =
-        patchAnnotation(ImportResource::class, String.format("classpath:%s", "fake_$userXmlFilePath"))
+        patchAnnotation(ImportResource::class, String.format("file:%s", "fake_$userXmlFilePath"))
 
     private fun patchAnnotation(annotationClass: KClass<*>, newValue: String?) {
         val proxyClass = classLoader.loadClass("java.lang.reflect.Proxy")
@@ -53,4 +53,4 @@ class ConfigurationManager(private val classLoader: ClassLoader, private val use
             memberValues["value"] = list.toTypedArray()
         }
     }
-}
+}

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

@@ -6,16 +6,5 @@ import kotlin.io.path.Path
 object PathsUtils {
     const val EMPTY_PATH = ""
 
-    fun createFakeFilePath(fileName: String): String =
-        Path(buildResourcesPath, "fake_${Path(fileName).fileName}").toString()
-
-    private val buildResourcesPath: String
-        get() {
-            val resourcesMarker =
-                this.javaClass.classLoader.getResource("resources_marker.txt")
-                    ?: error("Resources marker file is not found")
-
-            return Path(File(resourcesMarker.toURI()).path).parent.toString()
-        }
-
-}
+    fun createFakeFilePath(fileName: String): String = "fake_${Path(fileName).fileName}"
+}