nushell/crates/nu-std/tests/test_dirs.nu
Antoine Stevan 3005fe10e5
REFACTOR: move run-tests and fix the std assert namespace (#9303)
related to the namespace bullet point in
- https://github.com/nushell/nushell/issues/8450

# Description
this was the last module of the standard library with a broken
namespace, this PR takes care of this.

- `run-tests` has been moved to `std/mod.nu`
- `std/testing.nu` has been moved to `std/assert.nu`
- the namespace has been fixed
- `assert` is now called `main` and used in all the other `std assert`
commands
- for `std assert length` and `std assert str contains`, in order not to
shadow the built-in `length` and `str contains` commands, i've used
`alias "core ..." = ...` to (1) define `foo` in `assert.nu` and (2)
still use the builtin `foo` with `core foo` (replace `foo` by `length`
or `str contains`)
  - tests have been fixed accordingly

# User-Facing Changes
one can not use
```
use std "assert equal"
```
anymore because `assert ...` is not exported from `std`.
`std assert` is now a *real* module.

# Tests + Formatting
- 🟢 `toolkit fmt`
- 🟢 `toolkit clippy`
-  `toolkit test`
-  `toolkit test stdlib`

# After Submitting
```
$nothing
```

# Notes for reviewers
to test this, i think the easiest is to
- run `toolkit test stdlib` and see all the tests pass
- run `cargo run -- -n` and try `use std assert` => are all the commands
available in scope?
2023-05-27 07:45:04 -05:00

121 lines
4.0 KiB
Plaintext

use std assert
use std assert
use std log
# A couple of nuances to understand when testing module that exports environment:
# Each 'use' for that module in the test script will execute the export def-env block.
# PWD at the time of the `use` will be what the export def-env block will see.
export def setup [] {
# need some directories to play with
let base_path = ($nu.temp-path | path join $"test_dirs_(random uuid)")
let path_a = ($base_path | path join "a")
let path_b = ($base_path | path join "b")
mkdir $base_path $path_a $path_b
{base_path: $base_path, path_a:$path_a, path_b: $path_b}
}
export def teardown [] {
let base_path = $in.base_path
cd $base_path
cd ..
rm -r $base_path
}
def cur_dir_check [expect_dir, scenario] {
log debug $"check dir ($expect_dir), scenario ($scenario)"
assert equal $expect_dir $env.PWD $"expected not PWD after ($scenario)"
}
def cur_ring_check [expect_dir:string, expect_position: int scenario:string] {
log debug $"check ring ($expect_dir), position ($expect_position) scenario ($scenario)"
assert ($expect_position < ($env.DIRS_LIST | length)) $"ring big enough after ($scenario)"
assert equal $expect_position $env.DIRS_POSITION $"position in ring after ($scenario)"
}
export def test_dirs_command [] {
# careful with order of these statements!
# must capture value of $in before executing `use`s
let $c = $in
# must set PWD *before* doing `use` that will run the export def-env block in dirs module.
cd $c.base_path
# must execute these uses for the UOT commands *after* the test and *not* just put them at top of test module.
# the export def-env gets messed up
use std dirs
assert equal [$c.base_path] $env.DIRS_LIST "list is just pwd after initialization"
dirs next
assert equal $c.base_path $env.DIRS_LIST.0 "next wraps at end of list"
dirs prev
assert equal $c.base_path $env.DIRS_LIST.0 "prev wraps at top of list"
dirs add $c.path_b $c.path_a
assert equal $c.path_b $env.PWD "add changes PWD to first added dir"
assert length $env.DIRS_LIST 3 "add in fact adds to list"
assert equal $c.path_a $env.DIRS_LIST.2 "add in fact adds to list"
dirs next 2
# assert (not) equal requires span.start of first arg < span.end of 2nd
assert equal $env.PWD $c.base_path "next wraps at end of list"
dirs prev 1
assert equal $c.path_a $env.PWD "prev wraps at start of list"
cur_dir_check $c.path_a "prev wraps to end from start of list"
dirs drop
assert length $env.DIRS_LIST 2 "drop removes from list"
assert equal $env.PWD $c.path_b "drop changes PWD to previous in list (before dropped element)"
assert equal (dirs show) [[active path]; [false $c.base_path] [true $c.path_b]] "show table contains expected information"
}
export def test_dirs_next [] {
# must capture value of $in before executing `use`s
let $c = $in
# must set PWD *before* doing `use` that will run the export def-env block in dirs module.
cd $c.base_path
assert equal $env.PWD $c.base_path "test setup"
use std dirs
cur_dir_check $c.base_path "use module test setup"
dirs add $c.path_a $c.path_b
cur_ring_check $c.path_a 1 "add 2, but pwd is first one added"
dirs next
cur_ring_check $c.path_b 2 "next to third"
dirs next
cur_ring_check $c.base_path 0 "next from top wraps to bottom of ring"
}
export def test_dirs_cd [] {
# must capture value of $in before executing `use`s
let $c = $in
# must set PWD *before* doing `use` that will run the export def-env block in dirs module.
cd $c.base_path
use std dirs
cur_dir_check $c.base_path "use module test setup"
cd $c.path_b
cur_ring_check $c.path_b 0 "cd with empty ring"
dirs add $c.path_a
cur_dir_check $c.path_a "can add 2nd directory"
cd $c.path_b
cur_ring_check $c.path_b 1 "cd at 2nd item on ring"
dirs next
cur_ring_check $c.path_b 0 "cd updates current position in non-empty ring"
assert equal [$c.path_b $c.path_b] $env.DIRS_LIST "cd updated both positions in ring"
}