Mirrors/nushell
2
0
Fork 0
mirror of https://github.com/nushell/nushell synced 2025-01-04 09:18:57 +00:00
Code Issues Projects Releases Packages Wiki Activity
nushell/crates/nu-command/tests/commands/source.rs

190 lines
5.4 KiB
Rust
Raw Normal View History

Allow custom lib dir path for sourcing nu script libraries. (#3940) Given we can write nu scripts. As the codebase grows, splitting into many smaller nu scripts is necessary. In general, when we work with paths and files we seem to face quite a few difficulties. Here we just tackle one of them and it involves sourcing files that also source other nu files and so forth. The current working directory becomes important here and being on a different directory when sourcing scripts will not work. Mostly because we expand the path on the current working directory and parse the files when a source command call is done. For the moment, we introduce a `lib_dirs` configuration value and, unfortunately, introduce a new dependency in `nu-parser` (`nu-data`) to get a handle of the configuration file to retrieve it. This should give clues and ideas as the new parser engine continues (introduce a way to also know paths) With this PR we can do the following: Let's assume we want to write a nu library called `my_library`. We will have the code in a directory called `project`: The file structure will looks like this: ``` project/my_library.nu project/my_library/hello.nu project/my_library/name.nu ``` This "pattern" works well, that is, when creating a library have a directory named `my_library` and next to it a `my_library.nu` file. Filling them like this: ``` source my_library/hello.nu source my_library/name.nu ``` ``` def hello [] { "hello world" } ``` ``` def name [] { "Nu" end ``` Assuming this `project` directory is stored at `/path/to/lib/project`, we can do: ``` config set lib_dirs ['path/to/lib/project'] ``` Given we have this `lib_dirs` configuration value, we can be anywhere while using Nu and do the following: ``` source my_library.nu echo (hello) (name) ```
2021-08-26 07:04:04 +00:00
use nu_test_support::fs::{AbsolutePath, DisplayPath, Stub::FileWithContent};
Allow `source` to accept paths with emojis (#3939) * Allow sourcing paths with emojis * Add source command tests for emoji paths * Fmt * Disable source tests on Windows with illegal paths * Test sourcing also ASCII and single-quoted paths
2021-08-19 07:06:18 +00:00
use nu_test_support::nu;
engine-q merge
2022-02-07 19:11:34 +00:00
<<<<<<< HEAD
Allow custom lib dir path for sourcing nu script libraries. (#3940) Given we can write nu scripts. As the codebase grows, splitting into many smaller nu scripts is necessary. In general, when we work with paths and files we seem to face quite a few difficulties. Here we just tackle one of them and it involves sourcing files that also source other nu files and so forth. The current working directory becomes important here and being on a different directory when sourcing scripts will not work. Mostly because we expand the path on the current working directory and parse the files when a source command call is done. For the moment, we introduce a `lib_dirs` configuration value and, unfortunately, introduce a new dependency in `nu-parser` (`nu-data`) to get a handle of the configuration file to retrieve it. This should give clues and ideas as the new parser engine continues (introduce a way to also know paths) With this PR we can do the following: Let's assume we want to write a nu library called `my_library`. We will have the code in a directory called `project`: The file structure will looks like this: ``` project/my_library.nu project/my_library/hello.nu project/my_library/name.nu ``` This "pattern" works well, that is, when creating a library have a directory named `my_library` and next to it a `my_library.nu` file. Filling them like this: ``` source my_library/hello.nu source my_library/name.nu ``` ``` def hello [] { "hello world" } ``` ``` def name [] { "Nu" end ``` Assuming this `project` directory is stored at `/path/to/lib/project`, we can do: ``` config set lib_dirs ['path/to/lib/project'] ``` Given we have this `lib_dirs` configuration value, we can be anywhere while using Nu and do the following: ``` source my_library.nu echo (hello) (name) ```
2021-08-26 07:04:04 +00:00
use nu_test_support::pipeline as input;
use nu_test_support::playground::{says, Playground};
use hamcrest2::assert_that;
use hamcrest2::prelude::*;
engine-q merge
2022-02-07 19:11:34 +00:00
=======
Command tests (#922) * WIP command tests * Finish marking todo tests * update * update * Windows cd test ignoring
2022-02-04 02:01:45 +00:00
use nu_test_support::pipeline;
use nu_test_support::playground::Playground;
engine-q merge
2022-02-07 19:11:34 +00:00
>>>>>>> 9259a56a28f1dd3a4b720ad815aa19c6eaf6adce
Allow custom lib dir path for sourcing nu script libraries. (#3940) Given we can write nu scripts. As the codebase grows, splitting into many smaller nu scripts is necessary. In general, when we work with paths and files we seem to face quite a few difficulties. Here we just tackle one of them and it involves sourcing files that also source other nu files and so forth. The current working directory becomes important here and being on a different directory when sourcing scripts will not work. Mostly because we expand the path on the current working directory and parse the files when a source command call is done. For the moment, we introduce a `lib_dirs` configuration value and, unfortunately, introduce a new dependency in `nu-parser` (`nu-data`) to get a handle of the configuration file to retrieve it. This should give clues and ideas as the new parser engine continues (introduce a way to also know paths) With this PR we can do the following: Let's assume we want to write a nu library called `my_library`. We will have the code in a directory called `project`: The file structure will looks like this: ``` project/my_library.nu project/my_library/hello.nu project/my_library/name.nu ``` This "pattern" works well, that is, when creating a library have a directory named `my_library` and next to it a `my_library.nu` file. Filling them like this: ``` source my_library/hello.nu source my_library/name.nu ``` ``` def hello [] { "hello world" } ``` ``` def name [] { "Nu" end ``` Assuming this `project` directory is stored at `/path/to/lib/project`, we can do: ``` config set lib_dirs ['path/to/lib/project'] ``` Given we have this `lib_dirs` configuration value, we can be anywhere while using Nu and do the following: ``` source my_library.nu echo (hello) (name) ```
2021-08-26 07:04:04 +00:00
#[should_panic]
#[test]
fn sources_also_files_under_custom_lib_dirs_path() {
Playground::setup("source_test_1", |dirs, nu| {
let file = AbsolutePath::new(dirs.test().join("config.toml"));
let library_path = AbsolutePath::new(dirs.test().join("lib"));
nu.with_config(&file);
nu.with_files(vec![FileWithContent(
"config.toml",
&format!(
r#"
lib_dirs = ["{}"]
skip_welcome_message = true
"#,
library_path.display_path()
),
)]);
nu.within("lib").with_files(vec![FileWithContent(
"my_library.nu",
r#"
source my_library/main.nu
"#,
)]);
nu.within("lib/my_library").with_files(vec![FileWithContent(
"main.nu",
r#"
def hello [] {
echo "hello nu"
}
"#,
)]);
engine-q merge
2022-02-07 19:11:34 +00:00
<<<<<<< HEAD
Allow custom lib dir path for sourcing nu script libraries. (#3940) Given we can write nu scripts. As the codebase grows, splitting into many smaller nu scripts is necessary. In general, when we work with paths and files we seem to face quite a few difficulties. Here we just tackle one of them and it involves sourcing files that also source other nu files and so forth. The current working directory becomes important here and being on a different directory when sourcing scripts will not work. Mostly because we expand the path on the current working directory and parse the files when a source command call is done. For the moment, we introduce a `lib_dirs` configuration value and, unfortunately, introduce a new dependency in `nu-parser` (`nu-data`) to get a handle of the configuration file to retrieve it. This should give clues and ideas as the new parser engine continues (introduce a way to also know paths) With this PR we can do the following: Let's assume we want to write a nu library called `my_library`. We will have the code in a directory called `project`: The file structure will looks like this: ``` project/my_library.nu project/my_library/hello.nu project/my_library/name.nu ``` This "pattern" works well, that is, when creating a library have a directory named `my_library` and next to it a `my_library.nu` file. Filling them like this: ``` source my_library/hello.nu source my_library/name.nu ``` ``` def hello [] { "hello world" } ``` ``` def name [] { "Nu" end ``` Assuming this `project` directory is stored at `/path/to/lib/project`, we can do: ``` config set lib_dirs ['path/to/lib/project'] ``` Given we have this `lib_dirs` configuration value, we can be anywhere while using Nu and do the following: ``` source my_library.nu echo (hello) (name) ```
2021-08-26 07:04:04 +00:00
assert_that!(
nu.pipeline(&input(
r#"
source my_library.nu ;
hello
"#,
)),
says().stdout("hello nu")
);
engine-q merge
2022-02-07 19:11:34 +00:00
=======
Command tests (#922) * WIP command tests * Finish marking todo tests * update * update * Windows cd test ignoring
2022-02-04 02:01:45 +00:00
let actual = nu!(
cwd: ".", pipeline(
r#"
source my_library.nu ;
hello
"#
));
assert_eq!(actual.out, "hello nu");
engine-q merge
2022-02-07 19:11:34 +00:00
>>>>>>> 9259a56a28f1dd3a4b720ad815aa19c6eaf6adce
Allow custom lib dir path for sourcing nu script libraries. (#3940) Given we can write nu scripts. As the codebase grows, splitting into many smaller nu scripts is necessary. In general, when we work with paths and files we seem to face quite a few difficulties. Here we just tackle one of them and it involves sourcing files that also source other nu files and so forth. The current working directory becomes important here and being on a different directory when sourcing scripts will not work. Mostly because we expand the path on the current working directory and parse the files when a source command call is done. For the moment, we introduce a `lib_dirs` configuration value and, unfortunately, introduce a new dependency in `nu-parser` (`nu-data`) to get a handle of the configuration file to retrieve it. This should give clues and ideas as the new parser engine continues (introduce a way to also know paths) With this PR we can do the following: Let's assume we want to write a nu library called `my_library`. We will have the code in a directory called `project`: The file structure will looks like this: ``` project/my_library.nu project/my_library/hello.nu project/my_library/name.nu ``` This "pattern" works well, that is, when creating a library have a directory named `my_library` and next to it a `my_library.nu` file. Filling them like this: ``` source my_library/hello.nu source my_library/name.nu ``` ``` def hello [] { "hello world" } ``` ``` def name [] { "Nu" end ``` Assuming this `project` directory is stored at `/path/to/lib/project`, we can do: ``` config set lib_dirs ['path/to/lib/project'] ``` Given we have this `lib_dirs` configuration value, we can be anywhere while using Nu and do the following: ``` source my_library.nu echo (hello) (name) ```
2021-08-26 07:04:04 +00:00
})
}
Allow `source` to accept paths with emojis (#3939) * Allow sourcing paths with emojis * Add source command tests for emoji paths * Fmt * Disable source tests on Windows with illegal paths * Test sourcing also ASCII and single-quoted paths
2021-08-19 07:06:18 +00:00
fn try_source_foo_with_double_quotes_in(testdir: &str, playdir: &str) {
Playground::setup(playdir, |dirs, sandbox| {
let testdir = String::from(testdir);
let mut foo_file = testdir.clone();
foo_file.push_str("/foo.nu");
sandbox.mkdir(&testdir);
sandbox.with_files(vec![FileWithContent(&foo_file, "echo foo")]);
let cmd = String::from("source ") + r#"""# + &foo_file + r#"""#;
let actual = nu!(cwd: dirs.test(), &cmd);
assert_eq!(actual.out, "foo");
});
}
fn try_source_foo_with_single_quotes_in(testdir: &str, playdir: &str) {
Playground::setup(playdir, |dirs, sandbox| {
let testdir = String::from(testdir);
let mut foo_file = testdir.clone();
foo_file.push_str("/foo.nu");
sandbox.mkdir(&testdir);
sandbox.with_files(vec![FileWithContent(&foo_file, "echo foo")]);
let cmd = String::from("source ") + r#"'"# + &foo_file + r#"'"#;
let actual = nu!(cwd: dirs.test(), &cmd);
assert_eq!(actual.out, "foo");
});
}
fn try_source_foo_without_quotes_in(testdir: &str, playdir: &str) {
Playground::setup(playdir, |dirs, sandbox| {
let testdir = String::from(testdir);
let mut foo_file = testdir.clone();
foo_file.push_str("/foo.nu");
sandbox.mkdir(&testdir);
sandbox.with_files(vec![FileWithContent(&foo_file, "echo foo")]);
let cmd = String::from("source ") + &foo_file;
let actual = nu!(cwd: dirs.test(), &cmd);
assert_eq!(actual.out, "foo");
});
}
engine-q merge
2022-02-07 19:11:34 +00:00
<<<<<<< HEAD
=======
Command tests (#922) * WIP command tests * Finish marking todo tests * update * update * Windows cd test ignoring
2022-02-04 02:01:45 +00:00
// FIXME: jt: needs more work
#[ignore]
engine-q merge
2022-02-07 19:11:34 +00:00
>>>>>>> 9259a56a28f1dd3a4b720ad815aa19c6eaf6adce
Allow `source` to accept paths with emojis (#3939) * Allow sourcing paths with emojis * Add source command tests for emoji paths * Fmt * Disable source tests on Windows with illegal paths * Test sourcing also ASCII and single-quoted paths
2021-08-19 07:06:18 +00:00
#[test]
fn sources_unicode_file_in_normal_dir() {
try_source_foo_with_single_quotes_in("foo", "source_test_1");
try_source_foo_with_double_quotes_in("foo", "source_test_2");
try_source_foo_without_quotes_in("foo", "source_test_3");
}
engine-q merge
2022-02-07 19:11:34 +00:00
<<<<<<< HEAD
=======
Command tests (#922) * WIP command tests * Finish marking todo tests * update * update * Windows cd test ignoring
2022-02-04 02:01:45 +00:00
// FIXME: jt: needs more work
#[ignore]
engine-q merge
2022-02-07 19:11:34 +00:00
>>>>>>> 9259a56a28f1dd3a4b720ad815aa19c6eaf6adce
Allow `source` to accept paths with emojis (#3939) * Allow sourcing paths with emojis * Add source command tests for emoji paths * Fmt * Disable source tests on Windows with illegal paths * Test sourcing also ASCII and single-quoted paths
2021-08-19 07:06:18 +00:00
#[test]
fn sources_unicode_file_in_unicode_dir_without_spaces_1() {
try_source_foo_with_single_quotes_in("🚒", "source_test_4");
try_source_foo_with_double_quotes_in("🚒", "source_test_5");
try_source_foo_without_quotes_in("🚒", "source_test_6");
}
engine-q merge
2022-02-07 19:11:34 +00:00
<<<<<<< HEAD
=======
Command tests (#922) * WIP command tests * Finish marking todo tests * update * update * Windows cd test ignoring
2022-02-04 02:01:45 +00:00
// FIXME: jt: needs more work
#[ignore]
engine-q merge
2022-02-07 19:11:34 +00:00
>>>>>>> 9259a56a28f1dd3a4b720ad815aa19c6eaf6adce
Allow `source` to accept paths with emojis (#3939) * Allow sourcing paths with emojis * Add source command tests for emoji paths * Fmt * Disable source tests on Windows with illegal paths * Test sourcing also ASCII and single-quoted paths
2021-08-19 07:06:18 +00:00
#[cfg(not(windows))] // ':' is not allowed in Windows paths
#[test]
fn sources_unicode_file_in_unicode_dir_without_spaces_2() {
try_source_foo_with_single_quotes_in(":fire_engine:", "source_test_7");
try_source_foo_with_double_quotes_in(":fire_engine:", "source_test_8");
try_source_foo_without_quotes_in(":fire_engine:", "source_test_9");
}
engine-q merge
2022-02-07 19:11:34 +00:00
<<<<<<< HEAD
=======
Command tests (#922) * WIP command tests * Finish marking todo tests * update * update * Windows cd test ignoring
2022-02-04 02:01:45 +00:00
// FIXME: jt: needs more work
#[ignore]
engine-q merge
2022-02-07 19:11:34 +00:00
>>>>>>> 9259a56a28f1dd3a4b720ad815aa19c6eaf6adce
Allow `source` to accept paths with emojis (#3939) * Allow sourcing paths with emojis * Add source command tests for emoji paths * Fmt * Disable source tests on Windows with illegal paths * Test sourcing also ASCII and single-quoted paths
2021-08-19 07:06:18 +00:00
#[test]
fn sources_unicode_file_in_unicode_dir_with_spaces_1() {
try_source_foo_with_single_quotes_in("e-$ èрт🚒♞中片-j", "source_test_8");
try_source_foo_with_double_quotes_in("e-$ èрт🚒♞中片-j", "source_test_9");
}
engine-q merge
2022-02-07 19:11:34 +00:00
<<<<<<< HEAD
=======
Command tests (#922) * WIP command tests * Finish marking todo tests * update * update * Windows cd test ignoring
2022-02-04 02:01:45 +00:00
// FIXME: jt: needs more work
#[ignore]
engine-q merge
2022-02-07 19:11:34 +00:00
>>>>>>> 9259a56a28f1dd3a4b720ad815aa19c6eaf6adce
Allow `source` to accept paths with emojis (#3939) * Allow sourcing paths with emojis * Add source command tests for emoji paths * Fmt * Disable source tests on Windows with illegal paths * Test sourcing also ASCII and single-quoted paths
2021-08-19 07:06:18 +00:00
#[cfg(not(windows))] // ':' is not allowed in Windows paths
#[test]
fn sources_unicode_file_in_unicode_dir_with_spaces_2() {
try_source_foo_with_single_quotes_in("e-$ èрт:fire_engine:♞中片-j", "source_test_10");
try_source_foo_with_double_quotes_in("e-$ èрт:fire_engine:♞中片-j", "source_test_11");
}
#[ignore]
#[test]
fn sources_unicode_file_in_non_utf8_dir() {
// How do I create non-UTF-8 path???
}
Reference in a new issue Copy permalink