Skip to content

Commit

Permalink
Extend get_file_metadata with directory walking.
Browse files Browse the repository at this point in the history
  • Loading branch information
@panhania
panhania authored Sep 24, 2024
1 parent 80e3ee9 commit 48d206d
Show file tree
Hide file tree
Showing 2 changed files with 315 additions and 4 deletions.
308 changes: 305 additions & 3 deletions crates/rrg/src/action/get_file_metadata.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ use std::path::{Path, PathBuf};

/// Arguments of the `get_file_metadata` action.
pub struct Args {
/// Path the file to get the metadata of.
/// Root path to the file to get the metadata of.
path: PathBuf,
/// Limit on the depth of recursion when visiting subfolders.
max_depth: u32,
}

/// Result of the `get_file_metadata` action.
Expand Down Expand Up @@ -73,13 +75,75 @@ where
let symlink = symlink.transpose().map_err(crate::session::Error::action)?;

session.reply(Item {
path,
path: path.clone(),
metadata,
#[cfg(target_family = "unix")]
ext_attrs,
symlink,
})?;

if args.max_depth > 0 {
for entry in crate::fs::walk_dir(&path)
.map_err(crate::session::Error::action)?
.with_max_depth(args.max_depth)
{
let entry = match entry {
Ok(entry) => entry,
Err(error) => {
log::error!("failed to read directory entry: {error}");
continue
}
};

#[cfg(target_family = "unix")]
let ext_attrs = match ospect::fs::ext_attrs(&entry.path) {
Ok(ext_attrs) => ext_attrs.filter_map(|ext_attr| match ext_attr {
Ok(ext_attr) => Some(ext_attr),
Err(error) => {
log::error! {
"failed to read an extended attribute for '{}': {error}",
entry.path.display()
};

None
}
}).collect(),
Err(error) => {
log::error! {
"failed to list extended attributes for '{}': {error}",
entry.path.display()
};

Vec::default()
}
};

let symlink = if entry.metadata.is_symlink() {
match std::fs::read_link(&entry.path) {
Ok(symlink) => Some(symlink),
Err(error) => {
log::error! {
"failed to read symlink target for '{}': {error}",
entry.path.display()
};

None
}
}
} else {
None
};

session.reply(Item {
path: entry.path,
metadata: entry.metadata,
#[cfg(target_family = "unix")]
ext_attrs,
symlink,
})?;
}
}

Ok(())
}

