Move suppressions to core (#7101)

* Move suppression to Analyzer * Move Suppressions to core * improve kdoc
detekt · May 8, 2024 · bf3fc6f · bf3fc6f
1 parent 35c4599
commit bf3fc6f
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 150 deletions.
diff --git a/detekt-api/src/main/kotlin/io/gitlab/arturbosch/detekt/api/Rule.kt b/detekt-api/src/main/kotlin/io/gitlab/arturbosch/detekt/api/Rule.kt
@@ -1,7 +1,6 @@
 package io.gitlab.arturbosch.detekt.api
 
 import dev.drewhamilton.poko.Poko
-import io.gitlab.arturbosch.detekt.api.internal.isSuppressedBy
 import io.gitlab.arturbosch.detekt.api.internal.validateIdentifier
 import org.jetbrains.kotlin.psi.KtFile
 import org.jetbrains.kotlin.resolve.BindingContext
@@ -45,8 +44,6 @@ open class Rule(
      */
     open val defaultRuleIdAliases: Set<String> = emptySet()
 
-    private val ruleSetId: RuleSet.Id? get() = config.parent?.parentPath?.let(RuleSet::Id)
-
     val autoCorrect: Boolean
         get() = config.valueOrDefault(Config.AUTO_CORRECT_KEY, false) &&
             (config.parent?.valueOrDefault(Config.AUTO_CORRECT_KEY, true) != false)
@@ -100,16 +97,10 @@ open class Rule(
     }
 
     /**
-     * Reports a single code smell finding.
-     *
-     * Before adding a finding, it is checked if it is not suppressed
-     * by @Suppress or @SuppressWarnings annotations.
+     * Adds a code smell to the findings,
      */
     fun report(finding: Finding) {
-        val ktElement = finding.entity.ktElement
-        if (ktElement == null || !ktElement.isSuppressedBy(ruleId, aliases, ruleSetId)) {
-            findings.add(finding)
-        }
+        findings.add(finding)
     }
 
     @Poko

diff --git a/detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/Analyzer.kt b/detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/Analyzer.kt
@@ -14,11 +14,11 @@ import io.gitlab.arturbosch.detekt.api.Rule
 import io.gitlab.arturbosch.detekt.api.RuleSet
 import io.gitlab.arturbosch.detekt.api.RuleSetProvider
 import io.gitlab.arturbosch.detekt.api.Severity
-import io.gitlab.arturbosch.detekt.api.internal.isSuppressedBy
 import io.gitlab.arturbosch.detekt.api.internal.whichDetekt
 import io.gitlab.arturbosch.detekt.api.internal.whichJava
 import io.gitlab.arturbosch.detekt.api.internal.whichOS
 import io.gitlab.arturbosch.detekt.core.suppressors.buildSuppressors
+import io.gitlab.arturbosch.detekt.core.suppressors.isSuppressedBy
 import io.gitlab.arturbosch.detekt.core.util.isActiveOrDefault
 import io.gitlab.arturbosch.detekt.core.util.shouldAnalyzeFile
 import org.jetbrains.kotlin.config.languageVersionSettings
@@ -115,6 +115,9 @@ internal class Analyzer(
 
         return (correctableRules + otherRules).flatMap { (ruleInfo, rule) ->
             rule.visitFile(file, bindingContext, compilerResources)
+                .filterNot {
+                    it.entity.ktElement?.isSuppressedBy(ruleInfo.id, rule.aliases, ruleInfo.ruleSetId) == true
+                }
                 .filterSuppressedFindings(rule, bindingContext)
                 .map { it.toIssue(ruleInfo, rule.computeSeverity()) }
         }

diff --git a/...bosch/detekt/api/internal/Suppressions.kt → ...h/detekt/core/suppressors/Suppressions.kt b/...bosch/detekt/api/internal/Suppressions.kt → ...h/detekt/core/suppressors/Suppressions.kt
@@ -1,4 +1,4 @@
-package io.gitlab.arturbosch.detekt.api.internal
+package io.gitlab.arturbosch.detekt.core.suppressors
 
 import io.gitlab.arturbosch.detekt.api.Rule
 import io.gitlab.arturbosch.detekt.api.RuleSet

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
@@ -385,6 +385,29 @@ class AnalyzerSpec(val env: KotlinCoreEnvironment) {
             }
             assertThat(findings).isEmpty()
         }
+
+        @ParameterizedTest
+        @ValueSource(strings = ["MaxLineLength", "detekt.MaxLineLength", "MLL", "custom", "all"])
+        fun `when the ktElement is suppressed the issue is not raised`(suppress: String) {
+            val config = yamlConfigFromContent(
+                """
+                    custom:
+                      MaxLineLength:
+                        active: true
+                        maxLineLength: 10
+                        aliases: ["MLL"]
+                """.trimIndent()
+            )
+            val code = """
+                @Suppress("$suppress")
+                fun foo() = Unit
+            """.trimIndent()
+            val findings = createProcessingSettings(config = config).use { settings ->
+                Analyzer(settings, listOf(CustomRuleSetProvider()), emptyList())
+                    .run(listOf(compileContentForTest(code)))
+            }
+            assertThat(findings).isEmpty()
+        }
     }
 }
 

