Do not wrap single active recipe & remove activateAll() (#4349)

* Do not wrap single active recipe & remove `activateAll()` As discovered on openrewrite/rewrite-maven-plugin#816 * Add missing recipe descriptions * Do not expect CompositeRecipe wrapper in data table row * Return Recipe.noop() when there are no activated recipes * Add missing test descriptions * Further test fixes
openrewrite · Jul 24, 2024 · 02914e3 · 02914e3
1 parent f073c00
commit 02914e3
Show file tree

Hide file tree

Showing 13 changed files with 86 additions and 59 deletions.
diff --git a/rewrite-core/src/main/java/org/openrewrite/config/Environment.java b/rewrite-core/src/main/java/org/openrewrite/config/Environment.java
@@ -150,28 +150,30 @@ public Recipe activateRecipes(Iterable<String> activeRecipes) {
             }
         }
         if (!recipesNotFound.isEmpty()) {
+            @SuppressWarnings("deprecation")
             List<String> suggestions = recipesNotFound.stream()
                     .map(r -> recipesByName.keySet().stream()
                             .min(comparingInt(a -> StringUtils.getLevenshteinDistance(a, r)))
                             .orElse(r))
                     .collect(toList());
-            String message = String.format("Recipes not found: %s\nDid you mean: %s",
+            String message = String.format("Recipe(s) not found: %s\nDid you mean: %s",
                     String.join(", ", recipesNotFound),
                     String.join(", ", suggestions));
             throw new RecipeException(message);
         }
+        if (activatedRecipes.isEmpty()) {
+            return Recipe.noop();
+        }
+        if (activatedRecipes.size() == 1) {
+            return activatedRecipes.get(0);
+        }
         return new CompositeRecipe(activatedRecipes);
     }
 
     public Recipe activateRecipes(String... activeRecipes) {
         return activateRecipes(Arrays.asList(activeRecipes));
     }
 
-    //TODO: Nothing uses this and in most cases it would be a bad idea anyway, should consider removing
-    public Recipe activateAll() {
-        return new CompositeRecipe(listRecipes());
-    }
-
     /**
      * @return A list of validations of style names that could be activated.
      */

