Refactor for JPMS Support

Signed-off-by: Prudhvi Godithi <[email protected]>
prudhvigodithi · Jan 28, 2025 · 588bd0d · 588bd0d
1 parent b5234a5
commit 588bd0d
Show file tree

Hide file tree

Showing 26 changed files with 35 additions and 78 deletions.
diff --git a/...ools/keystore-cli/src/main/java/org/opensearch/common/settings/CreateKeyStoreCommand.java b/...ools/keystore-cli/src/main/java/org/opensearch/common/settings/CreateKeyStoreCommand.java
@@ -35,9 +35,9 @@
 import joptsimple.OptionSet;
 import joptsimple.OptionSpec;
 import org.opensearch.cli.ExitCodes;
-import org.opensearch.cli.KeyStoreAwareCommand;
 import org.opensearch.cli.Terminal;
 import org.opensearch.cli.UserException;
+import org.opensearch.common.cli.KeyStoreAwareCommand;
 import org.opensearch.core.common.settings.SecureString;
 import org.opensearch.env.Environment;
 

diff --git a/...ribution/tools/keystore-cli/src/main/java/org/opensearch/common/settings/KeyStoreCli.java b/...ribution/tools/keystore-cli/src/main/java/org/opensearch/common/settings/KeyStoreCli.java
@@ -32,8 +32,8 @@
 
 package org.opensearch.common.settings;
 
-import org.opensearch.cli.LoggingAwareMultiCommand;
 import org.opensearch.cli.Terminal;
+import org.opensearch.common.cli.LoggingAwareMultiCommand;
 
 /**
  * A CLI tool for managing secrets in the OpenSearch keystore.

diff --git a/distribution/tools/plugin-cli/src/main/java/org/opensearch/plugins/InstallPluginCommand.java b/distribution/tools/plugin-cli/src/main/java/org/opensearch/plugins/InstallPluginCommand.java
@@ -52,12 +52,12 @@
 import org.bouncycastle.openpgp.operator.jcajce.JcaPGPContentVerifierBuilderProvider;
 import org.opensearch.Build;
 import org.opensearch.Version;
-import org.opensearch.cli.EnvironmentAwareCommand;
 import org.opensearch.cli.ExitCodes;
 import org.opensearch.cli.Terminal;
 import org.opensearch.cli.UserException;
 import org.opensearch.common.SuppressForbidden;
 import org.opensearch.common.bootstrap.JarHell;
+import org.opensearch.common.cli.EnvironmentAwareCommand;
 import org.opensearch.common.collect.Tuple;
 import org.opensearch.common.hash.MessageDigests;
 import org.opensearch.common.util.io.IOUtils;

diff --git a/distribution/tools/plugin-cli/src/main/java/org/opensearch/plugins/ListPluginsCommand.java b/distribution/tools/plugin-cli/src/main/java/org/opensearch/plugins/ListPluginsCommand.java
@@ -34,8 +34,8 @@
 
 import joptsimple.OptionSet;
 import org.opensearch.Version;
-import org.opensearch.cli.EnvironmentAwareCommand;
 import org.opensearch.cli.Terminal;
+import org.opensearch.common.cli.EnvironmentAwareCommand;
 import org.opensearch.env.Environment;
 
 import java.io.IOException;

diff --git a/distribution/tools/plugin-cli/src/main/java/org/opensearch/plugins/PluginCli.java b/distribution/tools/plugin-cli/src/main/java/org/opensearch/plugins/PluginCli.java
@@ -33,8 +33,8 @@
 package org.opensearch.plugins;
 
 import org.opensearch.cli.Command;
-import org.opensearch.cli.LoggingAwareMultiCommand;
 import org.opensearch.cli.Terminal;
+import org.opensearch.common.cli.LoggingAwareMultiCommand;
 import org.opensearch.common.util.io.IOUtils;
 
 import java.io.IOException;

diff --git a/distribution/tools/plugin-cli/src/main/java/org/opensearch/plugins/RemovePluginCommand.java b/distribution/tools/plugin-cli/src/main/java/org/opensearch/plugins/RemovePluginCommand.java
@@ -34,10 +34,10 @@
 
 import joptsimple.OptionSet;
 import joptsimple.OptionSpec;
-import org.opensearch.cli.EnvironmentAwareCommand;
 import org.opensearch.cli.ExitCodes;
 import org.opensearch.cli.Terminal;
 import org.opensearch.cli.UserException;
+import org.opensearch.common.cli.EnvironmentAwareCommand;
 import org.opensearch.common.util.io.IOUtils;
 import org.opensearch.env.Environment;
 

diff --git a/distribution/tools/upgrade-cli/src/main/java/org/opensearch/upgrade/UpgradeCli.java b/distribution/tools/upgrade-cli/src/main/java/org/opensearch/upgrade/UpgradeCli.java
@@ -9,10 +9,10 @@
 package org.opensearch.upgrade;
 
 import joptsimple.OptionSet;
-import org.opensearch.cli.EnvironmentAwareCommand;
 import org.opensearch.cli.ExitCodes;
 import org.opensearch.cli.Terminal;
 import org.opensearch.cli.UserException;
+import org.opensearch.common.cli.EnvironmentAwareCommand;
 import org.opensearch.common.collect.Tuple;
 import org.opensearch.env.Environment;
 

diff --git a/libs/cli/build.gradle b/libs/cli/build.gradle
@@ -33,11 +33,11 @@ apply plugin: 'opensearch.publish'
 dependencies {
   api 'net.sf.jopt-simple:jopt-simple:5.0.4'
   api project(':libs:opensearch-common')
-}
 
-test.enabled = false
-// Since CLI does not depend on :server, it cannot run the jarHell task
-jarHell.enabled = false
+  testImplementation(project(":test:framework")) {
+    exclude group: 'org.opensearch', module: 'opensearch-cli'
+  }
+}
 
 tasks.named('forbiddenApisMain').configure {
   replaceSignatureFiles 'jdk-signatures'

diff --git a/libs/cli/src/main/java/org/opensearch/cli/Command.java b/libs/cli/src/main/java/org/opensearch/cli/Command.java
@@ -119,7 +119,7 @@ public final int main(String[] args, Terminal terminal) throws Exception {
     /**
      * Executes the command, but all errors are thrown.
      */
