HDDS-11838. Top-level shell to allow access to admin/debug/sh commands

Author: will-sh

hadoop-hdds/cli-common/src/main/java/org/apache/hadoop/hdds/cli/GenericCli.java

@@ -78,7 +78,12 @@ public void run(String[] argv) {
     int exitCode = execute(argv);
 
     if (exitCode != ExitCode.OK) {
-      ExitUtils.terminate(exitCode, null, null);
+      if (cmd.getOut() != null) {
+        cmd.getOut().println("Command executed with exit code: " + exitCode);
+      }
+      if (System.getProperty("ozone.interactive.shell") == null) {
+        ExitUtils.terminate(exitCode, null, null);
+      }
     }
   }
 

hadoop-ozone/cli-shell/src/main/java/org/apache/hadoop/ozone/shell/OzoneInteractiveShell.java

@@ -0,0 +1,80 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.hadoop.ozone.shell;
+
+import org.apache.hadoop.hdds.cli.GenericCli;
+import picocli.CommandLine;
+import picocli.CommandLine.Command;
+import picocli.shell.jline3.PicocliCommands.PicocliCommandsFactory;
+
+/**
+ * Interactive Shell for all Ozone commands.
+ */
+public final class OzoneInteractiveShell {
+
+  private OzoneInteractiveShell() {
+  }
+
+  public static void main(String[] argv) throws Exception {
+    PicocliCommandsFactory factory = new PicocliCommandsFactory();
+    CommandLine topCmd = new CommandLine(new TopCommand(), factory);
+
+    // Add known subcommands statically if they are in the same module.
+    topCmd.addSubcommand("sh", new OzoneShell().getCmd());
+    topCmd.addSubcommand("tenant", new org.apache.hadoop.ozone.shell.tenant.TenantShell().getCmd());
+    topCmd.addSubcommand("s3", new org.apache.hadoop.ozone.shell.s3.S3Shell().getCmd());
+
+    // Dynamically add subcommands from other modules to avoid circular dependencies.
+    addDynamicSubcommand(topCmd, "admin", "org.apache.hadoop.ozone.admin.OzoneAdmin");
+    addDynamicSubcommand(topCmd, "debug", "org.apache.hadoop.ozone.debug.OzoneDebug");
+    addDynamicSubcommand(topCmd, "fs", "org.apache.hadoop.fs.ozone.OzoneFsShell");
+    addDynamicSubcommand(topCmd, "repair", "org.apache.hadoop.ozone.repair.OzoneRepair");
+
+    Shell dummyShell = new Shell() {
+      @Override
+      public String name() {
+        return "ozone";
+      }
+
+      @Override
+      public String prompt() {
+        return "ozone";
+      }
+    };
+
+    new REPL(dummyShell, topCmd, factory, null);
+  }
+
+  private static void addDynamicSubcommand(CommandLine topCmd, String name, String className) {
+    try {
+      Class<?> clazz = Class.forName(className);
+      GenericCli instance = (GenericCli) clazz.getDeclaredConstructor().newInstance();
+      topCmd.addSubcommand(name, instance.getCmd());
+    } catch (Exception e) {
+      // Ignore if the class is not present in the classpath
+    }
+  }
+
+  @Command(name = "ozone", description = "Interactive Shell for all Ozone commands", mixinStandardHelpOptions = true)
+  private static class TopCommand implements Runnable {
+    @Override
+    public void run() {
+      // Top level command doesn't do anything by itself in REPL
+    }
+  }
+}

hadoop-ozone/cli-shell/src/main/java/org/apache/hadoop/ozone/shell/REPL.java

@@ -71,6 +71,7 @@ class REPL {
       }
 
       String prompt = shell.prompt() + "> ";
+      System.setProperty("ozone.interactive.shell", "true");
 
       final int batchSize = lines == null ? 0 : lines.size();
       if (batchSize > 0) {

hadoop-ozone/dist/src/shell/ozone/ozone

@@ -221,6 +221,17 @@ function ozonecmd_case
       OZONE_CLASSNAME=org.apache.hadoop.security.token.DtUtilShell
       OZONE_RUN_ARTIFACT_NAME="ozone-tools"
     ;;
+    interactive | --interactive)
+      OZONE_CLASSNAME=org.apache.hadoop.ozone.shell.OzoneInteractiveShell
+      OZONE_RUN_ARTIFACT_NAME="ozone-cli-shell"
+      OZONE_OPTS="${OZONE_OPTS} ${RATIS_OPTS} ${OZONE_MODULE_ACCESS_ARGS}"
+      # Add all CLI classpaths to support all subcommands dynamically
+      for cp_file in "ozone-cli-admin" "ozone-cli-debug" "ozone-cli-repair" "ozone-tools"; do
+        if [[ -f "${OZONE_HOME}/share/ozone/classpath/${cp_file}.classpath" ]]; then
+          ozone_add_classpath_from_file "${OZONE_HOME}/share/ozone/classpath/${cp_file}.classpath"
+        fi
+      done
+    ;;
     admin)
       OZONE_CLASSNAME=org.apache.hadoop.ozone.admin.OzoneAdmin
       OZONE_ADMIN_OPTS="${OZONE_ADMIN_OPTS} ${RATIS_OPTS} ${OZONE_MODULE_ACCESS_ARGS}"
@@ -318,6 +329,10 @@ fi
 
 OZONE_SUBCMD=$1
 
+if [[ "$OZONE_SUBCMD" == "--interactive" ]]; then
+  OZONE_SUBCMD="interactive"
+fi
+
 if [[ "$OZONE_SUBCMD" == "auditparser" ]] || [[ "$OZONE_SUBCMD" == "checknative" ]]; then
   echo "warning: 'ozone $OZONE_SUBCMD' is deprecated, use 'ozone debug $OZONE_SUBCMD' instead."
   OZONE_SUBCMD="debug"