Native support for multi-module Maven projects

pom.xml

@@ -256,14 +256,47 @@
                 <delete dir="${project.build.directory}/megawar/WEB-INF/detached-plugins" />
                 <delete file="${project.build.directory}/megawar/META-INF/JENKINS.RSA" />
                 <delete file="${project.build.directory}/megawar/META-INF/JENKINS.SF" />
-                <war destfile="${project.build.directory}/megawar.war">
+                <war destfile="${project.build.directory}/megawar.war" manifest="${project.build.directory}/megawar/META-INF/MANIFEST.MF">
                   <fileset dir="${project.build.directory}/megawar" />
                 </war>
               </target>
             </configuration>
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <artifactId>maven-jar-plugin</artifactId>
+        <configuration>
+          <archive>
+            <manifest>
+              <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
+            </manifest>
+            <manifestEntries>
+              <scmRevision>${buildNumber} ${buildIsTainted}</scmRevision>
+            </manifestEntries>
+          </archive>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>buildnumber-maven-plugin</artifactId>
+        <version>3.0.0</version>
+        <configuration>
+          <doCheck>true</doCheck>
+          <doUpdate>false</doUpdate>
+          <failTheBuild>false</failTheBuild>
+          <getRevisionOnlyOnce>true</getRevisionOnlyOnce>
+          <shortRevisionLength>7</shortRevisionLength>
+        </configuration>
+        <executions>
+          <execution>
+            <goals>
+              <goal>create</goal>
+            </goals>
+            <phase>validate</phase>
+          </execution>
+        </executions>
+      </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-shade-plugin</artifactId>
@@ -278,7 +311,7 @@
               <createDependencyReducedPom>false</createDependencyReducedPom>
               <transformers>
                 <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
-                  <mainClass>org.jenkins.tools.test.PluginCompatTesterCli</mainClass>
+                  <mainClass>org.jenkins.tools.test.CLI</mainClass>
                 </transformer>
                 <transformer implementation="org.apache.maven.plugins.shade.resource.ComponentsXmlResourceTransformer" />
                 <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer" />

src/main/java/org/jenkins/tools/test/CLI.java

@@ -0,0 +1,16 @@
+package org.jenkins.tools.test;
+
+import picocli.CommandLine;
+
+@CommandLine.Command(
+        name = "pct",
+        mixinStandardHelpOptions = true,
+        subcommands = {PluginCompatTesterCli.class, PluginListerCLI.class},
+        versionProvider = VersionProvider.class)
+public class CLI {
+
+    public static void main(String... args) {
+        int exitCode = new CommandLine(new CLI()).execute(args);
+        System.exit(exitCode);
+    }
+}

src/main/java/org/jenkins/tools/test/PluginCompatTesterCli.java

@@ -33,6 +33,7 @@
 import java.nio.file.Files;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
 import java.util.concurrent.Callable;
 import org.jenkins.tools.test.exception.PluginCompatibilityTesterException;
 import org.jenkins.tools.test.logging.LoggingConfiguration;
