Merge pull request #19 from wordpress-mobile/fix/ignore-enums-in-null…

…annotation-detector Ignore enums in null annotation detector
wordpress-mobile · Mar 13, 2024 · b374448 · b374448
2 parents e668b09 + 13b02ce
commit b374448
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ Pluggable lint module for WordPress-Android.
 * In your build.gradle:
 ```groovy
 dependencies {
-    lintChecks 'org.wordpress:lint:2.0.0' // use version 2.0.0
+    lintChecks 'org.wordpress:lint:2.1.0' // use version 2.1.0
 }
 ```
 

diff --git a/WordPressLint/src/main/java/org/wordpress/android/lint/MissingNullAnnotationDetector.kt b/WordPressLint/src/main/java/org/wordpress/android/lint/MissingNullAnnotationDetector.kt
@@ -12,17 +12,18 @@ import com.android.tools.lint.detector.api.Severity
 import com.android.tools.lint.detector.api.SourceCodeScanner
 import com.android.tools.lint.detector.api.isJava
 import com.intellij.psi.PsiAnnotation
+import com.intellij.psi.PsiEnumConstant
 import com.intellij.psi.PsiPrimitiveType
 import org.jetbrains.uast.UAnnotated
 import org.jetbrains.uast.UAnnotationMethod
 import org.jetbrains.uast.UAnonymousClass
 import org.jetbrains.uast.UElement
-import org.jetbrains.uast.UEnumConstant
 import org.jetbrains.uast.UField
 import org.jetbrains.uast.UMethod
 import org.jetbrains.uast.UParameter
 import org.jetbrains.uast.UVariable
 import org.jetbrains.uast.getContainingUClass
+import org.jetbrains.uast.getContainingUMethod
 
 class MissingNullAnnotationDetector : Detector(), SourceCodeScanner {
     override fun getApplicableUastTypes(): List<Class<out UElement>> = listOf(
@@ -101,7 +102,7 @@ class MissingNullAnnotationDetector : Detector(), SourceCodeScanner {
 private val UVariable.isPrimitive
     get() = type is PsiPrimitiveType
 private val UVariable.isEnum
-    get() = this is UEnumConstant
+    get() = this is PsiEnumConstant
 private val UVariable.isInjected
     get() = annotations.hasInject
 private val UVariable.isConstant
@@ -111,15 +112,23 @@ private val UVariable.isInitializedFinalField
 private val UVariable.requiresNullAnnotation
     get() = !(isPrimitive || isEnum || isConstant || isInitializedFinalField || isInjected)
 
+/* UParameter Extensions */
+private val UParameter.requiresNullAnnotation
+    get() = this.getContainingUMethod()?.uastBody != null
+            && (this as UVariable).requiresNullAnnotation
+
 /* UMethod Extensions */
 private val UMethod.isPrimitive
     get() = returnType is PsiPrimitiveType
 private val UMethod.requiresNullAnnotation
-    get() = this !is UAnnotationMethod && !isPrimitive && !isConstructor
+    get() = this !is UAnnotationMethod && uastBody != null && !isPrimitive && !isConstructor
+            && !isEnum
 private val UMethod.isAnonymousConstructor
     get() = isConstructor && getContainingUClass()?.let { it is UAnonymousClass } == true
 private val UMethod.isInjected
     get() = annotations.hasInject
+private val UMethod.isEnum
+    get() = returnType is PsiEnumConstant
 
 /* UAnnotated Extensions */
 private val UAnnotated.isNullAnnotated

diff --git a/WordPressLint/src/test/java/org/wordpress/android/lint/MissingNullAnnotationDetectorTest.kt b/WordPressLint/src/test/java/org/wordpress/android/lint/MissingNullAnnotationDetectorTest.kt
@@ -271,4 +271,24 @@ class MissingNullAnnotationDetectorTest {
                 .run()
                 .expectClean()
     }
+    @Test
+    fun `it ignores enums`() {
+        lint().files(LintDetectorTest.java("""
+            package test;
+            
+            public enum TrafficLightState {
+                RED,
+                YELLOW,
+                GREEN
+            }
+        """).indented())
+                .issues(
+                        MissingNullAnnotationDetector.MISSING_FIELD_ANNOTATION,
+                        MissingNullAnnotationDetector.MISSING_CONSTRUCTOR_PARAMETER_ANNOTATION,
+                        MissingNullAnnotationDetector.MISSING_METHOD_PARAMETER_ANNOTATION,
+                        MissingNullAnnotationDetector.MISSING_METHOD_RETURN_TYPE_ANNOTATION
+                )
+                .run()
+                .expectClean()
+    }
 }