Configurable failOnDryRunResults (#52)

* prevent dryRun from caching output so output generation always produces an actionable result
openrewrite · May 6, 2021 · a1e6453 · a1e6453
1 parent 43b17b1
commit a1e6453
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 1 deletion.
diff --git a/plugin/src/main/java/org/openrewrite/gradle/AbstractRewriteTask.java b/plugin/src/main/java/org/openrewrite/gradle/AbstractRewriteTask.java
@@ -41,7 +41,7 @@ public abstract class AbstractRewriteTask extends DefaultTask implements Rewrite
 
     private final Configuration configuration;
     private final SourceSet sourceSet;
-    private final RewriteExtension extension;
+    protected final RewriteExtension extension;
     private final RewriteReflectiveFacade rewrite;
 
     public AbstractRewriteTask(Configuration configuration, SourceSet sourceSet, RewriteExtension extension) {

diff --git a/plugin/src/main/java/org/openrewrite/gradle/RewriteDryRunTask.java b/plugin/src/main/java/org/openrewrite/gradle/RewriteDryRunTask.java
@@ -15,9 +15,11 @@
  */
 package org.openrewrite.gradle;
 
+import org.gradle.api.GradleException;
 import org.gradle.api.artifacts.Configuration;
 import org.gradle.api.logging.Logger;
 import org.gradle.api.logging.Logging;
+import org.gradle.api.specs.Specs;
 import org.gradle.api.tasks.OutputFile;
 import org.gradle.api.tasks.SourceSet;
 import org.gradle.api.tasks.TaskAction;
@@ -43,6 +45,7 @@ public RewriteDryRunTask(Configuration configuration, SourceSet sourceSet, Rewri
         super(configuration, sourceSet, extension);
         setGroup("rewrite");
         setDescription("Dry run the active refactoring recipes to sources within the " + sourceSet.getName() + " SourceSet. No results will be made.");
+        getOutputs().upToDateWhen(Specs.SATISFIES_NONE);
     }
 
     @Override
@@ -108,6 +111,10 @@ public void run() {
             getLog().warn("Report available:");
             getLog().warn(indent(1, patchFile.normalize().toString()));
             getLog().warn("Run 'mvn rewrite:run' to apply the recipes.");
+
+            if (extension.getFailOnDryRunResults()) {
+                throw new GradleException("Applying recipes would make changes. See logs for more details.");
+            }
         }
     }
 }
diff --git a/plugin/src/main/java/org/openrewrite/gradle/RewriteExtension.java b/plugin/src/main/java/org/openrewrite/gradle/RewriteExtension.java
@@ -44,6 +44,8 @@ public class RewriteExtension extends CodeQualityExtension {
      */
     private boolean failOnInvalidActiveRecipes = false;
 
+    private boolean failOnDryRunResults = false;
+
     @SuppressWarnings("unused")
     public RewriteExtension(Project project) {
         this.project = project;
@@ -139,4 +141,13 @@ public boolean getFailOnInvalidActiveRecipes() {
     public void setFailOnInvalidActiveRecipes(boolean failOnInvalidActiveRecipes) {
         this.failOnInvalidActiveRecipes = failOnInvalidActiveRecipes;
     }
+
+    public boolean getFailOnDryRunResults() {
+        return this.failOnDryRunResults;
+    }
+
+    public void setFailOnDryRunResults(boolean failOnDryRunResults) {
+        this.failOnDryRunResults = failOnDryRunResults;
+    }
+
 }