Remove conflicts and refactor the code to use DeprecatedCliOption class

Author: hani-fouladgar

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

@@ -23,7 +23,7 @@
 import java.util.Objects;
 
 /**
- * Emits warnings when deprecated multi-character short CLI options are used.
+ * Emits warnings when deprecated CLI option aliases are used.
  */
 public final class DeprecatedCliOption {
 
@@ -47,6 +47,35 @@ private static Map<String, String> buildDeprecatedOptions() {
     options.put("-tact", "--transaction-apply-check-interval");
     options.put("-pct", "--prepare-check-interval");
     options.put("-pt", "--prepare-timeout");
+    options.put("--accessId", "--access-id");
+    options.put("--bufferSize", "--buffer-size");
+    options.put("--column_family", "--column-family");
+    options.put("--dnSchema", "--dn-schema");
+    options.put("--expectedGeneration", "--expected-generation");
+    options.put("--fileCount", "--file-count");
+    options.put("--fileSize", "--file-size");
+    options.put("--filterByFactor", "--filter-by-factor");
+    options.put("--filterByState", "--filter-by-state");
+    options.put("--keySize", "--key-size");
+    options.put("--maxDatanodesPercentageToInvolvePerIteration",
+        "--max-datanodes-percentage-to-involve-per-iteration");
+    options.put("--maxSizeEnteringTargetInGB", "--max-size-entering-target-in-gb");
+    options.put("--maxSizeLeavingSourceInGB", "--max-size-leaving-source-in-gb");
+    options.put("--maxSizeToMovePerIterationInGB", "--max-size-to-move-per-iteration-in-gb");
+    options.put("--nameLen", "--name-len");
+    options.put("--newLeaderId", "--new-leader-id");
+    options.put("--numOfBuckets", "--num-of-buckets");
+    options.put("--numOfKeys", "--num-of-keys");
+    options.put("--numOfThreads", "--num-of-threads");
+    options.put("--numOfValidateThreads", "--num-of-validate-threads");
+    options.put("--numOfVolumes", "--num-of-volumes");
+    options.put("--onlyFileNames", "--only-file-names");
+    options.put("--replicationFactor", "--replication-factor");
+    options.put("--replicationType", "--replication-type");
+    options.put("--scmHost", "--scm-host");
+    options.put("--secretKey", "--secret");
+    options.put("--segmentPath", "--segment-path");
+    options.put("--validateWrites", "--validate-writes");
     return options;
   }
 

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

@@ -184,57 +184,8 @@ private Optional<Long> resolveMaxSizeLeavingSourceInGB() {
     return deprecatedMaxSizeLeavingSourceInGB;
   }
 
-  private void warnIfDeprecatedMaxDatanodesPercentageUsed() {
-    if (deprecatedMaxDatanodesPercentage != null
-        && deprecatedMaxDatanodesPercentage.isPresent()
-        && (maxDatanodesPercentageToInvolvePerIteration == null
-            || !maxDatanodesPercentageToInvolvePerIteration.isPresent())) {
-      System.err.println("warning: --maxDatanodesPercentageToInvolvePerIteration "
-          + "is deprecated, use --max-datanodes-percentage-to-involve-per-iteration "
-          + "instead.");
-    }
-  }
-
-  private void warnIfDeprecatedMaxSizeToMovePerIterationInGBUsed() {
-    if (deprecatedMaxSizeToMovePerIterationInGB != null
-        && deprecatedMaxSizeToMovePerIterationInGB.isPresent()
-        && (maxSizeToMovePerIterationInGB == null
-            || !maxSizeToMovePerIterationInGB.isPresent())) {
-      System.err.println("warning: --maxSizeToMovePerIterationInGB is deprecated, "
-          + "use --max-size-to-move-per-iteration-in-gb instead.");
-    }
-  }
-
-  private void warnIfDeprecatedMaxSizeEnteringTargetInGBUsed() {
-    if (deprecatedMaxSizeEnteringTargetInGB != null
-        && deprecatedMaxSizeEnteringTargetInGB.isPresent()
-        && (maxSizeEnteringTargetInGB == null
-            || !maxSizeEnteringTargetInGB.isPresent())) {
-      System.err.println("warning: --maxSizeEnteringTargetInGB is deprecated, "
-          + "use --max-size-entering-target-in-gb instead.");
-    }
-  }
-
-  private void warnIfDeprecatedMaxSizeLeavingSourceInGBUsed() {
-    if (deprecatedMaxSizeLeavingSourceInGB != null
-        && deprecatedMaxSizeLeavingSourceInGB.isPresent()
-        && (maxSizeLeavingSourceInGB == null
-            || !maxSizeLeavingSourceInGB.isPresent())) {
-      System.err.println("warning: --maxSizeLeavingSourceInGB is deprecated, "
-          + "use --max-size-leaving-source-in-gb instead.");
-    }
-  }
-
-  private void warnIfDeprecatedOptionsUsed() {
-    warnIfDeprecatedMaxDatanodesPercentageUsed();
-    warnIfDeprecatedMaxSizeToMovePerIterationInGBUsed();
-    warnIfDeprecatedMaxSizeEnteringTargetInGBUsed();
-    warnIfDeprecatedMaxSizeLeavingSourceInGBUsed();
-  }
-
   @Override
   public void execute(ScmClient scmClient) throws IOException {
-    warnIfDeprecatedOptionsUsed();
     StartContainerBalancerResponseProto response = scmClient.
         startContainerBalancer(threshold, iterations,
         resolveMaxDatanodesPercentageToInvolvePerIteration(),

hadoop-ozone/cli-admin/src/main/java/org/apache/hadoop/hdds/scm/cli/ContainerBalancerStartSubcommand.java

@@ -18,7 +18,6 @@
 package org.apache.hadoop.hdds.scm.cli.pipeline;
 
 import java.io.IOException;
-import org.apache.hadoop.hdds.cli.DeprecatedCliOptions;
 import org.apache.hadoop.hdds.cli.HddsVersionProvider;
 import org.apache.hadoop.hdds.protocol.proto.HddsProtos;
 import org.apache.hadoop.hdds.scm.cli.ScmSubcommand;
@@ -36,13 +35,9 @@
     versionProvider = HddsVersionProvider.class)
 public class CreatePipelineSubcommand extends ScmSubcommand {
 
-  @CommandLine.Spec
-  private CommandLine.Model.CommandSpec spec;
-
   @CommandLine.Option(
       names = {"-t", "--replication-type"},
       description = "Replication type is RATIS.",
-      defaultValue = "RATIS",
       hidden = true
   )
   private HddsProtos.ReplicationType type;
@@ -55,8 +50,7 @@ public class CreatePipelineSubcommand extends ScmSubcommand {
 
   @CommandLine.Option(
       names = {"-f", "--replication-factor"},
-      description = "Replication factor for RATIS (ONE, THREE).",
-      defaultValue = "ONE"
+      description = "Replication factor for RATIS (ONE, THREE)."
   )
   private HddsProtos.ReplicationFactor factor;
 
@@ -66,34 +60,30 @@ public class CreatePipelineSubcommand extends ScmSubcommand {
   @CommandLine.Option(names = "--replicationFactor", hidden = true)
   private HddsProtos.ReplicationFactor deprecatedReplicationFactor;
 
-  private HddsProtos.ReplicationType resolveReplicationType() {
-    if (DeprecatedCliOptions.hasMatchedOption(spec, "--replicationType")) {
-      return deprecatedReplicationType != null ? deprecatedReplicationType : type;
+  private HddsProtos.ReplicationType getReplicationType() {
+    if (type != null) {
+      return type;
     }
-    return type;
-  }
-
-  private HddsProtos.ReplicationFactor resolveReplicationFactor() {
-    if (DeprecatedCliOptions.hasMatchedOption(spec, "--replicationFactor")) {
-      return deprecatedReplicationFactor != null ? deprecatedReplicationFactor : factor;
+    if (deprecatedReplicationType != null) {
+      return deprecatedReplicationType;
     }
-    return factor;
+    return HddsProtos.ReplicationType.RATIS;
   }
 
-  private void warnIfDeprecatedOptionsUsed() {
-    DeprecatedCliOptions.warnIfDeprecatedUsedWithoutCanonical(
-        "--replicationType", "--replication-type", spec,
-        "--replication-type", "-t");
-    DeprecatedCliOptions.warnIfDeprecatedUsedWithoutCanonical(
-        "--replicationFactor", "--replication-factor", spec,
-        "--replication-factor", "-f");
+  private HddsProtos.ReplicationFactor getReplicationFactor() {
+    if (factor != null) {
+      return factor;
+    }
+    if (deprecatedReplicationFactor != null) {
+      return deprecatedReplicationFactor;
+    }
+    return HddsProtos.ReplicationFactor.ONE;
   }
 
   @Override
   public void execute(ScmClient scmClient) throws IOException {
-    warnIfDeprecatedOptionsUsed();
-    HddsProtos.ReplicationType resolvedType = resolveReplicationType();
-    HddsProtos.ReplicationFactor resolvedFactor = resolveReplicationFactor();
+    HddsProtos.ReplicationType resolvedType = getReplicationType();
+    HddsProtos.ReplicationFactor resolvedFactor = getReplicationFactor();
     // Once we support creating EC containers/pipelines from the client, the
     // client should check if SCM is able to fulfil the request, and
     // understands an EcReplicationConfig. For that we also need to have SCM's

hadoop-ozone/cli-admin/src/main/java/org/apache/hadoop/hdds/scm/cli/pipeline/CreatePipelineSubcommand.java

@@ -44,7 +44,6 @@ public class FilterPipelineOptions {
       defaultValue = "")
   private String replication;
 
-
   @CommandLine.Option(
       names = {"--filter-by-factor"},
       description = "[deprecated] Filter pipelines by factor (e.g. ONE, THREE) (implies RATIS replication type)")

hadoop-ozone/cli-admin/src/main/java/org/apache/hadoop/hdds/scm/cli/pipeline/FilterPipelineOptions.java

@@ -63,7 +63,12 @@ public void execute(ScmClient scmClient) throws IOException {
     if (replicationFilter.isPresent()) {
       stream = stream.filter(replicationFilter.get());
     }
+<<<<<<< HEAD
     if (!Strings.isNullOrEmpty(state)) {
+=======
+    String effectiveState = getState();
+    if (!Strings.isNullOrEmpty(effectiveState)) {
+>>>>>>> a71ff80348 (Remove conflicts and refactor the code to use DeprecatedCliOption class)
       stream = stream.filter(p -> p.getPipelineState().toString()
           .compareToIgnoreCase(state) == 0);
     }

hadoop-ozone/cli-admin/src/main/java/org/apache/hadoop/hdds/scm/cli/pipeline/ListPipelinesSubcommand.java

@@ -18,7 +18,6 @@
 package org.apache.hadoop.ozone.admin.om;
 
 import java.util.concurrent.Callable;
-import org.apache.hadoop.hdds.cli.DeprecatedCliOptions;
 import org.apache.hadoop.hdds.cli.HddsVersionProvider;
 import org.apache.hadoop.ozone.om.protocol.OzoneManagerProtocol;
 import picocli.CommandLine;
@@ -37,9 +36,6 @@ public class TransferOmLeaderSubCommand implements Callable<Void> {
   @CommandLine.Mixin
   private OmAddressOptions.OptionalServiceIdMixin omServiceOption;
 
-  @CommandLine.Spec
-  private CommandLine.Model.CommandSpec spec;
-
   @CommandLine.ArgGroup(multiplicity = "1")
   private TransferOption configGroup;
 
@@ -59,17 +55,18 @@ static class TransferOption {
     @CommandLine.Option(names = {"-r", "--random"},
         description = "Randomly choose a follower to transfer leadership.")
     private boolean isRandom;
+
+    String getOmNodeId() {
+      return omNodeId != null ? omNodeId : deprecatedOmNodeId;
+    }
   }
 
   @Override
   public Void call() throws Exception {
     if (configGroup.isRandom) {
       configGroup.omNodeId = "";
     } else {
-      DeprecatedCliOptions.warnIfDeprecatedUsedWithoutCanonical(
-          "--newLeaderId", "--new-leader-id", spec, "--new-leader-id", "-n");
-      configGroup.omNodeId = DeprecatedCliOptions.resolveString(
-          configGroup.omNodeId, configGroup.deprecatedOmNodeId);
+      configGroup.omNodeId = configGroup.getOmNodeId();
     }
     try (OzoneManagerProtocol client = omServiceOption.newClient()) {
       client.transferLeadership(configGroup.omNodeId);

hadoop-ozone/cli-admin/src/main/java/org/apache/hadoop/ozone/admin/om/TransferOmLeaderSubCommand.java

@@ -18,7 +18,6 @@
 package org.apache.hadoop.ozone.admin.scm;
 
 import java.util.concurrent.Callable;
-import org.apache.hadoop.hdds.cli.DeprecatedCliOptions;
 import org.apache.hadoop.hdds.cli.HddsVersionProvider;
 import org.apache.hadoop.hdds.scm.cli.ScmOption;
 import org.apache.hadoop.hdds.scm.client.ScmClient;
@@ -42,9 +41,6 @@ public class TransferScmLeaderSubCommand implements Callable<Void> {
   @Mixin
   private ScmOption scmOption;
 
-  @CommandLine.Spec
-  private CommandLine.Model.CommandSpec spec;
-
   @CommandLine.ArgGroup(multiplicity = "1")
   private TransferOption configGroup;
 
@@ -65,6 +61,10 @@ static class TransferOption {
     @CommandLine.Option(names = {"-r", "--random"},
         description = "Randomly choose a follower to transfer leadership.")
     private boolean isRandom;
+
+    String getScmId() {
+      return scmId != null ? scmId : deprecatedScmId;
+    }
   }
 
   @Override
@@ -74,10 +74,7 @@ public Void call() throws Exception {
     if (configGroup.isRandom) {
       configGroup.scmId = "";
     } else {
-      DeprecatedCliOptions.warnIfDeprecatedUsedWithoutCanonical(
-          "--newLeaderId", "--new-leader-id", spec, "--new-leader-id", "-n");
-      configGroup.scmId = DeprecatedCliOptions.resolveString(
-          configGroup.scmId, configGroup.deprecatedScmId);
+      configGroup.scmId = configGroup.getScmId();
     }
     client.transferLeadership(configGroup.scmId);
     System.out.println("Transfer leadership successfully to " +