Merge pull request #516 from jonesbusy/feature/various-cleanup-and-tests

Add is/missing common file conditional recipes and some cleanup

Author: jonesbusy

plugin-modernizer-cli/src/test/java/io/jenkins/tools/pluginmodernizer/cli/CommandLineITCase.java

@@ -339,6 +339,46 @@ public void testDryRunReplaceLibrariesWithApiPlugin(WireMockRuntimeInfo wmRuntim
         }
     }
 
+    @Test
+    public void testDryRunAddDependabot(WireMockRuntimeInfo wmRuntimeInfo) throws Exception {
+
+        Path logFile = setupLogs("testDryRunAddDependabot");
+
+        final String plugin = "empty";
+        final String recipe = "SetupDependabot";
+
+        // Junit attachment with logs file for the plugin build
+        System.out.printf(
+                "[[ATTACHMENT|%s]]%n", Plugin.build(plugin).getLogFile().toAbsolutePath());
+        System.out.printf("[[ATTACHMENT|%s]]%n", logFile.toAbsolutePath());
+
+        try (GitHubServerContainer gitRemote = new GitHubServerContainer(wmRuntimeInfo, keysPath, plugin, "main")) {
+
+            gitRemote.start();
+
+            Invoker invoker = buildInvoker();
+            InvocationRequest request = buildRequest(
+                    "dry-run --recipe %s %s".formatted(recipe, getRunArgs(wmRuntimeInfo, plugin)), logFile);
+            InvocationResult result = invoker.execute(request);
+
+            // Assert output
+            assertAll(
+                    () -> assertEquals(0, result.getExitCode()),
+                    () -> assertTrue(Files.readAllLines(logFile).stream()
+                            .anyMatch(line -> line.matches("(.*)Dry run mode. Changes were commited on (.*)"))));
+
+            // Check that new file was created
+            assertTrue(
+                    Files.exists(cachePath
+                            .resolve("jenkins-plugin-modernizer-cli")
+                            .resolve(plugin)
+                            .resolve("sources")
+                            .resolve(".github")
+                            .resolve("dependabot.yml")),
+                    "Dependabot file was not created");
+        }
+    }
+
     /**
      * Build the invoker
      * @return the invoker

plugin-modernizer-core/pom.xml

@@ -177,8 +177,6 @@
       <version>4.0.1</version>
       <scope>test</scope>
     </dependency>
-
-    <!-- Recipes test dependencies -->
     <dependency>
       <groupId>org.kohsuke.stapler</groupId>
       <artifactId>stapler</artifactId>

plugin-modernizer-core/src/main/java/io/jenkins/tools/pluginmodernizer/core/config/RecipesConsts.java

@@ -0,0 +1,17 @@
+package io.jenkins.tools.pluginmodernizer.core.config;
+
+/**
+ * Constants for the recipes.
+ */
+public final class RecipesConsts {
+
+    /**
+     * Utility class.
+     */
+    private RecipesConsts() {
+        // Utility class
+    }
+
+    public static final String PLUGINS_BOM_GROUP_ID = "io.jenkins.tools.bom";
+    public static final String VERSION_METADATA_PATTERN = "\\.v[a-f0-9_]+";
+}

plugin-modernizer-core/src/main/java/io/jenkins/tools/pluginmodernizer/core/extractor/ArchetypeCommonFile.java

@@ -1,5 +1,7 @@
 package io.jenkins.tools.pluginmodernizer.core.extractor;
 
