[1/n] [reconfigurator-cli] add log and switch commands (#9363)

Add commands to show a log of states, and to switch to a different
simulator state. This allows for rewinding and branching off states.

To render a graphical log, we use the sapling-renderdag library used by
Sapling and Jujutsu.

Author: sunshowers

Cargo.lock

@@ -799,7 +799,7 @@ zone = { version = "0.3.1", default-features = false, features = ["async"] }
 # the kinds). However, uses of omicron-uuid-kinds _within omicron_ will have
 # std and the other features enabled because they'll refer to it via
 # omicron-uuid-kinds.workspace = true.
-newtype-uuid = { version = "1.3.1", default-features = false }
+newtype-uuid = { version = "1.3.2", default-features = false }
 newtype-uuid-macros = "0.1.0"
 omicron-uuid-kinds = { path = "uuid-kinds", features = ["serde", "schemars08", "uuid-v4"] }
 

Cargo.toml

@@ -28,7 +28,10 @@ use nexus_reconfigurator_planning::planner::Planner;
 use nexus_reconfigurator_planning::system::{
     RotStateOverrides, SledBuilder, SledInventoryVisibility, SystemDescription,
 };
-use nexus_reconfigurator_simulation::{BlueprintId, CollectionId, SimState};
+use nexus_reconfigurator_simulation::{
+    BlueprintId, CollectionId, GraphRenderOptions, GraphStartingState,
+    ReconfiguratorSimId, SimState,
+};
 use nexus_reconfigurator_simulation::{SimStateBuilder, SimTufRepoSource};
 use nexus_reconfigurator_simulation::{SimTufRepoDescription, Simulator};
 use nexus_sled_agent_shared::inventory::ZoneKind;
@@ -345,6 +348,8 @@ fn process_command(
         Commands::LoadExample(args) => cmd_load_example(sim, args),
         Commands::FileContents(args) => cmd_file_contents(args),
         Commands::Save(args) => cmd_save(sim, args),
+        Commands::State(StateArgs::Log(args)) => cmd_state_log(sim, args),
+        Commands::State(StateArgs::Switch(args)) => cmd_state_switch(sim, args),
         Commands::Wipe(args) => cmd_wipe(sim, args),
     };
 
@@ -443,6 +448,9 @@ enum Commands {
     LoadExample(LoadExampleArgs),
     /// show information about what's in a saved file
     FileContents(FileContentsArgs),
+    /// state-related commands
+    #[command(flatten)]
+    State(StateArgs),
     /// reset the state of the REPL
     Wipe(WipeArgs),
 }
@@ -1015,6 +1023,45 @@ impl From<CollectionIdOpt> for CollectionId {
     }
 }
 
+#[derive(Clone, Debug)]
+enum ReconfiguratorSimIdOpt {
+    /// use a specific reconfigurator sim state by full UUID
+    Id(ReconfiguratorSimUuid),
+    /// use a reconfigurator sim state by UUID prefix
+    Prefix(String),
+}
+
+impl FromStr for ReconfiguratorSimIdOpt {
+    type Err = Infallible;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s.parse::<ReconfiguratorSimUuid>() {
+            Ok(id) => Ok(ReconfiguratorSimIdOpt::Id(id)),
+            Err(_) => Ok(ReconfiguratorSimIdOpt::Prefix(s.to_owned())),
+        }
+    }
+}
+
+impl fmt::Display for ReconfiguratorSimIdOpt {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            ReconfiguratorSimIdOpt::Id(id) => id.fmt(f),
+            ReconfiguratorSimIdOpt::Prefix(prefix) => prefix.fmt(f),
+        }
+    }
+}
+
+impl From<ReconfiguratorSimIdOpt> for ReconfiguratorSimId {
+    fn from(value: ReconfiguratorSimIdOpt) -> Self {
+        match value {
+            ReconfiguratorSimIdOpt::Id(id) => ReconfiguratorSimId::Id(id),
+            ReconfiguratorSimIdOpt::Prefix(prefix) => {
+                ReconfiguratorSimId::Prefix(prefix)
+            }
+        }
+    }
+}
+
 /// Clap field for an optional mupdate override UUID.
 ///
 /// This structure is similar to `Option`, but is specified separately to:
