[fm] add opt-in ANSI terminal colors to displayers (#10862)

Author: hawkw

Cargo.lock

@@ -1446,7 +1446,7 @@ impl DbArgs {
                         args.exec(&omdb, &opctx, &datastore).await
                     }
                     DbCommands::Sitrep(args) => {
-                        sitrep::cmd_db_sitrep(&opctx, &datastore, &fetch_opts, args).await
+                        sitrep::cmd_db_sitrep(&omdb, &opctx, &datastore, &fetch_opts, args).await
                     }
                     DbCommands::Sitreps(args) => {
                         sitrep::cmd_db_sitrep_history(&opctx, &datastore, &fetch_opts, args).await

dev-tools/omdb/src/bin/omdb/db.rs

@@ -4,10 +4,12 @@
 
 //! `omdb db sitrep` subcommands
 
+use crate::Omdb;
 use crate::db::DbFetchOptions;
 use crate::db::check_limit;
 use crate::helpers::const_max_len;
 use crate::helpers::datetime_opt_rfc3339_concise;
+use crate::helpers::should_colorize;
 use anyhow::Context;
 use async_bb8_diesel::AsyncRunQueryDsl;
 use chrono::{DateTime, Utc};
@@ -239,17 +241,23 @@ impl SitrepSelector {
 }
 
 pub(super) async fn cmd_db_sitrep(
+    omdb: &Omdb,
     opctx: &OpContext,
     datastore: &DataStore,
     fetch_opts: &DbFetchOptions,
     args: &SitrepArgs,
 ) -> anyhow::Result<()> {
+    let colored =
+        should_colorize(omdb.output.color, supports_color::Stream::Stdout);
     match args.command {
         Commands::History(ref args) => {
             cmd_db_sitrep_history(opctx, datastore, fetch_opts, args).await
         }
         Commands::Info { sitrep, opts: ref args } => {
-            cmd_db_sitrep_show(opctx, datastore, fetch_opts, args, sitrep).await
+            cmd_db_sitrep_show(
+                opctx, datastore, fetch_opts, args, sitrep, colored,
+            )
+            .await
         }
         Commands::Current(ref args) => {
             cmd_db_sitrep_show(
@@ -258,12 +266,15 @@ pub(super) async fn cmd_db_sitrep(
                 fetch_opts,
                 args,
                 SitrepSelector::Current,
+                colored,
             )
             .await
         }
         Commands::AnalysisReport(ref args) => {
-            cmd_db_sitrep_analysis_report(opctx, datastore, fetch_opts, args)
-                .await
+            cmd_db_sitrep_analysis_report(
+                opctx, datastore, fetch_opts, args, colored,
+            )
+            .await
         }
     }
 }
@@ -347,6 +358,7 @@ async fn cmd_db_sitrep_show(
     _fetch_opts: &DbFetchOptions,
     opts: &ShowOptions,
     sitrep_selector: SitrepSelector,
+    colored: bool,
 ) -> anyhow::Result<()> {
     let current_version = datastore
         .fm_current_sitrep_version(&opctx)
@@ -499,7 +511,7 @@ async fn cmd_db_sitrep_show(
     if !cases.is_empty() {
         println!("\n{:=<80}\n", "== CASES ");
         for case in cases {
-            println!("{}", case.display_indented(4, Some(id)));
+            println!("{}", case.display_indented(4, Some(id)).colored(colored));
         }
     }
 
@@ -511,6 +523,7 @@ async fn cmd_db_sitrep_analysis_report(
     datastore: &DataStore,
     _fetch_opts: &DbFetchOptions,
     args: &AnalysisReportArgs,
+    colored: bool,
 ) -> anyhow::Result<()> {
     let &AnalysisReportArgs { sitrep, ref opts } = args;
     let (_, id) = sitrep.resolve(&datastore, &opctx).await?;
@@ -519,14 +532,15 @@ async fn cmd_db_sitrep_analysis_report(
         load_analysis_report(datastore, id).await.with_context(|| {
             format!("failed to load analysis report for {err_ctx}",)
         })?;
-    print_analysis_report(&report, opts.json)?;
+    print_analysis_report(&report, opts.json, colored)?;
 
     Ok(())
 }
 
 fn print_analysis_report(
     report: &model::fm::SitrepAnalysisReport,
     json: bool,
+    colored: bool,
 ) -> anyhow::Result<()> {
     use nexus_types::fm::analysis_reports::{AnalysisReport, InputReport};
 
@@ -566,27 +580,33 @@ fn print_analysis_report(
 
     println!("\n{:=<80}", "== ANALYSIS INPUT REPORT ");
     match serde_json::from_value::<InputReport>(input_report.clone()) {
-        Ok(report) => println!("{}", report.display_multiline(0)),
+        Ok(report) => {
+            println!("{}", report.display_multiline(0).colored(colored))
+        }
         Err(e) => {
             eprintln!(
                 "WARNING: failed to parse input report; falling back to \
                 less structured output: {e}"
             );
-            let displayer = nexus_types::fm::display::Json::new(&input_report);
+            let displayer = nexus_types::fm::display::Json::new(&input_report)
+                .colored(colored);
             println!("{displayer}");
         }
     }
 
     println!("\n{:=<80}", "== ANALYSIS REPORT ");
     match serde_json::from_value::<AnalysisReport>(analysis_report.clone()) {
-        Ok(report) => println!("{}", report.display_multiline(0)),
+        Ok(report) => {
+            println!("{}", report.display_multiline(0).colored(colored))
+        }
         Err(e) => {
             eprintln!(
                 "WARNING: failed to parse analysis report; falling back to \
                 less structured output: {e}"
             );
             let displayer =
-                nexus_types::fm::display::Json::new(&analysis_report);
+                nexus_types::fm::display::Json::new(&analysis_report)
+                    .colored(colored);
             println!("{displayer}");
         }
     }

dev-tools/omdb/src/bin/omdb/db/sitrep.rs

@@ -722,7 +722,14 @@ impl NexusArgs {
             }) => cmd_nexus_background_tasks_list(&client).await,
             NexusCommands::BackgroundTasks(BackgroundTasksArgs {
                 command: BackgroundTasksCommands::Show(args),
-            }) => cmd_nexus_background_tasks_show(&client, args).await,
+            }) => {
+                cmd_nexus_background_tasks_show(
+                    &client,
+                    args,
+                    omdb.output.color,
+                )
+                .await
+            }
             NexusCommands::BackgroundTasks(BackgroundTasksArgs {
                 command: BackgroundTasksCommands::PrintReport(args),
             }) => {
@@ -990,6 +997,7 @@ async fn cmd_nexus_background_tasks_list(
 async fn cmd_nexus_background_tasks_show(
     client: &nexus_lockstep_client::Client,
     args: &BackgroundTasksShowArgs,
+    color: ColorChoice,
 ) -> Result<(), anyhow::Error> {
     let response =
         client.bgtask_list().await.context("listing background tasks")?;
@@ -1039,6 +1047,7 @@ async fn cmd_nexus_background_tasks_show(
 
     let opts = BackgroundTasksPrintOpts {
         show_executing_info: !args.no_executing_info,
+        colored: should_colorize(color, supports_color::Stream::Stdout),
     };
 
     // Some tasks should be grouped and printed together in a certain order,
@@ -1137,6 +1146,8 @@ async fn cmd_nexus_background_tasks_activate(
 #[derive(Clone, Debug)]
 struct BackgroundTasksPrintOpts {
     show_executing_info: bool,
+    /// Whether to style output with ANSI terminal colors.
+    colored: bool,
 }
 
 fn print_task(bgtask: &BackgroundTask, opts: &BackgroundTasksPrintOpts) {
@@ -1185,7 +1196,7 @@ fn print_task(bgtask: &BackgroundTask, opts: &BackgroundTasksPrintOpts) {
     // unstable -- it gets exposed by background tasks as unstructured
     // (schemaless) data.  We make a best effort to interpret it.
     if let LastResult::Completed(completed) = &bgtask.last {
-        print_task_details(&bgtask, &completed.details);
+        print_task_details(&bgtask, &completed.details, opts.colored);
     }
 }
 
@@ -1229,7 +1240,11 @@ fn print_start_end_time(
 /// undocumented and unstable (subject to change).  That does make this code
 /// both ugly and brittle.  It's not a fatal error to fail to parse these, but
 /// we do warn the user if that happens.
-fn print_task_details(bgtask: &BackgroundTask, details: &serde_json::Value) {
+fn print_task_details(
+    bgtask: &BackgroundTask,
+    details: &serde_json::Value,
+    colored: bool,
+) {
     // All tasks might produce an "error" property.  If we find one, print that
     // out and stop.
     #[derive(Deserialize)]
@@ -1362,7 +1377,7 @@ fn print_task_details(bgtask: &BackgroundTask, details: &serde_json::Value) {
             print_task_webhook_deliverator(details);
         }
         "fm_analysis" => {
-            print_task_fm_analysis(details);
+            print_task_fm_analysis(details, colored);
         }
         "fm_sitrep_loader" => {
             print_task_fm_sitrep_loader(details);
@@ -3490,7 +3505,7 @@ mod ereporter_status_fields {
     pub const NUM_WIDTH: usize = 4;
 }
 
-fn print_task_fm_analysis(details: &serde_json::Value) {
+fn print_task_fm_analysis(details: &serde_json::Value, colored: bool) {
     use nexus_types::internal_api::background::fm_analysis::{
         AnalysisOutcome, AnalysisStatus, Outcome, PreparationStatus,
     };
@@ -3629,7 +3644,7 @@ fn print_task_fm_analysis(details: &serde_json::Value) {
 
     let PreparationStatus { warnings, report: prep_report } = prep_status;
     println!("    preparation report:");
-    print!("{}", prep_report.display_multiline(6));
+    print!("{}", prep_report.display_multiline(6).colored(colored));
     if !warnings.is_empty() {
         println!("{ERRICON}   non-fatal errors preparing analysis inputs:");
         for error in warnings {
@@ -3639,7 +3654,7 @@ fn print_task_fm_analysis(details: &serde_json::Value) {
 
     println!();
     println!("    analysis report:");
-    print!("{}", analysis_report.display_multiline(6));
+    print!("{}", analysis_report.display_multiline(6).colored(colored));
     print_start_end_time(start_time, end_time, 4);
 }
 

dev-tools/omdb/src/bin/omdb/nexus.rs

@@ -35,6 +35,7 @@ itertools.workspace = true
 newtype_derive.workspace = true
 omicron-uuid-kinds.workspace = true
 openssl.workspace = true
+owo-colors.workspace = true
 oximeter-db.workspace = true
 oxnet.workspace = true
 oxql-types.workspace = true

nexus/types/Cargo.toml

@@ -0,0 +1,14 @@
+// an example analysis report
+sitrep ID: ea7affb0-36eb-4a9a-b9bd-22e00f1bcc04
+analysis log:
+  * began analysis
+cases (1 with activity):
+  * case b0d36461-e3e7-4a53-9162-82414fb30088
+    // PSU 0 faulted
+    diagnosis engine: power_shelf
+    opened in sitrep: ea7affb0-36eb-4a9a-b9bd-22e00f1bcc04 <-- this sitrep
+    activity in this analysis:
+      * opened case
+      * /!\ WARNING: something suspicious:
+        // hmmm...
+        * key: value