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
|
import time
import pytest # type: ignore[import-not-found]
import pipx.animate
from pipx.animate import (
CLEAR_LINE,
EMOJI_ANIMATION_FRAMES,
EMOJI_FRAME_PERIOD,
NONEMOJI_ANIMATION_FRAMES,
NONEMOJI_FRAME_PERIOD,
)
# 40-char test_string counts columns e.g.: "0204060810 ... 363840"
TEST_STRING_40_CHAR = "".join([f"{x:02}" for x in range(2, 41, 2)])
def check_animate_output(
capsys,
test_string,
frame_strings,
frame_period,
frames_to_test,
extra_animate_time=0.4,
extra_after_thread_time=0.1,
):
# github workflow history (2020-07-27):
# extra_animate_time <= 0.3 failed on macos
# extra_after_thread_time <= 0.0 failed on macos
expected_string = "".join(frame_strings)
chars_to_test = 1 + len("".join(frame_strings[:frames_to_test]))
with pipx.animate.animate(test_string, do_animation=True):
time.sleep(frame_period * (frames_to_test - 1) + extra_animate_time)
# Wait before capturing stderr to ensure animate thread is finished
# and to capture all its characters.
time.sleep(extra_after_thread_time)
captured = capsys.readouterr()
print("check_animate_output() Test Debug Output:")
if len(captured.err) < chars_to_test:
print("Not enough captured characters--Likely need to increase extra_animate_time")
print(f"captured characters: {len(captured.err)}")
print(f"chars_to_test: {chars_to_test}")
for i in range(0, chars_to_test, 40):
i_end = min(i + 40, chars_to_test)
print(f"expected_string[{i}:{i_end}]: {expected_string[i:i_end]!r}")
print(f"captured.err[{i}:{i_end}] : {captured.err[i:i_end]!r}")
assert captured.err[:chars_to_test] == expected_string[:chars_to_test]
def test_delay_suppresses_output(capsys, monkeypatch):
monkeypatch.setattr(pipx.animate, "stderr_is_tty", True)
monkeypatch.setenv("COLUMNS", "80")
test_string = "asdf"
with pipx.animate.animate(test_string, do_animation=True, delay=0.9):
time.sleep(0.5)
captured = capsys.readouterr()
assert test_string not in captured.err
@pytest.mark.parametrize(
"env_columns,expected_frame_message",
[
(45, f"{TEST_STRING_40_CHAR:.{45 - 6}}..."),
(46, f"{TEST_STRING_40_CHAR}"),
(47, f"{TEST_STRING_40_CHAR}"),
],
)
def test_line_lengths_emoji(capsys, monkeypatch, env_columns, expected_frame_message):
# EMOJI_SUPPORT and stderr_is_tty is set only at import animate.py
# since we are already after that, we must override both here
monkeypatch.setattr(pipx.animate, "stderr_is_tty", True)
monkeypatch.setattr(pipx.animate, "EMOJI_SUPPORT", True)
monkeypatch.setenv("COLUMNS", str(env_columns))
frames_to_test = 4
frame_strings = [f"\r{CLEAR_LINE}{x} {expected_frame_message}" for x in EMOJI_ANIMATION_FRAMES]
check_animate_output(capsys, TEST_STRING_40_CHAR, frame_strings, EMOJI_FRAME_PERIOD, frames_to_test)
@pytest.mark.parametrize(
"env_columns,expected_frame_message",
[
(43, f"{TEST_STRING_40_CHAR:.{43 - 4}}"),
(44, f"{TEST_STRING_40_CHAR}"),
(45, f"{TEST_STRING_40_CHAR}"),
],
)
def test_line_lengths_no_emoji(capsys, monkeypatch, env_columns, expected_frame_message):
# EMOJI_SUPPORT and stderr_is_tty is set only at import animate.py
# since we are already after that, we must override both here
monkeypatch.setattr(pipx.animate, "stderr_is_tty", True)
monkeypatch.setattr(pipx.animate, "EMOJI_SUPPORT", False)
monkeypatch.setenv("COLUMNS", str(env_columns))
frames_to_test = 2
frame_strings = [f"\r{CLEAR_LINE}{expected_frame_message}{x}" for x in NONEMOJI_ANIMATION_FRAMES]
check_animate_output(
capsys,
TEST_STRING_40_CHAR,
frame_strings,
NONEMOJI_FRAME_PERIOD,
frames_to_test,
)
@pytest.mark.parametrize("env_columns,stderr_is_tty", [(0, True), (8, True), (16, True), (17, False)])
def test_env_no_animate(capsys, monkeypatch, env_columns, stderr_is_tty):
monkeypatch.setattr(pipx.animate, "stderr_is_tty", stderr_is_tty)
monkeypatch.setenv("COLUMNS", str(env_columns))
frames_to_test = 4
expected_string = f"{TEST_STRING_40_CHAR}...\n"
extra_animate_time = 0.4
extra_after_thread_time = 0.1
with pipx.animate.animate(TEST_STRING_40_CHAR, do_animation=True):
time.sleep(EMOJI_FRAME_PERIOD * (frames_to_test - 1) + extra_animate_time)
time.sleep(extra_after_thread_time)
captured = capsys.readouterr()
assert captured.out == ""
assert captured.err == expected_string
|
