(gravitino) branch main updated: [#2184] improve(iceberg-rest): Improved test coverage for IcebergMetricsFormatter (#4840)

[jshao]

This is an automated email from the ASF dual-hosted git repository.

jshao pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git


The following commit(s) were added to refs/heads/main by this push:
     new ab483e773 [#2184] improve(iceberg-rest): Improved test coverage for 
IcebergMetricsFormatter (#4840)
ab483e773 is described below

commit ab483e7733f960631e9fc5587e026b9d32105076
Author: Derek <67556128+yaode...@users.noreply.github.com>
AuthorDate: Wed Sep 4 13:57:19 2024 -0700

    [#2184] improve(iceberg-rest): Improved test coverage for 
IcebergMetricsFormatter (#4840)
    
    1. [#2184 ] test: Added test coverage for IcebergMetricsFormatter
    
    ### What changes were proposed in this pull request?
    
    Adding test cases to improve coverage of IcebergMetricsFormatter
    
    ### Why are the changes needed?
    
    Currently very low coverage for this class.
    
    Fix: #2184
    
    ### Does this PR introduce _any_ user-facing change?
    No
    
    ### How was this patch tested?
    Running IntelliJ with coverage. Code coverage Number before and after
    are attached.
    
    **After the Fix**
    
    
![after](https://github.com/user-attachments/assets/cf8b6b46-b0cf-41b6-a40a-21cb8b3bdd24)
    
    ** Before the Fix**
    ![before
    
change](https://github.com/user-attachments/assets/c97e41e6-3f68-483a-8757-f1fb67add87d)
    
    ---------
    
    Co-authored-by: yaoderek <yaode...@outlook.com>
---
 .../metrics/TestIcebergMetricsFormatter.java       | 77 ++++++++++++++++++++++
 1 file changed, 77 insertions(+)

diff --git 
a/iceberg/iceberg-rest-server/src/test/java/org/apache/gravitino/iceberg/service/metrics/TestIcebergMetricsFormatter.java
 
b/iceberg/iceberg-rest-server/src/test/java/org/apache/gravitino/iceberg/service/metrics/TestIcebergMetricsFormatter.java
new file mode 100644
index 000000000..70ea69b96
--- /dev/null
+++ 
b/iceberg/iceberg-rest-server/src/test/java/org/apache/gravitino/iceberg/service/metrics/TestIcebergMetricsFormatter.java
@@ -0,0 +1,77 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.gravitino.iceberg.service.metrics;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import org.apache.iceberg.metrics.ImmutableCommitMetricsResult;
+import org.apache.iceberg.metrics.ImmutableCommitReport;
+import org.apache.iceberg.metrics.MetricsReport;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+
+class TestIcebergMetricsFormatter {
+
+  private static MetricsReport createMetricsReport() {
+    ImmutableCommitMetricsResult commitMetricsResult =
+        ImmutableCommitMetricsResult.builder().build();
+    return ImmutableCommitReport.builder()
+        .tableName("a")
+        .snapshotId(1)
+        .sequenceNumber(1)
+        .operation("select")
+        .commitMetrics(commitMetricsResult)
+        .build();
+  }
+
+  private static IcebergMetricsFormatter formatter;
+  private static MetricsReport report;
+
+  @BeforeAll
+  static void setup() {
+    formatter = new IcebergMetricsFormatter();
+    report = createMetricsReport();
+  }
+
+  private void validateResult(String result) {
+    Assertions.assertTrue(result.contains("\"table-name\":\"a\""));
+    Assertions.assertTrue(result.contains("\"snapshot-id\":1"));
+    Assertions.assertTrue(result.contains("\"sequence-number\":1"));
+    Assertions.assertTrue(result.contains("\"operation\":\"select\""));
+  }
+
+  @Test
+  void testToPrintableString() throws JsonProcessingException {
+    String reportString = formatter.toPrintableString(report);
+    validateResult(reportString);
+  }
+
+  @Test
+  void testToJson() {
+    IcebergMetricsFormatter formatter = new IcebergMetricsFormatter();
+    MetricsReport report = createMetricsReport();
+    try {
+      String jsonString = formatter.toJson(report);
+      validateResult(jsonString);
+    } catch (JsonProcessingException ex) {
+      Assertions.fail("Failed to format metrics report to json");
+    }
+  }
+}