add x-rust-type to ArtifactHash

oxidecomputer · Oct 11, 2024 · 4094dac · 4094dac
1 parent 4e8200a
commit 4094dac
Show file tree

Hide file tree

Showing 12 changed files with 60 additions and 6 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/clients/gateway-client/Cargo.toml b/clients/gateway-client/Cargo.toml
@@ -11,6 +11,7 @@ workspace = true
 base64.workspace = true
 chrono.workspace = true
 gateway-messages.workspace = true
+omicron-common.workspace = true
 progenitor.workspace = true
 rand.workspace = true
 reqwest = { workspace = true, features = ["rustls-tls", "stream"] }

diff --git a/clients/gateway-client/src/lib.rs b/clients/gateway-client/src/lib.rs
@@ -58,6 +58,9 @@ progenitor::generate_api!(
         slog::debug!(log, "client response"; "result" => ?result);
     }),
     derives = [schemars::JsonSchema],
+    crates = {
+        "omicron-common" = "0.1.0",
+    },
     patch = {
         HostPhase2RecoveryImageId = { derives = [PartialEq, Eq, PartialOrd, Ord] },
         ImageVersion = { derives = [PartialEq, Eq, PartialOrd, Ord] },

diff --git a/clients/installinator-client/src/lib.rs b/clients/installinator-client/src/lib.rs
@@ -18,6 +18,9 @@ progenitor::generate_api!(
         slog::debug!(log, "client response"; "result" => ?result);
     }),
     derives = [schemars::JsonSchema],
+    crates = {
+        "omicron-common" = "0.1.0",
+    },
     replace = {
         Duration = std::time::Duration,
         EventReportForInstallinatorSpec = installinator_common::EventReport,

diff --git a/clients/wicketd-client/src/lib.rs b/clients/wicketd-client/src/lib.rs
@@ -18,6 +18,9 @@ progenitor::generate_api!(
         slog::debug!(log, "client response"; "result" => ?result);
     }),
     derives = [schemars::JsonSchema],
+    crates = {
+        "omicron-common" = "0.1.0",
+    },
     patch = {
         CurrentRssUserConfig = { derives = [PartialEq] },
         CurrentRssUserConfigSensitive = { derives = [PartialEq, Eq, PartialOrd, Ord] },

diff --git a/common/src/update.rs b/common/src/update.rs
@@ -288,7 +288,7 @@ impl FromStr for ArtifactKind {
 #[cfg_attr(feature = "testing", derive(test_strategy::Arbitrary))]
 pub struct ArtifactHash(
     #[serde(with = "serde_human_bytes::hex_array")]
-    #[schemars(schema_with = "hex_schema::<32>")]
+    #[schemars(schema_with = "artifact_hash_schema")]
     pub [u8; 32],
 );
 
@@ -328,6 +328,19 @@ pub fn hex_schema<const N: usize>(gen: &mut SchemaGenerator) -> Schema {
     schema.into()
 }
 
+fn artifact_hash_schema(gen: &mut SchemaGenerator) -> Schema {
+    let mut schema: SchemaObject = hex_schema::<32>(gen).into();
+    schema.extensions.insert(
+        "x-rust-type".into(),
+        serde_json::json!({
+            "crate": env!("CARGO_PKG_NAME"),
+            "version": env!("CARGO_PKG_VERSION"),
+            "path": concat!(module_path!(), "::ArtifactHash"),
+        }),
+    );
+    schema.into()
+}
+
 #[cfg(test)]
 mod tests {
     use crate::api::internal::nexus::KnownArtifactKind;

diff --git a/gateway-cli/src/main.rs b/gateway-cli/src/main.rs
@@ -478,8 +478,8 @@ async fn main() -> Result<()> {
             } else {
                 // clap guarantees these are not `None` when `clear` is false.
                 let update_id = update_id.unwrap();
-                let host_phase_2 = host_phase_2.unwrap().to_string();
-                let control_plane = control_plane.unwrap().to_string();
+                let host_phase_2 = host_phase_2.unwrap();
+                let control_plane = control_plane.unwrap();
                 client
                     .sp_installinator_image_id_set(
                         sp.type_,

diff --git a/installinator/src/artifact.rs b/installinator/src/artifact.rs
@@ -93,7 +93,7 @@ impl ArtifactClient {
             .client
             .get_artifact_by_hash(
                 artifact_hash_id.kind.as_str(),
-                &artifact_hash_id.hash.to_string(),
+                &artifact_hash_id.hash,
             )
             .await?;
 

diff --git a/openapi/gateway.json b/openapi/gateway.json
@@ -1633,6 +1633,11 @@
         "type": "object",
         "properties": {
           "sha256_hash": {
+            "x-rust-type": {
+              "crate": "omicron-common",
+              "path": "omicron_common::update::ArtifactHash",
+              "version": "0.1.0"
+            },
             "type": "string",
             "format": "hex string (32 bytes)"
           }
@@ -1688,10 +1693,20 @@
         "type": "object",
         "properties": {
           "control_plane": {
+            "x-rust-type": {
+              "crate": "omicron-common",
+              "path": "omicron_common::update::ArtifactHash",
+              "version": "0.1.0"
+            },
             "type": "string",
             "format": "hex string (32 bytes)"
           },
           "host_phase_2": {
+            "x-rust-type": {
+              "crate": "omicron-common",
+              "path": "omicron_common::update::ArtifactHash",
+              "version": "0.1.0"
+            },
             "type": "string",
             "format": "hex string (32 bytes)"
           },

diff --git a/openapi/installinator.json b/openapi/installinator.json
@@ -21,6 +21,11 @@
             "description": "The hash of the artifact.",
             "required": true,
             "schema": {
+              "x-rust-type": {
+                "crate": "omicron-common",
+                "path": "omicron_common::update::ArtifactHash",
+                "version": "0.1.0"
+              },
               "type": "string",
               "format": "hex string (32 bytes)"
             }

diff --git a/openapi/wicketd.json b/openapi/wicketd.json
@@ -826,6 +826,11 @@
         "properties": {
           "hash": {
             "description": "The hash of the artifact.",
+            "x-rust-type": {
+              "crate": "omicron-common",
+              "path": "omicron_common::update::ArtifactHash",
+              "version": "0.1.0"
+            },
             "type": "string",
             "format": "hex string (32 bytes)"
           },
@@ -983,6 +988,11 @@
               },
               "sha256": {
                 "description": "A SHA-256 digest of the key.",
+                "x-rust-type": {
+                  "crate": "omicron-common",
+                  "path": "omicron_common::update::ArtifactHash",
+                  "version": "0.1.0"
+                },
                 "type": "string",
                 "format": "hex string (32 bytes)"
               }

diff --git a/wicketd/src/update_tracker.rs b/wicketd/src/update_tracker.rs
@@ -1362,8 +1362,8 @@ impl UpdateDriver {
                 "Setting installinator image ID",
                 move |_cx| async move {
                     let installinator_image_id = InstallinatorImageId {
-                        control_plane: plan.control_plane_hash.to_string(),
-                        host_phase_2: plan.host_phase_2_hash.to_string(),
+                        control_plane: plan.control_plane_hash,
+                        host_phase_2: plan.host_phase_2_hash,
                         update_id: update_cx.update_id,
                     };
                     update_cx