@@ -1455,6 +1502,40 @@ struct SaveArgs {
     filename: Utf8PathBuf,
 }
 
+#[derive(Debug, Subcommand)]
+enum StateArgs {
+    /// display a log of simulator states
+    ///
+    /// Shows the history of states from the current state back to the root.
+    Log(StateLogArgs),
+    /// switch to a different state
+    ///
+    /// Changes the current working state to the specified state. All subsequent
+    /// commands will operate from this state.
+    Switch(StateSwitchArgs),
+}
+
+#[derive(Debug, Args)]
+struct StateLogArgs {
+    /// Starting state ID (defaults to current state)
+    #[clap(long)]
+    from: Option<ReconfiguratorSimUuid>,
+
+    /// Limit number of states to display
+    #[clap(long, short = 'n', requires = "from")]
+    limit: Option<usize>,
+
+    /// Show changes in each state (verbose mode)
+    #[clap(long, short = 'v')]
+    verbose: bool,
+}
+
+#[derive(Debug, Args)]
+struct StateSwitchArgs {
+    /// The state ID or unique prefix to switch to
+    state_id: ReconfiguratorSimIdOpt,
+}
+
 #[derive(Debug, Args)]
 struct WipeArgs {
     /// What to wipe
@@ -2801,6 +2882,44 @@ fn cmd_save(
     )))
 }
 
+fn cmd_state_log(
+    sim: &mut ReconfiguratorSim,
+    args: StateLogArgs,
+) -> anyhow::Result<Option<String>> {
+    let StateLogArgs { from, limit, verbose } = args;
+
+    let starting_state = if let Some(start) = from {
+        GraphStartingState::State { start, limit }
+    } else {
+        GraphStartingState::None
+    };
+
+    let options = GraphRenderOptions::new(sim.current)
+        .with_verbose(verbose)
+        .with_starting_state(starting_state);
+
+    let output = sim.sim.render_graph(&options);
+
+    Ok(Some(output))
+}
+
+fn cmd_state_switch(
+    sim: &mut ReconfiguratorSim,
+    args: StateSwitchArgs,
+) -> anyhow::Result<Option<String>> {
+    let state = sim.sim.resolve_and_get_state(args.state_id.into())?;
+    let target_id = state.id();
+
+    sim.current = target_id;
+
+    Ok(Some(format!(
+        "switched to state {} (generation {}): {}",
+        target_id,
+        state.generation(),
+        state.description()
+    )))
+}
+
 fn cmd_wipe(
     sim: &mut ReconfiguratorSim,
     args: WipeArgs,
@@ -2812,7 +2931,7 @@ fn cmd_wipe(
             state.config_mut().wipe();
             state.rng_mut().reset_state();
             format!(
-                "- wiped system, reconfigurator-sim config, and RNG state\n
+                "- wiped system, reconfigurator-sim config, and RNG state\n\
                  - reset seed to {}",
                 state.rng_mut().seed()
             )

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

@@ -67,3 +67,34 @@ set planner-config --add-zones-with-mupdate-override true
 # Sled index out of bounds, will error out.
 wipe all
 load-example --seed test-basic --nsleds 3 --sled-policy 3:non-provisionable
+
+log
+log --verbose
+
+# Switch states with a full UUID.
+switch 4d8d6725-1ae3-4f88-b9cb-a34db82d7439
+log
+
+# Switch states with a unique prefix.
+switch 860f
+log
+
+# Switch states with an ambiguous prefix (should fail).
+switch 4
+
+# Switch states with a non-existent prefix (should fail).
+switch zzzz
+
+# Make a new branch.
+sled-add
+sled-add
+
+# Make an additional branch based on the previous branch.
+switch 4d8d6725
+sled-add
+
+# Go back to the previous branch.
+switch 5c53cf4b
+
+log
+log --verbose