Skip to content
This repository has been archived by the owner on Sep 26, 2019. It is now read-only.

[NC-1856] Extracted non-Docker CLI parameters to picoCLI mixin. #323

Merged
merged 6 commits into from
Dec 3, 2018
Merged

[NC-1856] Extracted non-Docker CLI parameters to picoCLI mixin. #323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dd0e311
[NC-1856] Separated non-docker CLI parameters to picoCLI mixin.
mark-terry Nov 29, 2018
fc6c9c9
[NC-1856] PR fixes.
mark-terry Dec 2, 2018
5eff21b
[NC-1856] Merge.
mark-terry Dec 2, 2018
976fb27
[NC-1856] PR fixes.
mark-terry Dec 3, 2018
8633375
[NC-1856] Test setup fix..
mark-terry Dec 3, 2018
630f3f8
[NC-1856] Test setup improvement.
mark-terry Dec 3, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions pantheon/src/main/java/tech/pegasys/pantheon/cli/DefaultCommandValues.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
/*
* Copyright 2018 ConsenSys AG.
*
* 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.
*/
package tech.pegasys.pantheon.cli;

import java.io.File;
import java.io.IOException;
import java.nio.file.FileAlreadyExistsException;
import java.nio.file.Files;
import java.nio.file.InvalidPathException;
import java.nio.file.Path;
import java.nio.file.Paths;

import picocli.CommandLine;

interface DefaultCommandValues {
String CONFIG_FILE_OPTION_NAME = "--config";

String MANDATORY_PATH_FORMAT_HELP = "<PATH>";
String PANTHEON_HOME_PROPERTY_NAME = "pantheon.home";
String DEFAULT_DATA_DIR_PATH = "./build/data";

static Path getDefaultPantheonDataDir(final Object command) {
// this property is retrieved from Gradle tasks or Pantheon running shell script.
final String pantheonHomeProperty = System.getProperty(PANTHEON_HOME_PROPERTY_NAME);
final Path pantheonHome;

// If prop is found, then use it
if (pantheonHomeProperty != null) {
try {
pantheonHome = Paths.get(pantheonHomeProperty);
} catch (final InvalidPathException e) {
throw new CommandLine.ParameterException(
new CommandLine(command),
String.format(
"Unable to define default data directory from %s property.",
PANTHEON_HOME_PROPERTY_NAME),
e);
}
} else {
// otherwise use a default path.
// That may only be used when NOT run from distribution script and Gradle as they all define
// the property.
try {
final String path = new File(DEFAULT_DATA_DIR_PATH).getCanonicalPath();
pantheonHome = Paths.get(path);
} catch (final IOException e) {
throw new CommandLine.ParameterException(
new CommandLine(command), "Unable to create default data directory.");
}
}

// Try to create it, then verify if the provided path is not already existing and is not a
// directory .Otherwise, if it doesn't exist or exists but is already a directory,
// Runner will use it to store data.
try {
Files.createDirectories(pantheonHome);
} catch (final FileAlreadyExistsException e) {
// Only thrown if it exist but is not a directory
throw new CommandLine.ParameterException(
new CommandLine(command),
String.format(
"%s: already exists and is not a directory.", pantheonHome.toAbsolutePath()),
e);
} catch (final Exception e) {
throw new CommandLine.ParameterException(
new CommandLine(command),
String.format("Error creating directory %s.", pantheonHome.toAbsolutePath()),
e);
}
return pantheonHome;
}
}
130 changes: 36 additions & 94 deletions pantheon/src/main/java/tech/pegasys/pantheon/cli/PantheonCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

import static com.google.common.base.Preconditions.checkNotNull;
import static java.nio.charset.StandardCharsets.UTF_8;
import static tech.pegasys.pantheon.cli.DefaultCommandValues.getDefaultPantheonDataDir;

