Merge pull request #55 from arortiz-rh/main

Addition of New Feature - Binary Support

Author: say-paul

src/lib/greenboot.rs

@@ -2,6 +2,8 @@ use anyhow::{Result, bail};
 use glob::glob;
 use std::collections::HashSet;
 use std::error::Error;
+use std::fs;
+use std::os::unix::fs::PermissionsExt;
 use std::path::Path;
 use std::process::Command;
 
@@ -104,35 +106,53 @@ fn run_scripts(name: &str, path: &str, disabled_scripts: Option<&[String]>) -> S
         skipped: Vec::new(),
     };
 
-    // Handle glob pattern error early
-    let entries = match glob(&format!("{}*.sh", path)) {
-        Ok(e) => e,
+    let entries = match glob(&format!("{}*", path)) {
+        Ok(e) => {
+            let valid: Vec<_> = e
+                .filter_map(Result::ok)
+                .filter(|entry| {
+                    if let Ok(metadata) = fs::metadata(entry) {
+                        let mode = metadata.permissions().mode();
+                        metadata.is_file()
+                            && (entry.extension().and_then(|ext| ext.to_str()) == Some("sh")
+                                || (mode & 0o001 != 0 || mode & 0o010 != 0 || mode & 0o100 != 0))
+                    } else {
+                        false
+                    }
+                })
+                .collect();
+            Some(valid).into_iter()
+        }
         Err(e) => {
             result.errors.push(Box::new(e));
             return result;
         }
     };
 
     for entry in entries.flatten() {
-        // Process script name
-        let script_name = match entry.file_name().and_then(|n| n.to_str()) {
+        // Process script/binary name
+        let file_name = match entry.file_name().and_then(|n| n.to_str()) {
             Some(name) => name,
             None => continue,
         };
 
-        // Check if script should be skipped
+        // Check if script/binary should be skipped
         if let Some(disabled) = disabled_scripts {
-            if disabled.contains(&script_name.to_string()) {
-                log::info!("Skipping disabled script: {}", script_name);
-                result.skipped.push(script_name.to_string());
+            if disabled.contains(&file_name.to_string()) {
+                log::info!("Skipping disabled script: {}", file_name);
+                result.skipped.push(file_name.to_string());
                 continue;
             }
         }
 
         log::info!("running {} check {}", name, entry.to_string_lossy());
 
-        // Execute script and handle output
-        let output = Command::new("bash").arg("-C").arg(&entry).output();
+        // Sort between scripts and binaries since they require different commands to execute properly.
+        let output = if entry.extension().and_then(|ext| ext.to_str()) == Some("sh") {
+            Command::new("bash").arg("-C").arg(&entry).output()
+        } else {
+            Command::new(&entry).output()
+        };
 
         match output {
             Ok(o) if o.status.success() => {
@@ -213,6 +233,11 @@ mod test {
         setup_folder_structure(false)
             .context("Test setup failed")
             .unwrap();
+        // Causes errors if these are not removed since they cause an excess amount
+        // of failures.
+        let required_path = format!("{}/check/required.d", GREENBOOT_INSTALL_PATHS[1]);
+        let _ = std::fs::remove_file(format!("{}/01_failing_binary", required_path));
+        let _ = std::fs::remove_file(format!("{}/02_failing_binary", required_path));
 
         let base_path = GREENBOOT_INSTALL_PATHS[1];
 
@@ -279,6 +304,12 @@ mod test {
             .context("Test setup failed")
             .unwrap();
 
+        // Removing extra failing binaries because this can cause a
+        // failure if not added to the skips or removed as done below.
+        let required_path = format!("{}/check/required.d", GREENBOOT_INSTALL_PATHS[1]);
+        let _ = std::fs::remove_file(format!("{}/01_failing_binary", required_path));
+        let _ = std::fs::remove_file(format!("{}/02_failing_binary", required_path));
+
         // Skip the disabled script in required.d ,since there are two
         // failing- scripts passing them both so that this test passes.
         let state = run_diagnostics(vec![
@@ -293,11 +324,41 @@ mod test {
         tear_down().context("Test teardown failed").unwrap();
     }
 
+    // Since binaries are a separate and later added feature compared to
+    // scripts, there should be a separate test to ensure they both work.
+    #[test]
+    fn test_skip_disabled_binary() {
+        setup_folder_structure(false)
+            .context("Test setup failed")
+            .unwrap();
+
+        // Removing extra failing scripts because this can cause a
+        // failure if not added to the skips or removed as done below
+        let required_path = format!("{}/check/required.d", GREENBOOT_INSTALL_PATHS[1]);
+        let _ = std::fs::remove_file(format!("{}/01_failing_script.sh", required_path));
+        let _ = std::fs::remove_file(format!("{}/02_failing_script.sh", required_path));
+
+        // Skip the disabled script in required.d ,since there are two
+        // failing- scripts passing them both so that this test passes.
+        let state = run_diagnostics(vec![
+            "01_failing_binary".to_string(),
+            "02_failing_binary".to_string(),
+        ]);
+        assert!(
+            state.is_ok(),
+            "Should pass when skipping disabled required binary"
+        );
+
+        tear_down().context("Test teardown failed").unwrap();
+    }
+
     fn setup_folder_structure(passing: bool) -> Result<()> {
         let required_path = format!("{}/check/required.d", GREENBOOT_INSTALL_PATHS[1]);
         let wanted_path = format!("{}/check/wanted.d", GREENBOOT_INSTALL_PATHS[1]);
         let passing_test_scripts = "testing_assets/passing_script.sh";
         let failing_test_scripts = "testing_assets/failing_script.sh";
+        let passing_test_binary = "testing_assets/passing_binary";
+        let failing_test_binary = "testing_assets/failing_binary";
 
         fs::create_dir_all(&required_path).expect("cannot create folder");
         fs::create_dir_all(&wanted_path).expect("cannot create folder");
@@ -315,13 +376,33 @@ mod test {
         )
         .context("unable to copy passing script to wanted.d")?;
 
+        // Create passing binary in both required and wanted
+        fs::copy(
+            passing_test_binary,
+            format!("{}/passing_binary", &required_path),
+        )
+        .context("unable to copy passing binary to required.d")?;
+
+        fs::copy(
+            passing_test_binary,
+            format!("{}/passing_binary", &wanted_path),
+        )
+        .context("unable to copy passing binary to wanted.d")?;
+
         // Create failing script in wanted.d
         fs::copy(
             failing_test_scripts,
             format!("{}/failing_script.sh", &wanted_path),
         )
         .context("unable to copy failing script to wanted.d")?;
 
+        // Create failing binary in wanted.d
+        fs::copy(
+            failing_test_binary,
+            format!("{}/failing_binary", &wanted_path),
+        )
+        .context("unable to copy failing binary to wanted.d")?;
+
         if !passing {
             // Create multiple failing script in required.d for failure cases
             fs::copy(
@@ -334,6 +415,18 @@ mod test {
                 format!("{}/02_failing_script.sh", &required_path),
             )
             .context("unable to copy another failing script to required.d")?;
+
+            // Create multiple failing binaries in required.d for failure cases
+            fs::copy(
+                failing_test_scripts,
+                format!("{}/01_failing_binary", &required_path),
+            )
+            .context("unable to copy failing binary to required.d")?;
+            fs::copy(
+                failing_test_scripts,
+                format!("{}/02_failing_binary", &required_path),
+            )
+            .context("unable to copy another failing binary to required.d")?;
         }
         Ok(())
     }

testing_assets/failing_binary

@@ -150,7 +150,9 @@ fi
 greenprint "Building greenboot packages"
 pushd .. && \
 make rpm
-cp rpmbuild/RPMS/x86_64/*.rpm tests/ && popd
+cp rpmbuild/RPMS/x86_64/*.rpm tests/
+cp testing_assets/passing_binary tests/
+cp testing_assets/failing_binary tests/ && popd
 
 ###########################################################
 ##
@@ -169,6 +171,8 @@ RUN dnf install -y \
     systemctl enable greenboot-healthcheck.service greenboot-rollback.service greenboot-success.target
 RUN sed -i "s/GREENBOOT_MAX_BOOT_ATTEMPTS=3/GREENBOOT_MAX_BOOT_ATTEMPTS=5/g" /etc/greenboot/greenboot.conf
 RUN sed -i 's#DISABLED_HEALTHCHECKS=()#DISABLED_HEALTHCHECKS=("01_repository_dns_check.sh" "not_exit.sh")#g' /etc/greenboot/greenboot.conf
+COPY passing_binary /etc/greenboot/check/required.d/
+COPY failing_binary /etc/greenboot/check/wanted.d/
 # Clean up by removing the local RPMs if desired
 RUN rm -f /tmp/greenboot-*.rpm
 EOF

testing_assets/passing_binary

@@ -150,7 +150,9 @@ fi
 greenprint "Building greenboot packages"
 pushd .. && \
 make rpm
-cp rpmbuild/RPMS/x86_64/*.rpm tests/ && popd
+cp rpmbuild/RPMS/x86_64/*.rpm tests/
+cp testing_assets/passing_binary tests/
+cp testing_assets/failing_binary tests/ && popd
 
 ###########################################################
 ##
@@ -169,6 +171,8 @@ RUN dnf install -y \
     systemctl enable greenboot-healthcheck.service greenboot-rollback.service greenboot-success.target
 RUN sed -i "s/GREENBOOT_MAX_BOOT_ATTEMPTS=3/GREENBOOT_MAX_BOOT_ATTEMPTS=5/g" /etc/greenboot/greenboot.conf
 RUN sed -i 's#DISABLED_HEALTHCHECKS=()#DISABLED_HEALTHCHECKS=("01_repository_dns_check.sh" "not_exit.sh")#g' /etc/greenboot/greenboot.conf
+COPY passing_binary /etc/greenboot/check/required.d/
+COPY failing_binary /etc/greenboot/check/wanted.d/
 # Clean up by removing the local RPMs if desired
 RUN rm -f /tmp/greenboot-*.rpm
 EOF

tests/greenboot-bootc-anaconda-iso.sh

@@ -164,6 +164,29 @@
           set_fact:
             failed_counter: "{{ failed_counter | int + 1 }}"
 
+    # case: check binary file support
+    - name: check binary file support
+      block:
+        - name: binary file check result should be found here
+          shell: journalctl -b -0 -u greenboot -u greenboot-healthcheck
+          become: yes
+          register: result_binary
+
+        - assert:
+            that:
+              - "'required script /etc/greenboot/check/required.d/passing_binary success!' in result_binary.stdout"
+              - "'wanted script /etc/greenboot/check/wanted.d/failing_binary failed!' in result_binary.stdout"
+            fail_msg: "Binary file check log not found"
+            success_msg: "Found binary file check log"
+
+      always:
+        - set_fact:
+            total_counter: "{{ total_counter | int + 1 }}"
+      rescue:
+        - name: failed count + 1
+          set_fact:
+            failed_counter: "{{ failed_counter | int + 1 }}"
+
     # case: check boot times
     - name: check boot times
       block: