test_utils.rs

// Copyright 2023 The ChromiumOS Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

use std::env::current_exe;
use std::process::Command;

/// The tests below require root privileges.
/// Re-invoke the test binary to execute the specified test with sudo. The test will fail if
/// passwordless sudo is not available.
///
/// Warning: If you use this, add your test to ROOT_TESTS in tools/impl/test_config.py
/// This will ensure they are not run when passwordless root is unavailable.
pub fn call_test_with_sudo(name: &str) {
    check_can_sudo();

    let result = Command::new("sudo")
        .args([
            "--preserve-env",
            current_exe().unwrap().to_str().unwrap(),
            "--nocapture",
            "--ignored",
            "--exact",
            name,
        ])
        .status()
        .unwrap();

    if !result.success() {
        panic!("Test {name} failed in child process.");
    }
}

/// Checks to see if user has entered their password for sudo.
pub fn check_can_sudo() {
    // Try a passwordless sudo first to provide a proper error message.
    // Note: The combination of SUDO_ASKPASS and --askpass will fail if sudo has to ask for a
    // password. When sudo needs to ask for a password, it will call "false" and fail without
    // prompting.
    let can_sudo = Command::new("sudo")
        .args(["--askpass", "true"]) // Use an askpass program to ask for a password
        .env("SUDO_ASKPASS", "false") // Set the askpass program to false
        .output()
        .unwrap();
    if !can_sudo.status.success() {
        panic!("This test need to be run as root or with passwordless sudo.");
    }
}

/// Assert repeatedly until it's true
///
/// Runs the provided `$cond` closure until it returns true. If it does not return true after
/// `$tries` times, it will panic.
/// There is no delay between polls, but the `$cond` can sleep as needed.
#[macro_export]
macro_rules! poll_assert {
    ($tries: tt, $cond:expr) => {
        $crate::test_utils::poll_assert_impl(stringify!($cond), $tries, $cond)
    };
}

/// Implementation of [poll_assert]
pub fn poll_assert_impl(msg: &'static str, tries: usize, poll_fn: impl Fn() -> bool) {
    for _ in 0..tries {
        if poll_fn() {
            return;
        }
    }
    panic!("Still failing after {tries} tries: {msg}");
}