[Java] Have ClusterTool.describeLatestConsensusModuleSnapshot return …

…an indication of failure or success.
G-Research · Sep 19, 2024 · 0d595be · 0d595be
1 parent c972efd
commit 0d595be
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/aeron-cluster/src/main/java/io/aeron/cluster/ClusterTool.java b/aeron-cluster/src/main/java/io/aeron/cluster/ClusterTool.java
@@ -508,10 +508,11 @@ public static boolean invalidateLatestSnapshot(final PrintStream out, final File
      *
      * @param out        to print the operation result.
      * @param clusterDir where the cluster is running.
+     * @return <code>true</code> if the snapshot was successfully described <code>false</code> otherwise.
      */
-    public static void describeLatestConsensusModuleSnapshot(final PrintStream out, final File clusterDir)
+    public static boolean describeLatestConsensusModuleSnapshot(final PrintStream out, final File clusterDir)
     {
-        BACKWARD_COMPATIBLE_OPERATIONS.describeLatestConsensusModuleSnapshot(clusterDir, out, null);
+        return BACKWARD_COMPATIBLE_OPERATIONS.describeLatestConsensusModuleSnapshot(clusterDir, out, null) == SUCCESS;
     }
 
     /**

diff --git a/aeron-system-tests/src/test/java/io/aeron/cluster/ClusterToolTest.java b/aeron-system-tests/src/test/java/io/aeron/cluster/ClusterToolTest.java
@@ -103,9 +103,9 @@ void shouldDescribeLatestConsensusModuleSnapshot()
             leader.consensusModule().context().clusterDir(),
             capturingPrintStream.resetAndGetPrintStream()));
 
-        ClusterTool.describeLatestConsensusModuleSnapshot(
+        assertTrue(ClusterTool.describeLatestConsensusModuleSnapshot(
             capturingPrintStream.resetAndGetPrintStream(),
-            leader.consensusModule().context().clusterDir());
+            leader.consensusModule().context().clusterDir()));
 
         assertThat(
             capturingPrintStream.flushAndGetContent(),