chore: Fix --version flag in subcommands (#1149)

Fix --version flag in subcommands

Author: usmansaleem

commandline/src/main/java/tech/pegasys/web3signer/commandline/subcommands/Eth1SubCommand.java

@@ -22,6 +22,7 @@
 
 import tech.pegasys.web3signer.commandline.PicoCliAwsKmsParameters;
 import tech.pegasys.web3signer.commandline.PicoCliAzureKeyVaultParameters;
+import tech.pegasys.web3signer.commandline.VersionProvider;
 import tech.pegasys.web3signer.commandline.annotations.RequiredOption;
 import tech.pegasys.web3signer.commandline.config.PicoV3KeystoresBulkloadParameters;
 import tech.pegasys.web3signer.commandline.config.client.PicoCliClientTlsOptions;
@@ -48,6 +49,7 @@
     name = Eth1SubCommand.COMMAND_NAME,
     description = "Handle Ethereum-1 SECP256k1 signing operations and public key reporting",
     subcommands = {HelpCommand.class},
+    versionProvider = VersionProvider.class,
     mixinStandardHelpOptions = true)
 public class Eth1SubCommand extends ModeSubCommand implements Eth1Config {
 

commandline/src/main/java/tech/pegasys/web3signer/commandline/subcommands/Eth2ExportSubCommand.java

@@ -12,6 +12,7 @@
  */
 package tech.pegasys.web3signer.commandline.subcommands;
 
+import tech.pegasys.web3signer.commandline.VersionProvider;
 import tech.pegasys.web3signer.core.InitializationException;
 import tech.pegasys.web3signer.slashingprotection.SlashingProtectionContext;
 import tech.pegasys.web3signer.slashingprotection.SlashingProtectionContextFactory;
@@ -35,6 +36,7 @@
     name = "export",
     description = "Exports the slashing protection database",
     subcommands = {HelpCommand.class},
+    versionProvider = VersionProvider.class,
     mixinStandardHelpOptions = true)
 public class Eth2ExportSubCommand implements Runnable {
 

commandline/src/main/java/tech/pegasys/web3signer/commandline/subcommands/Eth2ImportSubCommand.java

@@ -12,6 +12,7 @@
  */
 package tech.pegasys.web3signer.commandline.subcommands;
 
+import tech.pegasys.web3signer.commandline.VersionProvider;
 import tech.pegasys.web3signer.core.InitializationException;
 import tech.pegasys.web3signer.slashingprotection.SlashingProtectionContext;
 import tech.pegasys.web3signer.slashingprotection.SlashingProtectionContextFactory;
@@ -35,6 +36,7 @@
     name = "import",
     description = "Imports the slashing protection database",
     subcommands = {HelpCommand.class},
+    versionProvider = VersionProvider.class,
     mixinStandardHelpOptions = true)
 public class Eth2ImportSubCommand implements Runnable {
 

commandline/src/main/java/tech/pegasys/web3signer/commandline/subcommands/Eth2SubCommand.java

@@ -29,6 +29,7 @@
 import tech.pegasys.web3signer.commandline.PicoCliAzureKeyVaultParameters;
 import tech.pegasys.web3signer.commandline.PicoCliGcpSecretManagerParameters;
 import tech.pegasys.web3signer.commandline.PicoCliSlashingProtectionParameters;
+import tech.pegasys.web3signer.commandline.VersionProvider;
 import tech.pegasys.web3signer.commandline.config.KeyManagerApiParameters;
 import tech.pegasys.web3signer.commandline.config.PicoCommitBoostApiParameters;
 import tech.pegasys.web3signer.commandline.config.PicoKeystoresParameters;
@@ -65,6 +66,7 @@
       Eth2ImportSubCommand.class,
       Eth2WatermarkRepairSubCommand.class
     },