-    void mainWithoutErrorHandling(String[] args, Terminal terminal) throws Exception {
+    protected void mainWithoutErrorHandling(String[] args, Terminal terminal) throws Exception {
         final OptionSet options = parser.parse(args);
 
         if (options.has(helpOption)) {

diff --git a/...java/org/opensearch/cli/CommandTests.java → ...java/org/opensearch/cli/CommandTests.java b/...java/org/opensearch/cli/CommandTests.java → ...java/org/opensearch/cli/CommandTests.java
diff --git a/...org/opensearch/cli/MultiCommandTests.java → ...org/opensearch/cli/MultiCommandTests.java b/...org/opensearch/cli/MultiCommandTests.java → ...org/opensearch/cli/MultiCommandTests.java
diff --git a/...ava/org/opensearch/cli/TerminalTests.java → ...ava/org/opensearch/cli/TerminalTests.java b/...ava/org/opensearch/cli/TerminalTests.java → ...ava/org/opensearch/cli/TerminalTests.java
diff --git a/qa/evil-tests/src/test/java/org/opensearch/cli/EvilEnvironmentAwareCommandTests.java b/qa/evil-tests/src/test/java/org/opensearch/cli/EvilEnvironmentAwareCommandTests.java
@@ -35,6 +35,7 @@
 import joptsimple.OptionSet;
 import org.apache.lucene.tests.util.TestRuleRestoreSystemProperties;
 import org.opensearch.common.SuppressForbidden;
+import org.opensearch.common.cli.EnvironmentAwareCommand;
 import org.opensearch.env.Environment;
 import org.opensearch.test.OpenSearchTestCase;
 import org.junit.Rule;

diff --git a/server/src/main/java/org/opensearch/bootstrap/Bootstrap.java b/server/src/main/java/org/opensearch/bootstrap/Bootstrap.java
@@ -42,12 +42,12 @@
 import org.apache.lucene.util.StringHelper;
 import org.opensearch.OpenSearchException;
 import org.opensearch.Version;
-import org.opensearch.cli.KeyStoreAwareCommand;
 import org.opensearch.cli.Terminal;
 import org.opensearch.cli.UserException;
 import org.opensearch.common.PidFile;
 import org.opensearch.common.SuppressForbidden;
 import org.opensearch.common.bootstrap.JarHell;
+import org.opensearch.common.cli.KeyStoreAwareCommand;
 import org.opensearch.common.inject.CreationException;
 import org.opensearch.common.logging.LogConfigurator;
 import org.opensearch.common.logging.Loggers;

diff --git a/server/src/main/java/org/opensearch/bootstrap/OpenSearch.java b/server/src/main/java/org/opensearch/bootstrap/OpenSearch.java
@@ -37,10 +37,10 @@
 import joptsimple.OptionSpecBuilder;
 import joptsimple.util.PathConverter;
 import org.opensearch.Build;
-import org.opensearch.cli.EnvironmentAwareCommand;
 import org.opensearch.cli.ExitCodes;
 import org.opensearch.cli.Terminal;
 import org.opensearch.cli.UserException;
+import org.opensearch.common.cli.EnvironmentAwareCommand;
 import org.opensearch.common.logging.LogConfigurator;
 import org.opensearch.env.Environment;
 import org.opensearch.monitor.jvm.JvmInfo;

diff --git a/server/src/main/java/org/opensearch/cli/LoggingAwareCommand.java b/server/src/main/java/org/opensearch/cli/LoggingAwareCommand.java
diff --git a/server/src/main/java/org/opensearch/cluster/coordination/NodeToolCli.java b/server/src/main/java/org/opensearch/cluster/coordination/NodeToolCli.java
@@ -31,9 +31,9 @@
 
 package org.opensearch.cluster.coordination;
 
-import org.opensearch.cli.CommandLoggingConfigurator;
 import org.opensearch.cli.MultiCommand;
 import org.opensearch.cli.Terminal;
+import org.opensearch.common.cli.CommandLoggingConfigurator;
 import org.opensearch.env.NodeRepurposeCommand;
 import org.opensearch.env.OverrideNodeVersionCommand;
 

diff --git a/server/src/main/java/org/opensearch/cluster/coordination/OpenSearchNodeCommand.java b/server/src/main/java/org/opensearch/cluster/coordination/OpenSearchNodeCommand.java
@@ -40,7 +40,6 @@
 import org.opensearch.OpenSearchException;
 import org.opensearch.Version;
 import org.opensearch.action.admin.indices.rollover.Condition;
-import org.opensearch.cli.EnvironmentAwareCommand;
 import org.opensearch.cli.Terminal;
 import org.opensearch.cli.UserException;
 import org.opensearch.cluster.ClusterModule;
@@ -50,6 +49,7 @@
 import org.opensearch.cluster.metadata.ComponentTemplateMetadata;
 import org.opensearch.cluster.metadata.DataStreamMetadata;
 import org.opensearch.cluster.metadata.Metadata;
+import org.opensearch.common.cli.EnvironmentAwareCommand;
 import org.opensearch.common.collect.Tuple;
 import org.opensearch.common.settings.ClusterSettings;
 import org.opensearch.common.settings.Settings;

diff --git a/...earch/cli/CommandLoggingConfigurator.java → ...ommon/cli/CommandLoggingConfigurator.java b/...earch/cli/CommandLoggingConfigurator.java → ...ommon/cli/CommandLoggingConfigurator.java
@@ -30,7 +30,7 @@
  * GitHub history for details.
  */
 
-package org.opensearch.cli;
+package org.opensearch.common.cli;
 
 import org.apache.logging.log4j.Level;
 import org.opensearch.common.logging.LogConfigurator;

diff --git a/...ensearch/cli/EnvironmentAwareCommand.java → ...h/common/cli/EnvironmentAwareCommand.java b/...ensearch/cli/EnvironmentAwareCommand.java → ...h/common/cli/EnvironmentAwareCommand.java
@@ -30,11 +30,15 @@
  * GitHub history for details.
  */
 
-package org.opensearch.cli;
+package org.opensearch.common.cli;
 
 import joptsimple.OptionSet;
 import joptsimple.OptionSpec;
 import joptsimple.util.KeyValuePair;
+import org.opensearch.cli.Command;
+import org.opensearch.cli.ExitCodes;
+import org.opensearch.cli.Terminal;
+import org.opensearch.cli.UserException;
 import org.opensearch.common.SuppressForbidden;
 import org.opensearch.common.settings.Settings;
 import org.opensearch.env.Environment;

diff --git a/.../opensearch/cli/KeyStoreAwareCommand.java → ...arch/common/cli/KeyStoreAwareCommand.java b/.../opensearch/cli/KeyStoreAwareCommand.java → ...arch/common/cli/KeyStoreAwareCommand.java
@@ -30,9 +30,12 @@
  * GitHub history for details.
  */
 
-package org.opensearch.cli;
+package org.opensearch.common.cli;
 
 import joptsimple.OptionSet;
+import org.opensearch.cli.ExitCodes;
+import org.opensearch.cli.Terminal;
+import org.opensearch.cli.UserException;
 import org.opensearch.common.settings.KeyStoreWrapper;
 import org.opensearch.core.common.settings.SecureString;
 import org.opensearch.env.Environment;
@@ -42,7 +45,7 @@
 import java.util.Arrays;
 
 /**
- * An {@link org.opensearch.cli.EnvironmentAwareCommand} that needs to access the opensearch keystore, possibly
+ * An {@link EnvironmentAwareCommand} that needs to access the opensearch keystore, possibly
  * decrypting it if it is password protected.
  *
  * @opensearch.internal

diff --git a/...nsearch/cli/LoggingAwareMultiCommand.java → .../common/cli/LoggingAwareMultiCommand.java b/...nsearch/cli/LoggingAwareMultiCommand.java → .../common/cli/LoggingAwareMultiCommand.java
@@ -30,7 +30,9 @@
  * GitHub history for details.
  */
 
-package org.opensearch.cli;
+package org.opensearch.common.cli;
+
+import org.opensearch.cli.MultiCommand;
 
 /**
  * A multi-command that is aware of logging. This class should be preferred over the base {@link MultiCommand} class for any CLI tools that

diff --git a/...java/org/opensearch/cli/package-info.java → ...g/opensearch/common/cli/package-info.java b/...java/org/opensearch/cli/package-info.java → ...g/opensearch/common/cli/package-info.java
@@ -9,4 +9,4 @@
 /**
  * The command line interface module.
  */
-package org.opensearch.cli;
+package org.opensearch.common.cli;
diff --git a/server/src/main/java/org/opensearch/common/settings/BaseKeyStoreCommand.java b/server/src/main/java/org/opensearch/common/settings/BaseKeyStoreCommand.java
@@ -35,9 +35,9 @@
 import joptsimple.OptionSet;
 import joptsimple.OptionSpec;
 import org.opensearch.cli.ExitCodes;
-import org.opensearch.cli.KeyStoreAwareCommand;
 import org.opensearch.cli.Terminal;
 import org.opensearch.cli.UserException;
+import org.opensearch.common.cli.KeyStoreAwareCommand;
 import org.opensearch.core.common.settings.SecureString;
 import org.opensearch.env.Environment;
 

diff --git a/server/src/main/java/org/opensearch/common/settings/HasPasswordKeyStoreCommand.java b/server/src/main/java/org/opensearch/common/settings/HasPasswordKeyStoreCommand.java
@@ -33,9 +33,9 @@
 package org.opensearch.common.settings;
 
 import joptsimple.OptionSet;
-import org.opensearch.cli.KeyStoreAwareCommand;
 import org.opensearch.cli.Terminal;
 import org.opensearch.cli.UserException;
+import org.opensearch.common.cli.KeyStoreAwareCommand;
 import org.opensearch.env.Environment;
 
 import java.nio.file.Path;

diff --git a/server/src/main/java/org/opensearch/index/shard/ShardToolCli.java b/server/src/main/java/org/opensearch/index/shard/ShardToolCli.java
@@ -31,8 +31,8 @@
 
 package org.opensearch.index.shard;
 
-import org.opensearch.cli.LoggingAwareMultiCommand;
 import org.opensearch.cli.Terminal;
+import org.opensearch.common.cli.LoggingAwareMultiCommand;
 
 /**
  * Class encapsulating and dispatching commands from the {@code opensearch-shard} command line tool