Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Getting configuration from commands #4643

Merged
merged 10 commits into from
Jan 16, 2020
Merged

Getting configuration from commands #4643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b555169
Expose a method that allows converting RunCmd to Configuration
cecton Jan 13, 2020
66be588
WIP
cecton Jan 13, 2020
3ead9ce
WIP
cecton Jan 13, 2020
7c53455
WIP
cecton Jan 13, 2020
6995304
WIP
cecton Jan 15, 2020
1484209
WIP
cecton Jan 15, 2020
aa18852
Merge remote-tracking branch 'origin/master' into cecton-getting-conf…
cecton Jan 16, 2020
a5f77e4
WIP
cecton Jan 16, 2020
b9891a8
WIP
cecton Jan 16, 2020
9b8b472
WIP
cecton Jan 16, 2020
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
1 change: 1 addition & 0 deletions bin/node/cli/src/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ pub fn run<I, T, E>(args: I, exit: E, version: sc_cli::VersionInfo) -> error::Re
load_spec,
&cli_args.shared_params,
&version,
None,
)?;
sc_cli::fill_import_params(&mut config, &cli_args.import_params, ServiceRoles::FULL)?;

Expand Down
209 changes: 193 additions & 16 deletions client/cli/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,13 @@ pub fn load_spec<F, G, E>(cli: &SharedParams, factory: F) -> error::Result<Chain
Ok(spec)
}