diff --git a/...arturbosch/detekt/core/SuppressionSpec.kt → ...tekt/core/suppressors/SuppressionsSpec.kt b/...arturbosch/detekt/core/SuppressionSpec.kt → ...tekt/core/suppressors/SuppressionsSpec.kt
@@ -1,9 +1,8 @@
-package io.gitlab.arturbosch.detekt.core
+package io.gitlab.arturbosch.detekt.core.suppressors
 
 import io.github.detekt.test.utils.compileContentForTest
 import io.gitlab.arturbosch.detekt.api.Rule
 import io.gitlab.arturbosch.detekt.api.RuleSet
-import io.gitlab.arturbosch.detekt.api.internal.isSuppressedBy
 import org.assertj.core.api.Assertions.assertThat
 import org.jetbrains.kotlin.psi.KtClass
 import org.jetbrains.kotlin.psi.KtElement
@@ -16,7 +15,7 @@ import org.junit.jupiter.api.Test
 import org.junit.jupiter.params.ParameterizedTest
 import org.junit.jupiter.params.provider.ValueSource
 
-class SuppressionSpec {
+class SuppressionsSpec {
 
     private fun KtElement.isSuppressedBy(): Boolean {
         return isSuppressedBy(Rule.Id("RuleId"), setOf("alias1", "alias2"), RuleSet.Id("RuleSetId"))

diff --git a/detekt-rules/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/SuppressingSpec.kt b/detekt-rules/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/SuppressingSpec.kt
diff --git a/detekt-test/src/main/kotlin/io/gitlab/arturbosch/detekt/test/RuleExtensions.kt b/detekt-test/src/main/kotlin/io/gitlab/arturbosch/detekt/test/RuleExtensions.kt
@@ -6,6 +6,8 @@ import io.github.detekt.test.utils.compileForTest
 import io.gitlab.arturbosch.detekt.api.CompilerResources
 import io.gitlab.arturbosch.detekt.api.Finding
 import io.gitlab.arturbosch.detekt.api.Rule
+import io.gitlab.arturbosch.detekt.api.RuleSet
+import io.gitlab.arturbosch.detekt.core.suppressors.isSuppressedBy
 import org.intellij.lang.annotations.Language
 import org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment
 import org.jetbrains.kotlin.config.languageVersionSettings
@@ -25,12 +27,12 @@ fun Rule.compileAndLint(@Language("kotlin") content: String): List<Finding> {
 
 fun Rule.lint(@Language("kotlin") content: String): List<Finding> {
     val ktFile = compileContentForTest(content)
-    return visitFile(ktFile)
+    return visitFile(ktFile).filterSuppressed(this)
 }
 
 fun Rule.lint(path: Path): List<Finding> {
     val ktFile = compileForTest(path)
-    return visitFile(ktFile)
+    return visitFile(ktFile).filterSuppressed(this)
 }
 
 fun Rule.lintWithContext(
@@ -47,7 +49,7 @@ fun Rule.lintWithContext(
 
     val dataFlowValueFactory = DataFlowValueFactoryImpl(languageVersionSettings)
     val compilerResources = CompilerResources(languageVersionSettings, dataFlowValueFactory)
-    return visitFile(ktFile, bindingContext, compilerResources)
+    return visitFile(ktFile, bindingContext, compilerResources).filterSuppressed(this)
 }
 
 fun Rule.compileAndLintWithContext(
@@ -60,4 +62,10 @@ fun Rule.compileAndLintWithContext(
     return lintWithContext(environment, content)
 }
 
-fun Rule.lint(ktFile: KtFile): List<Finding> = visitFile(ktFile)
+fun Rule.lint(ktFile: KtFile): List<Finding> = visitFile(ktFile).filterSuppressed(this)
+
+private fun List<Finding>.filterSuppressed(rule: Rule): List<Finding> {
+    return filterNot {
+        it.entity.ktElement?.isSuppressedBy(rule.ruleId, rule.aliases, RuleSet.Id("NoARuleSetId")) == true
+    }
+}