Remove messageOrDescription (#6771)

* Always use the same default message * Don't create findings without message on tests * Make CodeSmell properites final * Remove messageOrDescription
detekt · Dec 30, 2023 · a3df60a · a3df60a
1 parent 4dc2182
commit a3df60a
Show file tree

Hide file tree

Showing 19 changed files with 46 additions and 54 deletions.
diff --git a/detekt-api/api/detekt-api.api b/detekt-api/api/detekt-api.api
@@ -30,17 +30,16 @@ public class io/gitlab/arturbosch/detekt/api/CodeSmell : io/gitlab/arturbosch/de
 	public fun compact ()Ljava/lang/String;
 	public fun compactWithSignature ()Ljava/lang/String;
 	public fun getCharPosition ()Lio/gitlab/arturbosch/detekt/api/TextLocation;
-	public fun getEntity ()Lio/gitlab/arturbosch/detekt/api/Entity;
+	public final fun getEntity ()Lio/gitlab/arturbosch/detekt/api/Entity;
 	public fun getFile ()Ljava/lang/String;
 	public fun getId ()Ljava/lang/String;
 	public final fun getIssue ()Lio/gitlab/arturbosch/detekt/api/Issue;
 	public fun getLocation ()Lio/gitlab/arturbosch/detekt/api/Location;
-	public fun getMessage ()Ljava/lang/String;
-	public fun getReferences ()Ljava/util/List;
+	public final fun getMessage ()Ljava/lang/String;
+	public final fun getReferences ()Ljava/util/List;
 	public fun getSeverity ()Lio/gitlab/arturbosch/detekt/api/Severity;
 	public fun getSignature ()Ljava/lang/String;
 	public fun getStartPosition ()Lio/gitlab/arturbosch/detekt/api/SourceLocation;
-	public fun messageOrDescription ()Ljava/lang/String;
 	public fun toString ()Ljava/lang/String;
 }
 
@@ -221,7 +220,6 @@ public abstract interface class io/gitlab/arturbosch/detekt/api/Finding : io/git
 	public abstract fun getMessage ()Ljava/lang/String;
 	public abstract fun getReferences ()Ljava/util/List;
 	public abstract fun getSeverity ()Lio/gitlab/arturbosch/detekt/api/Severity;