fn base_path(cli: &SharedParams, version: &VersionInfo) -> PathBuf {
fn base_path(
cli: &SharedParams,
version: &VersionInfo,
default_base_path: Option<PathBuf>,
) -> PathBuf {
cli.base_path.clone()
.or(default_base_path)
.unwrap_or_else(||
app_dirs::get_app_root(
AppDataType::UserData,
Expand Down Expand Up @@ -295,6 +300,78 @@ impl<'a, CC, RP> ParseAndPrepare<'a, CC, RP> where CC: GetSharedParams {
}
}

impl<'a, CC, RP> ParseAndPrepare<'a, CC, RP> {
/// Convert ParseAndPrepare to Configuration
pub fn into_configuration<C, G, E, S>(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should existing node/cli and node-template/cli be using that function?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(answered on #4643 (comment) )

self,
spec_factory: S,
default_base_path: Option<PathBuf>,
) -> error::Result<Option<Configuration<C, G, E>>>
where
C: Default,
G: RuntimeGenesis,
E: ChainSpecExtension,
S: FnOnce(&str) -> Result<Option<ChainSpec<G, E>>, String>,
{
match self {
ParseAndPrepare::Run(c) =>
Some(create_run_node_config(
c.params.left,
spec_factory,
c.impl_name,
c.version,
default_base_path,
)).transpose(),
ParseAndPrepare::BuildSpec(c) => {
let spec = load_spec(&c.params.shared_params, spec_factory)?;

Some(create_build_spec_config(
&spec,
&c.params.shared_params,
c.version,
default_base_path,
)).transpose()
},
ParseAndPrepare::ExportBlocks(c) =>
Some(create_config_with_db_path(
spec_factory,
&c.params.shared_params,
c.version,
default_base_path,
)).transpose(),
ParseAndPrepare::ImportBlocks(c) =>
Some(create_config_with_db_path(
spec_factory,
&c.params.shared_params,
c.version,
default_base_path,
)).transpose(),
ParseAndPrepare::CheckBlock(c) =>
Some(create_config_with_db_path(
spec_factory,
&c.params.shared_params,
c.version,
default_base_path,
)).transpose(),
ParseAndPrepare::PurgeChain(c) =>
Some(create_config_with_db_path(
spec_factory,
&c.params.shared_params,
c.version,
default_base_path,
)).transpose(),
ParseAndPrepare::RevertChain(c) =>
Some(create_config_with_db_path(
spec_factory,
&c.params.shared_params,
c.version,
default_base_path,
)).transpose(),
ParseAndPrepare::CustomCommand(_) => Ok(None),
}
}
}

/// Command ready to run the main client.
pub struct ParseAndPrepareRun<'a, RP> {
params: MergeParameters<RunCmd, RP>,
Expand All @@ -321,7 +398,11 @@ impl<'a, RP> ParseAndPrepareRun<'a, RP> {
RS: FnOnce(Exit, RunCmd, RP, Configuration<C, G, CE>) -> Result<(), E>
{
let config = create_run_node_config(
self.params.left.clone(), spec_factory, self.impl_name, self.version,
self.params.left.clone(),
spec_factory,
self.impl_name,
self.version,
None,
)?;

run_service(exit, self.params.left, self.params.right, config).map_err(Into::into)
Expand Down Expand Up @@ -350,11 +431,12 @@ impl<'a> ParseAndPrepareBuildSpec<'a> {
let mut spec = load_spec(&self.params.shared_params, spec_factory)?;

if spec.boot_nodes().is_empty() && !self.params.disable_default_bootnode {
let base_path = base_path(&self.params.shared_params, self.version);
let cfg = sc_service::Configuration::<C,_,_>::default_with_spec_and_base_path(
spec.clone(),
Some(base_path),
);
let cfg = create_build_spec_config::<C, _, _>(
&spec,
&self.params.shared_params,
self.version,
None,
)?;
let node_key = node_key_config(
self.params.node_key_params,
&Some(cfg.in_chain_config_dir(DEFAULT_NETWORK_CONFIG_PATH).expect("We provided a base_path"))
Expand Down Expand Up @@ -401,7 +483,12 @@ impl<'a> ParseAndPrepareExport<'a> {
E: ChainSpecExtension,
Exit: IntoExit
{
let mut config = create_config_with_db_path(spec_factory, &self.params.shared_params, self.version)?;
let mut config = create_config_with_db_path(
spec_factory,
&self.params.shared_params,
self.version,
None,
)?;
fill_config_keystore_in_memory(&mut config)?;

if let DatabaseConfig::Path { ref path, .. } = &config.database {
Expand Down Expand Up @@ -463,7 +550,12 @@ impl<'a> ParseAndPrepareImport<'a> {
E: ChainSpecExtension,
Exit: IntoExit
{
let mut config = create_config_with_db_path(spec_factory, &self.params.shared_params, self.version)?;
let mut config = create_config_with_db_path(
spec_factory,
&self.params.shared_params,
self.version,
None,
)?;
fill_import_params(&mut config, &self.params.import_params, sc_service::Roles::FULL)?;

let file: Box<dyn ReadPlusSeek + Send> = match self.params.input {
Expand Down Expand Up @@ -522,7 +614,12 @@ impl<'a> CheckBlock<'a> {
E: ChainSpecExtension,
Exit: IntoExit
{
let mut config = create_config_with_db_path(spec_factory, &self.params.shared_params, self.version)?;
let mut config = create_config_with_db_path(
spec_factory,
&self.params.shared_params,
self.version,
None,
)?;
fill_import_params(&mut config, &self.params.import_params, sc_service::Roles::FULL)?;
fill_config_keystore_in_memory(&mut config)?;

Expand Down Expand Up @@ -562,7 +659,10 @@ impl<'a> ParseAndPreparePurge<'a> {
E: ChainSpecExtension,
{
let mut config = create_config_with_db_path::<(), _, _, _>(
spec_factory, &self.params.shared_params, self.version
spec_factory,
&self.params.shared_params,
self.version,
None,
)?;
fill_config_keystore_in_memory(&mut config)?;
let db_path = match config.database {
Expand Down Expand Up @@ -627,7 +727,10 @@ impl<'a> ParseAndPrepareRevert<'a> {
E: ChainSpecExtension,
{
let mut config = create_config_with_db_path(
spec_factory, &self.params.shared_params, self.version
spec_factory,
&self.params.shared_params,
self.version,
None,
)?;
fill_config_keystore_in_memory(&mut config)?;

Expand Down Expand Up @@ -852,15 +955,24 @@ pub fn fill_import_params<C, G, E>(
}

fn create_run_node_config<C, G, E, S>(
cli: RunCmd, spec_factory: S, impl_name: &'static str, version: &VersionInfo,
cli: RunCmd,
spec_factory: S,
impl_name: &'static str,
version: &VersionInfo,
default_base_path: Option<PathBuf>,
) -> error::Result<Configuration<C, G, E>>
where
C: Default,
G: RuntimeGenesis,
E: ChainSpecExtension,
S: FnOnce(&str) -> Result<Option<ChainSpec<G, E>>, String>,
{
let mut config = create_config_with_db_path(spec_factory, &cli.shared_params, &version)?;
let mut config = create_config_with_db_path(
spec_factory,
&cli.shared_params,
&version,
default_base_path,
)?;

fill_config_keystore_password_and_path(&mut config, &cli)?;

Expand Down Expand Up @@ -994,7 +1106,10 @@ fn interface_str(

/// Creates a configuration including the database path.
pub fn create_config_with_db_path<C, G, E, S>(
spec_factory: S, cli: &SharedParams, version: &VersionInfo,
spec_factory: S,
cli: &SharedParams,
version: &VersionInfo,
default_base_path: Option<PathBuf>,
) -> error::Result<Configuration<C, G, E>>
where
C: Default,
Expand All @@ -1003,7 +1118,7 @@ where
S: FnOnce(&str) -> Result<Option<ChainSpec<G, E>>, String>,
{
let spec = load_spec(cli, spec_factory)?;
let base_path = base_path(cli, version);
let base_path = base_path(cli, version, default_base_path);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could delegate to create_build_spec_config to avoid duplication


let mut config = sc_service::Configuration::default_with_spec_and_base_path(
spec.clone(),
Expand All @@ -1018,6 +1133,27 @@ where
Ok(config)
}

/// Creates a configuration including the base path and the shared params
fn create_build_spec_config<C, G, E>(
spec: &ChainSpec<G, E>,
cli: &SharedParams,
version: &VersionInfo,
default_base_path: Option<PathBuf>,
) -> error::Result<Configuration<C, G, E>>
where
C: Default,
G: RuntimeGenesis,
E: ChainSpecExtension,
{
let base_path = base_path(&cli, version, default_base_path);
let cfg = sc_service::Configuration::<C,_,_>::default_with_spec_and_base_path(
spec.clone(),
Some(base_path),
);

Ok(cfg)
}

/// Internal trait used to cast to a dynamic type that implements Read and Seek.
trait ReadPlusSeek: Read + Seek {}

Expand Down Expand Up @@ -1255,6 +1391,7 @@ mod tests {
|_| Ok(Some(chain_spec.clone())),
"test",
&version_info,
None,
).unwrap();

let expected_path = match keystore_path {
Expand All @@ -1265,4 +1402,44 @@ mod tests {
assert_eq!(expected_path, node_config.keystore.path().unwrap().to_owned());
}
}

#[test]
fn parse_and_prepare_into_configuration() {
let chain_spec = ChainSpec::from_genesis(
"test",
"test-id",
|| (),
Vec::new(),
None,
None,
None,
None,
);
let version = VersionInfo {
name: "test",
version: "42",
commit: "234234",
executable_name: "test",
description: "cool test",
author: "universe",
support_url: "com",
};
let spec_factory = |_: &str| Ok(Some(chain_spec.clone()));

let args = vec!["substrate", "--dev", "--state-cache-size=42"];
let pnp = parse_and_prepare::<NoCustom, NoCustom, _>(&version, "test", args);
let config = pnp.into_configuration::<(), _, _, _>(spec_factory, None).unwrap().unwrap();
assert_eq!(config.roles, sc_service::Roles::AUTHORITY);
assert_eq!(config.state_cache_size, 42);

let args = vec!["substrate", "import-blocks", "--dev"];
let pnp = parse_and_prepare::<NoCustom, NoCustom, _>(&version, "test", args);
let config = pnp.into_configuration::<(), _, _, _>(spec_factory, None).unwrap().unwrap();
assert_eq!(config.roles, sc_service::Roles::FULL);

let args = vec!["substrate", "--base-path=/foo"];
let pnp = parse_and_prepare::<NoCustom, NoCustom, _>(&version, "test", args);
let config = pnp.into_configuration::<(), _, _, _>(spec_factory, Some("/bar".into())).unwrap().unwrap();
assert_eq!(config.config_dir, Some("/foo".into()));
}
}