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.

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

mktemp: respect TMPDIR environment variable #3552

Merged
merged 1 commit into from
Sep 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 15 additions & 6 deletions src/uu/mktemp/src/mktemp.rs
Original file line number Diff line number Diff line change
Expand Up @@ -170,12 +170,21 @@ impl Options {
let template = matches.value_of(OPT_TMPDIR).unwrap().to_string();
(tmpdir, template)
} else {
let tmpdir = matches.value_of(OPT_TMPDIR).map(String::from);
let template = matches
.value_of(ARG_TEMPLATE)
.unwrap_or(DEFAULT_TEMPLATE)
.to_string();
(tmpdir, template)
// If no template argument is given, `--tmpdir` is implied.
match matches.value_of(ARG_TEMPLATE) {
None => {
let tmpdir = match matches.value_of(OPT_TMPDIR) {
None => Some(env::temp_dir().display().to_string()),
Some(tmpdir) => Some(tmpdir.to_string()),
};
let template = DEFAULT_TEMPLATE;
(tmpdir, template.to_string())
}
Some(template) => {
let tmpdir = matches.value_of(OPT_TMPDIR).map(String::from);
(tmpdir, template.to_string())
}
}
};
Self {
directory: matches.contains_id(OPT_DIRECTORY),
Expand Down
72 changes: 72 additions & 0 deletions tests/by-util/test_mktemp.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ use crate::common::util::*;
use uucore::display::Quotable;

use std::path::PathBuf;
#[cfg(not(windows))]
use std::path::MAIN_SEPARATOR;
use tempfile::tempdir;

#[cfg(unix)]
Expand Down Expand Up @@ -39,6 +41,22 @@ macro_rules! assert_matches_template {
}};
}

/// Like [`assert_matches_template`] but for the suffix of a string.
#[cfg(windows)]
macro_rules! assert_suffix_matches_template {
($template:expr, $s:expr) => {{
let n = ($s).len();
let m = ($template).len();
let suffix = &$s[n - m..n];
assert!(
matches_template($template, suffix),
"\"{}\" does not end with \"{}\"",
$template,
suffix
);
}};
}

#[test]
fn test_mktemp_mktemp() {
let scene = TestScenario::new(util_name!());
Expand Down Expand Up @@ -663,3 +681,57 @@ fn test_mktemp_with_posixly_correct() {
.args(&["--suffix=b", "aXXXX"])
.succeeds();
}

/// Test that files are created relative to `TMPDIR` environment variable.
#[test]
fn test_tmpdir_env_var() {
// `TMPDIR=. mktemp`
let (at, mut ucmd) = at_and_ucmd!();
let result = ucmd.env(TMPDIR, ".").succeeds();
let filename = result.no_stderr().stdout_str().trim_end();
#[cfg(not(windows))]
{
let template = format!(".{}tmp.XXXXXXXXXX", MAIN_SEPARATOR);
assert_matches_template!(&template, filename);
}
// On Windows, `env::temp_dir()` seems to give an absolute path
// regardless of the value of `TMPDIR`; see
// * https://github.com/uutils/coreutils/pull/3552#issuecomment-1211804981
// * https://doc.rust-lang.org/std/env/fn.temp_dir.html
// * https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-gettemppath2w
#[cfg(windows)]
assert_suffix_matches_template!("tmp.XXXXXXXXXX", filename);
assert!(at.file_exists(filename));

// FIXME This is not working because --tmpdir is configured to
// require a value.
//
// // `TMPDIR=. mktemp --tmpdir`
// let (at, mut ucmd) = at_and_ucmd!();
// let result = ucmd.env(TMPDIR, ".").arg("--tmpdir").succeeds();
// let filename = result.no_stderr().stdout_str().trim_end();
// let template = format!(".{}tmp.XXXXXXXXXX", MAIN_SEPARATOR);
// assert_matches_template!(&template, filename);
// assert!(at.file_exists(filename));

// `TMPDIR=. mktemp --tmpdir XXX`
let (at, mut ucmd) = at_and_ucmd!();
let result = ucmd.env(TMPDIR, ".").args(&["--tmpdir", "XXX"]).succeeds();
let filename = result.no_stderr().stdout_str().trim_end();
#[cfg(not(windows))]
{
let template = format!(".{}XXX", MAIN_SEPARATOR);
assert_matches_template!(&template, filename);
}
#[cfg(windows)]
assert_suffix_matches_template!("XXX", filename);
assert!(at.file_exists(filename));

// `TMPDIR=. mktemp XXX` - in this case `TMPDIR` is ignored.
let (at, mut ucmd) = at_and_ucmd!();
let result = ucmd.env(TMPDIR, ".").arg("XXX").succeeds();
let filename = result.no_stderr().stdout_str().trim_end();
let template = "XXX";
assert_matches_template!(template, filename);
assert!(at.file_exists(filename));
}