Test tool result can now be read from file (#298)

### What's done:
* save can now read actual results from a file

Author: sanyavertolet

examples/kotlin-diktat/warn/chapter1/TestResultsFileTest/EnumTestDetection.kt

@@ -0,0 +1,15 @@
+package org.cqfn.diktat.test.resources.test.paragraph1.naming.enum_
+
+// ;warn:3:1: [MISSING_KDOC_TOP_LEVEL] all public and internal top-level classes and functions should have Kdoc: EnumTestDetection (cannot be auto-corrected)
+// ;warn:30: [WRONG_DECLARATIONS_ORDER] declarations of constants and enum members should be sorted alphabetically: enum entries order is incorrect
+// ;warn:10:5: [ENUMS_SEPARATED] enum is incorrectly formatted: enums must end with semicolon
+enum class EnumTestDetection {
+    // ;warn:$line+1:5: [ENUM_VALUE] enum values should be{{ in }}selected UPPER_CASE snake/PascalCase format: paSC_SAl_l
+    paSC_SAl_l,
+
+    // ;warn:5: [ENUM_VALUE] enum values{{ should }}be in selected{{ UPPER_CASE }}snake/PascalCase format: PascAsl_f
+    PascAsl_f
+    // ;warn:$line-2:5: [ENUMS_SEPARATED] enum is incorrectly formatted: last enum entry must end with a comma
+
+    // ;warn:1:9: {{.*}}[PACKAGE_NAME_INCORRECT_PREFIX] package name should start from company's domain: org.cqfn.save{{.*}}
+}

examples/kotlin-diktat/warn/chapter1/TestResultsFileTest/result.out

@@ -0,0 +1,7 @@
+C:\Users\vwx1020336\IdeaProjects\save\examples\kotlin-diktat\warn\chapter1\TestsWithRegex\EnumTestDetection.kt:1:9: [PACKAGE_NAME_INCORRECT_PREFIX] package name should start from company's domain: org.cqfn.save
+C:\Users\vwx1020336\IdeaProjects\save\examples\kotlin-diktat\warn\chapter1\TestsWithRegex\EnumTestDetection.kt:3:1: [MISSING_KDOC_TOP_LEVEL] all public and internal top-level classes and functions should have Kdoc: EnumTestDetection (cannot be auto-corrected)
+C:\Users\vwx1020336\IdeaProjects\save\examples\kotlin-diktat\warn\chapter1\TestsWithRegex\EnumTestDetection.kt:6:30: [WRONG_DECLARATIONS_ORDER] declarations of constants and enum members should be sorted alphabetically: enum entries order is incorrect
+C:\Users\vwx1020336\IdeaProjects\save\examples\kotlin-diktat\warn\chapter1\TestsWithRegex\EnumTestDetection.kt:8:5: [ENUM_VALUE] enum values should be in selected UPPER_CASE snake/PascalCase format: paSC_SAl_l
+C:\Users\vwx1020336\IdeaProjects\save\examples\kotlin-diktat\warn\chapter1\TestsWithRegex\EnumTestDetection.kt:10:5: [ENUMS_SEPARATED] enum is incorrectly formatted: enums must end with semicolon
+C:\Users\vwx1020336\IdeaProjects\save\examples\kotlin-diktat\warn\chapter1\TestsWithRegex\EnumTestDetection.kt:10:5: [ENUMS_SEPARATED] enum is incorrectly formatted: last enum entry must end with a comma
+C:\Users\vwx1020336\IdeaProjects\save\examples\kotlin-diktat\warn\chapter1\TestsWithRegex\EnumTestDetection.kt:11:5: [ENUM_VALUE] enum values should be in selected UPPER_CASE snake/PascalCase format: PascAsl_f

examples/kotlin-diktat/warn/chapter1/TestResultsFileTest/save.toml

@@ -0,0 +1,7 @@
+[general]
+    tags = ["tag3"]
+    description = "Test suite that check only raised warnings related to general coding practices in files detected by a regular expression."
+
+[warn]
+    testNameRegex = "^E.*T.*D.*"
+    testToolResFileOutput = "result.out"

save-core/src/commonNonJsMain/kotlin/org/cqfn/save/core/utils/TomlUtils.kt

@@ -22,6 +22,7 @@ import com.akuleshov7.ktoml.parsers.node.TomlTable
 import okio.FileSystem
 import okio.Path
 
+import kotlin.system.exitProcess
 import kotlinx.serialization.ExperimentalSerializationApi
 import kotlinx.serialization.serializer
 
@@ -64,7 +65,7 @@ private inline fun <reified T : PluginConfig> Path.createPluginConfig(
                 " This file has incorrect toml format or missing section [$pluginSectionName]." +
                 " Valid sections are: ${TestConfigSections.values().map { it.name.lowercase() }}."
     )
-    throw e
+    exitProcess(2)
 }
 
 /**

save-core/src/commonNonJsTest/kotlin/org/cqfn/save/core/integration/ClassicWarnTest.kt

@@ -38,7 +38,7 @@ class ClassicWarnTest {
             runTestsWithDiktat(
                 listOf(
                     "warn/chapter1"
-                ), 5
+                ), 6
             )
 
     @Test
@@ -49,6 +49,14 @@ class ClassicWarnTest {
                 ), 1
             )
 
+    @Test
+    fun `test output file set`() =
+            runTestsWithDiktat(
+                listOf(
+                    "warn/chapter1/TestResultsFileTest"
+                ), 1
+            )
+
     @Test
     @Ignore
     // FixMe: this test should be investigated, as resource discovery looks to be buggy
@@ -65,15 +73,15 @@ class ClassicWarnTest {
             runTestsWithDiktat(
                 listOf(
                     "warn/save.toml"
-                ), 5
+                ), 6
             )
 
     @Test
     fun `executing warn plugin on parental save-toml file`() =
             runTestsWithDiktat(
                 listOf(
                     "warn/chapter1/save.toml"
-                ), 5
+                ), 6
             )
 
     @Test

save-plugins/warn-plugin/README.md

@@ -105,6 +105,8 @@ linePlaceholder = "$line"
 patternForRegexInWarning = ["{{", "}}"]
 # if true - the regex created from expected warning will be wrapped with '.*': .*warn.*.
 partialWarnTextMatch = false # (default value)
+ # if not set than stdout will be used as result of warn plugin execution
+testToolResFileOutput = "result.out" # (no default value is set)
 ```
 
 When executed from project root (where `save.propertes` is located), SAVE will cd to `rootDir` and discover all files

save-plugins/warn-plugin/src/commonMain/kotlin/org/cqfn/save/plugin/warn/WarnPlugin.kt

@@ -19,6 +19,7 @@ import org.cqfn.save.plugin.warn.utils.Warning
 import org.cqfn.save.plugin.warn.utils.extractWarning
 import org.cqfn.save.plugin.warn.utils.getLineNumber
 
+import okio.FileNotFoundException
 import okio.FileSystem
 import okio.Path
 
@@ -83,7 +84,8 @@ class WarnPlugin(
     @Suppress(
         "TOO_LONG_FUNCTION",
         "SAY_NO_TO_VAR",
-        "LongMethod"
+        "LongMethod",
+        "SwallowedException",
     )
     private fun handleTestFile(
         paths: List<Path>,
@@ -143,10 +145,23 @@ class WarnPlugin(
                 )
             }.asSequence()
         }
-        val stdout = executionResult.stdout
+        val stdout =
+                warnPluginConfig.testToolResFileOutput?.let {
+                    val testToolResFilePath = testConfig.directory / warnPluginConfig.testToolResFileOutput
+                    try {
+                        fs.readLines(testToolResFilePath)
+                    } catch (ex: FileNotFoundException) {
+                        logWarn("Trying to read file \"${warnPluginConfig.testToolResFileOutput}\" that was set as an output for a tested tool with testToolResFileOutput," +
+                                " but no such file found. Will use the stdout as an input.")
+                        executionResult.stdout
+                    }
+                }
+                    ?: run {
+                        executionResult.stdout
+                    }
         val stderr = executionResult.stderr
 
-        val actualWarningsMap = executionResult.stdout.mapNotNull {
+        val actualWarningsMap = stdout.mapNotNull {
             with(warnPluginConfig) {
                 val line = it.getLineNumber(actualWarningsPattern!!, lineCaptureGroupOut)
                 it.extractWarning(

save-plugins/warn-plugin/src/commonMain/kotlin/org/cqfn/save/plugin/warn/WarnPluginConfig.kt

@@ -48,6 +48,7 @@ import kotlinx.serialization.UseSerializers
  * For example: for `[warn] my {{[hello|world]}} warn` patternForRegexInWarning = {{.*}}. Opening and closing symbols should be split with '.*' symbol.
  * @property partialWarnTextMatch if true - the regex created from expected warning will be wrapped with '.*': .*warn.*.
  * That can help a user to write only main information in the warning without any need to add/copy-paste technical info
+ * @property testToolResFileOutput file with actual warnings
  */
 @Serializable
 data class WarnPluginConfig(
@@ -69,7 +70,8 @@ data class WarnPluginConfig(
     val linePlaceholder: String? = null,
     val wildCardInDirectoryMode: String? = null,
     val patternForRegexInWarning: List<String>? = null,
-    val partialWarnTextMatch: Boolean? = null
+    val partialWarnTextMatch: Boolean? = null,
+    val testToolResFileOutput: String? = null,
 ) : PluginConfig {
     @Transient
     override val type = TestConfigSections.WARN
@@ -109,7 +111,8 @@ data class WarnPluginConfig(
             this.linePlaceholder ?: other.linePlaceholder,
             this.wildCardInDirectoryMode ?: other.wildCardInDirectoryMode,
             this.patternForRegexInWarning ?: other.patternForRegexInWarning,
-            this.partialWarnTextMatch ?: other.partialWarnTextMatch
+            this.partialWarnTextMatch ?: other.partialWarnTextMatch,
+            this.testToolResFileOutput ?: other.testToolResFileOutput,
         ).also { it.configLocation = this.configLocation }
     }
 
@@ -164,7 +167,8 @@ data class WarnPluginConfig(
             linePlaceholder ?: "\$line",
             wildCardInDirectoryMode,
             patternForRegexInWarning ?: defaultPatternForRegexInWarning,
-            partialWarnTextMatch ?: false
+            partialWarnTextMatch ?: false,
+            testToolResFileOutput,
         ).also { it.configLocation = this.configLocation }
     }