feat(status): display pinned deployments

Part of #904

Displays pinned deployments as part of "bootc status".
Includes unit tests to ensure correct parsing of the
pinned deployments, and that they are displayed in
human readable formats correctly.

Author: p5

lib/src/fixtures/spec-booted-pinned.yaml

@@ -0,0 +1,45 @@
+apiVersion: org.containers.bootc/v1alpha1
+kind: BootcHost
+metadata:
+  name: host
+spec:
+  image:
+    image: quay.io/centos-bootc/centos-bootc:stream9
+    transport: registry
+  bootOrder: default
+status:
+  staged: null
+  booted:
+    image:
+      image:
+        image: quay.io/centos-bootc/centos-bootc:stream9
+        transport: registry
+      architecture: arm64
+      version: stream9.20240807.0
+      timestamp: null
+      imageDigest: sha256:47e5ed613a970b6574bfa954ab25bb6e85656552899aa518b5961d9645102b38
+    cachedUpdate: null
+    incompatible: false
+    pinned: false
+    ostree:
+      checksum: 439f6bd2e2361bee292c1f31840d798c5ac5ba76483b8021dc9f7b0164ac0f48
+      deploySerial: 0
+  pinned:
+  - image:
+      image:
+        image: quay.io/centos-bootc/centos-bootc:stream9
+        transport: registry
+      version: stream9.20240807.0
+      timestamp: null
+      imageDigest: sha256:47e5ed613a970b6574bfa954ab25bb6e85656552899aa518b5961d9645102b37
+      architecture: arm64
+    cachedUpdate: null
+    incompatible: false
+    pinned: true
+    ostree:
+      checksum: 99b2cc3b6edce9ebaef6a6076effa5ee3e1dcff3523016ffc94a1b27c6c67e12
+      deploySerial: 0
+
+  rollback: null
+  rollbackQueued: false
+  type: bootcHost

lib/src/spec.rs

@@ -157,6 +157,8 @@ pub struct HostStatus {
     /// Set to true if the rollback entry is queued for the next boot.
     #[serde(default)]
     pub rollback_queued: bool,
+    /// All pinned images
+    pub pinned: Option<Vec<BootEntry>>,
 
     /// The detected type of system
     #[serde(rename = "type")]
@@ -196,6 +198,11 @@ impl Host {
                 self.status.staged = None;
                 self.status.booted = None;
             }
+            Slot::Pinned => {
+                self.status.staged = None;
+                self.status.booted = None;
+                self.status.rollback = None;
+            }
         }
     }
 }

lib/src/status.rs

@@ -253,6 +253,15 @@ pub(crate) fn get_status(
         .map(|d| boot_entry_from_deployment(sysroot, d))
         .transpose()
         .context("Rollback deployment")?;
+    let pinned = deployments
+        .other
+        .iter()
+        .filter_map(|d| {
+            d.is_pinned()
+                .then(|| boot_entry_from_deployment(sysroot, d).ok())
+        })
+        .collect::<Option<Vec<_>>>()
+        .filter(|v| !v.is_empty());
     let spec = staged
         .as_ref()
         .or(booted.as_ref())
@@ -280,6 +289,7 @@ pub(crate) fn get_status(
         booted,
         rollback,
         rollback_queued,
+        pinned,
         ty,
     };
     Ok((deployments, host))
@@ -336,6 +346,7 @@ pub enum Slot {
     Staged,
     Booted,
     Rollback,
+    Pinned,
 }
 
 impl std::fmt::Display for Slot {
@@ -344,6 +355,7 @@ impl std::fmt::Display for Slot {
             Slot::Staged => "staged",
             Slot::Booted => "booted",
             Slot::Rollback => "rollback",
+            Slot::Pinned => "pinned",
         };
         f.write_str(s)
     }
@@ -377,6 +389,7 @@ fn human_render_imagestatus(
         Slot::Staged => "  Staged image".into(),
         Slot::Booted => format!("{} Booted image", crate::glyph::Glyph::BlackCircle),
         Slot::Rollback => "  Rollback image".into(),
+        Slot::Pinned => "  Pinned image".into(),
     };
     let prefix_len = prefix.chars().count();
     writeln!(out, "{prefix}: {imageref}")?;
@@ -416,6 +429,7 @@ fn human_render_ostree(mut out: impl Write, slot: Slot, ostree_commit: &str) ->
         Slot::Staged => "  Staged ostree".into(),
         Slot::Booted => format!("{} Booted ostree", crate::glyph::Glyph::BlackCircle),
         Slot::Rollback => "  Rollback ostree".into(),
+        Slot::Pinned => "  Pinned ostree".into(),
     };
     let prefix_len = prefix.len();
     writeln!(out, "{prefix}")?;
