Added RPM Sign and Publish functionality, also updates docs.

Author: mdaraujo19

README.md

@@ -12,7 +12,7 @@ There are some **requirements** (tools and programs) that are needed for the suc
 
 - Have **Maven** installed.
 - Have **Java 11 SE** installed and configured.
-- Have access to the **dpkg**, **rpm**, **snap**, **snapcraft** and **lxd** commands, as well as being on a GNU/Linux operating system.
+- Have access to the **dpkg**, **rpm**, **snap**, **snapcraft**, **lxd**, **gpg** and **curl** commands, as well as being on a GNU/Linux operating system.
 - Recommended to have the **latests version of the Java to Distributable** project.
 
 If you already meet this requirements, you are free to continue.
@@ -87,6 +87,8 @@ The tags that can be placed in the `choices.xml` file are:
     - `<javaRunArg>` represents a Java execution argument to run the application with. It must not have the initial hyphen.
 - `<numberJavaRunArgs>` represents/contains a set of `<numberJavaRunArg>`
 	- `<numberJavaRunArg>` represents numbers that are the quantity of Java execution arguments for each command. Must be accumulative and match with the commands declaration order.
+- `<nexusUsername>` represents the Nexus repository username that is allowed to publish RPMs.
+- `<nexusRepoUrl>` represents the Nexus repository URL were the RPM package will be published to.
 
 ## Commands
 

doc/Example_Java_To_Distributable_commands.md

@@ -219,7 +219,7 @@ jtd generate-snap-distributable --jar --jar-file <your_desired_jar_file_path> --
 A overview of the command syntax is:
 
 ```
-jtd generate-rpm-distributable [--verbose/-ve] {--maven/-mvn | --jar/-j} [--jar-file/-jf JAR_PATH...] [--input-pom-file/-ipf POM_PATH | { --maven-remote-repositories/-mrr URL_REPOSITORY… | --from-maven-central/-fmc | --from-maven-local/-fml } --maven-coordinates/-mc COORDINATE… ] [--ignore-central-repository/-icr] [--prioritize-local-m2-repository/-plr] [--main-name/-mn PACKAGE_MAIN_NAME] [--application-class-name/-acn MAIN_CLASS_NAME...] [--choices-file/-cf CHOICES_PATH] --output-directory/-od OUTPUT_DIRECTORY [--dependency/-d DEPENDENCY...] [--documentation/-d DOCUMENTATION_URL] [--target-command-name/-tcn TARGET_COMMAND_NAME...] [--application-name/-an APPLICATION_NAME] [--application-version/-av APPLICATION_VERSION] [--application-description/-ad APPLICATION_DESCRIPTION] [--java-dependency/-jd JAVA_DEPENDENCY] [--man-page/-mp MAN_PAGE_PATH] [--java-run-arg/-jra JAVA_RUN_ARGUMENT...] [--number-java-run-arg/-njra NUMBER_JAVA_RUN_ARGUMENT...] [--licence/-l LICENCE_NAME]
+jtd generate-rpm-distributable [--verbose/-ve] {--maven/-mvn | --jar/-j} [--jar-file/-jf JAR_PATH...] [--input-pom-file/-ipf POM_PATH | { --maven-remote-repositories/-mrr URL_REPOSITORY… | --from-maven-central/-fmc | --from-maven-local/-fml } --maven-coordinates/-mc COORDINATE… ] [--ignore-central-repository/-icr] [--prioritize-local-m2-repository/-plr] [--main-name/-mn PACKAGE_MAIN_NAME] [--application-class-name/-acn MAIN_CLASS_NAME...] [--choices-file/-cf CHOICES_PATH] --output-directory/-od OUTPUT_DIRECTORY [--dependency/-d DEPENDENCY...] [--documentation/-d DOCUMENTATION_URL] [--target-command-name/-tcn TARGET_COMMAND_NAME...] [--application-name/-an APPLICATION_NAME] [--application-version/-av APPLICATION_VERSION] [--application-description/-ad APPLICATION_DESCRIPTION] [--java-dependency/-jd JAVA_DEPENDENCY] [--man-page/-mp MAN_PAGE_PATH] [--java-run-arg/-jra JAVA_RUN_ARGUMENT...] [--number-java-run-arg/-njra NUMBER_JAVA_RUN_ARGUMENT...] [--licence/-l LICENCE_NAME] [--sign/-s] [--publish/-p] [--nexus-username/-nu NEXUS_REPO_USERNAME] [--nexus-repo-url/-nru NEXUS_REPO_URL]
 ```
 
 Currently, the command has the following modes of operation:
