reconfigurator-cli should support setting target release (#8283)

Author: davepacheco

Cargo.lock

@@ -40,7 +40,9 @@ slog-term.workspace = true
 slog.workspace = true
 swrite.workspace = true
 tabled.workspace = true
+tokio.workspace = true
 tufaceous-artifact.workspace = true
+update-common.workspace = true
 uuid.workspace = true
 omicron-workspace-hack.workspace = true
 
@@ -50,11 +52,13 @@ omicron-workspace-hack.workspace = true
 # nexus/reconfigurator/cli-integration-tests.
 camino-tempfile.workspace = true
 datatest-stable.workspace = true
+dropshot.workspace = true
 expectorate.workspace = true
 omicron-test-utils.workspace = true
 serde.workspace = true
 subprocess.workspace = true
 tokio.workspace = true
+tufaceous.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.

dev-tools/reconfigurator-cli/Cargo.toml

@@ -60,6 +60,7 @@ use tabled::Tabled;
 use tufaceous_artifact::ArtifactHash;
 use tufaceous_artifact::ArtifactVersion;
 use tufaceous_artifact::ArtifactVersionError;
+use update_common::artifacts::{ArtifactsWithPlan, ControlPlaneZonesMode};
 
 mod log_capture;
 
@@ -727,6 +728,11 @@ enum SetArgs {
     NumNexus { num_nexus: u16 },
     /// system's external DNS zone name (suffix)
     ExternalDnsZoneName { zone_name: String },
+    /// system target release
+    TargetRelease {
+        /// TUF repo containing release artifacts
+        filename: Utf8PathBuf,
+    },
 }
 
 #[derive(Debug, Args)]
@@ -838,6 +844,7 @@ fn cmd_sled_list(
     #[tabled(rename_all = "SCREAMING_SNAKE_CASE")]
     struct Sled {
         id: SledUuid,
+        serial: String,
         nzpools: usize,
         subnet: String,
     }
@@ -849,11 +856,12 @@ fn cmd_sled_list(
         .to_planning_input_builder()
         .context("failed to generate planning input")?
         .build();
-    let rows = planning_input.all_sled_resources(SledFilter::Commissioned).map(
-        |(sled_id, sled_resources)| Sled {
+    let rows = planning_input.all_sleds(SledFilter::Commissioned).map(
+        |(sled_id, sled_details)| Sled {
             id: sled_id,
-            subnet: sled_resources.subnet.net().to_string(),
-            nzpools: sled_resources.zpools.len(),
+            serial: sled_details.baseboard_id.serial_number.clone(),
+            subnet: sled_details.resources.subnet.net().to_string(),
+            nzpools: sled_details.resources.zpools.len(),
         },
     );
     let table = tabled::Table::new(rows)
@@ -1618,20 +1626,7 @@ fn cmd_wipe(
 fn cmd_show(sim: &mut ReconfiguratorSim) -> anyhow::Result<Option<String>> {
     let mut s = String::new();
     let state = sim.current_state();
-    do_print_properties(&mut s, state);
-    swriteln!(
-        s,
-        "target number of Nexus instances: {}",
-        state
-            .config()
-            .num_nexus()
-            .map_or_else(|| "default".to_owned(), |n| n.to_string())
-    );
-    Ok(Some(s))
-}
 
-// TODO: consider moving this to a method on `SimState`.
-fn do_print_properties(s: &mut String, state: &SimState) {
     swriteln!(
         s,
         "configured external DNS zone name: {}",
@@ -1667,6 +1662,41 @@ fn do_print_properties(s: &mut String, state: &SimState) {
             .collect::<Vec<_>>()
             .join(", "),
     );
+    swriteln!(
+        s,
+        "target number of Nexus instances: {}",
+        state
+            .config()
+            .num_nexus()
+            .map_or_else(|| "default".to_owned(), |n| n.to_string())
+    );
+
+    let target_release = state.system().description().target_release();
+    match target_release {
+        Some(tuf_desc) => {
+            swriteln!(
+                s,
+                "target release: {} ({})",
+                tuf_desc.repo.system_version,
+                tuf_desc.repo.file_name
+            );
+            for artifact in &tuf_desc.artifacts {
+                swriteln!(
+                    s,
+                    "    artifact: {} {} ({} version {})",
+                    artifact.hash,
+                    artifact.id.kind,
+                    artifact.id.name,
+                    artifact.id.version
+                );
+            }
+        }
+        None => {
+            swriteln!(s, "target release: unset");
+        }
+    }
+
+    Ok(Some(s))
 }
 
 fn cmd_set(
@@ -1703,6 +1733,33 @@ fn cmd_set(
             state.config_mut().set_external_dns_zone_name(zone_name);
             rv
         }
+        SetArgs::TargetRelease { filename } => {
+            let file = std::fs::File::open(&filename)
+                .with_context(|| format!("open {:?}", filename))?;
+            let buf = std::io::BufReader::new(file);
+            let rt = tokio::runtime::Runtime::new()
+                .context("creating tokio runtime")?;
+            // We're not using the repo hash here.  Make one up.
+            let repo_hash = ArtifactHash([0; 32]);
+            let artifacts_with_plan = rt.block_on(async {
+                ArtifactsWithPlan::from_zip(
+                    buf,
+                    None,
+                    repo_hash,
+                    ControlPlaneZonesMode::Split,
+                    &sim.log,
+                )
+                .await
+                .with_context(|| format!("unpacking {:?}", filename))
+            })?;
+            let description = artifacts_with_plan.description().clone();
+            drop(artifacts_with_plan);
+            state
+                .system_mut()
+                .description_mut()
+                .set_target_release(Some(description));
+            format!("set target release based on {}", filename)
+        }
     };
 
     sim.commit_and_bump(format!("reconfigurator-cli set: {}", rv), state);

dev-tools/reconfigurator-cli/src/lib.rs

@@ -0,0 +1,73 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+//! Common code used by integration tests
+
+use camino::Utf8Path;
+use expectorate::assert_contents;
+use omicron_test_utils::dev::test_cmds::EXIT_SUCCESS;
+use omicron_test_utils::dev::test_cmds::Redactor;
+use omicron_test_utils::dev::test_cmds::assert_exit_code;
+use omicron_test_utils::dev::test_cmds::path_to_executable;
+use omicron_test_utils::dev::test_cmds::run_command;
+use std::path::PathBuf;
+use subprocess::{Exec, ExitStatus};
+
+fn path_to_cli() -> PathBuf {
+    path_to_executable(env!("CARGO_BIN_EXE_reconfigurator-cli"))
+}
+
+fn run_cli(
+    file: impl AsRef<Utf8Path>,
+    args: &[&str],
+    cwd: Option<&Utf8Path>,
+) -> (ExitStatus, String, String) {
+    let file = file.as_ref();
+
+    // Turn the path into an absolute one, because we're going to set a custom
+    // cwd for the subprocess.
+    let file = file.canonicalize_utf8().expect("file canonicalized");
+    eprintln!("using file: {file}");
+
+    // Create a temporary directory for the CLI to use -- that will let it
+    // read and write files in its own sandbox.
+    let tmpdir;
+    let cwd = match cwd {
+        None => {
+            tmpdir =
+                camino_tempfile::tempdir().expect("failed to create tmpdir");
+            tmpdir.path()
+        }
+        Some(c) => c,
+    };
+    let exec = Exec::cmd(path_to_cli()).arg(file).args(args).cwd(cwd);
+    run_command(exec)
+}
+
+pub fn script_with_cwd(
+    path: &Utf8Path,
+    cwd: Option<&Utf8Path>,
+) -> datatest_stable::Result<()> {
+    let (exit_status, stdout_text, stderr_text) =
+        run_cli(path, &["--seed", "reconfigurator-cli-test"], cwd);
+    assert_exit_code(exit_status, EXIT_SUCCESS, &stderr_text);
+
+    // Everything is deterministic, so we don't need to redact UUIDs.
+    // However, it's necessary to redact paths from generated log entries.
+    let stdout_text = Redactor::default()
+        .uuids(false)
+        .field("extracting uploaded archive to", ".*")
+        .field("created directory to store extracted artifacts, path:", ".*")
+        .do_redact(&stdout_text);
+
+    // This is the file name without the extension.
+    let test_name = path.file_stem().unwrap();
+    let stdout_file = format!("tests/output/{test_name}-stdout");
+    let stderr_file = format!("tests/output/{test_name}-stderr");
+
+    assert_contents(&stdout_file, &stdout_text);
+    assert_contents(&stderr_file, &stderr_text);
+
+    Ok(())
+}

dev-tools/reconfigurator-cli/tests/common/mod.rs

@@ -0,0 +1,68 @@
+# Load example system
+load-example --nsleds 3 --ndisks-per-sled 3
+
+# Print the default target release
+show
+
+# Load a target release from a fake file.
+# This file was generated by the test runner in a temporary directory that this
+# invocation of `reconfigurator-cli` is running out of as its working directory.
+set target-release repo-1.0.0.zip
+
+# Print the default target release again.
+show
+
+# Test that this state survives a save/load operation.
+save saved.out
+wipe all
+# This should NOT show the target release.
+show
+load saved.out
+# This should show the target release.
+show
+
+
+# Great.  Now, let's run through an upgrade!
+# First, print out what we've got.
+sled-list
+blueprint-list
+inventory-list
+
+# First step: upgrade one SP.
+blueprint-plan dbcbd3d6-41ff-48ae-ac0b-1becc9b2fd21 f45ba181-4b56-42cc-a762-874d90184a43
+blueprint-diff dbcbd3d6-41ff-48ae-ac0b-1becc9b2fd21 8da82a8e-bf97-4fbd-8ddd-9f6462732cf1
+
+# If we generate another plan, there should be no change.
+blueprint-plan 8da82a8e-bf97-4fbd-8ddd-9f6462732cf1 f45ba181-4b56-42cc-a762-874d90184a43
+blueprint-diff 8da82a8e-bf97-4fbd-8ddd-9f6462732cf1 58d5e830-0884-47d8-a7cd-b2b3751adeb4
+
+# Now, update the simulated SP to reflect that the update completed.
+# Collect inventory from it and use that collection for another planning step.
+# This should report that the update completed, remove that update, and add one
+# for another sled.
+sled-update-sp 98e6b7c2-2efa-41ca-b20a-0a4d61102fe6 --active 1.0.0
+inventory-generate
+blueprint-plan 58d5e830-0884-47d8-a7cd-b2b3751adeb4 eb0796d5-ab8a-4f7b-a884-b4aeacb8ab51
+blueprint-diff 58d5e830-0884-47d8-a7cd-b2b3751adeb4 af934083-59b5-4bf6-8966-6fb5292c29e1
+
+# This time, make it more interesting.  Change the inactive slot contents of
+# the simulated SP.  This should make the configured update impossible and cause
+# the planner to fix it.
+sled-update-sp 2b8f0cb3-0295-4b3c-bc58-4fe88b57112c --inactive 0.5.0
+inventory-generate
+blueprint-plan af934083-59b5-4bf6-8966-6fb5292c29e1 61f451b3-2121-4ed6-91c7-a550054f6c21
+blueprint-diff af934083-59b5-4bf6-8966-6fb5292c29e1 df06bb57-ad42-4431-9206-abff322896c7
+
+# Now simulate the update completing successfully.
+# Another planning step should try to update the last sled.
+sled-update-sp 2b8f0cb3-0295-4b3c-bc58-4fe88b57112c --active 1.0.0
+inventory-generate
+blueprint-plan df06bb57-ad42-4431-9206-abff322896c7 b1bda47d-2c19-4fba-96e3-d9df28db7436
+blueprint-diff df06bb57-ad42-4431-9206-abff322896c7 7f976e0d-d2a5-4eeb-9e82-c82bc2824aba
+
+# Finish updating the last sled and do one more planning run.
+# There should be nothing left to do.
+sled-update-sp d81c6a84-79b8-4958-ae41-ea46c9b19763 --active 1.0.0
+inventory-generate
+blueprint-plan 7f976e0d-d2a5-4eeb-9e82-c82bc2824aba a71f7a73-35a6-45e8-acbe-f1c5925eed69
+blueprint-diff 7f976e0d-d2a5-4eeb-9e82-c82bc2824aba 9034c710-3e57-45f3-99e5-4316145e87ac

dev-tools/reconfigurator-cli/tests/input/target-release.txt

@@ -16,14 +16,15 @@ configured silo names: example-silo
 internal DNS generations: 1
 external DNS generations: 1
 target number of Nexus instances: default
+target release: unset
 
 
 
 > sled-list
-ID                                   NZPOOLS SUBNET                  
-2eb69596-f081-4e2d-9425-9994926e0832 10      fd00:1122:3344:102::/64 
-32d8d836-4d8a-4e54-8fa9-f31d79c42646 10      fd00:1122:3344:103::/64 
-89d02b1b-478c-401a-8e28-7a26f74fa41b 10      fd00:1122:3344:101::/64 
+ID                                   SERIAL  NZPOOLS SUBNET                  
+2eb69596-f081-4e2d-9425-9994926e0832 serial1 10      fd00:1122:3344:102::/64 
+32d8d836-4d8a-4e54-8fa9-f31d79c42646 serial2 10      fd00:1122:3344:103::/64 
+89d02b1b-478c-401a-8e28-7a26f74fa41b serial0 10      fd00:1122:3344:101::/64 
 
 > inventory-list
 ID                                   NERRORS TIME_DONE                
@@ -383,8 +384,8 @@ loaded example system with:
 
 
 > sled-list
-ID                                   NZPOOLS SUBNET                  
-89d02b1b-478c-401a-8e28-7a26f74fa41b 4       fd00:1122:3344:101::/64 
+ID                                   SERIAL  NZPOOLS SUBNET                  
+89d02b1b-478c-401a-8e28-7a26f74fa41b serial0 4       fd00:1122:3344:101::/64 
 
 > inventory-list
 ID                                   NERRORS TIME_DONE                

dev-tools/reconfigurator-cli/tests/output/cmds-example-stdout

@@ -5,7 +5,7 @@ using provided RNG seed: reconfigurator-cli-test
 new RNG seed: test_basic
 
 > sled-list
-ID NZPOOLS SUBNET 
+ID SERIAL NZPOOLS SUBNET 
 
 > inventory-list
 ID NERRORS TIME_DONE 
@@ -21,8 +21,8 @@ error: attempted to access sled dde1c0e2-b10d-4621-b420-f179f7a7a00a not found i
 added sled dde1c0e2-b10d-4621-b420-f179f7a7a00a
 
 > sled-list
-ID                                   NZPOOLS SUBNET                  
-dde1c0e2-b10d-4621-b420-f179f7a7a00a 10      fd00:1122:3344:101::/64 
+ID                                   SERIAL  NZPOOLS SUBNET                  
+dde1c0e2-b10d-4621-b420-f179f7a7a00a serial0 10      fd00:1122:3344:101::/64 
 
 > sled-show dde1c0e2-b10d-4621-b420-f179f7a7a00a
 sled dde1c0e2-b10d-4621-b420-f179f7a7a00a
@@ -60,10 +60,10 @@ added sled 90c1102a-b9f5-4d88-92a2-60d54a2d98cc
 added sled 04ef3330-c682-4a08-8def-fcc4bef31bcd
 
 > sled-list
-ID                                   NZPOOLS SUBNET                  
-04ef3330-c682-4a08-8def-fcc4bef31bcd 10      fd00:1122:3344:103::/64 
-90c1102a-b9f5-4d88-92a2-60d54a2d98cc 10      fd00:1122:3344:102::/64 
-dde1c0e2-b10d-4621-b420-f179f7a7a00a 10      fd00:1122:3344:101::/64 
+ID                                   SERIAL  NZPOOLS SUBNET                  
+04ef3330-c682-4a08-8def-fcc4bef31bcd serial2 10      fd00:1122:3344:103::/64 
+90c1102a-b9f5-4d88-92a2-60d54a2d98cc serial1 10      fd00:1122:3344:102::/64 
+dde1c0e2-b10d-4621-b420-f179f7a7a00a serial0 10      fd00:1122:3344:101::/64 
 
 
 > sled-update-sp dde1c0e2-b10d-4621-b420-f179f7a7a00a