Merge pull request #585 from dustymabe/dusty-aleph-versiono-updates

coreos: update aleph version handling

src/bootupd.rs

@@ -388,8 +388,8 @@ pub(crate) fn print_status(status: &Status) -> Result<()> {
         }
     }
 
-    if let Some(coreos_aleph) = coreos::get_aleph_version()? {
-        println!("CoreOS aleph image ID: {}", coreos_aleph.aleph.imgid);
+    if let Some(coreos_aleph) = coreos::get_aleph_version(Path::new("/"))? {
+        println!("CoreOS aleph version: {}", coreos_aleph.aleph.version);
     }
 
     #[cfg(any(target_arch = "x86_64", target_arch = "aarch64"))]

src/coreos.rs

@@ -6,20 +6,18 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-use anyhow::Result;
+use anyhow::{Context, Result};
 use chrono::prelude::*;
-use openat_ext::OpenatDirExt;
 use serde::{Deserialize, Serialize};
+use std::fs::File;
+use std::path::Path;
 
 #[derive(Serialize, Deserialize, Clone, Debug, Hash, Ord, PartialOrd, PartialEq, Eq)]
 #[serde(rename_all = "kebab-case")]
 /// See https://github.com/coreos/fedora-coreos-tracker/blob/66d7d00bedd9d5eabc7287b9577f443dcefb7c04/internals/README-internals.md#aleph-version
 pub(crate) struct Aleph {
-    pub(crate) build: String,
-    #[serde(rename = "ref")]
-    pub(crate) ostree_ref: String,
-    pub(crate) ostree_commit: String,
-    pub(crate) imgid: String,
+    #[serde(alias = "build")]
+    pub(crate) version: String,
 }
 
 pub(crate) struct AlephWithTimestamp {
@@ -29,30 +27,75 @@ pub(crate) struct AlephWithTimestamp {
 }
 
 /// Path to the file, see above
-const ALEPH_PATH: &str = "/sysroot/.coreos-aleph-version.json";
+const ALEPH_PATH: &str = "sysroot/.coreos-aleph-version.json";
 
-pub(crate) fn get_aleph_version() -> Result<Option<AlephWithTimestamp>> {
-    let sysroot = openat::Dir::open("/")?;
-    if let Some(statusf) = sysroot.open_file_optional(ALEPH_PATH)? {
-        let meta = statusf.metadata()?;
-        let bufr = std::io::BufReader::new(statusf);
-        let aleph: Aleph = serde_json::from_reader(bufr)?;
-        Ok(Some(AlephWithTimestamp {
-            aleph,
-            ts: meta.created()?.into(),
-        }))
-    } else {
-        Ok(None)
+pub(crate) fn get_aleph_version(root: &Path) -> Result<Option<AlephWithTimestamp>> {
+    let path = &root.join(ALEPH_PATH);
+    if !path.exists() {
+        return Ok(None);
     }
+    let statusf = File::open(path).with_context(|| format!("Opening {path:?}"))?;
+    let meta = statusf.metadata()?;
+    let bufr = std::io::BufReader::new(statusf);
+    let aleph: Aleph = serde_json::from_reader(bufr)?;
+    Ok(Some(AlephWithTimestamp {
+        aleph,
+        ts: meta.created()?.into(),
+    }))
 }
 
 #[cfg(test)]
 mod test {
     use super::*;
     use anyhow::Result;
 
+    const V1_ALEPH_DATA: &str = r##"
+    {
+        "version": "32.20201002.dev.2",
+        "ref": "fedora/x86_64/coreos/testing-devel",
+        "ostree-commit": "b2ea6159d6274e1bbbb49aa0ef093eda5d53a75c8a793dbe184f760ed64dc862"
+    }"##;
+
     #[test]
-    fn test_parse_aleph() -> Result<()> {
+    fn test_parse_from_root_empty() -> Result<()> {
+        // Verify we're a no-op in an empty root
+        let root: &tempfile::TempDir = &tempfile::tempdir()?;
+        let root = root.path();
+        assert!(get_aleph_version(root).unwrap().is_none());
+        Ok(())
+    }
+
+    #[test]
+    fn test_parse_from_root() -> Result<()> {
+        let root: &tempfile::TempDir = &tempfile::tempdir()?;
+        let root = root.path();
+        let sysroot = &root.join("sysroot");
+        std::fs::create_dir(sysroot).context("Creating sysroot")?;
+        std::fs::write(root.join(ALEPH_PATH), V1_ALEPH_DATA).context("Writing aleph")?;
+        let aleph = get_aleph_version(root).unwrap().unwrap();
+        assert_eq!(aleph.aleph.version, "32.20201002.dev.2");
+        Ok(())
+    }
+
+    #[test]
+    fn test_parse_from_root_linked() -> Result<()> {
+        let root: &tempfile::TempDir = &tempfile::tempdir()?;
+        let root = root.path();
+        let sysroot = &root.join("sysroot");
+        std::fs::create_dir(sysroot).context("Creating sysroot")?;
+        let target_name = ".new-ostree-aleph.json";
+        let target = &sysroot.join(target_name);
+        std::fs::write(root.join(target), V1_ALEPH_DATA).context("Writing aleph")?;
+        std::os::unix::fs::symlink(target_name, root.join(ALEPH_PATH)).context("Symlinking")?;
+        let aleph = get_aleph_version(root).unwrap().unwrap();
+        assert_eq!(aleph.aleph.version, "32.20201002.dev.2");
+        Ok(())
+    }
+
+    #[test]
+    fn test_parse_old_aleph() -> Result<()> {
+        // What the aleph file looked like before we changed it in
+        // https://github.com/osbuild/osbuild/pull/1475
         let alephdata = r##"
 {
     "build": "32.20201002.dev.2",
@@ -61,10 +104,14 @@ mod test {
     "imgid": "fedora-coreos-32.20201002.dev.2-qemu.x86_64.qcow2"
 }"##;
         let aleph: Aleph = serde_json::from_str(alephdata)?;
-        assert_eq!(
-            aleph.imgid,
-            "fedora-coreos-32.20201002.dev.2-qemu.x86_64.qcow2"
-        );
+        assert_eq!(aleph.version, "32.20201002.dev.2");
+        Ok(())
+    }
+
+    #[test]
+    fn test_parse_aleph() -> Result<()> {
+        let aleph: Aleph = serde_json::from_str(V1_ALEPH_DATA)?;
+        assert_eq!(aleph.version, "32.20201002.dev.2");
         Ok(())
     }
 }

src/efi.rs

@@ -218,10 +218,10 @@ impl Component for Efi {
             return Ok(None);
         };
         // This would be extended with support for other operating systems later
-        if let Some(coreos_aleph) = crate::coreos::get_aleph_version()? {
+        if let Some(coreos_aleph) = crate::coreos::get_aleph_version(Path::new("/"))? {
             let meta = ContentMetadata {
                 timestamp: coreos_aleph.ts,
-                version: coreos_aleph.aleph.imgid,
+                version: coreos_aleph.aleph.version,
             };
             log::trace!("EFI adoptable: {:?}", &meta);
             return Ok(Some(Adoptable {

tests/kola/test-bootupd

@@ -44,7 +44,7 @@ bootupctl status > out.txt
 assert_file_has_content_literal out.txt 'Component EFI'
 assert_file_has_content_literal out.txt '  Installed: grub2-efi-x64-'
 assert_file_has_content_literal out.txt 'Update: At latest version'
-assert_file_has_content out.txt '^CoreOS aleph image ID: .*-qemu.'$(arch)'.qcow2'
+assert_file_has_content out.txt '^CoreOS aleph version:'
 ok status
 
 # Validate we auto-exited