Merge pull request #11 from hannesa2/fix/issue-380

fix JakeWharton#380 Quick-Fix incorrectly applied in kotlin
hannesa2 · Apr 13, 2021 · d63ce53 · d63ce53
2 parents 784777a + 6f25991
commit d63ce53
Show file tree

Hide file tree

Showing 2 changed files with 94 additions and 1 deletion.
diff --git a/timber-lint/src/main/java/timber/lint/WrongTimberUsageDetector.java b/timber-lint/src/main/java/timber/lint/WrongTimberUsageDetector.java
@@ -662,7 +662,7 @@ private LintFix quickFixIssueLog(UCallExpression logCall) {
       throw new IllegalStateException("android.util.Log overloads should have 2 or 3 arguments");
     }
 
-    String logCallSource = logCall.asSourceString();
+    String logCallSource = logCall.getUastParent().asSourceString();
     LintFix.GroupBuilder fixGrouper = fix().group();
     fixGrouper.add(
         fix().replace().text(logCallSource).shortenNames().reformat(true).with(fixSource1).build());

diff --git a/timber-lint/src/test/java/timber/lint/WrongTimberUsageDetectorTest.kt b/timber-lint/src/test/java/timber/lint/WrongTimberUsageDetectorTest.kt
@@ -51,6 +51,34 @@ class WrongTimberUsageDetectorTest {
             |-     Log.d("TAG", "msg");
             |+     Timber.d("msg");
             |""".trimMargin())
+
+    lint()
+        .files(
+            kt("""
+                |package foo
+                |import android.util.Log
+                |class Example {
+                |  fun log() {
+                |    Log.d("TAG", "msg")
+                |  }
+                |}""".trimMargin())
+        )
+        .issues(WrongTimberUsageDetector.ISSUE_LOG)
+        .run()
+        .expect("""
+            |src/foo/Example.kt:5: Warning: Using 'Log' instead of 'Timber' [LogNotTimber]
+            |    Log.d("TAG", "msg")
+            |    ~~~~~~~~~~~~~~~~~~~
+            |0 errors, 1 warnings""".trimMargin())
+        .expectFixDiffs("""
+            |Fix for src/foo/Example.kt line 5: Replace with Timber.tag("TAG").d("msg"):
+            |@@ -5 +5
+            |-     Log.d("TAG", "msg")
+            |+     Timber.tag("TAG").d("msg")
+            |Fix for src/foo/Example.kt line 5: Replace with Timber.d("msg"):
+            |@@ -5 +5
+            |-     Log.d("TAG", "msg")
+            |+     Timber.d("msg")""".trimMargin())
   }
 
   @Test fun usingAndroidLogWithThreeArguments() {
@@ -82,6 +110,25 @@ class WrongTimberUsageDetectorTest {
             |-     Log.d("TAG", "msg", new Exception());
             |+     Timber.d(new Exception(), "msg");
             |""".trimMargin())
+
+    lint()
+        .files(
+            kt("""
+                |package foo
+                |import android.util.Log
+                |class Example {
+                |  fun log() {
+                |    Log.d("TAG", "msg", Exception())
+                |  }
+                |}""".trimMargin())
+        )
+        .issues(WrongTimberUsageDetector.ISSUE_LOG)
+        .run()
+        .expect("""
+            |src/foo/Example.kt:5: Warning: Using 'Log' instead of 'Timber' [LogNotTimber]
+            |    Log.d("TAG", "msg", Exception())
+            |    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+            |0 errors, 1 warnings""".trimMargin())
   }
 
   @Test fun usingFullyQualifiedAndroidLogWithTwoArguments() {
@@ -112,6 +159,34 @@ class WrongTimberUsageDetectorTest {
             |-     android.util.Log.d("TAG", "msg");
             |+     Timber.d("msg");
             |""".trimMargin())
+
+    lint()
+        .files(
+            kt("""
+                |package foo
+                |class Example {
+                |  fun log() {
+                |    android.util.Log.d("TAG", "msg")
+                |  }
+                |}""".trimMargin())
+        )
+        .issues(WrongTimberUsageDetector.ISSUE_LOG)
+        .run()
+        .expect("""
+            |src/foo/Example.kt:4: Warning: Using 'Log' instead of 'Timber' [LogNotTimber]
+            |    android.util.Log.d("TAG", "msg")
+            |    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+            |0 errors, 1 warnings""".trimMargin())
+        .expectFixDiffs("""
+            |Fix for src/foo/Example.kt line 4: Replace with Timber.tag("TAG").d("msg"):
+            |@@ -4 +4
+            |-     android.util.Log.d("TAG", "msg")
+            |+     Timber.tag("TAG").d("msg")
+            |Fix for src/foo/Example.kt line 4: Replace with Timber.d("msg"):
+            |@@ -4 +4
+            |-     android.util.Log.d("TAG", "msg")
+            |+     Timber.d("msg")
+            |""".trimMargin())
   }
 
   @Test fun usingFullyQualifiedAndroidLogWithThreeArguments() {
@@ -142,6 +217,24 @@ class WrongTimberUsageDetectorTest {
             |-     android.util.Log.d("TAG", "msg", new Exception());
             |+     Timber.d(new Exception(), "msg");
             |""".trimMargin())
+
+    lint()
+        .files(
+            kt("""
+                |package foo
+                |class Example {
+                |  fun log() {
+                |    android.util.Log.d("TAG", "msg", Exception());
+                |  }
+                |}""".trimMargin())
+        )
+        .issues(WrongTimberUsageDetector.ISSUE_LOG)
+        .run()
+        .expect("""
+            |src/foo/Example.kt:4: Warning: Using 'Log' instead of 'Timber' [LogNotTimber]
+            |    android.util.Log.d("TAG", "msg", Exception());
+            |    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+            |0 errors, 1 warnings""".trimMargin())
   }
 
   @Test fun innerStringFormat() {