Introduce utilities to validate Refaster template collections (#43)

The `Refaster` check is now located in the new `refaster-runner` Maven module. The new `refaster-test-support` module exposes `RefasterTemplateCollection#validate`, which for a given template collection validates: - That there exist corresponding `*Test{Input,Output}.java` files. - That each template is exercised by precisely one method in these files.
PicnicSupermarket · Aug 10, 2022 · b06945b · b06945b
1 parent ef562c1
commit b06945b
Show file tree

Hide file tree

Showing 131 changed files with 1,387 additions and 281 deletions.
diff --git a/error-prone-contrib/pom.xml b/error-prone-contrib/pom.xml
@@ -41,15 +41,13 @@
         </dependency>
         <dependency>
             <groupId>${project.groupId}</groupId>
-            <artifactId>refaster-compiler</artifactId>
-            <!-- This dependency is declared only as a hint to Maven that
-            compilation depends on it; see the `maven-compiler-plugin`'s
-            `annotationProcessorPaths` configuration below. -->
+            <artifactId>refaster-support</artifactId>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>${project.groupId}</groupId>
-            <artifactId>refaster-support</artifactId>
+            <artifactId>refaster-test-support</artifactId>
+            <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
@@ -205,15 +203,6 @@
     <build>
         <pluginManagement>
             <plugins>
-                <plugin>
-                    <groupId>com.spotify.fmt</groupId>
-                    <artifactId>fmt-maven-plugin</artifactId>
-                    <configuration>
-                        <additionalSourceDirectories>
-                            <additionalSourceDirectory>${basedir}/src/test/resources</additionalSourceDirectory>
-                        </additionalSourceDirectories>
-                    </configuration>
-                </plugin>
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-compiler-plugin</artifactId>

diff --git a/...one-contrib/src/main/java/tech/picnic/errorprone/refastertemplates/OptionalTemplates.java b/...one-contrib/src/main/java/tech/picnic/errorprone/refastertemplates/OptionalTemplates.java
@@ -113,7 +113,7 @@ Optional<T> after(Iterator<T> it) {
   /** Prefer {@link Optional#filter(Predicate)} over usage of the ternary operator. */
   // XXX: This rule may introduce a compilation error: the `test` expression may reference a
   // non-effectively final variable, which is not allowed in the replacement lambda expression.
-  // Maybe our RefasterCheck should test `compilesWithFix`?
+  // Maybe our `Refaster` checker should test `compilesWithFix`?
   abstract static class TernaryOperatorOptionalPositiveFiltering<T> {
     @Placeholder
     abstract boolean test(T value);
@@ -133,7 +133,7 @@ Optional<T> after(T input) {
   /** Prefer {@link Optional#filter(Predicate)} over usage of the ternary operator. */
   // XXX: This rule may introduce a compilation error: the `test` expression may reference a
   // non-effectively final variable, which is not allowed in the replacement lambda expression.
-  // Maybe our RefasterCheck should test `compilesWithFix`?
+  // Maybe our `Refaster` checker should test `compilesWithFix`?
   abstract static class TernaryOperatorOptionalNegativeFiltering<T> {
     @Placeholder
     abstract boolean test(T value);

diff --git a/error-prone-contrib/src/test/java/tech/picnic/errorprone/bugpatterns/RefasterTest.java b/error-prone-contrib/src/test/java/tech/picnic/errorprone/bugpatterns/RefasterTest.java
diff --git a/...contrib/src/test/java/tech/picnic/errorprone/refastertemplates/RefasterTemplatesTest.java b/...contrib/src/test/java/tech/picnic/errorprone/refastertemplates/RefasterTemplatesTest.java
@@ -0,0 +1,81 @@
+package tech.picnic.errorprone.refastertemplates;
+
+import static java.util.function.Predicate.not;
+
+import com.google.common.collect.ImmutableSet;
+import java.util.stream.Stream;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+import tech.picnic.errorprone.refaster.test.RefasterTemplateCollection;
+
+final class RefasterTemplatesTest {
+  /** The names of all Refaster template groups defined in this module. */
+  private static final ImmutableSet<Class<?>> TEMPLATE_COLLECTIONS =
+      ImmutableSet.of(
+          AssertJTemplates.class,
+          AssertJBigDecimalTemplates.class,
+          AssertJBigIntegerTemplates.class,
+          AssertJBooleanTemplates.class,
+          AssertJByteTemplates.class,
+          AssertJCharSequenceTemplates.class,
+          AssertJDoubleTemplates.class,
+          AssertJEnumerableTemplates.class,
+          AssertJFloatTemplates.class,
+          AssertJIntegerTemplates.class,
+          AssertJLongTemplates.class,
+          AssertJNumberTemplates.class,
+          AssertJMapTemplates.class,
+          AssertJObjectTemplates.class,
+          AssertJOptionalTemplates.class,
+          AssertJShortTemplates.class,
+          AssertJStringTemplates.class,
+          AssertJThrowingCallableTemplates.class,
+          AssortedTemplates.class,
+          BigDecimalTemplates.class,
+          CollectionTemplates.class,
+          ComparatorTemplates.class,
+          DoubleStreamTemplates.class,
+          EqualityTemplates.class,
+          ImmutableListTemplates.class,
+          ImmutableListMultimapTemplates.class,
+          ImmutableMapTemplates.class,
+          ImmutableMultisetTemplates.class,
+          ImmutableSetTemplates.class,
+          ImmutableSetMultimapTemplates.class,
+          ImmutableSortedMapTemplates.class,
+          ImmutableSortedMultisetTemplates.class,
+          ImmutableSortedSetTemplates.class,
+          IntStreamTemplates.class,
+          JUnitTemplates.class,
+          LongStreamTemplates.class,
+          MapEntryTemplates.class,
+          MockitoTemplates.class,
+          MultimapTemplates.class,
+          NullTemplates.class,
+          OptionalTemplates.class,
+          PrimitiveTemplates.class,
+          ReactorTemplates.class,
+          RxJava2AdapterTemplates.class,
+          StreamTemplates.class,
+          StringTemplates.class,
+          TestNGToAssertJTemplates.class,
+          TimeTemplates.class,
+          WebClientTemplates.class);
+
+  // XXX: Create a JUnit extension to automatically discover the template collections in a given
+  // context to make sure the list is exhaustive.
+  private static Stream<Arguments> validateTemplateCollectionTestCases() {
+    // XXX: Drop the filter once we have added tests for AssertJ! We can then also replace this
+    // method with `@ValueSource(classes = {...})`.
+    return TEMPLATE_COLLECTIONS.stream()
+        .filter(not(AssertJTemplates.class::equals))
+        .map(Arguments::arguments);
+  }
+
+  @MethodSource("validateTemplateCollectionTestCases")
+  @ParameterizedTest
+  void validateTemplateCollection(Class<?> clazz) {
+    RefasterTemplateCollection.validate(clazz);
+  }
+}
diff --git a/...sources/tech/picnic/errorprone/refastertemplates/AssertJBigDecimalTemplatesTestInput.java b/...sources/tech/picnic/errorprone/refastertemplates/AssertJBigDecimalTemplatesTestInput.java
@@ -7,6 +7,7 @@
 import com.google.common.collect.ImmutableSet;
 import java.math.BigDecimal;
 import org.assertj.core.api.AbstractBigDecimalAssert;
+import tech.picnic.errorprone.refaster.test.RefasterTemplateTestCase;
 
 final class AssertJBigDecimalTemplatesTest implements RefasterTemplateTestCase {
   @Override

diff --git a/...ources/tech/picnic/errorprone/refastertemplates/AssertJBigDecimalTemplatesTestOutput.java b/...ources/tech/picnic/errorprone/refastertemplates/AssertJBigDecimalTemplatesTestOutput.java
@@ -7,6 +7,7 @@
 import com.google.common.collect.ImmutableSet;
 import java.math.BigDecimal;
 import org.assertj.core.api.AbstractBigDecimalAssert;
+import tech.picnic.errorprone.refaster.test.RefasterTemplateTestCase;
 
 final class AssertJBigDecimalTemplatesTest implements RefasterTemplateTestCase {
   @Override

diff --git a/...sources/tech/picnic/errorprone/refastertemplates/AssertJBigIntegerTemplatesTestInput.java b/...sources/tech/picnic/errorprone/refastertemplates/AssertJBigIntegerTemplatesTestInput.java
@@ -7,6 +7,7 @@
 import com.google.common.collect.ImmutableSet;
 import java.math.BigInteger;
 import org.assertj.core.api.AbstractBigIntegerAssert;
+import tech.picnic.errorprone.refaster.test.RefasterTemplateTestCase;
 
 final class AssertJBigIntegerTemplatesTest implements RefasterTemplateTestCase {
   @Override

diff --git a/...ources/tech/picnic/errorprone/refastertemplates/AssertJBigIntegerTemplatesTestOutput.java b/...ources/tech/picnic/errorprone/refastertemplates/AssertJBigIntegerTemplatesTestOutput.java
@@ -7,6 +7,7 @@
 import com.google.common.collect.ImmutableSet;
 import java.math.BigInteger;
 import org.assertj.core.api.AbstractBigIntegerAssert;
+import tech.picnic.errorprone.refaster.test.RefasterTemplateTestCase;
 
 final class AssertJBigIntegerTemplatesTest implements RefasterTemplateTestCase {
   @Override

diff --git a/.../resources/tech/picnic/errorprone/refastertemplates/AssertJBooleanTemplatesTestInput.java b/.../resources/tech/picnic/errorprone/refastertemplates/AssertJBooleanTemplatesTestInput.java
@@ -4,6 +4,7 @@
 
 import com.google.common.collect.ImmutableSet;
 import org.assertj.core.api.AbstractBooleanAssert;
+import tech.picnic.errorprone.refaster.test.RefasterTemplateTestCase;
 
 final class AssertJBooleanTemplatesTest implements RefasterTemplateTestCase {
   AbstractBooleanAssert<?> testAbstractBooleanAssertIsEqualTo() {

diff --git a/...resources/tech/picnic/errorprone/refastertemplates/AssertJBooleanTemplatesTestOutput.java b/...resources/tech/picnic/errorprone/refastertemplates/AssertJBooleanTemplatesTestOutput.java
@@ -4,6 +4,7 @@
 
 import com.google.common.collect.ImmutableSet;
 import org.assertj.core.api.AbstractBooleanAssert;
+import tech.picnic.errorprone.refaster.test.RefasterTemplateTestCase;
 
 final class AssertJBooleanTemplatesTest implements RefasterTemplateTestCase {
   AbstractBooleanAssert<?> testAbstractBooleanAssertIsEqualTo() {

diff --git a/...est/resources/tech/picnic/errorprone/refastertemplates/AssertJByteTemplatesTestInput.java b/...est/resources/tech/picnic/errorprone/refastertemplates/AssertJByteTemplatesTestInput.java
@@ -6,6 +6,7 @@
 
 import com.google.common.collect.ImmutableSet;
 import org.assertj.core.api.AbstractByteAssert;
+import tech.picnic.errorprone.refaster.test.RefasterTemplateTestCase;
 
 final class AssertJByteTemplatesTest implements RefasterTemplateTestCase {
   @Override

diff --git a/...st/resources/tech/picnic/errorprone/refastertemplates/AssertJByteTemplatesTestOutput.java b/...st/resources/tech/picnic/errorprone/refastertemplates/AssertJByteTemplatesTestOutput.java
@@ -6,6 +6,7 @@
 
 import com.google.common.collect.ImmutableSet;
 import org.assertj.core.api.AbstractByteAssert;
+import tech.picnic.errorprone.refaster.test.RefasterTemplateTestCase;
 
 final class AssertJByteTemplatesTest implements RefasterTemplateTestCase {
   @Override

diff --git a/...urces/tech/picnic/errorprone/refastertemplates/AssertJCharSequenceTemplatesTestInput.java b/...urces/tech/picnic/errorprone/refastertemplates/AssertJCharSequenceTemplatesTestInput.java
@@ -4,6 +4,7 @@
 
 import com.google.common.collect.ImmutableSet;
 import org.assertj.core.api.AbstractAssert;
+import tech.picnic.errorprone.refaster.test.RefasterTemplateTestCase;
 
 final class AssertJCharSequenceTemplatesTest implements RefasterTemplateTestCase {
   void testAssertThatCharSequenceIsEmpty() {