Expand All @@ -95,6 +159,7 @@ impl crate::request::Args for Args {

Ok(Args {
path,
max_depth: proto.max_depth(),
})
}
}
Expand Down Expand Up @@ -171,6 +236,7 @@ mod tests {

let args = Args {
path: tempdir.path().join("foo"),
max_depth: 0,
};

let mut session = crate::session::FakeSession::new();
Expand All @@ -180,7 +246,8 @@ mod tests {
#[test]
fn handle_relative() {
let args = Args {
path: PathBuf::from("foo/bar/baz")
path: PathBuf::from("foo/bar/baz"),
max_depth: 0,
};

let mut session = crate::session::FakeSession::new();
Expand All @@ -199,6 +266,7 @@ mod tests {

let args = Args {
path: tempdir.join("foo").to_path_buf(),
max_depth: 0,
};

let mut session = crate::session::FakeSession::new();
Expand Down Expand Up @@ -226,6 +294,7 @@ mod tests {

let args = Args {
path: tempdir.join("link"),
max_depth: 0,
};

let mut session = crate::session::FakeSession::new();
Expand Down Expand Up @@ -258,6 +327,7 @@ mod tests {

let args = Args {
path: tempfile.path().to_path_buf(),
max_depth: 0,
};

let mut session = crate::session::FakeSession::new();
Expand Down Expand Up @@ -290,6 +360,7 @@ mod tests {

let args = Args {
path: tempfile.path().to_owned(),
max_depth: 0,
};

let mut session = crate::session::FakeSession::new();
Expand All @@ -304,6 +375,237 @@ mod tests {
assert_eq!(item.ext_attrs[0].value, b"bar");
}

#[test]
fn handle_dir_max_depth_0() {
let tempdir = tempfile::tempdir()
.unwrap();
let tempdir = tempdir.path().canonicalize()
.unwrap();

std::fs::File::create(tempdir.join("foo"))
.unwrap();
std::fs::File::create(tempdir.join("bar"))
.unwrap();

let args = Args {
path: tempdir.to_path_buf(),
max_depth: 0,
};

let mut session = crate::session::FakeSession::new();
assert!(handle(&mut session, args).is_ok());

let paths = session.replies::<Item>()
.map(|item| item.path.clone())
.collect::<Vec<_>>();

assert!(paths.contains((&tempdir).into()));
assert!(!paths.contains(&tempdir.join("foo")));
assert!(!paths.contains(&tempdir.join("bar")));
}

#[test]
fn handle_dir_max_depth_1() {
let tempdir = tempfile::tempdir()
.unwrap();
let tempdir = tempdir.path().canonicalize()
.unwrap();

std::fs::File::create(tempdir.join("file1"))
.unwrap();
std::fs::File::create(tempdir.join("file2"))
.unwrap();

std::fs::create_dir(tempdir.join("subdir"))
.unwrap();

std::fs::File::create(tempdir.join("subdir").join("file1"))
.unwrap();
std::fs::File::create(tempdir.join("subdir").join("file2"))
.unwrap();

let args = Args {
path: tempdir.to_path_buf(),
max_depth: 1,
};

let mut session = crate::session::FakeSession::new();
assert!(handle(&mut session, args).is_ok());

let items_by_path = session.replies::<Item>()
.map(|item| (item.path.clone(), item))
.collect::<std::collections::HashMap<_, _>>();

assert!(items_by_path.contains_key(&tempdir));
assert!(items_by_path[&tempdir].metadata.is_dir());

assert!(items_by_path.contains_key(&tempdir.join("file1")));
assert!(items_by_path[&tempdir.join("file1")].metadata.is_file());

assert!(items_by_path.contains_key(&tempdir.join("file2")));
assert!(items_by_path[&tempdir.join("file2")].metadata.is_file());

assert!(items_by_path.contains_key(&tempdir.join("subdir")));
assert!(items_by_path[&tempdir.join("subdir")].metadata.is_dir());

assert!(!items_by_path.contains_key(&tempdir.join("subdir").join("file1")));
assert!(!items_by_path.contains_key(&tempdir.join("subdir").join("file2")));
}

#[cfg(target_family = "unix")]
#[test]
fn handle_dir_max_depth_1_symlinks() {
let tempdir = tempfile::tempdir()
.unwrap();
let tempdir = tempdir.path().canonicalize()
.unwrap();

std::fs::File::create(tempdir.join("file"))
.unwrap();

std::os::unix::fs::symlink(tempdir.join("file"), tempdir.join("link"))
.unwrap();

let args = Args {
path: tempdir.to_path_buf(),
max_depth: 1,
};

let mut session = crate::session::FakeSession::new();
assert!(handle(&mut session, args).is_ok());

let items_by_path = session.replies::<Item>()
.map(|item| (item.path.clone(), item))
.collect::<std::collections::HashMap::<_, _>>();

assert!(items_by_path.contains_key(&tempdir));
assert!(items_by_path.contains_key(&tempdir.join("file")));
assert!(items_by_path.contains_key(&tempdir.join("link")));

let item_link = items_by_path[&tempdir.join("link")];
assert!(item_link.metadata.is_symlink());
assert_eq!(item_link.symlink, Some(tempdir.join("file")));
}

#[cfg(feature = "test-setfattr")]
#[cfg(target_os = "linux")]
#[test]
fn handle_dir_max_depth_1_ext_attrs() {
let tempdir = tempfile::tempdir()
.unwrap();
let tempdir = tempdir.path().canonicalize()
.unwrap();

std::fs::File::create(tempdir.join("file1"))
.unwrap();
std::fs::File::create(tempdir.join("file2"))
.unwrap();

assert! {
std::process::Command::new("setfattr")
.arg("--no-dereference")
.arg("--name").arg("user.attr1")
.arg("--value").arg("value1")
.arg(tempdir.join("file1"))
.status().unwrap()
.success()
};
assert! {
std::process::Command::new("setfattr")
.arg("--no-dereference")
.arg("--name").arg("user.attr2")
.arg("--value").arg("value2")
.arg(tempdir.join("file2"))
.status().unwrap()
.success()
};

let args = Args {
path: tempdir.to_path_buf(),
max_depth: 1,
};

let mut session = crate::session::FakeSession::new();
assert!(handle(&mut session, args).is_ok());

let items_by_path = session.replies::<Item>()
.map(|item| (item.path.clone(), item))
.collect::<std::collections::HashMap::<_, _>>();

assert!(items_by_path.contains_key(&tempdir));
assert!(items_by_path.contains_key(&tempdir.join("file1")));
assert!(items_by_path.contains_key(&tempdir.join("file2")));

let item_file1 = items_by_path[&tempdir.join("file1")];
assert_eq!(item_file1.ext_attrs.len(), 1);
assert_eq!(item_file1.ext_attrs[0].name, "user.attr1");
assert_eq!(item_file1.ext_attrs[0].value, b"value1");

let item_file2 = items_by_path[&tempdir.join("file2")];
assert_eq!(item_file2.ext_attrs.len(), 1);
assert_eq!(item_file2.ext_attrs[0].name, "user.attr2");
assert_eq!(item_file2.ext_attrs[0].value, b"value2");
}

#[cfg(target_os = "macos")]
#[test]
fn handle_dir_max_depth_1_ext_attrs() {
let tempdir = tempfile::tempdir()
.unwrap();
let tempdir = tempdir.path().canonicalize()
.unwrap();

std::fs::File::create(tempdir.join("file1"))
.unwrap();
std::fs::File::create(tempdir.join("file2"))
.unwrap();

assert! {
std::process::Command::new("xattr")
.arg("-w")
.arg("user.attr1")
.arg("value1")
.arg(tempdir.join("file1"))
.status().unwrap()
.success()
};
assert! {
std::process::Command::new("xattr")
.arg("-w")
.arg("user.attr2")
.arg("value2")
.arg(tempdir.join("file2"))
.status().unwrap()
.success()
};

let args = Args {
path: tempdir.to_path_buf(),
max_depth: 1,
};

let mut session = crate::session::FakeSession::new();
assert!(handle(&mut session, args).is_ok());

let items_by_path = session.replies::<Item>()
.map(|item| (item.path.clone(), item))
.collect::<std::collections::HashMap::<_, _>>();

assert!(items_by_path.contains_key(&tempdir));
assert!(items_by_path.contains_key(&tempdir.join("file1")));
assert!(items_by_path.contains_key(&tempdir.join("file2")));

let item_file1 = items_by_path[&tempdir.join("file1")];
assert_eq!(item_file1.ext_attrs.len(), 1);
assert_eq!(item_file1.ext_attrs[0].name, "user.attr1");
assert_eq!(item_file1.ext_attrs[0].value, b"value1");

let item_file2 = items_by_path[&tempdir.join("file2")];
assert_eq!(item_file2.ext_attrs.len(), 1);
assert_eq!(item_file2.ext_attrs[0].name, "user.attr2");
assert_eq!(item_file2.ext_attrs[0].value, b"value2");
}

macro_rules! path {
($root:expr) => {{
::std::path::PathBuf::from($root)
Expand Down
Loading

0 comments on commit 48d206d

Please sign in to comment.