Suggestions

PicnicSupermarket · Mar 12, 2023 · 74a3a4d · 74a3a4d
1 parent 7eb1eaa
commit 74a3a4d
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 12 deletions.
diff --git a/error-prone-contrib/pom.xml b/error-prone-contrib/pom.xml
@@ -37,6 +37,7 @@
         <dependency>
             <groupId>${groupId.error-prone}</groupId>
             <artifactId>error_prone_test_helpers</artifactId>
+            <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>${project.groupId}</groupId>

diff --git a/error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/BugCheckerRules.java b/error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/BugCheckerRules.java
@@ -3,28 +3,51 @@
 import com.google.errorprone.BugCheckerRefactoringTestHelper;
 import com.google.errorprone.BugCheckerRefactoringTestHelper.FixChooser;
 import com.google.errorprone.BugCheckerRefactoringTestHelper.FixChoosers;
+import com.google.errorprone.refaster.Refaster;
 import com.google.errorprone.refaster.annotation.AfterTemplate;
 import com.google.errorprone.refaster.annotation.BeforeTemplate;
 import tech.picnic.errorprone.refaster.annotation.OnlineDocumentation;
 
-/** Refaster rules related to BugChecker classes. */
+/** Refaster rules related to {@link com.google.errorprone.bugpatterns.BugChecker} classes. */
 @OnlineDocumentation
 final class BugCheckerRules {
   private BugCheckerRules() {}
 
   /**
-   * Drop {@link BugCheckerRefactoringTestHelper#setFixChooser(FixChooser)} when set to the default
-   * {@link FixChoosers#FIRST}.
+   * Avoid calling {@link BugCheckerRefactoringTestHelper#setFixChooser(FixChooser)} with the
+   * default value of {@link FixChoosers#FIRST}.
    */
-  static final class SetFixChooserDefault {
+  static final class BugCheckerRefactoringTestHelperIdentity {
     @BeforeTemplate
     BugCheckerRefactoringTestHelper before(BugCheckerRefactoringTestHelper helper) {
-      return helper.setFixChooser(FixChoosers.FIRST);
+      return Refaster.anyOf(
+          helper.setFixChooser(FixChoosers.FIRST), helper.setImportOrder("static-first"));
     }
 
     @AfterTemplate
     BugCheckerRefactoringTestHelper after(BugCheckerRefactoringTestHelper helper) {
       return helper;
     }
   }
+
+  /**
+   * Prefer {@link BugCheckerRefactoringTestHelper.ExpectOutput#expectUnchanged()} over repeating
+   * the input.
+   */
+  // XXX: This rule assumes that the full source code is specified as a single string, e.g. using a
+  // text block. Support for multi-line source code input would require a `BugChecker`
+  // implementation instead.
+  static final class BugCheckerRefactoringTestHelperAddInputLinesExpectUnchanged {
+    @BeforeTemplate
+    BugCheckerRefactoringTestHelper before(
+        BugCheckerRefactoringTestHelper helper, String path, String source) {
+      return helper.addInputLines(path, source).addOutputLines(path, source);
+    }
+
+    @AfterTemplate
+    BugCheckerRefactoringTestHelper after(
+        BugCheckerRefactoringTestHelper helper, String path, String source) {
+      return helper.addInputLines(path, source).expectUnchanged();
+    }
+  }
 }
diff --git a/...rib/src/test/resources/tech/picnic/errorprone/refasterrules/BugCheckerRulesTestInput.java b/...rib/src/test/resources/tech/picnic/errorprone/refasterrules/BugCheckerRulesTestInput.java
@@ -3,7 +3,7 @@
 import com.google.common.collect.ImmutableSet;
 import com.google.errorprone.BugCheckerRefactoringTestHelper;
 import com.google.errorprone.BugCheckerRefactoringTestHelper.FixChoosers;
-import tech.picnic.errorprone.bugpatterns.StringCaseLocaleUsage;
+import com.google.errorprone.bugpatterns.BugChecker;
 import tech.picnic.errorprone.refaster.test.RefasterRuleCollectionTestCase;
 
 final class BugCheckerRulesTest implements RefasterRuleCollectionTestCase {
@@ -12,8 +12,18 @@ public ImmutableSet<?> elidedTypesAndStaticImports() {
     return ImmutableSet.of(FixChoosers.class);
   }
 
-  BugCheckerRefactoringTestHelper testSetFixChooserDefault() {
-    return BugCheckerRefactoringTestHelper.newInstance(StringCaseLocaleUsage.class, getClass())
-        .setFixChooser(FixChoosers.FIRST);
+  ImmutableSet<BugCheckerRefactoringTestHelper> testBugCheckerRefactoringTestHelperIdentity() {
+    return ImmutableSet.of(
+        BugCheckerRefactoringTestHelper.newInstance(BugChecker.class, getClass())
+            .setFixChooser(FixChoosers.FIRST),
+        BugCheckerRefactoringTestHelper.newInstance(BugChecker.class, getClass())
+            .setImportOrder("static-first"));
+  }
+
+  BugCheckerRefactoringTestHelper
+      testBugCheckerRefactoringTestHelperAddInputLinesExpectUnchanged() {
+    return BugCheckerRefactoringTestHelper.newInstance(BugChecker.class, getClass())
+        .addInputLines("A.java", "class A {}")
+        .addOutputLines("A.java", "class A {}");
   }
 }
diff --git a/...ib/src/test/resources/tech/picnic/errorprone/refasterrules/BugCheckerRulesTestOutput.java b/...ib/src/test/resources/tech/picnic/errorprone/refasterrules/BugCheckerRulesTestOutput.java
@@ -3,7 +3,7 @@
 import com.google.common.collect.ImmutableSet;
 import com.google.errorprone.BugCheckerRefactoringTestHelper;
 import com.google.errorprone.BugCheckerRefactoringTestHelper.FixChoosers;
-import tech.picnic.errorprone.bugpatterns.StringCaseLocaleUsage;
+import com.google.errorprone.bugpatterns.BugChecker;
 import tech.picnic.errorprone.refaster.test.RefasterRuleCollectionTestCase;
 
 final class BugCheckerRulesTest implements RefasterRuleCollectionTestCase {
@@ -12,7 +12,16 @@ public ImmutableSet<?> elidedTypesAndStaticImports() {
     return ImmutableSet.of(FixChoosers.class);
   }
 
-  BugCheckerRefactoringTestHelper testSetFixChooserDefault() {
-    return BugCheckerRefactoringTestHelper.newInstance(StringCaseLocaleUsage.class, getClass());
+  ImmutableSet<BugCheckerRefactoringTestHelper> testBugCheckerRefactoringTestHelperIdentity() {
+    return ImmutableSet.of(
+        BugCheckerRefactoringTestHelper.newInstance(BugChecker.class, getClass()),
+        BugCheckerRefactoringTestHelper.newInstance(BugChecker.class, getClass()));
+  }
+
+  BugCheckerRefactoringTestHelper
+      testBugCheckerRefactoringTestHelperAddInputLinesExpectUnchanged() {
+    return BugCheckerRefactoringTestHelper.newInstance(BugChecker.class, getClass())
+        .addInputLines("A.java", "class A {}")
+        .expectUnchanged();
   }
 }