Fix small corner-case in "SerialVersionUIDInSerializableClass" rule, …

…when property was declared inside private object. (#7346)
detekt · Jun 9, 2024 · a896408 · a896408
1 parent 9158f32
commit a896408
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/...ain/kotlin/io/gitlab/arturbosch/detekt/rules/style/SerialVersionUIDInSerializableClass.kt b/...ain/kotlin/io/gitlab/arturbosch/detekt/rules/style/SerialVersionUIDInSerializableClass.kt
@@ -96,7 +96,8 @@ class SerialVersionUIDInSerializableClass(config: Config) : Rule(
                     if (parentDeclaration is KtClass) "class" else "object"
                 )
             )
-        return if (property.isConstant() && isLongProperty(property) && property.isPrivate()) {
+        val isPropertyPrivate = declaration.isPrivate() || property.isPrivate()
+        return if (property.isConstant() && isLongProperty(property) && isPropertyPrivate) {
             null
         } else {
             SerialVersionUIDFindings(

diff --git a/...kotlin/io/gitlab/arturbosch/detekt/rules/style/SerialVersionUIDInSerializableClassSpec.kt b/...kotlin/io/gitlab/arturbosch/detekt/rules/style/SerialVersionUIDInSerializableClassSpec.kt
@@ -240,6 +240,20 @@ class SerialVersionUIDInSerializableClassSpec {
         assertThat(subject.compileAndLint(code)).isEmpty()
     }
 
+    @Test
+    fun `does not report constant in private companion object`() {
+        val code = """
+            import java.io.Serializable
+            
+            class C : Serializable {
+                private companion object {
+                    const val serialVersionUID: Long = 1
+                }
+            }
+        """.trimIndent()
+        assertThat(subject.compileAndLint(code)).isEmpty()
+    }
+
     companion object {
         private const val WRONG_SERIAL_VERSION_UID_MESSAGE =
             "The property `serialVersionUID` signature is not correct. `serialVersionUID` should be " +