Improve library versions analysis #2259 (#2263)

Author: EgorkaKulikov

utbot-intellij/src/main/kotlin/org/utbot/intellij/plugin/models/ExternalLibraryDescriptors.kt

@@ -2,6 +2,7 @@ package org.utbot.intellij.plugin.models
 
 import com.intellij.openapi.roots.ExternalLibraryDescriptor
 import org.jetbrains.idea.maven.utils.library.RepositoryLibraryDescription
+import org.utbot.intellij.plugin.ui.utils.Version
 
 val ExternalLibraryDescriptor.mavenCoordinates: String
     get() = "$libraryGroupId:$libraryArtifactId:${preferredVersion ?: RepositoryLibraryDescription.ReleaseVersionId}"
@@ -10,33 +11,70 @@ val ExternalLibraryDescriptor.id: String
     get() = "$libraryGroupId:$libraryArtifactId"
 
 //TODO: think about using JUnitExternalLibraryDescriptor from intellij-community sources (difficult to install)
-fun jUnit4LibraryDescriptor(versionInProject: String?) =
-    ExternalLibraryDescriptor("junit", "junit", "4.12", null, versionInProject ?: "4.13.2")
+fun jUnit4LibraryDescriptor(versionInProject: Version?): ExternalLibraryDescriptor {
+    val preferredVersion = if (versionInProject?.hasNumericOrEmptyPatch() == true) versionInProject?.plainText else "4.13.2"
+    return ExternalLibraryDescriptor(
+        "junit", "junit",
+        "4.12", null, preferredVersion
+    )
+}
 
-fun jUnit5LibraryDescriptor(versionInProject: String?) =
-    ExternalLibraryDescriptor("org.junit.jupiter", "junit-jupiter", "5.8.1", null, versionInProject ?: "5.8.1")
+fun jUnit5LibraryDescriptor(versionInProject: Version?): ExternalLibraryDescriptor {
+    val preferredVersion = if (versionInProject?.hasNumericOrEmptyPatch() == true) versionInProject?.plainText else "5.8.1"
+    return ExternalLibraryDescriptor(
+        "org.junit.jupiter", "junit-jupiter",
+        "5.8.1", null, preferredVersion
+    )
+}
 
-fun jUnit5ParametrizedTestsLibraryDescriptor(versionInProject: String?) =
-    ExternalLibraryDescriptor("org.junit.jupiter", "junit-jupiter-params", "5.8.1", null, versionInProject ?: "5.8.1")
+fun jUnit5ParametrizedTestsLibraryDescriptor(versionInProject: Version?): ExternalLibraryDescriptor {
+    val preferredVersion = if (versionInProject?.hasNumericOrEmptyPatch() == true) versionInProject?.plainText else "5.8.1"
+    return ExternalLibraryDescriptor(
+        "org.junit.jupiter", "junit-jupiter-params",
+        "5.8.1", null, preferredVersion
+    )
+}
 
-fun mockitoCoreLibraryDescriptor(versionInProject: String?) =
-    ExternalLibraryDescriptor("org.mockito", "mockito-core", "3.5.0", null, versionInProject ?: "4.2.0")
+fun mockitoCoreLibraryDescriptor(versionInProject: Version?): ExternalLibraryDescriptor {
+    val preferredVersion = if (versionInProject?.hasNumericOrEmptyPatch() == true) versionInProject?.plainText else "4.2.0"
+    return ExternalLibraryDescriptor(
+        "org.mockito", "mockito-core",
+        "3.5.0", null, preferredVersion
+    )
+}
 
-fun springBootTestLibraryDescriptor(versionInProject: String?) =
-    ExternalLibraryDescriptor("org.springframework.boot", "spring-boot-test", "2.4.0", null, versionInProject ?: "3.0.6")
+fun springBootTestLibraryDescriptor(versionInProject: Version?): ExternalLibraryDescriptor {
+    val preferredVersion = if (versionInProject?.hasNumericOrEmptyPatch() == true) versionInProject?.plainText else "3.0.6"
+    return ExternalLibraryDescriptor(
+        "org.springframework.boot", "spring-boot-test",
+        "2.4.0", null, preferredVersion
+    )
+}
 
-fun springTestLibraryDescriptor(versionInProject: String?) =
-    ExternalLibraryDescriptor("org.springframework", "spring-test", "2.5", null, versionInProject ?: "6.0.8")
+fun springTestLibraryDescriptor(versionInProject: Version?): ExternalLibraryDescriptor {
+    val preferredVersion = if (versionInProject?.hasNumericOrEmptyPatch() == true) versionInProject?.plainText else "6.0.8"
+    return ExternalLibraryDescriptor(
+        "org.springframework", "spring-test",
+        "2.5", null, preferredVersion
+    )
+}
 
 
 /**
  * TestNg requires JDK 11 since version 7.6.0
  * For projects with JDK 8 version 7.5 should be installed.
  * See https://groups.google.com/g/testng-users/c/BAFB1vk-kok?pli=1 for more details.
  */
