[workspace model tests] AT-427 Downloading public installers even on …

…dev build server GitOrigin-RevId: 77a44356c4e42dbea24566c52729114408a85496
JetBrains · Oct 2, 2023 · b3fe73f · b3fe73f
1 parent 3549f79
commit b3fe73f
Show file tree

Hide file tree

Showing 19 changed files with 90 additions and 77 deletions.
diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/community/IdeByLinkDownloader.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/community/IdeByLinkDownloader.kt
@@ -1,15 +1,15 @@
 package com.intellij.ide.starter.community
 
 import com.intellij.ide.starter.ide.IdeDownloader
-import com.intellij.ide.starter.ide.installer.IdeInstaller
+import com.intellij.ide.starter.ide.installer.IdeInstallerFile
 import com.intellij.ide.starter.models.IdeInfo
 import com.intellij.ide.starter.utils.HttpClient
 import com.intellij.ide.starter.utils.logOutput
 import java.nio.file.Path
 import kotlin.io.path.exists
 
 object IdeByLinkDownloader : IdeDownloader {
-  override fun downloadIdeInstaller(ideInfo: IdeInfo, installerDirectory: Path): IdeInstaller {
+  override fun downloadIdeInstaller(ideInfo: IdeInfo, installerDirectory: Path): IdeInstallerFile {
     requireNotNull(ideInfo.downloadURI) { "Download URI should not be null for $ideInfo" }
 
     val installerFile = installerDirectory.resolve("${ideInfo.installerFilePrefix}-${ideInfo.buildNumber}${ideInfo.installerFileExt}")
@@ -20,6 +20,6 @@ object IdeByLinkDownloader : IdeDownloader {
     }
     else logOutput("Installer file $installerFile already exists. Skipping download.")
 
-    return IdeInstaller(installerFile, ideInfo.buildNumber)
+    return IdeInstallerFile(installerFile, ideInfo.buildNumber)
   }
 }
diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/community/PublicIdeDownloader.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/community/PublicIdeDownloader.kt
@@ -2,7 +2,7 @@ package com.intellij.ide.starter.community
 
 import com.intellij.ide.starter.community.model.ReleaseInfo
 import com.intellij.ide.starter.ide.IdeDownloader
-import com.intellij.ide.starter.ide.installer.IdeInstaller
+import com.intellij.ide.starter.ide.installer.IdeInstallerFile
 import com.intellij.ide.starter.models.IdeInfo
 import com.intellij.ide.starter.system.OsType
 import com.intellij.ide.starter.system.SystemInfo
@@ -36,7 +36,7 @@ object PublicIdeDownloader : IdeDownloader {
     throw NoSuchElementException("Couldn't find specified release by parameters $filteringParams")
   }
 
-  override fun downloadIdeInstaller(ideInfo: IdeInfo, installerDirectory: Path): IdeInstaller {
+  override fun downloadIdeInstaller(ideInfo: IdeInfo, installerDirectory: Path): IdeInstallerFile {
     val params = ProductInfoRequestParameters(type = ideInfo.productCode,
                                               snapshot = ideInfo.buildType,
                                               buildNumber = ideInfo.buildNumber,
@@ -64,6 +64,6 @@ object PublicIdeDownloader : IdeDownloader {
     }
     else logOutput("Installer file $installerFile already exists. Skipping download.")
 
-    return IdeInstaller(installerFile, possibleBuild.build)
+    return IdeInstallerFile(installerFile, possibleBuild.build)
   }
 }
diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/di/diContainer.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/di/diContainer.kt
@@ -10,9 +10,7 @@ import com.intellij.ide.starter.frameworks.Framework
 import com.intellij.ide.starter.ide.CodeInjector
 import com.intellij.ide.starter.ide.IDETestContext
 import com.intellij.ide.starter.ide.IdeDownloader
-import com.intellij.ide.starter.ide.IdeInstallator
 import com.intellij.ide.starter.ide.installer.IdeInstallerFactory
-import com.intellij.ide.starter.models.IdeInfo
 import com.intellij.ide.starter.models.IdeProduct
 import com.intellij.ide.starter.models.IdeProductImp
 import com.intellij.ide.starter.path.GlobalPaths
@@ -49,7 +47,7 @@ var di = DI {
   bindSingleton<CodeInjector> { CodeBuilderHost() }
   bindFactory { testContext: IDETestContext -> PluginConfigurator(testContext) }
   bindSingleton<IdeDownloader> { PublicIdeDownloader }
-  bindFactory<IdeInfo, IdeInstallator> { ideInfo -> IdeInstallerFactory().createInstaller(ideInfo) }
+  bindSingleton<IdeInstallerFactory> { IdeInstallerFactory() }
 
   // you can extend DI with frameworks, specific to IDE language stack
   bindArgSet<IDETestContext, Framework>()

diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/IdeDistribution.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/IdeDistribution.kt
@@ -1,7 +1,19 @@
 package com.intellij.ide.starter.ide
 
 import java.nio.file.Path
+import kotlin.io.path.isRegularFile
+import kotlin.io.path.readText
 
 abstract class IdeDistribution {
   abstract fun installIde(unpackDir: Path, executableFileName: String): InstalledIde
+
+  companion object {
+    /** @return Product code and build number */
+    fun readProductCodeAndBuildNumberFromBuildTxt(buildTxtPath: Path): Pair<String, String> {
+      require(buildTxtPath.isRegularFile()) { "Cannot find build.txt file" }
+
+      val (productCode, build) = buildTxtPath.readText().trim().split("-", limit = 2)
+      return Pair(productCode, build)
+    }
+  }
 }
diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/IdeDownloader.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/IdeDownloader.kt
@@ -1,9 +1,9 @@
 package com.intellij.ide.starter.ide
 
-import com.intellij.ide.starter.ide.installer.IdeInstaller
+import com.intellij.ide.starter.ide.installer.IdeInstallerFile
 import com.intellij.ide.starter.models.IdeInfo
 import java.nio.file.Path
 
 interface IdeDownloader {
-  fun downloadIdeInstaller(ideInfo: IdeInfo, installerDirectory: Path): IdeInstaller
+  fun downloadIdeInstaller(ideInfo: IdeInfo, installerDirectory: Path): IdeInstallerFile
 }
diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/IdeInstallator.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/IdeInstallator.kt
diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/IdeInstaller.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/IdeInstaller.kt
@@ -0,0 +1,16 @@
+package com.intellij.ide.starter.ide
+
+import com.intellij.ide.starter.di.di
+import com.intellij.ide.starter.models.IdeInfo
+import org.kodein.di.direct
+import org.kodein.di.instance
+
+interface IdeInstaller {
+  val downloader: IdeDownloader
+    get() = di.direct.instance<IdeDownloader>()
+
+  /**
+   * @return <Build Number, InstalledIde>
+   */
+  fun install(ideInfo: IdeInfo): Pair<String, InstalledIde>
+}
diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/InstalledIde.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/InstalledIde.kt
@@ -26,5 +26,8 @@ interface InstalledIde {
 
   fun resolveAndDownloadTheSameJDK(): Path
 
-  fun isMajorVersionAtLeast(v: Int) = build.substringBefore(".").toIntOrNull()?.let { it >= v } ?: true
+  /** Check the major version of the build number.
+   * Eg: 232.9921.47 => 232
+   **/
+  fun isMajorBuildVersionAtLeast(v: Int) = build.substringBefore(".").toIntOrNull()?.let { it >= v } ?: true
 }
diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/LinuxIdeDistribution.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/LinuxIdeDistribution.kt
@@ -53,10 +53,7 @@ class LinuxIdeDistribution : IdeDistribution() {
     require(SystemInfo.isLinux) { "Can only run on Linux, docker is possible, please PR" }
 
     val appHome = (unpackDir.toFile().listFiles()?.singleOrNull { it.isDirectory }?.toPath() ?: unpackDir).toAbsolutePath()
-
-    val buildTxtPath = appHome.resolve("build.txt")
-    require(buildTxtPath.isRegularFile()) { "Cannot find build.txt file in $appHome" }
-    val (productCode, build) = buildTxtPath.readText().trim().split("-", limit = 2)
+    val (productCode, build) = readProductCodeAndBuildNumberFromBuildTxt(appHome.resolve("build.txt"))
 
     val binDir = appHome / "bin"
     val allBinFiles = binDir.listDirectoryEntries()

diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/MacOsIdeDistribution.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/MacOsIdeDistribution.kt
@@ -11,7 +11,6 @@ import java.nio.file.Path
 import kotlin.io.path.div
 import kotlin.io.path.isDirectory
 import kotlin.io.path.isRegularFile
-import kotlin.io.path.readText
 
 class MacOsIdeDistribution : IdeDistribution() {
 
@@ -53,10 +52,7 @@ class MacOsIdeDistribution : IdeDistribution() {
     val executablePath = appHome / "MacOS" / executableName
     require(executablePath.isRegularFile()) { "Cannot find macOS IDE executable file in $executablePath" }
 
-    val buildTxtPath = appHome / "Resources" / "build.txt"
-    require(buildTxtPath.isRegularFile()) { "Cannot find macOS IDE vmoptions file in $executablePath" }
-
-    val (productCode, build) = buildTxtPath.readText().trim().split("-", limit = 2)
+    val (productCode, build) = readProductCodeAndBuildNumberFromBuildTxt(appHome / "Resources" / "build.txt")
 
     return object : InstalledIde {
       override val bundledPluginsDir = appHome / "plugins"

diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/WindowsIdeDistribution.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/WindowsIdeDistribution.kt
@@ -5,13 +5,13 @@ import com.intellij.ide.starter.system.OsType
 import com.intellij.ide.starter.utils.JvmUtils
 import com.intellij.ide.starter.utils.logOutput
 import java.nio.file.Path
-import kotlin.io.path.*
+import kotlin.io.path.div
+import kotlin.io.path.isDirectory
+import kotlin.io.path.listDirectoryEntries
 
 class WindowsIdeDistribution : IdeDistribution() {
   override fun installIde(unpackDir: Path, executableFileName: String): InstalledIde {
-    val buildTxtPath = unpackDir.resolve("build.txt")
-    require(buildTxtPath.isRegularFile()) { "Cannot find WindowsOS IDE vmoptions file in $unpackDir" }
-    val (productCode, build) = buildTxtPath.readText().trim().split("-", limit = 2)
+    val (productCode, build) = readProductCodeAndBuildNumberFromBuildTxt(unpackDir.resolve("build.txt"))
 
     val binDir = unpackDir / "bin"
 
@@ -24,7 +24,7 @@ class WindowsIdeDistribution : IdeDistribution() {
     return object : InstalledIde {
       override val bundledPluginsDir = unpackDir.resolve("plugins")
 
-      private val vmOptionsFinal: VMOptions =VMOptions(
+      private val vmOptionsFinal: VMOptions = VMOptions(
         ide = this,
         data = emptyList(),
         env = emptyMap()

diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/installer/AndroidInstaller.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/installer/AndroidInstaller.kt
@@ -3,7 +3,7 @@ package com.intellij.ide.starter.ide.installer
 import com.intellij.ide.starter.di.di
 import com.intellij.ide.starter.ide.IdeArchiveExtractor
 import com.intellij.ide.starter.ide.IdeDistributionFactory
-import com.intellij.ide.starter.ide.IdeInstallator
+import com.intellij.ide.starter.ide.IdeInstaller
 import com.intellij.ide.starter.ide.InstalledIde
 import com.intellij.ide.starter.models.IdeInfo
 import com.intellij.ide.starter.path.GlobalPaths
@@ -14,7 +14,7 @@ import java.io.File
 import java.nio.file.Path
 import kotlin.io.path.div
 
-class AndroidInstaller : IdeInstallator {
+class AndroidInstaller : IdeInstaller {
 
   /**
    * Resolve platform specific android studio installer and return paths

diff --git a/...r/ide/installer/ExistingIdeInstallator.kt → ...ter/ide/installer/ExistingIdeInstaller.kt b/...r/ide/installer/ExistingIdeInstallator.kt → ...ter/ide/installer/ExistingIdeInstaller.kt
@@ -1,25 +1,28 @@
 package com.intellij.ide.starter.ide.installer
 
-import com.intellij.ide.starter.di.di
 import com.intellij.ide.starter.ide.IdeDistributionFactory
-import com.intellij.ide.starter.ide.IdeInstallator
+import com.intellij.ide.starter.ide.IdeInstaller
 import com.intellij.ide.starter.ide.InstalledIde
 import com.intellij.ide.starter.models.IdeInfo
 import com.intellij.ide.starter.path.GlobalPaths
 import org.apache.commons.io.FileUtils
-import org.kodein.di.direct
-import org.kodein.di.instance
 import java.nio.file.Path
 import kotlin.io.path.div
 
 /**
  * Use existing installed IDE instead of downloading one.
  * Set it as:
- * `bindFactory<IdeInfo, IdeInstallator>(overrides = true) { _ -> ExistingIdeInstallator(Paths.get(pathToInstalledIDE)) }`
+ * `bindSingleton<IdeInstallerFactory>(overrides = true) {
+ *    object : IdeInstallerFactory() {
+ *       override fun createInstaller(ideInfo: IdeInfo, downloader: IdeDownloader): IdeInstaller {
+ *         return ExistingIdeInstaller(Paths.get(pathToInstalledIDE))
+ *       }
+ *     }
+ * }`
  */
-class ExistingIdeInstallator(private val installedIdePath: Path) : IdeInstallator {
+class ExistingIdeInstaller(private val installedIdePath: Path) : IdeInstaller {
   override fun install(ideInfo: IdeInfo): Pair<String, InstalledIde> {
-    val ideInstaller = IdeInstaller(installedIdePath, "locally-installed-ide")
+    val ideInstaller = IdeInstallerFile(installedIdePath, "locally-installed-ide")
     val installDir = GlobalPaths.instance
                        .getCacheDirectoryFor("builds") / "${ideInfo.productCode}-${ideInstaller.buildNumber}"
     installDir.toFile().deleteRecursively()

diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/installer/IdeInstallerFactory.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/ide/installer/IdeInstallerFactory.kt
@@ -1,14 +1,18 @@
 package com.intellij.ide.starter.ide.installer
 
-import com.intellij.ide.starter.ide.IdeInstallator
+import com.intellij.ide.starter.di.di
+import com.intellij.ide.starter.ide.IdeDownloader
+import com.intellij.ide.starter.ide.IdeInstaller
 import com.intellij.ide.starter.ide.IdeProductProvider
 import com.intellij.ide.starter.models.IdeInfo
+import org.kodein.di.direct
+import org.kodein.di.instance
 
 open class IdeInstallerFactory {
-  open fun createInstaller(ideInfo: IdeInfo): IdeInstallator {
+  open fun createInstaller(ideInfo: IdeInfo, downloader: IdeDownloader = di.direct.instance<IdeDownloader>()): IdeInstaller {
     return if (ideInfo.productCode == IdeProductProvider.AI.productCode)
       AndroidInstaller()
     else
-      SimpleInstaller()
+      StandardInstaller(downloader)
   }
 }
diff --git a/...ide/starter/ide/installer/IdeInstaller.kt → ...starter/ide/installer/IdeInstallerFile.kt b/...ide/starter/ide/installer/IdeInstaller.kt → ...starter/ide/installer/IdeInstallerFile.kt
@@ -2,6 +2,6 @@ package com.intellij.ide.starter.ide.installer
 
 import java.nio.file.Path
 
-open class IdeInstaller(val installerFile: Path, val buildNumber: String) {
+open class IdeInstallerFile(val installerFile: Path, val buildNumber: String) {
   companion object
 }
diff --git a/.../starter/ide/installer/SimpleInstaller.kt → ...tarter/ide/installer/StandardInstaller.kt b/.../starter/ide/installer/SimpleInstaller.kt → ...tarter/ide/installer/StandardInstaller.kt
@@ -1,22 +1,23 @@
 package com.intellij.ide.starter.ide.installer
 
-import com.intellij.ide.starter.ide.IdeArchiveExtractor
-import com.intellij.ide.starter.ide.IdeDistributionFactory
-import com.intellij.ide.starter.ide.IdeInstallator
-import com.intellij.ide.starter.ide.InstalledIde
+import com.intellij.ide.starter.di.di
+import com.intellij.ide.starter.ide.*
 import com.intellij.ide.starter.models.IdeInfo
 import com.intellij.ide.starter.path.GlobalPaths
 import com.intellij.ide.starter.utils.logOutput
+import org.kodein.di.direct
+import org.kodein.di.instance
 import kotlin.io.path.createDirectories
 import kotlin.io.path.div
 
-class SimpleInstaller : IdeInstallator {
+/** Prebuilt installer, distributed via archive (.tar.gz, .exe, .dmg) */
+class StandardInstaller(override val downloader: IdeDownloader = di.direct.instance<IdeDownloader>()) : IdeInstaller {
 
   override fun install(ideInfo: IdeInfo): Pair<String, InstalledIde> {
     val installersDirectory = (GlobalPaths.instance.installersDirectory / ideInfo.productCode).createDirectories()
 
     //Download
-    val ideInstaller = ideInfo.download(installersDirectory)
+    val ideInstaller = downloader.downloadIdeInstaller(ideInfo, installersDirectory)
     val installDir = GlobalPaths.instance.getCacheDirectoryFor("builds") / "${ideInfo.productCode}-${ideInstaller.buildNumber}"
 
     if (ideInstaller.buildNumber == "SNAPSHOT") {

diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/models/IdeInfo.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/models/IdeInfo.kt
@@ -2,13 +2,12 @@ package com.intellij.ide.starter.models
 
 import com.intellij.ide.starter.community.model.BuildType
 import com.intellij.ide.starter.di.di
-import com.intellij.ide.starter.ide.IdeDownloader
-import com.intellij.ide.starter.ide.installer.IdeInstaller
+import com.intellij.ide.starter.ide.IdeInstaller
+import com.intellij.ide.starter.ide.installer.IdeInstallerFactory
 import com.intellij.ide.starter.system.SystemInfo
 import org.kodein.di.direct
 import org.kodein.di.instance
 import java.net.URI
-import java.nio.file.Path
 
 data class IdeInfo(
   /**
@@ -37,13 +36,8 @@ data class IdeInfo(
 
   val fullName: String,
 
-  private val downloader: IdeDownloader = di.direct.instance<IdeDownloader>()
+  val getInstaller: (IdeInfo) -> IdeInstaller = { di.direct.instance<IdeInstallerFactory>().createInstaller(it) }
 ) {
-
-  fun download(installerDirectory: Path): IdeInstaller {
-    return downloader.downloadIdeInstaller(this, installerDirectory)
-  }
-
   companion object
 
   val installerFilePrefix

diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/models/TestCase.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/models/TestCase.kt
@@ -3,6 +3,7 @@ package com.intellij.ide.starter.models
 import com.intellij.ide.starter.community.PublicIdeDownloader
 import com.intellij.ide.starter.community.model.BuildType
 import com.intellij.ide.starter.ide.IdeProductProvider
+import com.intellij.ide.starter.ide.installer.StandardInstaller
 import com.intellij.ide.starter.project.GitProjectInfo
 import com.intellij.ide.starter.project.LocalProjectInfo
 import com.intellij.ide.starter.project.ProjectInfoSpec
@@ -43,20 +44,22 @@ data class TestCase<T : ProjectInfoSpec>(
     buildNumber: String? = null,
     version: String? = null
   ): TestCase<T> {
-    return copy(ideInfo = ideInfo.copy(
-      buildType = buildType?.type ?: "",
-      downloader = PublicIdeDownloader,
-      buildNumber = buildNumber ?: "",
-      version = version ?: ""
-    ))
+    return copy(
+      ideInfo = ideInfo.copy(
+        buildType = buildType?.type ?: "",
+        buildNumber = buildNumber ?: "",
+        version = version ?: ""
+      ).run { this.copy(getInstaller = { StandardInstaller(PublicIdeDownloader) }) }
+    )
   }
 
   fun useRC(): TestCase<T> = copyWithPublicIdeDownloaderAndUpdatedInfo(buildType = BuildType.RC)
 
   fun useEAP(): TestCase<T> = copyWithPublicIdeDownloaderAndUpdatedInfo(buildType = BuildType.EAP)
 
   /** E.g: "222.3244.1" */
-  private fun useEAP(buildNumber: String = ""): TestCase<T> = copyWithPublicIdeDownloaderAndUpdatedInfo(BuildType.EAP, buildNumber = buildNumber)
+  private fun useEAP(buildNumber: String = ""): TestCase<T> = copyWithPublicIdeDownloaderAndUpdatedInfo(BuildType.EAP,
+                                                                                                        buildNumber = buildNumber)
 
   fun useRelease(): TestCase<T> = copyWithPublicIdeDownloaderAndUpdatedInfo(buildType = BuildType.RELEASE)