@@ -41,9 +42,10 @@
 import picocli.CommandLine;
 
 @CommandLine.Command(
-        name = "pct",
+        name = "test-plugins",
         mixinStandardHelpOptions = true,
-        description = "Perform a compatibility test for plugins against Jenkins core and other plugins.")
+        description = "Perform a compatibility test for plugins against Jenkins core and other plugins.",
+        versionProvider = VersionProvider.class)
 public class PluginCompatTesterCli implements Callable<Integer> {
 
     static {
@@ -75,7 +77,7 @@ public class PluginCompatTesterCli implements Callable<Integer> {
             paramLabel = "plugin",
             description =
                     "Comma-separated list of plugin artifact IDs to test. If not set, every plugin in the WAR will be tested.")
-    private List<String> includePlugins;
+    private Set<String> includePlugins;
 
     @CheckForNull
     @CommandLine.Option(
@@ -85,7 +87,7 @@ public class PluginCompatTesterCli implements Callable<Integer> {
             paramLabel = "plugin",
             description =
                     "Comma-separated list of plugin artifact IDs to skip. If not set, only the plugins specified by --plugins will be tested (or all plugins otherwise).")
-    private List<String> excludePlugins;
+    private Set<String> excludePlugins;
 
     @CheckForNull
     @CommandLine.Option(
@@ -194,11 +196,6 @@ public Integer call() throws PluginCompatibilityTesterException {
 
         PluginCompatTester tester = new PluginCompatTester(config);
         tester.testPlugins();
-        return 0;
-    }
-
-    public static void main(String... args) {
-        int exitCode = new CommandLine(new PluginCompatTesterCli()).execute(args);
-        System.exit(exitCode);
+        return Integer.valueOf(0);
     }
 }

src/main/java/org/jenkins/tools/test/PluginListerCLI.java

@@ -0,0 +1,123 @@
+package org.jenkins.tools.test;
+
+import edu.umd.cs.findbugs.annotations.CheckForNull;
+import java.io.BufferedWriter;
+import java.io.File;
+import java.io.IOException;
+import java.io.UncheckedIOException;
+import java.nio.file.Files;
+import java.nio.file.StandardOpenOption;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.Set;
+import java.util.concurrent.Callable;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+import java.util.stream.Collectors;
+import org.jenkins.tools.test.exception.PluginCompatibilityTesterException;
+import org.jenkins.tools.test.model.plugin_metadata.PluginMetadata;
+import org.jenkins.tools.test.model.plugin_metadata.PluginMetadataExtractor;
+import org.jenkins.tools.test.model.plugin_metadata.PluginMetadataHooks;
+import org.jenkins.tools.test.picocli.ExistingFileTypeConverter;
+import org.jenkins.tools.test.util.WarUtils;
+import picocli.CommandLine;
+
+@CommandLine.Command(
+        name = "list-plugins",
+        mixinStandardHelpOptions = true,
+        description = "List (non-detached) plugins and their associated repositories that the bundled in the war.",
+        versionProvider = VersionProvider.class)
+public class PluginListerCLI implements Callable<Integer> {
+
+    private static final Logger LOGGER = Logger.getLogger(PluginListerCLI.class.getName());
+
+    @CommandLine.Option(
+            names = {"-w", "--war"},
+            required = true,
+            description = "Path to the WAR file to be examined.",
+            converter = ExistingFileTypeConverter.class)
+    private File warFile;
+
+    @CommandLine.Option(
+            names = "--external-hooks-jars",
+            split = ",",
+            arity = "1",
+            paramLabel = "jar",
+            description = "Comma-separated list of paths to external hooks JARs.",
+            converter = ExistingFileTypeConverter.class)
+    private List<File> externalHooksJars = Collections.emptyList();
+
+    @CheckForNull
+    @CommandLine.Option(
+            names = {"-o", "--output"},
+            required = false,
+            description = "location of the file to write containing the plugin and reposiries.")
+    private File output;
+
+    @CheckForNull
+    @CommandLine.Option(
+            names = "--include-plugins",
+            split = ",",
+            arity = "1",
+            paramLabel = "plugin",
+            description =
+                    "Comma-separated list of plugin artifact IDs to test. If not set, every plugin in the WAR will be listed.")
+    private Set<String> includePlugins;
+
+    @CheckForNull
+    @CommandLine.Option(
+            names = "--exclude-plugins",
+            split = ",",
+            arity = "1",
+            paramLabel = "plugin",
+            description =
+                    "Comma-separated list of plugin artifact IDs to skip. If not set, only the plugins specified by --plugins will be listed (or all plugins otherwise).")
+    private Set<String> excludePlugins;
+
+    @Override
+    public Integer call() throws PluginCompatibilityTesterException {
+        List<PluginMetadataExtractor> metadataExtractors = PluginMetadataHooks.loadExtractors(externalHooksJars);
+
+        List<PluginMetadata> pluginMetadataList =
+                WarUtils.extractPluginMetadataFromWar(warFile, metadataExtractors, includePlugins, excludePlugins);
+
+        // group the plugins into their actual repositories.
+        Map<String, List<PluginMetadata>> metaDataByRepoMap =
+                pluginMetadataList.stream().collect(Collectors.groupingBy(PluginMetadata::getGitURL));
+
+        if (metaDataByRepoMap.isEmpty()) {
+            LOGGER.log(Level.WARNING, "found no plugins in ", warFile);
+            return Integer.valueOf(5);
+        }
+
+        if (output != null) {
+            try (BufferedWriter writer = Files.newBufferedWriter(
+                    output.toPath(),
+                    StandardOpenOption.CREATE,
+                    StandardOpenOption.TRUNCATE_EXISTING,
+                    StandardOpenOption.WRITE)) {
+                for (Map.Entry<String, List<PluginMetadata>> entry : metaDataByRepoMap.entrySet()) {
+                    writer.write(formatEntry(entry));
+                    writer.write("\\n");
+                }
+            } catch (IOException e) {
+                throw new UncheckedIOException(e);
+            }
+        } else {
+            for (Map.Entry<String, List<PluginMetadata>> entry : metaDataByRepoMap.entrySet()) {
+                System.out.println(formatEntry(entry));
+            }
+        }
+        return Integer.valueOf(0);
+    }
+
+    private static String formatEntry(Entry<String, List<PluginMetadata>> entry) {
+        StringBuilder sb = new StringBuilder(entry.getKey());
+        for (PluginMetadata pm : entry.getValue()) {
+            sb.append("\t").append(pm.getPluginId());
+        }
+        return sb.toString();
+    }
+}

src/main/java/org/jenkins/tools/test/VersionProvider.java

@@ -0,0 +1,41 @@
+package org.jenkins.tools.test;
+
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.jar.Attributes;
+import java.util.jar.Manifest;
+import picocli.CommandLine;
+
+public class VersionProvider implements CommandLine.IVersionProvider {
+
+    @Override
+    public String[] getVersion() throws Exception {
+        return new String[] {getPCTVersionString(), getJavaVersionString()};
+    }
+
+    @SuppressFBWarnings(
+            value = {"NP_LOAD_OF_KNOWN_NULL_VALUE", "RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE"},
+            justification =
+                    "spotbugs false poisitive due to try-with-resources / https://github.com/spotbugs/spotbugs/issues/2191")
+    private static String getPCTVersionString() {
+        try (InputStream manifestStream = VersionProvider.class.getResourceAsStream("/META-INF/MANIFEST.MF")) {
+            if (manifestStream != null) {
+                Manifest mf = new Manifest(manifestStream);
+                System.out.println(mf);
+                Attributes mainAttributes = mf.getMainAttributes();
+                return "PCT : "
+                        + mainAttributes.getValue("Implementation-Version")
+                        + " "
+                        + mainAttributes.getValue("scmRevision");
+            }
+        } catch (IOException e) {
+            // ignored
+        }
+        return "PCT : SNAPSHOT build";
+    }
+
+    private static String getJavaVersionString() {
+        return "Java : " + System.getProperty("java.version");
+    }
+}

src/main/java/org/jenkins/tools/test/exception/MetadataExtractionException.java

@@ -0,0 +1,18 @@
+package org.jenkins.tools.test.exception;
+
+/**
+ * Exception used when extracting metadata from the war fails, e.g. the list of plugins or Jenkins
+ * version could not be obtained.
+ */
+public class MetadataExtractionException extends PluginCompatibilityTesterException {
+
+    private static final long serialVersionUID = 1L;
+
+    public MetadataExtractionException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
+    public MetadataExtractionException(String message) {
+        super(message);
+    }
+}

src/main/java/org/jenkins/tools/test/exception/PluginCompatibilityTesterException.java

@@ -8,6 +8,8 @@
  */
 public class PluginCompatibilityTesterException extends Exception {
 
+    private static final long serialVersionUID = 1L;
+
     public PluginCompatibilityTesterException(String message) {
         super(message);
     }

src/main/java/org/jenkins/tools/test/exception/PluginSourcesUnavailableException.java

@@ -33,6 +33,9 @@
  * @author Frederic Camblor
  */
 public class PluginSourcesUnavailableException extends PluginCompatibilityTesterException {
+
+    private static final long serialVersionUID = 1L;
+
     public PluginSourcesUnavailableException(String message) {
         super(message);
     }

src/main/java/org/jenkins/tools/test/exception/PomExecutionException.java

@@ -33,6 +33,8 @@
  */
 public class PomExecutionException extends PluginCompatibilityTesterException {
 
+    private static final long serialVersionUID = 1L;
+
     public PomExecutionException(String message) {
         super(message);
     }

src/main/java/org/jenkins/tools/test/exception/PomTransformationException.java

@@ -32,6 +32,9 @@
  * @author Frederic Camblor
  */
 public class PomTransformationException extends PluginCompatibilityTesterException {
+
+    private static final long serialVersionUID = 1L;
+
     public PomTransformationException(String message) {
         super(message);
     }

src/main/java/org/jenkins/tools/test/exception/WrappedPluginCompatabilityException.java

@@ -0,0 +1,17 @@
+package org.jenkins.tools.test.exception;
+
+/** A {@ code RuntimeException} that wraps a wraps a PluginCompatibilityTesterException. */
+public class WrappedPluginCompatabilityException extends RuntimeException {
+
+    private static final long serialVersionUID = 1L;
+
+    public WrappedPluginCompatabilityException(PluginCompatibilityTesterException wrapped) {
+        super(wrapped);
+    }
+
+    @SuppressWarnings("sync-override")
+    @Override
+    public PluginCompatibilityTesterException getCause() {
+        return (PluginCompatibilityTesterException) super.getCause();
+    }
+}