diff --git a/rewrite-core/src/test/java/org/openrewrite/RecipeLifecycleTest.java b/rewrite-core/src/test/java/org/openrewrite/RecipeLifecycleTest.java
@@ -280,6 +280,7 @@ void canCallImperativeRecipeWithoutArgsFromDeclarative() {
             type: specs.openrewrite.org/v1beta/recipe
             name: test.recipe
             displayName: Test Recipe
+            description: Test Recipe.
             recipeList:
               - org.openrewrite.NoArgRecipe
             """,
@@ -295,6 +296,7 @@ void canCallImperativeRecipeWithUnnecessaryArgsFromDeclarative() {
             type: specs.openrewrite.org/v1beta/recipe
             name: test.recipe
             displayName: Test Recipe
+            description: Test Recipe.
             recipeList:
               - org.openrewrite.NoArgRecipe:
                   foo: bar
@@ -311,6 +313,7 @@ void canCallRecipeWithNoExplicitConstructor() {
             type: specs.openrewrite.org/v1beta/recipe
             name: test.recipe
             displayName: Test Recipe
+            description: Test Recipe.
             recipeList:
               - org.openrewrite.DefaultConstructorRecipe
             """,
@@ -326,18 +329,21 @@ void declarativeRecipeChain() {
             type: specs.openrewrite.org/v1beta/recipe
             name: test.recipe.a
             displayName: Test Recipe
+            description: Test Recipe.
             recipeList:
               - test.recipe.b
             ---
             type: specs.openrewrite.org/v1beta/recipe
             name: test.recipe.b
             displayName: Test Recipe
+            description: Test Recipe.
             recipeList:
               - test.recipe.c
             ---
             type: specs.openrewrite.org/v1beta/recipe
             name: test.recipe.c
             displayName: Test Recipe
+            description: Test Recipe.
             recipeList:
               - org.openrewrite.NoArgRecipe
             """,
@@ -354,6 +360,7 @@ void declarativeRecipeChainAcrossFiles() {
                 type: specs.openrewrite.org/v1beta/recipe
                 name: test.recipe.c
                 displayName: Test Recipe
+                description: Test Recipe.
                 recipeList:
                   - org.openrewrite.NoArgRecipe
                 """.getBytes()),
@@ -363,6 +370,7 @@ void declarativeRecipeChainAcrossFiles() {
                 type: specs.openrewrite.org/v1beta/recipe
                 name: test.recipe.b
                 displayName: Test Recipe
+                description: Test Recipe.
                 recipeList:
                   - test.recipe.c
                 """.getBytes()),
@@ -372,6 +380,7 @@ void declarativeRecipeChainAcrossFiles() {
                 type: specs.openrewrite.org/v1beta/recipe
                 name: test.recipe.a
                 displayName: Test Recipe
+                description: Test Recipe.
                 recipeList:
                   - test.recipe.b
                 """.getBytes()),
@@ -391,7 +400,7 @@ void declarativeRecipeChainFromResources() {
     void declarativeRecipeChainFromResourcesIncludesImperativeRecipesInDescriptors() {
         rewriteRun(spec -> spec.recipeFromResources("test.declarative.sample.a")
             .afterRecipe(recipeRun -> assertThat(recipeRun.getChangeset().getAllResults().get(0)
-              .getRecipeDescriptorsThatMadeChanges().get(0).getRecipeList().get(0).getRecipeList().get(0)
+              .getRecipeDescriptorsThatMadeChanges().get(0).getRecipeList().get(0)
               .getDisplayName()).isEqualTo("Change text")),
           text("Hi", "after"));
     }

diff --git a/rewrite-core/src/test/java/org/openrewrite/config/DeclarativeRecipeTest.java b/rewrite-core/src/test/java/org/openrewrite/config/DeclarativeRecipeTest.java
@@ -159,6 +159,7 @@ void yamlPrecondition() {
             ---
             type: specs.openrewrite.org/v1beta/recipe
             name: org.openrewrite.PreconditionTest
+            description: Test.
             preconditions:
               - org.openrewrite.text.Find:
                   find: 1
@@ -180,6 +181,7 @@ void yamlPreconditionWithScanningRecipe() {
               ---
               type: specs.openrewrite.org/v1beta/recipe
               name: org.openrewrite.PreconditionTest
+              description: Test.
               preconditions:
                 - org.openrewrite.text.Find:
                     find: 1

diff --git a/rewrite-core/src/test/java/org/openrewrite/table/SourceFileResultsTest.java b/rewrite-core/src/test/java/org/openrewrite/table/SourceFileResultsTest.java
@@ -31,26 +31,24 @@ class SourceFileResultsTest implements RewriteTest {
     void hierarchical() {
         rewriteRun(
           spec -> spec
-            .recipe(
-              new ByteArrayInputStream(
+            .recipeFromYaml(
                 //language=yml
                 """
                   type: specs.openrewrite.org/v1beta/recipe
                   name: test.ChangeTextToHello
                   displayName: Change text to hello
                   description: Hello world.
                   recipeList:
-                      - org.openrewrite.text.ChangeText:
-                          toText: Hello!
-                  """.getBytes()
-              ),
+                    - org.openrewrite.text.ChangeText:
+                        toText: Hello!
+                  """,
               "test.ChangeTextToHello"
             ).dataTable(SourcesFileResults.Row.class, rows -> {
-                assertThat(rows).hasSize(2);
+                assertThat(rows).hasSize(1);
                 assertThat(rows.stream().map(SourcesFileResults.Row::getParentRecipe))
-                  .containsExactly("test.ChangeTextToHello", "");
+                  .containsExactly("test.ChangeTextToHello");
                 assertThat(rows.stream().map(SourcesFileResults.Row::getRecipe))
-                  .containsExactly("org.openrewrite.text.ChangeText", "test.ChangeTextToHello");
+                  .containsExactly("org.openrewrite.text.ChangeText");
             }),
           text(
             "Hi",

diff --git a/rewrite-core/src/test/resources/META-INF/rewrite/test-sample-a.yml b/rewrite-core/src/test/resources/META-INF/rewrite/test-sample-a.yml
@@ -18,5 +18,6 @@
 type: specs.openrewrite.org/v1beta/recipe
 name: test.declarative.sample.a
 displayName: Test Recipe
+description: Test Recipe.
 recipeList:
   - test.declarative.sample.b
diff --git a/rewrite-core/src/test/resources/META-INF/rewrite/test-sample-b.yml b/rewrite-core/src/test/resources/META-INF/rewrite/test-sample-b.yml
@@ -18,6 +18,7 @@
 type: specs.openrewrite.org/v1beta/recipe
 name: test.declarative.sample.b
 displayName: Test Recipe
+description: Test Recipe.
 recipeList:
   - org.openrewrite.text.ChangeText:
       toText: after
diff --git a/...te-java-test/src/test/java/org/openrewrite/java/ReplaceStringLiteralWithConstantTest.java b/...te-java-test/src/test/java/org/openrewrite/java/ReplaceStringLiteralWithConstantTest.java
@@ -193,6 +193,7 @@ void replaceStringLiteralWithConstantValueWhenLiteralValueIsNotConfiguredYaml()
           spec -> spec.recipeFromYaml("""
               type: specs.openrewrite.org/v1beta/recipe
               name: org.openrewrite.ReplaceStringLiteralWithConstantList
+              description: Replace string literals with constants.
               recipeList:
                   - org.openrewrite.java.ReplaceStringLiteralWithConstant:
                       fullyQualifiedConstantName: %s
@@ -221,6 +222,7 @@ void replaceStringLiteralWithConstantValueWhenLiteralValueIsConfiguredYaml() {
           spec -> spec.recipeFromYaml("""
               type: specs.openrewrite.org/v1beta/recipe
               name: org.openrewrite.ReplaceStringLiteralWithConstantList
+              description: Replace string literals with constants.
               recipeList:
                   - org.openrewrite.java.ReplaceStringLiteralWithConstant:
                       literalValue: %s

diff --git a/rewrite-java-test/src/test/java/org/openrewrite/java/search/HasJavaVersionTest.java b/rewrite-java-test/src/test/java/org/openrewrite/java/search/HasJavaVersionTest.java
@@ -68,6 +68,7 @@ void declarativePrecondition() {
             ---
             type: specs.openrewrite.org/v1beta/recipe
             name: org.openrewrite.PreconditionTest
+            description: Test.
             preconditions:
               - org.openrewrite.java.search.HasJavaVersion:
                   version: 11
@@ -87,6 +88,7 @@ void declarativePreconditionMatch() {
             ---
             type: specs.openrewrite.org/v1beta/recipe
             name: org.openrewrite.PreconditionTest
+            description: Test.
             preconditions:
               - org.openrewrite.java.search.HasJavaVersion:
                   version: 11
@@ -105,6 +107,7 @@ void combinedWithFindMethod() {
             ---
             type: specs.openrewrite.org/v1beta/recipe
             name: org.openrewrite.CombinedWithFindMethod
+            description: Test.
             recipeList:
               - org.openrewrite.java.search.HasJavaVersion:
                   version: 11
@@ -142,6 +145,7 @@ void combinedWithFindMethodFirst() {
             ---
             type: specs.openrewrite.org/v1beta/recipe
             name: org.openrewrite.CombinedWithFindMethod
+            description: Test.
             recipeList:
               - org.openrewrite.java.search.FindMethods:
                   methodPattern: java.util.List add(..)

diff --git a/rewrite-java-test/src/test/java/org/openrewrite/text/FindAndReplaceJavaTest.java b/rewrite-java-test/src/test/java/org/openrewrite/text/FindAndReplaceJavaTest.java
@@ -53,6 +53,7 @@ void filePatternShouldLimitApplication() {
               type: specs.openrewrite.org/v1beta/recipe
               name: com.yourorg.FindAndReplaceExample
               displayName: Find and replace example
+              description: Test.
               recipeList:
                 - org.openrewrite.text.FindAndReplace:
                     find: blacklist