[starter] Add support of shallow git clone for project that don't nee…

…d full VCS history GitOrigin-RevId: bce958038eb54008dbc937e4374d678b9b3daaa0
JetBrains · Jun 20, 2024 · e16a7a5 · e16a7a5
1 parent 8b3edbb
commit e16a7a5
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/project/GitProjectInfo.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/project/GitProjectInfo.kt
@@ -35,6 +35,11 @@ data class GitProjectInfo(
   override val isReusable: Boolean = false,
   override val downloadTimeout: Duration = 10.minutes,
 
+  /**
+   * Set to true if you test don't need full VCS history and branches and project doesn't use submodules.
+   */
+  val shallow: Boolean = false,
+
   /**
    * Relative path inside Image file, where project home is located
    */
@@ -54,7 +59,7 @@ data class GitProjectInfo(
     get() = repositoryRootDir.let(projectHomeRelativePath)
 
   private fun cloneRepo(projectHome: Path) {
-    Git.clone(repoUrl = repositoryUrl, destinationDir = projectHome, branchName = branchName, timeout = downloadTimeout)
+    Git.clone(repoUrl = repositoryUrl, destinationDir = projectHome, branchName = branchName, shallow = false, timeout = downloadTimeout)
   }
 
   private fun setupRepositoryState(projectHome: Path) {

diff --git a/intellij.tools.ide.starter/src/com/intellij/ide/starter/utils/Git.kt b/intellij.tools.ide.starter/src/com/intellij/ide/starter/utils/Git.kt
@@ -4,10 +4,8 @@ import com.intellij.ide.starter.process.exec.ExecOutputRedirect
 import com.intellij.ide.starter.process.exec.ProcessExecutor
 import com.intellij.ide.starter.runner.SetupException
 import com.intellij.openapi.application.PathManager
-import com.intellij.tools.ide.util.common.PrintFailuresMode
 import com.intellij.tools.ide.util.common.logError
 import com.intellij.tools.ide.util.common.logOutput
-import com.intellij.tools.ide.util.common.withRetryBlocking
 import java.io.File
 import java.io.IOException
 import java.nio.file.Path
@@ -95,11 +93,12 @@ object Git {
     return Path(stdout.read().split("\n").first().trim()).toAbsolutePath()
   }
 
-  fun clone(repoUrl: String, destinationDir: Path, branchName: String = "", timeout: Duration = 10.minutes) {
+  fun clone(repoUrl: String, destinationDir: Path, branchName: String = "", shallow: Boolean, timeout: Duration = 10.minutes) {
     val cmdName = "git-clone"
 
     val arguments = mutableListOf("git", "clone", repoUrl, destinationDir.toString())
     if (branchName.isNotEmpty()) arguments.addAll(listOf("-b", branchName))
+    if (shallow) arguments.addAll(listOf("--depth", "1"))
 
     withRetryBlocking("Git clone $repoUrl failed", rollback = {
       logOutput("Deleting $destinationDir")