Correct default --help values (hyperledger#7454)

* Fix hyperledger#7367: Correct default value display for --rpc-max-trace-filter-range along with a test * Fix hyperledger#7369: Show default value for --genesis-state-hash-cache-enabled Signed-off-by: 7suyash7 <[email protected]>
shemnon · Aug 14, 2024 · adf19af · adf19af
1 parent a3b6fd5
commit adf19af
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/besu/src/main/java/org/hyperledger/besu/cli/BesuCommand.java b/besu/src/main/java/org/hyperledger/besu/cli/BesuCommand.java
@@ -375,7 +375,8 @@ public class BesuCommand implements DefaultCommandValues, Runnable {
 
   @Option(
       names = {"--genesis-state-hash-cache-enabled"},
-      description = "Use genesis state hash from data on startup if specified")
+      description =
+          "Use genesis state hash from data on startup if specified (default: ${DEFAULT-VALUE})")
   private final Boolean genesisStateHashCacheEnabled = false;
 
   @Option(

diff --git a/besu/src/main/java/org/hyperledger/besu/cli/options/stable/ApiConfigurationOptions.java b/besu/src/main/java/org/hyperledger/besu/cli/options/stable/ApiConfigurationOptions.java
@@ -85,7 +85,7 @@ public ApiConfigurationOptions() {}
   @CommandLine.Option(
       names = {"--rpc-max-trace-filter-range"},
       description =
-          "Specifies the maximum number of blocks for the trace_filter method. Must be >=0. 0 specifies no limit  (default: $DEFAULT-VALUE)")
+          "Specifies the maximum number of blocks for the trace_filter method. Must be >=0. 0 specifies no limit  (default: ${DEFAULT-VALUE})")
   private final Long maxTraceFilterRange = 1000L;
 
   /**

diff --git a/besu/src/test/java/org/hyperledger/besu/cli/BesuCommandTest.java b/besu/src/test/java/org/hyperledger/besu/cli/BesuCommandTest.java
@@ -2503,4 +2503,16 @@ public void genesisStateHashCacheEnabledShouldWork() throws IOException {
     assertThat(commandOutput.toString(UTF_8)).isEmpty();
     assertThat(commandErrorOutput.toString(UTF_8)).isEmpty();
   }
+
+  @Test
+  void helpOutputShouldDisplayCorrectDefaultValues() {
+    parseCommand("--help");
+
+    final String commandOutputString = commandOutput.toString(UTF_8);
+    final String errorOutputString = commandErrorOutput.toString(UTF_8);
+
+    assertThat(commandOutputString).doesNotContain("$DEFAULT-VALUE");
+
+    assertThat(errorOutputString).isEmpty();
+  }
 }