mktemp: add message for directory not found

Add special handling in `mktemp` for when the directory that will
contain the temporary file is not found. This situation now produces
the message

    mktemp: failed to create file via template 'XXX': No such file or directory

to match the behavior of GNU mktemp.
This commit is contained in:
Jeffrey Finkelstein 2022-09-15 22:49:50 -04:00
parent f2e4225bc6
commit 60ca9a03bb
2 changed files with 112 additions and 2 deletions

View file

@ -16,6 +16,7 @@ use uucore::format_usage;
use std::env; use std::env;
use std::error::Error; use std::error::Error;
use std::fmt::Display; use std::fmt::Display;
use std::io::ErrorKind;
use std::iter; use std::iter;
use std::path::{Path, PathBuf, MAIN_SEPARATOR}; use std::path::{Path, PathBuf, MAIN_SEPARATOR};
@ -54,6 +55,9 @@ enum MkTempError {
SuffixContainsDirSeparator(String), SuffixContainsDirSeparator(String),
InvalidTemplate(String), InvalidTemplate(String),
TooManyTemplates, TooManyTemplates,
/// When a specified temporary directory could not be found.
NotFound(String, String),
} }
impl UError for MkTempError { impl UError for MkTempError {
@ -93,6 +97,12 @@ impl Display for MkTempError {
TooManyTemplates => { TooManyTemplates => {
write!(f, "too many templates") write!(f, "too many templates")
} }
NotFound(template_type, s) => write!(
f,
"failed to create {} via template {}: No such file or directory",
template_type,
s.quote()
),
} }
} }
} }
@ -469,7 +479,8 @@ pub fn dry_exec(tmpdir: &str, prefix: &str, rand: usize, suffix: &str) -> UResul
/// ///
/// # Errors /// # Errors
/// ///
/// If the temporary directory could not be written to disk. /// If the temporary directory could not be written to disk or if the
/// given directory `dir` does not exist.
fn make_temp_dir(dir: &str, prefix: &str, rand: usize, suffix: &str) -> UResult<PathBuf> { fn make_temp_dir(dir: &str, prefix: &str, rand: usize, suffix: &str) -> UResult<PathBuf> {
let mut builder = Builder::new(); let mut builder = Builder::new();
builder.prefix(prefix).rand_bytes(rand).suffix(suffix); builder.prefix(prefix).rand_bytes(rand).suffix(suffix);
@ -481,6 +492,12 @@ fn make_temp_dir(dir: &str, prefix: &str, rand: usize, suffix: &str) -> UResult<
fs::set_permissions(&path, fs::Permissions::from_mode(0o700))?; fs::set_permissions(&path, fs::Permissions::from_mode(0o700))?;
Ok(path) Ok(path)
} }
Err(e) if e.kind() == ErrorKind::NotFound => {
let filename = format!("{}{}{}", prefix, "X".repeat(rand), suffix);
let path = Path::new(dir).join(filename);
let s = path.display().to_string();
Err(MkTempError::NotFound("directory".to_string(), s).into())
}
Err(e) => Err(e.into()), Err(e) => Err(e.into()),
} }
} }
@ -494,7 +511,8 @@ fn make_temp_dir(dir: &str, prefix: &str, rand: usize, suffix: &str) -> UResult<
/// ///
/// # Errors /// # Errors
/// ///
/// If the file could not be written to disk. /// If the file could not be written to disk or if the directory does
/// not exist.
fn make_temp_file(dir: &str, prefix: &str, rand: usize, suffix: &str) -> UResult<PathBuf> { fn make_temp_file(dir: &str, prefix: &str, rand: usize, suffix: &str) -> UResult<PathBuf> {
let mut builder = Builder::new(); let mut builder = Builder::new();
builder.prefix(prefix).rand_bytes(rand).suffix(suffix); builder.prefix(prefix).rand_bytes(rand).suffix(suffix);
@ -504,6 +522,12 @@ fn make_temp_file(dir: &str, prefix: &str, rand: usize, suffix: &str) -> UResult
Ok((_, pathbuf)) => Ok(pathbuf), Ok((_, pathbuf)) => Ok(pathbuf),
Err(e) => Err(MkTempError::PersistError(e.file.path().to_path_buf()).into()), Err(e) => Err(MkTempError::PersistError(e.file.path().to_path_buf()).into()),
}, },
Err(e) if e.kind() == ErrorKind::NotFound => {
let filename = format!("{}{}{}", prefix, "X".repeat(rand), suffix);
let path = Path::new(dir).join(filename);
let s = path.display().to_string();
Err(MkTempError::NotFound("file".to_string(), s).into())
}
Err(e) => Err(e.into()), Err(e) => Err(e.into()),
} }
} }

View file

@ -739,3 +739,89 @@ fn test_tmpdir_env_var() {
assert_matches_template!(template, filename); assert_matches_template!(template, filename);
assert!(at.file_exists(filename)); assert!(at.file_exists(filename));
} }
#[test]
fn test_nonexistent_tmpdir_env_var() {
#[cfg(not(windows))]
new_ucmd!().env(TMPDIR, "no/such/dir").fails().stderr_only("mktemp: failed to create file via template 'no/such/dir/tmp.XXXXXXXXXX': No such file or directory\n");
#[cfg(windows)]
{
let result = new_ucmd!().env(TMPDIR, r"no\such\dir").fails();
result.no_stdout();
let stderr = result.stderr_str();
assert!(
stderr.starts_with("mktemp: failed to create file via template"),
"{}",
stderr
);
assert!(
stderr.ends_with("no\\such\\dir\\tmp.XXXXXXXXXX': No such file or directory\n"),
"{}",
stderr
);
}
#[cfg(not(windows))]
new_ucmd!().env(TMPDIR, "no/such/dir").arg("-d").fails().stderr_only("mktemp: failed to create directory via template 'no/such/dir/tmp.XXXXXXXXXX': No such file or directory\n");
#[cfg(windows)]
{
let result = new_ucmd!().env(TMPDIR, r"no\such\dir").arg("-d").fails();
result.no_stdout();
let stderr = result.stderr_str();
assert!(
stderr.starts_with("mktemp: failed to create directory via template"),
"{}",
stderr
);
assert!(
stderr.ends_with("no\\such\\dir\\tmp.XXXXXXXXXX': No such file or directory\n"),
"{}",
stderr
);
}
}
#[test]
fn test_nonexistent_dir_prefix() {
#[cfg(not(windows))]
new_ucmd!().arg("d/XXX").fails().stderr_only(
"mktemp: failed to create file via template 'd/XXX': No such file or directory\n",
);
#[cfg(windows)]
{
let result = new_ucmd!().arg(r"d\XXX").fails();
result.no_stdout();
let stderr = result.stderr_str();
assert!(
stderr.starts_with("mktemp: failed to create file via template"),
"{}",
stderr
);
assert!(
stderr.ends_with("d\\XXX': No such file or directory\n"),
"{}",
stderr
);
}
#[cfg(not(windows))]
new_ucmd!().arg("-d").arg("d/XXX").fails().stderr_only(
"mktemp: failed to create directory via template 'd/XXX': No such file or directory\n",
);
#[cfg(windows)]
{
let result = new_ucmd!().arg("-d").arg(r"d\XXX").fails();
result.no_stdout();
let stderr = result.stderr_str();
assert!(
stderr.starts_with("mktemp: failed to create directory via template"),
"{}",
stderr
);
assert!(
stderr.ends_with("d\\XXX': No such file or directory\n"),
"{}",
stderr
);
}
}