mirror of
https://github.com/nushell/nushell.git
synced 2024-11-23 00:43:33 +01:00
bdb6daa4b5
This is the first PR towards migrating to a new `$env.PWD` API that returns potentially un-canonicalized paths. Refer to PR #12515 for motivations. ## New API: `EngineState::cwd()` The goal of the new API is to cover both parse-time and runtime use case, and avoid unintentional misuse. It takes an `Option<Stack>` as argument, which if supplied, will search for `$env.PWD` on the stack in additional to the engine state. I think with this design, there's less confusion over parse-time and runtime environments. If you have access to a stack, just supply it; otherwise supply `None`. ## Deprecation of other PWD-related APIs Other APIs are re-implemented using `EngineState::cwd()` and properly documented. They're marked deprecated, but their behavior is unchanged. Unused APIs are deleted, and code that accesses `$env.PWD` directly without using an API is rewritten. Deprecated APIs: * `EngineState::current_work_dir()` * `StateWorkingSet::get_cwd()` * `env::current_dir()` * `env::current_dir_str()` * `env::current_dir_const()` * `env::current_dir_str_const()` Other changes: * `EngineState::get_cwd()` (deleted) * `StateWorkingSet::list_env()` (deleted) * `repl::do_run_cmd()` (rewritten with `env::current_dir_str()`) ## `cd` and `pwd` now use logical paths by default This pulls the changes from PR #12515. It's currently somewhat broken because using non-canonicalized paths exposed a bug in our path normalization logic (Issue #12602). Once that is fixed, this should work. ## Future plans This PR needs some tests. Which test helpers should I use, and where should I put those tests? I noticed that unquoted paths are expanded within `eval_filepath()` and `eval_directory()` before they even reach the `cd` command. This means every paths is expanded twice. Is this intended? Once this PR lands, the plan is to review all usages of the deprecated APIs and migrate them to `EngineState::cwd()`. In the meantime, these usages are annotated with `#[allow(deprecated)]` to avoid breaking CI. --------- Co-authored-by: Jakub Žádník <kubouch@gmail.com>
288 lines
6.7 KiB
Rust
288 lines
6.7 KiB
Rust
use nu_test_support::fs::Stub::EmptyFile;
|
|
use nu_test_support::nu;
|
|
use nu_test_support::playground::Playground;
|
|
use std::path::PathBuf;
|
|
|
|
#[test]
|
|
fn cd_works_with_in_var() {
|
|
Playground::setup("cd_test_1", |dirs, _| {
|
|
let actual = nu!(
|
|
cwd: dirs.root(),
|
|
r#"
|
|
"cd_test_1" | cd $in; $env.PWD | path split | last
|
|
"#
|
|
);
|
|
|
|
assert_eq!("cd_test_1", actual.out);
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn filesystem_change_from_current_directory_using_relative_path() {
|
|
Playground::setup("cd_test_1", |dirs, _| {
|
|
let actual = nu!( cwd: dirs.root(), "cd cd_test_1; $env.PWD");
|
|
|
|
assert_eq!(PathBuf::from(actual.out), *dirs.test());
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn filesystem_change_from_current_directory_using_absolute_path() {
|
|
Playground::setup("cd_test_2", |dirs, _| {
|
|
let actual = nu!(
|
|
cwd: dirs.test(),
|
|
r#"
|
|
cd '{}'
|
|
$env.PWD
|
|
"#,
|
|
dirs.formats().display()
|
|
);
|
|
|
|
assert_eq!(PathBuf::from(actual.out), dirs.formats());
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn filesystem_switch_back_to_previous_working_directory() {
|
|
Playground::setup("cd_test_3", |dirs, sandbox| {
|
|
sandbox.mkdir("odin");
|
|
|
|
let actual = nu!(
|
|
cwd: dirs.test().join("odin"),
|
|
"
|
|
cd {}
|
|
cd -
|
|
$env.PWD
|
|
",
|
|
dirs.test().display()
|
|
);
|
|
|
|
assert_eq!(PathBuf::from(actual.out), dirs.test().join("odin"));
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn filesystem_change_from_current_directory_using_relative_path_and_dash() {
|
|
Playground::setup("cd_test_4", |dirs, sandbox| {
|
|
sandbox.within("odin").mkdir("-");
|
|
|
|
let actual = nu!(
|
|
cwd: dirs.test(),
|
|
"
|
|
cd odin/-
|
|
$env.PWD
|
|
"
|
|
);
|
|
|
|
assert_eq!(
|
|
PathBuf::from(actual.out),
|
|
dirs.test().join("odin").join("-")
|
|
);
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn filesystem_change_current_directory_to_parent_directory() {
|
|
Playground::setup("cd_test_5", |dirs, _| {
|
|
let actual = nu!(
|
|
cwd: dirs.test(),
|
|
"
|
|
cd ..
|
|
$env.PWD
|
|
"
|
|
);
|
|
|
|
assert_eq!(PathBuf::from(actual.out), *dirs.root());
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn filesystem_change_current_directory_to_two_parents_up_using_multiple_dots() {
|
|
Playground::setup("cd_test_6", |dirs, sandbox| {
|
|
sandbox.within("foo").mkdir("bar");
|
|
|
|
let actual = nu!(
|
|
cwd: dirs.test().join("foo/bar"),
|
|
"
|
|
cd ...
|
|
$env.PWD
|
|
"
|
|
);
|
|
|
|
assert_eq!(PathBuf::from(actual.out), *dirs.test());
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn filesystem_change_to_home_directory() {
|
|
Playground::setup("cd_test_8", |dirs, _| {
|
|
let actual = nu!(
|
|
cwd: dirs.test(),
|
|
"
|
|
cd ~
|
|
$env.PWD
|
|
"
|
|
);
|
|
|
|
assert_eq!(Some(PathBuf::from(actual.out)), dirs_next::home_dir());
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn filesystem_change_to_a_directory_containing_spaces() {
|
|
Playground::setup("cd_test_9", |dirs, sandbox| {
|
|
sandbox.mkdir("robalino turner katz");
|
|
|
|
let actual = nu!(
|
|
cwd: dirs.test(),
|
|
r#"
|
|
cd "robalino turner katz"
|
|
$env.PWD
|
|
"#
|
|
);
|
|
|
|
assert_eq!(
|
|
PathBuf::from(actual.out),
|
|
dirs.test().join("robalino turner katz")
|
|
);
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn filesystem_not_a_directory() {
|
|
Playground::setup("cd_test_10", |dirs, sandbox| {
|
|
sandbox.with_files(vec![EmptyFile("ferris_did_it.txt")]);
|
|
|
|
let actual = nu!(
|
|
cwd: dirs.test(),
|
|
"cd ferris_did_it.txt"
|
|
);
|
|
|
|
assert!(
|
|
actual.err.contains("ferris_did_it.txt"),
|
|
"actual={:?}",
|
|
actual.err
|
|
);
|
|
assert!(
|
|
actual.err.contains("is not a directory"),
|
|
"actual={:?}",
|
|
actual.err
|
|
);
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn filesystem_directory_not_found() {
|
|
Playground::setup("cd_test_11", |dirs, _| {
|
|
let actual = nu!(
|
|
cwd: dirs.test(),
|
|
"cd dir_that_does_not_exist"
|
|
|
|
);
|
|
|
|
assert!(
|
|
actual.err.contains("dir_that_does_not_exist"),
|
|
"actual={:?}",
|
|
actual.err
|
|
);
|
|
assert!(
|
|
actual.err.contains("directory not found"),
|
|
"actual={:?}",
|
|
actual.err
|
|
);
|
|
})
|
|
}
|
|
|
|
#[test]
|
|
fn filesystem_change_directory_to_symlink_relative() {
|
|
Playground::setup("cd_test_12", |dirs, sandbox| {
|
|
sandbox.mkdir("foo");
|
|
sandbox.mkdir("boo");
|
|
sandbox.symlink("foo", "foo_link");
|
|
|
|
let actual = nu!(
|
|
cwd: dirs.test().join("boo"),
|
|
"
|
|
cd ../foo_link
|
|
$env.PWD
|
|
"
|
|
);
|
|
assert_eq!(PathBuf::from(actual.out), dirs.test().join("foo_link"));
|
|
|
|
let actual = nu!(
|
|
cwd: dirs.test().join("boo"),
|
|
"
|
|
cd -P ../foo_link
|
|
$env.PWD
|
|
"
|
|
);
|
|
assert_eq!(PathBuf::from(actual.out), dirs.test().join("foo"));
|
|
})
|
|
}
|
|
|
|
// FIXME: jt: needs more work
|
|
#[ignore]
|
|
#[cfg(target_os = "windows")]
|
|
#[test]
|
|
fn test_change_windows_drive() {
|
|
Playground::setup("cd_test_20", |dirs, sandbox| {
|
|
sandbox.mkdir("test_folder");
|
|
|
|
let _actual = nu!(
|
|
cwd: dirs.test(),
|
|
r#"
|
|
subst Z: test_folder
|
|
Z:
|
|
echo "some text" | save test_file.txt
|
|
cd ~
|
|
subst Z: /d
|
|
"#
|
|
);
|
|
assert!(dirs
|
|
.test()
|
|
.join("test_folder")
|
|
.join("test_file.txt")
|
|
.exists());
|
|
})
|
|
}
|
|
|
|
#[cfg(unix)]
|
|
#[test]
|
|
fn cd_permission_denied_folder() {
|
|
Playground::setup("cd_test_21", |dirs, sandbox| {
|
|
sandbox.mkdir("banned");
|
|
let actual = nu!(
|
|
cwd: dirs.test(),
|
|
"
|
|
chmod -x banned
|
|
cd banned
|
|
"
|
|
);
|
|
assert!(actual.err.contains("Cannot change directory to"));
|
|
nu!(
|
|
cwd: dirs.test(),
|
|
"
|
|
chmod +x banned
|
|
rm banned
|
|
"
|
|
);
|
|
});
|
|
}
|
|
// FIXME: cd_permission_denied_folder on windows
|
|
#[ignore]
|
|
#[cfg(windows)]
|
|
#[test]
|
|
fn cd_permission_denied_folder() {
|
|
Playground::setup("cd_test_21", |dirs, sandbox| {
|
|
sandbox.mkdir("banned");
|
|
let actual = nu!(
|
|
cwd: dirs.test(),
|
|
r"
|
|
icacls banned /deny BUILTIN\Administrators:F
|
|
cd banned
|
|
"
|
|
);
|
|
assert!(actual.err.contains("Folder is not able to read"));
|
|
});
|
|
}
|