Addressed andrross's comment

Signed-off-by: Peter Alfonsi <[email protected]>

Author: Peter Alfonsi

modules/cache-common/src/internalClusterTest/java/org/opensearch/cache/common/tier/TieredSpilloverCacheStatsIT.java

@@ -104,8 +104,8 @@ public void testIndicesLevelAggregation() throws Exception {
         );
 
         for (ImmutableCacheStatsHolder statsHolder : List.of(allLevelsStatsHolder, indicesOnlyStatsHolder)) {
-            assertStatsEqual(index1ExpectedStats, statsHolder.getStatsForDimensionValues(List.of(index1Name)));
-            assertStatsEqual(index2ExpectedStats, statsHolder.getStatsForDimensionValues(List.of(index2Name)));
+            assertEquals(index1ExpectedStats, statsHolder.getStatsForDimensionValues(List.of(index1Name)));
+            assertEquals(index2ExpectedStats, statsHolder.getStatsForDimensionValues(List.of(index2Name)));
         }
     }
 
@@ -141,7 +141,7 @@ public void testIndicesAndTierLevelAggregation() throws Exception {
                 values.get("itemsOnHeapIndex1AfterTest")
             )
         );
-        assertStatsEqual(
+        assertEquals(
             index1HeapExpectedStats,
             allLevelsStatsHolder.getStatsForDimensionValues(List.of(index1Name, TIER_DIMENSION_VALUE_ON_HEAP))
         );
@@ -155,7 +155,7 @@ public void testIndicesAndTierLevelAggregation() throws Exception {
                 values.get("itemsOnHeapIndex2AfterTest")
             )
         );
-        assertStatsEqual(
+        assertEquals(
             index2HeapExpectedStats,
             allLevelsStatsHolder.getStatsForDimensionValues(List.of(index2Name, TIER_DIMENSION_VALUE_ON_HEAP))
         );
@@ -169,7 +169,7 @@ public void testIndicesAndTierLevelAggregation() throws Exception {
                 values.get("itemsOnDiskIndex1AfterTest")
             )
         );
-        assertStatsEqual(
+        assertEquals(
             index1DiskExpectedStats,
             allLevelsStatsHolder.getStatsForDimensionValues(List.of(index1Name, TIER_DIMENSION_VALUE_DISK))
         );
@@ -183,7 +183,7 @@ public void testIndicesAndTierLevelAggregation() throws Exception {
                 values.get("itemsOnDiskIndex2AfterTest")
             )
         );
-        assertStatsEqual(
+        assertEquals(
             index2DiskExpectedStats,
             allLevelsStatsHolder.getStatsForDimensionValues(List.of(index2Name, TIER_DIMENSION_VALUE_DISK))
         );
@@ -220,7 +220,7 @@ public void testTierLevelAggregation() throws Exception {
             )
         );
         ImmutableCacheStats heapStats = tiersOnlyStatsHolder.getStatsForDimensionValues(List.of(TIER_DIMENSION_VALUE_ON_HEAP));
-        assertStatsEqual(totalHeapExpectedStats, heapStats);
+        assertEquals(totalHeapExpectedStats, heapStats);
         ImmutableCacheStats totalDiskExpectedStats = returnNullIfAllZero(
             new ImmutableCacheStats(
                 values.get("hitsOnDiskIndex1") + values.get("hitsOnDiskIndex2"),
@@ -231,7 +231,7 @@ public void testTierLevelAggregation() throws Exception {
             )
         );
         ImmutableCacheStats diskStats = tiersOnlyStatsHolder.getStatsForDimensionValues(List.of(TIER_DIMENSION_VALUE_DISK));
-        assertStatsEqual(totalDiskExpectedStats, diskStats);
+        assertEquals(totalDiskExpectedStats, diskStats);
     }
 
     public void testInvalidLevelsAreIgnored() throws Exception {
@@ -324,7 +324,7 @@ public void testStatsMatchOldApi() throws Exception {
         ImmutableCacheStats totalStats = getNodeCacheStatsResult(client, List.of()).getTotalStats();
 
         // Check the new stats API values are as expected
-        assertStatsEqual(
+        assertEquals(
             new ImmutableCacheStats(expectedHits, expectedMisses, 0, expectedEntries * singleSearchSize, expectedEntries),
             totalStats
         );
@@ -504,16 +504,4 @@ private static ImmutableCacheStatsHolder getNodeCacheStatsResult(Client client,
         NodeCacheStats ncs = nodeStatsResponse.getNodes().get(0).getNodeCacheStats();
         return ncs.getStatsByCache(CacheType.INDICES_REQUEST_CACHE);
     }
-
-    // Check each stat separately for more transparency if there's a failure
-    private void assertStatsEqual(ImmutableCacheStats expected, ImmutableCacheStats actual) {
-        if (expected == null && actual == null) {
-            return;
-        }
-        assertEquals(expected.getHits(), actual.getHits());
-        assertEquals(expected.getMisses(), actual.getMisses());
-        assertEquals(expected.getEvictions(), actual.getEvictions());
-        assertEquals(expected.getSizeInBytes(), actual.getSizeInBytes());
-        assertEquals(expected.getItems(), actual.getItems());
-    }
 }

server/src/main/java/org/opensearch/common/cache/stats/ImmutableCacheStats.java

@@ -115,6 +115,23 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
         return builder;
     }
 
+    @Override
+    public String toString() {
+        return String.format(
+            "%s=%d, %s=%d, %s=%d, %s=%d, %s=%d",
+            Fields.HIT_COUNT,
+            hits,
+            Fields.MISS_COUNT,
+            misses,
+            Fields.EVICTIONS,
+            evictions,
+            Fields.SIZE_IN_BYTES,
+            sizeInBytes,
+            Fields.ITEM_COUNT,
+            items
+        );
+    }
+
     /**
      * Field names used to write the values in this object to XContent.
      */