Fix wrong test resources directory in Android Studio (#78)

* #70 Fix wrong test resources directory in Android Studio

* #70 Change the order of suitable test folders

* #70 Fix after review

Co-authored-by: Nikita Stroganov <stroganov.nikita@huawei.com>

Author: mmvpm

utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/generator/TestGenerator.kt

@@ -95,7 +95,7 @@ object TestGenerator {
     }
 
     private fun mergeSarifReports(model: GenerateTestsModel) {
-        val sarifReportsPath = model.testModule.getOrCreateSarifReportsPath()
+        val sarifReportsPath = model.testModule.getOrCreateSarifReportsPath(model.testSourceRoot)
         val sarifReports = sarifReportsPath.toFile()
             .walkTopDown()
             .filter { it.extension == "sarif" }
@@ -294,7 +294,7 @@ object TestGenerator {
     }
 
     private fun saveTestsReport(testsCodeWithTestReport: TestsCodeWithTestReport, model: GenerateTestsModel) {
-        val testResourcesDirPath = model.testModule.getOrCreateTestResourcesPath()
+        val testResourcesDirPath = model.testModule.getOrCreateTestResourcesPath(model.testSourceRoot)
 
         require(testResourcesDirPath.exists()) {
             "Test resources directory $testResourcesDirPath does not exist"

utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/sarif/SarifReportIdea.kt

@@ -21,7 +21,7 @@ object SarifReportIdea {
     ) {
         // building the path to the report file
         val classFqn = testCases.firstOrNull()?.method?.clazz?.qualifiedName ?: return
-        val sarifReportsPath = model.testModule.getOrCreateSarifReportsPath()
+        val sarifReportsPath = model.testModule.getOrCreateSarifReportsPath(model.testSourceRoot)
         val reportFilePath = sarifReportsPath.resolve("${classFqnToPath(classFqn)}-utbot.sarif")
 
         // creating report related directory

utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/ui/GenerateTestsDialogWindow.kt

@@ -575,7 +575,7 @@ class GenerateTestsDialogWindow(val model: GenerateTestsModel) : DialogWrapper(m
     }
 
     private fun configureStaticMocking() {
-        val testResourcesUrl = model.testModule.getOrCreateTestResourcesPath()
+        val testResourcesUrl = model.testModule.getOrCreateTestResourcesPath(model.testSourceRoot)
         configureMockitoResources(testResourcesUrl)
 
         val staticsMockingValue = staticsMocking.item

utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/ui/utils/ModuleUtils.kt

@@ -64,17 +64,16 @@ fun Module.suitableTestSourceFolders(): List<SourceFolder> =
  *
  * If no roots exist, our suggestion is a folder named "resources" in the entry root.
  */
-fun Module.getOrCreateTestResourcesPath(): Path {
-    val testResourcesUrl = getOrCreateTestResourcesUrl(this)
+fun Module.getOrCreateTestResourcesPath(testSourceRoot: VirtualFile?): Path {
+    val testResourcesUrl = getOrCreateTestResourcesUrl(this, testSourceRoot)
     return VfsUtilCore.urlToPath(testResourcesUrl).toPath()
 }
 
 /**
  * Gets a path to Sarif reports directory or creates it.
- *
  */
-fun Module.getOrCreateSarifReportsPath(): Path {
-    val testResourcesPath = this.getOrCreateTestResourcesPath()
+fun Module.getOrCreateSarifReportsPath(testSourceRoot: VirtualFile?): Path {
+    val testResourcesPath = this.getOrCreateTestResourcesPath(testSourceRoot)
     return "$testResourcesPath/sarif/".toPath()
 }
 
@@ -137,21 +136,33 @@ private fun Module.suitableTestSourceFolders(codegenLanguage: CodegenLanguage):
 
     return sourceFolders
         .filterNot { it.isForGeneratedSources() }
-        .filter { folder -> folder.rootType == codegenLanguage.testRootType() }
+        .filter { it.rootType == codegenLanguage.testRootType() }
+        // Heuristics: User is more likely to choose the shorter path
+        .sortedBy { it.url.length }
 }
 
 private const val resourcesSuffix = "/resources"
 
-private fun getOrCreateTestResourcesUrl(module: Module): String {
+private fun getOrCreateTestResourcesUrl(module: Module, testSourceRoot: VirtualFile?): String {
     val moduleInstance = ModuleRootManager.getInstance(module)
     val sourceFolders = moduleInstance.contentEntries.flatMap { it.sourceFolders.toList() }
 
-    val testResourcesFolder = sourceFolders.firstOrNull { it.rootType in testResourceRootTypes }
+    val testResourcesFolder = sourceFolders
+        .filter { sourceFolder ->
+            sourceFolder.rootType in testResourceRootTypes && !sourceFolder.isForGeneratedSources()
+        }
+        // taking the source folder that has the maximum common prefix
+        // with `testSourceRoot`, which was selected by the user
+        .maxBy { sourceFolder ->
+            val sourceFolderPath = sourceFolder.file?.path ?: ""
+            val testSourceRootPath = testSourceRoot?.path ?: ""
+            sourceFolderPath.commonPrefixWith(testSourceRootPath).length
+        }
     if (testResourcesFolder != null) {
         return testResourcesFolder.url
     }
 
-    val testFolder = sourceFolders.firstOrNull { f -> f.rootType in testSourceRootTypes }
+    val testFolder = sourceFolders.firstOrNull { it.rootType in testSourceRootTypes }
     val contentEntry = testFolder?.contentEntry ?: moduleInstance.contentEntries.first()
 
     val parentFolderUrl = testFolder?.let { getParentPath(testFolder.url) }

utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/ui/utils/RootUtils.kt

@@ -13,9 +13,9 @@ import org.jetbrains.kotlin.config.TestResourceKotlinRootType
 import org.jetbrains.kotlin.config.TestSourceKotlinRootType
 
 val sourceRootTypes: Set<JpsModuleSourceRootType<JavaSourceRootProperties>> = setOf(JavaSourceRootType.SOURCE, SourceKotlinRootType)
-val testSourceRootTypes: Set<JpsModuleSourceRootType<JavaSourceRootProperties>>  = setOf(JavaSourceRootType.TEST_SOURCE, TestSourceKotlinRootType)
-val resourceRootTypes: Set<JpsModuleSourceRootType<JavaResourceRootProperties>> =  setOf(JavaResourceRootType.RESOURCE, ResourceKotlinRootType)
-val testResourceRootTypes: Set<JpsModuleSourceRootType<JavaResourceRootProperties>>  = setOf(JavaResourceRootType.TEST_RESOURCE, TestResourceKotlinRootType)
+val testSourceRootTypes: Set<JpsModuleSourceRootType<JavaSourceRootProperties>> = setOf(JavaSourceRootType.TEST_SOURCE, TestSourceKotlinRootType)
+val resourceRootTypes: Set<JpsModuleSourceRootType<JavaResourceRootProperties>> = setOf(JavaResourceRootType.RESOURCE, ResourceKotlinRootType)
+val testResourceRootTypes: Set<JpsModuleSourceRootType<JavaResourceRootProperties>> = setOf(JavaResourceRootType.TEST_RESOURCE, TestResourceKotlinRootType)
 
 /**
  * Defines test root type for selected codegen language.
@@ -43,4 +43,4 @@ fun SourceFolder.isForGeneratedSources(): Boolean {
     val resourceProperties = jpsElement.getProperties(resourceRootTypes + testResourceRootTypes)
 
     return properties?.isForGeneratedSources == true && resourceProperties?.isForGeneratedSources == true
-}
+}