feat(status): display usroverlay state in status

Closes #474

Displays the status of the usroverlay within bootc status.

Although not ideal, handles the displaying of the host's
filesystem within the image/ostree functions since otherwise
it may require the introduction of another "host" block within
the status output (i.e. having a "host", "staged", "booted"
and "rollback").

Signed-off-by: Robert Sturla <[email protected]>

Author: p5

lib/src/spec.rs

@@ -2,8 +2,8 @@
 
 use std::fmt::Display;
 
-use ostree_ext::container::OstreeImageReference;
 use ostree_ext::oci_spec::image::Digest;
+use ostree_ext::{container::OstreeImageReference, ostree::DeploymentUnlockedState};
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
@@ -53,6 +53,41 @@ pub enum Store {
     OstreeContainer,
 }
 
+#[derive(
+    clap::ValueEnum, Serialize, Deserialize, Copy, Clone, Debug, PartialEq, Eq, JsonSchema,
+)]
+#[serde(rename_all = "camelCase")]
+/// The filesystem overlay type
+pub enum FilesystemOverlay {
+    /// Readonly overlay mode
+    Readonly,
+    /// Read-write overlay mode
+    ReadWrite,
+}
+
+impl FilesystemOverlay {
+    /// Convert from the ostree deployment state
+    pub fn from_ostree_deployment_state(state: &DeploymentUnlockedState) -> Option<Self> {
+        match state {
+            DeploymentUnlockedState::None => Some(Self::Readonly),
+            DeploymentUnlockedState::Development
+            | DeploymentUnlockedState::Transient
+            | DeploymentUnlockedState::Hotfix => Some(Self::ReadWrite),
+            // Default to readonly when unknown since it is the default
+            // for bootc deployments.
+            _ => Some(Self::Readonly),
+        }
+    }
+
+    /// Convert the FilesystemOverlay value to a human-readable string
+    pub fn to_human_string(&self) -> String {
+        match self {
+            Self::Readonly => "read-only".to_string(),
+            Self::ReadWrite => "read-write".to_string(),
+        }
+    }
+}
+
 #[derive(Serialize, Deserialize, Default, Debug, Clone, PartialEq, Eq, JsonSchema)]
 #[serde(rename_all = "camelCase")]
 /// The host specification
