1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
|
"""Tests the xonsh main function."""
import builtins
import gc
import os
import os.path
import sys
from contextlib import contextmanager
import pytest
import xonsh.main
from xonsh.main import XonshMode
from xonsh.pytest.tools import ON_WINDOWS, TEST_DIR, skip_if_on_windows
def Shell(*args, **kwargs):
pass
@pytest.fixture
def shell(xession, monkeypatch):
"""Xonsh Shell Mock"""
gc.collect()
Shell.shell_type_aliases = {"rl": "readline"}
monkeypatch.setattr(xonsh.main, "Shell", Shell)
@pytest.fixture(autouse=True)
def empty_xonshrc(monkeypatch):
# Don't use the local machine's xonshrc
empty_file_path = "NUL" if ON_WINDOWS else "/dev/null"
monkeypatch.setitem(os.environ, "XONSHRC", empty_file_path)
def test_premain_no_arg(shell, monkeypatch, xession):
monkeypatch.setattr(sys.stdin, "isatty", lambda: True)
xonsh.main.premain([])
assert xession.env.get("XONSH_LOGIN")
def test_premain_interactive(shell, xession):
xonsh.main.premain(["-i"])
assert xession.env.get("XONSH_INTERACTIVE")
def test_premain_login_command(shell, xession):
xonsh.main.premain(["-l", "-c", 'echo "hi"'])
assert xession.env.get("XONSH_LOGIN")
def test_premain_login(shell, xession):
xonsh.main.premain(["-l"])
assert xession.env.get("XONSH_LOGIN")
def test_premain_D(shell, xession):
xonsh.main.premain(["-DTEST1=1616", "-DTEST2=LOL"])
assert xession.env.get("TEST1") == "1616"
assert xession.env.get("TEST2") == "LOL"
def test_premain_custom_rc(shell, tmpdir, monkeypatch, xession):
monkeypatch.setattr(sys.stdin, "isatty", lambda: True)
monkeypatch.setitem(os.environ, "XONSH_CACHE_SCRIPTS", "False")
f = tmpdir.join("wakkawakka")
f.write("print('hi')")
args = xonsh.main.premain(["--rc", f.strpath])
assert args.mode == XonshMode.interactive
assert f.strpath in xession.rc_files
@pytest.mark.skipif(
ON_WINDOWS and sys.version[:3] == "3.8",
reason="weird failure on py38+windows",
)
def test_rc_with_modules(shell, tmpdir, monkeypatch, capsys, xession):
"""Test that an RC file can load modules inside the same folder it is located in."""
monkeypatch.setattr(sys.stdin, "isatty", lambda: True)
monkeypatch.setitem(os.environ, "XONSH_CACHE_SCRIPTS", "False")
tmpdir.join("my_python_module.py").write("print('Hello,')")
tmpdir.join("my_xonsh_module.xsh").write("print('World!')")
rc = tmpdir.join("rc.xsh")
rc.write("from my_python_module import *\nfrom my_xonsh_module import *")
xonsh.main.premain(["--rc", rc.strpath])
assert rc.strpath in xession.rc_files
stdout, stderr = capsys.readouterr()
assert "Hello,\nWorld!" in stdout
assert len(stderr) == 0
# Check that the temporary rc's folder is not left behind on the path
assert tmpdir.strpath not in sys.path
def test_python_rc(shell, tmpdir, monkeypatch, capsys, xession, mocker):
"""Test that python based control files are executed using Python's parser"""
monkeypatch.setattr(sys.stdin, "isatty", lambda: True)
monkeypatch.setitem(os.environ, "XONSH_CACHE_SCRIPTS", "False")
# spy on xonsh's compile method
spy = mocker.spy(xession.execer, "compile")
rc = tmpdir.join("rc.py")
rc.write("print('Hello World!')")
xonsh.main.premain(["--rc", rc.strpath])
assert rc.strpath in xession.rc_files
stdout, stderr = capsys.readouterr()
assert "Hello World!" in stdout
assert len(stderr) == 0
# Check that the temporary rc's folder is not left behind on the path
assert tmpdir.strpath not in sys.path
assert not spy.called
def test_rcdir(shell, tmpdir, monkeypatch, capsys):
"""
Test that files are loaded from an rcdir, after a normal rc file,
and in lexographic order.
"""
rcdir = tmpdir.join("rc.d")
rcdir.mkdir()
monkeypatch.setattr(sys.stdin, "isatty", lambda: True)
monkeypatch.setitem(os.environ, "XONSHRC_DIR", str(rcdir))
monkeypatch.setitem(os.environ, "XONSHRC", str(tmpdir.join("rc.xsh")))
monkeypatch.setitem(os.environ, "XONSH_CACHE_SCRIPTS", "False")
rcdir.join("2.xsh").write("print('2.xsh')")
rcdir.join("0.xsh").write("print('0.xsh')")
rcdir.join("1.xsh").write("print('1.xsh')")
tmpdir.join("rc.xsh").write("print('rc.xsh')")
xonsh.main.premain([])
stdout, stderr = capsys.readouterr()
assert "rc.xsh\n0.xsh\n1.xsh\n2.xsh" in stdout
assert len(stderr) == 0
def test_rcdir_cli(shell, tmpdir, xession, monkeypatch):
"""Test that --rc DIR works"""
rcdir = tmpdir.join("rcdir")
rcdir.mkdir()
rc = rcdir.join("test.xsh")
rc.write("print('test.xsh')")
monkeypatch.setattr(sys.stdin, "isatty", lambda: True)
xargs = xonsh.main.premain(["--rc", rcdir.strpath])
assert len(xargs.rc) == 1 and xargs.rc[0] == rcdir.strpath
assert rc.strpath in xession.rc_files
def test_rcdir_empty(shell, tmpdir, monkeypatch, capsys):
"""Test that an empty XONSHRC_DIR is not an error"""
rcdir = tmpdir.join("rc.d")
rcdir.mkdir()
rc = tmpdir.join("rc.xsh")
rc.write_binary(b"")
monkeypatch.setattr(sys.stdin, "isatty", lambda: True)
monkeypatch.setitem(os.environ, "XONSHRC", str(rc))
monkeypatch.setitem(os.environ, "XONSHRC_DIR", str(rcdir))
xonsh.main.premain([])
stdout, stderr = capsys.readouterr()
assert len(stderr) == 0
# the parameterisation is a list of xonsh args, followed by the list
# of RC files (see function body) expected to be loaded in order
# note that a tty is not faked, so this will default to non-interactive
# (skipped on windows because XONSHRC="/path/to/f1.xsh:/path/to/f2.xsh"
# doesn't appear to work, while it does on other platforms)
@pytest.mark.skipif(ON_WINDOWS, reason="Issue with multi-file XONSHRC")
@pytest.mark.parametrize(
["args", "expected"],
[
# non-interactive, nothing loading
[[], []],
# interactive, normal XONSHRC and XONSHRC_DIR
[["-i"], ["F0", "F1", "D0", "D1"]],
# --no-rc wins over -i
[["--no-rc", "-i"], []],
# --no-rc wins over -i --rc
[["--no-rc", "-i", "--rc", "<R0>"], []],
# --rc does nothing in non-interactive mode
[["--rc", "<R0>"], []],
# but is respected in interactive
[["-i", "--rc", "<R0>"], ["R0"]],
# multiple invocations of --rc only use the last
[["-i", "--rc", "<R0>", "--rc", "<R1>"], ["R1"]],
# but multiple RC files can be specified after --rc
[["-i", "--rc", "<R0>", "<R1>"], ["R0", "R1"]],
# including the same file twice
[["-i", "--rc", "<R0>", "<R0>"], ["R0", "R0"]],
# scripts are non-interactive
[["<SC>"], ["SC"]],
# but -i will load the normal environment with a script
[["-i", "<SC>"], ["F0", "F1", "D0", "D1", "SC"]],
# no-rc has no effect on a script
[["--no-rc", "<SC>"], ["SC"]],
# but does prevent RC loading in -i mode
[["--no-rc", "-i", "<SC>"], ["SC"]],
# --rc doesn't work here because a script is non-interactive
[["--rc", "<R0>", "--", "<SC>"], ["SC"]],
# unless forced with -i
[["-i", "--rc", "<R0>", "--", "<SC>"], ["R0", "SC"]],
# --no-rc also wins here
[["-i", "--rc", "<R0>", "--no-rc", "--", "<SC>"], ["SC"]],
# single commands are non-interactive
[["-c", "pass"], []],
# but load RCs with -i
[["-i", "-c", "pass"], ["F0", "F1", "D0", "D1"]],
# --rc ignores without -i
[["--rc", "<R0>", "-c", "pass"], []],
# but used with -i
[["-i", "--rc", "<R0>", "-c", "pass"], ["R0"]],
],
ids=lambda ae: " ".join(ae),
)
def test_script_startup(shell, tmpdir, monkeypatch, capsys, args, expected):
"""
Test the correct scripts are loaded, in the correct order, for
different combinations of CLI arguments. See
https://github.com/xonsh/xonsh/issues/4096
This sets up a standard set of RC files which will be loaded,
and tests whether they print their payloads at all, or in the right
order, depending on the CLI arguments chosen.
"""
rcdir = tmpdir.join("rc.d")
rcdir.mkdir()
# XONSHRC_DIR files, in order
rcdir.join("d0.xsh").write("print('D0')")
rcdir.join("d1.xsh").write("print('D1')")
# XONSHRC files, in order
f0 = tmpdir.join("f0.xsh")
f0.write("print('F0')")
f1 = tmpdir.join("f1.xsh")
f1.write("print('F1')")
# RC files which can be explicitly loaded with --rc
r0 = tmpdir.join("r0.xsh")
r0.write("print('R0')")
r1 = tmpdir.join("r1.xsh")
r1.write("print('R1')")
# a (non-RC) script which can be loaded
sc = tmpdir.join("sc.xsh")
sc.write("print('SC')")
monkeypatch.setitem(os.environ, "XONSHRC", f"{f0}:{f1}")
monkeypatch.setitem(os.environ, "XONSHRC_DIR", str(rcdir))
# replace <RC> with the path to rc.xsh and <SC> with sc.xsh
args = [
a.replace("<R0>", str(r0)).replace("<R1>", str(r1)).replace("<SC>", str(sc))
for a in args
]
# since we only test xonsh.premain here, a script file (SC)
# won't actually get run here, so won't appear in the stdout,
# so don't check for it (but check for a .file in the parsed args)
check_for_script = "SC" in expected
expected = [e for e in expected if e != "SC"]
xargs = xonsh.main.premain(args)
stdout, stderr = capsys.readouterr()
assert "\n".join(expected) in stdout
if check_for_script:
assert xargs.file is not None
def test_rcdir_ignored_with_rc(shell, tmpdir, monkeypatch, capsys, xession):
"""Test that --rc suppresses loading XONSHRC_DIRs"""
rcdir = tmpdir.join("rc.d")
rcdir.mkdir()
monkeypatch.setattr(sys.stdin, "isatty", lambda: True)
monkeypatch.setitem(os.environ, "XONSHRC_DIR", str(rcdir))
rcdir.join("rcd.xsh").write("print('RCDIR')")
tmpdir.join("rc.xsh").write("print('RCFILE')")
xonsh.main.premain(["--rc", str(tmpdir.join("rc.xsh"))])
stdout, stderr = capsys.readouterr()
assert "RCDIR" not in stdout
assert "RCFILE" in stdout
assert str(rcdir.join("rcd.xsh")) not in xession.rc_files
@pytest.mark.skipif(ON_WINDOWS, reason="See https://github.com/xonsh/xonsh/issues/3936")
def test_rc_with_modified_path(shell, tmpdir, monkeypatch, capsys, xession):
"""Test that an RC file can edit the sys.path variable without losing those values."""
monkeypatch.setattr(sys.stdin, "isatty", lambda: True)
monkeypatch.setitem(os.environ, "XONSH_CACHE_SCRIPTS", "False")
rc = tmpdir.join("rc.xsh")
rc.write(f"import sys\nsys.path.append('{tmpdir.strpath}')\nprint('Hello, World!')")
xonsh.main.premain(["--rc", rc.strpath])
assert rc.strpath in xession.rc_files
stdout, stderr = capsys.readouterr()
assert "Hello, World!" in stdout
assert len(stderr) == 0
# Check that the path that was explicitly added is not accidentally deleted
assert tmpdir.strpath in sys.path
def test_rc_with_failing_module(shell, tmpdir, monkeypatch, capsys, xession):
"""Test that an RC file which imports a module that throws an exception ."""
monkeypatch.setattr(sys.stdin, "isatty", lambda: True)
monkeypatch.setitem(os.environ, "XONSH_CACHE_SCRIPTS", "False")
tmpdir.join("my_failing_module.py").write("raise RuntimeError('Unexpected error')")
rc = tmpdir.join("rc.xsh")
rc.write("from my_failing_module import *")
xonsh.main.premain(["--rc", rc.strpath])
assert rc.strpath not in xession.rc_files
stdout, stderr = capsys.readouterr()
assert len(stdout) == 0
assert "RuntimeError: Unexpected error" in stderr
# Check that the temporary rc's folder is not left behind on the path
assert tmpdir.strpath not in sys.path
def test_no_rc_with_script(shell, tmpdir):
args = xonsh.main.premain(["tests/sample.xsh"])
assert not (args.mode == XonshMode.interactive)
def test_force_interactive_rc_with_script(shell, tmpdir, xession):
xonsh.main.premain(["-i", "tests/sample.xsh"])
assert xession.env.get("XONSH_INTERACTIVE")
def test_force_interactive_custom_rc_with_script(shell, tmpdir, monkeypatch, xession):
"""Calling a custom RC file on a script-call with the interactive flag
should run interactively
"""
monkeypatch.setitem(os.environ, "XONSH_CACHE_SCRIPTS", "False")
f = tmpdir.join("wakkawakka")
f.write("print('hi')")
args = xonsh.main.premain(["-i", "--rc", f.strpath, "tests/sample.xsh"])
assert args.mode == XonshMode.interactive
assert f.strpath in xession.rc_files
def test_custom_rc_with_script(shell, tmpdir):
"""Calling a custom RC file on a script-call without the interactive flag
should not run interactively
"""
f = tmpdir.join("wakkawakka")
f.write("print('hi')")
args = xonsh.main.premain(["--rc", f.strpath, "tests/sample.xsh"])
assert not (args.mode == XonshMode.interactive)
def test_premain_no_rc(shell, tmpdir, xession):
xonsh.main.premain(["--no-rc", "-i"])
assert len(xession.rc_files) == 0
@pytest.mark.parametrize(
"arg", ["", "-i", "-vERSION", "-hAALP", "TTTT", "-TT", "--TTT"]
)
def test_premain_with_file_argument(arg, shell, xession):
xonsh.main.premain(["tests/sample.xsh", arg])
assert not (xession.env.get("XONSH_INTERACTIVE"))
def test_premain_interactive__with_file_argument(shell, xession):
xonsh.main.premain(["-i", "tests/sample.xsh"])
assert xession.env.get("XONSH_INTERACTIVE")
@pytest.mark.parametrize("case", ["----", "--hep", "-TT", "--TTTT"])
def test_premain_invalid_arguments(shell, case, capsys):
with pytest.raises(SystemExit):
xonsh.main.premain([case])
assert "unrecognized argument" in capsys.readouterr()[1]
def test_premain_timings_arg(shell):
xonsh.main.premain(["--timings"])
@skip_if_on_windows
@pytest.mark.parametrize(
("env_shell", "rc_shells", "exp_shell"),
[
("", [], ""),
("/argle/bash", [], "/argle/bash"),
("/bin/xonsh", [], ""),
(
"/argle/bash",
["/argle/xonsh", "/argle/dash", "/argle/sh", "/argle/bargle"],
"/argle/bash",
),
(
"",
["/argle/xonsh", "/argle/dash", "/argle/sh", "/argle/bargle"],
"/argle/dash",
),
("", ["/argle/xonsh", "/argle/screen", "/argle/sh"], "/argle/sh"),
("", ["/argle/xonsh", "/argle/screen"], ""),
],
)
@skip_if_on_windows
def test_xonsh_failback(
env_shell,
rc_shells,
exp_shell,
shell,
xession,
monkeypatch,
monkeypatch_stderr,
):
failback_checker = []
def mocked_main(*args):
raise Exception("A fake failure")
monkeypatch.setattr(xonsh.main, "main_xonsh", mocked_main)
def mocked_execlp(f, *args):
failback_checker.append(f)
failback_checker.append(args[0])
monkeypatch.setattr(os, "execlp", mocked_execlp)
monkeypatch.setattr(os.path, "exists", lambda x: True)
monkeypatch.setattr(sys, "argv", ["/bin/xonsh", "-i"]) # has to look like real path
@contextmanager
def mocked_open(*args):
yield rc_shells
monkeypatch.setattr(builtins, "open", mocked_open)
monkeypatch.setenv("SHELL", env_shell)
try:
xonsh.main.main() # if main doesn't raise, it did try to invoke a shell
assert failback_checker[0] == exp_shell
assert failback_checker[1] == failback_checker[0]
except Exception as e:
if len(e.args) and "A fake failure" in str(
e.args[0]
): # if it did raise expected exception
assert len(failback_checker) == 0 # then it didn't invoke a shell
else:
raise e # it raised something other than the test exception,
def test_xonsh_failback_single(shell, monkeypatch, monkeypatch_stderr):
class FakeFailureError(Exception):
pass
def mocked_main(*args):
raise FakeFailureError()
monkeypatch.setattr(xonsh.main, "main_xonsh", mocked_main)
monkeypatch.setattr(sys, "argv", ["xonsh", "-c", "echo", "foo"])
with pytest.raises(FakeFailureError):
xonsh.main.main()
def test_xonsh_failback_script_from_file(shell, monkeypatch, monkeypatch_stderr):
checker = []
def mocked_execlp(f, *args):
checker.append(f)
monkeypatch.setattr(os, "execlp", mocked_execlp)
script = os.path.join(TEST_DIR, "scripts", "raise.xsh")
monkeypatch.setattr(sys, "argv", ["xonsh", script])
# changed in #4662: User-Code exceptions are now caught in main and handled there
# => we expect that no exception is thrown
assert len(checker) == 0
def test_xonsh_no_file_returncode(shell, monkeypatch, monkeypatch_stderr):
monkeypatch.setattr(sys, "argv", ["xonsh", "foobazbarzzznotafileatall.xsh"])
with pytest.raises(SystemExit):
xonsh.main.main()
def test_auto_loading_xontribs(xession, shell, mocker):
from importlib.metadata import EntryPoint
group = "xonsh.xontribs"
mocker.patch(
"importlib.metadata.entry_points",
autospec=True,
return_value={
group: [EntryPoint(name="test", group=group, value="test.module")]
},
)
xontribs_load = mocker.patch("xonsh.xontribs.xontribs_load")
xonsh.main.premain([])
assert xession.builtins.autoloaded_xontribs == {"test": "test.module"}
xontribs_load.assert_called()
|