[tests] disable colors in the sbt process to avoid ascii sequences in the output that we parse, reuse more utilities between test code (part 2)

Author: unkarjedy

packaging/src/test/scala-2.12/org/jetbrains/sbtidea/packaging/RegenerateProjectsStructureTestData.scala

@@ -9,6 +9,7 @@ import org.jetbrains.sbtidea.packaging.structure.sbtImpl.SbtPackagedProjectNodeI
 import org.jetbrains.sbtidea.packaging.testUtils.CirceEncodersDecoders.*
 import org.jetbrains.sbtidea.packaging.testUtils.{JsonUtils, RevisionReference, TestDataDir}
 import org.jetbrains.sbtidea.testUtils.IoUtils.*
+import org.jetbrains.sbtidea.testUtils.SbtProjectFilesUtils.IoMode.PrintAndCollectOutput
 import org.jetbrains.sbtidea.testUtils.{CurrentEnvironmentUtils, SbtProjectFilesUtils}
 import sbt.fileToRichFile
 
@@ -241,8 +242,7 @@ object RegenerateProjectsStructureTestData {
     val outputLines = SbtProjectFilesUtils.runSbtProcess(
       Seq(s"dumpStructureToFile $baseTargetStructuresDir"),
       repoDir,
-      inheritIO = false,
-      printAndCollectOutput = true,
+      ioMode = PrintAndCollectOutput,
       //ensure we reuse downloaded artifacts between tests if they need the same artifacts
       vmOptions = vmOptions,
       // Ensure the sbt process uses the same JVM that is used in the current app to ensure correct serialization

testUtils/src/test/scala/org/jetbrains/sbtidea/testUtils/CurrentEnvironmentUtils.scala

@@ -1,7 +1,8 @@
 package org.jetbrains.sbtidea.testUtils
 
+import org.jetbrains.sbtidea.testUtils.SbtProjectFilesUtils.IoMode.PrintAndCollectOutput
+
 import java.io.File
-import scala.util.Using
 
 object CurrentEnvironmentUtils {
 
@@ -15,23 +16,11 @@ object CurrentEnvironmentUtils {
   def publishCurrentSbtIdeaPluginToLocalRepoAndGetVersions: String = {
     println("Publishing sbt-idea-plugin to local repository and getting it's version")
 
-    val process = new ProcessBuilder("sbt", "compile ; publishLocal ; show core / version")
-      .directory(CurrentWorkingDir)
-      .redirectErrorStream(true)
-      .start()
-
-    val outputLines = Using.resource(scala.io.Source.fromInputStream(process.getInputStream)) { source =>
-      source.getLines().map { line =>
-       println(line)
-       line
-     }.toArray.toSeq
-    }
-
-    process.waitFor()
-
-    val exitCode = process.exitValue()
-    if (exitCode != 0)
-      throw new RuntimeException(s"Failed to execute sbt command to detect current sbt-idea-plugin version (exit code: $exitCode)")
+    val outputLines = SbtProjectFilesUtils.runSbtProcess(
+      Seq("compile ; publishLocal ; show core / version"),
+      CurrentWorkingDir,
+      ioMode = PrintAndCollectOutput,
+    ).outputLines.get
 
     val infoLines = outputLines
       .map(_.trim)
@@ -44,12 +33,12 @@ object CurrentEnvironmentUtils {
         val DebugInfo = if (infoLines.nonEmpty)
           s"""Last $TaleLastLinesNumber info lines:
              |  ## ${infoLines.takeRight(TaleLastLinesNumber).mkString("\n  ## ")}"""
-        else if (outputLines.nonEmpty) {
+        else if (outputLines.nonEmpty)
           s"""Last $TaleLastLinesNumber output lines:
              |  ## ${outputLines.takeRight(TaleLastLinesNumber).mkString("\n  ## ")}"""
-        } else {
+        else
           "!!! No output lines !!!"
-        }
+
         throw new RuntimeException(
           s"""Failed to retrieve plugin version from the sbt process output.
              |$DebugInfo""".stripMargin)

testUtils/src/test/scala/org/jetbrains/sbtidea/testUtils/SbtProjectFilesUtils.scala

@@ -58,8 +58,7 @@ object SbtProjectFilesUtils {
   def runSbtProcess(
     sbtArguments: Seq[String],
     workingDir: File,
-    inheritIO: Boolean = true,
-    printAndCollectOutput: Boolean = false,
+    ioMode: IoMode = IoMode.Inherit,
     vmOptions: Seq[String] = Seq.empty,
     envVars: Map[String, String] = Map.empty,
   ): ProcessRunResult = {
@@ -69,28 +68,32 @@ object SbtProjectFilesUtils {
     runProcess(
       // Disable colors to avoid escape sequences in the output
       // This is needed to parse the output of the test reliably
-      "sbt" +: "-no-colors" +: sbtArguments,
+      Seq("sbt", "-no-colors") ++ sbtArguments,
       workingDir,
-      inheritIO = inheritIO,
-      printAndCollectOutput = printAndCollectOutput,
+      ioMode = ioMode,
       envVars = envVarsUpdated,
     )
   }
 
   case class ProcessRunResult(outputLines: Option[Seq[String]])
 
+  sealed trait IoMode
+  object IoMode {
+    object Inherit extends IoMode
+    object PrintAndCollectOutput extends IoMode
+  }
+
   def runProcess(
     command: Seq[String],
     workingDir: File,
-    inheritIO: Boolean = true,
-    printAndCollectOutput: Boolean = false,
+    ioMode: IoMode = IoMode.Inherit,
     envVars: Map[String, String] = Map.empty
   ): ProcessRunResult = {
     val pb = new ProcessBuilder(command *)
     pb.directory(workingDir)
     pb.redirectErrorStream(true)
 
-    if (inheritIO) {
+    if (ioMode == IoMode.Inherit) {
       pb.inheritIO()
     }
 
@@ -100,7 +103,7 @@ object SbtProjectFilesUtils {
 
     val process = pb.start()
 
-    val outputLines: Option[Seq[String]] = if (printAndCollectOutput) {
+    val outputLines: Option[Seq[String]] = if (ioMode == IoMode.PrintAndCollectOutput) {
       Some(Using.resource(Source.fromInputStream(process.getInputStream)) { source =>
         source.getLines.map { line =>
           println(line)