+    versionProvider = VersionProvider.class,
     mixinStandardHelpOptions = true)
 public class Eth2SubCommand extends ModeSubCommand {
   private static final Logger LOG = LogManager.getLogger();

commandline/src/main/java/tech/pegasys/web3signer/commandline/subcommands/Eth2WatermarkRepairSubCommand.java

@@ -12,6 +12,7 @@
  */
 package tech.pegasys.web3signer.commandline.subcommands;
 
+import tech.pegasys.web3signer.commandline.VersionProvider;
 import tech.pegasys.web3signer.slashingprotection.SlashingProtectionContext;
 import tech.pegasys.web3signer.slashingprotection.SlashingProtectionContextFactory;
 import tech.pegasys.web3signer.slashingprotection.dao.HighWatermark;
@@ -40,6 +41,7 @@
             + "This will not move the low watermark lower, the low watermark can only be increased."
             + "If setting the high watermark, care should be taken to set this to a future epoch and slot.",
     subcommands = {HelpCommand.class},
+    versionProvider = VersionProvider.class,
     mixinStandardHelpOptions = true)
 public class Eth2WatermarkRepairSubCommand implements Runnable {
   private static final Logger LOG = LogManager.getLogger();

…line/CommandLineParserHelpUsageTest.java …ndLineParserHelpAndVersionUsageTest.javacommandline/src/test/java/tech/pegasys/web3signer/commandline/CommandLineParserHelpUsageTest.java renamed to commandline/src/test/java/tech/pegasys/web3signer/commandline/CommandLineParserHelpAndVersionUsageTest.java commandline/src/test/java/tech/pegasys/web3signer/commandline/CommandLineParserHelpUsageTest.java renamed to commandline/src/test/java/tech/pegasys/web3signer/commandline/CommandLineParserHelpAndVersionUsageTest.java

@@ -16,6 +16,7 @@
 
 import tech.pegasys.web3signer.commandline.subcommands.Eth1SubCommand;
 import tech.pegasys.web3signer.commandline.subcommands.Eth2SubCommand;
+import tech.pegasys.web3signer.common.ApplicationInfo;
 
 import java.io.PrintWriter;
 import java.io.StringWriter;
@@ -29,7 +30,8 @@
 import org.junit.jupiter.params.provider.MethodSource;
 import picocli.CommandLine;
 
-public class CommandLineParserHelpUsageTest {
+public class CommandLineParserHelpAndVersionUsageTest {
+  private static final String EXPECTED_VERSION = ApplicationInfo.version();
   private static final String EXPECTED_USAGE = getCommandUsageMessage(false);
   private static final String EXPECTED_SUBCOMMAND_USAGE = getCommandUsageMessage(true);
 
@@ -94,6 +96,23 @@ private static Stream<Arguments> provideHelpCommandVariations() {
         Arguments.of(new String[] {"eth2", "help"}, "subcommand with help subcommand"));
   }
 
+  @ParameterizedTest(name = "{index}: {1}")
+  @MethodSource("provideVersionCommandVariations")
+  void versionArgDisplaysVersion(final String[] args, final String description) {
+    parser.parseCommandLine(args);
+
+    assertThat(commandOutput.toString().trim())
+        .as(description + " - std out")
+        .isEqualTo(EXPECTED_VERSION);
+  }
+
+  private static Stream<Arguments> provideVersionCommandVariations() {
+    return Stream.of(
+        Arguments.of(new String[] {"--version"}, "--version flag with main command"),
+        Arguments.of(new String[] {"eth1", "--version"}, "eth1 subcommand with --version flag"),
+        Arguments.of(new String[] {"eth2", "--version"}, "eth2 subcommand with --version flag"));
+  }
+
   private static String getCommandUsageMessage(final boolean isSubCommand) {
     final CommandLine expectedBaseCommandLine = new CommandLine(new Web3SignerBaseCommand());
     expectedBaseCommandLine.setCaseInsensitiveEnumValuesAllowed(true);