Merge pull request #5 from TomasHofman/external-service

SET-218 Refactored logger configuration and HTML processor

Author: TomasHofman

core/src/main/java/org/jboss/set/mavendependencyupdater/core/aggregation/ComponentUpgradeAggregator.java

@@ -0,0 +1,50 @@
+package org.jboss.set.mavendependencyupdater.core.aggregation;
+
+import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
+import org.jboss.set.mavendependencyupdater.DependencyEvaluator.ComponentUpgrade;
+import org.jboss.set.mavendependencyupdater.LocatedDependency;
+import org.jboss.set.mavendependencyupdater.PomDependencyUpdater;
+
+import java.io.File;
+import java.io.IOException;
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Optional;
+import java.util.Set;
+
+public class ComponentUpgradeAggregator {
+
+    /**
+     * Aggregates component upgrades based on which properties they would update in the POM file.
+     *
+     * E.g. if a subset of component upgrades would lead to upgrading of the same property, only the first component
+     * upgrade in this subset would be present in the resulting list.
+     *
+     * @param pomFile POM file being updated
+     * @param upgrades list of component upgrades to be aggregated
+     * @return aggregated list
+     */
+    public static List<ComponentUpgrade> aggregateComponentUpgrades(File pomFile, List<ComponentUpgrade> upgrades)
+            throws IOException, XmlPullParserException {
+        final URI uri = pomFile.toURI();
+        final Set<ModifiedProperty> modifiedProperties = new HashSet<>();
+        final List<ComponentUpgrade> aggregatedUpgrades = new ArrayList<>();
+
+        for (ComponentUpgrade upgrade: upgrades) {
+            Optional<LocatedDependency> locatedDependencyOpt =
+                    PomDependencyUpdater.locateDependency(pomFile, upgrade.getArtifact());
+            if (locatedDependencyOpt.isPresent()) {
+                LocatedDependency locatedDependency = locatedDependencyOpt.get();
+                boolean added = modifiedProperties.add(
+                        new ModifiedProperty(uri, locatedDependency.getProfile(), locatedDependency.getVersionProperty(), upgrade.getNewVersion()));
+                if (added) {
+                    aggregatedUpgrades.add(upgrade);
+                }
+            }
+        }
+
+        return aggregatedUpgrades;
+    }
+}

core/src/main/java/org/jboss/set/mavendependencyupdater/core/aggregation/ModifiedProperty.java

@@ -0,0 +1,53 @@
+package org.jboss.set.mavendependencyupdater.core.aggregation;
+
+import org.apache.commons.lang3.builder.EqualsBuilder;
+import org.apache.commons.lang3.builder.HashCodeBuilder;
+
+import java.net.URI;
+
+/**
+ * Identifies a property in a particular POM file and a profile.
+ *
+ * It's used to record properties that would be changed by a component upgrade, to detect that given property would
+ * have already been changed by a previous component upgrade.
+ */
+class ModifiedProperty {
+
+    final private URI pomUri;
+    final private String profile;
+    final private String propertyName;
+    final private String newValue;
+
+    ModifiedProperty(URI pomUri, String profile, String propertyName, String newValue) {
+        this.pomUri = pomUri;
+        this.profile = profile;
+        this.propertyName = propertyName;
+        this.newValue = newValue;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+
+        if (o == null || getClass() != o.getClass()) return false;
+
+        ModifiedProperty that = (ModifiedProperty) o;
+
+        return new EqualsBuilder()
+                .append(pomUri, that.pomUri)
+                .append(profile, that.profile)
+                .append(propertyName, that.propertyName)
+                .append(newValue, that.newValue)
+                .isEquals();
+    }
+
+    @Override
+    public int hashCode() {
+        return new HashCodeBuilder(17, 37)
+                .append(pomUri)
+                .append(profile)
+                .append(propertyName)
+                .append(newValue)
+                .toHashCode();
+    }
+}

core/src/main/java/org/jboss/set/mavendependencyupdater/core/processingstrategies/HtmlReportProcessingStrategy.java

@@ -1,7 +1,9 @@
 package org.jboss.set.mavendependencyupdater.core.processingstrategies;
 
