Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Select Kotlin test src root by default when generating for Kotlin #949 #1074

Merged
merged 2 commits into from
Oct 10, 2022
Merged

Select Kotlin test src root by default when generating for Kotlin #949 #1074

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e68a3c9
Select Kotlin test src root by default when generating for Kotlin
volivan239 Oct 4, 2022
7c6ab37
Move testsourceroot-choosing heuristics from ModuleUtils to TestFolde…
volivan239 Oct 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ...-intellij/src/main/kotlin/org/utbot/intellij/plugin/generator/CodeGenerationController.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,8 +416,8 @@ object CodeGenerationController {
// all test roots for the given test module
val testRoots = runReadAction {
testModule
.suitableTestSourceRoots(this)
.mapNotNull { psiManager.findDirectory(it) }
.suitableTestSourceRoots()
.mapNotNull { psiManager.findDirectory(it.dir) }
}

// return an util class from one of the test source roots or null if no util class was found
Expand Down
4 changes: 3 additions & 1 deletion utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/models/GenerateTestsModel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import com.intellij.openapi.vfs.newvfs.impl.FakeVirtualFile
import com.intellij.psi.PsiClass
import com.intellij.psi.PsiJavaFile
import com.intellij.refactoring.util.classMembers.MemberInfo
import org.jetbrains.kotlin.asJava.classes.KtUltraLightClass
import org.jetbrains.kotlin.psi.KtFile
import org.utbot.framework.plugin.api.JavaDocCommentStyle
import org.utbot.framework.util.ConflictTriggers
Expand Down Expand Up @@ -56,13 +57,14 @@ data class GenerateTestsModel(
?: error("Could not find module for $newTestSourceRoot")
}

var codegenLanguage = if (srcClasses.all { it is KtUltraLightClass }) CodegenLanguage.KOTLIN else CodegenLanguage.JAVA

var testPackageName: String? = null
lateinit var testFramework: TestFramework
lateinit var mockStrategy: MockStrategyApi
lateinit var mockFramework: MockFramework
lateinit var staticsMocking: StaticsMocking
lateinit var parametrizedTestSource: ParametrizedTestSource
lateinit var codegenLanguage: CodegenLanguage
lateinit var runtimeExceptionTestsBehaviour: RuntimeExceptionTestsBehaviour
lateinit var hangingTestsTimeout: HangingTestsTimeout
lateinit var forceStaticMocking: ForceStaticMocking
Expand Down
4 changes: 1 addition & 3 deletions utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/ui/GenerateTestsDialogWindow.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@ import javax.swing.JSpinner
import javax.swing.text.DefaultFormatter
import org.jetbrains.concurrency.Promise
import org.jetbrains.concurrency.thenRun
import org.jetbrains.kotlin.asJava.classes.KtUltraLightClass
import org.utbot.common.PathUtil.toPath
import org.utbot.framework.UtSettings
import org.utbot.framework.codegen.ForceStaticMocking
Expand Down Expand Up @@ -651,8 +650,7 @@ class GenerateTestsDialogWindow(val model: GenerateTestsModel) : DialogWrapper(m
mockStrategies.isEnabled = areMocksSupported
staticsMocking.isEnabled = areMocksSupported && mockStrategies.item != MockStrategyApi.NO_MOCKS

codegenLanguages.item =
if (model.srcClasses.all { it is KtUltraLightClass }) CodegenLanguage.KOTLIN else CodegenLanguage.JAVA
codegenLanguages.item = model.codegenLanguage

val installedTestFramework = TestFramework.allItems.singleOrNull { it.isInstalled }
currentFrameworkItem = when (parametrizedTestSources.isSelected) {
Expand Down
23 changes: 17 additions & 6 deletions ...rc/main/kotlin/org/utbot/intellij/plugin/ui/components/TestFolderComboWithBrowseButton.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import javax.swing.JList
import org.jetbrains.kotlin.idea.util.projectStructure.allModules
import org.utbot.common.PathUtil
import org.utbot.intellij.plugin.models.GenerateTestsModel
import org.utbot.intellij.plugin.ui.utils.TestSourceRoot
import org.utbot.intellij.plugin.ui.utils.addDedicatedTestRoot
import org.utbot.intellij.plugin.ui.utils.isBuildWithGradle
import org.utbot.intellij.plugin.ui.utils.suitableTestSourceRoots
Expand Down Expand Up @@ -58,9 +59,20 @@ class TestFolderComboWithBrowseButton(private val model: GenerateTestsModel) :
val suggestedModules =
if (model.project.isBuildWithGradle) model.project.allModules() else model.potentialTestModules

val testRoots = suggestedModules.flatMap { it.suitableTestSourceRoots().toList() }.toMutableList()
val testRoots = suggestedModules.flatMap {
it.suitableTestSourceRoots()
}.sortedWith(
compareByDescending<TestSourceRoot> {
// Heuristics: Dirs with language == codegenLanguage should go first
it.expectedLanguage == model.codegenLanguage
}.thenBy {
// Heuristics: User is more likely to choose the shorter path
it.dir.path.length
}
).toMutableList()

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use sorting instead of filtering

// this method is blocked for Gradle, where multiple test modules can exist
model.testModule.addDedicatedTestRoot(testRoots)
model.testModule.addDedicatedTestRoot(testRoots, model.codegenLanguage)

if (testRoots.isNotEmpty()) {
configureRootsCombo(testRoots)
Expand Down Expand Up @@ -94,13 +106,12 @@ class TestFolderComboWithBrowseButton(private val model: GenerateTestsModel) :
files.singleOrNull()
}

private fun configureRootsCombo(testRoots: List<VirtualFile>) {
// unfortunately, Gradle creates Kotlin test source root with Java source root type, so type is misleading
private fun configureRootsCombo(testRoots: List<TestSourceRoot>) {
val selectedRoot = testRoots.first()

// do not update model.testModule here, because fake test source root could have been chosen
model.testSourceRoot = selectedRoot
newItemList(testRoots.toSet())
model.testSourceRoot = selectedRoot.dir
newItemList(testRoots.map { it.dir }.toSet())
}

private fun newItemList(comboItems: Set<Any>) {
Expand Down
59 changes: 42 additions & 17 deletions utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/ui/utils/ModuleUtils.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ import org.jetbrains.kotlin.platform.TargetPlatformVersion

private val logger = KotlinLogging.logger {}

data class TestSourceRoot(
val dir: VirtualFile,
val expectedLanguage: CodegenLanguage
)

/**
* @return jdk version of the module
*/
Expand All @@ -60,12 +65,6 @@ fun Module.kotlinTargetPlatform(): TargetPlatformVersion {
?.singleOrNull() ?: error("Can't determine target platform for module $this")
}

fun Module.suitableTestSourceRoots(): List<VirtualFile> =
suitableTestSourceRoots(CodegenLanguage.JAVA) + suitableTestSourceRoots(CodegenLanguage.KOTLIN)

fun Module.suitableTestSourceFolders(): List<SourceFolder> =
suitableTestSourceFolders(CodegenLanguage.JAVA) + suitableTestSourceFolders(CodegenLanguage.KOTLIN)

/**
* Gets a path to test resources source root.
*
Expand Down Expand Up @@ -121,8 +120,8 @@ private fun findPotentialModulesForTests(project: Project, srcModule: Module): L
/**
* Finds all suitable test root virtual files.
*/
fun Module.suitableTestSourceRoots(codegenLanguage: CodegenLanguage): List<VirtualFile> {
val sourceRootsInModule = suitableTestSourceFolders(codegenLanguage).mapNotNull { it.file }
fun Module.suitableTestSourceRoots(): List<TestSourceRoot> {
val sourceRootsInModule = suitableTestSourceFolders().mapNotNull { it.testSourceRoot }

if (sourceRootsInModule.isNotEmpty()) {
return sourceRootsInModule
Expand All @@ -133,22 +132,30 @@ fun Module.suitableTestSourceRoots(codegenLanguage: CodegenLanguage): List<Virtu
ModuleUtilCore.collectModulesDependsOn(this, dependentModules)

return dependentModules
.flatMap { it.suitableTestSourceFolders(codegenLanguage) }
.mapNotNull { it.file }
.flatMap { it.suitableTestSourceFolders() }
.mapNotNull { it.testSourceRoot }
}

private fun Module.suitableTestSourceFolders(codegenLanguage: CodegenLanguage): List<SourceFolder> {
private val SourceFolder.testSourceRoot:TestSourceRoot?
get() {
val file = file
val expectedLanguage = expectedLanguageForTests
if (file != null && expectedLanguage != null)
return TestSourceRoot(file, expectedLanguage)
return null
}

private fun Module.suitableTestSourceFolders(): List<SourceFolder> {
val sourceFolders = ModuleRootManager.getInstance(this)
.contentEntries
.flatMap { it.sourceFolders.toList() }
.filterNotNull()

return sourceFolders
.filterNot { it.isForGeneratedSources() }
.filter { it.rootType == codegenLanguage.testRootType() }
// Heuristics: User is more likely to choose the shorter path
.sortedBy { it.url.length }
.filter { it.isTestSource }
}

private val GRADLE_SYSTEM_ID = ProjectSystemId("GRADLE")

val Project.isBuildWithGradle get() =
Expand All @@ -157,19 +164,20 @@ val Project.isBuildWithGradle get() =
}

private const val dedicatedTestSourceRootName = "utbot_tests"
fun Module.addDedicatedTestRoot(testSourceRoots: MutableList<VirtualFile>): VirtualFile? {

fun Module.addDedicatedTestRoot(testSourceRoots: MutableList<TestSourceRoot>, language: CodegenLanguage): VirtualFile? {
// Don't suggest new test source roots for Gradle project where 'unexpected' test roots won't work
if (project.isBuildWithGradle) return null
// Dedicated test root already exists
if (testSourceRoots.any { file -> file.name == dedicatedTestSourceRootName }) return null
if (testSourceRoots.any { root -> root.dir.name == dedicatedTestSourceRootName }) return null

val moduleInstance = ModuleRootManager.getInstance(this)
val testFolder = moduleInstance.contentEntries.flatMap { it.sourceFolders.toList() }
.firstOrNull { it.rootType in testSourceRootTypes }
(testFolder?.let { testFolder.file?.parent }
?: testFolder?.contentEntry?.file ?: this.guessModuleDir())?.let {
val file = FakeVirtualFile(it, dedicatedTestSourceRootName)
testSourceRoots.add(file)
testSourceRoots.add(TestSourceRoot(file, language))
// We return "true" IFF it's case of not yet created fake directory
return if (VfsUtil.findRelativeFile(it, dedicatedTestSourceRootName) == null) file else null
}
Expand Down Expand Up @@ -275,3 +283,20 @@ private fun jdkVersionBy(sdk: Sdk?): JavaSdkVersion {
}
return jdkVersion
}

private val SourceFolder.expectedLanguageForTests: CodegenLanguage?
get() {
// unfortunately, Gradle creates Kotlin test source root with Java source root type, so type is misleading,
// and we should try looking for name first
if (file?.name == "kotlin")
return CodegenLanguage.KOTLIN

if (file?.name == "java")
return CodegenLanguage.JAVA

return when (rootType) {
CodegenLanguage.KOTLIN.testRootType() -> CodegenLanguage.KOTLIN
CodegenLanguage.JAVA.testRootType() -> CodegenLanguage.JAVA
else -> null
}
}