Adding spring factories migration

Author: sanagaraj-pivotal

components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot/upgrade_27_30/report/helper/SpringFactoriesHelper.java

@@ -0,0 +1,67 @@
+/*
+ * 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.boot.upgrade_27_30.report.helper;
+
+import org.springframework.sbm.boot.upgrade_27_30.report.SpringBootUpgradeReportSectionHelper;
+import org.springframework.sbm.common.filter.PathPatternMatchingProjectResourceFinder;
+import org.springframework.sbm.engine.context.ProjectContext;
+import org.springframework.sbm.project.resource.ProjectResource;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Properties;
+
+public class SpringFactoriesHelper extends SpringBootUpgradeReportSectionHelper<List<String>>  {
+
+    private List<String> files;
+
+    @Override
+    public boolean evaluate(ProjectContext context) {
+        List<ProjectResource> search = context
+                .search(
+                        new PathPatternMatchingProjectResourceFinder(
+                                "/**/src/main/resources/META-INF/spring.factories"
+                        ));
+
+        files = search.stream().map(k -> k.getAbsolutePath().toString()).toList();
+
+        return search
+                .stream()
+                .anyMatch(r -> isRightProperty(r.print()));
+    }
+
+    private boolean isRightProperty(String propertyString) {
+
+        Properties prop = new Properties();
+        try {
+            prop.load(new ByteArrayInputStream(propertyString.getBytes()));
+            String enableAutoConfig = prop.getProperty("org.springframework.boot.autoconfigure.EnableAutoConfiguration");
+
+            return enableAutoConfig != null;
+        } catch (IOException e) {
+
+            return false;
+        }
+    }
+
+    @Override
+    public Map<String, List<String>> getData() {
+        return Map.of("files", files);
+    }
+}

components/sbm-recipes-boot-upgrade/src/main/resources/recipes/27_30/migration/sbu30-auto-configuration.yaml

@@ -0,0 +1,9 @@
+- name: sbu30-auto-configuration
+  description: Move EnableAutoConfiguration Property from spring.factories to AutoConfiguration.imports
+  condition:
+    type: org.springframework.sbm.common.migration.conditions.TrueCondition
+  actions:
+    - type: org.springframework.sbm.boot.upgrade.common.actions.CreateAutoconfigurationAction
+      condition:
+        type: org.springframework.sbm.boot.upgrade_27_30.report.helper.SpringFactoriesHelper
+      description: Move EnableAutoConfiguration Property from spring.factories to AutoConfiguration.imports

components/sbm-recipes-boot-upgrade/src/main/resources/recipes/27_30/report/sbu30-report.yaml

@@ -102,17 +102,16 @@
 #          contributors:
 #            - "Fabian Krüger[@fabapp2]"
 
-        - title: Upgrade Dependencies
+        - title: Prepare for Spring 3.0 dependency
           helper: org.springframework.sbm.boot.upgrade_27_30.report.helper.UpgradeDependenciesHelper
           change: |-
-            Spring Boot 3.0 upgraded many used dependencies. 
-            Also, dependencies previously in the `javax` packages use the new `jakarta` packages now.
-            WARNING: THis is a dummy and needs to be replaced with the matching changes from the release notes!
+            Some of the dependencies artifacts are removed/deprecated/moved to new co ordinates, this automated recipe helps prepare SBM to migrate
           affected: |-
-            List the found dependencies here?
+            *
           remediation:
             description: |-
-              A comprehensive list of affected dependencies and their new replacements
+              * adds ehcache classifier
+              * auto corrects right co ordinates of wiremock if used
             recipe: sbu30-upgrade-dependencies
           contributors:
             - "Fabian Krüger[@fabapp2]"
@@ -244,6 +243,28 @@
           contributors:
             - "Fabian Krüger[@fabapp2]"
 
+        - title: Deprecation of Spring.factories
+          helper: org.springframework.sbm.boot.upgrade_27_30.report.helper.SpringFactoriesHelper
+          change: |-
+            In Spring 2.7 custom auto configurations defined in spring.factories file has been moved to `META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports`
+          affected: |-
+            The scan found spring.factories file:
+
+            <#list files as file>
+            * `${file}`
+            </#list>
+          remediation:
+            description: ""
+            possibilities:
+              - title: Move spring.factories properties
+                description: |-
+                  Move the contents of spring.factories file into `org.springframework.boot.autoconfigure.AutoConfiguration.imports`
+                resources:
+                  - https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.7-Release-Notes#auto-configuration-registration[Auto Configuration Registration Docs]
+                recipe: sbu30-auto-configuration
+          gitHubIssue: 150
+          contributors:
+            - "Sandeep Nagaraj[@sanagaraj-pivotal]"
         - title: Banner support
           helper: org.springframework.sbm.boot.upgrade_27_30.report.helper.BannerSupportHelper
           change: |-

components/sbm-recipes-boot-upgrade/src/test/java/org/springframework/sbm/boot/upgrade_27_30/report/helper/SpringFactoriesHelperTest.java

@@ -0,0 +1,51 @@
+/*
+ * 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.boot.upgrade_27_30.report.helper;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.sbm.engine.context.ProjectContext;
+import org.springframework.sbm.java.api.JavaSource;
+import org.springframework.sbm.project.resource.TestProjectContext;
+
+import java.util.List;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class SpringFactoriesHelperTest {
+
+    @Test
+    public void detectsFileWithSpringFactories() {
+
+        ProjectContext context = TestProjectContext.buildProjectContext()
+                .addProjectResource(
+                        "src/main/resources/META-INF/spring.factories",
+                        """
+                                hello.world=something
+                                org.springframework.boot.autoconfigure.EnableAutoConfiguration=XYZ
+                                """
+                )
+                .build();
+
+        SpringFactoriesHelper sut = new SpringFactoriesHelper();
+        boolean evaluate = sut.evaluate(context);
+
+        assertThat(evaluate).isTrue();
+
+        assertThat(sut.getData()).isNotNull();
+        assertThat(sut.getData().get("files")).hasSize(1);
+        assertThat(sut.getData().get("files").get(0)).contains("src/main/resources/META-INF/spring.factories");
+    }
+}