Fix NoImplicitFunctionReturnType for unit tests

Ivy-Apps · Mar 27, 2024 · 73ed95e · 73ed95e
1 parent dbff4a9
commit 73ed95e
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/src/main/kotlin/com/github/ivy/explicit/rule/NoImplicitFunctionReturnTypeRule.kt b/src/main/kotlin/com/github/ivy/explicit/rule/NoImplicitFunctionReturnTypeRule.kt
@@ -3,6 +3,7 @@ package com.github.ivy.explicit.rule
 import com.github.ivy.explicit.util.Message
 import io.gitlab.arturbosch.detekt.api.*
 import org.jetbrains.kotlin.psi.KtNamedFunction
+import org.jetbrains.kotlin.psi.psiUtil.containingClass
 
 class NoImplicitFunctionReturnTypeRule(config: Config) : Rule(config) {
 
@@ -16,6 +17,12 @@ class NoImplicitFunctionReturnTypeRule(config: Config) : Rule(config) {
 
     override fun visitNamedFunction(function: KtNamedFunction) {
         super.visitNamedFunction(function)
+
+        if (function.isInsideTestClass()) {
+            // Do not report tests
+            return
+        }
+
         // Check if the function has an explicit return type
         if (function.typeReference == null && !function.hasBlockBody() && !function.isLocal) {
             report(
@@ -28,6 +35,10 @@ class NoImplicitFunctionReturnTypeRule(config: Config) : Rule(config) {
         }
     }
 
+    private fun KtNamedFunction.isInsideTestClass(): Boolean {
+        return containingClass()?.name?.endsWith("Test") == true
+    }
+
     private fun failureMessage(function: KtNamedFunction): String = buildString {
         append("The function '${Message.functionSignature(function)}' should declare an explicit return type. ")
         append("Implicit (missing) return types make the code harder to read and reason about. ")

diff --git a/src/test/kotlin/com/github/ivy/explicit/rule/NoImplicitFunctionReturnTypeRuleTest.kt b/src/test/kotlin/com/github/ivy/explicit/rule/NoImplicitFunctionReturnTypeRuleTest.kt
@@ -83,4 +83,23 @@ internal class NoImplicitFunctionReturnTypeRuleTest(private val env: KotlinCoreE
         // then
         findings shouldHaveSize 0
     }
+
+    @Test
+    fun `doesn't report tests with implicit return type`() {
+        // given
+        val code = """
+        class SomeTest {
+            @Test
+            fun `my test`() = runTest {
+                // doesn't matter
+            }
+        }
+        """
+
+        // when
+        val findings = rule.compileAndLintWithContext(env, code)
+
+        // then
+        findings shouldHaveSize 0
+    }
 }