Merge pull request #1133 from daniel6yi8-gif/fix/1107-normalize-cli-exit-codes

Normalize error handling and exit codes across CLI commands

Author: OtowoSamuel

docs/cli-commands-reference.md

@@ -347,6 +347,9 @@ Available for all commands:
 
 ## Exit Codes
 
+Every subcommand returns its error through `Error::exit_code()` (`src/error.rs`),
+so the code below is consistent across all commands rather than per-command.
+
 | Code | Meaning |
 |------|---------|
 | 0 | Success |

src/error.rs

@@ -150,6 +150,24 @@ impl Error {
     pub fn status_message(&self) -> String {
         self.to_string()
     }
+
+    /// Map this error to the process exit code documented in
+    /// `docs/cli-commands-reference.md#exit-codes`.
+    ///
+    /// Rust's default `Termination` impl for `Result<(), Error>` always exits
+    /// with code 1 on `Err`, regardless of the error variant, so every CLI
+    /// command was silently ignoring the documented 2/3/4 exit codes unless it
+    /// special-cased `std::process::exit` itself. Routing every command's
+    /// error through this method instead keeps the exit code consistent with
+    /// the error category everywhere.
+    pub fn exit_code(&self) -> i32 {
+        match self {
+            Error::ValidationError(_) | Error::InvalidNodeType(_) | Error::MissingRequiredField { .. } => 2,
+            Error::KubeError(_) | Error::KubeconfigError(_) | Error::FinalizerError(_) | Error::NotFound { .. } => 3,
+            Error::ConfigError(_) | Error::MaintenanceError(_) | Error::CertificateError(_) => 4,
+            _ => 1,
+        }
+    }
 }
 
 // Implement From for kube::runtime::finalizer::Error to enable ? operator

src/main.rs

@@ -14,21 +14,21 @@ use crate::commands::runbook::run_generate_runbook;
 use crate::commands::simulator::run_simulator;
 use crate::commands::webhook::run_webhook;
 use clap::Parser;
-use std::process;
 
 use stellar_k8s::controller::archive_prune::prune_archive;
 use stellar_k8s::controller::diff::diff;
 use stellar_k8s::version_check;
 use stellar_k8s::{incident, Error};
 
 #[tokio::main]
-async fn main() -> Result<(), Error> {
-    // rustls 0.23 requires an explicit crypto provider when aws-lc-rs/ring are
-    // not auto-selected via default features (common with kube/reqwest stacks).
-    rustls::crypto::ring::default_provider()
-        .install_default()
-        .expect("failed to install rustls ring CryptoProvider");
+async fn main() {
+    if let Err(e) = run().await {
+        eprintln!("Error: {e}");
+        std::process::exit(e.exit_code());
+    }
+}
 
+async fn run() -> Result<(), Error> {
     let args = Args::parse();
 
     let offline = args.offline;
@@ -111,8 +111,7 @@ async fn main() -> Result<(), Error> {
         }
         Commands::Run(run_args) => {
             if let Err(e) = run_args.validate() {
-                eprintln!("error: {e}");
-                process::exit(2);
+                return Err(Error::validation_step("run args", e));
             }
             return run_operator(run_args).await;
         }