WIP: Add MultiModuleAwareAction for actions dealing with multi-module projects

Author: fabapp2

components/sbm-core/src/main/java/org/springframework/sbm/build/migration/actions/AddDependencies.java

@@ -15,7 +15,6 @@
  */
 package org.springframework.sbm.build.migration.actions;
 
-import org.springframework.sbm.build.api.BuildFile;
 import org.springframework.sbm.build.api.Dependency;
 import org.springframework.sbm.engine.recipe.AbstractAction;
 import org.springframework.sbm.engine.context.ProjectContext;
@@ -39,7 +38,7 @@ public class AddDependencies extends AbstractAction {
 
     @Override
     public void apply(ProjectContext context) {
-        BuildFile buildFile = context.getBuildFile();
-        buildFile.addDependencies(dependencies);
+        dependencies.forEach(d -> context.getBuildFile().addDependency(d));
     }
+
 }

components/sbm-core/src/main/java/org/springframework/sbm/build/migration/actions/AddDependenciesMultiModuleHandler.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2021 - 2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.sbm.build.migration.actions;
+
+import org.springframework.sbm.build.api.ApplicationModules;
+import org.springframework.sbm.build.api.Dependency;
+import org.springframework.sbm.engine.context.ProjectContext;
+
+public interface AddDependenciesMultiModuleHandler {
+    void handle(ProjectContext context, Dependency d);
+}

components/sbm-core/src/main/java/org/springframework/sbm/build/migration/actions/AddDependenciesToApplicationModules.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2021 - 2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.sbm.build.migration.actions;
+
+import org.springframework.sbm.build.api.Dependency;
+import org.springframework.sbm.engine.context.ProjectContext;
+
+public class AddDependenciesToApplicationModules implements AddDependenciesMultiModuleHandler {
+    @Override
+    public void handle(ProjectContext context, Dependency d) {
+        if(!context.getApplicationModules().isSingleModuleApplication()) {
+            context.getApplicationModules().getTopmostApplicationModules().forEach(m -> m.getBuildFile().addDependency(d));
+        }
+    }
+}

components/sbm-core/src/main/java/org/springframework/sbm/build/migration/actions/AddMavenPlugin.java

@@ -20,11 +20,12 @@
 import org.springframework.sbm.engine.context.ProjectContext;
 import lombok.Getter;
 import lombok.Setter;
+import org.springframework.sbm.engine.recipe.MultiModuleAwareAction;
 
 import javax.validation.Valid;
 
 @Getter
-public class AddMavenPlugin extends AbstractAction {
+public class AddMavenPlugin extends MultiModuleAwareAction {
 
     @Setter
     @Valid

components/sbm-core/src/main/java/org/springframework/sbm/build/migration/actions/AddMavenPluginToApplicationModules.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2021 - 2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.sbm.build.migration.actions;
+
+public class AddMavenPluginToApplicationModules implements AddMavenPluginToMultiModuleHandler {
+}

components/sbm-core/src/main/java/org/springframework/sbm/build/migration/actions/AddMavenPluginToMultiModuleHandler.java

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2021 - 2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.sbm.build.migration.actions;
+
+public interface AddMavenPluginToMultiModuleHandler {
+}

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

@@ -23,6 +23,7 @@
 import lombok.experimental.SuperBuilder;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.ApplicationEventPublisher;
+import org.springframework.sbm.engine.context.ProjectContext;
 
 import javax.validation.constraints.NotBlank;
 
@@ -52,6 +53,11 @@ public String getDetailedDescription() {
         return conditionDescription + getDescription();
     }
 
+    @Override
+    public void applyInternal(ProjectContext context) {
+        apply(context);
+    }
+
     @Override
     public boolean isAutomated() {
         return !this.getClass().isAssignableFrom(DisplayDescription.class);

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

@@ -34,7 +34,7 @@ default void applyWithStatusEvent(ProjectContext context) {
             eventPublisher.publishEvent(new ActionStartedEvent(getDescription()));
         }
         try {
-            apply(context);
+            applyInternal(context);
         } catch(Exception e) {
             throw new ActionFailedException("'"+this.getDescription()+"' failed: " + e.getMessage(), e);
         }
@@ -43,6 +43,8 @@ default void applyWithStatusEvent(ProjectContext context) {
         }
     }
 
+    void applyInternal(ProjectContext context);
+
     ApplicationEventPublisher getEventPublisher();
 
     boolean isAutomated();

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

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2021 - 2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.sbm.engine.recipe;
+
+import lombok.Setter;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.sbm.build.api.ApplicationModule;
+import org.springframework.sbm.build.migration.actions.AddDependenciesToApplicationModules;
+import org.springframework.sbm.engine.context.ProjectContext;
+
+public abstract class MultiModuleAwareAction extends AbstractAction {
+
+    @Autowired
+    @Setter
+    private MultiModuleHandler multiModuleHandler;
+
+    @Override
+    public void applyInternal(ProjectContext context) {
+        if (context.getApplicationModules().isSingleModuleApplication()) {
+            apply(context);
+        } else {
+            multiModuleHandler.handle(context);
+        }
+    }
+}

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

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2021 - 2022 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.sbm.engine.recipe;
+
+import org.springframework.sbm.engine.context.ProjectContext;
+
+public interface MultiModuleHandler {
+    void handle(ProjectContext context);
+}

components/sbm-support-boot/src/main/resources/recipes/initialize-spring-boot-migration.yaml

@@ -53,6 +53,8 @@
           artifactId: spring-boot-starter-test
           version: 2.6.3
           scope: test
+      multiModuleHandler:
+        type: org.springframework.sbm.build.migration.actions.AddDependenciesToApplicationModules
       description: Add spring dependencies 'spring-boot-starter' and 'spring-boot-starter-test'.
       detailedDescription: |-
         This code snippet is going to be added to the <dependencies> section in pom.xml
@@ -92,6 +94,8 @@
         plugin:
           groupId: org.springframework.boot
           artifactId: spring-boot-maven-plugin
+      multiModuleHandler:
+        type: org.springframework.sbm.build.migration.actions.AddMavenPluginToApplicationModules
       description: Add Spring Boot Maven plugin.
       detailedDescription: |