HDDS-9317. Provide an option for displaying Ozone snapshot diff outpu…

…t as JSON
hemantk-12 · May 29, 2024 · c6e55f6 · c6e55f6
1 parent 74737bf
commit c6e55f6
Show file tree

Hide file tree

Showing 3 changed files with 83 additions and 5 deletions.
diff --git a/...one/common/src/main/java/org/apache/hadoop/ozone/snapshot/CancelSnapshotDiffResponse.java b/...one/common/src/main/java/org/apache/hadoop/ozone/snapshot/CancelSnapshotDiffResponse.java
@@ -34,7 +34,7 @@ public String getMessage() {
 
   @Override
   public String toString() {
-    return message + "\n";
+    return message;
   }
 
   /**

diff --git a/...-ozone/common/src/main/java/org/apache/hadoop/ozone/snapshot/SnapshotDiffReportOzone.java b/...-ozone/common/src/main/java/org/apache/hadoop/ozone/snapshot/SnapshotDiffReportOzone.java
@@ -89,6 +89,14 @@ public List<DiffReportEntry> getDiffList() {
     return super.getDiffList();
   }
 
+  public String getVolumeName() {
+    return volumeName;
+  }
+
+  public String getBucketName() {
+    return bucketName;
+  }
+
   public String getToken() {
     return token;
   }

diff --git a/...ozone/tools/src/main/java/org/apache/hadoop/ozone/shell/snapshot/SnapshotDiffHandler.java b/...ozone/tools/src/main/java/org/apache/hadoop/ozone/shell/snapshot/SnapshotDiffHandler.java
@@ -17,17 +17,28 @@
  */
 package org.apache.hadoop.ozone.shell.snapshot;
 
+import com.fasterxml.jackson.databind.node.ArrayNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.hadoop.fs.Path;
+import org.apache.hadoop.hdds.server.JsonUtils;
+import org.apache.hadoop.hdfs.DFSUtilClient;
+import org.apache.hadoop.hdfs.protocol.SnapshotDiffReport;
 import org.apache.hadoop.ozone.OmUtils;
 import org.apache.hadoop.ozone.client.ObjectStore;
 import org.apache.hadoop.ozone.client.OzoneClient;
 import org.apache.hadoop.ozone.shell.Handler;
 import org.apache.hadoop.ozone.shell.OzoneAddress;
 import org.apache.hadoop.ozone.shell.bucket.BucketUri;
+import org.apache.hadoop.ozone.snapshot.SnapshotDiffReportOzone;
+import org.apache.hadoop.ozone.snapshot.SnapshotDiffResponse;
 import picocli.CommandLine;
 
 import java.io.IOException;
 import java.io.PrintStream;
 
+import static org.apache.hadoop.hdds.server.JsonUtils.toJsonStringWithDefaultPrettyPrinter;
+
 /**
  * ozone sh snapshot diff.
  */
@@ -74,6 +85,11 @@ public class SnapshotDiffHandler extends Handler {
       hidden = true)
   private boolean diffDisableNativeLibs;
 
+  @CommandLine.Option(names = { "--json" },
+      defaultValue = "false",
+      description = "Format output as JSON")
+  private boolean json;
+
   @Override
   protected OzoneAddress getAddress() {
     return snapshotPath.getValue();
@@ -97,17 +113,71 @@ protected void execute(OzoneClient client, OzoneAddress address)
 
   private void getSnapshotDiff(ObjectStore store, String volumeName,
                                String bucketName) throws IOException {
+    SnapshotDiffResponse diffResponse = store.snapshotDiff(volumeName, bucketName, fromSnapshot, toSnapshot,
+        token, pageSize, forceFullDiff, diffDisableNativeLibs);
     try (PrintStream stream = out()) {
-      stream.println(store.snapshotDiff(volumeName, bucketName, fromSnapshot,
-          toSnapshot, token, pageSize, forceFullDiff, diffDisableNativeLibs));
+      if (json) {
+        stream.println(toJsonStringWithDefaultPrettyPrinter(getJsonObject(diffResponse)));
+      } else {
+        stream.println(diffResponse);
+      }
     }
   }
 
   private void cancelSnapshotDiff(ObjectStore store, String volumeName,
                                   String bucketName) throws IOException {
     try (PrintStream stream = out()) {
-      stream.print(store.cancelSnapshotDiff(volumeName, bucketName,
-          fromSnapshot, toSnapshot));
+      stream.println(store.cancelSnapshotDiff(volumeName, bucketName, fromSnapshot, toSnapshot));
+    }
+  }
+
+  private ObjectNode getJsonObject(SnapshotDiffResponse diffResponse) {
+    ObjectNode diffResponseNode = JsonUtils.createObjectNode(null);
+    diffResponseNode.set("snapshotDiffReport", getJsonObject(diffResponse.getSnapshotDiffReport()));
+    diffResponseNode.put("jobStatus", diffResponse.getJobStatus().name());
+    if (diffResponse.getWaitTimeInMs() != 0) {
+      diffResponseNode.put("waitTimeInMs", diffResponse.getWaitTimeInMs());
+    }
+    if (StringUtils.isNotEmpty(diffResponse.getReason())) {
+      diffResponseNode.put("reason", diffResponse.getReason());
+    }
+    return diffResponseNode;
+  }
+
+  private ObjectNode getJsonObject(SnapshotDiffReportOzone diffReportOzone) {
+    ObjectNode diffReportNode = JsonUtils.createObjectNode(null);
+    diffReportNode.put("volumeName", diffReportOzone.getVolumeName());
+    diffReportNode.put("bucketName", diffReportOzone.getBucketName());
+    diffReportNode.put("fromSnapshot", diffReportOzone.getFromSnapshot());
+    diffReportNode.put("toSnapshot", diffReportOzone.getLaterSnapshotName());
+    ArrayNode resArray = JsonUtils.createArrayNode();
+    diffReportOzone.getDiffList()
+        .forEach(diffReportEntry -> resArray.add(getJsonObject(diffReportEntry)));
+    diffReportNode.set("diffList", resArray);
+
+    if (StringUtils.isNotEmpty(diffReportOzone.getToken())) {
+      diffReportNode.put("nextToken", diffReportOzone.getToken());
+    }
+    return diffReportNode;
+  }
+
+
+  private ObjectNode getJsonObject(SnapshotDiffReport.DiffReportEntry diffReportEntry) {
+    ObjectNode diffReportNode = JsonUtils.createObjectNode(null);
+    diffReportNode.put("diffType", diffReportEntry.getType().getLabel());
+    diffReportNode.put("sourcePath", getPathString(diffReportEntry.getSourcePath()));
+    if (diffReportEntry.getTargetPath() != null) {
+      diffReportNode.put("targetPath", getPathString(diffReportEntry.getTargetPath()));
+    }
+    return diffReportNode;
+  }
+
+  private String getPathString(byte[] path) {
+    String pathStr = DFSUtilClient.bytes2String(path);
+    if (pathStr.isEmpty()) {
+      return Path.CUR_DIR;
+    } else {
+      return Path.CUR_DIR + Path.SEPARATOR + pathStr;
     }
   }
 }