@@ -62,6 +97,9 @@ pub struct HostSpec {
     /// If set, and there is a rollback deployment, it will be set for the next boot.
     #[serde(default)]
     pub boot_order: BootOrder,
+    /// Matches the `ostree admin unlock` state
+    #[serde(default)]
+    pub usr_overlay: Option<FilesystemOverlay>,
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
@@ -157,6 +195,9 @@ pub struct HostStatus {
     /// Set to true if the rollback entry is queued for the next boot.
     #[serde(default)]
     pub rollback_queued: bool,
+    /// Matches the `ostree admin unlock` state
+    #[serde(default)]
+    pub usr_overlay: Option<FilesystemOverlay>,
 
     /// The detected type of system
     #[serde(rename = "type")]

lib/src/status.rs

@@ -15,6 +15,7 @@ use ostree_ext::oci_spec;
 use ostree_ext::ostree;
 
 use crate::cli::OutputFormat;
+use crate::spec::FilesystemOverlay;
 use crate::spec::{BootEntry, BootOrder, Host, HostSpec, HostStatus, HostType};
 use crate::spec::{ImageReference, ImageSignature};
 use crate::store::{CachedImageStatus, ContainerImageStore, Storage};
@@ -225,6 +226,12 @@ pub(crate) fn get_status(
     } else {
         BootOrder::Default
     };
+    let usr_overlay = FilesystemOverlay::from_ostree_deployment_state(
+        &booted_deployment
+            .as_ref()
+            .expect("Expected a booted deployment")
+            .unlocked(),
+    );
     tracing::debug!("Rollback queued={rollback_queued:?}");
     let other = {
         related_deployments.extend(other_deployments);
@@ -260,6 +267,7 @@ pub(crate) fn get_status(
         .map(|img| HostSpec {
             image: Some(img.image.clone()),
             boot_order,
+            usr_overlay,
         })
         .unwrap_or_default();
 
@@ -280,6 +288,7 @@ pub(crate) fn get_status(
         booted,
         rollback,
         rollback_queued,
+        usr_overlay,
         ty,
     };
     Ok((deployments, host))
@@ -331,7 +340,7 @@ pub(crate) async fn status(opts: super::cli::StatusOpts) -> Result<()> {
     Ok(())
 }
 
-#[derive(Debug)]
+#[derive(Debug, PartialEq)]
 pub enum Slot {
     Staged,
     Booted,
@@ -363,6 +372,7 @@ fn human_render_imagestatus(
     mut out: impl Write,
     slot: Slot,
     image: &crate::spec::ImageStatus,
+    host: &crate::spec::HostStatus,
 ) -> Result<()> {
     let transport = &image.image.transport;
     let imagename = &image.image.image;
@@ -407,10 +417,24 @@ fn human_render_imagestatus(
         writeln!(out, "{timestamp}")?;
     }
 
+    if let Some(usr_overlay) = &host.usr_overlay {
+        // Only show the usr filesystem overlay state if we are booted and not the default
+        // read-only mode.
+        if slot == Slot::Booted && *usr_overlay != FilesystemOverlay::Readonly {
+            write_row_name(&mut out, "Usr overlay", prefix_len)?;
+            writeln!(out, "{}", usr_overlay.to_human_string())?;
+        }
+    }
+
     Ok(())
 }
 
-fn human_render_ostree(mut out: impl Write, slot: Slot, ostree_commit: &str) -> Result<()> {
+fn human_render_ostree(
+    mut out: impl Write,
+    slot: Slot,
+    ostree_commit: &str,
+    host: &crate::spec::HostStatus,
+) -> Result<()> {
     // TODO consider rendering more ostree stuff here like rpm-ostree status does
     let prefix = match slot {
         Slot::Staged => "  Staged ostree".into(),
@@ -421,6 +445,16 @@ fn human_render_ostree(mut out: impl Write, slot: Slot, ostree_commit: &str) ->
     writeln!(out, "{prefix}")?;
     write_row_name(&mut out, "Commit", prefix_len)?;
     writeln!(out, "{ostree_commit}")?;
+
+    if let Some(usr_overlay) = &host.usr_overlay {
+        // Only show the usr filesystem overlay state if we are booted and not the default
+        // read-only mode.
+        if slot == Slot::Booted && *usr_overlay != FilesystemOverlay::Readonly {
+            write_row_name(&mut out, "Usr overlay", prefix_len)?;
+            writeln!(out, "{}", usr_overlay.to_human_string())?;
+        }
+    }
+
     Ok(())
 }
 
@@ -438,9 +472,9 @@ fn human_readable_output_booted(mut out: impl Write, host: &Host) -> Result<()>
                 writeln!(out)?;
             }
             if let Some(image) = &host_status.image {
-                human_render_imagestatus(&mut out, slot_name, image)?;
+                human_render_imagestatus(&mut out, slot_name, image, &host.status)?;
             } else if let Some(ostree) = host_status.ostree.as_ref() {
-                human_render_ostree(&mut out, slot_name, &ostree.checksum)?;
+                human_render_ostree(&mut out, slot_name, &ostree.checksum, &host.status)?;
             } else {
                 writeln!(out, "Current {slot_name} state is unknown")?;
             }
@@ -480,7 +514,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 +532,7 @@ mod tests {
         let expected = indoc::indoc! { r"
             Staged ostree
                    Commit: 1c24260fdd1be20f72a4a97a75c582834ee3431fbb0fa8e4f482bb219d633a45
-          
+
           ● Booted ostree
                      Commit: f9fa3a553ceaaaf30cf85bfe7eed46a822f7b8fd7e14c1e3389cbc3f6d27f791
         "};
@@ -514,7 +548,7 @@ mod tests {
             Staged image: quay.io/centos-bootc/centos-bootc:stream9
                   Digest: sha256:47e5ed613a970b6574bfa954ab25bb6e85656552899aa518b5961d9645102b38 (s390x)
                  Version: stream9.20240807.0
-          
+
           ● Booted ostree
                      Commit: f9fa3a553ceaaaf30cf85bfe7eed46a822f7b8fd7e14c1e3389cbc3f6d27f791
         "};