xonsh/tests/test_dirstack.py
Gil Forsyth 0fe0a6c03e
fix(dirstack): use XSH.env for $HOME check, not os.path (#5211)
`os.path.expanduser` relies on the value of `$HOME` set in `os.environ`.
This meant that a user who set `$HOME` would then not end up in that
directory with a no-argument call to `cd` unless they had set
`UPDATE_OS_ENVIRON`.

Now the value of `$HOME` is respected regardless of the setting in `UPDATE_OS_ENVIRON`
2023-09-25 14:53:15 +06:00

116 lines
2.9 KiB
Python

"""Testing dirstack"""
import os
import pytest # noqa F401
from xonsh import dirstack
from xonsh.tools import chdir
HERE = os.path.abspath(os.path.dirname(__file__))
PARENT = os.path.dirname(HERE)
def test_simple(xession):
xession.env.update(dict(CDPATH=PARENT, PWD=PARENT))
with chdir(PARENT):
assert os.getcwd() != HERE
dirstack.cd(["tests"])
assert os.getcwd() == HERE
def test_cdpath_simple(xession):
xession.env.update(dict(CDPATH=PARENT, PWD=HERE))
with chdir(os.path.normpath("/")):
assert os.getcwd() != HERE
dirstack.cd(["tests"])
assert os.getcwd() == HERE
def test_cdpath_collision(xession):
xession.env.update(dict(CDPATH=PARENT, PWD=HERE))
sub_tests = os.path.join(HERE, "tests")
if not os.path.exists(sub_tests):
os.mkdir(sub_tests)
with chdir(HERE):
assert os.getcwd() == HERE
dirstack.cd(["tests"])
assert os.getcwd() == os.path.join(HERE, "tests")
def test_cdpath_expansion(xession):
xession.env.update(dict(HERE=HERE, CDPATH=("~", "$HERE")))
test_dirs = (
os.path.join(HERE, "xonsh-test-cdpath-here"),
os.path.expanduser("~/xonsh-test-cdpath-home"),
)
try:
for d in test_dirs:
if not os.path.exists(d):
os.mkdir(d)
assert os.path.exists(
dirstack._try_cdpath(d)
), f"dirstack._try_cdpath: could not resolve {d}"
finally:
for d in test_dirs:
if os.path.exists(d):
os.rmdir(d)
def test_cdpath_events(xession, tmpdir):
xession.env.update(dict(CDPATH=PARENT, PWD=os.getcwd()))
target = str(tmpdir)
ev = None
@xession.builtins.events.on_chdir
def handler(olddir, newdir, **kw):
nonlocal ev
ev = olddir, newdir
old_dir = os.getcwd()
try:
dirstack.cd([target])
except Exception:
raise
else:
assert (old_dir, target) == ev
finally:
# Use os.chdir() here so dirstack.cd() doesn't fire events (or fail again)
os.chdir(old_dir)
def test_cd_autopush(xession, tmpdir):
xession.env.update(dict(CDPATH=PARENT, PWD=os.getcwd(), AUTO_PUSHD=True))
target = str(tmpdir)
old_dir = os.getcwd()
old_ds_size = len(dirstack.DIRSTACK)
assert target != old_dir
try:
dirstack.cd([target])
assert target == os.getcwd()
assert old_ds_size + 1 == len(dirstack.DIRSTACK)
dirstack.popd([])
except Exception:
raise
finally:
while len(dirstack.DIRSTACK) > old_ds_size:
dirstack.popd([])
assert old_dir == os.getcwd()
def test_cd_home(xession, tmpdir):
target = str(tmpdir)
old_home = xession.env.get("HOME")
xession.env.update(dict(HOME=target, PWD=os.getcwd(), AUTO_PUSHD=True))
dirstack.cd([])
assert target == os.getcwd()
dirstack.popd([])
xession.env.update(dict(HOME=old_home))