[2702] Add check for required option on cli (hyperledger#4717)

* Add check for required option on cli

Signed-off-by: wcgcyx <wcgcyx@gmail.com>
Co-authored-by: Jason Frame <jason.frame@consensys.net>
Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com>

besu/src/main/java/org/hyperledger/besu/cli/BesuCommand.java

@@ -1752,6 +1752,7 @@ private void configureNativeLibs() {
   }
 
   private void validateOptions() {
+    validateRequiredOptions();
     issueOptionWarnings();
     validateP2PInterface(p2PDiscoveryOptionGroup.p2pInterface);
     validateMiningParams();
@@ -1764,6 +1765,19 @@ private void validateOptions() {
     pkiBlockCreationOptions.checkPkiBlockCreationOptionsDependencies(logger, commandLine);
   }
 
+  private void validateRequiredOptions() {
+    commandLine
+        .getCommandSpec()
+        .options()
+        .forEach(
+            option -> {
+              if (option.required() && option.stringValues().isEmpty()) {
+                throw new ParameterException(
+                    this.commandLine, "Missing required option: " + option.longestName());
+              }
+            });
+  }
+
   @SuppressWarnings("ConstantConditions")
   private void validateMiningParams() {
     if (Boolean.TRUE.equals(minerOptionGroup.isMiningEnabled)

besu/src/test/java/org/hyperledger/besu/cli/BesuCommandTest.java

@@ -5425,4 +5425,40 @@ public void portInUseReportsError() throws IOException {
 
     serverSocket.close();
   }
+
+  @Test
+  public void presentRequiredOptionShouldPass() {
+    parseCommandWithRequiredOption("--accept-terms-and-conditions", "true");
+    assertThat(commandOutput.toString(UTF_8)).isEmpty();
+    assertThat(commandErrorOutput.toString(UTF_8)).isEmpty();
+  }
+
+  @Test
+  public void missingRequiredOptionShouldFail() {
+    parseCommandWithRequiredOption();
+    assertThat(commandOutput.toString(UTF_8)).isEmpty();
+    assertThat(commandErrorOutput.toString(UTF_8))
+        .startsWith(
+            "Missing required option: '--accept-terms-and-conditions=<acceptTermsAndConditions>'");
+  }
+
+  @Test
+  public void havingRequiredOptionInEnvVarShouldFail() {
+    setEnvironmentVariable("BESU_ACCEPT_TERMS_AND_CONDITIONS", "true");
+    parseCommandWithRequiredOption();
+    assertThat(commandOutput.toString(UTF_8)).isEmpty();
+    assertThat(commandErrorOutput.toString(UTF_8))
+        .startsWith(
+            "Missing required option: '--accept-terms-and-conditions=<acceptTermsAndConditions>'");
+  }
+
+  @Test
+  public void havingRequiredOptionInConfigShouldFail() throws IOException {
+    final Path toml = createTempFile("toml", "accept-terms-and-conditions=true\n");
+    parseCommandWithRequiredOption("--config-file", toml.toString());
+    assertThat(commandOutput.toString(UTF_8)).isEmpty();
+    assertThat(commandErrorOutput.toString(UTF_8))
+        .startsWith(
+            "Missing required option: '--accept-terms-and-conditions=<acceptTermsAndConditions>'");
+  }
 }

besu/src/test/java/org/hyperledger/besu/cli/CommandTestAbstract.java

@@ -351,30 +351,53 @@ protected TestBesuCommand parseCommand(final String... args) {
     return parseCommand(System.in, args);
   }
 
+  protected TestBesuCommand parseCommand(final InputStream in, final String... args) {
+    return parseCommand(false, in, args);
+  }
+
+  protected TestBesuCommand parseCommandWithRequiredOption(final String... args) {
+    return parseCommand(true, System.in, args);
+  }
+
   private JsonBlockImporter jsonBlockImporterFactory(final BesuController controller) {
     return jsonBlockImporter;
   }
 
-  protected TestBesuCommand parseCommand(final InputStream in, final String... args) {
+  protected TestBesuCommand parseCommand(
+      final boolean requiredOption, final InputStream in, final String... args) {
     // turn off ansi usage globally in picocli
     System.setProperty("picocli.ansi", "false");
     // reset GlobalOpenTelemetry
     GlobalOpenTelemetry.resetForTest();
 
     final TestBesuCommand besuCommand =
-        new TestBesuCommand(
-            mockLogger,
-            () -> rlpBlockImporter,
-            this::jsonBlockImporterFactory,
-            (blockchain) -> rlpBlockExporter,
-            mockRunnerBuilder,
-            mockControllerBuilderFactory,
-            mockBesuPluginContext,
-            environment,
-            storageService,
-            securityModuleService,
-            mockPkiBlockCreationConfigProvider,
-            privacyPluginService);
+        requiredOption
+            ? new TestBesuCommandWithRequiredOption(
+                mockLogger,
+                () -> rlpBlockImporter,
+                this::jsonBlockImporterFactory,
+                (blockchain) -> rlpBlockExporter,
+                mockRunnerBuilder,
+                mockControllerBuilderFactory,
+                mockBesuPluginContext,
+                environment,
+                storageService,
+                securityModuleService,
+                mockPkiBlockCreationConfigProvider,
+                privacyPluginService)
+            : new TestBesuCommand(
+                mockLogger,
+                () -> rlpBlockImporter,
+                this::jsonBlockImporterFactory,
+                (blockchain) -> rlpBlockExporter,
+                mockRunnerBuilder,
+                mockControllerBuilderFactory,
+                mockBesuPluginContext,
+                environment,
+                storageService,
+                securityModuleService,
+                mockPkiBlockCreationConfigProvider,
+                privacyPluginService);
     besuCommands.add(besuCommand);
 
     final File defaultKeyFile =
@@ -487,4 +510,47 @@ public void close() {
       }
     }
   }
+
+  @CommandLine.Command
+  public static class TestBesuCommandWithRequiredOption extends TestBesuCommand {
+
+    @CommandLine.Option(
+        names = {"--accept-terms-and-conditions"},
+        description = "You must explicitly accept terms and conditions",
+        arity = "1",
+        required = true)
+    private final Boolean acceptTermsAndConditions = false;
+
+    TestBesuCommandWithRequiredOption(
+        final Logger mockLogger,
+        final Supplier<RlpBlockImporter> mockBlockImporter,
+        final Function<BesuController, JsonBlockImporter> jsonBlockImporterFactory,
+        final Function<Blockchain, RlpBlockExporter> rlpBlockExporterFactory,
+        final RunnerBuilder mockRunnerBuilder,
+        final BesuController.Builder controllerBuilderFactory,
+        final BesuPluginContextImpl besuPluginContext,
+        final Map<String, String> environment,
+        final StorageServiceImpl storageService,
+        final SecurityModuleServiceImpl securityModuleService,
+        final PkiBlockCreationConfigurationProvider pkiBlockCreationConfigProvider,
+        final PrivacyPluginServiceImpl privacyPluginService) {
+      super(
+          mockLogger,
+          mockBlockImporter,
+          jsonBlockImporterFactory,
+          rlpBlockExporterFactory,
+          mockRunnerBuilder,
+          controllerBuilderFactory,
+          besuPluginContext,
+          environment,
+          storageService,
+          securityModuleService,
+          pkiBlockCreationConfigProvider,
+          privacyPluginService);
+    }
+
+    public Boolean getAcceptTermsAndConditions() {
+      return acceptTermsAndConditions;
+    }
+  }
 }