import tech.pegasys.pantheon.Runner;
import tech.pegasys.pantheon.RunnerBuilder;
Expand Down Expand Up @@ -41,11 +42,7 @@
import java.io.File;
import java.io.IOException;
import java.net.InetAddress;
import java.nio.file.FileAlreadyExistsException;
import java.nio.file.Files;
import java.nio.file.InvalidPathException;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
Expand Down Expand Up @@ -81,27 +78,21 @@
footerHeading = "%n",
footer = "Pantheon is licensed under the Apache License 2.0"
)
public class PantheonCommand implements Runnable {
public class PantheonCommand implements DefaultCommandValues, Runnable {

private static final int DEFAULT_MAX_PEERS = 25;

// Default should be FAST for the next release
// but we use FULL for the moment as Fast is still in progress
private static final SyncMode DEFAULT_SYNC_MODE = SyncMode.FULL;

private static final String PANTHEON_HOME_PROPERTY_NAME = "pantheon.home";
private static final String DEFAULT_DATA_DIR_PATH = "./build/data";

private static final String MANDATORY_HOST_AND_PORT_FORMAT_HELP = "<HOST:PORT>";
private static final String MANDATORY_PATH_FORMAT_HELP = "<PATH>";
private static final String MANDATORY_INTEGER_FORMAT_HELP = "<INTEGER>";
private static final String MANDATORY_MODE_FORMAT_HELP = "<MODE>";

private static final Wei DEFAULT_MIN_TRANSACTION_GAS_PRICE = Wei.of(1000);
private static final BytesValue DEFAULT_EXTRA_DATA = BytesValue.EMPTY;

private static final String CONFIG_FILE_OPTION_NAME = "--config";

public static class RpcApisConverter implements ITypeConverter<RpcApi> {
@Override
public RpcApi convert(final String name) throws RpcApisConversionException {
Expand Down Expand Up @@ -132,23 +123,12 @@ public static class RpcApisConversionException extends Exception {
// Public IP stored to prevent having to research it each time we need it.
private InetAddress autoDiscoveredDefaultIP = null;

// Property to indicate whether Pantheon has been launched via docker
private final boolean isDocker = Boolean.getBoolean("pantheon.docker");

// CLI options defined by user at runtime.
// Options parsing is done with CLI library Picocli https://picocli.info/

@Option(
names = {CONFIG_FILE_OPTION_NAME},
paramLabel = MANDATORY_PATH_FORMAT_HELP,
description = "TOML config file (default: none)"
)
private final File configFile = null;

@Option(
names = {"--datadir"},
paramLabel = MANDATORY_PATH_FORMAT_HELP,
description = "the path to Pantheon data directory (default: ${DEFAULT-VALUE})"
)
private final Path dataDir = getDefaultPantheonDataDir();

@Option(
names = {"--node-private-key"},
paramLabel = MANDATORY_PATH_FORMAT_HELP,
Expand All @@ -157,17 +137,6 @@ public static class RpcApisConversionException extends Exception {
)
private final File nodePrivateKeyFile = null;

// Genesis file path with null default option if the option
// is not defined on command line as this default is handled by Runner
// to use mainnet json file from resources
// NOTE: we have no control over default value here.
@Option(
names = {"--genesis"},
paramLabel = MANDATORY_PATH_FORMAT_HELP,
description = "The path to genesis file (default: Pantheon embedded mainnet genesis file)"
)
private final File genesisFile = null;

// Boolean option to indicate if peers should NOT be discovered, default to false indicates that
// the peers should be discovered by default.
//
Expand Down Expand Up @@ -400,13 +369,21 @@ public PantheonCommand(
this.synchronizerConfigurationBuilder = synchronizerConfigurationBuilder;
}

private StandaloneCommand standaloneCommands;

public void parse(
final AbstractParseResultHandler<List<Object>> resultHandler,
final DefaultExceptionHandler<List<Object>> exceptionHandler,
final String... args) {

final CommandLine commandLine = new CommandLine(this);

standaloneCommands = new StandaloneCommand();

if (isFullInstantiation()) {
commandLine.addMixin("standaloneCommands", standaloneCommands);
}

final ImportSubCommand importSubCommand = new ImportSubCommand(blockImporter);
commandLine.addSubcommand("import", importSubCommand);
commandLine.addSubcommand("export-pub-key", new ExportPublicKeySubCommand());
Expand Down Expand Up @@ -462,7 +439,7 @@ PantheonController<?> buildController() {
try {
return controllerBuilder
.synchronizerConfiguration(buildSyncConfig(syncMode))
.homePath(dataDir)
.homePath(dataDir())
.ethNetworkConfig(ethNetworkConfig())
.syncWithOttoman(syncWithOttoman)
.miningParameters(
Expand All @@ -478,7 +455,9 @@ PantheonController<?> buildController() {
}

private File getNodePrivateKeyFile() {
return nodePrivateKeyFile != null ? nodePrivateKeyFile : KeyPairUtil.getDefaultKeyFile(dataDir);
return nodePrivateKeyFile != null
? nodePrivateKeyFile
: KeyPairUtil.getDefaultKeyFile(dataDir());
}

private JsonRpcConfiguration jsonRpcConfiguration() {
Expand Down Expand Up @@ -539,7 +518,7 @@ private void synchronize(
.maxPeers(maxPeers)
.jsonRpcConfiguration(jsonRpcConfiguration)
.webSocketConfiguration(webSocketConfiguration)
.dataDir(dataDir)
.dataDir(dataDir())
.bannedNodeIds(bannedNodeIds)
.permissioningConfiguration(permissioningConfiguration)
.build();
Expand Down Expand Up @@ -579,57 +558,6 @@ private HostAndPort getDefaultHostAndPort(final int port) {
return HostAndPort.fromParts(autoDiscoverDefaultIP().getHostAddress(), port);
}

private Path getDefaultPantheonDataDir() {
// this property is retrieved from Gradle tasks or Pantheon running shell script.
final String pantheonHomeProperty = System.getProperty(PANTHEON_HOME_PROPERTY_NAME);
final Path pantheonHome;

// If prop is found, then use it
if (pantheonHomeProperty != null) {
try {
pantheonHome = Paths.get(pantheonHomeProperty);
} catch (final InvalidPathException e) {
throw new ParameterException(
new CommandLine(this),
String.format(
"Unable to define default data directory from %s property.",
PANTHEON_HOME_PROPERTY_NAME),
e);
}
} else {
// otherwise use a default path.
// That may only be used when NOT run from distribution script and Gradle as they all define
// the property.
try {
final String path = new File(DEFAULT_DATA_DIR_PATH).getCanonicalPath();
pantheonHome = Paths.get(path);
} catch (final IOException e) {
throw new ParameterException(
new CommandLine(this), "Unable to create default data directory.");
}
}

// Try to create it, then verify if the provided path is not already existing and is not a
// directory .Otherwise, if it doesn't exist or exists but is already a directory,
// Runner will use it to store data.
try {
Files.createDirectories(pantheonHome);
} catch (final FileAlreadyExistsException e) {
// Only thrown if it exist but is not a directory
throw new ParameterException(
new CommandLine(this),
String.format(
"%s: already exists and is not a directory.", pantheonHome.toAbsolutePath()),
e);
} catch (final Exception e) {
throw new ParameterException(
new CommandLine(this),
String.format("Error creating directory %s.", pantheonHome.toAbsolutePath()),
e);
}
return pantheonHome;
}

private EthNetworkConfig ethNetworkConfig() {
final EthNetworkConfig predefinedNetworkConfig;
if (rinkeby) {
Expand All @@ -644,7 +572,7 @@ private EthNetworkConfig ethNetworkConfig() {

private EthNetworkConfig updateNetworkConfig(final EthNetworkConfig ethNetworkConfig) {
final EthNetworkConfig.Builder builder = new EthNetworkConfig.Builder(ethNetworkConfig);
if (genesisFile != null) {
if (genesisFile() != null) {
builder.setGenesisConfig(genesisConfig());
}
if (networkId != null) {
Expand All @@ -658,10 +586,24 @@ private EthNetworkConfig updateNetworkConfig(final EthNetworkConfig ethNetworkCo

private String genesisConfig() {
try {
return Resources.toString(genesisFile.toURI().toURL(), UTF_8);
} catch (final IOException e) {
return Resources.toString(genesisFile().toURI().toURL(), UTF_8);
} catch (IOException e) {
throw new ParameterException(
new CommandLine(this), String.format("Unable to load genesis file %s.", genesisFile), e);
new CommandLine(this),
String.format("Unable to load genesis file %s.", genesisFile()),
e);
}
}

private File genesisFile() {
return isFullInstantiation() ? standaloneCommands.genesisFile : null;
}

private Path dataDir() {
return isFullInstantiation() ? standaloneCommands.dataDir : getDefaultPantheonDataDir(this);
}

private boolean isFullInstantiation() {
return !isDocker;
}
}
48 changes: 48 additions & 0 deletions pantheon/src/main/java/tech/pegasys/pantheon/cli/StandaloneCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/*
* Copyright 2018 ConsenSys AG.
*
* 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.
*/
package tech.pegasys.pantheon.cli;

import static tech.pegasys.pantheon.cli.DefaultCommandValues.getDefaultPantheonDataDir;

import java.io.File;
import java.nio.file.Path;

import picocli.CommandLine;

class StandaloneCommand implements DefaultCommandValues {

@CommandLine.Option(
names = {CONFIG_FILE_OPTION_NAME},
paramLabel = MANDATORY_PATH_FORMAT_HELP,
description = "TOML config file (default: none)"
)
private final File configFile = null;

@CommandLine.Option(
names = {"--datadir"},
paramLabel = MANDATORY_PATH_FORMAT_HELP,
description = "The path to Pantheon data directory (default: ${DEFAULT-VALUE})"
)
final Path dataDir = getDefaultPantheonDataDir(this);

// Genesis file path with null default option if the option
// is not defined on command line as this default is handled by Runner
// to use mainnet json file from resources
// NOTE: we have no control over default value here.
@CommandLine.Option(
names = {"--genesis"},
paramLabel = MANDATORY_PATH_FORMAT_HELP,
description = "The path to genesis file (default: Pantheon embedded mainnet genesis file)"
)
final File genesisFile = null;
}
Loading