Java: exclude anonymous, local, and private classes

Author: Jami Cogswell

java/ql/lib/semmle/code/java/UnitTests.qll

@@ -120,6 +120,20 @@ class JUnit5TestClass extends Class {
   JUnit5TestClass() { this.getAMethod() instanceof JUnitJupiterTestMethod }
 }
 
+/**
+ * A JUnit inner test class that is non-anonymous, non-local,
+ * and non-private.
+ */
+class JUnit5InnerTestClass extends JUnit5TestClass {
+  JUnit5InnerTestClass() {
+    // `InnerClass` is a non-static nested class.
+    this instanceof InnerClass and
+    not this.isAnonymous() and
+    not this.isLocal() and
+    not this.isPrivate()
+  }
+}
+
 /**
  * A JUnit `@Ignore` annotation.
  */

java/ql/src/Likely Bugs/Frameworks/JUnit/JUnit5MissingNestedAnnotation.ql

@@ -15,10 +15,8 @@
 
 import java
 
-from JUnit5TestClass testClass
+from JUnit5InnerTestClass testClass
 where
-  // `InnerClass` is a non-static, nested class.
-  testClass instanceof InnerClass and
   not testClass.hasAnnotation("org.junit.jupiter.api", "Nested") and
   // An abstract class should not have a `@Nested` annotation
   not testClass.isAbstract()

java/ql/test/query-tests/Likely Bugs/Frameworks/JUnit/AnnotationTest.java

@@ -59,4 +59,32 @@ public abstract class Test8 {
     public void test() {
     }
   }
+
+  interface Test9 {
+  }
+
+  public void f() {
+    // COMPLIANT: anonymous classes are not considered as inner test
+    // classes by JUnit and therefore don't need `@Nested`
+    new Test9() {
+      @Test
+      public void test() {
+      }
+    };
+    // COMPLIANT: local classes are not considered as inner test
+    // classes by JUnit and therefore don't need `@Nested`
+    class Test10 {
+      @Test
+      void test() {
+      }
+    }
+  }
+
+  // COMPLIANT: private classes are not considered as inner test
+  // classes by JUnit and therefore don't need `@Nested`
+  private class Test11 {
+    @Test
+    public void test() {
+    }
+  }
 }