Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Skip test_disk_usage if there's no /usr/bin/du #6479

Closed
wants to merge 1 commit into from
Closed

Skip test_disk_usage if there's no /usr/bin/du #6479

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion sled-agent/src/zone_bundle.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ const ARCHIVE_SNAPSHOT_PREFIX: &'static str = "zone-archives-";
const ZONE_BUNDLE_ZFS_PROPERTY_NAME: &'static str = "oxide:for-zone-bundle";
const ZONE_BUNDLE_ZFS_PROPERTY_VALUE: &'static str = "true";

// Path to the `du(1)` executable.
const DU: &str = "/usr/bin/du";

// Initialize the ZFS resources we need for zone bundling.
//
// This deletes any snapshots matching the names we expect to create ourselves
Expand Down Expand Up @@ -1573,7 +1576,6 @@ async fn disk_usage(path: &Utf8PathBuf) -> Result<u64, BundleError> {
compile_error!("unsupported target OS");
}
}
const DU: &str = "/usr/bin/du";
let args = &[DU_ARG, "-s", path.as_str()];
let output = Command::new(DU).args(args).output().await.map_err(|err| {
BundleError::Command { cmd: format!("{DU} {}", args.join(" ")), err }
Expand Down Expand Up @@ -1660,10 +1662,33 @@ async fn zfs_quota(path: &Utf8PathBuf) -> Result<u64, BundleError> {
#[cfg(test)]
mod tests {
use super::disk_usage;
use super::Utf8Path;
use super::Utf8PathBuf;
use super::DU;

#[tokio::test]
async fn test_disk_usage() {
// On some systems, such as NixOS, the `du(1)` executable may not live
// at the path `/usr/bin/du``. We could, potentially, change the
// `disk_usage` function to find a du binary on the PATH, or fall back
// to other locations...but, on Helios, it is always at `/usr/bin/du`,
// so hardcoding it is a good solution for the environment that
// sled-agents are actually intended to run in.
//
// However, hardcoding the path means that this test will always fail on
// systems where there is no `/usr/bin/du`, so let's just return early
// on such systems.
//
// TODO(eliza): if, someday, Rust's libtest grows a mechanism for tests
// to mark themselves as skipped at runtime dynamically (rather than
// using the `#[ignore]` attribute at compile-time), we should use
// that here. See:
// https://internals.rust-lang.org/t/pre-rfc-skippable-tests/14611
if !Utf8Path::new(DU).exists() {
eprintln!("No {DU} executable found, skipping disk usage test!");
return;
}
Comment on lines +1687 to +1690
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we put this behind a #[cfg(target_os = "linux")]? Super conservative, but would make me slightly more comfortable :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, although, perhaps we want #[cfg(not(target_os = "illumos"))]? Would we also want this behavior on MacOS/Windows?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was just trying to preserve the existing behavior on the largest number of systems we already run the test on, that's all. Implementing du in Rust is also fine to me, just sounds like more work, but there may be a good library for it.


let path =
Utf8PathBuf::from(concat!(env!("CARGO_MANIFEST_DIR"), "/src"));
let usage = disk_usage(&path).await.unwrap();
Expand Down
Loading