Simplifying BesuCommand step 1 (hyperledger#7682)

Simplifying BesuCommand
---------

Signed-off-by: Justin Florentine <[email protected]>

acceptance-tests/dsl/src/main/java/org/hyperledger/besu/tests/acceptance/dsl/node/ProcessBesuNodeRunner.java

@@ -17,8 +17,8 @@
 import static com.google.common.base.Preconditions.checkState;
 import static java.nio.charset.StandardCharsets.UTF_8;
 
+import org.hyperledger.besu.cli.options.DataStorageOptions;
 import org.hyperledger.besu.cli.options.TransactionPoolOptions;
-import org.hyperledger.besu.cli.options.stable.DataStorageOptions;
 import org.hyperledger.besu.cli.options.unstable.NetworkingOptions;
 import org.hyperledger.besu.ethereum.api.jsonrpc.ipc.JsonRpcIpcConfiguration;
 import org.hyperledger.besu.ethereum.eth.transactions.ImmutableTransactionPoolConfiguration;

besu/src/main/java/org/hyperledger/besu/cli/options/stable/DataStorageOptions.java → besu/src/main/java/org/hyperledger/besu/cli/options/DataStorageOptions.java

@@ -12,7 +12,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-package org.hyperledger.besu.cli.options.stable;
+package org.hyperledger.besu.cli.options;
 
 import static org.hyperledger.besu.ethereum.worldstate.DataStorageConfiguration.DEFAULT_BONSAI_LIMIT_TRIE_LOGS_ENABLED;
 import static org.hyperledger.besu.ethereum.worldstate.DataStorageConfiguration.DEFAULT_BONSAI_MAX_LAYERS_TO_LOAD;
@@ -22,7 +22,6 @@
 import static org.hyperledger.besu.ethereum.worldstate.DataStorageConfiguration.Unstable.DEFAULT_BONSAI_CODE_USING_CODE_HASH_ENABLED;
 import static org.hyperledger.besu.ethereum.worldstate.DataStorageConfiguration.Unstable.DEFAULT_BONSAI_FULL_FLAT_DB_ENABLED;
 
-import org.hyperledger.besu.cli.options.CLIOptions;
 import org.hyperledger.besu.cli.util.CommandLineUtils;
 import org.hyperledger.besu.ethereum.worldstate.DataStorageConfiguration;
 import org.hyperledger.besu.ethereum.worldstate.ImmutableDataStorageConfiguration;

besu/src/main/java/org/hyperledger/besu/cli/options/stable/ApiConfigurationOptions.java

@@ -28,6 +28,7 @@
  * Handles configuration options for the API in Besu, including gas price settings, RPC log range,
  * and trace filter range.
  */
+// TODO: implement CLIOption<ApiConfiguration>
 public class ApiConfigurationOptions {
   /** Default constructor. */
   public ApiConfigurationOptions() {}

besu/src/main/java/org/hyperledger/besu/cli/options/stable/EngineRPCConfiguration.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright contributors to Hyperledger Besu.
+ *
+ * Licensed 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package org.hyperledger.besu.cli.options.stable;
+
+import org.hyperledger.besu.cli.custom.JsonRPCAllowlistHostsProperty;
+
+import java.nio.file.Path;
+
+/**
+ * Command line options for configuring Engine RPC on the node.
+ *
+ * @param overrideEngineRpcEnabled enable the engine api, even in the absence of merge-specific
+ *     configurations.
+ * @param engineRpcPort Port to provide consensus client APIS on
+ * @param engineJwtKeyFile Path to file containing shared secret key for JWT signature verification
+ * @param isEngineAuthDisabled Disable authentication for Engine APIs
+ * @param engineHostsAllowlist List of hosts to allowlist for Engine APIs
+ */
+public record EngineRPCConfiguration(
+    Boolean overrideEngineRpcEnabled,
+    Integer engineRpcPort,
+    Path engineJwtKeyFile,
+    Boolean isEngineAuthDisabled,
+    JsonRPCAllowlistHostsProperty engineHostsAllowlist) {}

besu/src/main/java/org/hyperledger/besu/cli/options/stable/EngineRPCOptions.java

@@ -0,0 +1,81 @@
+/*
+ * Copyright contributors to Hyperledger Besu.
+ *
+ * Licensed 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package org.hyperledger.besu.cli.options.stable;
+
+import static org.hyperledger.besu.ethereum.api.jsonrpc.JsonRpcConfiguration.DEFAULT_ENGINE_JSON_RPC_PORT;
+
+import org.hyperledger.besu.cli.DefaultCommandValues;
+import org.hyperledger.besu.cli.custom.JsonRPCAllowlistHostsProperty;
+import org.hyperledger.besu.cli.options.CLIOptions;
+import org.hyperledger.besu.cli.util.CommandLineUtils;
+
+import java.nio.file.Path;
+import java.util.List;
+
+import picocli.CommandLine;
+
+/** Command line options for configuring Engine RPC on the node. */
+public class EngineRPCOptions implements CLIOptions<EngineRPCConfiguration> {
+
+  /** Default constructor */
+  public EngineRPCOptions() {}
+
+  @CommandLine.Option(
+      names = {"--engine-rpc-enabled"},
+      description = "enable the engine api, even in the absence of merge-specific configurations.")
+  private final Boolean overrideEngineRpcEnabled = false;
+
+  @CommandLine.Option(
+      names = {"--engine-rpc-port", "--engine-rpc-http-port"},
+      paramLabel = DefaultCommandValues.MANDATORY_PORT_FORMAT_HELP,
+      description = "Port to provide consensus client APIS on (default: ${DEFAULT-VALUE})",
+      arity = "1")
+  private final Integer engineRpcPort = DEFAULT_ENGINE_JSON_RPC_PORT;
+
+  @CommandLine.Option(
+      names = {"--engine-jwt-secret"},
+      paramLabel = DefaultCommandValues.MANDATORY_FILE_FORMAT_HELP,
+      description = "Path to file containing shared secret key for JWT signature verification")
+  private final Path engineJwtKeyFile = null;
+
+  @CommandLine.Option(
+      names = {"--engine-jwt-disabled"},
+      description = "Disable authentication for Engine APIs (default: ${DEFAULT-VALUE})")
+  private final Boolean isEngineAuthDisabled = false;
+
+  @CommandLine.Option(
+      names = {"--engine-host-allowlist"},
+      paramLabel = "<hostname>[,<hostname>...]... or * or all",
+      description =
+          "Comma separated list of hostnames to allow for ENGINE API access (applies to both HTTP and websockets), or * to accept any host (default: ${DEFAULT-VALUE})",
+      defaultValue = "localhost,127.0.0.1")
+  private final JsonRPCAllowlistHostsProperty engineHostsAllowlist =
+      new JsonRPCAllowlistHostsProperty();
+
+  @Override
+  public EngineRPCConfiguration toDomainObject() {
+    return new EngineRPCConfiguration(
+        overrideEngineRpcEnabled,
+        engineRpcPort,
+        engineJwtKeyFile,
+        isEngineAuthDisabled,
+        engineHostsAllowlist);
+  }
+
+  @Override
+  public List<String> getCLIOptions() {
+    return CommandLineUtils.getCLIOptions(this, new EngineRPCOptions());
+  }
+}

besu/src/main/java/org/hyperledger/besu/cli/options/stable/GraphQlOptions.java

@@ -29,6 +29,7 @@
 import picocli.CommandLine;
 
 /** Handles configuration options for the GraphQL HTTP service in Besu. */
+// TODO: implement CLIOptions<GraphQLConfiguration>
 public class GraphQlOptions {
   @CommandLine.Option(
       names = {"--graphql-http-enabled"},

besu/src/main/java/org/hyperledger/besu/cli/options/stable/JsonRpcHttpOptions.java

@@ -52,6 +52,7 @@
  * Handles configuration options for the JSON-RPC HTTP service, including validation and creation of
  * a JSON-RPC configuration.
  */
+// TODO: implement CLIOption<JsonRpcConfiguration>
 public class JsonRpcHttpOptions {
   @CommandLine.Option(
       names = {"--rpc-http-enabled"},
@@ -265,37 +266,50 @@ && rpcHttpAuthenticationCredentialsFile(commandLine) == null
   /**
    * Creates a JsonRpcConfiguration based on the provided options.
    *
-   * @param hostsAllowlist List of hosts allowed
-   * @param defaultHostAddress Default host address
-   * @param timoutSec timeout in seconds
-   * @return A JsonRpcConfiguration instance
+   * @return configuration populated from options or defaults
    */
-  public JsonRpcConfiguration jsonRpcConfiguration(
-      final List<String> hostsAllowlist, final String defaultHostAddress, final Long timoutSec) {
+  public JsonRpcConfiguration jsonRpcConfiguration() {
 
     final JsonRpcConfiguration jsonRpcConfiguration = JsonRpcConfiguration.createDefault();
     jsonRpcConfiguration.setEnabled(isRpcHttpEnabled);
-    jsonRpcConfiguration.setHost(
-        Strings.isNullOrEmpty(rpcHttpHost) ? defaultHostAddress : rpcHttpHost);
     jsonRpcConfiguration.setPort(rpcHttpPort);
     jsonRpcConfiguration.setMaxActiveConnections(rpcHttpMaxConnections);
     jsonRpcConfiguration.setCorsAllowedDomains(rpcHttpCorsAllowedOrigins);
     jsonRpcConfiguration.setRpcApis(rpcHttpApis.stream().distinct().collect(Collectors.toList()));
     jsonRpcConfiguration.setNoAuthRpcApis(
         rpcHttpApiMethodsNoAuth.stream().distinct().collect(Collectors.toList()));
-    jsonRpcConfiguration.setHostsAllowlist(hostsAllowlist);
     jsonRpcConfiguration.setAuthenticationEnabled(isRpcHttpAuthenticationEnabled);
     jsonRpcConfiguration.setAuthenticationCredentialsFile(rpcHttpAuthenticationCredentialsFile);
     jsonRpcConfiguration.setAuthenticationPublicKeyFile(rpcHttpAuthenticationPublicKeyFile);
     jsonRpcConfiguration.setAuthenticationAlgorithm(rpcHttpAuthenticationAlgorithm);
     jsonRpcConfiguration.setTlsConfiguration(rpcHttpTlsConfiguration());
-    jsonRpcConfiguration.setHttpTimeoutSec(timoutSec);
     jsonRpcConfiguration.setMaxBatchSize(rpcHttpMaxBatchSize);
     jsonRpcConfiguration.setMaxRequestContentLength(rpcHttpMaxRequestContentLength);
     jsonRpcConfiguration.setPrettyJsonEnabled(prettyJsonEnabled);
     return jsonRpcConfiguration;
   }
 
+  /**
+   * Creates a JsonRpcConfiguration based on the provided options.
+   *
+   * @param hostsAllowlist List of hosts allowed
+   * @param defaultHostAddress Default host address
+   * @param timoutSec timeout in seconds
+   * @return A JsonRpcConfiguration instance
+   */
+  public JsonRpcConfiguration jsonRpcConfiguration(
+      final List<String> hostsAllowlist, final String defaultHostAddress, final Long timoutSec) {
+
+    final JsonRpcConfiguration jsonRpcConfiguration = this.jsonRpcConfiguration();
+
+    jsonRpcConfiguration.setHost(
+        Strings.isNullOrEmpty(rpcHttpHost) ? defaultHostAddress : rpcHttpHost);
+    jsonRpcConfiguration.setHostsAllowlist(hostsAllowlist);
+    ;
+    jsonRpcConfiguration.setHttpTimeoutSec(timoutSec);
+    return jsonRpcConfiguration;
+  }
+
   /**
    * Checks dependencies between options.
    *

besu/src/main/java/org/hyperledger/besu/cli/options/stable/MetricsOptionGroup.java

@@ -30,6 +30,7 @@
 import picocli.CommandLine;
 
 /** Command line options for configuring metrics. */
+// TODO: implement CLIOption<MetricsConfiguration> and rename to drop the Group
 public class MetricsOptionGroup {
   @CommandLine.Option(
       names = {"--metrics-enabled"},