add smoke test for omdb (#4101)

Cargo.toml

@@ -154,7 +154,7 @@ chacha20poly1305 = "0.10.1"
 ciborium = "0.2.1"
 cfg-if = "1.0"
 chrono = { version = "0.4", features = [ "serde" ] }
-clap = { version = "4.4", features = ["derive", "env"] }
+clap = { version = "4.4", features = ["derive", "env", "wrap_help"] }
 cookie = "0.16"
 criterion = { version = "0.5.1", features = [ "async_tokio" ] }
 crossbeam = "0.8"

omdb/Cargo.toml

@@ -31,6 +31,15 @@ textwrap.workspace = true
 tokio = { workspace = true, features = [ "full" ] }
 uuid.workspace = true
 
+[dev-dependencies]
+expectorate.workspace = true
+nexus-test-utils.workspace = true
+nexus-test-utils-macros.workspace = true
+omicron-nexus.workspace = true
+omicron-test-utils.workspace = true
+regex.workspace = true
+subprocess.workspace = true
+
 # Disable doc builds by default for our binaries to work around issue
 # rust-lang/cargo#8373.  These docs would not be very useful anyway.
 [[bin]]

omdb/src/bin/omdb/db.rs

@@ -210,7 +210,7 @@ async fn check_schema_version(datastore: &DataStore) {
         Ok(found_version) => {
             if found_version == expected_version {
                 eprintln!(
-                    "note: databaase schema version matches expected ({})",
+                    "note: database schema version matches expected ({})",
                     expected_version
                 );
                 return;

omdb/src/bin/omdb/nexus.rs

@@ -34,17 +34,17 @@ pub struct NexusArgs {
 #[derive(Debug, Subcommand)]
 enum NexusCommands {
     /// print information about background tasks
-    BackgroundTask(BackgroundTaskArgs),
+    BackgroundTasks(BackgroundTasksArgs),
 }
 
 #[derive(Debug, Args)]
-struct BackgroundTaskArgs {
+struct BackgroundTasksArgs {
     #[command(subcommand)]
-    command: BackgroundTaskCommands,
+    command: BackgroundTasksCommands,
 }
 
 #[derive(Debug, Subcommand)]
-enum BackgroundTaskCommands {
+enum BackgroundTasksCommands {
     /// Show documentation about background tasks
     Doc,
     /// Print a summary of the status of all background tasks
@@ -70,26 +70,27 @@ impl NexusArgs {
         let client = nexus_client::Client::new(nexus_url, log.clone());
 
         match &self.command {
-            NexusCommands::BackgroundTask(BackgroundTaskArgs {
-                command: BackgroundTaskCommands::Doc,
-            }) => cmd_nexus_background_task_doc(&client).await,
-            NexusCommands::BackgroundTask(BackgroundTaskArgs {
-                command: BackgroundTaskCommands::List,
-            }) => cmd_nexus_background_task_list(&client).await,
-            NexusCommands::BackgroundTask(BackgroundTaskArgs {
-                command: BackgroundTaskCommands::Show,
-            }) => cmd_nexus_background_task_show(&client).await,
+            NexusCommands::BackgroundTasks(BackgroundTasksArgs {
+                command: BackgroundTasksCommands::Doc,
+            }) => cmd_nexus_background_tasks_doc(&client).await,
+            NexusCommands::BackgroundTasks(BackgroundTasksArgs {
+                command: BackgroundTasksCommands::List,
+            }) => cmd_nexus_background_tasks_list(&client).await,
+            NexusCommands::BackgroundTasks(BackgroundTasksArgs {
+                command: BackgroundTasksCommands::Show,
+            }) => cmd_nexus_background_tasks_show(&client).await,
         }
     }
 }
 
-/// Runs `omdb nexus background-task doc`
-async fn cmd_nexus_background_task_doc(
+/// Runs `omdb nexus background-tasks doc`
+async fn cmd_nexus_background_tasks_doc(
     client: &nexus_client::Client,
 ) -> Result<(), anyhow::Error> {
     let response =
         client.bgtask_list().await.context("listing background tasks")?;
     let tasks = response.into_inner();
+    let tasks: BTreeMap<_, _> = tasks.into_iter().collect();
     for (_, bgtask) in &tasks {
         println!("task: {:?}", bgtask.name);
         println!(
@@ -108,8 +109,8 @@ async fn cmd_nexus_background_task_doc(
     Ok(())
 }
 
-/// Runs `omdb nexus background-task list`
-async fn cmd_nexus_background_task_list(
+/// Runs `omdb nexus background-tasks list`
+async fn cmd_nexus_background_tasks_list(
     client: &nexus_client::Client,
 ) -> Result<(), anyhow::Error> {
     let response =
@@ -124,8 +125,8 @@ async fn cmd_nexus_background_task_list(
     Ok(())
 }
 
-/// Runs `omdb nexus background-task show`
-async fn cmd_nexus_background_task_show(
+/// Runs `omdb nexus background-tasks show`
+async fn cmd_nexus_background_tasks_show(
     client: &nexus_client::Client,
 ) -> Result<(), anyhow::Error> {
     let response =

omdb/tests/config.test.toml

@@ -0,0 +1 @@
+../../nexus/tests/config.test.toml

omdb/tests/env.out

@@ -0,0 +1,74 @@
+EXECUTING COMMAND: omdb ["db", "--db-url", "postgresql://root@[::1]:REDACTED_PORT/omicron?sslmode=disable", "sleds"]
+termination: Exited(0)
+---------------------------------------------
+stdout:
+SERIAL       IP          ROLE ID                                   
+sim-b6d65341 [::1]:REDACTED_PORT -    REDACTED_UUID_REDACTED_UUID_REDACTED 
+---------------------------------------------
+stderr:
+note: database schema version matches expected (4.0.0)
+=============================================
+EXECUTING COMMAND: omdb ["db", "--db-url", "junk", "sleds"]
+termination: Exited(2)
+---------------------------------------------
+stdout:
+---------------------------------------------
+stderr:
+error: invalid value 'junk' for '--db-url <DB_URL>': invalid connection string: unexpected EOF
+
+For more information, try '--help'.
+=============================================
+EXECUTING COMMAND: omdb ["nexus", "--nexus-internal-url", "http://127.0.0.1:REDACTED_PORT", "background-tasks", "doc"]
+termination: Exited(0)
+---------------------------------------------
+stdout:
+task: "dns_config_external"
+    watches external DNS data stored in CockroachDB
+
+
+task: "dns_config_internal"
+    watches internal DNS data stored in CockroachDB
+
+
+task: "dns_propagation_external"
+    propagates latest external DNS configuration (from "dns_config_external"
+    background task) to the latest list of DNS servers (from
+    "dns_servers_external" background task)
+
+
+task: "dns_propagation_internal"
+    propagates latest internal DNS configuration (from "dns_config_internal"
+    background task) to the latest list of DNS servers (from
+    "dns_servers_internal" background task)
+
+
+task: "dns_servers_external"
+    watches list of external DNS servers stored in CockroachDB
+
+
+task: "dns_servers_internal"
+    watches list of internal DNS servers stored in CockroachDB
+
+
+task: "external_endpoints"
+    reads config for silos and TLS certificates to determine the right set of
+    HTTP endpoints, their HTTP server names, and which TLS certificates to use
+    on each one
+
+
+---------------------------------------------
+stderr:
+=============================================
+EXECUTING COMMAND: omdb ["nexus", "--nexus-internal-url", "junk", "background-tasks", "doc"]
+termination: Exited(1)
+---------------------------------------------
+stdout:
+---------------------------------------------
+stderr:
+Error: listing background tasks
+
+Caused by:
+    0: Communication Error: builder error: relative URL without a base
+    1: builder error: relative URL without a base
+    2: relative URL without a base
+=============================================