Java: include RepeatedTest, ParameterizedTest, TestFactory, and TestTemplate when identifying JUnit 5 test methods

Author: Jami Cogswell

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

@@ -113,11 +113,36 @@ class JUnitJupiterTestMethod extends Method {
 }
 
 /**
- * A JUnit test class that contains at least one method annotated with
- * `org.junit.jupiter.api.Test`.
+ * A JUnit 5 test method.
+ * A test method is defined by JUnit as "any instance method
+ * that is directly annotated or meta-annotated with `@Test`,
+ * `@RepeatedTest`, `@ParameterizedTest`, `@TestFactory`, or
+ * `@TestTemplate`."
+ * See https://junit.org/junit5/docs/current/user-guide/#writing-tests-definitions
+ */
+class JUnit5TestMethod extends Method {
+  JUnit5TestMethod() {
+    this instanceof JUnitJupiterTestMethod or
+    this.getAnAnnotation()
+        .getType()
+        .hasQualifiedName("org.junit.jupiter.api", ["RepeatedTest", "TestFactory", "TestTemplate"]) or
+    this.getAnAnnotation()
+        .getType()
+        .hasQualifiedName("org.junit.jupiter.params", "ParameterizedTest")
+  }
+}
+
+/**
+ * A JUnit 5 test class.
+ * A test class must contain at least one test method, and
+ * cannot be abstract.
+ * See https://junit.org/junit5/docs/current/user-guide/#writing-tests-definitions
  */
 class JUnit5TestClass extends Class {
-  JUnit5TestClass() { this.getAMethod() instanceof JUnitJupiterTestMethod }
+  JUnit5TestClass() {
+    this.getAMethod() instanceof JUnit5TestMethod and
+    not this.isAbstract()
+  }
 }
 
 /**

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

@@ -16,8 +16,5 @@
 import java
 
 from JUnit5InnerTestClass testClass
-where
-  not testClass.hasAnnotation("org.junit.jupiter.api", "Nested") and
-  // An abstract class should not have a `@Nested` annotation
-  not testClass.isAbstract()
+where not testClass.hasAnnotation("org.junit.jupiter.api", "Nested")
 select testClass, "This JUnit 5 inner test class lacks a '@Nested' annotation."

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

@@ -1,5 +1,11 @@
+import java.util.Collection;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.RepeatedTest;
+import org.junit.jupiter.api.TestFactory;
+import org.junit.jupiter.api.TestTemplate;
 import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
 
 public class AnnotationTest {
   @Nested
@@ -10,12 +16,42 @@ public void test() {
   }
 
   // NON_COMPLIANT: Inner test class is missing `@Nested`
-  public class Test2 {  // $ Alert
+  public class Test2_Test { // $ Alert
     @Test
     public void test() {
     }
   }
 
+  // NON_COMPLIANT: Inner test class is missing `@Nested`
+  public class Test2_RepeatedTest { // $ Alert
+    @RepeatedTest(2)
+    public void test() {
+    }
+  }
+
+  // NON_COMPLIANT: Inner test class is missing `@Nested`
+  public class Test2_ParameterizedTest { // $ Alert
+    @ParameterizedTest
+    @ValueSource(strings = { "" })
+    public void test(String s) {
+    }
+  }
+
+  // NON_COMPLIANT: Inner test class is missing `@Nested`
+  public class Test2_TestFactory { // $ Alert
+    @TestFactory
+    Collection<Object> test() {
+        return null;
+    }
+  }
+
+  // NON_COMPLIANT: Inner test class is missing `@Nested`
+  public class Test2_TestTemplate { // $ Alert
+    @TestTemplate
+    public void test() {
+    }
+  }
+
   public class Test3 { // COMPLIANT: Since it is empty, it is not a test class
   }
 

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

@@ -1 +1,5 @@
-| AnnotationTest.java:13:16:13:20 | Test2 | This JUnit 5 inner test class lacks a '@Nested' annotation. |
+| AnnotationTest.java:19:16:19:25 | Test2_Test | This JUnit 5 inner test class lacks a '@Nested' annotation. |
+| AnnotationTest.java:26:16:26:33 | Test2_RepeatedTest | This JUnit 5 inner test class lacks a '@Nested' annotation. |
+| AnnotationTest.java:33:16:33:38 | Test2_ParameterizedTest | This JUnit 5 inner test class lacks a '@Nested' annotation. |
+| AnnotationTest.java:41:16:41:32 | Test2_TestFactory | This JUnit 5 inner test class lacks a '@Nested' annotation. |
+| AnnotationTest.java:49:16:49:33 | Test2_TestTemplate | This JUnit 5 inner test class lacks a '@Nested' annotation. |