Extract duplicate clap helpers into clap-utils (#6812)

Author: ryoqun

Cargo.lock

@@ -10,6 +10,7 @@ homepage = "https://solana.com/"
 [dependencies]
 clap = "2.33.0"
 console = "0.9.1"
+solana-clap-utils = { path = "../clap-utils", version = "0.21.0" }
 solana-core = { path = "../core", version = "0.21.0" }
 solana-logger = { path = "../logger", version = "0.21.0" }
 solana-metrics = { path = "../metrics", version = "0.21.0" }

archiver/Cargo.toml

@@ -1,5 +1,6 @@
 use clap::{crate_description, crate_name, crate_version, App, Arg};
 use console::style;
+use solana_clap_utils::input_validators::is_keypair;
 use solana_core::{
     archiver::Archiver,
     cluster_info::{Node, VALIDATOR_PORT_RANGE},
@@ -11,13 +12,6 @@ use solana_sdk::{
 };
 use std::{net::SocketAddr, path::PathBuf, process::exit, sync::Arc};
 
-// Return an error if a keypair file cannot be parsed.
-fn is_keypair(string: String) -> Result<(), String> {
-    read_keypair_file(&string)
-        .map(|_| ())
-        .map_err(|err| format!("{:?}", err))
-}
-
 fn main() {
     solana_logger::setup();
 

archiver/src/main.rs

@@ -0,0 +1,18 @@
+[package]
+name = "solana-clap-utils"
+version = "0.21.0"
+description = "Solana utilities for the clap"
+authors = ["Solana Maintainers <[email protected]>"]
+repository = "https://github.com/solana-labs/solana"
+license = "Apache-2.0"
+homepage = "https://solana.com/"
+edition = "2018"
+
+[dependencies]
+clap = "2.33.0"
+semver = "0.9.0"
+solana-sdk = { path = "../sdk", version = "0.21.0" }
+url = "2.1.0"
+
+[lib]
+name = "solana_clap_utils"

clap-utils/Cargo.toml

@@ -34,3 +34,17 @@ pub fn is_url(string: String) -> Result<(), String> {
         Err(err) => Err(format!("{:?}", err)),
     }
 }
+
+pub fn is_semver(semver: &str) -> Result<(), String> {
+    match semver::Version::parse(&semver) {
+        Ok(_) => Ok(()),
+        Err(err) => Err(format!("{:?}", err)),
+    }
+}
+
+pub fn is_release_channel(channel: &str) -> Result<(), String> {
+    match channel {
+        "edge" | "beta" | "stable" => Ok(()),
+        _ => Err(format!("Invalid release channel {}", channel)),
+    }
+}

cli/src/input_parsers.rs renamed to clap-utils/src/input_parsers.rs

@@ -0,0 +1,2 @@
+pub mod input_parsers;
+pub mod input_validators;

cli/src/input_validators.rs renamed to clap-utils/src/input_validators.rs

@@ -27,6 +27,7 @@ serde_derive = "1.0.102"
 serde_json = "1.0.41"
 serde_yaml = "0.8.11"
 solana-budget-api = { path = "../programs/budget_api", version = "0.21.0" }
+solana-clap-utils = { path = "../clap-utils", version = "0.21.0" }
 solana-client = { path = "../client", version = "0.21.0" }
 solana-config-api = { path = "../programs/config_api", version = "0.21.0" }
 solana-drone = { path = "../drone", version = "0.21.0" }

clap-utils/src/lib.rs

@@ -1,13 +1,14 @@
 use crate::{
-    cluster_query::*, display::println_name_value, input_parsers::*, input_validators::*, stake::*,
-    storage::*, validator_info::*, vote::*,
+    cluster_query::*, display::println_name_value, stake::*, storage::*, validator_info::*, vote::*,
 };
 use chrono::prelude::*;
 use clap::{App, AppSettings, Arg, ArgMatches, SubCommand};
 use log::*;
 use num_traits::FromPrimitive;
 use serde_json::{self, json, Value};
+
 use solana_budget_api::budget_instruction::{self, BudgetError};
+use solana_clap_utils::{input_parsers::*, input_validators::*};
 use solana_client::{client_error::ClientError, rpc_client::RpcClient};
 #[cfg(not(test))]
 use solana_drone::drone::request_airdrop_transaction;
@@ -32,6 +33,7 @@ use solana_sdk::{
 use solana_stake_api::stake_state::{Lockup, StakeAuthorize};
 use solana_storage_api::storage_instruction::StorageAccountType;
 use solana_vote_api::vote_state::VoteAuthorize;
+
 use std::{
     fs::File,
     io::{Read, Write},

cli/Cargo.toml

@@ -5,8 +5,6 @@ pub mod cli;
 pub mod cluster_query;
 pub mod config;
 pub mod display;
-pub mod input_parsers;
-pub mod input_validators;
 pub mod stake;
 pub mod storage;
 pub mod validator_info;

cli/src/cli.rs

@@ -1,12 +1,14 @@
 use clap::{crate_description, crate_name, crate_version, Arg, ArgGroup, ArgMatches, SubCommand};
 use console::style;
+
+use solana_clap_utils::input_validators::is_url;
 use solana_cli::{
     cli::{app, parse_command, process_command, CliCommandInfo, CliConfig, CliError},
     config::{self, Config},
     display::{println_name_value, println_name_value_or},
-    input_validators::is_url,
 };
 use solana_sdk::signature::read_keypair_file;
+
 use std::error;
 
 fn parse_settings(matches: &ArgMatches<'_>) -> Result<bool, Box<dyn error::Error>> {

cli/src/lib.rs

@@ -1,14 +1,10 @@
-use crate::{
-    cli::{
-        build_balance_message, check_account_for_fee, check_unique_pubkeys,
-        log_instruction_custom_error, CliCommand, CliCommandInfo, CliConfig, CliError,
-        ProcessResult,
-    },
-    input_parsers::*,
-    input_validators::*,
+use crate::cli::{
+    build_balance_message, check_account_for_fee, check_unique_pubkeys,
+    log_instruction_custom_error, CliCommand, CliCommandInfo, CliConfig, CliError, ProcessResult,
 };
 use clap::{App, Arg, ArgMatches, SubCommand};
 use console::style;
+use solana_clap_utils::{input_parsers::*, input_validators::*};
 use solana_client::rpc_client::RpcClient;
 use solana_sdk::signature::Keypair;
 use solana_sdk::{

cli/src/main.rs

@@ -1,12 +1,9 @@
-use crate::{
-    cli::{
-        check_account_for_fee, check_unique_pubkeys, log_instruction_custom_error, CliCommand,
-        CliCommandInfo, CliConfig, CliError, ProcessResult,
-    },
-    input_parsers::*,
-    input_validators::*,
+use crate::cli::{
+    check_account_for_fee, check_unique_pubkeys, log_instruction_custom_error, CliCommand,
+    CliCommandInfo, CliConfig, CliError, ProcessResult,
 };
 use clap::{App, Arg, ArgMatches, SubCommand};
+use solana_clap_utils::{input_parsers::*, input_validators::*};
 use solana_client::rpc_client::RpcClient;
 use solana_sdk::signature::Keypair;
 use solana_sdk::{

cli/src/stake.rs

@@ -1,14 +1,17 @@
 use crate::{
     cli::{check_account_for_fee, CliCommand, CliCommandInfo, CliConfig, CliError, ProcessResult},
     display::println_name_value,
-    input_parsers::pubkey_of,
-    input_validators::{is_pubkey, is_url},
 };
 use bincode::deserialize;
 use clap::{App, Arg, ArgMatches, SubCommand};
 use reqwest::Client;
 use serde_derive::{Deserialize, Serialize};
 use serde_json::{Map, Value};
+
+use solana_clap_utils::{
+    input_parsers::pubkey_of,
+    input_validators::{is_pubkey, is_url},
+};
 use solana_client::rpc_client::RpcClient;
 use solana_config_api::{config_instruction, get_config_data, ConfigKeys, ConfigState};
 use solana_sdk::{
@@ -19,6 +22,7 @@ use solana_sdk::{
     signature::{Keypair, KeypairUtil},
     transaction::Transaction,
 };
+
 use std::error;
 
 pub const MAX_SHORT_FIELD_LENGTH: usize = 70;

cli/src/storage.rs

@@ -1,13 +1,9 @@
-use crate::{
-    cli::{
-        build_balance_message, check_account_for_fee, check_unique_pubkeys,
-        log_instruction_custom_error, CliCommand, CliCommandInfo, CliConfig, CliError,
-        ProcessResult,
-    },
-    input_parsers::*,
-    input_validators::*,
+use crate::cli::{
+    build_balance_message, check_account_for_fee, check_unique_pubkeys,
+    log_instruction_custom_error, CliCommand, CliCommandInfo, CliConfig, CliError, ProcessResult,
 };
 use clap::{value_t_or_exit, App, Arg, ArgMatches, SubCommand};
+use solana_clap_utils::{input_parsers::*, input_validators::*};
 use solana_client::rpc_client::RpcClient;
 use solana_sdk::signature::Keypair;
 use solana_sdk::{

cli/src/validator_info.rs

@@ -10,6 +10,7 @@ homepage = "https://solana.com/"
 
 [dependencies]
 clap = "2.33.0"
+solana-clap-utils = { path = "../clap-utils", version = "0.21.0" }
 solana-core = { path = "../core", version = "0.21.0" }
 solana-client = { path = "../client", version = "0.21.0" }
 solana-logger = { path = "../logger", version = "0.21.0" }

cli/src/vote.rs

@@ -4,20 +4,14 @@ use clap::{
     crate_description, crate_name, crate_version, value_t_or_exit, App, AppSettings, Arg,
     SubCommand,
 };
+use solana_clap_utils::input_validators::is_pubkey;
 use solana_client::rpc_client::RpcClient;
 use solana_core::{contact_info::ContactInfo, gossip_service::discover};
 use solana_sdk::pubkey::Pubkey;
 use std::error;
 use std::net::SocketAddr;
 use std::process::exit;
 
-fn is_pubkey(pubkey: String) -> Result<(), String> {
-    match pubkey.parse::<Pubkey>() {
-        Ok(_) => Ok(()),
-        Err(err) => Err(format!("{:?}", err)),
-    }
-}
-
 fn main() -> Result<(), Box<dyn error::Error>> {
     solana_logger::setup_with_filter("solana=info");
 

gossip/Cargo.toml

@@ -23,11 +23,11 @@ lazy_static = "1.4.0"
 log = "0.4.8"
 nix = "0.15.0"
 reqwest = { version = "0.9.22", default-features = false, features = ["rustls-tls"] }
-semver = "0.9.0"
 serde = "1.0.102"
 serde_derive = "1.0.102"
 serde_yaml = "0.8.11"
 sha2 = "0.8.0"
+solana-clap-utils = { path = "../clap-utils", version = "0.21.0" }
 solana-client = { path = "../client", version = "0.21.0" }
 solana-config-api = { path = "../programs/config_api", version = "0.21.0" }
 solana-logger = { path = "../logger", version = "0.21.0" }

gossip/src/main.rs

@@ -2,6 +2,7 @@
 extern crate lazy_static;
 
 use clap::{crate_description, crate_name, crate_version, App, AppSettings, Arg, SubCommand};
+use solana_clap_utils::input_validators::{is_pubkey, is_release_channel, is_semver, is_url};
 use solana_sdk::pubkey::Pubkey;
 
 mod build_env;
@@ -11,42 +12,6 @@ mod defaults;
 mod stop_process;
 mod update_manifest;
 
-// Return an error if a url cannot be parsed.
-fn is_url(string: String) -> Result<(), String> {
-    match url::Url::parse(&string) {
-        Ok(url) => {
-            if url.has_host() {
-                Ok(())
-            } else {
-                Err("no host provided".to_string())
-            }
-        }
-        Err(err) => Err(format!("{:?}", err)),
-    }
-}
-
-// Return an error if a pubkey cannot be parsed.
-fn is_pubkey(string: String) -> Result<(), String> {
-    match string.parse::<Pubkey>() {
-        Ok(_) => Ok(()),
-        Err(err) => Err(format!("{:?}", err)),
-    }
-}
-
-fn is_semver(semver: &str) -> Result<(), String> {
-    match semver::Version::parse(&semver) {
-        Ok(_) => Ok(()),
-        Err(err) => Err(format!("{:?}", err)),
-    }
-}
-
-fn is_release_channel(channel: &str) -> Result<(), String> {
-    match channel {
-        "edge" | "beta" | "stable" => Ok(()),
-        _ => Err(format!("Invalid release channel {}", channel)),
-    }
-}
-
 pub fn main() -> Result<(), String> {
     solana_logger::setup();
 

install/Cargo.toml

@@ -17,6 +17,7 @@ log = "0.4.8"
 indicatif = "0.13.0"
 reqwest = { version = "0.9.22", default-features = false }
 serde_json = "1.0.41"
+solana-clap-utils = { path = "../clap-utils", version = "0.21.0" }
 solana-client = { path = "../client", version = "0.21.0" }
 solana-core = { path = "../core", version = "0.21.0" }
 solana-drone = { path = "../drone", version = "0.21.0" }