@@ -318,7 +318,27 @@ Another example with more options is:
 jtd generate-rpm-distributable --jar --jar-file <your_desired_jar_file_path> --jar-file <another_desired_jar_file_path> --application-class-name org.sing_group.seda.cli.SedaCliApplication --licence GPLv3 --output-directory <your_desired_output_path> --choices-file <your_desired_choices_file>
 ```
 
-### Build a multi-command distributable
+### Sign a distributable
+
+If you want to sign the resulting RPM distributable package after creation, you need to add the appropriate flag as follows:
+
+```
+jtd generate-rpm-distributable --maven --maven-remote-repositories https://maven.sing-group.org/repository/maven-snapshots/ --maven-coordinates org.sing_group:seda:1.6.0-SNAPSHOT --maven-coordinates org.sing_group:seda-plugin-blast:1.6.0-SNAPSHOT --application-class-name org.sing_group.seda.cli.SedaCliApplication --output-directory <your_desired_output_path> --sign
+```
+
+During the process, the user is required to enter the GPG key passphrase interactively so keep that in mind.
+
+### Publish a distributable
+
+If you want to publish the resulting RPM distributable package after creation, you need to add the appropriate flag and provide some additional information as follows:
+
+```
+jtd generate-rpm-distributable --maven --maven-remote-repositories https://maven.sing-group.org/repository/maven-snapshots/ --maven-coordinates org.sing_group:seda:1.6.0-SNAPSHOT --maven-coordinates org.sing_group:seda-plugin-blast:1.6.0-SNAPSHOT --application-class-name org.sing_group.seda.cli.SedaCliApplication --output-directory <your_desired_output_path> --publish --nexus-username <your_nexus_repo_username> --nexus-repo-url <your_nexus_repo_url_for_package_storing>
+```
+
+During the process, the user is required to enter the Nexus repository username's password interactively so keep that in mind.
+
+## Build a multi-command distributable
 
 If you need to package multiple commands in the same distributable file, you can add more classes and command names as follows:
 

src/main/java/es/uvigo/esei/sing/java_to_distributable/cli/command/GenerateDebianDistributableCommand.java

@@ -29,6 +29,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Map;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -39,8 +40,11 @@
 import es.uvigo.esei.sing.java_to_distributable.cli.option.ImageFileWithExtensionOption;
 import es.uvigo.esei.sing.java_to_distributable.enums.OptionCategoryEnum;
 import es.uvigo.esei.sing.java_to_distributable.model.AppInfo;
+import es.uvigo.esei.sing.java_to_distributable.utils.output.AppOutputGenerator;
 import es.uvigo.esei.sing.java_to_distributable.utils.output.DebianAppOutputGenerator;
 import es.uvigo.esei.sing.java_to_distributable.utils.output.OutputGenerator;
+import es.uvigo.esei.sing.java_to_distributable.utils.output.sign.DebianSignerAppOutputGenerator;
+import es.uvigo.esei.sing.java_to_distributable.utils.output.publish.DebianPublisherAppOutputGenerator;
 
 /**
  * An specialization of {@link GenerateDistributableCommand} that generates a
@@ -131,8 +135,24 @@ protected List<Option<?>> createDistributableOptions() {
    *
    */
   @Override
-  protected OutputGenerator getOutputGenerator(File output, AppInfo info) {
-    return new DebianAppOutputGenerator(info, output);
+  protected OutputGenerator getOutputGenerator(File output, AppInfo info, Map<String, Boolean> options) {
+    AppOutputGenerator gen = new DebianAppOutputGenerator(info, output);
+    for (String option : options.keySet()) {
+      switch (option.toUpperCase()) {
+        case "SIGN":
+          if (options.get(option) == true)
+            gen = new DebianSignerAppOutputGenerator(gen);
+        break;
+        case "PUBLISH":
+          if (options.get(option) == true)
+            gen = new DebianPublisherAppOutputGenerator(gen);
+        break;
+        default:
+          LOGGER.warn("Option: " + option + " not supported.");
+          break;
+      }
+    }
+    return gen;
   }
 
   /**

src/main/java/es/uvigo/esei/sing/java_to_distributable/cli/command/GenerateDistributableCommand.java

@@ -29,7 +29,9 @@
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.LinkedHashMap;
 import java.util.List;
+import java.util.Map;
 
 import org.apache.commons.lang3.tuple.ImmutablePair;
 import org.apache.commons.lang3.tuple.Pair;
@@ -328,6 +330,24 @@ public abstract class GenerateDistributableCommand extends AbstractCommand {
     Arrays.asList(OptionCategoryEnum.OPTIONAL.getCategory()), "verbose", "ve",
     "Whether to see command progress messages or not."
   );
+  
+  /**
+   * Represents the option that indicates whether to sign the resulting distributable 
+   * package file or not. It is optional and does not require a value.
+   */
+  protected static final FlagOption SIGN_OPTION = new FlagOption(
+    Arrays.asList(OptionCategoryEnum.SIGN.getCategory()), "sign", "s", 
+    "Wheter to sign the resulting package using GNUPG or not."
+  );
+  
+  /**
+   * Represents the option that indicates whether to publish the resulting distributable 
+   * package file or not. It is optional and does not require a value.
+   */
+  protected static final FlagOption PUBLISH_OPTION = new FlagOption(
+    Arrays.asList(OptionCategoryEnum.PUBLISH.getCategory()), "publish", "p",
+    "Wheter to publish the resulting package or not."
+  );
 
   /**
    * Represents the optional options of which at least one of each list must be
@@ -405,11 +425,13 @@ public abstract class GenerateDistributableCommand extends AbstractCommand {
    *          The output directory where the result will be stored.
    * @param info
    *          The application's info needed to generate the output.
+   * @param options
+   *          The additional options that add extra processes (like signing or deploying).
    *
    * @return the {@code OutputGenerator} instance.
    *
    */
-  protected abstract OutputGenerator getOutputGenerator(File output, AppInfo info);
+  protected abstract OutputGenerator getOutputGenerator(File output, AppInfo info, Map<String, Boolean> options);
 
   /**
    * Abstract method that the subclasses must implement to get the proper
@@ -452,12 +474,14 @@ public void execute(Parameters parameters) throws Exception {
 
       final AppInfo info = provider.createInfo();
 
+      // Verify if all the critical parameters are present
       if (info.getTargetCommandName().isEmpty() || info.getVersion().isEmpty() || info.getClassName().isEmpty()) {
         throw new IllegalArgumentException(
           "One of: targetCommandName, version or className is not found nor provided. Cannot continue."
         );
       }
 
+      // If there is no Java run arguments, set the number of Java run arguments to 0
       if (info.getJavaRunArgs().isEmpty() && info.getNumberJavaRunArgs().isEmpty()) {
         List<String> nja = new ArrayList<>();
         for (int i = 0; i < info.getTargetCommandName().size(); i++) {
@@ -467,6 +491,7 @@ public void execute(Parameters parameters) throws Exception {
         LOGGER.warn("The parameter numberJavaRunArgs is not set, using default value (all zeroes [0]).");
       }
 
+      // Verify the multi-command format
       if (!info.validateMulticommandFormat(info.getTargetCommandName(), 
         info.getClassName(), info.getJavaRunArgs(), info.getNumberJavaRunArgs())) {
         throw new IllegalArgumentException(
@@ -477,8 +502,12 @@ public void execute(Parameters parameters) throws Exception {
 
       LOGGER.info("Choosing the OutputGenerator.");
 
+      Map<String, Boolean> options = new LinkedHashMap<>();
+      options.put("SIGN", parameters.hasFlag(SIGN_OPTION));
+      options.put("PUBLISH", parameters.hasFlag(PUBLISH_OPTION));
+
       final OutputGenerator generator = this
-        .getOutputGenerator(parameters.getSingleValue(OUTPUT_DIRECTORY_OPTION), info);
+        .getOutputGenerator(parameters.getSingleValue(OUTPUT_DIRECTORY_OPTION), info, options);
 
       LOGGER.info("Generating output, this step could take several minutes.");
 
@@ -539,6 +568,8 @@ protected List<Option<?>> createOptions() {
     options.add(DOCUMENTATION_URL_OPTION);
     options.add(MAN_PAGE_OPTION);
     options.add(OUTPUT_DIRECTORY_OPTION);
+    options.add(SIGN_OPTION);
+    options.add(PUBLISH_OPTION);
     options.addAll(this.createDistributableOptions());
 
     return options;

src/main/java/es/uvigo/esei/sing/java_to_distributable/cli/command/GenerateRPMDistributableCommand.java

@@ -26,18 +26,24 @@
 package es.uvigo.esei.sing.java_to_distributable.cli.command;
 
 import java.io.File;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Map;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import es.uvigo.ei.sing.yacli.command.option.Option;
 import es.uvigo.ei.sing.yacli.command.option.StringOption;
+import es.uvigo.esei.sing.java_to_distributable.cli.option.UrlOption;
 import es.uvigo.esei.sing.java_to_distributable.enums.OptionCategoryEnum;
 import es.uvigo.esei.sing.java_to_distributable.model.AppInfo;
 import es.uvigo.esei.sing.java_to_distributable.utils.output.OutputGenerator;
+import es.uvigo.esei.sing.java_to_distributable.utils.output.AppOutputGenerator;
 import es.uvigo.esei.sing.java_to_distributable.utils.output.RPMAppOutputGenerator;
+import es.uvigo.esei.sing.java_to_distributable.utils.output.sign.RPMSignerAppOutputGenerator;
+import es.uvigo.esei.sing.java_to_distributable.utils.output.publish.RPMPublisherAppOutputGenerator;
 
 /**
  * A specialization of {@link GenerateDistributableCommand} that generates a Red
@@ -52,6 +58,16 @@ public class GenerateRPMDistributableCommand extends GenerateDistributableComman
     Arrays.asList(OptionCategoryEnum.CUSTOM.getCategory()), "licence", "l",
     "The name of the licence of the application.", true, true, false
   );
+  
+  private static final StringOption NEXUS_USERNAME = new StringOption(
+    Arrays.asList(OptionCategoryEnum.PUBLISH.getCategory()), "nexus-username", "nu",
+    "The username of the Nexus repository access credentials for publishing the RPM package.", true, true, false
+  );
+  
+  private static final UrlOption NEXUS_REPO_URL = new UrlOption(
+    Arrays.asList(OptionCategoryEnum.PUBLISH.getCategory()), "nexus-repo-url", "nru",
+    "The URL of the Nexus repository where the RPM package will be published to.", true, true, false
+  );
 
   /**
    * Gets the command name.
@@ -95,7 +111,13 @@ public String getDescription() {
    */
   @Override
   protected List<Option<?>> createDistributableOptions() {
-    return Arrays.asList(LICENSE_OPTION);
+    final List<Option<?>> options = new ArrayList<>();
+
+    options.add(LICENSE_OPTION);
+    options.add(NEXUS_USERNAME);
+    options.add(NEXUS_REPO_URL);
+    
+    return options;
   }
 
   /**
@@ -105,8 +127,26 @@ protected List<Option<?>> createDistributableOptions() {
    *
    */
   @Override
-  protected OutputGenerator getOutputGenerator(File output, AppInfo info) {
-    return new RPMAppOutputGenerator(info, output);
+  protected OutputGenerator getOutputGenerator(File output, AppInfo info, Map<String, Boolean> options) {
+    AppOutputGenerator gen = new RPMAppOutputGenerator(info, output);
+    for (String option : options.keySet()) {
+      switch (option.toUpperCase()) {
+        case "SIGN":
+          if (options.get(option) == true) {
+            gen = new RPMSignerAppOutputGenerator(gen);
+          }
+        break;
+        case "PUBLISH":
+          if (options.get(option) == true) {
+            gen = new RPMPublisherAppOutputGenerator(gen);
+          }
+        break;
+        default:
+          LOGGER.warn("Option: " + option + " not supported.");
+        break;
+      }
+    }
+    return gen;
   }
 
   /**

src/main/java/es/uvigo/esei/sing/java_to_distributable/cli/command/GenerateSnapcraftDistributableCommand.java

@@ -29,6 +29,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Map;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -40,8 +41,11 @@
 import es.uvigo.esei.sing.java_to_distributable.enums.SnapConfinementEnum;
 import es.uvigo.esei.sing.java_to_distributable.enums.SnapGradeEnum;
 import es.uvigo.esei.sing.java_to_distributable.model.AppInfo;
+import es.uvigo.esei.sing.java_to_distributable.utils.output.AppOutputGenerator;
 import es.uvigo.esei.sing.java_to_distributable.utils.output.OutputGenerator;
 import es.uvigo.esei.sing.java_to_distributable.utils.output.SnapcraftAppOutputGenerator;
+import es.uvigo.esei.sing.java_to_distributable.utils.output.sign.SnapcraftSignerAppOutputGenerator;
+import es.uvigo.esei.sing.java_to_distributable.utils.output.publish.SnapcraftPublisherAppOutputGenerator;
 
 /**
  * A specialization of {@link GenerateDistributableCommand} that generates a
@@ -127,8 +131,24 @@ protected List<Option<?>> createDistributableOptions() {
    *
    */
   @Override
-  protected OutputGenerator getOutputGenerator(File output, AppInfo info) {
-    return new SnapcraftAppOutputGenerator(info, output);
+  protected OutputGenerator getOutputGenerator(File output, AppInfo info, Map<String, Boolean> options) {
+    AppOutputGenerator gen = new SnapcraftAppOutputGenerator(info, output);
+    for (String option : options.keySet()) {
+      switch (option.toUpperCase()) {
+        case "SIGN":
+          if (options.get(option) == true)
+            gen = new SnapcraftSignerAppOutputGenerator(gen);
+        break;
+        case "PUBLISH":
+          if (options.get(option) == true)
+            gen = new SnapcraftPublisherAppOutputGenerator(gen);
+        break;
+        default:
+          LOGGER.warn("Option: " + option + " not supported.");
+          break;
+      }
+    }
+    return gen;
   }
 
   /**

src/main/java/es/uvigo/esei/sing/java_to_distributable/enums/OptionCategoryEnum.java

@@ -80,7 +80,17 @@ public enum OptionCategoryEnum {
   /**
    * Represents Jar-related options.
    */
-  JAR(new OptionCategory("jar"));
+  JAR(new OptionCategory("jar")),
+  
+  /**
+   * Represents Package signing-related options.
+   */
+  SIGN(new OptionCategory("sign")),
+  
+  /**
+   * Represents Package publish-related options.
+   */
+  PUBLISH(new OptionCategory("publish"));
 
   private OptionCategory category;