Improve IgnoredReturnValue (#7285)

detekt · May 20, 2024 · 2c7db38 · 2c7db38
1 parent 83203f0
commit 2c7db38
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 7 deletions.
diff --git a/...s-errorprone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/IgnoredReturnValue.kt b/...s-errorprone/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/IgnoredReturnValue.kt
@@ -116,16 +116,15 @@ class IgnoredReturnValue(config: Config) : Rule(
 
         if (ignoreFunctionCall.any { it.match(resultingDescriptor) }) return
 
-        val annotations = resultingDescriptor.annotations + resultingDescriptor.findPackage().annotations
-        if (resultingDescriptor.annotations.any { it in ignoreReturnValueAnnotations } ||
-            resultingDescriptor.findPackage().annotations.any { it in ignoreReturnValueAnnotations }
-        ) {
-            return
+        val annotations = buildList {
+            addAll(resultingDescriptor.annotations)
+            addAll(resultingDescriptor.findPackage().annotations)
+            addAll(resultingDescriptor.containingDeclaration.annotations)
         }
+        if (annotations.any { it in ignoreReturnValueAnnotations }) return
         if (restrictToConfig &&
             resultingDescriptor.returnType !in returnValueTypes &&
-            annotations.none { it in returnValueAnnotations } &&
-            resultingDescriptor.containingDeclaration.annotations.none { it in returnValueAnnotations }
+            annotations.none { it in returnValueAnnotations }
         ) {
             return
         }

diff --git a/...rorprone/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/IgnoredReturnValueSpec.kt b/...rorprone/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/IgnoredReturnValueSpec.kt
@@ -975,6 +975,33 @@ class IgnoredReturnValueSpec {
             assertThat(findings).isEmpty()
         }
 
+        @Test
+        fun `does not report when a function has a custom annotation on parent`() {
+            val code = """
+                package foo
+                
+                annotation class CustomIgnoreReturn
+                
+                @CustomIgnoreReturn
+                object Foo {
+                    fun listOfChecked(value: String) = listOf(value)
+                }
+                
+                fun foo() : Int {
+                    Foo.listOfChecked("hello")
+                    return 42
+                }
+            """.trimIndent()
+            val rule = IgnoredReturnValue(
+                TestConfig(
+                    "ignoreReturnValueAnnotations" to listOf("*.CustomIgnoreReturn"),
+                    "restrictToConfig" to false,
+                )
+            )
+            val findings = rule.compileAndLintWithContext(env, code)
+            assertThat(findings).isEmpty()
+        }
+
         @Test
         fun `does not report when a function is in ignoreFunctionCall`() {
             val code = """