From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gate001.proxmox.com (gate001.proxmox.com [IPv6:2a0f:8001:1:32::40]) by lore.proxmox.com (Postfix) with ESMTPS id 369F71FF0B6 for ; Thu, 12 Nov 2026 11:07:10 +0100 (CET) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id 9397121666; Thu, 12 Nov 2026 11:07:07 +0100 (CET) Message-ID: <2026dd36-e147-4f13-90c1-f340a6160c2f@proxmox.com> Date: Thu, 12 Nov 2026 11:07:02 +0100 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH installer] fix #7833: common: cli: ensure process exits with 1 if subcommand fails To: pve-devel@lists.proxmox.com References: <20260818095947.464930-1-c.heiss@proxmox.com> Content-Language: en-US From: Christoph Heiss In-Reply-To: <20260818095947.464930-1-c.heiss@proxmox.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1794478022674 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.131 Adjusted score from AWL reputation of From: address DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment (newer systems) RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: E5L62423GUQYDS3FLFYTGBLOD2352ZNQ X-Message-ID-Hash: E5L62423GUQYDS3FLFYTGBLOD2352ZNQ X-MailFrom: c.heiss@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox VE development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Obsoleted by commit 8d2483a67 [0]. [0] https://git.proxmox.com/?p=pve-installer.git;a=commitdiff;h=8d2483a67 On 8/18/26 11:59, Christoph Heiss wrote: > Fixes #7833 [0]. > > Currently, errors from the `AppInfo::on_command` handler is propagated > and printed, but does not cause cli::run() to return a failure exit > code. > > A small, custom error enum is introduced to differentiate between an > unknown/missing subcommand - which should also trigger the global help > menu - and errors from the command that was run. > > Based on that, the appropriate `ExitCode` variant is set and propagated > back to the caller. > > [0] https://bugzilla.proxmox.com/show_bug.cgi?id=7833 > > Signed-off-by: Christoph Heiss > --- > proxmox-auto-install-assistant/src/main.rs | 4 +- > proxmox-chroot/src/main.rs | 4 +- > proxmox-installer-common/src/cli.rs | 91 ++++++++++++++++++---- > 3 files changed, 78 insertions(+), 21 deletions(-) > > diff --git a/proxmox-auto-install-assistant/src/main.rs b/proxmox-auto-install-assistant/src/main.rs > index 730d7d8..728d8ee 100644 > --- a/proxmox-auto-install-assistant/src/main.rs > +++ b/proxmox-auto-install-assistant/src/main.rs > @@ -560,8 +560,8 @@ GLOBAL OPTIONS: > Some("device-match") => cli::handle_command::(args), > Some("device-info") => cli::handle_command::(args), > Some("system-info") => cli::handle_command::(args), > - Some(s) => bail!("unknown subcommand '{s}'"), > - None => bail!("subcommand required"), > + Some(s) => Err(cli::Error::UnknownSubcommand(s.to_owned())), > + None => Err(cli::Error::SubcommandRequired), > }, > }) > } > diff --git a/proxmox-chroot/src/main.rs b/proxmox-chroot/src/main.rs > index 5f087bb..6544bf1 100644 > --- a/proxmox-chroot/src/main.rs > +++ b/proxmox-chroot/src/main.rs > @@ -125,8 +125,8 @@ GLOBAL OPTIONS: > on_command: |s, args| match s { > Some("prepare") => cli::handle_command::(args), > Some("cleanup") => cli::handle_command::(args), > - Some(s) => bail!("unknown subcommand '{s}'"), > - None => bail!("subcommand required"), > + Some(s) => Err(cli::Error::UnknownSubcommand(s.to_owned())), > + None => Err(cli::Error::SubcommandRequired), > }, > }) > } > diff --git a/proxmox-installer-common/src/cli.rs b/proxmox-installer-common/src/cli.rs > index e2b4d81..1c9ef29 100644 > --- a/proxmox-installer-common/src/cli.rs > +++ b/proxmox-installer-common/src/cli.rs > @@ -1,7 +1,7 @@ > //! Provides a simple command line parsing interface, with special support for > //! (one-level deep) subcommands. > > -use std::process; > +use std::{fmt, process::ExitCode}; > > use anyhow::Result; > > @@ -22,41 +22,98 @@ pub trait Subcommand { > fn run(&self) -> Result<()>; > } > > +/// Describes a CLI app. > +/// > +/// ### Example usage > +/// ``` > +/// fn main() -> process::ExitCode { > +/// cli::run(cli::AppInfo { > +/// global_help: "Some CLI app", > +/// on_command: |s, args| match s { > +/// Some("foo") => cli::handle_command::(args), > +/// Some(s) => Err(cli::Error::UnknownSubcommand(s.to_owned())), > +/// None => Err(cli::Error::SubcommandRequired), > +/// } > +/// }) > +/// } > +/// ``` > pub struct AppInfo<'a> { > + /// Global help menu to display if `-h`/`--help` was given without any subcommand or an invalid > + /// subcommand was specified. > pub global_help: &'a str, > - pub on_command: fn(Option<&str>, &mut Arguments) -> Result<()>, > + /// Callback to invoke with the subcommand name (if given) and the argument list. > + /// > + /// Receives the subcommand name (if one was given on the command line) and the rest of the > + /// argument list. > + pub on_command: fn(Option<&str>, &mut Arguments) -> Result<(), Error>, > } > > -pub fn run(info: AppInfo) -> process::ExitCode { > - if let Err(err) = parse_args(&info) { > - eprintln!("Error: {err:#}\n\n{}", info.global_help); > - process::ExitCode::FAILURE > - } else { > - process::ExitCode::SUCCESS > +#[derive(Debug)] > +pub enum Error { > + UnknownSubcommand(String), > + SubcommandRequired, > + Other(anyhow::Error), > +} > + > +impl std::error::Error for Error {} > + > +impl fmt::Display for Error { > + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { > + match self { > + Error::UnknownSubcommand(s) => write!(f, "unknown subcommand '{s}'"), > + Error::SubcommandRequired => write!(f, "subcommand required"), > + Error::Other(s) => write!(f, "{s}"), > + } > } > } > > -fn parse_args(info: &AppInfo) -> Result<()> { > +/// Retrieves the process command line, checks for a subcommand name and for the default global > +/// flags `-h`/`--help` and `-V`/`--version`. > +/// > +/// If no global flag was given, runs the command handler given in [`AppInfo::on_command`]. > +pub fn run(info: AppInfo) -> ExitCode { > let mut args = pico_args::Arguments::from_env(); > - let subcommand = args.subcommand()?; > + > + let subcommand = match args.subcommand() { > + Ok(s) => s, > + Err(err) => { > + eprintln!("Error: {err:#}\n\n{}", info.global_help); > + return ExitCode::FAILURE; > + } > + }; > > if subcommand.is_none() && args.contains(["-h", "--help"]) { > eprintln!("{}", info.global_help); > - Ok(()) > + ExitCode::SUCCESS > } else if args.contains(["-V", "--version"]) { > eprintln!("{} v{}", env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION")); > - Ok(()) > + ExitCode::SUCCESS > } else { > - (info.on_command)(subcommand.as_deref(), &mut args) > + match (info.on_command)(subcommand.as_deref(), &mut args) { > + Ok(()) => ExitCode::SUCCESS, > + Err(Error::Other(err)) => { > + eprintln!("Error: {err:#}"); > + ExitCode::FAILURE > + } > + // For non-command errors (i.e. invalid subcommand), also print the help text, in > + // addition to the error itself. > + Err(err) => { > + eprintln!("Error: {err:#}\n\n{}", info.global_help); > + ExitCode::FAILURE > + } > + } > } > } > > -pub fn handle_command(args: &mut pico_args::Arguments) -> Result<()> { > +/// Runs a specific subcommand. If the arguments contain -h/--help, the help text of the subcommand > +/// is printed and success is returned. > +pub fn handle_command(args: &mut pico_args::Arguments) -> Result<(), Error> { > if args.contains(["-h", "--help"]) { > T::print_usage(); > - } else if let Err(err) = T::parse(args).and_then(|cmd| cmd.run()) { > - eprintln!("Error: {err:#}"); > + return Ok(()); > } > > - Ok(()) > + T::parse(args) > + .and_then(|cmd| cmd.run()) > + .map_err(Error::Other) > }