-	public abstract fun messageOrDescription ()Ljava/lang/String;
 }
 
 public final class io/gitlab/arturbosch/detekt/api/Finding$DefaultImpls {

diff --git a/detekt-api/src/main/kotlin/io/gitlab/arturbosch/detekt/api/CodeSmell.kt b/detekt-api/src/main/kotlin/io/gitlab/arturbosch/detekt/api/CodeSmell.kt
@@ -9,10 +9,13 @@ package io.gitlab.arturbosch.detekt.api
  */
 open class CodeSmell(
     final override val issue: Issue,
-    override val entity: Entity,
-    override val message: String,
-    override val references: List<Entity> = emptyList()
+    final override val entity: Entity,
+    final override val message: String,
+    final override val references: List<Entity> = emptyList()
 ) : Finding {
+    init {
+        require(message.isNotBlank()) { "The message should not be empty" }
+    }
 
     internal var internalSeverity: Severity? = null
     override val severity: Severity
@@ -32,8 +35,6 @@ open class CodeSmell(
             "severity=$severity, " +
             "id='$id')"
     }
-
-    override fun messageOrDescription(): String = message.ifEmpty { issue.description }
 }
 
 /**

diff --git a/detekt-api/src/main/kotlin/io/gitlab/arturbosch/detekt/api/Findings.kt b/detekt-api/src/main/kotlin/io/gitlab/arturbosch/detekt/api/Findings.kt
@@ -14,11 +14,6 @@ interface Finding : Compactable, HasEntity {
     val message: String
     val severity: Severity
         get() = Severity.DEFAULT
-
-    /**
-     * Explanation why this finding was raised.
-     */
-    fun messageOrDescription(): String
 }
 
 /**

diff --git a/detekt-api/src/testFixtures/kotlin/io/gitlab/arturbosch/detekt/test/TestFactory.kt b/detekt-api/src/testFixtures/kotlin/io/gitlab/arturbosch/detekt/test/TestFactory.kt
@@ -36,7 +36,7 @@ fun createCorrectableFinding(
 fun createFinding(
     issue: Issue,
     entity: Entity,
-    message: String = entity.signature,
+    message: String = "TestMessage",
     severity: Severity = Severity.ERROR
 ) = object : CodeSmell(
     issue = issue,

diff --git a/...n/src/main/kotlin/io/github/detekt/compiler/plugin/internal/MessageCollectorExtensions.kt b/...n/src/main/kotlin/io/github/detekt/compiler/plugin/internal/MessageCollectorExtensions.kt
@@ -44,5 +44,5 @@ fun Finding.renderAsCompilerWarningMessage(): Pair<String, CompilerMessageLocati
         )
     }
 
-    return "$id: ${messageOrDescription()}" to sourceLocation
+    return "$id: $message" to sourceLocation
 }
diff --git a/detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/reporting/Reporting.kt b/detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/reporting/Reporting.kt
@@ -58,7 +58,7 @@ fun Detektion.filterAutoCorrectedIssues(config: Config): Map<RuleSetId, List<Fin
 }
 
 private fun Finding.truncatedMessage(): String {
-    val message = messageOrDescription()
+    val message = message
         .replace(messageReplacementRegex, " ")
         .trim()
     return when {

diff --git a/.../src/main/kotlin/io/gitlab/arturbosch/detekt/core/reporting/console/LiteFindingsReport.kt b/.../src/main/kotlin/io/gitlab/arturbosch/detekt/core/reporting/console/LiteFindingsReport.kt
@@ -14,7 +14,7 @@ class LiteFindingsReport : AbstractFindingsReport() {
     override fun render(findings: Map<RuleSetId, List<Finding>>): String {
         return buildString {
             findings.values.flatten().forEach { finding ->
-                append("${finding.location.compact()}: ${finding.messageOrDescription()} [${finding.issue.id}]")
+                append("${finding.location.compact()}: ${finding.message} [${finding.issue.id}]")
                 appendLine()
             }
         }

diff --git a/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/AnalyzerSpec.kt b/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/AnalyzerSpec.kt
@@ -244,7 +244,7 @@ private class CustomRuleSetProvider : RuleSetProvider {
 }
 
 private class MaxLineLength(config: Config) : Rule(config) {
-    override val issue = Issue(this::class.java.simpleName, "")
+    override val issue = Issue(this::class.java.simpleName, "TestDescription")
     private val lengthThreshold: Int = valueOrDefault("maxLineLength", 10)
     override fun visitKtFile(file: KtFile) {
         super.visitKtFile(file)
@@ -258,7 +258,7 @@ private class MaxLineLength(config: Config) : Rule(config) {
 
 @RequiresTypeResolution
 private class RequiresTypeResolutionMaxLineLength(config: Config) : Rule(config) {
-    override val issue = Issue(this::class.java.simpleName, "")
+    override val issue = Issue(this::class.java.simpleName, "TestDescription")
     private val lengthThreshold: Int = valueOrDefault("maxLineLength", 10)
     override fun visitKtFile(file: KtFile) {
         super.visitKtFile(file)

diff --git a/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/KT.kt b/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/KT.kt
@@ -28,6 +28,6 @@ class TestProvider2(override val ruleSetId: String = "Test2") : RuleSetProvider
 class FindName(config: Config) : Rule(config) {
     override val issue: Issue = Issue(javaClass.simpleName, "")
     override fun visitClassOrObject(classOrObject: KtClassOrObject) {
-        report(CodeSmell(issue, Entity.atName(classOrObject), message = ""))
+        report(CodeSmell(issue, Entity.atName(classOrObject), message = "TestMessage"))
     }
 }
diff --git a/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/SuppressionSpec.kt b/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/SuppressionSpec.kt
@@ -304,14 +304,14 @@ private class TestLM(config: Config = Config.empty) : Rule(config) {
         val start = Location.startLineAndColumn(function.funKeyword!!).line
         val end = Location.startLineAndColumn(function.lastBlockStatementOrThis()).line
         val offset = end - start
-        if (offset > 10) report(CodeSmell(issue, Entity.from(function), message = ""))
+        if (offset > 10) report(CodeSmell(issue, Entity.from(function), message = "TestMessage"))
     }
 }
 
 private class TestLPL(config: Config = Config.empty) : Rule(config) {
     override val issue = Issue("LongParameterList", "")
     override fun visitNamedFunction(function: KtNamedFunction) {
         val size = function.valueParameters.size
-        if (size > 5) report(CodeSmell(issue, Entity.from(function), message = ""))
+        if (size > 5) report(CodeSmell(issue, Entity.from(function), message = "TestMessage"))
     }
 }
diff --git a/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/suppressors/Builders.kt b/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/suppressors/Builders.kt
@@ -18,7 +18,7 @@ import kotlin.io.path.Path
 internal fun buildFinding(element: KtElement?): Finding = CodeSmell(
     issue = Issue("RuleName", ""),
     entity = element?.let { Entity.from(element) } ?: buildEmptyEntity(),
-    message = "",
+    message = "TestMessage",
 )
 
 private fun buildEmptyEntity(): Entity = Entity(

diff --git a/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/suppressors/SuppressorsSpec.kt b/detekt-core/src/test/kotlin/io/gitlab/arturbosch/detekt/core/suppressors/SuppressorsSpec.kt
@@ -16,7 +16,7 @@ class SuppressorsSpec {
     val noIgnorableCodeSmell = CodeSmell(
         issue = ARule().issue,
         entity = Entity.from(compileContentForTest("""fun foo() = Unit""".trimIndent())),
-        message = ""
+        message = "TestMessage"
     )
 
     val ignorableCodeSmell = CodeSmell(
@@ -32,7 +32,7 @@ class SuppressorsSpec {
                 """.trimIndent()
             )
         ),
-        message = ""
+        message = "TestMessage"
     )
 
     @Test

diff --git a/detekt-report-html/src/test/kotlin/io/github/detekt/report/html/HtmlOutputReportSpec.kt b/detekt-report-html/src/test/kotlin/io/github/detekt/report/html/HtmlOutputReportSpec.kt
@@ -220,7 +220,7 @@ private fun createTestDetektionWithMultipleSmells(): Detektion {
             createFinding(issueA, entity1, "Message finding 1"),
             createFinding(issueA, entity2, "Message finding 2")
         ),
-        "Section 2" to listOf(createFinding(issueB, entity3, ""))
+        "Section 2" to listOf(createFinding(issueB, entity3, "Message finding 3"))
     )
 }
 
@@ -257,7 +257,7 @@ private fun createTestDetektionFromRelativePath(): Detektion {
             createFinding(issueA, entity1, "Message finding 1"),
             createFinding(issueA, entity2, "Message finding 2")
         ),
-        "Section 2" to listOf(createFinding(issueB, entity3, ""))
+        "Section 2" to listOf(createFinding(issueB, entity3, "Message finding 3"))
     )
 }
 

diff --git a/detekt-report-html/src/test/resources/HtmlOutputFormatTest.html b/detekt-report-html/src/test/resources/HtmlOutputFormatTest.html
@@ -191,7 +191,7 @@ <h3>Section 2: 1</h3>
     <summary class="rule-container"><span class="rule">id_b: 1 </span><span class="description">Description id_b</span></summary>
 <a href="https://detekt.dev/docs/rules/section 2#id_b">Documentation</a>
     <ul>
-      <li><span class="location">src/main/com/sample/Sample3.kt:33:3</span></li>
+      <li><span class="location">src/main/com/sample/Sample3.kt:33:3</span><span class="message">Message finding 3</span></li>
     </ul>
   </details>
 </div>

diff --git a/detekt-report-md/src/test/kotlin/io/github/detekt/report/md/MdOutputReportSpec.kt b/detekt-report-md/src/test/kotlin/io/github/detekt/report/md/MdOutputReportSpec.kt
@@ -208,7 +208,7 @@ private fun createTestDetektionWithMultipleSmells(): Detektion {
             createFinding(issueA, entity2, "Message finding 2")
         ),
         "Section-2" to listOf(
-            createFinding(issueB, entity3, "")
+            createFinding(issueB, entity3, "Message finding 3")
         )
     ).also {
         it.putUserData(complexityKey, 10)

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
@@ -30,7 +30,7 @@ private fun Finding.toResult(ruleSetId: RuleSetId): io.github.detekt.sarif4k.Res
         ruleID = "detekt.$ruleSetId.$id",
         level = severity.toResultLevel(),
         locations = (listOf(location) + references.map { it.location }).map { it.toLocation(code) }.distinct().toList(),
-        message = Message(text = messageOrDescription())
+        message = Message(text = message)
     )
 }
 

diff --git a/detekt-report-xml/src/main/kotlin/io/github/detekt/report/xml/XmlOutputReport.kt b/detekt-report-xml/src/main/kotlin/io/github/detekt/report/xml/XmlOutputReport.kt
@@ -34,7 +34,7 @@ class XmlOutputReport : BuiltInOutputReport, OutputReport() {
                         "\t<error line=\"${it.location.source.line.toXmlString()}\"",
                         "column=\"${it.location.source.column.toXmlString()}\"",
                         "severity=\"${it.severityLabel.toXmlString()}\"",
-                        "message=\"${it.messageOrDescription().toXmlString()}\"",
+                        "message=\"${it.message.toXmlString()}\"",
                         "source=\"${"detekt.${it.id.toXmlString()}"}\" />"
                     ).joinToString(separator = " ")
                 }

diff --git a/detekt-report-xml/src/test/kotlin/io/github/detekt/report/xml/XmlOutputFormatSpec.kt b/detekt-report-xml/src/test/kotlin/io/github/detekt/report/xml/XmlOutputFormatSpec.kt
@@ -57,7 +57,7 @@ class XmlOutputFormatSpec {
 
     @Test
     fun `renders one reported issue in single file`() {
-        val smell = CodeSmell(Issue("id_a", ""), entity1, message = "")
+        val smell = CodeSmell(Issue("id_a", ""), entity1, message = "TestMessage")
 
         val result = outputFormat.render(TestDetektion(smell))
 
@@ -66,7 +66,7 @@ class XmlOutputFormatSpec {
                 <?xml version="1.0" encoding="UTF-8"?>
                 <checkstyle version="4.3">
                 <file name="src/main/com/sample/Sample1.kt">
-                $TAB<error line="11" column="1" severity="error" message="" source="detekt.id_a" />
+                $TAB<error line="11" column="1" severity="error" message="TestMessage" source="detekt.id_a" />
                 </file>
                 </checkstyle>
             """.trimIndent()
@@ -75,8 +75,8 @@ class XmlOutputFormatSpec {
 
     @Test
     fun `renders two reported issues in single file`() {
-        val smell1 = CodeSmell(Issue("id_a", ""), entity1, message = "")
-        val smell2 = CodeSmell(Issue("id_b", ""), entity1, message = "")
+        val smell1 = CodeSmell(Issue("id_a", ""), entity1, message = "TestMessage")
+        val smell2 = CodeSmell(Issue("id_b", ""), entity1, message = "TestMessage")
 
         val result = outputFormat.render(TestDetektion(smell1, smell2))
 
@@ -85,8 +85,8 @@ class XmlOutputFormatSpec {
                 <?xml version="1.0" encoding="UTF-8"?>
                 <checkstyle version="4.3">
                 <file name="src/main/com/sample/Sample1.kt">
-                $TAB<error line="11" column="1" severity="error" message="" source="detekt.id_a" />
-                $TAB<error line="11" column="1" severity="error" message="" source="detekt.id_b" />
+                $TAB<error line="11" column="1" severity="error" message="TestMessage" source="detekt.id_a" />
+                $TAB<error line="11" column="1" severity="error" message="TestMessage" source="detekt.id_b" />
                 </file>
                 </checkstyle>
             """.trimIndent()
@@ -95,8 +95,8 @@ class XmlOutputFormatSpec {
 
     @Test
     fun `renders one reported issue across multiple files`() {
-        val smell1 = CodeSmell(Issue("id_a", ""), entity1, message = "")
-        val smell2 = CodeSmell(Issue("id_a", ""), entity2, message = "")
+        val smell1 = CodeSmell(Issue("id_a", ""), entity1, message = "TestMessage")
+        val smell2 = CodeSmell(Issue("id_a", ""), entity2, message = "TestMessage")
 
         val result = outputFormat.render(TestDetektion(smell1, smell2))
 
@@ -105,10 +105,10 @@ class XmlOutputFormatSpec {
                 <?xml version="1.0" encoding="UTF-8"?>
                 <checkstyle version="4.3">
                 <file name="src/main/com/sample/Sample1.kt">
-                $TAB<error line="11" column="1" severity="error" message="" source="detekt.id_a" />
+                $TAB<error line="11" column="1" severity="error" message="TestMessage" source="detekt.id_a" />
                 </file>
                 <file name="src/main/com/sample/Sample2.kt">
-                $TAB<error line="22" column="2" severity="error" message="" source="detekt.id_a" />
+                $TAB<error line="22" column="2" severity="error" message="TestMessage" source="detekt.id_a" />
                 </file>
                 </checkstyle>
             """.trimIndent()
@@ -147,10 +147,10 @@ class XmlOutputFormatSpec {
 
     @Test
     fun `renders two reported issues across multiple files`() {
-        val smell1 = CodeSmell(Issue("id_a", ""), entity1, message = "")
-        val smell2 = CodeSmell(Issue("id_b", ""), entity1, message = "")
-        val smell3 = CodeSmell(Issue("id_a", ""), entity2, message = "")
-        val smell4 = CodeSmell(Issue("id_b", ""), entity2, message = "")
+        val smell1 = CodeSmell(Issue("id_a", ""), entity1, message = "TestMessage")
+        val smell2 = CodeSmell(Issue("id_b", ""), entity1, message = "TestMessage")
+        val smell3 = CodeSmell(Issue("id_a", ""), entity2, message = "TestMessage")
+        val smell4 = CodeSmell(Issue("id_b", ""), entity2, message = "TestMessage")
 
         val result = outputFormat.render(
             TestDetektion(
@@ -166,12 +166,12 @@ class XmlOutputFormatSpec {
                 <?xml version="1.0" encoding="UTF-8"?>
                 <checkstyle version="4.3">
                 <file name="src/main/com/sample/Sample1.kt">
-                $TAB<error line="11" column="1" severity="error" message="" source="detekt.id_a" />
-                $TAB<error line="11" column="1" severity="error" message="" source="detekt.id_b" />
+                $TAB<error line="11" column="1" severity="error" message="TestMessage" source="detekt.id_a" />
+                $TAB<error line="11" column="1" severity="error" message="TestMessage" source="detekt.id_b" />
                 </file>
                 <file name="src/main/com/sample/Sample2.kt">
-                $TAB<error line="22" column="2" severity="error" message="" source="detekt.id_a" />
-                $TAB<error line="22" column="2" severity="error" message="" source="detekt.id_b" />
+                $TAB<error line="22" column="2" severity="error" message="TestMessage" source="detekt.id_a" />
+                $TAB<error line="22" column="2" severity="error" message="TestMessage" source="detekt.id_b" />
                 </file>
                 </checkstyle>
             """.trimIndent()
@@ -198,7 +198,7 @@ class XmlOutputFormatSpec {
                 <?xml version="1.0" encoding="UTF-8"?>
                 <checkstyle version="4.3">
                 <file name="src/main/com/sample/Sample1.kt">
-                $TAB<error line="${finding.location.source.line}" column="${finding.location.source.column}" severity="$xmlSeverity" message="${finding.messageOrDescription()}" source="detekt.${finding.id}" />
+                $TAB<error line="${finding.location.source.line}" column="${finding.location.source.column}" severity="$xmlSeverity" message="${finding.message}" source="detekt.${finding.id}" />
                 </file>
                 </checkstyle>
             """.trimIndent()

diff --git a/...xity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/ThresholdedCodeSmell.kt b/...xity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/ThresholdedCodeSmell.kt
@@ -23,6 +23,4 @@ open class ThresholdedCodeSmell(
     references = references
 ) {
     override fun compact(): String = "$id - $metric - ${entity.compact()}"
-
-    override fun messageOrDescription(): String = message.ifEmpty { issue.description }
 }