+import j2html.tags.DomContent;
 import org.jboss.set.mavendependencyupdater.DependencyEvaluator.ComponentUpgrade;
 import org.jboss.set.mavendependencyupdater.configuration.Configuration;
+import org.jboss.set.mavendependencyupdater.core.aggregation.ComponentUpgradeAggregator;
 
 import java.io.File;
 import java.io.PrintStream;
@@ -40,7 +42,7 @@ public class HtmlReportProcessingStrategy extends TextReportProcessingStrategy {
     private static final String CAPTION_STYLES = "text-align: left;" +
             "font-weight: bold;";
     private static final String TH_TD_STYLES = "border-bottom: 1px solid #ddd;" +
-            "padding: 10px;" +
+            "padding: 5px;" +
             "text-align: left;";
     private static final String GAV_STYLES = "font-family: \"Courier New\";";
     private static final String UL_STYLES = "list-style-type: circle;";
@@ -82,6 +84,8 @@ public boolean process(List<ComponentUpgrade> upgrades) {
             List<ComponentUpgrade> sortedUpgrades =
                     upgrades.stream().sorted(new ComponentUpgradeComparator())
                             .collect(Collectors.toList());
+            List<ComponentUpgrade> aggregatedUpgrades = ComponentUpgradeAggregator.aggregateComponentUpgrades(pomFile, sortedUpgrades);
+
 
             String html = div().withStyle(BASIC_STYLES).with(
                     h2("Component Upgrade Report"),
@@ -96,29 +100,9 @@ public boolean process(List<ComponentUpgrade> upgrades) {
                     ),
                     table().withStyle(BASIC_STYLES + TABLE_STYLES).with(
                             caption("Possible Component Upgrades").withStyle(CAPTION_STYLES),
-                            thead(tr().with(
-                                    th("GAV").withStyle(TH_TD_STYLES),
-                                    th("New Version").withStyle(TH_TD_STYLES),
-                                    th("Repository").withStyle(TH_TD_STYLES),
-                                    th("Since").withStyle(TH_TD_STYLES)
-                            )),
-                            each(sortedUpgrades, upgrade -> {
-                                boolean isNew = upgrade.getFirstSeen() == null;
-                                return tr().with(
-                                        td(upgrade.getArtifact().getGroupId()
-                                                + ":" + upgrade.getArtifact().getArtifactId()
-                                                + ":" + upgrade.getArtifact().getVersionString())
-                                                .withStyle(TH_TD_STYLES + GAV_STYLES + (isNew ? BG_NEW : "")),
-                                        td(upgrade.getNewVersion())
-                                                .withStyle(TH_TD_STYLES + (isNew ? BG_NEW : "")),
-                                        td(span(upgrade.getRepository())
-                                                .withStyle(REPO_LABEL_STYLES + repositoryColor(upgrade.getRepository())))
-                                                .withStyle(TH_TD_STYLES + (isNew ? BG_NEW : "")),
-                                        td(upgrade.getFirstSeen() == null ? "new" : upgrade.getFirstSeen().format(DATE_FORMATTER))
-                                                .withStyle(TH_TD_STYLES + (isNew ? BG_NEW : ""))
-                                );
-                            }),
-                            tr(td(sortedUpgrades.size() + " items").withStyle(TH_TD_STYLES).attr("colspan", "4"))),
+                            thead(tr().with(tableHeaders())),
+                            each(aggregatedUpgrades, upgrade -> tr().with(tableRowData(upgrade))),
+                            tr(td(aggregatedUpgrades.size() + " items").withStyle(TH_TD_STYLES).attr("colspan", "4"))),
                     p("Generated on " + DATE_FORMATTER.format(ZonedDateTime.now())),
                     p().withStyle(FOOTER_STYLES).with(
                             text("Report generated by "),
@@ -138,6 +122,37 @@ public boolean process(List<ComponentUpgrade> upgrades) {
         }
     }
 
+    private DomContent[] tableHeaders() {
+        ArrayList<DomContent> headers = new ArrayList<>();
+        headers.add(th("GAV").withStyle(TH_TD_STYLES));
+        headers.add(th("New Version").withStyle(TH_TD_STYLES));
+        headers.add(th("Repository").withStyle(TH_TD_STYLES));
+        if (configuration.getLogger().isActive()) {
+            headers.add(th("Since").withStyle(TH_TD_STYLES));
+        }
+        return headers.toArray(new DomContent[]{});
+    }
+
+    private DomContent[] tableRowData(ComponentUpgrade upgrade) {
+        boolean isNew = upgrade.getFirstSeen() == null && configuration.getLogger().isActive();
+
+        ArrayList<DomContent> cells = new ArrayList<>();
+        cells.add(td(upgrade.getArtifact().getGroupId()
+                + ":" + upgrade.getArtifact().getArtifactId()
+                + ":" + upgrade.getArtifact().getVersionString())
+                .withStyle(TH_TD_STYLES + GAV_STYLES + (isNew ? BG_NEW : "")));
+        cells.add(td(upgrade.getNewVersion())
+                .withStyle(TH_TD_STYLES + (isNew ? BG_NEW : "")));
+        cells.add(td(span(upgrade.getRepository())
+                        .withStyle(REPO_LABEL_STYLES + repositoryColor(upgrade.getRepository())))
+                        .withStyle(TH_TD_STYLES + (isNew ? BG_NEW : "")));
+        if (configuration.getLogger().isActive()) {
+            cells.add(td(upgrade.getFirstSeen() == null ? "new" : upgrade.getFirstSeen().format(DATE_FORMATTER))
+                    .withStyle(TH_TD_STYLES + (isNew ? BG_NEW : "")));
+        }
+        return cells.toArray(new DomContent[]{});
+    }
+
     private void initRepositoryKeys() {
         repositoryKeys = new ArrayList<>(configuration.getRepositories().keySet());
     }

core/src/main/java/org/jboss/set/mavendependencyupdater/core/processingstrategies/TextReportProcessingStrategy.java

@@ -1,26 +1,19 @@
 package org.jboss.set.mavendependencyupdater.core.processingstrategies;
 
-import org.apache.commons.lang3.builder.EqualsBuilder;
-import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.commonjava.maven.atlas.ident.ref.ArtifactRef;
 import org.jboss.logging.Logger;
 import org.jboss.set.mavendependencyupdater.DependencyEvaluator.ComponentUpgrade;
-import org.jboss.set.mavendependencyupdater.LocatedDependency;
-import org.jboss.set.mavendependencyupdater.PomDependencyUpdater;
 import org.jboss.set.mavendependencyupdater.configuration.Configuration;
+import org.jboss.set.mavendependencyupdater.core.aggregation.ComponentUpgradeAggregator;
 
 import java.io.File;
 import java.io.FileNotFoundException;
 import java.io.PrintStream;
-import java.net.URI;
 import java.time.ZonedDateTime;
 import java.time.format.DateTimeFormatter;
 import java.util.Comparator;
-import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
-import java.util.Set;
 import java.util.stream.Collectors;
 
 /**
@@ -38,7 +31,6 @@ public class TextReportProcessingStrategy implements UpgradeProcessingStrategy {
 
     final protected File pomFile;
     final protected Configuration configuration;
-    final protected Set<ModifiedProperty> recordedUpdates = new HashSet<>();
     protected PrintStream outputStream;
     protected File outputFile;
 
@@ -83,6 +75,7 @@ public boolean process(List<ComponentUpgrade> upgrades) {
             List<ComponentUpgrade> sortedUpgrades =
                     upgrades.stream().sorted(new ComponentUpgradeComparator())
                             .collect(Collectors.toList());
+            List<ComponentUpgrade> aggregatedUpgrades = ComponentUpgradeAggregator.aggregateComponentUpgrades(pomFile, sortedUpgrades);
 
             outputStream.println("Generated at " + DATE_TIME_FORMATTER.format(ZonedDateTime.now()));
             outputStream.println();
@@ -93,33 +86,18 @@ public boolean process(List<ComponentUpgrade> upgrades) {
             outputStream.println();
             outputStream.println("Possible upgrades:\n");
 
-            int counter = 0;
-            URI uri = pomFile.toURI();
-            for (ComponentUpgrade upgrade : sortedUpgrades) {
-                Optional<LocatedDependency> locatedDependencyOpt =
-                        PomDependencyUpdater.locateDependency(pomFile, upgrade.getArtifact());
+            for (ComponentUpgrade upgrade : aggregatedUpgrades) {
                 ArtifactRef artifact = upgrade.getArtifact();
-                String newVersion = upgrade.getNewVersion();
-                String repoId = upgrade.getRepository();
-
-                if (locatedDependencyOpt.isPresent()) {
-                    LocatedDependency locatedDependency = locatedDependencyOpt.get();
-                    boolean added = recordedUpdates.add(
-                            new ModifiedProperty(uri, locatedDependency.getProfile(), locatedDependency.getVersionProperty(), newVersion));
-                    if (added) {
-                        counter++;
-                        outputStream.println(
-                                String.format("%s:%s:%s -> %s (%s) - %s",
-                                        artifact.getGroupId(), artifact.getArtifactId(), artifact.getVersionString(),
-                                        newVersion, repoId,
-                                        upgrade.getFirstSeen() == null ?
-                                                "new" : "since " + upgrade.getFirstSeen().format(DATE_FORMATTER)
-                                ));
-                    }
-                }
+                outputStream.println(
+                        String.format("%s:%s:%s -> %s (%s) - %s",
+                                artifact.getGroupId(), artifact.getArtifactId(), artifact.getVersionString(),
+                                upgrade.getNewVersion(), upgrade.getRepository(),
+                                upgrade.getFirstSeen() == null ?
+                                        "new" : "since " + upgrade.getFirstSeen().format(DATE_FORMATTER)
+                        ));
             }
 
-            outputStream.println("\n" + counter + " items");
+            outputStream.println("\n" + aggregatedUpgrades.size() + " items");
             outputStream.println("\nReport generated by Maven Dependency Updater");
             outputStream.println(PROJECT_URL);
             return true;
@@ -132,68 +110,24 @@ public boolean process(List<ComponentUpgrade> upgrades) {
         }
     }
 
-    /**
-     * Identifies a property in a particular POM file and a profile.
-     *
-     * It's used to record properties that would be changed by a component upgrade, to detect that given property would
-     * have already been changed by a previous component upgrade.
-     */
-    protected static class ModifiedProperty {
-
-        final private URI pomUri;
-        final private String profile;
-        final private String propertyName;
-        final private String newValue;
-
-        ModifiedProperty(URI pomUri, String profile, String propertyName, String newValue) {
-            this.pomUri = pomUri;
-            this.profile = profile;
-            this.propertyName = propertyName;
-            this.newValue = newValue;
-        }
-
-        @Override
-        public boolean equals(Object o) {
-            if (this == o) return true;
-
-            if (o == null || getClass() != o.getClass()) return false;
-
-            ModifiedProperty that = (ModifiedProperty) o;
-
-            return new EqualsBuilder()
-                    .append(pomUri, that.pomUri)
-                    .append(profile, that.profile)
-                    .append(propertyName, that.propertyName)
-                    .append(newValue, that.newValue)
-                    .isEquals();
-        }
-
-        @Override
-        public int hashCode() {
-            return new HashCodeBuilder(17, 37)
-                    .append(pomUri)
-                    .append(profile)
-                    .append(propertyName)
-                    .append(newValue)
-                    .toHashCode();
-        }
-    }
-
     /**
      * Comparator for sorting component upgrades. Sort primarily by first seen date, then alphabetically.
      */
     protected static class ComponentUpgradeComparator implements Comparator<ComponentUpgrade> {
         @Override
         public int compare(ComponentUpgrade o1, ComponentUpgrade o2) {
+            // order null values first
             if (o1.getFirstSeen() == null && o2.getFirstSeen() == null) {
                 return o1.getArtifact().compareTo(o2.getArtifact());
             } else if (o1.getFirstSeen() == null) {
-                return 1;
-            } else if (o2.getFirstSeen() == null) {
                 return -1;
+            } else if (o2.getFirstSeen() == null) {
+                return 1;
             } else {
-                int res = o1.getFirstSeen().toLocalDate().compareTo(o2.getFirstSeen().toLocalDate());
+                // order by age from new to old
+                int res = -o1.getFirstSeen().toLocalDate().compareTo(o2.getFirstSeen().toLocalDate());
                 if (res == 0) {
+                    // when the date is the same, order alphabetically
                     res = o1.getArtifact().toString().compareTo(o2.getArtifact().toString());
                 }
                 return res;