( )⚙ D11738 tests: run the whole hg-core/path_auditor test in a clean temp dir

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D11738

tests: run the whole hg-core/path_auditor test in a clean temp dir
ClosedPublic

Authored by Alphare on Nov 9 2021, 8:18 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHGab2dfc993b5c: tests: run the whole hg-core/path_auditor test in a clean temp dir
Summary

This makes the whole test happen in a clean temporary directory in
$TMPDIR/$random, and simplifies the test a bit by eliminating unnecessarily
dynamic path elements computations.

Before this patch, the first part of the test was happening in /tmp itself.
This allowed coincidentally named files placed in that directory to impact the
outcome of the test. Additionally, this made the second part of the test fail
on systems on which $TMPDIR != /tmp, because the inspected directory was
different from the one in which the mock files were being written. This fully
fixes the issue only partially solved in db2bc9e667a1.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Alphare created this revision.Nov 9 2021, 8:18 AM
Alphare added a subscriber: pacien.Nov 9 2021, 8:20 AM

Note to reviewers, this is *not* my series, I'm just sending it on behalf of @pacien who didn't have time to send them today. I've reviewed these patches and they look good, I'm sending them here to keep a public track of what's happening

pacien added a commit: rHGab2dfc993b5c: tests: run the whole hg-core/path_auditor test in a clean temp dir.Nov 9 2021, 9:30 AM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHGab2dfc993b5c: tests: run the whole hg-core/path_auditor test in a clean temp dir (authored by pacien). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 31035

rust/hg-core/src/utils/path_auditor.rs

pub fn check(&self, path: impl AsRef<HgPath>) -> bool { pub fn check(&self, path: impl AsRef<HgPath>) -> bool {
self.audit_path(path).is_ok() self.audit_path(path).is_ok()
} }
} }
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
use crate::utils::files::get_path_from_bytes; use std::fs::{create_dir, File};
use crate::utils::hg_path::path_to_hg_path_buf; use tempfile::tempdir;
#[test] #[test]
fn test_path_auditor() { fn test_path_auditor() {
let auditor = PathAuditor::new(get_path_from_bytes(b"/tmp")); let base_dir = tempdir().unwrap();
let base_dir_path = base_dir.path();
let auditor = PathAuditor::new(base_dir_path);
let path = HgPath::new(b".hg/00changelog.i"); let path = HgPath::new(b".hg/00changelog.i");
assert_eq!( assert_eq!(
auditor.audit_path(path), auditor.audit_path(path),
Err(HgPathError::InsideDotHg(path.to_owned())) Err(HgPathError::InsideDotHg(path.to_owned()))
); );
let path = HgPath::new(b"this/is/nested/.hg/thing.txt"); let path = HgPath::new(b"this/is/nested/.hg/thing.txt");
assert_eq!( assert_eq!(
auditor.audit_path(path), auditor.audit_path(path),
Err(HgPathError::IsInsideNestedRepo { Err(HgPathError::IsInsideNestedRepo {
path: path.to_owned(), path: path.to_owned(),
nested_repo: HgPathBuf::from_bytes(b"this/is/nested") nested_repo: HgPathBuf::from_bytes(b"this/is/nested")
}) })
); );
use std::fs::{create_dir, File}; create_dir(&base_dir_path.join("realdir")).unwrap();
use tempfile::tempdir; File::create(&base_dir_path.join("realdir/realfile")).unwrap();
let base_dir = tempdir().unwrap();
let base_dir_path = base_dir.path();
let skip = base_dir_path.components().count() - 1;
let a = base_dir_path.join("a");
let b = base_dir_path.join("b");
create_dir(&a).unwrap();
let in_a_path = a.join("in_a");
File::create(in_a_path).unwrap();
// TODO make portable // TODO make portable
std::os::unix::fs::symlink(&a, &b).unwrap(); std::os::unix::fs::symlink(
&base_dir_path.join("realdir"),
let buf = b.join("in_a").components().skip(skip).collect::<PathBuf>(); &base_dir_path.join("symlink"),
eprintln!("buf: {}", buf.display()); )
let path = path_to_hg_path_buf(buf).unwrap(); .unwrap();
let path = HgPath::new(b"symlink/realfile");
assert_eq!( assert_eq!(
auditor.audit_path(&path), auditor.audit_path(path),
Err(HgPathError::TraversesSymbolicLink { Err(HgPathError::TraversesSymbolicLink {
path: path, path: path.to_owned(),
symlink: path_to_hg_path_buf( symlink: HgPathBuf::from_bytes(b"symlink"),
b.components().skip(2).collect::<PathBuf>()
)
.unwrap()
}) })
); );
} }
} }