From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id 6F49B1FF394 for ; Mon, 3 Jun 2024 10:10:15 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 9A2991CCF9; Mon, 3 Jun 2024 10:10:42 +0200 (CEST) Date: Mon, 3 Jun 2024 10:10:39 +0200 From: Wolfgang Bumiller To: Gabriel Goller Message-ID: References: <20240426123720.110120-1-g.goller@proxmox.com> <20240426123720.110120-2-g.goller@proxmox.com> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20240426123720.110120-2-g.goller@proxmox.com> X-SPAM-LEVEL: Spam detection results: 0 AWL 0.090 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: Re: [pbs-devel] [PATCH proxmox v6 1/2] router: cli: add confirmation helper X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox Backup Server development discussion Cc: Thomas Lamprecht , pbs-devel@lists.proxmox.com Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" Some minor cleanups & doc nits: On Fri, Apr 26, 2024 at 02:37:15PM GMT, Gabriel Goller wrote: > Add confirmation helper that outputs a prompt and lets the user > confirm or deny it. > Implemented to close #4763. > > Co-authored-by: Thomas Lamprecht > Signed-off-by: Gabriel Goller > --- > proxmox-router/Cargo.toml | 1 + > proxmox-router/src/cli/mod.rs | 113 +++++++++++++++++++++++++++++++++- > 2 files changed, 113 insertions(+), 1 deletion(-) > > diff --git a/proxmox-router/Cargo.toml b/proxmox-router/Cargo.toml > index dcd71a4..0b9d361 100644 > --- a/proxmox-router/Cargo.toml > +++ b/proxmox-router/Cargo.toml > @@ -19,6 +19,7 @@ percent-encoding.workspace = true > serde_json.workspace = true > serde.workspace = true > unicode-width ="0.1.8" > +regex.workspace = true > > # cli: > tokio = { workspace = true, features = [], optional = true } > diff --git a/proxmox-router/src/cli/mod.rs b/proxmox-router/src/cli/mod.rs > index 7df94ad..d13caa5 100644 > --- a/proxmox-router/src/cli/mod.rs > +++ b/proxmox-router/src/cli/mod.rs > @@ -12,7 +12,11 @@ > //! - Ability to create interactive commands (using ``rustyline``) > //! - Supports complex/nested commands > > -use std::collections::HashMap; > +use std::{ > + collections::HashMap, > + io::{self, Write}, > +}; > +use anyhow::bail; > > use crate::ApiMethod; > > @@ -61,6 +65,113 @@ pub fn init_cli_logger(env_var_name: &str, default_log_level: &str) { > .init(); > } > > +#[derive(PartialEq, Debug)] This is essentially a bool, so +Clone+Copy please. Also maybe +Eq? > +/// Use for simple yes or no questions, where booleans can be confusing, especially if there's a > +/// default response to consider. The implementation provides query helper for the CLI. > +pub enum Confirmation { > + Yes, > + No, > +} > + > +impl Confirmation { > + /// Get the formatted choice for the query prompt, with self being the highlighted (default) > + /// one displayed as upper case. > + pub fn default_choice_str(&self) -> &'static str { ^ With +Copy all the methods can drop the `&` and be self-consuming. > + match self { > + Self::Yes => "Y/n", > + Self::No => "y/N", > + } > + } > + > + /// Returns true if the answer is Yes > + pub fn is_yes(&self) -> bool { > + *self == Self::Yes > + } > + > + /// Returns true if the answer is No > + pub fn is_no(&self) -> bool { > + *self == Self::No > + } > + > + /// Parse an input string reference as yes or no confirmation. > + /// > + /// The input string is checked verbatim if it is exactly one of the single chars 'y', 'Y', > + /// 'n', or 'N'. You must trim the string before calling, if needed, or use one of the query > + /// helper functions. > + /// > + /// ``` > + /// use proxmox_router::cli::Confirmation; > + /// > + /// let answer = Confirmation::from_str("y"); > + /// assert!(answer.expect("valid").is_yes()); > + /// > + /// let answer = Confirmation::from_str("N"); > + /// assert!(answer.expect("valid").is_no()); > + /// > + /// let answer = Confirmation::from_str("bogus"); > + /// assert!(answer.is_err()); > + /// ``` > + pub fn from_str(input: &str) -> Result { > + match input.trim() { > + "y" | "Y" => Ok(Self::Yes), > + "n" | "N" => Ok(Self::No), > + _ => bail!("unexpected choice '{input}'! Use 'y' or 'n'"), > + } > + } > + > + /// Parse a input string reference as yes or no confirmation, allowing a fallback default > + /// answer if the user enters an empty choice. > + /// > + /// The input string is checked verbatim if it is exactly one of the single chars 'y', 'Y', > + /// 'n', or 'N'. The empty string maps to the default. You must trim the string before calling, > + /// if needed, or use one of the query helper functions. > + /// > + /// ``` > + /// use proxmox_router::cli::Confirmation; > + /// > + /// let answer = Confirmation::from_str_with_default("", Confirmation::No); > + /// assert!(answer.expect("valid").is_no()); > + /// > + /// let answer = Confirmation::from_str_with_default("n", Confirmation::Yes); > + /// assert!(answer.expect("valid").is_no()); > + /// > + /// let answer = Confirmation::from_str_with_default("yes", Confirmation::Yes); > + /// assert!(answer.is_err()); // full-word answer not allowed for now. > + /// ``` > + pub fn from_str_with_default(input: &str, default: Self) -> Result { > + match input.trim() { > + "y" | "Y" => Ok(Self::Yes), > + "n" | "N" => Ok(Self::No), > + "" => Ok(default), > + _ => bail!("unexpected choice '{input}'! Use enter for default or use 'y' or 'n'"), > + } > + } > + > + /// Print a query prompt with available yes no choices and returns the String the user enters. > + fn read_line(query: &str, choices: &str) -> Result { > + print!("{query} [{choices}]: "); > + > + io::stdout().flush()?; > + let stdin = io::stdin(); > + let mut line = String::new(); > + stdin.read_line(&mut line)?; > + Ok(line) > + } > + > + /// Print a query prompt and parse the white-space trimmed answer using from_str. Please add backticks around `from_str`. > + pub fn query(query: &str) -> Result { > + let line = Self::read_line(query, "y/n")?; > + Confirmation::from_str(line.trim()) > + } > + > + /// Print a query prompt and parse the answer using from_str_with_default, falling back to the Please add backticks around `from_str_with_default`. > + /// default_answer if the user provided an empty string. > + pub fn query_with_default(query: &str, default_answer: Self) -> Result { > + let line = Self::read_line(query, default_answer.default_choice_str())?; > + Confirmation::from_str_with_default(line.trim(), default_answer) > + } > +} _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel