Move report base path handling to OutputReport

detekt · Apr 27, 2024 · 86b5741 · 86b5741
1 parent 537c4fe
commit 86b5741
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 2 deletions.
diff --git a/detekt-api/api/detekt-api.api b/detekt-api/api/detekt-api.api
@@ -231,6 +231,8 @@ public final class io/gitlab/arturbosch/detekt/api/Notification$Level : java/lan
 }
 
 public abstract class io/gitlab/arturbosch/detekt/api/OutputReport : io/gitlab/arturbosch/detekt/api/Extension {
+	public static final field Companion Lio/gitlab/arturbosch/detekt/api/OutputReport$Companion;
+	public static final field DETEKT_OUTPUT_REPORT_BASE_PATH_KEY Ljava/lang/String;
 	public fun <init> ()V
 	public abstract fun getEnding ()Ljava/lang/String;
 	public fun getPriority ()I
@@ -240,6 +242,9 @@ public abstract class io/gitlab/arturbosch/detekt/api/OutputReport : io/gitlab/a
 	public final fun write (Ljava/nio/file/Path;Lio/gitlab/arturbosch/detekt/api/Detektion;)V
 }
 
+public final class io/gitlab/arturbosch/detekt/api/OutputReport$Companion {
+}
+
 public class io/gitlab/arturbosch/detekt/api/ProjectMetric {
 	public fun <init> (Ljava/lang/String;IIZI)V
 	public synthetic fun <init> (Ljava/lang/String;IIZIILkotlin/jvm/internal/DefaultConstructorMarker;)V

diff --git a/detekt-api/src/main/kotlin/io/gitlab/arturbosch/detekt/api/OutputReport.kt b/detekt-api/src/main/kotlin/io/gitlab/arturbosch/detekt/api/OutputReport.kt
@@ -34,4 +34,8 @@ abstract class OutputReport : Extension {
      * Defines the translation process of detekt's result into a string.
      */
     abstract fun render(detektion: Detektion): String?
+
+    companion object {
+        const val DETEKT_OUTPUT_REPORT_BASE_PATH_KEY = "detekt.output.report.base.path"
+    }
 }
diff --git a/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/reporting/OutputFacadeSpec.kt b/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/reporting/OutputFacadeSpec.kt
@@ -10,7 +10,9 @@ import io.github.detekt.test.utils.resourceAsPath
 import io.gitlab.arturbosch.detekt.core.DetektResult
 import io.gitlab.arturbosch.detekt.core.createNullLoggingSpec
 import io.gitlab.arturbosch.detekt.core.tooling.withSettings
+import io.gitlab.arturbosch.detekt.test.createEntity
 import io.gitlab.arturbosch.detekt.test.createIssue
+import io.gitlab.arturbosch.detekt.test.createLocation
 import io.gitlab.arturbosch.detekt.test.createRuleInfo
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.jupiter.api.Test
@@ -22,7 +24,19 @@ class OutputFacadeSpec {
     fun `Running the output facade with multiple reports`() {
         val printStream = StringPrintStream()
         val inputPath: Path = resourceAsPath("/cases")
-        val defaultResult = DetektResult(listOf(createIssue(createRuleInfo(ruleSetId = "Key"))))
+        val defaultResult = DetektResult(
+            listOf(
+                createIssue(
+                    createRuleInfo(ruleSetId = "Key"),
+                    createEntity(
+                        location = createLocation(
+                            "TestFile.kt",
+                            System.getProperty("user.dir")
+                        )
+                    )
+                )
+            )
+        )
         val plainOutputPath = createTempFileForTest("detekt", ".txt")
         val htmlOutputPath = createTempFileForTest("detekt", ".html")
         val xmlOutputPath = createTempFileForTest("detekt", ".xml")

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
@@ -19,7 +19,6 @@ import kotlin.io.path.Path
 import kotlin.io.path.absolute
 import kotlin.io.path.invariantSeparatorsPathString
 
-const val DETEKT_OUTPUT_REPORT_BASE_PATH_KEY = "detekt.output.report.base.path"
 const val SRCROOT = "%SRCROOT%"
 
 class SarifOutputReport : BuiltInOutputReport, OutputReport() {

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
@@ -4,6 +4,7 @@ import io.github.detekt.test.utils.readResourceContent
 import io.gitlab.arturbosch.detekt.api.CodeSmell
 import io.gitlab.arturbosch.detekt.api.Config
 import io.gitlab.arturbosch.detekt.api.Entity
+import io.gitlab.arturbosch.detekt.api.OutputReport.Companion.DETEKT_OUTPUT_REPORT_BASE_PATH_KEY
 import io.gitlab.arturbosch.detekt.api.Rule
 import io.gitlab.arturbosch.detekt.api.RuleSet
 import io.gitlab.arturbosch.detekt.api.RuleSetProvider