Spring Boot 3 Upgrade Report (#553)

* Spring Boot 3 Upgrade Report Web App
* Section gets removed when running recipe succeeds, closes #551
* Move report generation into runner
* Add button and change Controller to accept all applicable recipes
* Commented out all code related to "run all recipes" button
* Section fades out before being removed
* Related section in sidebar fades out and gets removed
* page scrolls to the next section
* Moved add milestone repository for dependencies and plugins to dedicated recipe
* Moved dependency version updates to dedicated recipe
* Moved dependency version updates to dedicated recipe
* Moved recipe for javax to jakarta package change to dedicated recipe
* Moved recipe migration of spring.data properties to dedicated recipe
* Moved recipe for PagingAndSoprtingRepository to dedicated recipe
* Moved new Spring Boot 3.0 upgrade recipes to dedicated dir
* Renamed Helper to something meaningful and fixed condition
* Added missing properties to applicaiton.properties to enable git support
* Replaced tags with pinned sha for GH actions
* Prevent empty commits, closes #527
* Move ImprovedConstructorBinding into dedicated recipe and fix condition
* Fix condition for PagingAndSorting migration
* Fix condition for migrate jakarta packages migration
* Adjust replace button in SpringBootUpgradeReportTestSupport
* Rename report recipe
* Fix conditoon for PagingAndSortingHelper and use in migration
* Add withBootParentOf to TestProjectContext
* TestProjectContext supports creating pom.xml with spring*boot*parent of given version
* removed unused variable
* Fixed recipes names (#555)
* Fixing PagingAndSortingHelperTest conforming to new finder (#556)
* Add recipe to remove image banner, closes #558
* Fixing TestProjectContext when used to create a multi*module project
* Enhance PomBuilder to throw exception on API misuse
* Enhance RecipeTestSupport to use with declarative rewrite recipe
* Fix type check in ConditionDeserializer
* Moved recipes for Boot 2.7 to 3.0 upgrade to respective dirs
* Add report section and recipe to bump boot version to 3.0
* Add a flag to not re*generate report on first request
* Enhanced DependencyHelper and TestProjectContext to allow adding managed dependencies without given version
* Add upgrade dependencies report and migration
* Fix typo
* Renamed rest*service to spring*boot*upgrade
* Fix BannerSupportReportSectionTest
* Remove freemarker markup from expected output fixes SpringMvcAndWebFluxMatchinChnagesReportSectionTest
* Replace ST parsing with string replace
* rework rendering the list of authors
* Add demo for new Spring Boot Upgrade report
* Set triggermesh flag to false on test teardown
* Moved report recipe to report package (again)
* Delete obsolete file

Co*authored*by: ashakirin <[email protected]>
Co*authored*by: Sandeep Nagaraj <59915704+sanagaraj*[email protected]>

Author: fabapp2

applications/rest-service/commands.txt

@@ -24,7 +24,7 @@
         <relativePath>../../pom.xml</relativePath>
     </parent>
 
-    <artifactId>rest-service</artifactId>
+    <artifactId>spring-boot-upgrade</artifactId>
 
     <packaging>jar</packaging>
 
@@ -71,10 +71,12 @@
                                     <artifactId>spring-asciidoctor-backends</artifactId>
                                 </dependency>
                             </requiresUnpack>
-                            <finalName>spring-boot-upgrade</finalName>
                         </configuration>
                     </execution>
                 </executions>
+                <configuration>
+                    <finalName>spring-boot-upgrade</finalName>
+                </configuration>
             </plugin>
         </plugins>
     </build>

applications/rest-service/src/main/java/org/springframework/sbm/SpringBootMigratorServiceApp.java

@@ -0,0 +1,83 @@
+/*
+ * 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;
+
+import lombok.Getter;
+import lombok.Setter;
+import lombok.Value;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.MediaType;
+import org.springframework.sbm.boot.upgrade_27_30.report.SpringBootUpgradeReportRenderer;
+import org.springframework.sbm.engine.commands.ApplyCommand;
+import org.springframework.sbm.engine.context.ProjectContext;
+import org.springframework.sbm.engine.context.ProjectContextHolder;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.*;
+
+import java.util.List;
+
+@Controller
+@CrossOrigin
+class ReportController{
+
+    @Autowired
+    private ApplyCommand applyCommand;
+    @Autowired
+    private ReportHolder reportHolder;
+
+    @Autowired
+    private ProjectContextHolder contextHolder;
+
+    public static final String REPORT_RECIPE = "sbu30-report";
+
+    private boolean isInitialReport = true;
+
+    @GetMapping(path = "/spring-boot-upgrade", produces = MediaType.TEXT_HTML_VALUE)
+    @ResponseBody
+    public String upgrade() {
+        // Urgh... that's nasty
+        if(!isInitialReport) {
+            applyCommand.execute(contextHolder.getProjectContext(), REPORT_RECIPE);
+        }
+        isInitialReport = false;
+        return reportHolder.getReport();
+    }
+
+    @PostMapping(path = "/spring-boot-upgrade", consumes = MediaType.APPLICATION_FORM_URLENCODED_VALUE, produces = MediaType.TEXT_HTML_VALUE)
+    @ResponseBody
+    public String applyRecipes(@RequestParam("recipeNames[]") String[] recipeNames) {
+        ProjectContext context = contextHolder.getProjectContext();
+        List.of(recipeNames).forEach(recipeName -> applyCommand.execute(context, recipeName));
+        applyCommand.execute(context, REPORT_RECIPE);
+        return reportHolder.getReport();
+    }
+
+    @PostMapping(path = "/spring-boot-upgrade")
+    @ResponseBody
+    public void applyRecipes2(@RequestBody Recipe recipeNames) {
+        ProjectContext context = contextHolder.getProjectContext();
+        recipeNames.getRecipes().forEach(
+                recipeName -> applyCommand.execute(context, recipeName)
+        );
+        applyCommand.execute(context, REPORT_RECIPE);
+    }
+
+    @Getter
+    @Setter
+    static class Recipe {
+        private List<String> recipes;
+    }
+}

applications/rest-service/src/main/resources/banner.txt

@@ -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;
+
+import lombok.RequiredArgsConstructor;
+import org.springframework.boot.ApplicationArguments;
+import org.springframework.boot.ApplicationRunner;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.sbm.engine.commands.ApplyCommand;
+import org.springframework.sbm.engine.commands.ScanCommand;
+import org.springframework.sbm.engine.context.ProjectContext;
+import org.springframework.sbm.engine.context.ProjectContextHolder;
+
+@Configuration
+@RequiredArgsConstructor
+public class SpringBootMigratorRunner implements ApplicationRunner {
+
+    private final ScanCommand scanCommand;
+    private final ProjectContextHolder contextHolder;
+    private final ApplyCommand applyCommand;
+    private final String REPORT_RECIPE = "sbu30-report";
+
+    @Override
+    public void run(ApplicationArguments args) {
+        if (args.getSourceArgs().length == 0) {
+            System.err.println("PLease provide the path to the application as parameter.");
+            return;
+        }
+        String applicationPath = args.getSourceArgs()[0];
+        System.out.println("Scanning " + applicationPath);
+        ProjectContext context = scanCommand.execute(applicationPath);
+        contextHolder.setProjectContext(context);
+        applyCommand.execute(contextHolder.getProjectContext(), REPORT_RECIPE);
+        System.out.println("finished scan. Please open: http://localhost:8080/spring-boot-upgrade");
+    }
+
+
+}

applications/rest-service/src/main/resources/static/css/site.css.map

@@ -0,0 +1,47 @@
+/*
+ * 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;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.Bean;
+import org.springframework.web.servlet.config.annotation.CorsRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+/**
+ * @author Fabian Krüger
+ */
+@SpringBootApplication
+public class SpringBootUpgradeReportApp {
+    public static void main(String[] args) {
+        try {
+            SpringApplication.run(SpringBootUpgradeReportApp.class, args);
+        } catch (Exception exception) {
+            System.err.println(exception.getMessage());
+            exception.printStackTrace();
+        }
+    }
+
+    @Bean
+    public WebMvcConfigurer corsConfigurer() {
+        return new WebMvcConfigurer() {
+            @Override
+            public void addCorsMappings(CorsRegistry registry) {
+                registry.addMapping("/**").allowedMethods("*");
+            }
+        };
+    }
+}

applications/rest-service/pom.xml renamed to applications/spring-boot-upgrade/pom.xml

@@ -27,12 +27,28 @@
 @Component
 @Primary
 public class SpringBootUpgradeReportStringRenderer implements SpringBootUpgradeReportRenderer {
-
     @Autowired
     private ReportHolder reportHolder;
     @Override
     public void processReport(String renderedReport) {
         String htmlReport = UpgradeReportUtil.renderHtml(renderedReport);
+        String closingHeadTag = "</head>";
+
+        String additionalHeader =
+//                "<link rel=\"stylesheet\" href=\"css/button.css\">\n" +
+//                "<script src=\"js/setup2.js\"></script>\n" +
+//                "<script src=\"js/site2.js\"></script>\n" +
+
+//                "<script src=\"js/java.min.js\"></script>\n";
+//        htmlReport = htmlReport.replace(closingHeadTag, additionalHeader + closingHeadTag);
+
+        htmlReport = htmlReport.replace("</body>", """
+                <link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-Zenh87qX5JnK2Jl0vWa8Ck2rdkQ2Bzep5IDxbcnCeuOxjzrPF/et3URy9Bv1WTRi" crossorigin="anonymous">
+                <script src="https://code.jquery.com/jquery-3.6.1.min.js" integrity="sha256-o88AwQnZB+VDvE9tvIXrMQaPlFFSUTR+nldQm1LuPXQ=" crossorigin="anonymous"></script>
+                <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity="sha384-OERcA2EqjJCMA+/3y+gxIOqMEjwtxJY7qPCqsdltbNJuaOe923+mo//f6V8Qbsw3" crossorigin="anonymous"></script>
+                <script src="js/recipe.js"></script>
+                </body>
+                """);
         reportHolder.setReport(htmlReport);
     }
 }

applications/spring-boot-upgrade/src/main/java/org/springframework/sbm/ReportController.java

@@ -0,0 +1,10 @@
+spring.profiles.active=default, core
+spring.application.name=spring-boot-upgrade-report
+# toggle support for git to sync and auto-commit
+sbm.gitSupportEnabled=true
+logging.level.org=ERROR
+logging.level.org.springframework.sbm.logging.MethodCallTraceInterceptor=DEBUG
+logging.level.org.springframework.sbm.logging.StopWatchTraceInterceptor=DEBUG
+logging.level.org.springframework=ERROR
+logging.level.org.openrewrite=ERROR
+logging.level.org.springframework.sbm=ERROR