execCmd and batchSize on cli args (#433)

* added cli args
* added EvaluatedToolConfig

Author: nulls

OptionsTable.md

@@ -12,4 +12,8 @@ Most (except for `-h` and `-prop`) of the options below can be passed to a SAVE
 | i | include-suites | Test suites, only which ones will be checked | - |
 | l | language | Language that you are developing analyzer for | UNDEFINED |
 | out | result-output | Data output stream | STDOUT |
-| - | report-dir | Path to directory, where to store output (when `resultOutput` is set to `FILE`) | save-reports |
+| - | report-dir | Path to directory, where to store output (when `resultOutput` is set to `FILE`) | save-reports |
+| - | override-exec-cmd | A temporary workaround for save-cloud to override `execCmd` in `save.toml` | - |
+| - | override-exec-flags | A temporary workaround for save-cloud to override `execFlags` in `save.toml` | - |
+| - | batch-size | Number of files execCmd will process at a time | 1 |
+| - | batch-separator | A separator to join test files to string if the tested tool supports processing of file batches (`batch-size` > 1) | ,  |

buildSrc/src/main/resources/config-options.json

@@ -78,5 +78,37 @@
       "shortName" : "",
       "description" : "Path to directory, where to store output (when `resultOutput` is set to `FILE`)",
       "default" : "save-reports"
+    },
+    "overrideExecCmd" : {
+      "argType": "ArgType.String",
+      "kotlinType": "kotlin.String",
+      "fullName": "override-exec-cmd",
+      "shortName" : "",
+      "description" : "A temporary workaround for save-cloud to override `execCmd` in `save.toml`",
+      "default" : null
+    },
+    "overrideExecFlags" : {
+      "argType": "ArgType.String",
+      "kotlinType": "kotlin.String",
+      "fullName": "override-exec-flags",
+      "shortName" : "",
+      "description" : "A temporary workaround for save-cloud to override `execFlags` in `save.toml`",
+      "default" : null
+    },
+    "batchSize" : {
+      "argType" : "ArgType.Int",
+      "kotlinType": "kotlin.Int",
+      "fullName" : "batch-size",
+      "shortName" : "",
+      "description" : "Number of files execCmd will process at a time",
+      "default" : "1"
+    },
+    "batchSeparator" : {
+      "argType": "ArgType.String",
+      "kotlinType": "kotlin.String",
+      "fullName": "batch-separator",
+      "shortName" : "",
+      "description" : "A separator to join test files to string if the tested tool supports processing of file batches (`batch-size` > 1)",
+      "default" : ", "
     }
 }

save-cli/src/commonNonJsMain/kotlin/com/saveourtool/save/cli/config/SavePropertiesExt.kt

@@ -7,6 +7,7 @@ package com.saveourtool.save.cli.config
 import com.saveourtool.save.cli.ExitCodes
 import com.saveourtool.save.cli.fs
 import com.saveourtool.save.cli.logging.logErrorAndExit
+import com.saveourtool.save.cli.logging.logWarn
 import com.saveourtool.save.core.config.SaveProperties
 import com.saveourtool.save.core.config.resolveSaveTomlConfig
 import com.saveourtool.save.core.logging.logDebug
@@ -51,6 +52,23 @@ private fun SaveProperties.validate(): SaveProperties {
                     " Please provide a valid path to the test config via command-line or using the file with properties."
         )
     }
+    if (batchSize < 1) {
+        return logErrorAndExit(
+            ExitCodes.INVALID_CONFIGURATION, "Property `batch-size` should be more or equal to 1."
+        )
+    }
+    overrideExecCmd?.also {
+        logWarn {
+            "Property `override-exec-cmd` is a temporary workaround for `save-cloud`, " +
+                    "please be aware this property can be removed in future versions"
+        }
+    }
+    overrideExecFlags?.also {
+        logWarn {
+            "Property `override-exec-flags` is a temporary workaround for `save-cloud`, " +
+                    "please be aware this property can be removed in future versions"
+        }
+    }
 
     return this
 }

save-cli/src/commonNonJsMain/kotlin/com/saveourtool/save/cli/logging/Logger.kt

@@ -15,3 +15,10 @@ import com.saveourtool.save.cli.ExitCodes
  */
 @Deprecated("never use this method in save-core as it can lead to a break of save-cloud application")
 expect fun logErrorAndExit(exitCode: ExitCodes, message: String): Nothing
+
+/**
+ * Log result of [messageSupplier] with level WARN
+ *
+ * @param messageSupplier supplier for message to log
+ */
+expect fun logWarn(messageSupplier: () -> String): Unit

save-cli/src/jvmMain/kotlin/com/saveourtool/save/cli/logging/Logger.kt

@@ -6,9 +6,14 @@ package com.saveourtool.save.cli.logging
 
 import com.saveourtool.save.cli.ExitCodes
 import com.saveourtool.save.core.logging.logError
+import com.saveourtool.save.core.logging.logWarn
 import kotlin.system.exitProcess
 
 actual fun logErrorAndExit(exitCode: ExitCodes, message: String): Nothing {
     logError(message)
     exitProcess(exitCode.code)
 }
+
+actual fun logWarn(messageSupplier: () -> String) {
+    logWarn(messageSupplier())
+}

save-cli/src/nativeMain/kotlin/com/saveourtool/save/cli/logging/Logger.kt

@@ -6,9 +6,14 @@ package com.saveourtool.save.cli.logging
 
 import com.saveourtool.save.cli.ExitCodes
 import com.saveourtool.save.core.logging.logError
+import com.saveourtool.save.core.logging.logWarn
 import kotlin.system.exitProcess
 
 actual fun logErrorAndExit(exitCode: ExitCodes, message: String): Nothing {
     logError(message)
     exitProcess(exitCode.code)
 }
