Reuse ProcessBuilder from save-cli (#2)

* Reuse ProcessBuilder from save-cli

### What's done:
 * Moved ProcessBuilder from saveourtool/save-cli to saveourtool/process-builder-multiplatform
 * Downgraded kotest version (5.5.5 -> 5.5.4) as 5.5.5 is not available for macosArm64

build.gradle.kts

@@ -1,4 +1,5 @@
 
+import com.saveourtool.processbuilder.configureDetekt
 import com.saveourtool.processbuilder.configureDiktat
 import com.saveourtool.processbuilder.createDetektTask
 
@@ -12,3 +13,4 @@ plugins {
 
 configureDiktat()
 createDetektTask()
+configureDetekt()

buildSrc/src/main/kotlin/com/saveourtool/processbuilder/DetektConfiguration.kt

@@ -22,32 +22,27 @@ fun Project.configureDetekt() {
         basePath = rootDir.canonicalPath
         buildUponDefaultConfig = true
     }
+
+    val reportMerge: TaskProvider<ReportMergeTask> = rootProject.tasks.named<ReportMergeTask>("mergeDetektReports") {
+        input.from(tasks.withType<Detekt>().map { it.sarifReportFile })
+        shouldRunAfter(tasks.withType<Detekt>())
+    }
+    tasks.withType<Detekt>().configureEach {
+        reports.sarif.required.set(true)
+        finalizedBy(reportMerge)
+    }
 }
 
 /**
  * Register a unified detekt task
  */
 fun Project.createDetektTask() {
-    val detektAllTask = tasks.register("detektAll") {
+    tasks.register("detektAll") {
         allprojects {
             this@register.dependsOn(tasks.withType<Detekt>())
         }
     }
-
     tasks.register("mergeDetektReports", ReportMergeTask::class) {
-        mustRunAfter(detektAllTask)
         output.set(buildDir.resolve("detekt-sarif-reports/detekt-merged.sarif"))
     }
-
-    @Suppress("GENERIC_VARIABLE_WRONG_DECLARATION")
-    val reportMerge: TaskProvider<ReportMergeTask> = rootProject.tasks.named<ReportMergeTask>("mergeDetektReports") {
-        input.from(
-            tasks.withType<Detekt>().map { it.sarifReportFile }
-        )
-        shouldRunAfter(tasks.withType<Detekt>())
-    }
-    tasks.withType<Detekt>().configureEach {
-        reports.sarif.required.set(true)
-        finalizedBy(reportMerge)
-    }
 }

core/build.gradle.kts

@@ -0,0 +1,90 @@
+import com.saveourtool.processbuilder.configureDetekt
+import com.saveourtool.processbuilder.configureDiktat
+
+plugins {
+    kotlin("multiplatform")
+}
+
+kotlin {
+    jvm {
+        jvmToolchain(11)
+        withJava()
+        testRuns["test"].executionTask.configure {
+            useJUnitPlatform()
+        }
+    }
+
+    macosArm64()
+    macosX64()
+    linuxX64()
+    mingwX64()
+
+    sourceSets {
+        all {
+            languageSettings.optIn("kotlin.RequiresOptIn")
+        }
+
+        val commonMain by getting {
+            dependencies {
+                api(libs.okio)
+
+                implementation(libs.kotlin.logging)
+                implementation(libs.kotlinx.datetime)
+                implementation(libs.kotlinx.coroutines.core)
+            }
+        }
+
+        val commonTest by getting {
+            dependencies {
+                implementation(libs.okio.fakefilesystem)
+                implementation(libs.kotest.assertions.core)
+                implementation(kotlin("test-common"))
+                implementation(kotlin("test-annotations-common"))
+            }
+        }
+
+        val jvmMain by getting {
+            dependsOn(commonMain)
+            dependencies {
+                implementation(libs.slf4j)
+            }
+        }
+
+        val jvmTest by getting {
+            dependsOn(commonTest)
+            dependencies {
+                implementation(kotlin("test-junit5"))
+                implementation(libs.junit.jupiter.engine)
+            }
+        }
+
+        val macosArm64Main by getting
+        val macosX64Main by getting
+        val linuxX64Main by getting
+        val mingwX64Main by getting
+
+        val nativeMain by creating {
+            dependsOn(commonMain)
+            macosArm64Main.dependsOn(this)
+            macosX64Main.dependsOn(this)
+            linuxX64Main.dependsOn(this)
+            mingwX64Main.dependsOn(this)
+        }
+
+        val macosArm64Test by getting
+        val macosX64Test by getting
+        val linuxX64Test by getting
+        val mingwX64Test by getting
+
+        val nativeTest by creating {
+            dependsOn(commonTest)
+            macosArm64Test.dependsOn(this)
+            macosX64Test.dependsOn(this)
+            linuxX64Test.dependsOn(this)
+            mingwX64Test.dependsOn(this)
+        }
+    }
+}
+
+configureDetekt()
+configureDiktat()

core/src/commonMain/kotlin/com/saveourtool/processbuilder/ProcessBuilder.kt

@@ -0,0 +1,211 @@
+/**
+ * Utilities to run a process and get its result.
+ */
+
+package com.saveourtool.processbuilder
+
+import com.saveourtool.processbuilder.exceptions.ProcessExecutionException
+import com.saveourtool.processbuilder.exceptions.ProcessTimeoutException
+import com.saveourtool.processbuilder.utils.createFile
+import com.saveourtool.processbuilder.utils.isCurrentOsWindows
+import com.saveourtool.processbuilder.utils.myDeleteRecursively
+import com.saveourtool.processbuilder.utils.readLines
+import io.github.oshai.KotlinLogging
+import okio.FileSystem
+import okio.Path
+import okio.Path.Companion.toPath
+
+import kotlinx.datetime.Clock
+
+internal val logger = KotlinLogging.logger { }
+
+/**
+ * Class contains common logic for all platforms
+ *
+ * @property useInternalRedirections whether to collect output for future usage, if false, redirectTo will be ignored
+ * @property fs describes the current file system
+ */
+class ProcessBuilder(private val useInternalRedirections: Boolean, private val fs: FileSystem) {
+    /**
+     * Execute [command] and wait for its completion.
+     *
+     * @param command executable command with arguments
+     * @param directory where to execute provided command, i.e. `cd [directory]` will be performed before [command] execution
+     * @param redirectTo a file where process output and errors should be redirected. If null, output will be returned as [ExecutionResult.stdout] and [ExecutionResult.stderr].
+     * @param timeOutMillis max command execution time
+     * @return [ExecutionResult] built from process output
+     * @throws ProcessExecutionException in case of impossibility of command execution
+     * @throws ProcessTimeoutException if timeout is exceeded
+     */
+    @Suppress(
+        "TOO_LONG_FUNCTION",
+        "TooGenericExceptionCaught",
+        "ReturnCount",
+        "SwallowedException",
+    )
+    fun exec(
+        command: String,
+        directory: String,
+        redirectTo: Path?,
+        timeOutMillis: Long,
+    ): ExecutionResult {
+        if (command.isBlank()) {
+            logErrorAndThrowProcessBuilderException("Execution command in ProcessBuilder couldn't be empty!")
+        }
+        if (command.contains(">") && useInternalRedirections) {
+            logger.error {
+                "Found user provided redirections in `$command`. " +
+                        "SAVE will create own redirections for internal purpose, please refuse redirects or use corresponding argument [redirectTo]"
+            }
+        }
+
+        // Temporary directory for stderr and stdout (posix `system()` can't separate streams, so we do it ourselves)
+        val tmpDir = (FileSystem.SYSTEM_TEMPORARY_DIRECTORY /
+                ("ProcessBuilder_" + Clock.System.now().toEpochMilliseconds()).toPath())
+        logger.trace { "Creating temp directory: $tmpDir" }
+        // Path to stdout file
+        val stdoutFile = tmpDir / "stdout.txt"
+        logger.trace { "Creating stdout file of ProcessBuilder: $stdoutFile" }
+        // Path to stderr file
+        val stderrFile = tmpDir / "stderr.txt"
+        logger.trace { "Creating stderr file of ProcessBuilder: $stderrFile" }
+        // Instance, containing platform-dependent realization of command execution
+        val processBuilderInternal = ProcessBuilderInternal(stdoutFile, stderrFile, useInternalRedirections)
+        fs.createDirectories(tmpDir)
+        fs.createFile(stdoutFile)
+        fs.createFile(stderrFile)
+        logger.trace { "Created temp directory $tmpDir for stderr and stdout of ProcessBuilder" }
+
+        val cmd = modifyCmd(command, directory, processBuilderInternal)
+
+        logger.debug { "Executing: $cmd with timeout $timeOutMillis ms" }
+        val status = try {
+            processBuilderInternal.exec(cmd, timeOutMillis)
+        } catch (ex: ProcessTimeoutException) {
+            fs.deleteRecursively(tmpDir)
+            throw ex
+        } catch (ex: Exception) {
+            fs.deleteRecursively(tmpDir)
+            logErrorAndThrowProcessBuilderException(ex.message ?: "Couldn't execute $cmd")
+        }
+
+        val stdout = fs.readLines(stdoutFile)
+        val stderr = fs.readLines(stderrFile)
+
+        fs.myDeleteRecursively(tmpDir)
+        logger.trace { "Removed temp directory $tmpDir" }
+        if (stderr.isNotEmpty()) {
+            logger.debug { "stderr of `$command`:\t${stderr.joinToString("\t")}" }
+        }
+        redirectTo?.let {
+            fs.write(redirectTo) {
+                write(stdout.joinToString("\n").encodeToByteArray())
+                write(stderr.joinToString("\n").encodeToByteArray())
+            }
+        } ?: logger.trace { "Execution output:\t$stdout" }
+        return ExecutionResult(status, stdout, stderr)
+    }
+
+    private fun modifyCmd(
+        command: String,
+        directory: String,
+        processBuilderInternal: ProcessBuilderInternal,
+    ): String {
+        // If we need to step out into some directory before execution
+        val cdCmd = if (directory.isNotBlank()) {
+            if (isCurrentOsWindows()) {
+                "cd /d $directory && "
+            } else {
+                "cd $directory && "
+            }
+        } else {
+            ""
+        }
+        // Additionally process command for Windows, it it contain `echo`
+        val commandWithEcho = cdCmd + if (isCurrentOsWindows()) {
+            processCommandWithEcho(command)
+        } else {
+            command
+        }
+        logger.trace { "Modified cmd: $commandWithEcho" }
+        // Finally, make platform dependent adaptations
+        return processBuilderInternal.prepareCmd(commandWithEcho)
+    }
+
+    /**
+     * Log error message and throw exception
+     *
+     * @param errMsg error message
+     * @throws ProcessExecutionException
+     */
+    private fun logErrorAndThrowProcessBuilderException(errMsg: String): Nothing {
+        logger.error { errMsg }
+        throw ProcessExecutionException(errMsg)
+    }
+
+    companion object {
+        /**
+         * Check whether there are exists `echo` commands, and process them, since in Windows
+         * `echo` adds extra whitespaces and newlines. This method will remove them
+         *
+         * @param command command to process
+         * @return unmodified command, if there is no `echo` subcommands, otherwise add parameter `set /p=` to `echo`
+         */
+        @Suppress("ReturnCount")
+        fun processCommandWithEcho(command: String): String {
+            if (!command.contains("echo")) {
+                return command
+            }
+            // Command already contains correct signature.
+            // We also believe not to met complex cases: `echo a; echo | set /p="a && echo b"`
+            val cmdWithoutWhitespaces = command.replace(" ", "")
+            if (cmdWithoutWhitespaces.contains("echo|set")) {
+                return command
+            }
+            if (cmdWithoutWhitespaces.contains("echo\"")) {
+                logger.warn { "You can use echo | set /p\"your command\" to avoid extra whitespaces on Windows" }
+                return command
+            }
+            // If command is complex (have `&&` or `;`), we need to modify only `echo` subcommands
+            val separator = if (command.contains("&&")) {
+                "&&"
+            } else if (command.contains(";")) {
+                ";"
+            } else {
+                ""
+            }
+            val listOfCommands = if (separator != "") command.split(separator) as MutableList<String> else mutableListOf(command)
+            listOfCommands.forEachIndexed { index, cmd ->
+                if (cmd.contains("echo")) {
+                    var newEchoCommand = cmd.trim(' ').replace("echo ", " echo | set /p dummyName=\"")
+                    // Now we need to add closing `"` in proper place
+                    // Despite the fact, that we don't expect user redirections, for out internal tests we use them,
+                    // so we need to process such cases
+                    // There are three different cases, where we need to insert closing `"`.
+                    // 1) Before stdout redirection
+                    // 2) Before stderr redirection
+                    // 3) At the end of string, if there is no redirections
+                    val indexOfStdoutRedirection = if (newEchoCommand.indexOf(">") != -1) newEchoCommand.indexOf(">") else newEchoCommand.length
+                    val indexOfStderrRedirection = if (newEchoCommand.indexOf("2>") != -1) newEchoCommand.indexOf("2>") else newEchoCommand.length
+                    val insertIndex = minOf(indexOfStdoutRedirection, indexOfStderrRedirection)
+                    newEchoCommand = newEchoCommand.substring(0, insertIndex).trimEnd(' ') + "\" " + newEchoCommand.substring(insertIndex, newEchoCommand.length) + " "
+                    listOfCommands[index] = newEchoCommand
+                }
+            }
+            val modifiedCommand = listOfCommands.joinToString(separator).trim(' ')
+            logger.trace { "Additionally modify command:`$command` to `$modifiedCommand` because of `echo` on Windows add extra newlines" }
+            return modifiedCommand
+        }
+    }
+}
+
+/**
+ * @property code exit code
+ * @property stdout content of stdout
+ * @property stderr content of stderr
+ */
+data class ExecutionResult(
+    val code: Int,
+    val stdout: List<String>,
+    val stderr: List<String>,
+)

core/src/commonMain/kotlin/com/saveourtool/processbuilder/ProcessBuilderInternal.kt

@@ -0,0 +1,37 @@
+/**
+ * Utilities to run a process and get its result.
+ */
+
+package com.saveourtool.processbuilder
+
+import okio.Path
+
+/**
+ * A class that is capable of executing processes, specific to different OS and returning their output.
+ */
+expect class ProcessBuilderInternal(
+    stdoutFile: Path,
+    stderrFile: Path,
+    useInternalRedirections: Boolean,
+) {
+    /**
+     * Modify execution command according behavior of different OS,
+     * also stdout and stderr will be redirected to tmp files
+     *
+     * @param command raw command
+     * @return command with redirection of stderr to tmp file
+     */
+    fun prepareCmd(command: String): String
+
+    /**
+     * Execute [cmd] and wait for its completion.
+     *
+     * @param cmd executable command with arguments
+     * @param timeOutMillis max command execution time
+     * @return exit status
+     */
+    fun exec(
+        cmd: String,
+        timeOutMillis: Long,
+    ): Int
+}