Merge pull request #946 from jpmorganchase/use-picocli-for-main-cli

Use picocli for main cli

cli/cli-api/build.gradle

@@ -1,8 +1,7 @@
 
 dependencies {
-    compile 'info.picocli:picocli:4.0.4'
+    compile 'info.picocli:picocli'
     compile 'org.apache.commons:commons-lang3:3.7'
-    compile 'commons-cli:commons-cli:1.4'
     compile project(':config')
     compile project(':shared')
     compile project(':encryption:encryption-api')

cli/cli-api/pom.xml

@@ -20,7 +20,6 @@
         <dependency>
             <groupId>info.picocli</groupId>
             <artifactId>picocli</artifactId>
-            <version>4.0.4</version>
         </dependency>
 
     </dependencies>

cli/cli-api/src/main/java/com/quorum/tessera/cli/CliDelegate.java

@@ -1,29 +1,13 @@
 package com.quorum.tessera.cli;
 
-import com.quorum.tessera.ServiceLoaderUtil;
-import com.quorum.tessera.cli.parsers.ConfigConverter;
 import com.quorum.tessera.config.Config;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import picocli.CommandLine;
 
-import java.util.List;
-import java.util.Objects;
 import java.util.Optional;
-import java.util.function.Predicate;
-import java.util.stream.Collectors;
-
-import static picocli.CommandLine.Model.CommandSpec.DEFAULT_COMMAND_NAME;
 
+// TODO(cjh) still using CliDelegate as a config store so that config can be injected by spring
 public enum CliDelegate {
     INSTANCE;
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(CliDelegate.class);
-
-    private static final CliResult HELP_RESULT = new CliResult(0, true, null);
-
-    private static final CliResult DEFAULT_RESULT = new CliResult(1, true, null);
-
     private Config config;
 
     public static CliDelegate instance() {
@@ -36,70 +20,7 @@ public Config getConfig() {
                         () -> new IllegalStateException("Execute must be invoked before attempting to fetch config"));
     }
 
-    public CliResult execute(String... args) throws Exception {
-
-        final List<CliAdapter> adapters = ServiceLoaderUtil.loadAll(CliAdapter.class).collect(Collectors.toList());
-
-        LOGGER.debug("Loaded adapters {}", adapters);
-
-        CliType cliType = CliType.valueOf(System.getProperty(CliType.CLI_TYPE_KEY, CliType.CONFIG.name()));
-
-        LOGGER.debug("cliType {}", cliType);
-
-        Predicate<CliAdapter> isTopLevel =
-                a -> a.getClass().getAnnotation(CommandLine.Command.class).name().equals(DEFAULT_COMMAND_NAME);
-
-        // Finds the top level adapter that we want to start with. Exactly one is expected to be on the classpath.
-        final CliAdapter adapter =
-                adapters.stream()
-                        .filter(a -> a.getClass().isAnnotationPresent(CommandLine.Command.class))
-                        .filter(isTopLevel)
-                        .filter(a -> a.getType() == cliType)
-                        .findFirst()
-                        .get();
-
-        LOGGER.debug("Loaded adapter {}", adapter);
-
-        // Then we find all the others and attach them as sub-commands. It is expected that they have defined their
-        // own hierarchy and command names.
-        final List<CliAdapter> subcommands =
-                adapters.stream()
-                        // .filter(isTopLevel)
-                        .filter(a -> a != adapter)
-                        .filter(a -> a.getType() != CliType.ENCLAVE)
-                        .collect(Collectors.toList());
-
-        // the mapper will give us access to the exception from the outside, if one occurred.
-        // mostly since we have an existing system, and this is a workaround
-        final CLIExceptionCapturer mapper = new CLIExceptionCapturer();
-        final CommandLine commandLine = new CommandLine(adapter);
-
-        subcommands.stream().peek(sc -> LOGGER.debug("Adding subcommand {}", sc)).forEach(commandLine::addSubcommand);
-
-        commandLine
-                .registerConverter(Config.class, new ConfigConverter())
-                .setSeparator(" ")
-                .setCaseInsensitiveEnumValuesAllowed(true)
-                .setUnmatchedArgumentsAllowed(true)
-                .setExecutionExceptionHandler(mapper)
-                .setParameterExceptionHandler(mapper);
-
-        commandLine.execute(args);
-
-        // if an exception occurred, throw it to to the upper levels where it gets handled
-        if (mapper.getThrown() != null) {
-            throw mapper.getThrown();
-        }
-
-        // otherwise, set the config object (if there is one) and return
-        final CliResult result =
-                commandLine.getParseResult().asCommandLineList().stream()
-                        .map(cl -> cl.isUsageHelpRequested() ? HELP_RESULT : cl.getExecutionResult())
-                        .filter(Objects::nonNull)
-                        .findFirst()
-                        .orElse(DEFAULT_RESULT);
-
-        this.config = result.getConfig().orElse(null);
-        return result;
+    public void setConfig(Config config) {
+        this.config = config;
     }
 }

cli/cli-api/src/main/java/com/quorum/tessera/cli/parsers/ConfigConverter.java

@@ -2,6 +2,7 @@
 
 import com.quorum.tessera.config.Config;
 import com.quorum.tessera.config.ConfigFactory;
+import com.quorum.tessera.config.util.ConfigFileStore;
 import picocli.CommandLine;
 
 import java.io.FileNotFoundException;
@@ -22,6 +23,8 @@ public Config convert(final String value) throws Exception {
             throw new FileNotFoundException(String.format("%s not found.", path));
         }
 
+        ConfigFileStore.create(path);
+
         try (InputStream in = Files.newInputStream(path)) {
             return configFactory.create(in);
         }