Merge pull request #41 from diffblue/pcrane/feature/intestsusefactory-annotation

[TG-21232] Add `@InTestsUseFactory` annotation

Author: pcrane

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
         java-version: '8'
 
     - name: Run Spotless Check
-      run: mvn spotless:check
+      run: mvn --batch-mode spotless:check
 
     - name: Compile Project
-      run: mvn compile        
+      run: mvn --batch-mode compile

README.md

@@ -24,7 +24,7 @@ For installation into a Maven project the `provided` scope is recommended so tha
     <dependency>
         <groupId>com.diffblue.cover</groupId>
         <artifactId>cover-annotations</artifactId>
-        <version>1.5.0</version>
+        <version>1.7.0</version>
         <scope>provided</scope>
     </dependency>
 </dependencies>
@@ -36,9 +36,9 @@ For installation into a Gradle project the `compileOnly` and `testImplementation
 
 ```
 dependencies {
-    compileOnly("com.diffblue.cover:cover-annotations:1.6.0")
+    compileOnly("com.diffblue.cover:cover-annotations:1.7.0")
 
-    testImplementation("com.diffblue.cover:cover-annotations:1.6.0")    
+    testImplementation("com.diffblue.cover:cover-annotations:1.7.0")    
 }
 ```
 

pom.xml

@@ -16,7 +16,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.diffblue.cover</groupId>
   <artifactId>cover-annotations</artifactId>
-  <version>1.6.0</version>
+  <version>1.7.0</version>
   <packaging>jar</packaging>
 
   <name>Cover Annotations</name>

src/main/java/com/diffblue/cover/annotations/InTestsUseFactories.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2024-2025 Diffblue Limited.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+package com.diffblue.cover.annotations;
+
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.Repeatable;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ * Identifies factories that should be considered when writing tests for the annotated method.
+ *
+ * @since Diffblue Cover 2024.10.01
+ */
+@Retention(RUNTIME)
+@Target(METHOD)
+@Repeatable(InTestsUseFactories.Repeatable.class)
+public @interface InTestsUseFactories {
+
+  /** Collects multiple {@link InTestsUseFactories} annotations. */
+  @Retention(RUNTIME)
+  @Target(METHOD)
+  @interface Repeatable {
+
+    /** @return the repeated {@link InTestsUseFactories} annotations. */
+    InTestsUseFactories[] value();
+  }
+
+  /** @return The name of the class containing the factory methods. */
+  String className();
+
+  /** @return The method names to use for factory methods. */
+  String[] methodNames();
+}