+
+actual fun logWarn(messageSupplier: () -> String) {
+    logWarn(messageSupplier())
+}

save-common-test/src/commonNonJsMain/kotlin/com/saveourtool/save/plugin/MockPlugin.kt

@@ -1,5 +1,6 @@
 package com.saveourtool.save.plugin
 
+import com.saveourtool.save.core.config.EvaluatedToolConfig
 import com.saveourtool.save.core.config.TestConfig
 import com.saveourtool.save.core.files.createFile
 import com.saveourtool.save.core.plugin.Plugin
@@ -20,7 +21,7 @@ class MockPlugin(baseDir: Path, testFiles: List<String> = emptyList()) : Plugin(
     useInternalRedirections = true,
     redirectTo = null
 ) {
-    override fun handleFiles(files: Sequence<TestFiles>): Sequence<TestResult> = emptySequence()
+    override fun handleFiles(evaluatedToolConfig: EvaluatedToolConfig, files: Sequence<TestFiles>): Sequence<TestResult> = emptySequence()
 
     override fun rawDiscoverTestFiles(resourceDirectories: Sequence<Path>): Sequence<TestFiles> = emptySequence()
 

save-common/src/commonMain/kotlin/com/saveourtool/save/core/config/EvaluatedToolConfig.kt

@@ -0,0 +1,16 @@
+package com.saveourtool.save.core.config
+
+/**
+ * Configuration for an evaluated tool, that is read from test suite configuration file (toml config) or cli
+ *
+ * @property execCmd
+ * @property execFlags
+ * @property batchSize it controls how many files execCmd will process at a time
+ * @property batchSeparator A separator to join test files to string if the tested tool supports processing of file batches (`batch-size` > 1)
+ */
+data class EvaluatedToolConfig(
+    val execCmd: String?,
+    val execFlags: String?,
+    val batchSize: Int,
+    val batchSeparator: String,
+)

save-common/src/commonMain/kotlin/com/saveourtool/save/core/plugin/Plugin.kt

@@ -1,5 +1,6 @@
 package com.saveourtool.save.core.plugin
 
+import com.saveourtool.save.core.config.EvaluatedToolConfig
 import com.saveourtool.save.core.config.TestConfig
 import com.saveourtool.save.core.config.isSaveTomlConfig
 import com.saveourtool.save.core.files.createRelativePathToTheRoot
@@ -20,6 +21,7 @@ import kotlinx.serialization.Serializable
 
 /**
  * Plugin that can be injected into SAVE during execution. Plugins accept contents of configuration file and then perform some work.
+ *
  * @property testConfig
  * @property testFiles a list of files (test resources or save.toml configs)
  * @property fs describes the current file system
@@ -42,9 +44,10 @@ abstract class Plugin(
     /**
      * Perform plugin's work.
      *
+     * @param evaluatedToolConfig a configuration for evaluated tool
      * @return a sequence of [TestResult]s for each group of test resources
      */
-    fun execute(): Sequence<TestResult> {
+    fun execute(evaluatedToolConfig: EvaluatedToolConfig): Sequence<TestResult> {
         clean()
         val testFilesList = discoverTestFiles(testConfig.directory).toList()
 
@@ -68,7 +71,7 @@ abstract class Plugin(
             val excludedTestResults = excludedTestFiles.map {
                 TestResult(it, Ignored("Excluded by configuration"))
             }
-            handleFiles(actualTestFiles.asSequence()) + excludedTestResults
+            handleFiles(evaluatedToolConfig, actualTestFiles.asSequence()) + excludedTestResults
         } else {
             emptySequence()
         }
@@ -77,10 +80,11 @@ abstract class Plugin(
     /**
      * Perform plugin's work on a set of files.
      *
+     * @param evaluatedToolConfig a configuration for evaluated tool
      * @param files a sequence of file groups, corresponding to tests.
      * @return a sequence of [TestResult]s for each group of test resources
      */
-    abstract fun handleFiles(files: Sequence<TestFiles>): Sequence<TestResult>
+    abstract fun handleFiles(evaluatedToolConfig: EvaluatedToolConfig, files: Sequence<TestFiles>): Sequence<TestResult>
 
     /**
      * Discover groups of resource files which will be used to run tests, applying additional filtering

save-common/src/commonMain/kotlin/com/saveourtool/save/core/plugin/PluginConfig.kt

@@ -41,7 +41,7 @@ interface PluginConfig {
     val resourceNamePatternStr: String
 
     /**
-     * @param otherConfig - 'this' will be merged with 'other'
+     * @param otherConfig 'this' will be merged with 'other'
      * @return merged config
      */
     fun mergeWith(otherConfig: PluginConfig): PluginConfig
@@ -60,13 +60,13 @@ interface PluginConfig {
  * of nested configs, we can't detect whether the value are passed by user, or taken from default.
  * The logic of the default value processing will be provided in stage of validation
  *
- * @property execCmd a command that will be executed to check resources and emit warnings
+ * @property execCmd a command that will be executed to check resources
  * @property tags special labels that can be used for splitting tests into groups
  * @property description free text with a description
  * @property suiteName name of test suite that can be visible from save-cloud
  * @property language to tests
  * @property excludedTests excluded tests from the run
- * @property expectedWarningsPattern - pattern with warnings that are expected from the test file
+ * @property expectedWarningsPattern pattern with warnings that are expected from the test file
  * @property runConfigPattern everything from the capture group will be split by comma and then by `=`
  * @property timeOutMillis command execution time for one test
  * @property expectedWarningsMiddlePattern