Path migration part 2: nu-test-support (#13329)

# Description
Part 2 of replacing `std::path` types with `nu_path` types added in
#13115. This PR targets `nu-test-support`.
This commit is contained in:
Ian Manske 2024-07-12 02:43:10 +00:00 committed by GitHub
parent 4bd87d0496
commit d56457d63e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
17 changed files with 142 additions and 338 deletions

View File

@ -721,7 +721,7 @@ fn file_completion_quoted() {
"`te#st.txt`".to_string(), "`te#st.txt`".to_string(),
"`te'st.txt`".to_string(), "`te'st.txt`".to_string(),
"`te(st).txt`".to_string(), "`te(st).txt`".to_string(),
format!("`{}`", folder("test dir".into())), format!("`{}`", folder("test dir")),
]; ];
match_suggestions(expected_paths, suggestions); match_suggestions(expected_paths, suggestions);

View File

@ -1,5 +1,6 @@
use nu_engine::eval_block; use nu_engine::eval_block;
use nu_parser::parse; use nu_parser::parse;
use nu_path::{AbsolutePathBuf, PathBuf};
use nu_protocol::{ use nu_protocol::{
debugger::WithoutDebug, debugger::WithoutDebug,
engine::{EngineState, Stack, StateWorkingSet}, engine::{EngineState, Stack, StateWorkingSet},
@ -7,14 +8,14 @@ use nu_protocol::{
}; };
use nu_test_support::fs; use nu_test_support::fs;
use reedline::Suggestion; use reedline::Suggestion;
use std::path::{PathBuf, MAIN_SEPARATOR}; use std::path::MAIN_SEPARATOR;
fn create_default_context() -> EngineState { fn create_default_context() -> EngineState {
nu_command::add_shell_command_context(nu_cmd_lang::create_default_context()) nu_command::add_shell_command_context(nu_cmd_lang::create_default_context())
} }
// creates a new engine with the current path into the completions fixtures folder // creates a new engine with the current path into the completions fixtures folder
pub fn new_engine() -> (PathBuf, String, EngineState, Stack) { pub fn new_engine() -> (AbsolutePathBuf, String, EngineState, Stack) {
// Target folder inside assets // Target folder inside assets
let dir = fs::fixtures().join("completions"); let dir = fs::fixtures().join("completions");
let dir_str = dir let dir_str = dir
@ -69,7 +70,7 @@ pub fn new_engine() -> (PathBuf, String, EngineState, Stack) {
} }
// creates a new engine with the current path into the completions fixtures folder // creates a new engine with the current path into the completions fixtures folder
pub fn new_dotnu_engine() -> (PathBuf, String, EngineState, Stack) { pub fn new_dotnu_engine() -> (AbsolutePathBuf, String, EngineState, Stack) {
// Target folder inside assets // Target folder inside assets
let dir = fs::fixtures().join("dotnu_completions"); let dir = fs::fixtures().join("dotnu_completions");
let dir_str = dir let dir_str = dir
@ -114,7 +115,7 @@ pub fn new_dotnu_engine() -> (PathBuf, String, EngineState, Stack) {
(dir, dir_str, engine_state, stack) (dir, dir_str, engine_state, stack)
} }
pub fn new_quote_engine() -> (PathBuf, String, EngineState, Stack) { pub fn new_quote_engine() -> (AbsolutePathBuf, String, EngineState, Stack) {
// Target folder inside assets // Target folder inside assets
let dir = fs::fixtures().join("quoted_completions"); let dir = fs::fixtures().join("quoted_completions");
let dir_str = dir let dir_str = dir
@ -149,7 +150,7 @@ pub fn new_quote_engine() -> (PathBuf, String, EngineState, Stack) {
(dir, dir_str, engine_state, stack) (dir, dir_str, engine_state, stack)
} }
pub fn new_partial_engine() -> (PathBuf, String, EngineState, Stack) { pub fn new_partial_engine() -> (AbsolutePathBuf, String, EngineState, Stack) {
// Target folder inside assets // Target folder inside assets
let dir = fs::fixtures().join("partial_completions"); let dir = fs::fixtures().join("partial_completions");
let dir_str = dir let dir_str = dir
@ -205,16 +206,15 @@ pub fn match_suggestions(expected: Vec<String>, suggestions: Vec<Suggestion>) {
} }
// append the separator to the converted path // append the separator to the converted path
pub fn folder(path: PathBuf) -> String { pub fn folder(path: impl Into<PathBuf>) -> String {
let mut converted_path = file(path); let mut converted_path = file(path);
converted_path.push(MAIN_SEPARATOR); converted_path.push(MAIN_SEPARATOR);
converted_path converted_path
} }
// convert a given path to string // convert a given path to string
pub fn file(path: PathBuf) -> String { pub fn file(path: impl Into<PathBuf>) -> String {
path.into_os_string().into_string().unwrap_or_default() path.into().into_os_string().into_string().unwrap()
} }
// merge_input executes the given input into the engine // merge_input executes the given input into the engine
@ -223,7 +223,7 @@ pub fn merge_input(
input: &[u8], input: &[u8],
engine_state: &mut EngineState, engine_state: &mut EngineState,
stack: &mut Stack, stack: &mut Stack,
dir: PathBuf, dir: AbsolutePathBuf,
) -> Result<(), ShellError> { ) -> Result<(), ShellError> {
let (block, delta) = { let (block, delta) = {
let mut working_set = StateWorkingSet::new(engine_state); let mut working_set = StateWorkingSet::new(engine_state);

View File

@ -580,7 +580,7 @@ mod test {
Playground::setup("test_expand_glob", |dirs, play| { Playground::setup("test_expand_glob", |dirs, play| {
play.with_files(&[Stub::EmptyFile("a.txt"), Stub::EmptyFile("b.txt")]); play.with_files(&[Stub::EmptyFile("a.txt"), Stub::EmptyFile("b.txt")]);
let cwd = dirs.test(); let cwd = dirs.test().as_std_path();
let actual = expand_glob("*.txt", cwd, Span::unknown(), &Signals::empty()).unwrap(); let actual = expand_glob("*.txt", cwd, Span::unknown(), &Signals::empty()).unwrap();
let expected = &["a.txt", "b.txt"]; let expected = &["a.txt", "b.txt"];

View File

@ -465,7 +465,7 @@ fn make_sqlite_db(dirs: &Dirs, nu_table: &str) -> PathBuf {
); );
assert!(nucmd.status.success()); assert!(nucmd.status.success());
testdb_path testdb_path.into()
} }
fn insert_test_rows(dirs: &Dirs, nu_table: &str, sql_query: Option<&str>, expected: Vec<TestRow>) { fn insert_test_rows(dirs: &Dirs, nu_table: &str, sql_query: Option<&str>, expected: Vec<TestRow>) {

View File

@ -1,3 +1,4 @@
use nu_path::AbsolutePath;
use nu_test_support::fs::{files_exist_at, Stub::EmptyFile}; use nu_test_support::fs::{files_exist_at, Stub::EmptyFile};
use nu_test_support::nu; use nu_test_support::nu;
use nu_test_support::playground::Playground; use nu_test_support::playground::Playground;
@ -405,10 +406,10 @@ fn removes_file_after_cd() {
} }
struct Cleanup<'a> { struct Cleanup<'a> {
dir_to_clean: &'a Path, dir_to_clean: &'a AbsolutePath,
} }
fn set_dir_read_only(directory: &Path, read_only: bool) { fn set_dir_read_only(directory: &AbsolutePath, read_only: bool) {
let mut permissions = fs::metadata(directory).unwrap().permissions(); let mut permissions = fs::metadata(directory).unwrap().permissions();
permissions.set_readonly(read_only); permissions.set_readonly(read_only);
fs::set_permissions(directory, permissions).expect("failed to set directory permissions"); fs::set_permissions(directory, permissions).expect("failed to set directory permissions");

View File

@ -1,4 +1,3 @@
use nu_test_support::fs::AbsolutePath;
use nu_test_support::fs::Stub::{FileWithContent, FileWithContentToBeTrimmed}; use nu_test_support::fs::Stub::{FileWithContent, FileWithContentToBeTrimmed};
use nu_test_support::nu; use nu_test_support::nu;
use nu_test_support::pipeline; use nu_test_support::pipeline;
@ -8,17 +7,18 @@ use nu_test_support::playground::Playground;
#[test] #[test]
fn sources_also_files_under_custom_lib_dirs_path() { fn sources_also_files_under_custom_lib_dirs_path() {
Playground::setup("source_test_1", |dirs, nu| { Playground::setup("source_test_1", |dirs, nu| {
let file = AbsolutePath::new(dirs.test().join("config.toml")); let file = dirs.test().join("config.toml");
let library_path = AbsolutePath::new(dirs.test().join("lib")); let library_path = dirs.test().join("lib");
nu.with_config(&file); nu.with_config(file);
nu.with_files(&[FileWithContent( nu.with_files(&[FileWithContent(
"config.toml", "config.toml",
&format!( &format!(
r#" r#"
lib_dirs = ["{library_path}"] lib_dirs = ["{}"]
skip_welcome_message = true skip_welcome_message = true
"# "#,
library_path.as_os_str().to_str().unwrap(),
), ),
)]); )]);

View File

@ -1,6 +1,6 @@
use nu_test_support::fs::file_contents; use nu_test_support::fs::file_contents;
use nu_test_support::fs::{ use nu_test_support::fs::{
files_exist_at, AbsoluteFile, files_exist_at,
Stub::{EmptyFile, FileWithContent, FileWithPermission}, Stub::{EmptyFile, FileWithContent, FileWithPermission},
}; };
use nu_test_support::nu; use nu_test_support::nu;
@ -55,7 +55,7 @@ fn copies_the_file_inside_directory_if_path_to_copy_is_directory() {
fn copies_the_file_inside_directory_if_path_to_copy_is_directory_impl(progress: bool) { fn copies_the_file_inside_directory_if_path_to_copy_is_directory_impl(progress: bool) {
Playground::setup("ucp_test_2", |dirs, _| { Playground::setup("ucp_test_2", |dirs, _| {
let expected_file = AbsoluteFile::new(dirs.test().join("sample.ini")); let expected_file = dirs.test().join("sample.ini");
let progress_flag = if progress { "-p" } else { "" }; let progress_flag = if progress { "-p" } else { "" };
// Get the hash of the file content to check integrity after copy. // Get the hash of the file content to check integrity after copy.
@ -64,13 +64,13 @@ fn copies_the_file_inside_directory_if_path_to_copy_is_directory_impl(progress:
cwd: dirs.formats(), cwd: dirs.formats(),
"cp {} ../formats/sample.ini {}", "cp {} ../formats/sample.ini {}",
progress_flag, progress_flag,
expected_file.dir() expected_file.parent().unwrap().as_os_str().to_str().unwrap(),
); );
assert!(dirs.test().join("sample.ini").exists()); assert!(dirs.test().join("sample.ini").exists());
// Check the integrity of the file. // Check the integrity of the file.
let after_cp_hash = get_file_hash(expected_file); let after_cp_hash = get_file_hash(expected_file.display());
assert_eq!(first_hash, after_cp_hash); assert_eq!(first_hash, after_cp_hash);
}) })
} }

View File

@ -1,4 +1,3 @@
use nu_test_support::fs::AbsolutePath;
use nu_test_support::fs::Stub::{FileWithContent, FileWithContentToBeTrimmed}; use nu_test_support::fs::Stub::{FileWithContent, FileWithContentToBeTrimmed};
use nu_test_support::nu; use nu_test_support::nu;
use nu_test_support::pipeline; use nu_test_support::pipeline;
@ -7,10 +6,10 @@ use nu_test_support::playground::Playground;
#[test] #[test]
fn use_module_file_within_block() { fn use_module_file_within_block() {
Playground::setup("use_test_1", |dirs, nu| { Playground::setup("use_test_1", |dirs, nu| {
let file = AbsolutePath::new(dirs.test().join("spam.nu")); let file = dirs.test().join("spam.nu");
nu.with_files(&[FileWithContent( nu.with_files(&[FileWithContent(
&file.to_string(), file.as_os_str().to_str().unwrap(),
r#" r#"
export def foo [] { export def foo [] {
echo "hello world" echo "hello world"
@ -37,10 +36,10 @@ fn use_module_file_within_block() {
#[test] #[test]
fn use_keeps_doc_comments() { fn use_keeps_doc_comments() {
Playground::setup("use_doc_comments", |dirs, nu| { Playground::setup("use_doc_comments", |dirs, nu| {
let file = AbsolutePath::new(dirs.test().join("spam.nu")); let file = dirs.test().join("spam.nu");
nu.with_files(&[FileWithContent( nu.with_files(&[FileWithContent(
&file.to_string(), file.as_os_str().to_str().unwrap(),
r#" r#"
# this is my foo command # this is my foo command
export def foo [ export def foo [

View File

@ -1,137 +1,5 @@
use std::fmt::Display; use nu_path::{AbsolutePath, AbsolutePathBuf, Path};
use std::io::Read; use std::io::Read;
use std::ops::Div;
use std::path::{Path, PathBuf};
pub struct AbsoluteFile {
inner: PathBuf,
}
impl AbsoluteFile {
pub fn new(path: impl AsRef<Path>) -> AbsoluteFile {
let path = path.as_ref();
if !path.is_absolute() {
panic!(
"AbsoluteFile::new must take an absolute path :: {}",
path.display()
)
} else if path.is_dir() {
// At the moment, this is not an invariant, but rather a way to catch bugs
// in tests.
panic!(
"AbsoluteFile::new must not take a directory :: {}",
path.display()
)
} else {
AbsoluteFile {
inner: path.to_path_buf(),
}
}
}
pub fn dir(&self) -> AbsolutePath {
AbsolutePath::new(if let Some(parent) = self.inner.parent() {
parent
} else {
unreachable!("Internal error: could not get parent in dir")
})
}
}
impl From<AbsoluteFile> for PathBuf {
fn from(file: AbsoluteFile) -> Self {
file.inner
}
}
pub struct AbsolutePath {
pub inner: PathBuf,
}
impl AbsolutePath {
pub fn new(path: impl AsRef<Path>) -> AbsolutePath {
let path = path.as_ref();
if path.is_absolute() {
AbsolutePath {
inner: path.to_path_buf(),
}
} else {
panic!("AbsolutePath::new must take an absolute path")
}
}
}
impl Div<&str> for &AbsolutePath {
type Output = AbsolutePath;
fn div(self, rhs: &str) -> Self::Output {
let parts = rhs.split('/');
let mut result = self.inner.clone();
for part in parts {
result = result.join(part);
}
AbsolutePath::new(result)
}
}
impl AsRef<Path> for AbsolutePath {
fn as_ref(&self) -> &Path {
self.inner.as_path()
}
}
pub struct RelativePath {
inner: PathBuf,
}
impl RelativePath {
pub fn new(path: impl Into<PathBuf>) -> RelativePath {
let path = path.into();
if path.is_relative() {
RelativePath { inner: path }
} else {
panic!("RelativePath::new must take a relative path")
}
}
}
impl<T: AsRef<str>> Div<T> for &RelativePath {
type Output = RelativePath;
fn div(self, rhs: T) -> Self::Output {
let parts = rhs.as_ref().split('/');
let mut result = self.inner.clone();
for part in parts {
result = result.join(part);
}
RelativePath::new(result)
}
}
impl Display for AbsoluteFile {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.inner.display())
}
}
impl Display for AbsolutePath {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.inner.display())
}
}
impl Display for RelativePath {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{}", self.inner.display())
}
}
pub enum Stub<'a> { pub enum Stub<'a> {
FileWithContent(&'a str, &'a str), FileWithContent(&'a str, &'a str),
@ -140,7 +8,7 @@ pub enum Stub<'a> {
FileWithPermission(&'a str, bool), FileWithPermission(&'a str, bool),
} }
pub fn file_contents(full_path: impl AsRef<Path>) -> String { pub fn file_contents(full_path: impl AsRef<AbsolutePath>) -> String {
let mut file = std::fs::File::open(full_path.as_ref()).expect("can not open file"); let mut file = std::fs::File::open(full_path.as_ref()).expect("can not open file");
let mut contents = String::new(); let mut contents = String::new();
file.read_to_string(&mut contents) file.read_to_string(&mut contents)
@ -148,7 +16,7 @@ pub fn file_contents(full_path: impl AsRef<Path>) -> String {
contents contents
} }
pub fn file_contents_binary(full_path: impl AsRef<Path>) -> Vec<u8> { pub fn file_contents_binary(full_path: impl AsRef<AbsolutePath>) -> Vec<u8> {
let mut file = std::fs::File::open(full_path.as_ref()).expect("can not open file"); let mut file = std::fs::File::open(full_path.as_ref()).expect("can not open file");
let mut contents = Vec::new(); let mut contents = Vec::new();
file.read_to_end(&mut contents).expect("can not read file"); file.read_to_end(&mut contents).expect("can not read file");
@ -167,56 +35,32 @@ pub fn line_ending() -> String {
} }
} }
pub fn delete_file_at(full_path: impl AsRef<Path>) { pub fn files_exist_at(files: Vec<impl AsRef<Path>>, path: impl AsRef<AbsolutePath>) -> bool {
let full_path = full_path.as_ref(); let path = path.as_ref();
files.iter().all(|f| path.join(f.as_ref()).exists())
if full_path.exists() {
std::fs::remove_file(full_path).expect("can not delete file");
}
} }
pub fn create_file_at(full_path: impl AsRef<Path>) -> Result<(), std::io::Error> { pub fn executable_path() -> AbsolutePathBuf {
let full_path = full_path.as_ref();
if full_path.parent().is_some() {
panic!("path exists");
}
std::fs::write(full_path, b"fake data")
}
pub fn copy_file_to(source: &str, destination: &str) {
std::fs::copy(source, destination).expect("can not copy file");
}
pub fn files_exist_at(files: Vec<impl AsRef<Path>>, path: impl AsRef<Path>) -> bool {
files.iter().all(|f| {
let mut loc = PathBuf::from(path.as_ref());
loc.push(f);
loc.exists()
})
}
pub fn delete_directory_at(full_path: &str) {
std::fs::remove_dir_all(PathBuf::from(full_path)).expect("can not remove directory");
}
pub fn executable_path() -> PathBuf {
let mut path = binaries(); let mut path = binaries();
path.push("nu"); path.push("nu");
path path
} }
pub fn installed_nu_path() -> PathBuf { pub fn installed_nu_path() -> AbsolutePathBuf {
let path = std::env::var_os(crate::NATIVE_PATH_ENV_VAR); let path = std::env::var_os(crate::NATIVE_PATH_ENV_VAR);
which::which_in("nu", path, ".").unwrap_or_else(|_| executable_path()) if let Ok(path) = which::which_in("nu", path, ".") {
AbsolutePathBuf::try_from(path).expect("installed nushell path is absolute")
} else {
executable_path()
}
} }
pub fn root() -> PathBuf { pub fn root() -> AbsolutePathBuf {
let manifest_dir = if let Ok(manifest_dir) = std::env::var("CARGO_MANIFEST_DIR") { let manifest_dir = if let Ok(manifest_dir) = std::env::var("CARGO_MANIFEST_DIR") {
PathBuf::from(manifest_dir) AbsolutePathBuf::try_from(manifest_dir).expect("CARGO_MANIFEST_DIR is not an absolute path")
} else { } else {
PathBuf::from(env!("CARGO_MANIFEST_DIR")) AbsolutePathBuf::try_from(env!("CARGO_MANIFEST_DIR"))
.expect("CARGO_MANIFEST_DIR is not an absolute path")
}; };
let test_path = manifest_dir.join("Cargo.lock"); let test_path = manifest_dir.join("Cargo.lock");
@ -228,11 +72,11 @@ pub fn root() -> PathBuf {
.expect("Couldn't find the debug binaries directory") .expect("Couldn't find the debug binaries directory")
.parent() .parent()
.expect("Couldn't find the debug binaries directory") .expect("Couldn't find the debug binaries directory")
.to_path_buf() .into()
} }
} }
pub fn binaries() -> PathBuf { pub fn binaries() -> AbsolutePathBuf {
let build_target = std::env::var("CARGO_BUILD_TARGET").unwrap_or_default(); let build_target = std::env::var("CARGO_BUILD_TARGET").unwrap_or_default();
let profile = if let Ok(env_profile) = std::env::var("NUSHELL_CARGO_PROFILE") { let profile = if let Ok(env_profile) = std::env::var("NUSHELL_CARGO_PROFILE") {
@ -244,27 +88,28 @@ pub fn binaries() -> PathBuf {
}; };
std::env::var("CARGO_TARGET_DIR") std::env::var("CARGO_TARGET_DIR")
.map(PathBuf::from) .ok()
.unwrap_or_else(|_| root().join("target")) .and_then(|p| AbsolutePathBuf::try_from(p).ok())
.unwrap_or_else(|| root().join("target"))
.join(build_target) .join(build_target)
.join(profile) .join(profile)
} }
pub fn fixtures() -> PathBuf { pub fn fixtures() -> AbsolutePathBuf {
root().join("tests").join("fixtures") let mut path = root();
path.push("tests");
path.push("fixtures");
path
} }
pub fn assets() -> PathBuf { // FIXME: re-enable nu_json tests
root().join("tests/assets") // pub fn assets() -> AbsolutePathBuf {
} // let mut path = root();
// path.push("tests");
// path.push("assets");
// path
// }
pub fn in_directory(str: impl AsRef<Path>) -> String { pub fn in_directory(path: impl AsRef<nu_path::Path>) -> AbsolutePathBuf {
let path = str.as_ref(); root().join(path)
let path = if path.is_relative() {
root().join(path)
} else {
path.to_path_buf()
};
path.display().to_string()
} }

View File

@ -234,16 +234,16 @@ macro_rules! nu_with_plugins {
} }
use crate::{Outcome, NATIVE_PATH_ENV_VAR}; use crate::{Outcome, NATIVE_PATH_ENV_VAR};
use std::ffi::OsStr; use nu_path::{AbsolutePath, AbsolutePathBuf, Path};
use std::{ use std::{
path::Path, ffi::OsStr,
process::{Command, Stdio}, process::{Command, Stdio},
}; };
use tempfile::tempdir; use tempfile::tempdir;
#[derive(Default)] #[derive(Default)]
pub struct NuOpts { pub struct NuOpts {
pub cwd: Option<String>, pub cwd: Option<AbsolutePathBuf>,
pub locale: Option<String>, pub locale: Option<String>,
pub envs: Option<Vec<(String, String)>>, pub envs: Option<Vec<(String, String)>>,
pub collapse_output: Option<bool>, pub collapse_output: Option<bool>,
@ -251,19 +251,12 @@ pub struct NuOpts {
} }
pub fn nu_run_test(opts: NuOpts, commands: impl AsRef<str>, with_std: bool) -> Outcome { pub fn nu_run_test(opts: NuOpts, commands: impl AsRef<str>, with_std: bool) -> Outcome {
let test_bins = crate::fs::binaries(); let test_bins = crate::fs::binaries()
.canonicalize()
let cwd = std::env::current_dir().expect("Could not get current working directory."); .expect("Could not canonicalize dummy binaries path");
let test_bins = nu_path::canonicalize_with(&test_bins, cwd).unwrap_or_else(|e| {
panic!(
"Couldn't canonicalize dummy binaries path {}: {:?}",
test_bins.display(),
e
)
});
let mut paths = crate::shell_os_paths(); let mut paths = crate::shell_os_paths();
paths.insert(0, test_bins); paths.insert(0, test_bins.into());
let commands = commands.as_ref().lines().collect::<Vec<_>>().join("; "); let commands = commands.as_ref().lines().collect::<Vec<_>>().join("; ");
@ -272,7 +265,7 @@ pub fn nu_run_test(opts: NuOpts, commands: impl AsRef<str>, with_std: bool) -> O
Err(_) => panic!("Couldn't join paths for PATH var."), Err(_) => panic!("Couldn't join paths for PATH var."),
}; };
let target_cwd = opts.cwd.unwrap_or(".".to_string()); let target_cwd = opts.cwd.unwrap_or_else(crate::fs::root);
let locale = opts.locale.unwrap_or("en_US.UTF-8".to_string()); let locale = opts.locale.unwrap_or("en_US.UTF-8".to_string());
let executable_path = crate::fs::executable_path(); let executable_path = crate::fs::executable_path();
@ -450,7 +443,7 @@ fn collapse_output(out: &str) -> String {
out.replace('\n', "") out.replace('\n', "")
} }
fn setup_command(executable_path: &Path, target_cwd: &str) -> Command { fn setup_command(executable_path: &AbsolutePath, target_cwd: &AbsolutePath) -> Command {
let mut command = Command::new(executable_path); let mut command = Command::new(executable_path);
command command

View File

@ -6,5 +6,5 @@ mod play;
mod tests; mod tests;
pub use director::Director; pub use director::Director;
pub use nu_process::{Executable, NuProcess, NuResult, Outcome}; pub use nu_process::{Executable, NuProcess, Outcome};
pub use play::{Dirs, EnvironmentVariable, Playground}; pub use play::{Dirs, EnvironmentVariable, Playground};

View File

@ -83,7 +83,7 @@ impl Director {
} }
impl Executable for Director { impl Executable for Director {
fn execute(&mut self) -> NuResult { fn execute(&mut self) -> Result<Outcome, NuError> {
use std::process::Stdio; use std::process::Stdio;
match self.executable() { match self.executable() {

View File

@ -1,12 +1,13 @@
use super::EnvironmentVariable; use super::EnvironmentVariable;
use crate::fs::{binaries as test_bins_path, executable_path}; use crate::fs::{binaries as test_bins_path, executable_path};
use std::ffi::{OsStr, OsString}; use std::{
use std::fmt; ffi::{OsStr, OsString},
use std::path::Path; fmt,
use std::process::{Command, ExitStatus}; process::{Command, ExitStatus},
};
pub trait Executable { pub trait Executable {
fn execute(&mut self) -> NuResult; fn execute(&mut self) -> Result<Outcome, NuError>;
} }
#[derive(Clone, Debug)] #[derive(Clone, Debug)]
@ -24,8 +25,6 @@ impl Outcome {
} }
} }
pub type NuResult = Result<Outcome, NuError>;
#[derive(Debug)] #[derive(Debug)]
pub struct NuError { pub struct NuError {
pub desc: String, pub desc: String,
@ -69,14 +68,10 @@ impl NuProcess {
self self
} }
pub fn get_cwd(&self) -> Option<&Path> {
self.cwd.as_ref().map(Path::new)
}
pub fn construct(&self) -> Command { pub fn construct(&self) -> Command {
let mut command = Command::new(executable_path()); let mut command = Command::new(executable_path());
if let Some(cwd) = self.get_cwd() { if let Some(cwd) = &self.cwd {
command.current_dir(cwd); command.current_dir(cwd);
} }

View File

@ -1,8 +1,9 @@
use super::Director; use super::Director;
use crate::fs; use crate::fs::{self, Stub};
use crate::fs::Stub;
use nu_glob::glob; use nu_glob::glob;
use std::path::{Path, PathBuf}; #[cfg(not(target_arch = "wasm32"))]
use nu_path::Path;
use nu_path::{AbsolutePath, AbsolutePathBuf};
use std::str; use std::str;
use tempfile::{tempdir, TempDir}; use tempfile::{tempdir, TempDir};
@ -22,46 +23,46 @@ impl EnvironmentVariable {
} }
pub struct Playground<'a> { pub struct Playground<'a> {
root: TempDir, _root: TempDir,
tests: String, tests: String,
cwd: PathBuf, cwd: AbsolutePathBuf,
config: Option<PathBuf>, config: Option<AbsolutePathBuf>,
environment_vars: Vec<EnvironmentVariable>, environment_vars: Vec<EnvironmentVariable>,
dirs: &'a Dirs, dirs: &'a Dirs,
} }
#[derive(Default, Clone)] #[derive(Clone)]
pub struct Dirs { pub struct Dirs {
pub root: PathBuf, pub root: AbsolutePathBuf,
pub test: PathBuf, pub test: AbsolutePathBuf,
pub fixtures: PathBuf, pub fixtures: AbsolutePathBuf,
} }
impl Dirs { impl Dirs {
pub fn formats(&self) -> PathBuf { pub fn formats(&self) -> AbsolutePathBuf {
self.fixtures.join("formats") self.fixtures.join("formats")
} }
pub fn root(&self) -> &Path { pub fn root(&self) -> &AbsolutePath {
self.root.as_path() &self.root
} }
pub fn test(&self) -> &Path { pub fn test(&self) -> &AbsolutePath {
self.test.as_path() &self.test
} }
} }
impl<'a> Playground<'a> { impl<'a> Playground<'a> {
pub fn root(&self) -> &Path { pub fn root(&self) -> &AbsolutePath {
self.root.path() &self.dirs.root
} }
pub fn cwd(&self) -> &Path { pub fn cwd(&self) -> &AbsolutePath {
&self.cwd &self.cwd
} }
pub fn back_to_playground(&mut self) -> &mut Self { pub fn back_to_playground(&mut self) -> &mut Self {
self.cwd = PathBuf::from(self.root()).join(self.tests.clone()); self.cwd = self.root().join(&self.tests);
self self
} }
@ -70,68 +71,46 @@ impl<'a> Playground<'a> {
} }
pub fn setup(topic: &str, block: impl FnOnce(Dirs, &mut Playground)) { pub fn setup(topic: &str, block: impl FnOnce(Dirs, &mut Playground)) {
let root = tempdir().expect("Couldn't create a tempdir"); let temp = tempdir().expect("Could not create a tempdir");
let nuplay_dir = root.path().join(topic);
if PathBuf::from(&nuplay_dir).exists() { let root = AbsolutePathBuf::try_from(temp.path())
std::fs::remove_dir_all(PathBuf::from(&nuplay_dir)).expect("can not remove directory"); .expect("Tempdir is not an absolute path")
.canonicalize()
.expect("Could not canonicalize tempdir");
let test = root.join(topic);
if test.exists() {
std::fs::remove_dir_all(&test).expect("Could not remove directory");
} }
std::fs::create_dir(&test).expect("Could not create directory");
let test = test
.canonicalize()
.expect("Could not canonicalize test path");
std::fs::create_dir(PathBuf::from(&nuplay_dir)).expect("can not create directory"); let fixtures = fs::fixtures()
.canonicalize()
let fixtures = fs::fixtures(); .expect("Could not canonicalize fixtures path");
let cwd = std::env::current_dir().expect("Could not get current working directory.");
let fixtures = nu_path::canonicalize_with(fixtures.clone(), cwd).unwrap_or_else(|e| {
panic!(
"Couldn't canonicalize fixtures path {}: {:?}",
fixtures.display(),
e
)
});
let mut playground = Playground {
root,
tests: topic.to_string(),
cwd: nuplay_dir,
config: None,
environment_vars: Vec::default(),
dirs: &Dirs::default(),
};
let playground_root = playground.root.path();
let cwd = std::env::current_dir().expect("Could not get current working directory.");
let test =
nu_path::canonicalize_with(playground_root.join(topic), cwd).unwrap_or_else(|e| {
panic!(
"Couldn't canonicalize test path {}: {:?}",
playground_root.join(topic).display(),
e
)
});
let cwd = std::env::current_dir().expect("Could not get current working directory.");
let root = nu_path::canonicalize_with(playground_root, cwd).unwrap_or_else(|e| {
panic!(
"Couldn't canonicalize tests root path {}: {:?}",
playground_root.display(),
e
)
});
let dirs = Dirs { let dirs = Dirs {
root, root: root.into(),
test, test: test.as_path().into(),
fixtures, fixtures: fixtures.into(),
}; };
playground.dirs = &dirs; let mut playground = Playground {
_root: temp,
tests: topic.to_string(),
cwd: test.into(),
config: None,
environment_vars: Vec::default(),
dirs: &dirs,
};
block(dirs.clone(), &mut playground); block(dirs.clone(), &mut playground);
} }
pub fn with_config(&mut self, source_file: impl AsRef<Path>) -> &mut Self { pub fn with_config(&mut self, source_file: AbsolutePathBuf) -> &mut Self {
self.config = Some(source_file.as_ref().to_path_buf()); self.config = Some(source_file);
self self
} }
@ -205,7 +184,6 @@ impl<'a> Playground<'a> {
files files
.iter() .iter()
.map(|f| { .map(|f| {
let mut path = PathBuf::from(&self.cwd);
let mut permission_set = false; let mut permission_set = false;
let mut write_able = true; let mut write_able = true;
let (file_name, contents) = match *f { let (file_name, contents) = match *f {
@ -227,7 +205,7 @@ impl<'a> Playground<'a> {
} }
}; };
path.push(file_name); let path = self.cwd.join(file_name);
std::fs::write(&path, contents.as_bytes()).expect("can not create file"); std::fs::write(&path, contents.as_bytes()).expect("can not create file");
if permission_set { if permission_set {
@ -252,7 +230,7 @@ impl<'a> Playground<'a> {
self self
} }
pub fn glob_vec(pattern: &str) -> Vec<PathBuf> { pub fn glob_vec(pattern: &str) -> Vec<std::path::PathBuf> {
let glob = glob(pattern); let glob = glob(pattern);
glob.expect("invalid pattern") glob.expect("invalid pattern")

View File

@ -1,11 +1,4 @@
use crate::playground::Playground; use crate::playground::Playground;
use std::path::{Path, PathBuf};
fn path(p: &Path) -> PathBuf {
let cwd = std::env::current_dir().expect("Could not get current working directory.");
nu_path::canonicalize_with(p, cwd)
.unwrap_or_else(|e| panic!("Couldn't canonicalize path {}: {:?}", p.display(), e))
}
#[test] #[test]
fn current_working_directory_in_sandbox_directory_created() { fn current_working_directory_in_sandbox_directory_created() {
@ -13,7 +6,7 @@ fn current_working_directory_in_sandbox_directory_created() {
let original_cwd = dirs.test(); let original_cwd = dirs.test();
nu.within("some_directory_within"); nu.within("some_directory_within");
assert_eq!(path(nu.cwd()), original_cwd.join("some_directory_within")); assert_eq!(nu.cwd(), original_cwd.join("some_directory_within"));
}) })
} }
@ -25,6 +18,6 @@ fn current_working_directory_back_to_root_from_anywhere() {
nu.within("some_directory_within"); nu.within("some_directory_within");
nu.back_to_playground(); nu.back_to_playground();
assert_eq!(path(nu.cwd()), *original_cwd); assert_eq!(nu.cwd(), original_cwd);
}) })
} }

View File

@ -4,7 +4,7 @@ use assert_cmd::Command;
fn call() { fn call() {
// Add the `nu` binaries to the path env // Add the `nu` binaries to the path env
let path_env = std::env::join_paths( let path_env = std::env::join_paths(
std::iter::once(nu_test_support::fs::binaries()).chain( std::iter::once(nu_test_support::fs::binaries().into()).chain(
std::env::var_os(nu_test_support::NATIVE_PATH_ENV_VAR) std::env::var_os(nu_test_support::NATIVE_PATH_ENV_VAR)
.as_deref() .as_deref()
.map(std::env::split_paths) .map(std::env::split_paths)

View File

@ -162,7 +162,7 @@ fn plugin_rm_then_restart_nu() {
contents.upsert_plugin(PluginRegistryItem { contents.upsert_plugin(PluginRegistryItem {
name: "foo".into(), name: "foo".into(),
// this doesn't exist, but it should be ok // this doesn't exist, but it should be ok
filename: dirs.test().join("nu_plugin_foo"), filename: dirs.test().join("nu_plugin_foo").into(),
shell: None, shell: None,
data: valid_plugin_item_data(), data: valid_plugin_item_data(),
}); });
@ -238,7 +238,7 @@ fn plugin_rm_from_custom_path() {
contents.upsert_plugin(PluginRegistryItem { contents.upsert_plugin(PluginRegistryItem {
name: "foo".into(), name: "foo".into(),
// this doesn't exist, but it should be ok // this doesn't exist, but it should be ok
filename: dirs.test().join("nu_plugin_foo"), filename: dirs.test().join("nu_plugin_foo").into(),
shell: None, shell: None,
data: valid_plugin_item_data(), data: valid_plugin_item_data(),
}); });
@ -286,7 +286,7 @@ fn plugin_rm_using_filename() {
contents.upsert_plugin(PluginRegistryItem { contents.upsert_plugin(PluginRegistryItem {
name: "foo".into(), name: "foo".into(),
// this doesn't exist, but it should be ok // this doesn't exist, but it should be ok
filename: dirs.test().join("nu_plugin_foo"), filename: dirs.test().join("nu_plugin_foo").into(),
shell: None, shell: None,
data: valid_plugin_item_data(), data: valid_plugin_item_data(),
}); });
@ -344,7 +344,7 @@ fn warning_on_invalid_plugin_item() {
contents.upsert_plugin(PluginRegistryItem { contents.upsert_plugin(PluginRegistryItem {
name: "badtest".into(), name: "badtest".into(),
// this doesn't exist, but it should be ok // this doesn't exist, but it should be ok
filename: dirs.test().join("nu_plugin_badtest"), filename: dirs.test().join("nu_plugin_badtest").into(),
shell: None, shell: None,
data: PluginRegistryItemData::Invalid, data: PluginRegistryItemData::Invalid,
}); });