Rework report creation to simplify usage

Author: fabapp2

components/sbm-core/src/main/java/org/springframework/sbm/properties/api/PropertiesSource.java

@@ -28,10 +28,14 @@
 import org.openrewrite.properties.tree.Properties.Entry;
 import org.openrewrite.properties.tree.Properties.File;
 
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.Path;
 import java.util.List;
 import java.util.Optional;
 import java.util.Set;
+import java.util.stream.Collectors;
 
 // TODO: fcoi RewriteSourceFileHolder as member ?!
 @Slf4j
@@ -79,6 +83,17 @@ public Optional<String> getProperty(String key) {
 
     }
 
+    public java.util.Properties getProperties() {
+        String collect = getSourceFile().getContent().stream().map(c -> c.toString()).collect(Collectors.joining());
+        try {
+            java.util.Properties properties = new java.util.Properties(collect.length());
+            properties.load(new ByteArrayInputStream(collect.getBytes(StandardCharsets.UTF_8)));
+            return properties;
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
     private void apply(Recipe r) {
         File rewriteResource = getSourceFile();
         List<Result> results = r.run(List.of(rewriteResource), executionContext).getResults();

components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot/upgrade_27_30/report/ChangesToDataProperties.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.boot.upgrade_27_30.report;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import org.springframework.sbm.boot.properties.api.SpringBootApplicationProperties;
+import org.springframework.sbm.boot.properties.search.SpringBootApplicationPropertiesResourceListFilter;
+import org.springframework.sbm.build.migration.conditions.NoDependencyExistMatchingRegex;
+import org.springframework.sbm.engine.context.ProjectContext;
+import org.springframework.sbm.engine.recipe.Condition;
+
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+/**
+ * @author Fabian Krüger
+ */
+public class ChangesToDataProperties implements Condition, SpringBootUpgradeReportAction.Helper<List<ChangesToDataProperties.Match>> {
+
+    private Map<String, List<Match>> data = new HashMap<>();
+
+    @Override
+    public String getDescription() {
+        return "";
+    }
+
+    @Override
+    public boolean evaluate(ProjectContext context) {
+        boolean noDepExists = new NoDependencyExistMatchingRegex(List.of("org\\.springframework\\.data\\:.*")).evaluate(
+                context);
+        List<SpringBootApplicationProperties> search = context.search(
+                new SpringBootApplicationPropertiesResourceListFilter());
+        search.forEach(p -> {
+            Path absolutePath = p.getAbsolutePath();
+            List<Object> propertiesFound = p
+                    .getProperties()
+                    .keySet()
+                    .stream()
+                    .filter(k -> k.toString().startsWith("spring.data."))
+                    .collect(Collectors.toList());
+
+            if(data.containsKey("matches")) {
+                data.get("matches").add(new Match(absolutePath.toString(), p.getSourcePath().toString(), propertiesFound));
+            } else {
+                List<Match> matches = new ArrayList<>();
+                matches.add(new Match(absolutePath.toString(), p.getSourcePath().toString(), propertiesFound));
+                data.put("matches", matches);
+            }
+        });
+        return noDepExists && !data.isEmpty();
+    }
+
+    @Override
+    public Map<String, List<Match>> getData(ProjectContext context) {
+        return data;
+    }
+
+    @RequiredArgsConstructor
+    @Getter
+    public class Match {
+        private final String absolutePath;
+        private final String relativePath;
+        private final List<Object> propertiesFound;
+    }
+}

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

@@ -0,0 +1,180 @@
+/*
+ * 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;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import freemarker.cache.StringTemplateLoader;
+import freemarker.core.ParseException;
+import freemarker.template.*;
+import lombok.Data;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import lombok.experimental.SuperBuilder;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.ApplicationEventPublisher;
+import org.springframework.sbm.engine.context.ProjectContext;
+import org.springframework.sbm.engine.recipe.Action;
+import org.springframework.sbm.engine.recipe.Condition;
+
+import java.io.IOException;
+import java.io.StringWriter;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * @author Fabian Krüger
+ */
+@Setter
+@Getter
+@SuperBuilder
+@NoArgsConstructor
+public class SpringBootUpgradeReportAction implements Action {
+
+    private Condition condition;
+    @JsonIgnore
+    @Autowired
+    private SpringBootUpgradeReportRenderer upgradeReportRenderer;
+    @JsonIgnore
+    private Configuration configuration;
+    @JsonIgnore
+    private StringTemplateLoader stringLoader;
+
+    @Data
+    @NoArgsConstructor
+    @Getter
+    @Setter
+    public class Section {
+        String title;
+        String info;
+        String reason;
+        String todos;
+        @JsonIgnore
+        Helper helper;
+
+        public String render(ProjectContext context) {
+            if (getHelper().evaluate(context)) {
+                Map<String, Object> params = new HashMap<>();
+                if (getHelper() != null) {
+                    params = getHelper().getData(context);
+                }
+
+                try (StringWriter writer = new StringWriter()) {
+                    stringLoader.putTemplate("section",
+                                             "##" + getTitle() +
+                                                     "\n" +
+                                                     getInfo() +
+                                                     "\n" +
+                                                     getReason() +
+                                                     "\n" +
+                                                     getTodos());
+                    Template t = configuration.getTemplate("section");
+                    t.process(params, writer);
+                    String s = writer.toString();
+                    System.out.println(s);
+                    return s;
+                } catch (TemplateException e) {
+                    throw new RuntimeException(e);
+                } catch (TemplateNotFoundException e) {
+                    throw new RuntimeException(e);
+                } catch (ParseException e) {
+                    throw new RuntimeException(e);
+                } catch (MalformedTemplateNameException e) {
+                    throw new RuntimeException(e);
+                } catch (IOException e) {
+                    throw new RuntimeException(e);
+                }
+            }
+            return "";
+        }
+//        Condition condition;
+//        DataProvider dataProvider;
+    }
+
+    public interface Helper<T> extends Condition {
+        <T> Map<String, T> getData(ProjectContext context);
+    }
+
+    List<Section> sections;
+
+    @Override
+    public String getDescription() {
+        return "The description";
+    }
+
+    @Override
+    public String getDetailedDescription() {
+        return "The detailed description";
+    }
+
+    @Override
+    public Condition getCondition() {
+        return condition;
+    }
+
+    @Override
+    public void apply(ProjectContext context) {
+
+        List<String> renderedSections = new ArrayList<>();
+
+        Version version = new Version("2.3.0");
+        configuration = new Configuration(version);
+        stringLoader = new StringTemplateLoader();
+        configuration.setTemplateLoader(stringLoader);
+
+        sections.stream().forEach(section -> {
+            renderedSections.add(section.render(context));
+        });
+        renderReport(renderedSections, configuration, stringLoader);
+    }
+
+    private void renderReport(List<String> sections, Configuration configuration, StringTemplateLoader stringLoader) {
+        try (StringWriter writer = new StringWriter()) {
+            String content = """
+                <#list sections as changeSection>
+                section: ${changeSection}
+                </#list>
+                """;
+            stringLoader.putTemplate("report", content);
+            Template report = configuration.getTemplate("report");// Template.getPlainTextTemplate("report", content, configuration);
+            report.process(Map.of("sections", sections), writer);
+            String s = writer.toString();
+            System.out.println(s);
+            upgradeReportRenderer.renderReport(s);
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        } catch (TemplateException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    @Override
+    public void applyInternal(ProjectContext context) {
+        apply(context);
+    }
+
+    @Override
+    public ApplicationEventPublisher getEventPublisher() {
+        return null;
+    }
+
+    @Override
+    public boolean isAutomated() {
+        return false;
+    }
+}

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

@@ -0,0 +1,78 @@
+/*
+ * 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;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ArrayNode;
+import org.springframework.beans.factory.config.AutowireCapableBeanFactory;
+import org.springframework.sbm.engine.recipe.Action;
+import org.springframework.sbm.engine.recipe.ActionDeserializer;
+import org.springframework.stereotype.Component;
+
+import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
+
+/**
+ * @author Fabian Krüger
+ */
+@Component
+public class SpringBootUpgradeReportActionDeserializer implements ActionDeserializer {
+    @Override
+    public Action deserialize(ObjectMapper tolerantObjectMapper, Class<? extends Action> actionClass, JsonNode node, AutowireCapableBeanFactory beanFactory) {
+        try {
+            SpringBootUpgradeReportAction action = (SpringBootUpgradeReportAction) tolerantObjectMapper.convertValue(node, actionClass);
+            JsonNode sections = node.get("sections");
+            if (sections != null) {
+                if(ArrayNode.class.isInstance(sections)) {
+                    ArrayNode arrayNode = (ArrayNode) sections;
+                    for(int i=0; i < arrayNode.size(); i++) {
+                        JsonNode helper = arrayNode.get(i).get("helper");
+                        String type = helper.textValue();
+                        Class<?> aClass = Class.forName(type);
+                        Constructor<?> constructor = aClass.getConstructor(null);
+                        Object o = constructor.newInstance();
+                        SpringBootUpgradeReportAction.Helper cast = (SpringBootUpgradeReportAction.Helper) aClass.cast(o);
+                        action.getSections().get(i).setHelper(cast);
+                    }
+                }
+//                YamlResourceLoader yamlResourceLoader = new YamlResourceLoader(
+//                        new ByteArrayInputStream(sections.toString().getBytes(StandardCharsets.UTF_8)),
+//                        URI.create("recipe.yaml"), new Properties());
+//                String type = sections.textValue();
+//                ((MultiModuleHandler) o).setAction(action);
+            } else {
+                throw new IllegalArgumentException("Could not find required field 'sections' for SpringBootUpgradeReportAction with description '"+action.getDescription()+"'.");
+            }
+            return action;
+        } catch (ClassNotFoundException e) {
+            throw new RuntimeException(e);
+        } catch (NoSuchMethodException e) {
+            throw new RuntimeException(e);
+        } catch (InvocationTargetException e) {
+            throw new RuntimeException(e);
+        } catch (InstantiationException e) {
+            throw new RuntimeException(e);
+        } catch (IllegalAccessException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    @Override
+    public boolean canHandle(Class<? extends Action> key) {
+        return SpringBootUpgradeReportAction.class.isAssignableFrom(key);
+    }
+}