[10/n] [sled-agent] validate zone images as written in zone manifest (#8190)

Included in this PR:

* Add validation for zone images
* Write tests for success and failure cases
* Extend the `test_installinator_fetch` wicketd integration test to also
ensure installinator + sled-agent have a coherent view of the world

The last point forced me to expose a bunch of the status via a public
interface. We'll be able to reuse this information (though probably not
in this full form) and send it up as part of the inventory.

Author: sunshowers

Cargo.lock

@@ -2,6 +2,8 @@
 // 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/.
 
+use std::fmt;
+
 use iddqd::{IdOrdItem, IdOrdMap, id_upcast};
 use omicron_uuid_kinds::MupdateUuid;
 use serde::{Deserialize, Serialize};
@@ -10,9 +12,8 @@ use tufaceous_artifact::ArtifactHash;
 /// Describes the set of Omicron zones written out into an install dataset.
 #[derive(Clone, Debug, Eq, PartialEq, Deserialize, Serialize)]
 pub struct OmicronZoneManifest {
-    /// The UUID of the mupdate which created this manifest. Intended primarily
-    /// for checking equality.
-    pub mupdate_id: MupdateUuid,
+    /// The source of the manifest.
+    pub source: OmicronZoneManifestSource,
 
     /// Omicron zone file names and hashes.
     pub zones: IdOrdMap<OmicronZoneFileMetadata>,
@@ -23,6 +24,34 @@ impl OmicronZoneManifest {
     pub const FILE_NAME: &str = "zones.json";
 }
 
+/// The source of truth for an Omicron zone manifest.
+#[derive(Clone, Debug, Eq, PartialEq, Deserialize, Serialize)]
+pub enum OmicronZoneManifestSource {
+    /// The manifest was written out by installinator and the mupdate process.
+    Installinator {
+        /// The UUID of the mupdate.
+        mupdate_id: MupdateUuid,
+    },
+
+    /// The zone manifest was not found during the install process. A synthetic
+    /// zone manifest was generated by Sled Agent by looking at all the
+    /// `.tar.gz` files in the install dataset.
+    SledAgent,
+}
+
+impl fmt::Display for OmicronZoneManifestSource {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            OmicronZoneManifestSource::Installinator { mupdate_id } => {
+                write!(f, "installinator (mupdate ID: {})", mupdate_id)
+            }
+            OmicronZoneManifestSource::SledAgent => {
+                write!(f, "sled-agent")
+            }
+        }
+    }
+}
+
 /// Information about an Omicron zone file written out to the install dataset.
 ///
 /// Part of [`OmicronZoneManifest`].

common/src/update/zone_manifest.rs

@@ -25,6 +25,7 @@ use omicron_common::{
     disk::M2Slot,
     update::{
         MupdateOverrideInfo, OmicronZoneFileMetadata, OmicronZoneManifest,
+        OmicronZoneManifestSource,
     },
 };
 use omicron_uuid_kinds::{MupdateOverrideUuid, MupdateUuid};
@@ -63,7 +64,8 @@ struct ArtifactDestination {
 
 impl ArtifactDestination {
     fn from_directory(dir: &Utf8Path) -> Result<Self> {
-        let control_plane_dir = dir.join("zones");
+        // The install dataset goes into a directory called "install".
+        let control_plane_dir = dir.join("install");
         std::fs::create_dir_all(&control_plane_dir)
             .with_context(|| format!("error creating directories at {dir}"))?;
 
@@ -827,8 +829,12 @@ impl ControlPlaneZoneWriteContext<'_> {
     async fn omicron_zone_manifest_artifact(&self) -> BufList {
         let zones = compute_zone_hashes(&self.zones).await;
 
-        let omicron_zone_manifest =
-            OmicronZoneManifest { mupdate_id: self.mupdate_id, zones };
+        let omicron_zone_manifest = OmicronZoneManifest {
+            source: OmicronZoneManifestSource::Installinator {
+                mupdate_id: self.mupdate_id,
+            },
+            zones,
+        };
         let json_bytes = serde_json::to_vec(&omicron_zone_manifest)
             .expect("this serialization is infallible");
         BufList::from(json_bytes)

installinator/src/write.rs

@@ -15,16 +15,21 @@ illumos-utils.workspace = true
 nexus-sled-agent-shared.workspace = true
 omicron-common.workspace = true
 omicron-workspace-hack.workspace = true
+rayon.workspace = true
+serde.workspace = true
 serde_json.workspace = true
+sha2.workspace = true
 sled-agent-config-reconciler.workspace = true
 sled-storage.workspace = true
 slog.workspace = true
 slog-error-chain.workspace = true
 thiserror.workspace = true
+tufaceous-artifact.workspace = true
 
 [dev-dependencies]
 camino-tempfile-ext.workspace = true
 dropshot.workspace = true
+expectorate.workspace = true
 omicron-uuid-kinds.workspace = true
 pretty_assertions.workspace = true
 sled-agent-config-reconciler = { workspace = true, features = ["testing"] }

sled-agent/zone-images/Cargo.toml

@@ -0,0 +1,46 @@
+// 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/.
+
+use std::{io, sync::Arc};
+use thiserror::Error;
+
+/// An `io::Error` wrapper that implements `Clone` and `PartialEq`.
+#[derive(Clone, Debug, Error)]
+#[error(transparent)]
+pub struct ArcIoError(pub Arc<io::Error>);
+
+impl ArcIoError {
+    pub(crate) fn new(error: io::Error) -> Self {
+        Self(Arc::new(error))
+    }
+}
+
+/// Testing aid.
+impl PartialEq for ArcIoError {
+    fn eq(&self, other: &Self) -> bool {
+        // Simply comparing io::ErrorKind is good enough for tests.
+        self.0.kind() == other.0.kind()
+    }
+}
+
+/// A `serde_json::Error` that implements `Clone` and `PartialEq`.
+#[derive(Clone, Debug, Error)]
+#[error(transparent)]
+pub struct ArcSerdeJsonError(pub Arc<serde_json::Error>);
+
+impl ArcSerdeJsonError {
+    pub(crate) fn new(error: serde_json::Error) -> Self {
+        Self(Arc::new(error))
+    }
+}
+
+/// Testing aid.
+impl PartialEq for ArcSerdeJsonError {
+    fn eq(&self, other: &Self) -> bool {
+        // Simply comparing line/column/category is good enough for tests.
+        self.0.line() == other.0.line()
+            && self.0.column() == other.0.column()
+            && self.0.classify() == other.0.classify()
+    }
+}