Use toUri to generate absolute ArtifactLocation paths

detekt · Oct 8, 2023 · d64d520 · d64d520
1 parent c6fb152
commit d64d520
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 7 deletions.
diff --git a/detekt-report-sarif/src/main/kotlin/io/github/detekt/report/sarif/Results.kt b/detekt-report-sarif/src/main/kotlin/io/github/detekt/report/sarif/Results.kt
@@ -58,7 +58,7 @@ private fun Location.toLocation(code: String?): io.github.detekt.sarif4k.Locatio
                     uriBaseID = SRCROOT
                 )
             } else {
-                ArtifactLocation(uri = "file:///${filePath.absolutePath.invariantSeparatorsPathString}")
+                ArtifactLocation(uri = filePath.absolutePath.toUri().toString())
             }
         )
     )

diff --git a/detekt-report-sarif/src/main/kotlin/io/github/detekt/report/sarif/SarifOutputReport.kt b/detekt-report-sarif/src/main/kotlin/io/github/detekt/report/sarif/SarifOutputReport.kt
@@ -15,6 +15,7 @@ import io.gitlab.arturbosch.detekt.api.UnstableApi
 import io.gitlab.arturbosch.detekt.api.getOrNull
 import io.gitlab.arturbosch.detekt.api.internal.whichDetekt
 import java.nio.file.Path
+import kotlin.io.path.Path
 import kotlin.io.path.absolute
 import kotlin.io.path.invariantSeparatorsPathString
 
@@ -62,7 +63,7 @@ class SarifOutputReport : OutputReport() {
                         )
                     ),
                     originalURIBaseIDS = basePath?.let {
-                        mapOf(SRCROOT to ArtifactLocation(uri = "file:///$basePath"))
+                        mapOf(SRCROOT to ArtifactLocation(uri = Path(basePath!!).toUri().toString()))
                     },
                     results = toResults(detektion)
                 )

diff --git a/detekt-report-sarif/src/test/kotlin/io/github/detekt/report/sarif/SarifOutputReportSpec.kt b/detekt-report-sarif/src/test/kotlin/io/github/detekt/report/sarif/SarifOutputReportSpec.kt
@@ -38,7 +38,10 @@ class SarifOutputReportSpec {
             .apply { init(EmptySetupContext()) }
             .render(result)
 
-        assertThat(report).isEqualToIgnoringWhitespace(readResourceContent("vanilla.sarif.json"))
+        val expectedReport = readResourceContent("vanilla.sarif.json")
+            .replace("<PREFIX>", Path(System.getProperty("user.dir")).toUri().toString())
+
+        assertThat(report).isEqualToIgnoringWhitespace(expectedReport)
     }
 
     @Test

diff --git a/detekt-report-sarif/src/test/resources/relative_path.sarif.json b/detekt-report-sarif/src/test/resources/relative_path.sarif.json
@@ -5,7 +5,7 @@
     {
       "originalUriBaseIds": {
         "%SRCROOT%": {
-          "uri": "file:///Users/tester/detekt/"
+          "uri": "file:///Users/tester/detekt"
         }
       },
       "results": [

diff --git a/detekt-report-sarif/src/test/resources/vanilla.sarif.json b/detekt-report-sarif/src/test/resources/vanilla.sarif.json
@@ -10,7 +10,7 @@
             {
               "physicalLocation": {
                 "artifactLocation": {
-                  "uri": "file:///TestFile.kt"
+                  "uri": "<PREFIX>TestFile.kt"
                 },
                 "region": {
                   "startColumn": 1,
@@ -30,7 +30,7 @@
             {
               "physicalLocation": {
                 "artifactLocation": {
-                  "uri": "file:///TestFile.kt"
+                  "uri": "<PREFIX>TestFile.kt"
                 },
                 "region": {
                   "startColumn": 1,
@@ -50,7 +50,7 @@
             {
               "physicalLocation": {
                 "artifactLocation": {
-                  "uri": "file:///TestFile.kt"
+                  "uri": "<PREFIX>TestFile.kt"
                 },
                 "region": {
                   "startColumn": 1,