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 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
|
"""Tests the json history backend."""
# pylint: disable=protected-access
import shlex
import pytest
from xonsh.history.json import (
JsonHistory,
_xhj_gc_bytes_to_rmfiles,
_xhj_gc_commands_to_rmfiles,
_xhj_gc_files_to_rmfiles,
_xhj_gc_seconds_to_rmfiles,
)
from xonsh.history.main import HistoryAlias, history_main
from xonsh.lazyjson import LazyJSON
CMDS = ["ls", "cat hello kitty", "abc", "def", "touch me", "grep from me"]
IGNORE_OPTS = ",".join(["ignoredups", "ignoreerr", "ignorespace"])
@pytest.fixture
def hist(tmpdir, xession, monkeypatch):
file = tmpdir / "xonsh-HISTORY-TEST.json"
h = JsonHistory(filename=str(file), here="yup", sessionid="SESSIONID", gc=False)
monkeypatch.setattr(xession, "history", h)
yield h
def test_hist_init(hist, xession):
"""Test initialization of the shell history."""
with LazyJSON(hist.filename) as lj:
obs = lj["here"]
assert "yup" == obs
def test_hist_append(hist, xession):
"""Verify appending to the history works."""
xession.env["HISTCONTROL"] = set()
hf = hist.append({"inp": "still alive", "rtn": 0})
assert hf is None
assert "still alive" == hist.buffer[0]["inp"]
assert 0 == hist.buffer[0]["rtn"]
assert 0 == hist.rtns[-1]
hf = hist.append({"inp": "dead now", "rtn": 1})
assert "dead now" == hist.buffer[1]["inp"]
assert 1 == hist.buffer[1]["rtn"]
assert 1 == hist.rtns[-1]
hf = hist.append({"inp": "reborn", "rtn": 0})
assert "reborn" == hist.buffer[2]["inp"]
assert 0 == hist.buffer[2]["rtn"]
assert 0 == hist.rtns[-1]
def test_hist_flush(hist, xession):
"""Verify explicit flushing of the history works."""
hf = hist.flush()
assert hf is None
xession.env["HISTCONTROL"] = set()
hist.append({"inp": "still alive?", "rtn": 0, "out": "yes"})
hf = hist.flush()
assert hf is not None
while hf.is_alive():
pass
with LazyJSON(hist.filename) as lj:
assert len(lj["cmds"]) == 1
cmd = lj["cmds"][0]
assert cmd["inp"] == "still alive?"
assert not cmd.get("out", None)
def test_hist_flush_with_store_stdout(hist, xession):
"""Verify explicit flushing of the history works."""
hf = hist.flush()
assert hf is None
xession.env["HISTCONTROL"] = set()
xession.env["XONSH_STORE_STDOUT"] = True
hist.append({"inp": "still alive?", "rtn": 0, "out": "yes"})
hf = hist.flush()
assert hf is not None
while hf.is_alive():
pass
with LazyJSON(hist.filename) as lj:
assert len(lj["cmds"]) == 1
assert lj["cmds"][0]["inp"] == "still alive?"
assert lj["cmds"][0]["out"].strip() == "yes"
def test_hist_flush_with_store_cwd(hist, xession):
hf = hist.flush()
assert hf is None
hist.save_cwd = True
hist.append({"inp": "# saving with cwd", "rtn": 0, "out": "yes", "cwd": "/tmp"})
hf = hist.flush()
assert hf is not None
hist.save_cwd = False
hist.append({"inp": "# saving without cwd", "rtn": 0, "out": "yes", "cwd": "/tmp"})
hf = hist.flush()
assert hf is not None
while hf.is_alive():
pass
with LazyJSON(hist.filename) as lj:
assert len(lj["cmds"]) == 2
assert lj["cmds"][0]["cwd"] == "/tmp"
assert "cwd" not in lj["cmds"][1]
def test_hist_flush_with_hist_control(hist, xession):
"""Verify explicit flushing of the history works."""
hf = hist.flush()
assert hf is None
xession.env["HISTCONTROL"] = IGNORE_OPTS
hist.append({"inp": "ls foo1", "rtn": 0})
hist.append({"inp": "ls foo1", "rtn": 1})
hist.append({"inp": "ls foo1", "rtn": 0})
hist.append({"inp": "ls foo2", "rtn": 2})
hist.append({"inp": "ls foo3", "rtn": 0})
hist.append({"inp": "ls secret", "rtn": 0, "spc": True})
hf = hist.flush()
assert hf is not None
while hf.is_alive():
pass
assert len(hist.buffer) == 0
with LazyJSON(hist.filename) as lj:
cmds = list(lj["cmds"])
assert len(cmds) == 2
assert [x["inp"] for x in cmds] == ["ls foo1", "ls foo3"]
assert [x["rtn"] for x in cmds] == [0, 0]
def test_cmd_field(hist, xession):
# in-memory
xession.env["HISTCONTROL"] = set()
hf = hist.append({"inp": "ls foo", "rtn": 1})
assert hf is None
assert 1 == hist.rtns[0]
assert 1 == hist.rtns[-1]
assert hist.outs[-1] is None
# slice
assert [1] == hist.rtns[:]
# on disk
hf = hist.flush()
assert hf is not None
assert 1 == hist.rtns[0]
assert 1 == hist.rtns[-1]
assert hist.outs[-1] is None
@pytest.mark.parametrize(
"inp, commands, offset",
[
("", CMDS, (0, 1)),
("-r", list(reversed(CMDS)), (len(CMDS) - 1, -1)),
("0", CMDS[0:1], (0, 1)),
("1", CMDS[1:2], (1, 1)),
("-2", CMDS[-2:-1], (len(CMDS) - 2, 1)),
("1:3", CMDS[1:3], (1, 1)),
("1::2", CMDS[1::2], (1, 2)),
("-4:-2", CMDS[-4:-2], (len(CMDS) - 4, 1)),
],
)
def test_show_cmd_numerate(inp, commands, offset, hist, xession, capsys):
"""Verify that CLI history commands work."""
base_idx, step = offset
xession.env["HISTCONTROL"] = set()
for ts, cmd in enumerate(CMDS): # populate the shell history
hist.append({"inp": cmd, "rtn": 0, "ts": (ts + 1, ts + 1.5)})
exp = (f"{base_idx + idx * step}: {cmd}" for idx, cmd in enumerate(list(commands)))
exp = "\n".join(exp)
history_main(["show", "-n"] + shlex.split(inp))
out, err = capsys.readouterr()
assert out.rstrip() == exp
def test_history_diff(tmpdir, xession, monkeypatch, capsys):
files = [tmpdir / f"xonsh-HISTORY-TEST-{idx}.json" for idx in range(2)]
for file in files:
hist = JsonHistory(
filename=str(file), here="yup", sessionid="SESSIONID", gc=False
)
monkeypatch.setattr(xession, "history", hist)
xession.env["HISTCONTROL"] = set()
for ts, cmd in enumerate(CMDS): # populate the shell history
hist.append({"inp": cmd, "rtn": 0, "ts": (ts + 1, ts + 1.5)})
flush = hist.flush()
if flush.queue:
# make sure that flush is complete
time.sleep(0.1)
left, right = (str(f) for f in files)
history_main(["diff", left, right])
out, err = capsys.readouterr()
# make sure it is called
assert out.rstrip()
def test_histcontrol(hist, xession):
"""Test HISTCONTROL=ignoredups,ignoreerr,ignorespacee"""
xession.env["HISTCONTROL"] = IGNORE_OPTS
assert len(hist.buffer) == 0
# An error, buffer remains empty
hist.append({"inp": "ls foo", "rtn": 2})
assert len(hist.buffer) == 1
assert hist.rtns[-1] == 2
assert hist.inps[-1] == "ls foo"
# Success
hist.append({"inp": "ls foobazz", "rtn": 0})
assert len(hist.buffer) == 2
assert "ls foobazz" == hist.buffer[-1]["inp"]
assert 0 == hist.buffer[-1]["rtn"]
assert hist.rtns[-1] == 0
assert hist.inps[-1] == "ls foobazz"
# Error
hist.append({"inp": "ls foo", "rtn": 2})
assert len(hist.buffer) == 3
assert "ls foo" == hist.buffer[-1]["inp"]
assert 2 == hist.buffer[-1]["rtn"]
assert hist.rtns[-1] == 2
assert hist.inps[-1] == "ls foo"
# File now exists, success
hist.append({"inp": "ls foo", "rtn": 0})
assert len(hist.buffer) == 4
assert "ls foo" == hist.buffer[-1]["inp"]
assert 0 == hist.buffer[-1]["rtn"]
assert hist.rtns[-1] == 0
assert hist.inps[-1] == "ls foo"
# Success
hist.append({"inp": "ls", "rtn": 0})
assert len(hist.buffer) == 5
assert "ls" == hist.buffer[-1]["inp"]
assert 0 == hist.buffer[-1]["rtn"]
assert hist.rtns[-1] == 0
assert hist.inps[-1] == "ls"
# Dup
hist.append({"inp": "ls", "rtn": 0})
assert len(hist.buffer) == 6
assert hist.rtns[-1] == 0
assert hist.inps[-1] == "ls"
# Success
hist.append({"inp": "/bin/ls", "rtn": 0})
assert len(hist.buffer) == 7
assert "/bin/ls" == hist.buffer[-1]["inp"]
assert 0 == hist.buffer[-1]["rtn"]
assert hist.rtns[-1] == 0
assert hist.inps[-1] == "/bin/ls"
# Error
hist.append({"inp": "ls bazz", "rtn": 1})
assert len(hist.buffer) == 8
assert "ls bazz" == hist.buffer[-1]["inp"]
assert 1 == hist.buffer[-1]["rtn"]
assert hist.rtns[-1] == 1
assert hist.inps[-1] == "ls bazz"
# Error
hist.append({"inp": "ls bazz", "rtn": -1})
assert len(hist.buffer) == 9
assert "ls bazz" == hist.buffer[-1]["inp"]
assert -1 == hist.buffer[-1]["rtn"]
assert hist.rtns[-1] == -1
assert hist.inps[-1] == "ls bazz"
# Success
hist.append({"inp": "echo not secret", "rtn": 0, "spc": False})
assert len(hist.buffer) == 10
assert "echo not secret" == hist.buffer[-1]["inp"]
assert 0 == hist.buffer[-1]["rtn"]
assert hist.rtns[-1] == 0
assert hist.inps[-1] == "echo not secret"
# Space
hist.append({"inp": "echo secret command", "rtn": 0, "spc": True})
assert len(hist.buffer) == 10
assert hist.rtns[-1] == 0
assert hist.inps[-1] == "echo not secret"
@pytest.mark.parametrize("args", ["-h", "--help", "show -h", "show --help"])
def test_parse_args_help(args, capsys):
with pytest.raises(SystemExit):
history_main(shlex.split(args))
assert "show this help message and exit" in capsys.readouterr()[0]
@pytest.mark.parametrize(
"args, session, slice, numerate, reverse",
[
("", "session", [], False, False),
("1:5", "session", ["1:5"], False, False),
("show", "session", [], False, False),
("show 15", "session", ["15"], False, False),
("show bash 3:5 15:66", "bash", ["3:5", "15:66"], False, False),
("show -r", "session", [], False, True),
("show -rn bash", "bash", [], True, True),
("show -n -r -30:20", "session", ["-30:20"], True, True),
("show -n zsh 1:2:3", "zsh", ["1:2:3"], True, False),
],
)
def test_parser_show(args, session, slice, numerate, reverse, mocker, hist, xession):
# use dict instead of argparse.Namespace for pretty pytest diff
exp_ns = {
"session": session,
"slices": slice,
"numerate": numerate,
"reverse": reverse,
"start_time": None,
"end_time": None,
"datetime_format": None,
"timestamp": False,
"null_byte": False,
}
# clear parser instance, so that patched func can take place
from xonsh.history import main as mod
main = HistoryAlias()
spy = mocker.spy(mod.xcli, "_dispatch_func")
# action
main(shlex.split(args))
# assert
spy.assert_called_once()
# assemble
args, _ = spy.call_args
_, kwargs = args
called_with = {attr: kwargs[attr] for attr in exp_ns}
if kwargs["_unparsed"]:
called_with["slices"] = kwargs["_unparsed"]
# assert
assert called_with == exp_ns
@pytest.mark.parametrize(
"index, exp",
[
(-1, ("grep from me", "out", 0, (5, 6))),
(1, ("cat hello kitty", "out", 0, (1, 2))),
(
slice(1, 3),
[("cat hello kitty", "out", 0, (1, 2)), ("abc", "out", 0, (2, 3))],
),
],
)
def test_history_getitem(index, exp, hist, xession):
xession.env["HISTCONTROL"] = set()
attrs = ("inp", "out", "rtn", "ts")
for ts, cmd in enumerate(CMDS): # populate the shell history
entry = {k: v for k, v in zip(attrs, [cmd, "out", 0, (ts, ts + 1)])}
hist.append(entry)
entry = hist[index]
if isinstance(entry, list):
assert [(e.cmd, e.out, e.rtn, e.ts) for e in entry] == exp
else:
assert (entry.cmd, entry.out, entry.rtn, entry.ts) == exp
import calendar
import time
HF_FIRST_DAY = calendar.timegm(time.struct_time((2018, 5, 13, 0, 0, 0, 0, 0, 0)))
def history_files_list(gen_count) -> (float, int, str, int):
"""Generate a list of history file tuples"""
# generate test list:
# 2 files every day in range
# morning file has 100 commands, evening 50
# first file size 10000, 2nd 2500
# first file time 0900, 2nd 2300
# for sanity in reproducable test results, all date arithmetic ignores astronomy.
# time zone is UTC, all days have 24 h and 0 sec, no leap year or leap sec.
retval = []
for i in range(int((gen_count + 1) / 2)):
retval.append(
(
# first day in sec + #days * 24hr + #hr * 60min + # sec * 60sec + sec= sec to date.
HF_FIRST_DAY + (((((i * 24) + 9) * 60) + 0) * 60) + 0, # mod dt,
100,
f".argle/xonsh-{2*i:05n}.json",
10000,
)
)
retval.append(
(
# first day in sec + #days * 24hr + #hr * 60min + # sec * 60sec + sec= sec to date.
HF_FIRST_DAY + (((((i * 24) + 23) * 60) + 0) * 60) + 0, # mod dt,
50,
f".argle/xonsh-{2*i+1:05n}.json",
2500,
)
)
return retval
# generate 100 files, 50 days.
HISTORY_FILES_LIST = history_files_list(100)
# TS of newest history file
SEC_FROM_LATEST = time.time() - (HISTORY_FILES_LIST[-1][0])
SEC_PER_DAY = 24 * 60 * 60
# "now" gets evaluated above at test definition time and later when the tests
# are executed. If the difference between these equals half the smallest time
# interval between log files, the test will fail. We constructed logs at 9a and
# 11p every day. The smallest interval is thus ten hours (from 11p to 9a), so
# we can't spend more than five hours executing the tests.
MAX_RUNTIME = 30 * 60
MIN_DIFF = min(
HISTORY_FILES_LIST[i + 1][0] - HISTORY_FILES_LIST[i][0]
for i in range(len(HISTORY_FILES_LIST) - 1)
)
assert MAX_RUNTIME < MIN_DIFF / 2
@pytest.mark.parametrize(
"fn, hsize, in_files, exp_size, exp_files",
[
# xhj_gc_commands_to_rmfiles
(
_xhj_gc_commands_to_rmfiles,
1001 * (100 + 50), # Limit > history, no trimming.
HISTORY_FILES_LIST,
0, # nothing trimmed
[], #
),
(
_xhj_gc_commands_to_rmfiles,
20 * (100 + 50), # keep 20 full days (40 files)
HISTORY_FILES_LIST,
30 * (100 + 50),
HISTORY_FILES_LIST[: 2 * (30)], # trim 30 full days
),
(
_xhj_gc_commands_to_rmfiles,
20 * (100 + 50) + 100, # keep 20 full newest and evening before (41 files)
HISTORY_FILES_LIST,
30 * (100 + 50) - 50, # trim 30 full oldest, keep newest evening (59 files)
HISTORY_FILES_LIST[: 2 * 30 - 1],
),
# xhj_gc_files_to_rmfiles
(
_xhj_gc_files_to_rmfiles,
1001, # Limit > history, no trimming.
HISTORY_FILES_LIST,
0, # nothing trimmed
[], #
),
(
_xhj_gc_files_to_rmfiles,
40, # keep 20 full days (40 files)
HISTORY_FILES_LIST,
60,
HISTORY_FILES_LIST[:60], # trim 30 full days
),
(
_xhj_gc_files_to_rmfiles,
41, # keep 20 full newest and evening before (41 files)
HISTORY_FILES_LIST,
59, # trim 30 full oldest, keep newest evening (59 files)
HISTORY_FILES_LIST[: 2 * 30 - 1],
),
# xhj_gc_bytes_to_rmfiles
(
_xhj_gc_bytes_to_rmfiles,
1001 * (10000 + 2500), # Limit > history, no trimming.
HISTORY_FILES_LIST,
0, # nothing trimmed
[], #
),
(
_xhj_gc_bytes_to_rmfiles,
20 * (10000 + 2500), # keep 20 full days (40 files)
HISTORY_FILES_LIST,
30 * (10000 + 2500),
HISTORY_FILES_LIST[: 2 * (30)], # trim 30 full days
),
(
_xhj_gc_bytes_to_rmfiles,
20 * (10000 + 2500)
+ 10000, # keep 20 full newest and evening before (41 files)
HISTORY_FILES_LIST,
30 * (10000 + 2500)
- 2500, # trim 30 full oldest, keep newest evening (59 files)
HISTORY_FILES_LIST[: 2 * 30 - 1],
),
# xhj_gc_seconds_to_rmfiles
(
_xhj_gc_seconds_to_rmfiles,
SEC_FROM_LATEST + 1001 * SEC_PER_DAY, # Limit > history, no trimming.
HISTORY_FILES_LIST,
0, # nothing trimmed
[], #
),
(
_xhj_gc_seconds_to_rmfiles,
SEC_FROM_LATEST + MAX_RUNTIME, # keep just the latest file (night)
HISTORY_FILES_LIST,
HISTORY_FILES_LIST[-1][0] - HISTORY_FILES_LIST[0][0],
HISTORY_FILES_LIST[:-1],
),
(
_xhj_gc_seconds_to_rmfiles,
# keep the latest file and previous day, so we'll get three files
# including the previous morning and night before
SEC_FROM_LATEST + SEC_PER_DAY + MAX_RUNTIME,
HISTORY_FILES_LIST,
HISTORY_FILES_LIST[-3][0] - HISTORY_FILES_LIST[0][0],
HISTORY_FILES_LIST[:-3],
),
],
)
def test__xhj_gc_xx_to_rmfiles(fn, hsize, in_files, exp_size, exp_files, xession):
act_size, act_files = fn(hsize, in_files)
assert act_files == exp_files
# comparing age is approximate, because xhj_gc_seconds_to_rmfiles computes 'now' on each call.
# We find multi-minute variations in CI environments.
# This should cover some amount of think time sitting at a breakpoint, too.
if fn == _xhj_gc_seconds_to_rmfiles:
assert abs(act_size - exp_size) < MAX_RUNTIME
else:
assert act_size == exp_size
def test_hist_clear_cmd(hist, xession, capsys, tmpdir):
"""Verify that the CLI history clear command works."""
xession.env.update({"XONSH_DATA_DIR": str(tmpdir)})
xession.env["HISTCONTROL"] = set()
for ts, cmd in enumerate(CMDS): # populate the shell history
hist.append({"inp": cmd, "rtn": 0, "ts": (ts + 1, ts + 1.5)})
assert len(xession.history) == 6
history_main(["clear"])
out, err = capsys.readouterr()
assert err.rstrip() == "History cleared"
assert len(xession.history) == 0
def test_hist_off_cmd(hist, xession, capsys, tmpdir):
"""Verify that the CLI history off command works."""
xession.env.update({"XONSH_DATA_DIR": str(tmpdir)})
xession.env["HISTCONTROL"] = set()
for ts, cmd in enumerate(CMDS): # populate the shell history
hist.append({"inp": cmd, "rtn": 0, "ts": (ts + 1, ts + 1.5)})
assert len(xession.history) == 6
history_main(["off"])
out, err = capsys.readouterr()
assert err.rstrip() == "History off"
assert len(xession.history) == 0
for ts, cmd in enumerate(CMDS): # attempt to populate the shell history
hist.append({"inp": cmd, "rtn": 0, "ts": (ts + 1, ts + 1.5)})
assert len(xession.history) == 0
def test_hist_on_cmd(hist, xession, capsys, tmpdir):
"""Verify that the CLI history on command works."""
xession.env.update({"XONSH_DATA_DIR": str(tmpdir)})
xession.env["HISTCONTROL"] = set()
for ts, cmd in enumerate(CMDS): # populate the shell history
hist.append({"inp": cmd, "rtn": 0, "ts": (ts + 1, ts + 1.5)})
assert len(xession.history) == 6
history_main(["off"])
history_main(["on"])
out, err = capsys.readouterr()
assert err.rstrip().endswith("History on")
assert len(xession.history) == 0
for ts, cmd in enumerate(CMDS): # populate the shell history
hist.append({"inp": cmd, "rtn": 0, "ts": (ts + 1, ts + 1.5)})
assert len(xession.history) == 6
|