+import java.nio.file.Path;
+
 /**
  * An archetype repository file with location
  * Used to create metadata and store information about file presence or changes
@@ -108,7 +110,7 @@ public enum ArchetypeCommonFile {
      */
     public static ArchetypeCommonFile fromFile(String file) {
         for (ArchetypeCommonFile f : ArchetypeCommonFile.values()) {
-            if (f.getPath().equals(file)) {
+            if (Path.of(f.getPath()).equals(Path.of(file))) {
                 return f;
             }
         }

plugin-modernizer-core/src/main/java/io/jenkins/tools/pluginmodernizer/core/extractor/ArchetypeCommonFileVisitor.java

@@ -0,0 +1,40 @@
+package io.jenkins.tools.pluginmodernizer.core.extractor;
+
+import org.openrewrite.SourceFile;
+import org.openrewrite.Tree;
+import org.openrewrite.TreeVisitor;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * A tree visitor that visit a tree and populate the metadata with common files.
+ */
+public class ArchetypeCommonFileVisitor extends TreeVisitor<Tree, PluginMetadata> {
+
+    /**
+     * LOGGER.
+     */
+    private static final Logger LOG = LoggerFactory.getLogger(ArchetypeCommonFileVisitor.class);
+
+    @Override
+    public Tree visit(Tree tree, PluginMetadata pluginMetadata) {
+
+        SourceFile sourceFile = (SourceFile) tree;
+
+        ArchetypeCommonFile commonFile =
+                ArchetypeCommonFile.fromFile(sourceFile.getSourcePath().toString());
+
+        // Store common files into metadata
+        if (commonFile != null) {
+            if (pluginMetadata.hasCommonFile(commonFile)) {
+                LOG.debug("File {} is already a common file", sourceFile.getSourcePath());
+            } else {
+                LOG.debug("File {} is a common file", sourceFile.getSourcePath());
+                pluginMetadata.addCommonFile(commonFile);
+            }
+        } else {
+            LOG.debug("File {} is not a common file", sourceFile.getSourcePath());
+        }
+        return tree;
+    }
+}

plugin-modernizer-core/src/main/java/io/jenkins/tools/pluginmodernizer/core/extractor/MetadataFinalizerVisitor.java

@@ -20,17 +20,23 @@ public class MetadataFinalizerVisitor extends TreeVisitor<Tree, ExecutionContext
     @Override
     public Tree visit(Tree tree, ExecutionContext ctx) {
 
+        PluginMetadata mergedMetadata = ctx.getMessage("mergedMetadata", new PluginMetadata());
+        PluginMetadata commonMetadata = ctx.getMessage("commonMetadata", new PluginMetadata());
         PluginMetadata pluginMetadata = ctx.getMessage("pomMetadata", new PluginMetadata());
         PluginMetadata jenkinsFileMetadata = ctx.getMessage("jenkinsFileMetadata", new PluginMetadata());
 
+        // Merge the metadata
         PluginMetadata merged = JsonUtils.fromJson(
                 JsonUtils.merge(pluginMetadata.toJson(), jenkinsFileMetadata.toJson()), PluginMetadata.class);
-        ;
+        merged = JsonUtils.fromJson(JsonUtils.merge(commonMetadata.toJson(), merged.toJson()), PluginMetadata.class);
+        merged = JsonUtils.fromJson(JsonUtils.merge(mergedMetadata.toJson(), merged.toJson()), PluginMetadata.class);
+
         LOG.debug("Merged metadata: {}", JsonUtils.toJson(merged));
 
         // Write the metadata to a file for later use by the plugin modernizer.
         merged.save();
         LOG.debug("Plugin metadata written to {}", merged.getRelativePath());
+        ctx.putMessage("mergedMetadata", merged);
         LOG.debug(JsonUtils.toJson(merged));
 
         return tree;

plugin-modernizer-core/src/main/java/io/jenkins/tools/pluginmodernizer/core/extractor/MetadataVisitor.java

@@ -1,8 +1,6 @@
 package io.jenkins.tools.pluginmodernizer.core.extractor;
 
 import io.jenkins.tools.pluginmodernizer.core.utils.JsonUtils;
-import org.jspecify.annotations.NonNull;
-import org.jspecify.annotations.Nullable;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.PathUtils;
 import org.openrewrite.SourceFile;
@@ -23,40 +21,26 @@ public class MetadataVisitor extends TreeVisitor<Tree, ExecutionContext> {
 
     final PluginMetadata pluginMetadata;
 
+    /**
+     * Constructor.
+     * @param pluginMetadata the plugin metadata
+     */
     public MetadataVisitor(PluginMetadata pluginMetadata) {
         this.pluginMetadata = pluginMetadata;
     }
 
-    @Override
-    public @Nullable Tree postVisit(@NonNull Tree tree, ExecutionContext executionContext) {
-        LOG.debug("Finalizing metadata");
-        return super.postVisit(tree, executionContext);
-    }
-
     @Override
     public Tree visit(Tree tree, ExecutionContext executionContext) {
 
         SourceFile sourceFile = (SourceFile) tree;
 
-        ArchetypeCommonFile commonFile =
-                ArchetypeCommonFile.fromFile(sourceFile.getSourcePath().toString());
-
-        // Store common files into metadata
-        if (commonFile != null) {
-            if (pluginMetadata.hasCommonFile(commonFile)) {
-                LOG.debug("File {} is already a common file", sourceFile.getSourcePath());
-            } else {
-                LOG.debug("File {} is a common file", sourceFile.getSourcePath());
-                pluginMetadata.addCommonFile(commonFile);
-            }
-        } else {
-            LOG.debug("File {} is not a common file", sourceFile.getSourcePath());
-        }
+        // Common metadata
+        PluginMetadata commonMetadata = new ArchetypeCommonFileVisitor().reduce(tree, pluginMetadata);
 
         // Extract metadata from Jenkinsfile
         if (PathUtils.matchesGlob(sourceFile.getSourcePath(), "**/Jenkinsfile")) {
             LOG.debug("Visiting Jenkinsfile {}", sourceFile.getSourcePath());
-            PluginMetadata jenkinsFileMetadata = new JenkinsfileVisitor().reduce(tree, pluginMetadata);
+            PluginMetadata jenkinsFileMetadata = new JenkinsfileVisitor().reduce(tree, commonMetadata);
             LOG.debug("Jenkinsfile metadata: {}", JsonUtils.toJson(jenkinsFileMetadata));
             executionContext.putMessage(
                     "jenkinsFileMetadata", jenkinsFileMetadata); // Is there better than context messaging ?
@@ -66,12 +50,17 @@ public Tree visit(Tree tree, ExecutionContext executionContext) {
         // Extract metadata from POM
         else if (PathUtils.matchesGlob(sourceFile.getSourcePath(), "**/pom.xml")) {
             LOG.debug("Visiting POM {}", sourceFile.getSourcePath());
-            PluginMetadata pomMetadata = new PomResolutionVisitor().reduce(tree, pluginMetadata);
+            PluginMetadata pomMetadata = new PomResolutionVisitor().reduce(tree, commonMetadata);
             LOG.debug("POM metadata: {}", JsonUtils.toJson(pomMetadata));
             executionContext.putMessage("pomMetadata", pomMetadata); // Is there better than context messaging ?
             return tree;
         }
 
+        // Just add the common
+        else {
+            executionContext.putMessage("commonMetadata", commonMetadata); // Is there better than context messaging ?
+        }
+
         return tree;
     }
 }

plugin-modernizer-core/src/main/java/io/jenkins/tools/pluginmodernizer/core/extractor/PomResolutionVisitor.java

@@ -1,5 +1,6 @@
 package io.jenkins.tools.pluginmodernizer.core.extractor;
 
+import io.jenkins.tools.pluginmodernizer.core.config.RecipesConsts;
 import java.util.Map;
 import java.util.Optional;
 import org.openrewrite.marker.Markers;
@@ -60,7 +61,7 @@ public Xml.Document visitDocument(Xml.Document document, PluginMetadata pluginMe
         // Lookup by group ID to set the BOM version if any
         pom.getDependencyManagement().stream()
                 .peek(dependency -> LOG.debug("Dependency: {}", dependency))
-                .filter(dependency -> "io.jenkins.tools.bom".equals(dependency.getGroupId()))
+                .filter(dependency -> RecipesConsts.PLUGINS_BOM_GROUP_ID.equals(dependency.getGroupId()))
                 .findFirst()
                 .ifPresent(dependency -> {
                     pluginMetadata.setBomArtifactId(dependency.getArtifactId());

plugin-modernizer-core/src/main/java/io/jenkins/tools/pluginmodernizer/core/impl/PluginModernizer.java

@@ -50,10 +50,12 @@ public void validate() {
      * List available recipes
      */
     public void listRecipes() {
-        Settings.AVAILABLE_RECIPES.forEach(recipe -> LOG.info(
-                "{} - {}",
-                recipe.getName().replaceAll(Settings.RECIPE_FQDN_PREFIX + ".", ""),
-                recipe.getDescription()));
+        Settings.AVAILABLE_RECIPES.stream()
+                .sorted()
+                .forEach(recipe -> LOG.info(
+                        "{} - {}",
+                        recipe.getName().replaceAll(Settings.RECIPE_FQDN_PREFIX + ".", ""),
+                        recipe.getDescription()));
     }
 
     /**

plugin-modernizer-core/src/main/java/io/jenkins/tools/pluginmodernizer/core/model/Recipe.java

@@ -1,13 +1,32 @@
 package io.jenkins.tools.pluginmodernizer.core.model;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
+import java.util.Objects;
 import java.util.Set;
 
-public class Recipe {
+/**
+ * Our own representation of a recipe.
+ */
+public class Recipe implements Comparable<Recipe> {
 
+    /**
+     * Name of the recipe.
+     */
     private String name;
+
+    /**
+     * Display name of the recipe.
+     */
     private String displayName;
+
+    /**
+     * Description of the recipe.
+     */
     private String description;
+
+    /**
+     * Tags of the recipe.
+     */
     private Set<String> tags;
 
     @JsonIgnore
@@ -85,4 +104,21 @@ public Boolean getCausesAnotherCycle() {
     public void setCausesAnotherCycle(Boolean causesAnotherCycle) {
         this.causesAnotherCycle = causesAnotherCycle;
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (o == null || getClass() != o.getClass()) return false;
+        Recipe recipe = (Recipe) o;
+        return Objects.equals(getName(), recipe.getName());
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hashCode(getName());
+    }
+
+    @Override
+    public int compareTo(Recipe o) {
+        return this.getName().compareTo(o.getName());
+    }
 }