[fm] add a SitrepBuilder, to help with building sitreps (#9566)

Depends on #9552.

This is [a surprise tool that will help us
later][1]!

[1]: https://www.youtube.com/watch?v=GTU84u_Logo

Author: hawkw

Cargo.lock

@@ -93,6 +93,7 @@ members = [
     "nexus/db-schema",
     "nexus/defaults",
     "nexus/external-api",
+    "nexus/fm",
     "nexus/internal-api",
     "nexus/inventory",
     "nexus/lockstep-api",
@@ -271,6 +272,7 @@ default-members = [
     "nexus/db-schema",
     "nexus/defaults",
     "nexus/external-api",
+    "nexus/fm",
     "nexus/internal-api",
     "nexus/inventory",
     "nexus/lockstep-api",
@@ -601,6 +603,7 @@ nexus-db-queries = { path = "nexus/db-queries" }
 nexus-db-schema = { path = "nexus/db-schema" }
 nexus-defaults = { path = "nexus/defaults" }
 nexus-external-api = { path = "nexus/external-api" }
+nexus-fm = { path = "nexus/fm" }
 nexus-inventory = { path = "nexus/inventory" }
 nexus-internal-api = { path = "nexus/internal-api" }
 nexus-lockstep-api = { path = "nexus/lockstep-api" }

Cargo.toml

@@ -178,6 +178,7 @@ hubtools.workspace = true
 hyper-rustls.workspace = true
 nexus-client.workspace = true
 nexus-db-queries = { workspace = true, features = ["testing"] }
+nexus-fm = { workspace = true, features = ["testing"] }
 nexus-lockstep-client.workspace = true
 nexus-test-utils.workspace = true
 nexus-test-utils-macros.workspace = true

nexus/Cargo.toml

@@ -0,0 +1,39 @@
+[package]
+name = "nexus-fm"
+version = "0.1.0"
+edition = "2021"
+
+[lints]
+workspace = true
+
+[features]
+testing = [
+    "omicron-test-utils",
+    "nexus-reconfigurator-planning",
+    "ereport-types",
+]
+
+[dependencies]
+anyhow.workspace = true
+chrono.workspace = true
+iddqd.workspace = true
+nexus-types.workspace = true
+omicron-uuid-kinds.workspace = true
+rand.workspace = true
+serde.workspace = true
+serde_json.workspace = true
+slog.workspace = true
+slog-error-chain.workspace = true
+typed-rng.workspace = true
+
+# deps for test utils
+omicron-test-utils = { workspace = true, optional = true }
+nexus-reconfigurator-planning = { workspace = true, optional = true }
+ereport-types = { workspace = true, optional = true }
+
+omicron-workspace-hack.workspace = true
+
+[dev-dependencies]
+omicron-test-utils.workspace = true
+nexus-reconfigurator-planning.workspace = true
+ereport-types.workspace = true

nexus/fm/Cargo.toml

@@ -0,0 +1,101 @@
+// 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/.
+
+//! Sitrep builder
+
+use nexus_types::fm;
+use nexus_types::inventory;
+use omicron_uuid_kinds::OmicronZoneUuid;
+use omicron_uuid_kinds::SitrepUuid;
+use slog::Logger;
+
+mod case;
+pub use case::{AllCases, CaseBuilder};
+pub(crate) mod rng;
+pub use rng::SitrepBuilderRng;
+
+#[derive(Debug)]
+pub struct SitrepBuilder<'a> {
+    pub log: Logger,
+    pub inventory: &'a inventory::Collection,
+    pub parent_sitrep: Option<&'a fm::Sitrep>,
+    pub sitrep_id: SitrepUuid,
+    pub cases: case::AllCases,
+    comment: String,
+}
+
+impl<'a> SitrepBuilder<'a> {
+    pub fn new(
+        log: &Logger,
+        inventory: &'a inventory::Collection,
+        parent_sitrep: Option<&'a fm::Sitrep>,
+    ) -> Self {
+        Self::new_with_rng(
+            log,
+            inventory,
+            parent_sitrep,
+            SitrepBuilderRng::from_entropy(),
+        )
+    }
+
+    pub fn new_with_rng(
+        log: &Logger,
+        inventory: &'a inventory::Collection,
+        parent_sitrep: Option<&'a fm::Sitrep>,
+        mut rng: SitrepBuilderRng,
+    ) -> Self {
+        // TODO(eliza): should the RNG also be seeded with the parent sitrep
+        // UUID and/or the Omicron zone UUID? Hmm.
+        let sitrep_id = rng.sitrep_id();
+        let log = log.new(slog::o!(
+            "sitrep_id" => format!("{sitrep_id:?}"),
+            "parent_sitrep_id" => format!("{:?}", parent_sitrep.as_ref().map(|s| s.id())),
+            "inv_collection_id" => format!("{:?}", inventory.id),
+        ));
+
+        let cases =
+            case::AllCases::new(log.clone(), sitrep_id, parent_sitrep, rng);
+
+        slog::info!(
+            &log,
+            "preparing sitrep {sitrep_id:?}";
+            "existing_open_cases" => cases.len(),
+        );
+
+        SitrepBuilder {
+            log,
+            sitrep_id,
+            inventory,
+            parent_sitrep,
+            comment: String::new(),
+            cases,
+        }
+    }
+
+    pub fn comment(&self) -> &str {
+        &self.comment
+    }
+
+    pub fn comment_mut(&mut self) -> &mut str {
+        &mut self.comment
+    }
+
+    pub fn build(
+        self,
+        creator_id: OmicronZoneUuid,
+        time_created: chrono::DateTime<chrono::Utc>,
+    ) -> fm::Sitrep {
+        fm::Sitrep {
+            metadata: fm::SitrepMetadata {
+                id: self.sitrep_id,
+                parent_sitrep_id: self.parent_sitrep.map(|s| s.metadata.id),
+                inv_collection_id: self.inventory.id,
+                creator_id,
+                comment: self.comment,
+                time_created,
+            },
+            cases: self.cases.cases.into_iter().map(fm::Case::from).collect(),
+        }
+    }
+}