Enable picocli for some tools

Author: janhoy

solr/core/src/java/org/apache/solr/cli/HealthcheckTool.java

@@ -51,9 +51,35 @@
 import org.slf4j.LoggerFactory;
 
 /** Supports healthcheck command in the bin/solr script. */
+@picocli.CommandLine.Command(
+    name = "healthcheck",
+    description = "Check the health of a SolrCloud collection.")
 public class HealthcheckTool extends ToolBase {
   private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 
+  @picocli.CommandLine.Option(
+      names = {"-c", "--name"},
+      required = true,
+      description = "Name of the collection to check.")
+  private String collection;
+
+  // NOCOMMIT: Find a way to make this common for all tools that need it
+  @picocli.CommandLine.Option(
+      names = {"-z", "--zk-host"},
+      description =
+          "Zookeeper connection string; unnecessary if ZK_HOST is defined in solr.in.sh; otherwise, defaults to "
+              + CommonCLIOptions.DefaultValues.ZK_HOST
+              + '.',
+      required = true)
+  String zkHost;
+
+  @picocli.CommandLine.Option(
+      names = {"-u", "--credentials"},
+      description =
+          "Credentials in the format username:password. Example: --credentials solr:SolrRocks")
+  private String credentials;
+
+  @Deprecated
   private static final Option COLLECTION_NAME_OPTION =
       Option.builder("c")
           .longOpt("name")
@@ -89,15 +115,17 @@ public HealthcheckTool(PrintStream stdout) {
 
   @Override
   public void runImpl(CommandLine cli) throws Exception {
-    String zkHost = CLIUtils.getZkHost(cli);
+    zkHost = CLIUtils.getZkHost(cli);
+    collection = cli.getOptionValue(COLLECTION_NAME_OPTION);
+
     if (zkHost == null) {
       CLIO.err("Healthcheck tool only works in Solr Cloud mode.");
       System.exit(1);
     }
     try (CloudHttp2SolrClient cloudSolrClient = CLIUtils.getCloudHttp2SolrClient(zkHost)) {
       echoIfVerbose("\nConnecting to ZooKeeper at " + zkHost + " ...");
       cloudSolrClient.connect();
-      runCloudTool(cloudSolrClient, cli);
+      runCloudTool(cloudSolrClient);
     }
   }
 
@@ -106,8 +134,7 @@ public String getName() {
     return "healthcheck";
   }
 
-  protected void runCloudTool(CloudSolrClient cloudSolrClient, CommandLine cli) throws Exception {
-    String collection = cli.getOptionValue(COLLECTION_NAME_OPTION);
+  protected void runCloudTool(CloudSolrClient cloudSolrClient) throws Exception {
 
     log.debug("Running healthcheck for {}", collection);
 
@@ -168,15 +195,11 @@ protected void runCloudTool(CloudSolrClient cloudSolrClient, CommandLine cli) th
           q = new SolrQuery("*:*");
           q.setRows(0);
           q.set(DISTRIB, "false");
-          try (var solrClientForCollection =
-              CLIUtils.getSolrClient(
-                  coreUrl, cli.getOptionValue(CommonCLIOptions.CREDENTIALS_OPTION))) {
+          try (var solrClientForCollection = CLIUtils.getSolrClient(coreUrl, credentials)) {
             qr = solrClientForCollection.query(q);
             numDocs = qr.getResults().getNumFound();
             try (var solrClient =
-                CLIUtils.getSolrClient(
-                    replicaCoreProps.getBaseUrl(),
-                    cli.getOptionValue(CommonCLIOptions.CREDENTIALS_OPTION))) {
+                CLIUtils.getSolrClient(replicaCoreProps.getBaseUrl(), credentials)) {
               NamedList<Object> systemInfo =
                   solrClient.request(
                       new GenericSolrRequest(
@@ -227,6 +250,20 @@ protected void runCloudTool(CloudSolrClient cloudSolrClient, CommandLine cli) th
     new JSONWriter(arr, 2).write(report);
     echo(arr.toString());
   }
+
+  @Override
+  public int callTool() throws Exception {
+    if (zkHost == null) {
+      CLIO.err("Healthcheck tool only works in Solr Cloud mode.");
+      return 1;
+    }
+    try (CloudHttp2SolrClient cloudSolrClient = CLIUtils.getCloudHttp2SolrClient(zkHost)) {
+      echoIfVerbose("\nConnecting to ZooKeeper at " + zkHost + " ...");
+      cloudSolrClient.connect();
+      runCloudTool(cloudSolrClient);
+    }
+    return 0;
+  }
 }
 
 class ReplicaHealth implements Comparable<ReplicaHealth> {

solr/core/src/java/org/apache/solr/cli/SolrCLI.java

@@ -38,19 +38,50 @@
 import org.apache.commons.cli.Option;
 import org.apache.commons.cli.Options;
 import org.apache.commons.cli.ParseException;
+import org.apache.solr.client.api.util.SolrVersion;
 import org.apache.solr.client.solrj.SolrClient;
 import org.apache.solr.client.solrj.request.ContentStreamUpdateRequest;
 import org.apache.solr.common.util.ContentStreamBase;
+import org.apache.solr.common.util.EnvUtils;
 import org.apache.solr.common.util.NamedList;
 import org.apache.solr.util.configuration.SSLConfigurationsFactory;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /** Command-line utility for working with Solr. */
+@picocli.CommandLine.Command(
+    name = "solr",
+    version = "Apache Solr version " + SolrVersion.LATEST_STRING,
+    mixinStandardHelpOptions = true,
+    commandListHeading = "\nCommands:\n",
+    descriptionHeading = "Global options:\n",
+    footer = {
+      "",
+      "SolrCloud example (embedded Zookeeper):",
+      "",
+      "  ./solr start -c",
+      "",
+      "For more help on how to use Solr, head to https://solr.apache.org/"
+    },
+    usageHelpAutoWidth = true,
+    defaultValueProvider = ZkTool.ZkHostDefaultValueProvider.class,
+    subcommands = {StatusTool.class, HealthcheckTool.class, VersionTool.class, ZkTool.class})
 public class SolrCLI implements CLIO {
 
   private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 
+  @picocli.CommandLine.Option(
+      names = {"-v", "--version"},
+      versionHelp = true,
+      description = "Print version information and exit")
+  boolean versionRequested;
+
+  @picocli.CommandLine.Option(
+      names = {"-h", "--help"},
+      usageHelp = true,
+      description = "Display this help message")
+  boolean helpRequested;
+
   public static void exit(int exitStatus) {
     try {
       System.exit(exitStatus);
@@ -62,6 +93,25 @@ public static void exit(int exitStatus) {
 
   /** Runs a tool. */
   public static void main(String[] args) throws Exception {
+    if (EnvUtils.getPropertyAsBool("solr.picocli", true)) {
+      CLIO.err("Using picocli");
+      SSLConfigurationsFactory.current().init();
+      picocli.CommandLine commandLine = new picocli.CommandLine(new SolrCLI());
+      exit(commandLine.execute(args));
+    } else {
+      CLIO.err("DEBUG: Using commons-cli");
+      exit(parseWithCommonsCli(args));
+    }
+  }
+
+  /**
+   * Parses the command-line arguments passed by the user using Apache Commons CLI. This
+   *
+   * @param args the original command-line arguments
+   * @deprecated Please use picocli
+   */
+  @Deprecated(since = "9.9")
+  public static int parseWithCommonsCli(String[] args) throws Exception {
     final boolean hasNoCommand =
         args == null || args.length == 0 || args[0] == null || args[0].trim().length() == 0;
     final boolean isHelpCommand = !hasNoCommand && Arrays.asList("-h", "--help").contains(args[0]);
@@ -117,15 +167,17 @@ public static void main(String[] args) throws Exception {
       System.exit(1);
     }
     CommandLine cli = parseCmdLine(tool, args);
-    System.exit(tool.runTool(cli));
+    return tool.runTool(cli);
   }
 
+  @Deprecated
   public static Tool findTool(String[] args) throws Exception {
     String toolType = args[0].trim().toLowerCase(Locale.ROOT);
     return newTool(toolType);
   }
 
-  public static CommandLine parseCmdLine(Tool tool, String[] args) {
+  @Deprecated
+  public static org.apache.commons.cli.CommandLine parseCmdLine(Tool tool, String[] args) {
     // the parser doesn't like -D props
     List<String> toolArgList = new ArrayList<>();
     List<String> dashDList = new ArrayList<>();
@@ -140,7 +192,7 @@ public static CommandLine parseCmdLine(Tool tool, String[] args) {
     String[] toolArgs = toolArgList.toArray(new String[0]);
 
     // process command-line args to configure this application
-    CommandLine cli = processCommandLineArgs(tool, toolArgs);
+    org.apache.commons.cli.CommandLine cli = processCommandLineArgs(tool, toolArgs);
 
     List<String> argList = cli.getArgList();
     argList.addAll(dashDList);
@@ -179,6 +231,7 @@ protected static void checkSslStoreSysProp(String solrInstallDir, String key) {
   }
 
   // Creates an instance of the requested tool, using classpath scanning if necessary
+  @Deprecated
   private static Tool newTool(String toolType) throws Exception {
     if ("healthcheck".equals(toolType)) return new HealthcheckTool();
     else if ("status".equals(toolType)) return new StatusTool();
@@ -232,7 +285,7 @@ private static Tool newTool(String toolType) throws Exception {
    * CLI option.
    */
   public static String getOptionWithDeprecatedAndDefault(
-      CommandLine cli, Option opt, Option deprecated, String def) {
+      org.apache.commons.cli.CommandLine cli, Option opt, Option deprecated, String def) {
     String val = cli.getOptionValue(opt);
     if (val == null) {
       val = cli.getOptionValue(deprecated);
@@ -242,6 +295,7 @@ public static String getOptionWithDeprecatedAndDefault(
 
   // TODO: SOLR-17429 - remove the custom logic when Commons CLI is upgraded and
   // makes stderr the default, or makes Option.toDeprecatedString() public.
+  @Deprecated
   private static void deprecatedHandlerStdErr(Option o) {
     // Deprecated options without a description act as "stealth" options
     if (o.isDeprecated() && !o.getDeprecated().getDescription().isBlank()) {
@@ -256,10 +310,12 @@ private static void deprecatedHandlerStdErr(Option o) {
   }
 
   /** Parses the command-line arguments passed by the user. */
-  public static CommandLine processCommandLineArgs(Tool tool, String[] args) {
+  @Deprecated
+  public static org.apache.commons.cli.CommandLine processCommandLineArgs(
+      Tool tool, String[] args) {
     Options options = tool.getOptions();
 
-    CommandLine cli = null;
+    org.apache.commons.cli.CommandLine cli = null;
     try {
       cli =
           DefaultParser.builder()
@@ -296,6 +352,7 @@ public static CommandLine processCommandLineArgs(Tool tool, String[] args) {
   }
 
   /** Prints tool help for a given tool */
+  @Deprecated
   public static void printToolHelp(Tool tool) {
     HelpFormatter formatter = getFormatter();
     Options nonDeprecatedOptions = new Options();
@@ -314,13 +371,19 @@ public static void printToolHelp(Tool tool) {
         autoGenerateUsage);
   }
 
+  @Deprecated
   public static HelpFormatter getFormatter() {
     HelpFormatter formatter = HelpFormatter.builder().get();
     formatter.setWidth(120);
     return formatter;
   }
 
-  /** Scans Jar files on the classpath for Tool implementations to activate. */
+  /**
+   * Scans Jar files on the classpath for Tool implementations to activate.
+   *
+   * @deprecated With Picocli we no longer need to scan the classpath for Tool implementations?
+   */
+  @Deprecated
   private static List<Class<? extends Tool>> findToolClassesInPackage(String packageName) {
     List<Class<? extends Tool>> toolClasses = new ArrayList<>();
     try {
@@ -344,6 +407,7 @@ private static List<Class<? extends Tool>> findToolClassesInPackage(String packa
     return toolClasses;
   }
 
+  @Deprecated
   private static Set<String> findClasses(String path, String packageName) throws Exception {
     Set<String> classes = new TreeSet<>();
     if (path.startsWith("file:") && path.contains("!")) {
@@ -402,6 +466,7 @@ public static String uptime(long uptimeMs) {
         numSeconds);
   }
 
+  @Deprecated
   private static void printHelp() {
 
     print("Usage: solr COMMAND OPTIONS");