-
-fun testNgNewLibraryDescriptor(versionInProject: String?) =
-    ExternalLibraryDescriptor("org.testng", "testng", "7.6.0", null, versionInProject ?: "7.6.0")
+fun testNgNewLibraryDescriptor(versionInProject: Version?): ExternalLibraryDescriptor {
+    val preferredVersion = if (versionInProject?.hasNumericOrEmptyPatch() == true) versionInProject?.plainText else "7.6.0"
+    return ExternalLibraryDescriptor(
+        "org.testng", "testng",
+        "7.6.0", null, preferredVersion
+    )
+}
 
 fun testNgOldLibraryDescriptor() =
-    ExternalLibraryDescriptor("org.testng", "testng", "7.5", "7.5", "7.5")
+    ExternalLibraryDescriptor(
+        "org.testng", "testng",
+        "7.5", "7.5", "7.5"
+    )

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

@@ -964,7 +964,9 @@ class GenerateTestsDialogWindow(val model: GenerateTestsModel) : DialogWrapper(m
             ?: error("Trying to install Spring test framework, but Spring framework is not found in module ${model.srcModule.name}")
         val frameworkTestVersionInProject = frameworkTestLibrary?.libraryName?.parseVersion()
 
-        if (frameworkTestVersionInProject == null || frameworkTestVersionInProject < frameworkVersionInProject) {
+        if (frameworkTestVersionInProject == null ||
+            !frameworkTestVersionInProject.isCompatibleWith(frameworkVersionInProject)
+) {
             val libraryDescriptor = when (framework) {
                 SpringBoot ->  springBootTestLibraryDescriptor(frameworkVersionInProject)
                 SpringBeans -> springTestLibraryDescriptor(frameworkVersionInProject)

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

@@ -25,20 +25,6 @@ fun Module.allLibraries(): List<LibraryOrderEntry> {
     val moduleRootManager = ModuleRootManager.getInstance(this)
     return allLibraries(moduleRootManager.orderEntries())
 }
-
-fun String.parseVersion(): String? {
-    val lastSemicolon = lastIndexOf(':')
-    val version = substring(lastSemicolon + 1)
-
-    if (lastSemicolon == -1 ||
-        version.split('.').any { it.toIntOrNull() == null }
-    ) {
-        return null
-    }
-
-    return version
-}
-
 fun List<LibraryOrderEntry>.matchesAnyOf(patterns: List<Regex>): LibraryOrderEntry? =
     firstOrNull { entry ->
         patterns.any { pattern ->

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

@@ -0,0 +1,50 @@
+package org.utbot.intellij.plugin.ui.utils
+
+/**
+ * Describes the version of a library.
+ * Contains three standard components: major, minor and patch.
+ *
+ * Major and minor components are always numbers, while patch
+ * may contain a number with some postfix like -RELEASE.
+ *
+ * Sometimes patch is empty, e.g. for TestNg 7.5 version.
+ *
+ * @param plainText is optional and represents whole version as text.
+ */
+data class Version(
+    val major: Int,
+    val minor: Int,
+    val patch: String,
+    val plainText: String? = null,
+) {
+    fun isCompatibleWith(another: Version): Boolean {
+        //Non-numeric versions can't be compared to each other, so we cannot be sure that current is compatible
+        if (!hasNumericOrEmptyPatch() || !hasNumericOrEmptyPatch()) {
+            return false
+        }
+
+        return major > another.major ||
+                major == another.major && minor > another.minor ||
+                major == another.major && minor == another.minor &&
+                (another.patch.isEmpty() || patch.isNotEmpty() && patch.toInt() >= another.patch.toInt())
+    }
+
+    fun hasNumericOrEmptyPatch(): Boolean = patch.toIntOrNull() != null
+}
+
+fun String.parseVersion(): Version? {
+    val lastSemicolon = lastIndexOf(':')
+    val versionText = substring(lastSemicolon + 1)
+    val versionComponents = versionText.split('.')
+
+    // Components must be: major, minor and (optional) patch
+    if (versionComponents.size < 2 || versionComponents.size > 3) {
+        return null
+    }
+
+    val major = versionComponents[0].toIntOrNull() ?: return null
+    val minor = versionComponents[1].toIntOrNull() ?: return null
+    val patch = if (versionComponents.size == 3) versionComponents[2] else ""
+
+    return Version(major, minor, patch, versionText)
+}