Introduce unified entrypoint for CLI scripts (#85821)

CLI scripts have a common infrastructure in that they call to the shared
elasticsearch-cli shell script which launches them with the appropriate
java command line. However, each underlying Java class must implement
its own main method.

This commit introduces a single main method to be shared by CLIs. The
new CliToolLauncher takes in system properties to determine which tool
is being run, and a new CliToolProvider SPI allows defining and finding
the named tools.

relates #85758

Co-authored-by: William Brafford <[email protected]>

Author: rjernst

distribution/build.gradle

@@ -230,7 +230,7 @@ configure(subprojects.findAll { ['archives', 'packages'].contains(it.name) }) {
    *             Properties to expand when copying packaging files             *
    *****************************************************************************/
   configurations {
-    ['libs', 'libsLaunchers', 'libsVersionChecker', 'libsPluginCli', 'libsKeystoreCli', 'libsSecurityCli', 'libsGeoIpCli', 'libsAnsiConsole'].each {
+    ['libs', 'libsLaunchers', 'libsVersionChecker', 'libsCliLauncher', 'libsPluginCli', 'libsKeystoreCli', 'libsSecurityCli', 'libsGeoIpCli', 'libsAnsiConsole'].each {
       create(it) {
         canBeConsumed = false
         canBeResolved = true
@@ -251,6 +251,7 @@ configure(subprojects.findAll { ['archives', 'packages'].contains(it.name) }) {
     libs project(':server')
 
     libsVersionChecker project(':distribution:tools:java-version-checker')
+    libsCliLauncher project(':distribution:tools:cli-launcher')
     libsLaunchers project(':distribution:tools:launchers')
     libsAnsiConsole project(':distribution:tools:ansi-console')
     libsPluginCli project(':distribution:tools:plugin-cli')
@@ -274,6 +275,9 @@ configure(subprojects.findAll { ['archives', 'packages'].contains(it.name) }) {
         into('java-version-checker') {
           from(configurations.libsVersionChecker)
         }
+        into('cli-launcher') {
+          from(configurations.libsCliLauncher)
+        }
         into('tools/geoip-cli') {
           from(configurations.libsGeoIpCli)
         }
@@ -370,12 +374,7 @@ configure(subprojects.findAll { ['archives', 'packages'].contains(it.name) }) {
         // module provided bin files
         with copySpec {
           eachFile { it.setMode(0755) }
-          if (testDistro == false) {
-            from(defaultBinFiles)
-          } else {
-            from(defaultBinFiles)
-              include 'x-pack-env', 'x-pack-security-env'
-          }
+          from(defaultBinFiles)
           if (distributionType != 'zip') {
             exclude '*.bat'
           }

distribution/packages/src/common/scripts/postinst

@@ -59,17 +59,15 @@ if [ "x$IS_UPGRADE" != "xtrue" ]; then
     # Don't exit immediately on error, we want to hopefully print some helpful banners
     set +e
     # Attempt to auto-configure security, this seems to be an installation
-    if ES_MAIN_CLASS=org.elasticsearch.xpack.security.cli.AutoConfigureNode \
-    ES_ADDITIONAL_SOURCES="x-pack-env;x-pack-security-env" \
-    ES_ADDITIONAL_CLASSPATH_DIRECTORIES=lib/tools/security-cli \
+    if CLI_NAME="auto-configure-node" \
+    CLI_LIBS="modules/x-pack-core,modules/x-pack-security,lib/tools/security-cli" \
     /usr/share/elasticsearch/bin/elasticsearch-cli <<< ""; then
         # Above command runs as root and TLS keystores are created group-owned by root. It's simple to correct the ownership here
         chown root:elasticsearch "${ES_PATH_CONF}"/certs/http.p12
         chown root:elasticsearch "${ES_PATH_CONF}"/certs/http_ca.crt
         chown root:elasticsearch "${ES_PATH_CONF}"/certs/transport.p12
-        if INITIAL_PASSWORD=$(ES_MAIN_CLASS=org.elasticsearch.xpack.security.enrollment.tool.AutoConfigGenerateElasticPasswordHash \
-        ES_ADDITIONAL_SOURCES="x-pack-env;x-pack-security-env" \
-        ES_ADDITIONAL_CLASSPATH_DIRECTORIES=lib/tools/security-cli \
+        if INITIAL_PASSWORD=$(CLI_NAME=auto-config-gen-passwd \
+        CLI_LIBS="modules/x-pack-core,modules/x-pack-security,lib/tools/security-cli" \
         /usr/share/elasticsearch/bin/elasticsearch-cli); then
             echo "--------------------------- Security autoconfiguration information ------------------------------"
             echo

distribution/src/bin/elasticsearch

@@ -66,19 +66,17 @@ then
 fi
 
 if [[ $ENROLL_TO_CLUSTER = true ]]; then
-  ES_MAIN_CLASS=org.elasticsearch.xpack.security.cli.AutoConfigureNode \
-  ES_ADDITIONAL_SOURCES="x-pack-env;x-pack-security-env" \
-  ES_ADDITIONAL_CLASSPATH_DIRECTORIES=lib/tools/security-cli \
+  CLI_NAME="auto-configure-node" \
+  CLI_LIBS="modules/x-pack-core,modules/x-pack-security,lib/tools/security-cli" \
   bin/elasticsearch-cli "${ARG_LIST[@]}" <<<"$KEYSTORE_PASSWORD"
 elif [[ $ATTEMPT_SECURITY_AUTO_CONFIG = true ]]; then
   # It is possible that an auto-conf failure prevents the node from starting, but this is only the exceptional case (exit code 1).
   # Most likely an auto-conf failure will leave the configuration untouched (exit codes 73, 78 and 80), optionally printing a message
   # if the error is uncommon or unexpected, but it should otherwise let the node to start as usual.
   # It is passed in all the command line options in order to read the node settings ones (-E), while the other parameters are ignored
   # (a small caveat is that it also inspects the -v option in order to provide more information on how auto config went)
-  if ES_MAIN_CLASS=org.elasticsearch.xpack.security.cli.AutoConfigureNode \
-    ES_ADDITIONAL_SOURCES="x-pack-env;x-pack-security-env" \
-    ES_ADDITIONAL_CLASSPATH_DIRECTORIES=lib/tools/security-cli \
+  if CLI_NAME="auto-configure-node" \
+    CLI_LIBS="modules/x-pack-core,modules/x-pack-security,lib/tools/security-cli" \
     bin/elasticsearch-cli "${ARG_LIST[@]}" <<<"$KEYSTORE_PASSWORD"; then
       :
   else

distribution/src/bin/elasticsearch-cli

@@ -4,28 +4,21 @@ set -e -o pipefail
 
 source "`dirname "$0"`"/elasticsearch-env
 
-IFS=';' read -r -a additional_sources <<< "$ES_ADDITIONAL_SOURCES"
-for additional_source in "${additional_sources[@]}"
-do
-  source "$ES_HOME"/bin/$additional_source
-done
-
-IFS=';' read -r -a additional_classpath_directories <<< "$ES_ADDITIONAL_CLASSPATH_DIRECTORIES"
-for additional_classpath_directory in "${additional_classpath_directories[@]}"
-do
-  ES_CLASSPATH="$ES_CLASSPATH:$ES_HOME/$additional_classpath_directory/*"
-done
-
 # use a small heap size for the CLI tools, and thus the serial collector to
-# avoid stealing many CPU cycles; a user can override by setting ES_JAVA_OPTS
-ES_JAVA_OPTS="-Xms4m -Xmx64m -XX:+UseSerialGC ${ES_JAVA_OPTS}"
+# avoid stealing many CPU cycles; a user can override by setting CLI_JAVA_OPTS
+CLI_JAVA_OPTS="-Xms4m -Xmx64m -XX:+UseSerialGC ${CLI_JAVA_OPTS}"
+
+LAUNCHER_CLASSPATH=$ES_HOME/lib/*:$ES_HOME/lib/cli-launcher/*
 
 exec \
   "$JAVA" \
-  $ES_JAVA_OPTS \
+  $CLI_JAVA_OPTS \
+  -Dcli.name="$CLI_NAME" \
+  -Dcli.script="$0" \
+  -Dcli.libs="$CLI_LIBS" \
   -Des.path.home="$ES_HOME" \
   -Des.path.conf="$ES_PATH_CONF" \
   -Des.distribution.type="$ES_DISTRIBUTION_TYPE" \
-  -cp "$ES_CLASSPATH" \
-  "$ES_MAIN_CLASS" \
+  -cp "$LAUNCHER_CLASSPATH" \
+  org.elasticsearch.launcher.CliToolLauncher \
   "$@"

distribution/src/bin/elasticsearch-cli.bat

@@ -1,28 +1,27 @@
-call "%~dp0elasticsearch-env.bat" || exit /b 1
+@echo off
 
-if defined ES_ADDITIONAL_SOURCES (
-  for %%a in ("%ES_ADDITIONAL_SOURCES:;=","%") do (
-    call "%~dp0%%a"
-  )
-)
+setlocal enabledelayedexpansion
 
-if defined ES_ADDITIONAL_CLASSPATH_DIRECTORIES (
-  for %%a in ("%ES_ADDITIONAL_CLASSPATH_DIRECTORIES:;=","%") do (
-    set ES_CLASSPATH=!ES_CLASSPATH!;!ES_HOME!/%%a/*
-  )
-)
+call "%~dp0elasticsearch-env.bat" || exit /b 1
 
 rem use a small heap size for the CLI tools, and thus the serial collector to
 rem avoid stealing many CPU cycles; a user can override by setting ES_JAVA_OPTS
 set ES_JAVA_OPTS=-Xms4m -Xmx64m -XX:+UseSerialGC %ES_JAVA_OPTS%
 
+set LAUNCHER_CLASSPATH=%ES_HOME%/lib/*;%ES_HOME%/lib/cli-launcher/*
+
 %JAVA% ^
-  %ES_JAVA_OPTS% ^
+  %CLI_JAVA_OPTS% ^
+  -Dcli.name="%CLI_NAME%" ^
+  -Dcli.script="%CLI_SCRIPT%" ^
+  -Dcli.libs="%CLI_LIBS%" ^
   -Des.path.home="%ES_HOME%" ^
   -Des.path.conf="%ES_PATH_CONF%" ^
   -Des.distribution.type="%ES_DISTRIBUTION_TYPE%" ^
-  -cp "%ES_CLASSPATH%" ^
-  "%ES_MAIN_CLASS%" ^
+  -cp "%LAUNCHER_CLASSPATH%" ^
+  org.elasticsearch.launcher.CliToolLauncher ^
   %*
 
 exit /b %ERRORLEVEL%
+
+endlocal

distribution/src/bin/elasticsearch-geoip

@@ -1,6 +1,4 @@
 #!/bin/bash
 
-ES_MAIN_CLASS=org.elasticsearch.geoip.GeoIpCli \
-  ES_ADDITIONAL_CLASSPATH_DIRECTORIES=lib/tools/geoip-cli \
-  "`dirname "$0"`"/elasticsearch-cli \
-  "$@"
+CLI_LIBS=lib/tools/geoip-cli
+source "`dirname "$0"`"/elasticsearch-cli

distribution/src/bin/elasticsearch-geoip.bat

@@ -3,8 +3,8 @@
 setlocal enabledelayedexpansion
 setlocal enableextensions
 
-set ES_MAIN_CLASS=org.elasticsearch.geoip.GeoIpCli
-set ES_ADDITIONAL_CLASSPATH_DIRECTORIES=lib/tools/geoip-cli
+set CLI_SCRIPT=%~0
+set CLI_LIBS=lib/tools/geoip-cli
 call "%~dp0elasticsearch-cli.bat" ^
   %%* ^
   || goto exit

distribution/src/bin/elasticsearch-keystore

@@ -1,6 +1,4 @@
 #!/bin/bash
 
-ES_MAIN_CLASS=org.elasticsearch.cli.keystore.KeyStoreCli \
-  ES_ADDITIONAL_CLASSPATH_DIRECTORIES=lib/tools/keystore-cli \
-  "`dirname "$0"`"/elasticsearch-cli \
-  "$@"
+CLI_LIBS=lib/tools/keystore-cli
+source "`dirname "$0"`"/elasticsearch-cli

distribution/src/bin/elasticsearch-keystore.bat

@@ -3,8 +3,8 @@
 setlocal enabledelayedexpansion
 setlocal enableextensions
 
-set ES_MAIN_CLASS=org.elasticsearch.cli.keystore.KeyStoreCli
-set ES_ADDITIONAL_CLASSPATH_DIRECTORIES=lib/tools/keystore-cli
+set CLI_SCRIPT=%~0
+set CLI_LIBS=lib/tools/keystore-cli
 call "%~dp0elasticsearch-cli.bat" ^
   %%* ^
   || goto exit

distribution/src/bin/elasticsearch-node

@@ -1,5 +1,3 @@
 #!/bin/bash
 
-ES_MAIN_CLASS=org.elasticsearch.cluster.coordination.NodeToolCli \
-  "`dirname "$0"`"/elasticsearch-cli \
-  "$@"
+source "`dirname "$0"`"/elasticsearch-cli