Improved error processing for OpenRewrite Adapter actions(#306)

Co-authored-by: Andrei Shakirin <[email protected]>

Author: 2 people

components/sbm-core/src/main/java/org/springframework/sbm/engine/recipe/Action.java

@@ -36,7 +36,11 @@ default void applyWithStatusEvent(ProjectContext context) {
         try {
             apply(context);
         } catch(Exception e) {
-            throw new ActionFailedException("'"+this.getDescription()+"' failed: " + e.getMessage(), e);
+            String message = "'" + this.getDescription() + "' failed: " + e.getMessage();
+            if (eventPublisher != null) {
+                eventPublisher.publishEvent(new ActionFailedEvent(message));
+            }
+            throw new ActionFailedException(message, e);
         }
         if (eventPublisher != null) {
             eventPublisher.publishEvent(new ActionFinishedEvent(getDescription()));

components/sbm-core/src/main/java/org/springframework/sbm/engine/recipe/OpenRewriteDeclarativeRecipeAdapter.java

@@ -18,6 +18,7 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import lombok.*;
+import org.openrewrite.InMemoryExecutionContext;
 import org.openrewrite.Recipe;
 import org.openrewrite.Result;
 import org.openrewrite.SourceFile;
@@ -71,7 +72,9 @@ public void apply(ProjectContext context) {
         }
         Recipe recipe = rewriteYamlRecipe.iterator().next();
         List<? extends SourceFile> rewriteSourceFiles = context.search(new OpenRewriteSourceFilesFinder());
-        List<Result> results = recipe.run(rewriteSourceFiles);
+        List<Result> results = recipe.run(rewriteSourceFiles, new InMemoryExecutionContext((t) -> {
+            throw new RuntimeException(t);
+        }));
         resultMerger.mergeResults(context, results);
     }
 

components/sbm-core/src/test/java/org/springframework/sbm/engine/recipe/ActionTest.java

@@ -0,0 +1,75 @@
+package org.springframework.sbm.engine.recipe;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.mockito.Spy;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.springframework.context.ApplicationEventPublisher;
+import org.springframework.sbm.engine.context.ProjectContext;
+import org.springframework.sbm.engine.events.ActionFailedEvent;
+import org.springframework.sbm.engine.events.ActionStartedEvent;
+
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.mockito.ArgumentMatchers.any;
+
+@ExtendWith(MockitoExtension.class)
+class ActionTest {
+
+    @Spy
+    private ApplicationEventPublisher publisher;
+
+    @Mock
+    ProjectContext projectContext;
+
+    @InjectMocks
+    private TestActionImpl testAction;
+
+    static class TestActionImpl implements Action {
+        private final ApplicationEventPublisher publisher;
+
+        TestActionImpl(ApplicationEventPublisher publisher) {
+            this.publisher = publisher;
+        }
+
+        @Override
+        public String getDescription() {
+            return "Test failing action";
+        }
+
+        @Override
+        public String getDetailedDescription() {
+            return null;
+        }
+
+        @Override
+        public Condition getCondition() {
+            return null;
+        }
+
+        @Override
+        public void apply(ProjectContext context) {
+            throw new RuntimeException("my exception");
+        }
+
+        @Override
+        public ApplicationEventPublisher getEventPublisher() {
+            return publisher;
+        }
+
+        @Override
+        public boolean isAutomated() {
+            return false;
+        }
+    }
+
+    @Test
+    void applyWithStatusEvent() {
+        assertThrows(RuntimeException.class, () -> testAction.applyWithStatusEvent(projectContext));
+
+        Mockito.verify(publisher).publishEvent(any(ActionStartedEvent.class));
+        Mockito.verify(publisher).publishEvent(any(ActionFailedEvent.class));
+    }
+}

components/sbm-core/src/test/java/org/springframework/sbm/engine/recipe/ErrorClass.java

@@ -0,0 +1,20 @@
+package org.springframework.sbm.engine.recipe;
+
+import org.openrewrite.ExecutionContext;
+import org.openrewrite.SourceFile;
+
+import java.util.List;
+
+public class ErrorClass extends org.openrewrite.Recipe {
+
+    @Override
+    public String getDisplayName() {
+        return "NAME";
+    }
+
+    @Override
+    protected List<SourceFile> visit(List<SourceFile> before, ExecutionContext ctx) {
+        ctx.getOnError().accept(new RuntimeException("A problem happened whilst visiting"));
+        return super.visit(before, ctx);
+    }
+}

components/sbm-core/src/test/java/org/springframework/sbm/engine/recipe/OpenRewriteDeclarativeRecipeAdapterTest.java

@@ -16,27 +16,23 @@
 
 package org.springframework.sbm.engine.recipe;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import lombok.Getter;
 import org.junit.jupiter.api.Test;
-import org.openrewrite.Result;
-import org.openrewrite.config.YamlResourceLoader;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.context.ApplicationEventPublisher;
 import org.springframework.sbm.engine.context.ProjectContext;
-import org.springframework.sbm.java.api.JavaSource;
 import org.springframework.sbm.project.RewriteSourceFileWrapper;
 import org.springframework.sbm.project.resource.ResourceHelper;
 import org.springframework.sbm.project.resource.TestProjectContext;
+import org.springframework.stereotype.Component;
 import org.springframework.validation.beanvalidation.CustomValidatorBean;
 
-import java.io.ByteArrayInputStream;
 import java.io.IOException;
-import java.net.URI;
-import java.nio.charset.StandardCharsets;
-import java.util.Collection;
-import java.util.List;
-import java.util.Properties;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
 @SpringBootTest(classes = {
         RecipeParser.class,
@@ -56,7 +52,7 @@ class OpenRewriteDeclarativeRecipeAdapterTest {
     @Test
     void recipeFromYaml() throws IOException {
         String yaml =
-                "- name: test-recipe\n" +
+                        "- name: test-recipe\n" +
                         "  description: Replace deprecated spring.datasource.* properties\n" +
                         "  condition:\n" +
                         "    type: org.springframework.sbm.common.migration.conditions.TrueCondition\n" +
@@ -91,4 +87,42 @@ void recipeFromYaml() throws IOException {
                         "}"
         );
     }
-}
+
+
+    @Test
+    public void propagateExceptionFromOpenRewriteRecipe() throws IOException {
+
+        String actionDescription =
+                "- name: test-recipe\n" +
+                        "  description: Replace deprecated spring.datasource.* properties\n" +
+                        "  condition:\n" +
+                        "    type: org.springframework.sbm.common.migration.conditions.TrueCondition\n" +
+                        "  actions:\n" +
+                        "    - type: org.springframework.sbm.engine.recipe.OpenRewriteDeclarativeRecipeAdapter\n" +
+                        "      condition:\n" +
+                        "        type: org.springframework.sbm.common.migration.conditions.TrueCondition\n" +
+                        "        versionStartingWith: \"2.7.\"\n" +
+                        "      description: Add Spring Milestone Repository and bump parent pom to 3.0.0-M3\n" +
+                        "\n" +
+                        "      openRewriteRecipe: |-\n" +
+                        "        type: specs.openrewrite.org/v1beta/recipe\n" +
+                        "        name: org.openrewrite.java.spring.boot3.data.UpgradeSpringData30\n" +
+                        "        displayName: Upgrade to Spring Data 3.0\n" +
+                        "        description: 'Upgrade to Spring Data to 3.0 from any prior version.'\n" +
+                        "        recipeList:\n" +
+                        "          - org.springframework.sbm.engine.recipe.ErrorClass\n";
+
+        Recipe[] recipes = recipeParser.parseRecipe(actionDescription);
+        assertThat(recipes[0].getActions().get(0)).isInstanceOf(OpenRewriteDeclarativeRecipeAdapter.class);
+        OpenRewriteDeclarativeRecipeAdapter recipeAdapter = (OpenRewriteDeclarativeRecipeAdapter) recipes[0].getActions().get(0);
+
+        String javaSource = "@java.lang.Deprecated\n" +
+                "public class Foo {}";
+
+        ProjectContext context = TestProjectContext.buildProjectContext()
+                .addJavaSource("src/main/java", javaSource)
+                .build();
+
+        assertThrows(RuntimeException.class, () -> recipeAdapter.apply(context));
+    }
+}