Subsume StackTraceElementGetClass into DoNotCall.

This loses the intricate refactorings provided by the former, but standardises on one check. PiperOrigin-RevId: 421787835
google · Jan 14, 2022 · e1d3844 · e1d3844
1 parent 9889e7a
commit e1d3844
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 235 deletions.
diff --git a/core/src/main/java/com/google/errorprone/bugpatterns/DoNotCallChecker.java b/core/src/main/java/com/google/errorprone/bugpatterns/DoNotCallChecker.java
@@ -130,6 +130,11 @@ public class DoNotCallChecker extends BugChecker
                   .onExactClass("java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock")
                   .named("newCondition"),
               "ReadLocks do not support conditions.")
+          .put(
+              instanceMethod().onExactClass("java.lang.StackTraceElement").named("getClass"),
+              "Calling getClass on StackTraceElement returns the Class object for"
+                  + " StackTraceElement, you probably meant to retrieve the class containing the"
+                  + " execution point represented by this stack trace element using getClassName")
           .buildOrThrow();
 
   static final String DO_NOT_CALL = "com.google.errorprone.annotations.DoNotCall";

diff --git a/core/src/main/java/com/google/errorprone/bugpatterns/StackTraceElementGetClass.java b/core/src/main/java/com/google/errorprone/bugpatterns/StackTraceElementGetClass.java
diff --git a/core/src/main/java/com/google/errorprone/scanner/BuiltInCheckerSuppliers.java b/core/src/main/java/com/google/errorprone/scanner/BuiltInCheckerSuppliers.java
@@ -307,7 +307,6 @@
 import com.google.errorprone.bugpatterns.ShortCircuitBoolean;
 import com.google.errorprone.bugpatterns.ShouldHaveEvenArgs;
 import com.google.errorprone.bugpatterns.SizeGreaterThanOrEqualsZero;
-import com.google.errorprone.bugpatterns.StackTraceElementGetClass;
 import com.google.errorprone.bugpatterns.StaticAssignmentInConstructor;
 import com.google.errorprone.bugpatterns.StaticMockMember;
 import com.google.errorprone.bugpatterns.StaticQualifiedUsingExpression;
@@ -726,7 +725,6 @@ public static ScannerSupplier errorChecks() {
           SelfEquals.class,
           ShouldHaveEvenArgs.class,
           SizeGreaterThanOrEqualsZero.class,
-          StackTraceElementGetClass.class,
           StreamToString.class,
           StringBuilderInitWithChar.class,
           SubstringOfZero.class,

diff --git a/core/src/test/java/com/google/errorprone/bugpatterns/DoNotCallCheckerTest.java b/core/src/test/java/com/google/errorprone/bugpatterns/DoNotCallCheckerTest.java
@@ -552,4 +552,22 @@ public void typeArgs_dontCrash() {
             "}")
         .doTest();
   }
+
+  @Test
+  public void positive_getSimpleName_refactoredToGetClassName() {
+    testHelper
+        .addSourceLines(
+            "Test.java",
+            "class Test{",
+            " void f() {",
+            "   try {",
+            "     throw new Exception();",
+            "   } catch (Exception ex) {",
+            "     // BUG: Diagnostic contains: getClassName",
+            "     ex.getStackTrace()[0].getClass().getSimpleName();",
+            "   }",
+            " }",
+            "}")
+        .doTest();
+  }
 }
diff --git a/core/src/test/java/com/google/errorprone/bugpatterns/StackTraceElementGetClassTest.java b/core/src/test/java/com/google/errorprone/bugpatterns/StackTraceElementGetClassTest.java
diff --git a/docs/bugpattern/StackTraceElementGetClass.md b/docs/bugpattern/StackTraceElementGetClass.md