-
Notifications
You must be signed in to change notification settings - Fork 839
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CLI option for disabling auto-registration of external plugins (#7470)
Signed-off-by: Gabriel-Trintinalia <gabriel.trintinalia@consensys.net>
- Loading branch information
1 parent
5133595
commit d7041d4
Showing
9 changed files
with
269 additions
and
76 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
118 changes: 118 additions & 0 deletions
118
besu/src/test/java/org/hyperledger/besu/cli/PluginsOptionsTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| /* | ||
| * 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; | ||
|
|
||
| import static java.nio.charset.StandardCharsets.UTF_8; | ||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.mockito.Mockito.verify; | ||
|
|
||
| import org.hyperledger.besu.ethereum.core.plugins.PluginConfiguration; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.mockito.ArgumentCaptor; | ||
| import org.mockito.Captor; | ||
|
|
||
| public class PluginsOptionsTest extends CommandTestAbstract { | ||
|
|
||
| @Captor protected ArgumentCaptor<PluginConfiguration> pluginConfigurationArgumentCaptor; | ||
|
|
||
| @Test | ||
| public void shouldParsePluginOptionForSinglePlugin() { | ||
| parseCommand("--plugins", "pluginA"); | ||
| verify(mockBesuPluginContext).registerPlugins(pluginConfigurationArgumentCaptor.capture()); | ||
| assertThat(pluginConfigurationArgumentCaptor.getValue().getRequestedPlugins()) | ||
| .isEqualTo(List.of("pluginA")); | ||
| assertThat(commandOutput.toString(UTF_8)).isEmpty(); | ||
| assertThat(commandErrorOutput.toString(UTF_8)).isEmpty(); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldParsePluginOptionForMultiplePlugins() { | ||
| parseCommand("--plugins", "pluginA,pluginB"); | ||
| verify(mockBesuPluginContext).registerPlugins(pluginConfigurationArgumentCaptor.capture()); | ||
| assertThat(pluginConfigurationArgumentCaptor.getValue().getRequestedPlugins()) | ||
| .isEqualTo(List.of("pluginA", "pluginB")); | ||
|
|
||
| assertThat(commandOutput.toString(UTF_8)).isEmpty(); | ||
| assertThat(commandErrorOutput.toString(UTF_8)).isEmpty(); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldNotUsePluginOptionWhenNoPluginsSpecified() { | ||
| parseCommand(); | ||
| verify(mockBesuPluginContext).registerPlugins(pluginConfigurationArgumentCaptor.capture()); | ||
| assertThat(pluginConfigurationArgumentCaptor.getValue().getRequestedPlugins()) | ||
| .isEqualTo(List.of()); | ||
| assertThat(commandOutput.toString(UTF_8)).isEmpty(); | ||
| assertThat(commandErrorOutput.toString(UTF_8)).isEmpty(); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldNotParseAnyPluginsWhenPluginOptionIsEmpty() { | ||
| parseCommand("--plugins", ""); | ||
| verify(mockBesuPluginContext).registerPlugins(pluginConfigurationArgumentCaptor.capture()); | ||
| assertThat(pluginConfigurationArgumentCaptor.getValue().getRequestedPlugins()) | ||
| .isEqualTo(List.of()); | ||
| assertThat(commandOutput.toString(UTF_8)).isEmpty(); | ||
| assertThat(commandErrorOutput.toString(UTF_8)).isEmpty(); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldParsePluginsExternalEnabledOptionWhenFalse() { | ||
| parseCommand("--Xplugins-external-enabled=false"); | ||
| verify(mockBesuPluginContext).registerPlugins(pluginConfigurationArgumentCaptor.capture()); | ||
|
|
||
| assertThat(pluginConfigurationArgumentCaptor.getValue().isExternalPluginsEnabled()) | ||
| .isEqualTo(false); | ||
|
|
||
| assertThat(commandOutput.toString(UTF_8)).isEmpty(); | ||
| assertThat(commandErrorOutput.toString(UTF_8)).isEmpty(); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldParsePluginsExternalEnabledOptionWhenTrue() { | ||
| parseCommand("--Xplugins-external-enabled=true"); | ||
| verify(mockBesuPluginContext).registerPlugins(pluginConfigurationArgumentCaptor.capture()); | ||
|
|
||
| assertThat(pluginConfigurationArgumentCaptor.getValue().isExternalPluginsEnabled()) | ||
| .isEqualTo(true); | ||
|
|
||
| assertThat(commandOutput.toString(UTF_8)).isEmpty(); | ||
| assertThat(commandErrorOutput.toString(UTF_8)).isEmpty(); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldEnablePluginsExternalByDefault() { | ||
| parseCommand(); | ||
| verify(mockBesuPluginContext).registerPlugins(pluginConfigurationArgumentCaptor.capture()); | ||
| assertThat(pluginConfigurationArgumentCaptor.getValue().isExternalPluginsEnabled()) | ||
| .isEqualTo(true); | ||
|
|
||
| assertThat(commandOutput.toString(UTF_8)).isEmpty(); | ||
| assertThat(commandErrorOutput.toString(UTF_8)).isEmpty(); | ||
| } | ||
|
|
||
| @Test | ||
| public void shouldFailWhenPluginsIsDisabledAndPluginsExplicitlyRequested() { | ||
| parseCommand("--Xplugins-external-enabled=false", "--plugins", "pluginA"); | ||
| verify(mockBesuPluginContext).registerPlugins(pluginConfigurationArgumentCaptor.capture()); | ||
|
|
||
| assertThat(commandOutput.toString(UTF_8)).isEmpty(); | ||
| assertThat(commandErrorOutput.toString(UTF_8)) | ||
| .contains("--plugins option can only be used when --Xplugins-external-enabled is true"); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.