chore: Remove unused options from container commands (closes #379)

fortify · Jul 28, 2023 · d2529c0 · d2529c0
1 parent 720ee58
commit d2529c0
Show file tree

Hide file tree

Showing 75 changed files with 176 additions and 149 deletions.
diff --git a/fcli-core/fcli-app/src/main/java/com/fortify/cli/app/_main/cli/cmd/FCLIRootCommands.java b/fcli-core/fcli-app/src/main/java/com/fortify/cli/app/_main/cli/cmd/FCLIRootCommands.java
@@ -13,7 +13,7 @@
 package com.fortify.cli.app._main.cli.cmd;
 
 import com.fortify.cli.app.FortifyCLIVersionProvider;
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractContainerCommand;
 import com.fortify.cli.common.util.DisableTest;
 import com.fortify.cli.common.util.DisableTest.TestType;
 import com.fortify.cli.config._main.cli.cmd.ConfigCommands;
@@ -53,7 +53,7 @@
             UtilCommands.class
     }
 )
-public class FCLIRootCommands extends AbstractFortifyCLICommand {    
+public class FCLIRootCommands extends AbstractContainerCommand {    
     // We only want to have the --version option on the top-level fcli command,
     @Option(names = {"-V", "--version"}, versionHelp = true, scope = ScopeType.LOCAL, order = -1002)
     @DisableTest(TestType.OPT_SHORT_NAME)

diff --git a/.../fcli-app/src/main/java/com/fortify/cli/app/runner/util/FortifyCLIDynamicInitializer.java b/.../fcli-app/src/main/java/com/fortify/cli/app/runner/util/FortifyCLIDynamicInitializer.java
@@ -19,9 +19,9 @@
 
 import org.slf4j.LoggerFactory;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand.GenericOptionsArgGroup;
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand.LogLevel;
+import com.fortify.cli.common.cli.cmd.AbstractRunnableCommand;
+import com.fortify.cli.common.cli.cmd.AbstractRunnableCommand.GenericOptionsArgGroup;
+import com.fortify.cli.common.cli.cmd.AbstractRunnableCommand.LogLevel;
 
 import ch.qos.logback.classic.Logger;
 import ch.qos.logback.classic.LoggerContext;
@@ -111,7 +111,7 @@ private CommandLine createGenericOptionsCommandLine() {
 
     @Command(name = "fcli")
     @RequiredArgsConstructor
-    public static final class FortifyCLIInitializerCommand extends AbstractFortifyCLICommand implements Runnable {
+    public static final class FortifyCLIInitializerCommand extends AbstractRunnableCommand implements Runnable {
         private final Consumer<GenericOptionsArgGroup> consumer;
 
         @Override

diff --git a/fcli-core/fcli-app/src/test/java/com/fortify/cli/FortifyCLITest.java b/fcli-core/fcli-app/src/test/java/com/fortify/cli/FortifyCLITest.java
@@ -101,7 +101,9 @@ private void checkOptions(Results results, CommandSpec cmdSpec) {
 
     private void checkStandardOptions(Results results, CommandSpec spec) {
         var optionNames = spec.optionsMap().keySet();
-        var expectedOptionNames = Arrays.asList("-h", "--help", "--log-level", "--log-file", "--env-prefix");
+        var expectedOptionNames = spec.userObject() instanceof Runnable
+                ? Arrays.asList("-h", "--help", "--log-level", "--log-file", "--env-prefix")
+                : Arrays.asList("-h", "--help");
         if ( !optionNames.containsAll(expectedOptionNames) ) {
             results.add(TestType.CMD_STD_OPTS, Level.ERROR, spec, "Missing one or more standard option names: "+expectedOptionNames);
         }

diff --git a/...re/fcli-common/src/main/java/com/fortify/cli/common/cli/cmd/AbstractContainerCommand.java b/...re/fcli-common/src/main/java/com/fortify/cli/common/cli/cmd/AbstractContainerCommand.java
@@ -0,0 +1,26 @@
+/*******************************************************************************
+ * Copyright 2021, 2023 Open Text.
+ *
+ * The only warranties for products and services of Open Text 
+ * and its affiliates and licensors ("Open Text") are as may 
+ * be set forth in the express warranty statements accompanying 
+ * such products and services. Nothing herein should be construed 
+ * as constituting an additional warranty. Open Text shall not be 
+ * liable for technical or editorial errors or omissions contained 
+ * herein. The information contained herein is subject to change 
+ * without notice.
+ *******************************************************************************/
+package com.fortify.cli.common.cli.cmd;
+
+import picocli.CommandLine.Option;
+
+/**
+ * This abstract class should be used as the base class for all fcli container commands.
+ * It is responsible for providing the standard help option.
+ *
+ * @author Ruud Senden
+ */
+public abstract class AbstractContainerCommand {
+    @Option(names = {"-h", "--help"}, usageHelp = true)
+    private boolean usageHelpRequested;
+}
diff --git a/...on/cli/cmd/AbstractFortifyCLICommand.java → ...mmon/cli/cmd/AbstractRunnableCommand.java b/...on/cli/cmd/AbstractFortifyCLICommand.java → ...mmon/cli/cmd/AbstractRunnableCommand.java
@@ -25,7 +25,7 @@
 import picocli.CommandLine.Spec;
 
 /**
- * This abstract class should be used as the base class for all fcli commands.
+ * This abstract class should be used as the base class for all runnable fcli commands.
  * It is responsible for providing the following fcli features:
  * <ul>
  *  <li>Providing standard command configuration settings (default value provider, ...)</li>
@@ -36,7 +36,7 @@
  *
  * @author Ruud Senden
  */
-public class AbstractFortifyCLICommand {
+public abstract class AbstractRunnableCommand implements Runnable {
     // Have picocli inject the CommandSpec representing the current command
     @Spec private CommandSpec commandSpec;
 

diff --git a/fcli-core/fcli-common/src/main/java/com/fortify/cli/common/cli/mixin/ICommandAware.java b/fcli-core/fcli-common/src/main/java/com/fortify/cli/common/cli/mixin/ICommandAware.java
@@ -12,7 +12,7 @@
  *******************************************************************************/
 package com.fortify.cli.common.cli.mixin;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractRunnableCommand;
 
 import picocli.CommandLine.Model.CommandSpec;
 import picocli.CommandLine.Spec;
@@ -28,7 +28,7 @@
  * <p>Mixins usually wouldn't implement this interface directly, but instead
  * utilize {@link CommandHelperMixin} as it provides some useful utility methods
  * related to the the injected {@link CommandSpec}. Injection is handled 
- * by {@link AbstractFortifyCLICommand}.</p>
+ * by {@link AbstractRunnableCommand}.</p>
  * 
  * @author rsenden
  *

diff --git a/...cli-common/src/main/java/com/fortify/cli/common/output/cli/cmd/AbstractOutputCommand.java b/...cli-common/src/main/java/com/fortify/cli/common/output/cli/cmd/AbstractOutputCommand.java
@@ -15,11 +15,11 @@
 import java.util.Arrays;
 import java.util.List;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractRunnableCommand;
 import com.fortify.cli.common.output.cli.mixin.IOutputHelper;
 import com.fortify.cli.common.output.writer.ISingularSupplier;
 
-public abstract class AbstractOutputCommand extends AbstractFortifyCLICommand implements Runnable, ISingularSupplier {
+public abstract class AbstractOutputCommand extends AbstractRunnableCommand implements Runnable, ISingularSupplier {
     private static final List<Class<?>> supportedInterfaces = Arrays.asList(
             IBaseRequestSupplier.class, 
             IJsonNodeSupplier.class);

diff --git a/...fcli-common/src/main/java/com/fortify/cli/common/rest/cli/cmd/AbstractWaitForCommand.java b/...fcli-common/src/main/java/com/fortify/cli/common/rest/cli/cmd/AbstractWaitForCommand.java
@@ -12,7 +12,7 @@
  *******************************************************************************/
 package com.fortify.cli.common.rest.cli.cmd;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractRunnableCommand;
 import com.fortify.cli.common.output.cli.mixin.OutputHelperMixins;
 import com.fortify.cli.common.output.product.IProductHelperSupplier;
 import com.fortify.cli.common.output.transform.IActionCommandResultSupplier;
@@ -28,7 +28,7 @@
 import lombok.Getter;
 import picocli.CommandLine.Mixin;
 
-public abstract class AbstractWaitForCommand extends AbstractFortifyCLICommand implements IActionCommandResultSupplier, IProductHelperSupplier, ISingularSupplier, Runnable {
+public abstract class AbstractWaitForCommand extends AbstractRunnableCommand implements IActionCommandResultSupplier, IProductHelperSupplier, ISingularSupplier, Runnable {
     @Getter @Mixin private OutputHelperMixins.WaitFor outputHelper;
     @Mixin private WaitHelperControlOptions controlOptions;
     @Mixin private WaitHelperWaitOptions waitOptions;

diff --git a/fcli-core/fcli-config/src/main/java/com/fortify/cli/config/_main/cli/cmd/ConfigCommands.java b/fcli-core/fcli-config/src/main/java/com/fortify/cli/config/_main/cli/cmd/ConfigCommands.java
@@ -12,7 +12,7 @@
  *******************************************************************************/
 package com.fortify.cli.config._main.cli.cmd;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractContainerCommand;
 import com.fortify.cli.config.language.cli.cmd.LanguageCommands;
 import com.fortify.cli.config.proxy.cli.cmd.ProxyCommands;
 import com.fortify.cli.config.truststore.cli.cmd.TrustStoreCommands;
@@ -30,5 +30,5 @@
                 TrustStoreCommands.class
         }
 )
-public class ConfigCommands extends AbstractFortifyCLICommand {
+public class ConfigCommands extends AbstractContainerCommand {
 }
diff --git a/...e/fcli-config/src/main/java/com/fortify/cli/config/language/cli/cmd/LanguageCommands.java b/...e/fcli-config/src/main/java/com/fortify/cli/config/language/cli/cmd/LanguageCommands.java
@@ -12,7 +12,7 @@
  *******************************************************************************/
 package com.fortify.cli.config.language.cli.cmd;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractContainerCommand;
 
 import picocli.CommandLine;
 
@@ -27,5 +27,5 @@
                 LanguageGetCommand.class
         }
 )
-public class LanguageCommands extends AbstractFortifyCLICommand {
+public class LanguageCommands extends AbstractContainerCommand {
 }
diff --git a/fcli-core/fcli-config/src/main/java/com/fortify/cli/config/proxy/cli/cmd/ProxyCommands.java b/fcli-core/fcli-config/src/main/java/com/fortify/cli/config/proxy/cli/cmd/ProxyCommands.java
@@ -12,7 +12,7 @@
  *******************************************************************************/
 package com.fortify.cli.config.proxy.cli.cmd;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractContainerCommand;
 
 import picocli.CommandLine.Command;
 
@@ -26,5 +26,5 @@
             ProxyUpdateCommand.class
         }
 )
-public class ProxyCommands extends AbstractFortifyCLICommand {
+public class ProxyCommands extends AbstractContainerCommand {
 }
diff --git a/...li-config/src/main/java/com/fortify/cli/config/truststore/cli/cmd/TrustStoreCommands.java b/...li-config/src/main/java/com/fortify/cli/config/truststore/cli/cmd/TrustStoreCommands.java
@@ -12,7 +12,7 @@
  *******************************************************************************/
 package com.fortify.cli.config.truststore.cli.cmd;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractContainerCommand;
 
 import picocli.CommandLine.Command;
 
@@ -24,5 +24,5 @@
             TrustStoreSetCommand.class,
         }
 )
-public class TrustStoreCommands extends AbstractFortifyCLICommand {
+public class TrustStoreCommands extends AbstractContainerCommand {
 }
diff --git a/...cli-fod/src/main/java/com/fortify/cli/fod/_common/session/cli/cmd/FoDSessionCommands.java b/...cli-fod/src/main/java/com/fortify/cli/fod/_common/session/cli/cmd/FoDSessionCommands.java
@@ -12,7 +12,7 @@
  *******************************************************************************/
 package com.fortify.cli.fod._common.session.cli.cmd;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractContainerCommand;
 
 import picocli.CommandLine.Command;
 
@@ -24,5 +24,5 @@
                 FoDSessionLogoutCommand.class 
         }
 )
-public class FoDSessionCommands extends AbstractFortifyCLICommand {
+public class FoDSessionCommands extends AbstractContainerCommand {
 }
diff --git a/fcli-core/fcli-fod/src/main/java/com/fortify/cli/fod/_main/cli/cmd/FoDCommands.java b/fcli-core/fcli-fod/src/main/java/com/fortify/cli/fod/_main/cli/cmd/FoDCommands.java
@@ -12,7 +12,7 @@
  *******************************************************************************/
 package com.fortify.cli.fod._main.cli.cmd;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractContainerCommand;
 import com.fortify.cli.fod._common.session.cli.cmd.FoDSessionCommands;
 import com.fortify.cli.fod.app.cli.cmd.FoDAppCommands;
 import com.fortify.cli.fod.microservice.cli.cmd.FoDAppMicroserviceCommands;
@@ -48,4 +48,4 @@
 
         }
 )
-public class FoDCommands extends AbstractFortifyCLICommand {}
+public class FoDCommands extends AbstractContainerCommand {}
diff --git a/fcli-core/fcli-fod/src/main/java/com/fortify/cli/fod/app/cli/cmd/FoDAppCommands.java b/fcli-core/fcli-fod/src/main/java/com/fortify/cli/fod/app/cli/cmd/FoDAppCommands.java
@@ -12,7 +12,7 @@
  *******************************************************************************/
 package com.fortify.cli.fod.app.cli.cmd;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractContainerCommand;
 import com.fortify.cli.common.variable.DefaultVariablePropertyName;
 
 import picocli.CommandLine;
@@ -29,5 +29,5 @@
         }
 )
 @DefaultVariablePropertyName("applicationId")
-public class FoDAppCommands extends AbstractFortifyCLICommand {
+public class FoDAppCommands extends AbstractContainerCommand {
 }
diff --git a/...od/src/main/java/com/fortify/cli/fod/microservice/cli/cmd/FoDAppMicroserviceCommands.java b/...od/src/main/java/com/fortify/cli/fod/microservice/cli/cmd/FoDAppMicroserviceCommands.java
@@ -13,7 +13,7 @@
 
 package com.fortify.cli.fod.microservice.cli.cmd;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractContainerCommand;
 import com.fortify.cli.common.variable.DefaultVariablePropertyName;
 
 import picocli.CommandLine;
@@ -28,5 +28,5 @@
         }
 )
 @DefaultVariablePropertyName("microserviceId")
-public class FoDAppMicroserviceCommands extends AbstractFortifyCLICommand {
+public class FoDAppMicroserviceCommands extends AbstractContainerCommand {
 }
diff --git a/fcli-core/fcli-fod/src/main/java/com/fortify/cli/fod/release/cli/cmd/FoDAppRelCommands.java b/fcli-core/fcli-fod/src/main/java/com/fortify/cli/fod/release/cli/cmd/FoDAppRelCommands.java
@@ -13,7 +13,7 @@
 
 package com.fortify.cli.fod.release.cli.cmd;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractContainerCommand;
 import com.fortify.cli.common.variable.DefaultVariablePropertyName;
 
 import picocli.CommandLine;
@@ -28,5 +28,5 @@
         }
 )
 @DefaultVariablePropertyName("releaseId")
-public class FoDAppRelCommands extends AbstractFortifyCLICommand {
+public class FoDAppRelCommands extends AbstractContainerCommand {
 }
diff --git a/fcli-core/fcli-fod/src/main/java/com/fortify/cli/fod/rest/cli/cmd/FoDRestCommands.java b/fcli-core/fcli-fod/src/main/java/com/fortify/cli/fod/rest/cli/cmd/FoDRestCommands.java
@@ -12,9 +12,9 @@
  *******************************************************************************/
 package com.fortify.cli.fod.rest.cli.cmd;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
-
+import com.fortify.cli.common.cli.cmd.AbstractContainerCommand;
 import com.fortify.cli.fod.rest.lookup.cli.cmd.FoDLookupCommand;
+
 import picocli.CommandLine.Command;
 
 @Command(
@@ -26,5 +26,5 @@
         }
 
 )
-public class FoDRestCommands extends AbstractFortifyCLICommand {
+public class FoDRestCommands extends AbstractContainerCommand {
 }
diff --git a/fcli-core/fcli-fod/src/main/java/com/fortify/cli/fod/scan/cli/cmd/FoDScanCommands.java b/fcli-core/fcli-fod/src/main/java/com/fortify/cli/fod/scan/cli/cmd/FoDScanCommands.java
@@ -13,7 +13,7 @@
 
 package com.fortify.cli.fod.scan.cli.cmd;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractContainerCommand;
 import com.fortify.cli.common.variable.DefaultVariablePropertyName;
 import com.fortify.cli.fod.scan.cli.cmd.dast.FoDDastScanImportCommand;
 import com.fortify.cli.fod.scan.cli.cmd.dast.FoDDastScanStartCommand;
@@ -48,5 +48,5 @@
         }
 )
 @DefaultVariablePropertyName("scanId")
-public class FoDScanCommands extends AbstractFortifyCLICommand {
+public class FoDScanCommands extends AbstractContainerCommand {
 }
diff --git a/fcli-core/fcli-fod/src/main/java/com/fortify/cli/fod/user/cli/cmd/FoDUserCommands.java b/fcli-core/fcli-fod/src/main/java/com/fortify/cli/fod/user/cli/cmd/FoDUserCommands.java
@@ -12,7 +12,7 @@
  *******************************************************************************/
 package com.fortify.cli.fod.user.cli.cmd;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractContainerCommand;
 import com.fortify.cli.common.variable.DefaultVariablePropertyName;
 
 import picocli.CommandLine;
@@ -27,5 +27,5 @@
         }
 )
 @DefaultVariablePropertyName("userId")
