HDDS-12078. Improve container reconciliation CLIs

hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/scm/container/ContainerReplicaInfo.java

@@ -17,16 +17,11 @@
 
 package org.apache.hadoop.hdds.scm.container;
 
-import static org.apache.hadoop.hdds.HddsUtils.checksumToString;
-
-import com.fasterxml.jackson.core.JsonGenerator;
-import com.fasterxml.jackson.databind.JsonSerializer;
-import com.fasterxml.jackson.databind.SerializerProvider;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
-import java.io.IOException;
 import java.util.UUID;
 import org.apache.hadoop.hdds.protocol.DatanodeDetails;
 import org.apache.hadoop.hdds.protocol.proto.HddsProtos;
+import org.apache.hadoop.hdds.server.JsonUtils;
 
 /**
  * Class which stores ContainerReplica details on the client.
@@ -41,7 +36,7 @@ public final class ContainerReplicaInfo {
   private long keyCount;
   private long bytesUsed;
   private int replicaIndex = -1;
-  @JsonSerialize(using = LongToHexJsonSerializer.class)
+  @JsonSerialize(using = JsonUtils.ChecksumSerializer.class)
   private long dataChecksum;
 
   public static ContainerReplicaInfo fromProto(
@@ -100,13 +95,6 @@ public long getDataChecksum() {
     return dataChecksum;
   }
 
-  private static class LongToHexJsonSerializer extends JsonSerializer<Long> {
-    @Override
-    public void serialize(Long value, JsonGenerator gen, SerializerProvider provider) throws IOException {
-      gen.writeString(checksumToString(value));
-    }
-  }
-
   /**
    * Builder for ContainerReplicaInfo class.
    */

hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/server/JsonUtils.java

@@ -18,21 +18,26 @@
 package org.apache.hadoop.hdds.server;
 
 import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.JsonSerializer;
 import com.fasterxml.jackson.databind.MappingIterator;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.ObjectReader;
 import com.fasterxml.jackson.databind.ObjectWriter;
 import com.fasterxml.jackson.databind.SequenceWriter;
 import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.databind.SerializerProvider;
 import com.fasterxml.jackson.databind.node.ArrayNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 import java.io.File;
 import java.io.IOException;
+import java.io.OutputStream;
 import java.io.Reader;
 import java.util.List;
+import org.apache.hadoop.hdds.HddsUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -76,6 +81,23 @@ public static String toJsonString(Object obj) throws IOException {
     return MAPPER.writeValueAsString(obj);
   }
 
+  /**
+   * Returns a {@link SequenceWriter} that will write to and close the provided output stream when it is closed.
+   * If the sequence is being written to stdout and more stdout output is needed later, use
+   * {@link #getStdoutSequenceWriter} instead.
+   */
+  public static SequenceWriter getSequenceWriter(OutputStream stream) throws IOException {
+    return WRITER.writeValuesAsArray(stream);
+  }
+
+  /**
+   * Returns a {@link SequenceWriter} that will write to stdout but not close stdout for more output once the sequence
+   * writer is closed.
+   */
+  public static SequenceWriter getStdoutSequenceWriter() throws IOException {
+    return getSequenceWriter(new NonClosingOutputStream(System.out));
+  }
+
   public static String toJsonStringWIthIndent(Object obj)  {
     try {
       return INDENT_OUTPUT_MAPPER.writeValueAsString(obj);
@@ -107,6 +129,10 @@ public static <T> T readFromReader(Reader reader, Class<T> valueType) throws IOE
     return MAPPER.readValue(reader, valueType);
   }
 
+  public static ObjectMapper getDefaultMapper() {
+    return MAPPER;
+  }
+
   /**
    * Utility to sequentially write a large collection of items to a file.
    */
@@ -132,4 +158,47 @@ public static <T> List<T> readFromFile(File file, Class<T> itemType)
     }
   }
 
+  /**
+   * Serializes a checksum stored as a long into its json string representation.
+   */
+  public static class ChecksumSerializer extends JsonSerializer<Long> {
+    @Override
+    public void serialize(Long value, JsonGenerator gen, SerializerProvider provider) throws IOException {
+      gen.writeString(HddsUtils.checksumToString(value));
+    }
+  }
+
+  private static class NonClosingOutputStream extends OutputStream {
+
+    private final OutputStream delegate;
+
+    NonClosingOutputStream(OutputStream delegate) {
+      this.delegate = delegate;
+    }
+
+    @Override
+    public void write(int b) throws IOException {
+      delegate.write(b);
+    }
+
+    @Override
+    public void write(byte[] b) throws IOException {
+      delegate.write(b);
+    }
+
+    @Override
+    public void write(byte[] b, int off, int len) throws IOException {
+      delegate.write(b, off, len);
+    }
+
+    @Override
+    public void flush() throws IOException {
+      delegate.flush();
+    }
+
+    @Override
+    public void close() {
+      // Ignore close to keep the underlying stream open
+    }
+  }
 }

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

@@ -17,6 +17,7 @@
 
 package org.apache.hadoop.hdds.scm.cli.container;
 
+import java.util.ArrayList;
 import java.util.List;
 import org.apache.hadoop.hdds.cli.ItemsFromStdin;
 import picocli.CommandLine;
@@ -25,10 +26,42 @@
 @CommandLine.Command
 public class ContainerIDParameters extends ItemsFromStdin {
 
+  @CommandLine.Spec
+  private CommandLine.Model.CommandSpec spec;
+
   @CommandLine.Parameters(description = "Container IDs" + FORMAT_DESCRIPTION,
       arity = "1..*",
       paramLabel = "<container ID>")
   public void setContainerIDs(List<String> arguments) {
     setItems(arguments);
   }
+
+  public List<Long> getValidatedIDs() {
+    List<Long> containerIDs = new ArrayList<>(size());
+    List<String> invalidIDs = new ArrayList<>();
+
+    for (String input: this) {
+      boolean idValid = true;
+      try {
+        long id = Long.parseLong(input);
+        if (id <= 0) {
+          idValid = false;
+        } else {
+          containerIDs.add(id);
+        }
+      } catch (NumberFormatException e) {
+        idValid = false;
+      }
+
+      if (!idValid) {
+        invalidIDs.add(input);
+      }
+    }
+
+    if (!invalidIDs.isEmpty()) {
+      throw new CommandLine.ParameterException(spec.commandLine(),
+          "Container IDs must be positive integers. Invalid container IDs: " + String.join(" ", invalidIDs));
+    }
+    return containerIDs;
+  }
 }

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

@@ -69,6 +69,7 @@ public void execute(ScmClient scmClient) throws IOException {
     multiContainer = containerList.size() > 1;
 
     printHeader();
+    // TODO HDDS-13592: Use ContainerIDParameters#getValidatedIDs to automatically handle type conversion and fail fast.
     for (String id : containerList) {
       printOutput(scmClient, id, first);
       first = false;

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

@@ -182,6 +182,7 @@ private void listAllContainers(ScmClient scmClient, SequenceWriter writer,
     } while (fetchedCount > 0);
   }
 
+  // TODO HDDS-13593 Remove this in favor of JsonUtils#getStdoutSequenceWriter.
   private static class NonClosingOutputStream extends OutputStream {
 
     private final OutputStream delegate;