Minor changes in examples and PlainTextReporter (#151)

### What's done:
* Run save with default value for properties file in run.sh
* Introduced short reason for Fail
* Moved logic on test resources emptiness check into base Plugin class
* Collapse comment to one line in PlainTextReporter
* Improvements for kotlin-diktat example case
* Logging cleanup

Author: petertrr

examples/kotlin-diktat/fix/smoke/Example1Expected.kt

@@ -0,0 +1,6 @@
+package org.cqfn.diktat
+
+class Example {
+    @get:JvmName("getIsValid")
+    val isValid = true
+}

examples/kotlin-diktat/fix/smoke/Example1Test.kt

@@ -0,0 +1,6 @@
+package test.smoke
+
+class example {
+    @get : JvmName("getIsValid")
+    val isValid = true
+}

examples/kotlin-diktat/fix/smoke/src/main/kotlin/org/cqfn/diktat/Example1Expected.kt

@@ -22,5 +22,5 @@ if [ "$1" == "--help" ]; then
 For example, `./run.sh warn/chapter1/save.toml` to execute tests located in warn/chapter1
 `./run.sh EnumValueSnakeCaseTest.kt to execute a single test`'
 else
-    ./save --debug -prop save.properties $1
+    ./save $@
 fi

examples/kotlin-diktat/fix/smoke/src/main/kotlin/org/cqfn/diktat/Example1Test.kt

@@ -0,0 +1,25 @@
+// ;warn:1:9 [PACKAGE_NAME_INCORRECT_PREFIX] package name should start from company's domain: org.cqfn.save
+// ;warn:1:1 [FILE_NAME_MATCH_CLASS] file name is incorrect - it should match with the class described in it if there is the only one class declared: GenericFunctionTest.kt vs ClassName
+package org.cqfn.diktat.test.paragraph1.naming.generic
+
+private class ClassName<T> {
+    private fun <Template, T> lock(body: ((Template?) -> T?)?, value: Template?): T? {
+        try {
+            // ;warn:6:13 [LOCAL_VARIABLE_EARLY_DECLARATION] local variables should be declared close to the line where they are first used: <variableName> is declared on line <6> and is used for the first time on line <9> (cannot be auto-corrected)
+            // ;warn:6:43 [NULLABLE_PROPERTY_TYPE] try to avoid use of nullable types: initialize explicitly (cannot be auto-corrected)
+            val variableName: Template? = null
+            // ;warn:7:17 [VARIABLE_NAME_INCORRECT_FORMAT] variable name should be in lowerCamelCase and should contain only latin (ASCII) letters or numbers and should start from lower letter: variableT
+            // ;warn:7:33 [NULLABLE_PROPERTY_TYPE] try to avoid use of nullable types: initialize explicitly (cannot be auto-corrected)
+            val variableT: T? = null
+            println(variableT)
+            return body!!(variableName)
+        } finally {
+            println()
+        }
+    }
+
+    // ;warn:15:5 [MISSING_KDOC_ON_FUNCTION] all public, internal and protected functions should have Kdoc with proper tags: foo
+    fun foo(var1: T, var2: ((T?) -> T?)?) {
+        lock<T, T>(var2, var1)
+    }
+}

examples/kotlin-diktat/run.sh

@@ -14,6 +14,6 @@ fileNameCaptureGroupOut = 1
 lineCaptureGroupOut = 2
 columnCaptureGroupOut = 3
 messageCaptureGroupOut = 4
-exactWarningsMatch = true
+exactWarningsMatch = false
 warningTextHasColumn = true
 warningTextHasLine = true

examples/kotlin-diktat/warn/chapter1/GenericFunctionTest.kt

@@ -8,7 +8,6 @@ import org.cqfn.save.cli.logging.logErrorAndExit
 import org.cqfn.save.core.config.SaveProperties
 import org.cqfn.save.core.config.defaultConfig
 import org.cqfn.save.core.logging.logDebug
-import org.cqfn.save.core.logging.logInfo
 
 import okio.FileNotFoundException
 import okio.FileSystem
@@ -58,7 +57,7 @@ fun createConfigFromArgs(args: Array<String>): SaveProperties {
     val configFromPropertiesFile = readPropertiesFile(configFromCli.propertiesFile ?: defaultConfig().propertiesFile)
     // merging two configurations into single [SaveProperties] class with a priority to command line arguments
     val mergedProperties = configFromCli.mergeConfigWithPriorityToThis(configFromPropertiesFile)
-    logInfo("Using the following properties for SAVE execution:\n${mergedProperties.getFields()}")
+    logDebug("Using the following properties for SAVE execution:\n${mergedProperties.getFields()}")
     return mergedProperties.validate()
 }
 

examples/kotlin-diktat/warn/save.toml

@@ -3,6 +3,7 @@ package org.cqfn.save.core.plugin
 import org.cqfn.save.core.config.TestConfig
 import org.cqfn.save.core.config.isSaveTomlConfig
 import org.cqfn.save.core.files.findDescendantDirectoriesBy
+import org.cqfn.save.core.logging.logDebug
 import org.cqfn.save.core.result.TestResult
 import org.cqfn.save.core.utils.ProcessBuilder
 
@@ -32,10 +33,14 @@ abstract class Plugin(
      */
     fun execute(): Sequence<TestResult> {
         clean()
-        return handleFiles(
-            // todo: pass individual groups of files to handleFiles? Or it will play bad with batch mode?
-            discoverTestFiles(testConfig.directory)
-        )
+        // todo: pass individual groups of files to handleFiles? Or it will play bad with batch mode?
+        val testFilesSequence = discoverTestFiles(testConfig.directory)
+        return if (testFilesSequence.any()) {
+            logDebug("Discovered the following test resources: ${testFilesSequence.toList()}")
+            handleFiles(testFilesSequence)
+        } else {
+            emptySequence()
+        }
     }
 
     /**

save-cli/src/nativeMain/kotlin/org/cqfn/save/cli/SaveConfigReader.kt

@@ -24,9 +24,7 @@ interface Reporter {
     /**
      * This function is called before any tests are executed
      */
-    fun beforeAll() {
-        out.write("Initializing reporter ${this::class.qualifiedName} of type $type\n".encodeToByteArray())
-    }
+    fun beforeAll()
 
     /**
      * This function is called after all tests are executed

save-common/src/commonMain/kotlin/org/cqfn/save/core/plugin/Plugin.kt

@@ -16,8 +16,9 @@ data class Pass(val message: String?) : TestStatus()
 
 /**
  * @property reason reason of failure
+ * @property shortReason
  */
-data class Fail(val reason: String) : TestStatus()
+data class Fail(val reason: String, val shortReason: String) : TestStatus()
 
 /**
  * @property reason reason of test ignoring

save-common/src/commonMain/kotlin/org/cqfn/save/core/reporter/Reporter.kt

@@ -78,12 +78,12 @@ class Save(
 
     private fun executePlugin(plugin: Plugin, reporter: Reporter) {
         reporter.onPluginInitialization(plugin)
-        logInfo("=> Executing plugin: ${plugin::class.simpleName} for [${plugin.testConfig.location}]")
+        logDebug("=> Executing plugin: ${plugin::class.simpleName} for [${plugin.testConfig.location}]")
         reporter.onPluginExecutionStart(plugin)
         try {
             val events = plugin.execute().toList()
             if (events.isEmpty()) {
-                logInfo("No resources discovered for ${plugin::class.simpleName} in [${plugin.testConfig.location}], skipping")
+                logDebug("No resources discovered for ${plugin::class.simpleName} in [${plugin.testConfig.location}], skipping")
                 reporter.onPluginExecutionSkip(plugin)
             }
             events
@@ -93,7 +93,7 @@ class Save(
             reporter.onPluginExecutionError(ex)
             logError("${plugin::class.simpleName} has crashed: ${ex.message}")
         }
-        logInfo("<= Finished execution of: ${plugin::class.simpleName} for [${plugin.testConfig.location}]")
+        logDebug("<= Finished execution of: ${plugin::class.simpleName} for [${plugin.testConfig.location}]")
         reporter.onPluginExecutionEnd(plugin)
     }
 

save-common/src/commonMain/kotlin/org/cqfn/save/core/result/TestStatus.kt

@@ -4,7 +4,6 @@ import org.cqfn.save.core.config.TestConfig
 import org.cqfn.save.core.files.createFile
 import org.cqfn.save.core.files.readFile
 import org.cqfn.save.core.files.readLines
-import org.cqfn.save.core.logging.logInfo
 import org.cqfn.save.core.plugin.GeneralConfig
 import org.cqfn.save.core.plugin.Plugin
 import org.cqfn.save.core.result.DebugInfo
@@ -15,6 +14,8 @@ import org.cqfn.save.core.utils.ProcessExecutionException
 
 import io.github.petertrr.diffutils.diff
 import io.github.petertrr.diffutils.patch.ChangeDelta
+import io.github.petertrr.diffutils.patch.Delta
+import io.github.petertrr.diffutils.patch.DeltaType
 import io.github.petertrr.diffutils.patch.Patch
 import io.github.petertrr.diffutils.text.DiffRowGenerator
 import okio.FileSystem
@@ -43,12 +44,6 @@ class FixPlugin(
 
     @Suppress("TOO_LONG_FUNCTION")
     override fun handleFiles(files: Sequence<List<Path>>): Sequence<TestResult> {
-        val flattenedResources = files.toList()
-        if (flattenedResources.isEmpty()) {
-            return emptySequence()
-        }
-        logInfo("Discovered the following file pairs for comparison: $flattenedResources")
-
         testConfig.validateAndSetDefaults()
 
         val fixPluginConfig = testConfig.pluginConfigs.filterIsInstance<FixPluginConfig>().single()
@@ -63,7 +58,7 @@ class FixPlugin(
                 } catch (ex: ProcessExecutionException) {
                     return@map TestResult(
                         listOf(expected, test),
-                        Fail(ex.message!!),
+                        Fail("${ex::class.simpleName}: ${ex.message}", ex::class.simpleName ?: "Unknown exception"),
                         DebugInfo(null, ex.message, null)
                     )
                 }
@@ -76,7 +71,7 @@ class FixPlugin(
                     if (patch.deltas.isEmpty()) {
                         Pass(null)
                     } else {
-                        Fail(patch.formatToString())
+                        Fail(patch.formatToString(), patch.formatToShortString())
                     }
                 }
                 TestResult(
@@ -143,4 +138,13 @@ class FixPlugin(
             else -> delta.toString()
         }
     }
+
+    private fun Patch<String>.formatToShortString(): String = deltas.groupingBy {
+        it.type
+    }
+        .aggregate<Delta<String>, DeltaType, Int> { _, acc, delta, _ ->
+            (acc ?: 0) + delta.source.lines.size
+        }
+        .toList()
+        .joinToString { (type, lines) -> "$type: $lines lines" }
 }

save-core/src/commonMain/kotlin/org/cqfn/save/core/Save.kt

@@ -3,7 +3,6 @@ package org.cqfn.save.plugin.warn
 import org.cqfn.save.core.config.TestConfig
 import org.cqfn.save.core.files.createFile
 import org.cqfn.save.core.files.readLines
-import org.cqfn.save.core.logging.logInfo
 import org.cqfn.save.core.plugin.GeneralConfig
 import org.cqfn.save.core.plugin.Plugin
 import org.cqfn.save.core.result.DebugInfo
@@ -33,14 +32,10 @@ class WarnPlugin(
     testFiles,
     useInternalRedirections) {
     private val fs = FileSystem.SYSTEM
+    private val expectedAndNotReceived = "Some warnings were expected but not received"
+    private val unexpected = "Some warnings were unexpected"
 
     override fun handleFiles(files: Sequence<List<Path>>): Sequence<TestResult> {
-        val flattenedResources = files.toList().flatten()
-        if (flattenedResources.isEmpty()) {
-            return emptySequence()
-        }
-        logInfo("Discovered the following test resources: $flattenedResources")
-
         testConfig.validateAndSetDefaults()
 
         val warnPluginConfig = testConfig.pluginConfigs.filterIsInstance<WarnPluginConfig>().single()
@@ -112,7 +107,7 @@ class WarnPlugin(
         } catch (ex: ProcessExecutionException) {
             return listOf(TestResult(
                 paths,
-                Fail(ex.message!!),
+                Fail("${ex::class.simpleName}: ${ex.message}", ex::class.simpleName ?: "Unknown exception"),
                 DebugInfo(null, ex.message, null)
             ))
         }
@@ -182,18 +177,22 @@ class WarnPlugin(
         val unexpectedWarnings = actualWarningsMap.valuesNotIn(expectedWarningsMap)
 
         return when (missingWarnings.isEmpty() to unexpectedWarnings.isEmpty()) {
-            false to true -> Fail("Some warnings were expected but not received: $missingWarnings")
-            false to false -> Fail("Some warnings were expected but not received: $missingWarnings, " +
-                    "and others were unexpected: $unexpectedWarnings")
+            false to true -> createFail(expectedAndNotReceived, missingWarnings)
+            false to false -> Fail(
+                "$expectedAndNotReceived: $missingWarnings, and ${unexpected.lowercase()}: $unexpectedWarnings",
+                "$expectedAndNotReceived (${missingWarnings.size}), and ${unexpected.lowercase()} (${unexpectedWarnings.size})"
+            )
             true to false -> if (warnPluginConfig.exactWarningsMatch == false) {
-                Pass("Some warnings were unexpected: $unexpectedWarnings")
+                Pass("$unexpected: $unexpectedWarnings")
             } else {
-                Fail("Some warnings were unexpected: $unexpectedWarnings")
+                createFail(unexpected, unexpectedWarnings)
             }
             true to true -> Pass(null)
-            else -> Fail("")
+            else -> Fail("", "")
         }
     }
+
+    private fun createFail(baseText: String, warnings: List<Warning>) = Fail("$baseText: $warnings", "$baseText (${warnings.size})")
 }
 
 /**