Fixes in SARIF mode (#479)

### What's done:
* Rework the logic of comparing the `test` file and its copy
* Enable test for SARIF mode in fix plugin

Author: kgevorkyan

build.gradle.kts

@@ -12,3 +12,11 @@ createDetektTask()
 installGitHooks()
 // publishing to maven central
 configurePublishing()
+
+allprojects {
+    configurations.all {
+        // if SNAPSHOT dependencies are used, refresh them periodically
+        resolutionStrategy.cacheDynamicVersionsFor(10, TimeUnit.MINUTES)
+        resolutionStrategy.cacheChangingModulesFor(10, TimeUnit.MINUTES)
+    }
+}

examples/kotlin-diktat/fix/sarif/save.toml

@@ -3,8 +3,6 @@
     description = "SARIF fix objects: Smoke tests for diktat"
     suiteName = "SARIF fix objects - Autofix"
 
-# FixMe: Until https://github.com/saveourtool/sarif-utils/issues/23
-# FixMe: compare only by names, but should by full paths
-#[fix]
-    #actualFixFormat = "SARIF"
-    #actualFixSarifFileName = "save-fixes.sarif"
+[fix]
+    actualFixFormat = "SARIF"
+    actualFixSarifFileName = "save-fixes.sarif"

gradle/libs.versions.toml

@@ -12,7 +12,7 @@ multiplatform-diff = "0.4.0"
 kotlinpoet = "1.12.0"
 kotest = "5.5.4"
 sarif4k = "0.3.0"
-sarif-utils = "0.1.0"
+sarif-utils = "0.2.0-SNAPSHOT"
 
 [plugins]
 kotlin-multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }

save-core/src/commonNonJsTest/kotlin/com/saveourtool/save/core/test/utils/TestUtilsCommon.kt

@@ -53,7 +53,7 @@ fun runTestsWithDiktat(
     ).let(overrideProperties)
 
     // logger is not set from save properties without a config reader, need to set it explicitly
-    logType.set(LogType.ALL)
+    logType.set(LogType.WARN)
     // In this test we need to merge with emulated empty save.properties file in aim to use default values,
     // since initially all fields are null
     val save = Save(saveProperties, fs)

save-plugins/fix-plugin/src/commonMain/kotlin/com/saveourtool/save/plugins/fix/FixPlugin.kt

@@ -26,7 +26,7 @@ import com.saveourtool.save.core.utils.ProcessTimeoutException
 import com.saveourtool.save.core.utils.calculatePathToSarifFile
 import com.saveourtool.save.core.utils.singleIsInstance
 
-import com.saveourtool.sarifutils.cli.adapter.SarifFixAdapter
+import com.saveourtool.sarifutils.adapter.SarifFixAdapter
 import io.github.petertrr.diffutils.diff
 import io.github.petertrr.diffutils.patch.ChangeDelta
 import io.github.petertrr.diffutils.patch.Delta
@@ -124,7 +124,13 @@ class FixPlugin(
                 val stdout = executionResult.stdout
                 val stderr = executionResult.stderr
 
-                buildTestResultsForChunk(testToExpectedFilesMap, adjustedTestCopyToExpectedFilesMap, execCmd, stdout, stderr)
+                buildTestResultsForChunk(
+                    testToExpectedFilesMap,
+                    adjustedTestCopyToExpectedFilesMap,
+                    execCmd,
+                    stdout,
+                    stderr
+                )
             }
             .flatten()
     }
@@ -202,9 +208,10 @@ class FixPlugin(
         // modify existing map, replace test copies to fixed test copies
         val fixedTestCopyToExpectedFilesMap = testCopyToExpectedFilesMap.toMutableList().map { (testCopy, expected) ->
             val fixedTestCopy = fixedFiles.first {
-                // FixMe: Until https://github.com/saveourtool/sarif-utils/issues/23
-                // FixMe: compare only by names, but should by full paths
-                it.name == testCopy.name
+                isComparingTestAndCopy(
+                    it,
+                    testCopy
+                )
             }
             fixedTestCopy to expected
         }
@@ -226,7 +233,7 @@ class FixPlugin(
         testCopyToExpectedFilesMap: List<PathPair>,
         execCmd: String,
         stdout: List<String>,
-        stderr: List<String>,
+        stderr: List<String>
     ): List<TestResult> = testCopyToExpectedFilesMap.map { (testCopy, expected) ->
         val fixedLines = fs.readLines(testCopy)
         val expectedLines = fs.readLines(expected)
@@ -246,19 +253,49 @@ class FixPlugin(
         )
     }
 
-    private fun isComparingTestAndCopy(test: Path, testCopy: Path): Boolean {
-        // TestCopyPath stored in tmpDir, holding the whole hierarchy of original file
-        // while testPath comes to us with path, starting from testRootPath, so we compare them in such way
-        val testCopyPath = testCopy.relativeTo(FileSystem.SYSTEM_TEMPORARY_DIRECTORY)
-            .toString()
-            .substringAfter(Path.DIRECTORY_SEPARATOR)
-            .toPath()
+    private fun isComparingTestAndCopy(
+        test: Path,
+        testCopy: Path,
+    ): Boolean {
+        val testPath = test.trimTmpDir().trimTestRootPath().replaceSeparators()
+        val testCopyPath = testCopy.trimTmpDir().trimTestRootPath().replaceSeparators()
+        return testCopyPath.compareTo(testPath) == 0
+    }
 
-        val testPath = test.createRelativePathToTheRoot(testConfig.getRootConfig().directory).toPath()
+    private fun Path.trimTmpDir(): Path {
+        val currentPathAdjusted = this.toString().replaceSeparators()
+        val tmpDirAdjusted = FileSystem.SYSTEM_TEMPORARY_DIRECTORY.toString().replaceSeparators()
+        return if (currentPathAdjusted.startsWith(tmpDirAdjusted)) {
+            currentPathAdjusted
+                // trim tmpDir
+                .substringAfter("$tmpDirAdjusted/")
+                // trim tmp FixPlugin dir
+                .substringAfter("/")
+                .toPath()
+        } else {
+            this
+        }
+    }
 
-        return testCopyPath.compareTo(testPath) == 0
+    private fun Path.trimTestRootPath(): Path {
+        val currentPathAdjusted = this.toString().replaceSeparators()
+        val testRootPathAdjusted = testConfig.getRootConfig()
+            .directory
+            .toString()
+            .replaceSeparators()
+        return if (currentPathAdjusted.startsWith(testRootPathAdjusted)) {
+            currentPathAdjusted
+                .substringAfter("$testRootPathAdjusted/")
+                .toPath()
+        } else {
+            this
+        }
     }
 
+    private fun String.replaceSeparators(): String = this.replace("\\", "/")
+
+    private fun Path.replaceSeparators(): Path = this.toString().replaceSeparators().toPath()
+
     private fun failTestResult(
         chunk: List<FixTestFiles>,
         ex: ProcessExecutionException,

settings.gradle.kts

@@ -11,6 +11,10 @@ include("save-common-test")
 dependencyResolutionManagement {
     repositories {
         mavenCentral()
+        // add sonatype repository
+        maven {
+            url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots/")
+        }
     }
 }
 enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")