[38/n] [sled-agent-zone-images] use real Omicron zone names (#8687)

We're going to switch this API to accept an Omicron `ZoneKind` soon.
Prepare for that change by using real zone names internally.

Author: sunshowers

.git-blame-ignore-revs

@@ -1,2 +1,3 @@
 # Whitespace-only changes
 d01ba56c2127789d85723793380a7378394583f1
+852c59e89088455d251376786776fd556784995c

Cargo.lock

@@ -11,6 +11,7 @@ workspace = true
 camino.workspace = true
 camino-tempfile-ext.workspace = true
 iddqd.workspace = true
+nexus-sled-agent-shared.workspace = true
 omicron-common.workspace = true
 omicron-uuid-kinds.workspace = true
 omicron-workspace-hack.workspace = true

sled-agent/zone-images-examples/Cargo.toml

@@ -15,6 +15,7 @@ use camino_tempfile_ext::{
     prelude::*,
 };
 use iddqd::{IdOrdItem, IdOrdMap, id_upcast};
+use nexus_sled_agent_shared::inventory::ZoneKind;
 use omicron_common::update::{
     MupdateOverrideInfo, OmicronZoneFileMetadata, OmicronZoneManifest,
     OmicronZoneManifestSource,
@@ -82,12 +83,13 @@ impl WriteInstallDatasetContext {
     /// errors.
     pub fn new_basic() -> Self {
         Self {
+            // The zones are picked arbitrarily for our unit tests.
             zones: [
-                ZoneContents::new("zone1.tar.gz", b"zone1"),
-                ZoneContents::new("zone2.tar.gz", b"zone2"),
-                ZoneContents::new("zone3.tar.gz", b"zone3"),
-                ZoneContents::new("zone4.tar.gz", b"zone4"),
-                ZoneContents::new("zone5.tar.gz", b"zone5"),
+                ZoneContents::new(ZoneKind::CockroachDb, b"fake cockroachdb"),
+                ZoneContents::new(ZoneKind::Clickhouse, b"fake clickhouse"),
+                ZoneContents::new(ZoneKind::Crucible, b"fake crucible"),
+                ZoneContents::new(ZoneKind::InternalDns, b"fake internal_dns"),
+                ZoneContents::new(ZoneKind::Nexus, b"fake nexus"),
             ]
             .into_iter()
             .collect(),
@@ -99,16 +101,17 @@ impl WriteInstallDatasetContext {
 
     /// Makes a number of error cases for testing.
     pub fn make_error_cases(&mut self) {
-        // zone1.tar.gz is valid.
-        // For zone2.tar.gz, change the size.
-        self.zones.get_mut("zone2.tar.gz").unwrap().json_size = 1024;
-        // For zone3.tar.gz, change the hash.
-        self.zones.get_mut("zone3.tar.gz").unwrap().json_hash =
+        // cockroachdb.tar.gz is valid.
+        // For clickhouse, change the size.
+        self.zones.get_mut(&ZoneKind::Clickhouse).unwrap().json_size = 1024;
+        // For crucible, change the hash.
+        self.zones.get_mut(&ZoneKind::Crucible).unwrap().json_hash =
             ArtifactHash([0; 32]);
-        // Don't write out zone4 but include it in the JSON.
-        self.zones.get_mut("zone4.tar.gz").unwrap().write_to_disk = false;
-        // Write out zone5 but don't include it in the JSON.
-        self.zones.get_mut("zone5.tar.gz").unwrap().include_in_json = false;
+        // Don't write out internal DNS but include it in the JSON.
+        self.zones.get_mut(&ZoneKind::InternalDns).unwrap().write_to_disk =
+            false;
+        // Write out nexus but don't include it in the JSON.
+        self.zones.get_mut(&ZoneKind::Nexus).unwrap().include_in_json = false;
     }
 
     /// Set to false to not write out the zone manifest to disk.
@@ -141,7 +144,10 @@ impl WriteInstallDatasetContext {
                 .iter()
                 .filter_map(|zone| {
                     zone.include_in_json.then(|| OmicronZoneFileMetadata {
-                        file_name: zone.file_name.clone(),
+                        file_name: zone
+                            .zone_kind
+                            .artifact_in_install_dataset()
+                            .to_owned(),
                         file_size: zone.json_size,
                         hash: zone.json_hash,
                     })
@@ -176,7 +182,8 @@ impl WriteInstallDatasetContext {
     pub fn write_to(&self, dir: &ChildPath) -> Result<(), FixtureError> {
         for zone in &self.zones {
             if zone.write_to_disk {
-                dir.child(&zone.file_name).write_binary(&zone.contents)?;
+                dir.child(zone.zone_kind.artifact_in_install_dataset())
+                    .write_binary(&zone.contents)?;
             }
         }
 
@@ -202,7 +209,7 @@ impl WriteInstallDatasetContext {
 
 #[derive(Clone, Debug)]
 pub struct ZoneContents {
-    file_name: String,
+    zone_kind: ZoneKind,
     contents: Vec<u8>,
     // json_size and json_hash are stored separately, so tests can tweak
     // them before writing out the override info.
@@ -213,11 +220,11 @@ pub struct ZoneContents {
 }
 
 impl ZoneContents {
-    fn new(file_name: &str, contents: &[u8]) -> Self {
+    fn new(zone_kind: ZoneKind, contents: &[u8]) -> Self {
         let size = contents.len() as u64;
         let hash = compute_hash(contents);
         Self {
-            file_name: file_name.to_string(),
+            zone_kind,
             contents: contents.to_vec(),
             json_size: size,
             json_hash: hash,
@@ -243,9 +250,12 @@ impl ZoneContents {
             }
         };
 
+        let file_name = self.zone_kind.artifact_in_install_dataset().to_owned();
+        let path = dir.join(&file_name);
+
         ZoneManifestArtifactResult {
-            file_name: self.file_name.clone(),
-            path: dir.join(&self.file_name),
+            file_name,
+            path,
             expected_size: self.json_size,
             expected_hash: self.json_hash,
             status,
@@ -254,10 +264,10 @@ impl ZoneContents {
 }
 
 impl IdOrdItem for ZoneContents {
-    type Key<'a> = &'a str;
+    type Key<'a> = ZoneKind;
 
     fn key(&self) -> Self::Key<'_> {
-        &self.file_name
+        self.zone_kind
     }
 
     id_upcast!();

sled-agent/zone-images-examples/src/lib.rs

@@ -228,6 +228,7 @@ mod tests {
 
     use camino_tempfile_ext::prelude::*;
     use dropshot::{ConfigLogging, ConfigLoggingLevel, test_util::LogContext};
+    use nexus_sled_agent_shared::inventory::ZoneKind;
     use sled_agent_zone_images_examples::{
         BOOT_PATHS, BOOT_UUID, WriteInstallDatasetContext,
     };
@@ -252,16 +253,16 @@ mod tests {
         // RAM disk image sources should work as expected.
         let ramdisk_source = resolver
             .file_source_for(
-                "zone1",
+                "switch",
                 &ZoneImageSource::Ramdisk,
                 internal_disks_rx.current(),
             )
             .unwrap();
-        assert_eq!(ramdisk_source, ramdisk_file_source("zone1"));
+        assert_eq!(ramdisk_source, ramdisk_file_source("switch"));
 
         let file_source = resolver
             .file_source_for(
-                "zone1",
+                ZoneKind::CockroachDb.zone_prefix(),
                 &ZoneImageSource::Omicron(
                     OmicronZoneImageSource::InstallDataset,
                 ),
@@ -274,7 +275,9 @@ mod tests {
         assert_eq!(
             file_source,
             ZoneImageFileSource {
-                file_name: install_dataset_file_name("zone1"),
+                file_name: ZoneKind::CockroachDb
+                    .artifact_in_install_dataset()
+                    .to_owned(),
                 search_paths: vec![Utf8PathBuf::from(RAMDISK_IMAGE_PATH)]
             }
         );
@@ -305,17 +308,17 @@ mod tests {
         // The resolver should not fail for ramdisk images.
         let file_source = resolver
             .file_source_for(
-                "fake-zone",
+                "switch",
                 &ZoneImageSource::Ramdisk,
                 internal_disks_rx.current(),
             )
             .unwrap();
-        assert_eq!(file_source, ramdisk_file_source("fake-zone"));
+        assert_eq!(file_source, ramdisk_file_source("switch"));
 
-        // zone1.tar.gz is valid.
+        // The cockroach zone is valid.
         let file_source = resolver
             .file_source_for(
-                "zone1",
+                ZoneKind::CockroachDb.zone_prefix(),
                 &ZoneImageSource::Omicron(
                     OmicronZoneImageSource::InstallDataset,
                 ),
@@ -325,20 +328,27 @@ mod tests {
         assert_eq!(
             file_source,
             ZoneImageFileSource {
-                file_name: "zone1.tar.gz".to_string(),
+                file_name: ZoneKind::CockroachDb
+                    .artifact_in_install_dataset()
+                    .to_string(),
                 search_paths: vec![
                     Utf8PathBuf::from(RAMDISK_IMAGE_PATH),
                     dir.path().join(&BOOT_PATHS.install_dataset)
                 ]
             },
         );
 
-        // zone2, zone3, zone4 and zone5 aren't valid, and none of them will
-        // return the install dataset path.
-        for zone_name in ["zone2", "zone3", "zone4", "zone5"] {
+        // Clickhouse, Crucible, InternalDns and Nexus aren't valid, and none of
+        // them will return the install dataset path.
+        for zone_kind in [
+            ZoneKind::Clickhouse,
+            ZoneKind::Crucible,
+            ZoneKind::InternalDns,
+            ZoneKind::Nexus,
+        ] {
             let file_source = resolver
                 .file_source_for(
-                    zone_name,
+                    zone_kind.zone_prefix(),
                     &ZoneImageSource::Omicron(
                         OmicronZoneImageSource::InstallDataset,
                     ),
@@ -348,7 +358,9 @@ mod tests {
             assert_eq!(
                 file_source,
                 ZoneImageFileSource {
-                    file_name: install_dataset_file_name(zone_name),
+                    file_name: zone_kind
+                        .artifact_in_install_dataset()
+                        .to_owned(),
                     search_paths: vec![Utf8PathBuf::from(RAMDISK_IMAGE_PATH)]
                 }
             );

sled-agent/zone-images/src/source_resolver.rs

@@ -1,6 +1,6 @@
 5 artifacts in manifest generated by installinator (mupdate ID: 00000000-0000-0000-0000-000000000000): 5 valid, 0 mismatched, 0 errors:
-  - zone1.tar.gz: valid (5 bytes, a34f924efa72cd0139ea5dc268f5d2736a9ebc858552b8f3c8cb2bed1992c31d)
-  - zone2.tar.gz: valid (5 bytes, 930c5a9adbeb8410817a1dff05d7cbffe4ada2ddbeaacecadd7cbcb35a233231)
-  - zone3.tar.gz: valid (5 bytes, 0f40fdb255100d0239a7e0944c8b9fdb9ba4795ad72988eaeeb00e9346236e08)
-  - zone4.tar.gz: valid (5 bytes, 64d6e4a84209b4b02f4da36d24eae12b0d1ec9e414d1c3bd12a261a245148324)
-  - zone5.tar.gz: valid (5 bytes, 112b21db93f16057fa957a58b711bff40ec395c9147d4084a88c9085c6507bf7)
+  - clickhouse.tar.gz: valid (15 bytes, 360cfb774fc2f2e492efcb21995620ea4dcb0abc4bd390bb391785c7f7429386)
+  - cockroachdb.tar.gz: valid (16 bytes, 7a91673e17475dfd18ca5267ecf4c771000eefa715e324db915448034e913bc1)
+  - crucible.tar.gz: valid (13 bytes, a18058cdfecf9eb3251f5b1c87986e565713080a7f7b00adf81fd0e201ba4d62)
+  - internal_dns.tar.gz: valid (17 bytes, f4ef1d710d82c1daa35e0c0a8100913139e2bfb349e435cf9ce5b72625d7bdef)
+  - nexus.tar.gz: valid (10 bytes, 96eddf0a4af3e1991879de233883cd9e2a15ed68cabd69977034d12842579b80)

sled-agent/zone-images/tests/output/zone_manifest_match_result.txt

@@ -1,5 +1,5 @@
 4 artifacts in manifest generated by installinator (mupdate ID: 00000000-0000-0000-0000-000000000000): 1 valid, 2 mismatched, 1 errors:
-  - zone1.tar.gz: valid (5 bytes, a34f924efa72cd0139ea5dc268f5d2736a9ebc858552b8f3c8cb2bed1992c31d)
-  - zone2.tar.gz: mismatch (expected 1024 bytes, 930c5a9adbeb8410817a1dff05d7cbffe4ada2ddbeaacecadd7cbcb35a233231; found 5 bytes, 930c5a9adbeb8410817a1dff05d7cbffe4ada2ddbeaacecadd7cbcb35a233231)
-  - zone3.tar.gz: mismatch (expected 5 bytes, 0000000000000000000000000000000000000000000000000000000000000000; found 5 bytes, 0f40fdb255100d0239a7e0944c8b9fdb9ba4795ad72988eaeeb00e9346236e08)
-  - zone4.tar.gz: error (file not found)
+  - clickhouse.tar.gz: mismatch (expected 1024 bytes, 360cfb774fc2f2e492efcb21995620ea4dcb0abc4bd390bb391785c7f7429386; found 15 bytes, 360cfb774fc2f2e492efcb21995620ea4dcb0abc4bd390bb391785c7f7429386)
+  - cockroachdb.tar.gz: valid (16 bytes, 7a91673e17475dfd18ca5267ecf4c771000eefa715e324db915448034e913bc1)
+  - crucible.tar.gz: mismatch (expected 13 bytes, 0000000000000000000000000000000000000000000000000000000000000000; found 13 bytes, a18058cdfecf9eb3251f5b1c87986e565713080a7f7b00adf81fd0e201ba4d62)
+  - internal_dns.tar.gz: error (file not found)