Replace List<Path> with TestFiles in TestResult (#284)

### What's done:
* Changed property of `TestResult` and updated usages

Author: petertrr

save-cli/src/jvmTest/kotlin/org/cqfn/save/cli/GeneralTest.kt

@@ -84,10 +84,11 @@ class GeneralTest {
         // All result statuses should be Pass
         json.forEach { report ->
             report.pluginExecutions.forEach { pluginExecution ->
-                pluginExecution.testResults.forEach { result ->
+                pluginExecution.testResults.find { result ->
                     println(result.status)
-                    result.resources.find { it.name == "ThisShouldAlwaysFailTest.kt" }
-                        ?: assertTrue(result.status is Pass)
+                    result.resources.test.name != "ThisShouldAlwaysFailTest.kt"
+                }?.let {
+                    assertTrue(it.status is Pass)
                 }
             }
         }

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

@@ -7,12 +7,15 @@ import org.cqfn.save.core.files.findDescendantDirectoriesBy
 import org.cqfn.save.core.files.parentsWithSelf
 import org.cqfn.save.core.logging.logDebug
 import org.cqfn.save.core.result.TestResult
+import org.cqfn.save.core.utils.PathSerializer
 import org.cqfn.save.core.utils.ProcessBuilder
 
 import okio.FileSystem
 import okio.Path
 import okio.Path.Companion.toPath
 
+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
@@ -210,10 +213,20 @@ abstract class Plugin(
          * path to test file
          */
         val test: Path
+
+        /**
+         * @param root path to calculate relative paths
+         * @return copy of `this` with relativized paths
+         */
+        fun withRelativePaths(root: Path): TestFiles
     }
 
     /**
      * @property test test file
      */
-    data class Test(override val test: Path) : TestFiles
+    @Serializable
+    data class Test(@Serializable(with = PathSerializer::class) override val test: Path) : TestFiles {
+        override fun withRelativePaths(root: Path) =
+                copy(test = test.createRelativePathToTheRoot(root).toPath())
+    }
 }

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

@@ -2,10 +2,9 @@
 
 package org.cqfn.save.core.result
 
+import org.cqfn.save.core.plugin.Plugin
 import org.cqfn.save.core.utils.PathSerializer
 
-import okio.Path
-
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.UseSerializers
 
@@ -18,7 +17,7 @@ import kotlinx.serialization.UseSerializers
  */
 @Serializable
 data class TestResult(
-    val resources: Collection<Path>,
+    val resources: Plugin.TestFiles,
     val status: TestStatus,
     val debugInfo: DebugInfo? = null,
 )

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

@@ -7,7 +7,6 @@ import org.cqfn.save.core.config.SaveProperties
 import org.cqfn.save.core.config.isSaveTomlConfig
 import org.cqfn.save.core.files.ConfigDetector
 import org.cqfn.save.core.files.StdStreamsSink
-import org.cqfn.save.core.files.createRelativePathToTheRoot
 import org.cqfn.save.core.logging.logDebug
 import org.cqfn.save.core.logging.logError
 import org.cqfn.save.core.logging.logInfo
@@ -22,6 +21,7 @@ import org.cqfn.save.core.result.Pass
 import org.cqfn.save.core.result.TestResult
 import org.cqfn.save.core.utils.buildActivePlugins
 import org.cqfn.save.core.utils.processInPlace
+import org.cqfn.save.plugins.fix.FixPlugin
 import org.cqfn.save.reporter.json.JsonReporter
 import org.cqfn.save.reporter.plain.PlainOnlyFailedReporter
 import org.cqfn.save.reporter.plain.PlainTextReporter
@@ -135,8 +135,7 @@ class Save(
             plugin.execute()
                 .onEach { event ->
                     // calculate relative paths, because reporters don't need paths higher than root dir
-                    val resourcesRelative =
-                            event.resources.map { it.createRelativePathToTheRoot(testRepositoryRootPath).toPath() }
+                    val resourcesRelative = event.resources.withRelativePaths(testRepositoryRootPath)
                     reporter.onEvent(event.copy(resources = resourcesRelative))
                 }
                 .forEach(this::handleResult)
@@ -164,7 +163,9 @@ class Save(
         return when (saveProperties.reportType) {
             ReportType.PLAIN -> PlainTextReporter(out)
             ReportType.PLAIN_FAILED -> PlainOnlyFailedReporter(out)
-            ReportType.JSON -> JsonReporter(out)
+            ReportType.JSON -> JsonReporter(out) {
+                FixPlugin.FixTestFiles.register(this)
+            }
             ReportType.TEST -> TestReporter(out)
             else -> TODO("Reporter for type ${saveProperties.reportType} is not yet supported")
         }

save-core/src/commonNonJsTest/kotlin/org/cqfn/save/core/test/utils/TestUtilsCommon.kt

@@ -53,7 +53,7 @@ fun runTestsWithDiktat(
     assertEquals(numberOfTests, testReporter.results.size)
     testReporter.results.forEach { test ->
         // FixMe: if we will have other failing tests - we will make the logic less hardcoded
-        test.resources.find { it.name == "ThisShouldAlwaysFailTest.kt" }?.let {
+        if (test.resources.test.name == "ThisShouldAlwaysFailTest.kt") {
             assertEquals(
                 Fail(
                     "Some warnings were expected but not received:" +
@@ -62,9 +62,8 @@ fun runTestsWithDiktat(
                     "Some warnings were expected but not received (1)"
                 ), test.status
             )
+        } else {
+            assertEquals(Pass(null), test.status)
         }
-            ?: run {
-                assertEquals(Pass(null), test.status)
-            }
     }
 }

save-plugins/fix-and-warn-plugin/src/commonMain/kotlin/org/cqfn/save/plugins/fixandwarn/FixAndWarnPlugin.kt

@@ -78,7 +78,7 @@ class FixAndWarnPlugin(
         val (fixTestResultsPassed, fixTestResultsFailed) = fixTestResults.partition { it.status is Pass }
 
         val expectedFilesWithPass = expectedFiles.filter { expectedFile ->
-            fixTestResultsPassed.map { it.resources.toList()[1] }.contains(expectedFile)
+            fixTestResultsPassed.map { (it.resources as FixPlugin.FixTestFiles).expected }.contains(expectedFile)
         }
 
         // Fill back original data with warnings

save-plugins/fix-plugin/src/commonMain/kotlin/org/cqfn/save/plugins/fix/FixPlugin.kt

@@ -2,6 +2,7 @@ package org.cqfn.save.plugins.fix
 
 import org.cqfn.save.core.config.TestConfig
 import org.cqfn.save.core.files.createFile
+import org.cqfn.save.core.files.createRelativePathToTheRoot
 import org.cqfn.save.core.files.readLines
 import org.cqfn.save.core.logging.describe
 import org.cqfn.save.core.plugin.ExtraFlags
@@ -13,6 +14,7 @@ import org.cqfn.save.core.result.DebugInfo
 import org.cqfn.save.core.result.Fail
 import org.cqfn.save.core.result.Pass
 import org.cqfn.save.core.result.TestResult
+import org.cqfn.save.core.utils.PathSerializer
 import org.cqfn.save.core.utils.ProcessExecutionException
 
 import io.github.petertrr.diffutils.diff
@@ -23,6 +25,11 @@ import io.github.petertrr.diffutils.patch.Patch
 import io.github.petertrr.diffutils.text.DiffRowGenerator
 import okio.FileSystem
 import okio.Path
+import okio.Path.Companion.toPath
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.modules.PolymorphicModuleBuilder
+import kotlinx.serialization.modules.subclass
 
 /**
  * A plugin that runs an executable on a file and compares output with expected output.
@@ -81,7 +88,7 @@ class FixPlugin(
             } catch (ex: ProcessExecutionException) {
                 return@map chunk.map {
                     TestResult(
-                        pathMap.map { (test, expected) -> listOf(test, expected) }.flatten(),
+                        it,
                         Fail(ex.describe(), ex.describe()),
                         DebugInfo(null, ex.message, null)
                     )
@@ -98,7 +105,7 @@ class FixPlugin(
                 val test = pathMap.first { (test, _) -> test.name == testCopy.name }.first
 
                 TestResult(
-                    listOf(test, expected),
+                    FixTestFiles(test, expected),
                     checkStatus(expectedLines, fixedLines),
                     DebugInfo(
                         stdout.filter { it.contains(testCopy.name) }.joinToString("\n"),
@@ -195,5 +202,22 @@ class FixPlugin(
      * @property test test file
      * @property expected expected file
      */
-    data class FixTestFiles(override val test: Path, val expected: Path) : TestFiles
+    @Serializable
+    data class FixTestFiles(
+        @Serializable(with = PathSerializer::class) override val test: Path,
+        @Serializable(with = PathSerializer::class) val expected: Path
+    ) : TestFiles {
+        override fun withRelativePaths(root: Path) = copy(
+            test = test.createRelativePathToTheRoot(root).toPath(),
+            expected = expected.createRelativePathToTheRoot(root).toPath(),
+        )
+
+        companion object {
+            /**
+             * @param builder `PolymorphicModuleBuilder` to which this class should be registered for serialization
+             */
+            fun register(builder: PolymorphicModuleBuilder<TestFiles>): Unit =
+                    builder.subclass(FixTestFiles::class)
+        }
+    }
 }

save-plugins/fix-plugin/src/commonNonJsTest/kotlin/org/cqfn/save/plugins/fix/FixPluginTest.kt

@@ -88,7 +88,7 @@ class FixPluginTest {
         ).execute()
 
         assertEquals(1, results.count(), "Size of results should equal number of pairs")
-        assertEquals(TestResult(listOf(testFile, expectedFile), Pass(null),
+        assertEquals(TestResult(FixPlugin.FixTestFiles(testFile, expectedFile), Pass(null),
             DebugInfo(results.single().debugInfo?.stdout, results.single().debugInfo?.stderr, null)), results.single())
         val tmpDir = (FileSystem.SYSTEM_TEMPORARY_DIRECTORY / FixPlugin::class.simpleName!!)
         assertTrue("Files should be identical") {

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

@@ -135,13 +135,13 @@ class WarnPlugin(
         val executionResult = try {
             pb.exec(execCmd, testConfig.getRootConfig().directory.toString(), redirectTo)
         } catch (ex: ProcessExecutionException) {
-            return sequenceOf(
+            return paths.map {
                 TestResult(
-                    paths,
+                    Test(it),
                     Fail(ex.describe(), ex.describe()),
                     DebugInfo(null, ex.message, null)
                 )
-            )
+            }.asSequence()
         }
         val stdout = executionResult.stdout
         val stderr = executionResult.stderr
@@ -169,7 +169,7 @@ class WarnPlugin(
 
         return paths.map { path ->
             TestResult(
-                listOf(path),
+                Test(path),
                 resultsChecker.checkResults(path.name),
                 DebugInfo(
                     stdout.filter { it.contains(path.name) }.joinToString("\n"),

save-reporters/src/commonMain/kotlin/org/cqfn/save/reporter/json/JsonReporter.kt

@@ -10,19 +10,35 @@ import okio.BufferedSink
 
 import kotlinx.serialization.encodeToString
 import kotlinx.serialization.json.Json
+import kotlinx.serialization.modules.PolymorphicModuleBuilder
+import kotlinx.serialization.modules.SerializersModule
+import kotlinx.serialization.modules.polymorphic
+import kotlinx.serialization.modules.subclass
 
 /**
  * Reporter that produces a JSON report as a [Report]
  *
  * @property out a sink for output
+ *
+ * @param builder additional configuration lambda for serializers module
  */
-class JsonReporter(override val out: BufferedSink) : Reporter {
+class JsonReporter(
+    override val out: BufferedSink,
+    builder: PolymorphicModuleBuilder<Plugin.TestFiles>.() -> Unit = {}
+) : Reporter {
     override val type: ReportType = ReportType.JSON
 
     /**
      * Formatter to serialize/deserialize to JSON
      */
-    internal val json = Json
+    val json: Json = Json {
+        serializersModule = SerializersModule {
+            polymorphic(Plugin.TestFiles::class) {
+                subclass(Plugin.Test::class)
+                builder()
+            }
+        }
+    }
 
     private var isFirstEvent = true  // todo: use AtomicBoolean
 

save-reporters/src/commonMain/kotlin/org/cqfn/save/reporter/plain/PlainTextReporter.kt

@@ -74,7 +74,7 @@ open class PlainTextReporter(override val out: BufferedSink) : Reporter {
         }
             ?: ""
         out.write(
-            "| $currentTestSuite | $currentPlugin | ${event.resources.first()} | ${event.status::class.simpleName} | $shortComment |\n"
+            "| $currentTestSuite | $currentPlugin | ${event.resources.test} | ${event.status::class.simpleName} | $shortComment |\n"
                 .encodeToByteArray()
         )
     }

save-reporters/src/commonTest/kotlin/org/cqfn/save/reporter/json/JsonReporterTest.kt

@@ -1,6 +1,7 @@
 package org.cqfn.save.reporter.json
 
 import org.cqfn.save.core.files.readFile
+import org.cqfn.save.core.plugin.Plugin
 import org.cqfn.save.core.result.Crash
 import org.cqfn.save.core.result.TestResult
 import org.cqfn.save.plugin.MockPlugin
@@ -59,7 +60,7 @@ class JsonReporterTest {
         jsonReporter.onPluginExecutionStart(mockPlugin)
         jsonReporter.onEvent(
             TestResult(
-                emptyList(),
+                Plugin.Test(tmpFile),
                 Crash("IllegalArgumentException", "foo")
             )
         )