@@ -446,6 +460,18 @@ fn human_readable_output_booted(mut out: impl Write, host: &Host) -> Result<()>
             }
         }
     }
+
+    if let Some(pinned) = &host.status.pinned {
+        writeln!(out)?;
+        for entry in pinned {
+            if let Some(image) = &entry.image {
+                human_render_imagestatus(&mut out, Slot::Pinned, image)?;
+            } else if let Some(ostree) = entry.ostree.as_ref() {
+                human_render_ostree(&mut out, Slot::Pinned, &ostree.checksum)?;
+            }
+        }
+    }
+
     Ok(())
 }
 
@@ -480,7 +506,7 @@ mod tests {
             Staged image: quay.io/example/someimage:latest
                   Digest: sha256:16dc2b6256b4ff0d2ec18d2dbfb06d117904010c8cf9732cdb022818cf7a7566 (arm64)
                  Version: nightly (2023-10-14T19:22:15Z)
-        
+
           ● Booted image: quay.io/example/someimage:latest
                   Digest: sha256:736b359467c9437c1ac915acaae952aad854e07eb4a16a94999a48af08c83c34 (arm64)
                  Version: nightly (2023-09-30T19:22:16Z)
@@ -498,7 +524,7 @@ mod tests {
         let expected = indoc::indoc! { r"
             Staged ostree
                    Commit: 1c24260fdd1be20f72a4a97a75c582834ee3431fbb0fa8e4f482bb219d633a45
-          
+
           ● Booted ostree
                      Commit: f9fa3a553ceaaaf30cf85bfe7eed46a822f7b8fd7e14c1e3389cbc3f6d27f791
         "};
@@ -514,7 +540,7 @@ mod tests {
             Staged image: quay.io/centos-bootc/centos-bootc:stream9
                   Digest: sha256:47e5ed613a970b6574bfa954ab25bb6e85656552899aa518b5961d9645102b38 (s390x)
                  Version: stream9.20240807.0
-          
+
           ● Booted ostree
                      Commit: f9fa3a553ceaaaf30cf85bfe7eed46a822f7b8fd7e14c1e3389cbc3f6d27f791
         "};
@@ -534,6 +560,23 @@ mod tests {
         similar_asserts::assert_eq!(w, expected);
     }
 
+    #[test]
+    fn test_human_readable_booted_pinned_spec() {
+        // booted image, no staged/rollback
+        let w = human_status_from_spec_fixture(include_str!("fixtures/spec-booted-pinned.yaml"))
+            .expect("No spec found");
+        let expected = indoc::indoc! { r"
+          ● Booted image: quay.io/centos-bootc/centos-bootc:stream9
+                  Digest: sha256:47e5ed613a970b6574bfa954ab25bb6e85656552899aa518b5961d9645102b38 (arm64)
+                 Version: stream9.20240807.0
+
+            Pinned image: quay.io/centos-bootc/centos-bootc:stream9
+                  Digest: sha256:47e5ed613a970b6574bfa954ab25bb6e85656552899aa518b5961d9645102b37 (arm64)
+                 Version: stream9.20240807.0
+        "};
+        similar_asserts::assert_eq!(w, expected);
+    }
+
     #[test]
     fn test_human_readable_staged_rollback_spec() {
         // staged/rollback image, no booted