-public class FoDUserCommands extends AbstractFortifyCLICommand {
+public class FoDUserCommands extends AbstractContainerCommand {
 }
diff --git a/...e/fcli-fod/src/main/java/com/fortify/cli/fod/user_group/cli/cmd/FoDUserGroupCommands.java b/...e/fcli-fod/src/main/java/com/fortify/cli/fod/user_group/cli/cmd/FoDUserGroupCommands.java
@@ -12,7 +12,7 @@
  *******************************************************************************/
 package com.fortify.cli.fod.user_group.cli.cmd;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractContainerCommand;
 import com.fortify.cli.common.variable.DefaultVariablePropertyName;
 
 import picocli.CommandLine;
@@ -27,5 +27,5 @@
         }
 )
 @DefaultVariablePropertyName("id")
-public class FoDUserGroupCommands extends AbstractFortifyCLICommand {
+public class FoDUserGroupCommands extends AbstractContainerCommand {
 }
diff --git a/...ore/fcli-license/src/main/java/com/fortify/cli/license/_main/cli/cmd/LicenseCommands.java b/...ore/fcli-license/src/main/java/com/fortify/cli/license/_main/cli/cmd/LicenseCommands.java
@@ -12,7 +12,7 @@
  *******************************************************************************/
 package com.fortify.cli.license._main.cli.cmd;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractContainerCommand;
 import com.fortify.cli.license.msp_report.cli.cmd.MspReportCommands;
 import com.fortify.cli.license.ncd_report.cli.cmd.NcdReportCommands;
 
@@ -26,4 +26,4 @@
             NcdReportCommands.class
         }
 )
-public class LicenseCommands extends AbstractFortifyCLICommand {}
+public class LicenseCommands extends AbstractContainerCommand {}
diff --git a/...i-license/src/main/java/com/fortify/cli/license/msp_report/cli/cmd/MspReportCommands.java b/...i-license/src/main/java/com/fortify/cli/license/msp_report/cli/cmd/MspReportCommands.java
@@ -12,7 +12,7 @@
  *******************************************************************************/
 package com.fortify.cli.license.msp_report.cli.cmd;
 
-import com.fortify.cli.common.cli.cmd.AbstractFortifyCLICommand;
+import com.fortify.cli.common.cli.cmd.AbstractContainerCommand;
 
 import picocli.CommandLine.Command;
 
@@ -23,4 +23,4 @@
             MspReportGenerateConfigCommand.class
         }
 )
-public class MspReportCommands extends AbstractFortifyCLICommand {}
+public class MspReportCommands extends AbstractContainerCommand {}