lints: Ignore /boot/EFI

See containers/composefs-rs#131

Signed-off-by: Colin Walters <[email protected]>

Author: cgwalters

crates/lib/src/bootc_composefs/boot.rs

@@ -1,7 +1,7 @@
+use std::ffi::OsStr;
 use std::fs::create_dir_all;
 use std::io::Write;
 use std::path::Path;
-use std::ffi::OsStr;
 
 use anyhow::{anyhow, Context, Result};
 use bootc_blockdev::find_parent_devices;
@@ -51,7 +51,7 @@ use crate::install::{RootSetup, State};
 /// Contains the EFP's filesystem UUID. Used by grub
 pub(crate) const EFI_UUID_FILE: &str = "efiuuid.cfg";
 /// The EFI Linux directory
-const EFI_LINUX: &str = "EFI/Linux";
+pub(crate) const EFI_LINUX: &str = "EFI/Linux";
 
 /// Timeout for systemd-boot bootloader menu
 const SYSTEMD_TIMEOUT: &str = "timeout 5";
@@ -1024,8 +1024,8 @@ pub(crate) fn setup_composefs_boot(
 
 #[cfg(test)]
 mod tests {
-    use cap_std_ext::cap_std;
     use super::*;
+    use cap_std_ext::cap_std;
 
     #[test]
     fn test_root_has_uki() -> Result<()> {
@@ -1051,4 +1051,4 @@ mod tests {
 
         Ok(())
     }
-}
+}

crates/lib/src/lints.rs

@@ -27,6 +27,8 @@ use linkme::distributed_slice;
 use ostree_ext::ostree_prepareroot;
 use serde::Serialize;
 
+use crate::bootc_composefs::boot::EFI_LINUX;
+
 /// Reference to embedded default baseimage content that should exist.
 const BASEIMAGE_REF: &str = "usr/share/doc/bootc/baseimage/base";
 // https://systemd.io/API_FILE_SYSTEMS/ with /var added for us
@@ -758,14 +760,24 @@ fn check_boot(root: &Dir, config: &LintExecutionConfig) -> LintResult {
     };
 
     // First collect all entries to determine if the directory is empty
-    let entries: Result<Vec<_>, _> = d.entries()?.collect();
-    let entries = entries?;
+    let entries: Result<BTreeSet<_>, _> = d
+        .entries()?
+        .into_iter()
+        .map(|v| {
+            let v = v?;
+            anyhow::Ok(v.file_name())
+        })
+        .collect();
+    let mut entries = entries?;
+    // Work around https://github.com/containers/composefs-rs/issues/131
+    let efidir = Utf8Path::new(EFI_LINUX)
+        .parent()
+        .map(|b| b.as_std_path())
+        .unwrap();
+    entries.remove(efidir.as_os_str());
     if entries.is_empty() {
         return lint_ok();
     }
-    // Gather sorted filenames
-    let mut entries = entries.iter().map(|v| v.file_name()).collect::<Vec<_>>();
-    entries.sort();
 
     let header = "Found non-empty /boot";
     let items = entries.iter().map(PathQuotedDisplay::new);
@@ -973,6 +985,12 @@ mod tests {
         let root = &passing_fixture()?;
         let config = &LintExecutionConfig::default();
         check_boot(&root, config).unwrap().unwrap();
+
+        // Verify creating EFI doesn't error
+        root.create_dir_all("EFI/Linux")?;
+        root.write("EFI/Linux/foo.efi", b"some dummy efi")?;
+        check_boot(&root, config).unwrap().unwrap();
+
         root.create_dir("boot/somesubdir")?;
         let Err(e) = check_boot(&root, config).unwrap() else {
             unreachable!()