-
Notifications
You must be signed in to change notification settings - Fork 236
Expand file tree
/
Copy pathtest_progress.py
More file actions
1425 lines (1106 loc) · 45.5 KB
/
test_progress.py
File metadata and controls
1425 lines (1106 loc) · 45.5 KB
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
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Tests for tmuxp CLI progress indicator."""
from __future__ import annotations
import atexit
import io
import pathlib
import time
import typing as t
import libtmux
import pytest
from tmuxp.cli._colors import ColorMode
from tmuxp.cli._progress import (
BAR_WIDTH,
ERASE_LINE,
HIDE_CURSOR,
PROGRESS_PRESETS,
SHOW_CURSOR,
SUCCESS_TEMPLATE,
BuildTree,
Spinner,
_truncate_visible,
_visible_len,
render_bar,
resolve_progress_format,
)
class SpinnerEnablementFixture(t.NamedTuple):
"""Test fixture for spinner TTY/color enablement matrix."""
test_id: str
isatty: bool
color_mode: ColorMode
expected_enabled: bool
SPINNER_ENABLEMENT_FIXTURES: list[SpinnerEnablementFixture] = [
SpinnerEnablementFixture("tty_color_always", True, ColorMode.ALWAYS, True),
SpinnerEnablementFixture("tty_color_auto", True, ColorMode.AUTO, True),
SpinnerEnablementFixture("tty_color_never", True, ColorMode.NEVER, True),
SpinnerEnablementFixture("non_tty_color_always", False, ColorMode.ALWAYS, False),
SpinnerEnablementFixture("non_tty_color_never", False, ColorMode.NEVER, False),
]
@pytest.mark.parametrize(
list(SpinnerEnablementFixture._fields),
SPINNER_ENABLEMENT_FIXTURES,
ids=[f.test_id for f in SPINNER_ENABLEMENT_FIXTURES],
)
def test_spinner_enablement(
test_id: str,
isatty: bool,
color_mode: ColorMode,
expected_enabled: bool,
) -> None:
"""Spinner._enabled depends only on TTY, not on color mode."""
stream = io.StringIO()
stream.isatty = lambda: isatty # type: ignore[method-assign]
spinner = Spinner(message="Test", color_mode=color_mode, stream=stream)
assert spinner._enabled is expected_enabled
def test_spinner_disabled_output() -> None:
"""Disabled spinner produces no output."""
stream = io.StringIO()
stream.isatty = lambda: False # type: ignore[method-assign]
with Spinner(message="Test", stream=stream) as spinner:
spinner.update_message("Updated")
assert stream.getvalue() == ""
def test_spinner_enabled_output() -> None:
"""Enabled spinner writes ANSI control sequences."""
stream = io.StringIO()
stream.isatty = lambda: True # type: ignore[method-assign]
with Spinner(
message="Test", color_mode=ColorMode.ALWAYS, stream=stream, interval=0.01
):
pass # enter and exit — enough for at least one frame + cleanup
output = stream.getvalue()
assert HIDE_CURSOR in output
assert SHOW_CURSOR in output
assert ERASE_LINE in output
assert "Test" in output
def test_spinner_atexit_registered(monkeypatch: pytest.MonkeyPatch) -> None:
"""atexit.register called on start, unregistered on stop."""
registered: list[t.Any] = []
unregistered: list[t.Any] = []
monkeypatch.setattr(atexit, "register", lambda fn, *a: registered.append(fn))
monkeypatch.setattr(atexit, "unregister", lambda fn: unregistered.append(fn))
stream = io.StringIO()
stream.isatty = lambda: True # type: ignore[method-assign]
with Spinner(message="Test", color_mode=ColorMode.ALWAYS, stream=stream) as spinner:
assert len(registered) == 1
assert spinner._restore_cursor in registered
assert len(unregistered) == 1
assert spinner._restore_cursor in unregistered
def test_spinner_cleans_up_on_exception() -> None:
"""SHOW_CURSOR written even when body raises."""
stream = io.StringIO()
stream.isatty = lambda: True # type: ignore[method-assign]
msg = "deliberate"
with (
pytest.raises(ValueError),
Spinner(message="Test", color_mode=ColorMode.ALWAYS, stream=stream),
):
raise ValueError(msg)
assert SHOW_CURSOR in stream.getvalue()
def test_spinner_update_message_thread_safe() -> None:
"""update_message() can be called from the main thread without error."""
stream = io.StringIO()
stream.isatty = lambda: False # type: ignore[method-assign]
spinner = Spinner(message="Start", color_mode=ColorMode.NEVER, stream=stream)
spinner.update_message("Updated")
assert spinner.message == "Updated"
def test_spinner_add_output_line_accumulates() -> None:
"""add_output_line() appends stripped lines to the panel deque on TTY."""
stream = io.StringIO()
stream.isatty = lambda: True # type: ignore[method-assign]
spinner = Spinner(message="Test", color_mode=ColorMode.NEVER, stream=stream)
spinner.add_output_line("Session created: test\n")
spinner.add_output_line("Creating window: editor")
spinner.add_output_line("") # blank lines are ignored
assert list(spinner._output_lines) == [
"Session created: test",
"Creating window: editor",
]
def test_spinner_panel_respects_maxlen() -> None:
"""Panel deque enforces output_lines maxlen, dropping oldest lines."""
stream = io.StringIO()
stream.isatty = lambda: True # type: ignore[method-assign]
spinner = Spinner(
message="Test", color_mode=ColorMode.NEVER, stream=stream, output_lines=3
)
for i in range(5):
spinner.add_output_line(f"line {i}")
panel = list(spinner._output_lines)
assert len(panel) == 3
assert panel == ["line 2", "line 3", "line 4"]
def test_spinner_panel_rendered_in_output() -> None:
"""Enabled spinner writes panel lines and spinner line to stream."""
stream = io.StringIO()
stream.isatty = lambda: True # type: ignore[method-assign]
with Spinner(
message="Building...", color_mode=ColorMode.ALWAYS, stream=stream, interval=0.01
) as spinner:
spinner.add_output_line("Session created: my-session")
# Wait long enough for the spinner thread to render at least one frame
# that includes the panel line (interval=0.01s, so 0.05s is sufficient).
time.sleep(0.05)
output = stream.getvalue()
assert HIDE_CURSOR in output
assert SHOW_CURSOR in output
assert "Session created: my-session" in output
assert "Building..." in output
# BuildTree tests
def test_build_tree_empty_renders_nothing() -> None:
"""BuildTree.render() returns [] before any session_created event."""
colors = ColorMode.NEVER
tree = BuildTree()
from tmuxp.cli._colors import Colors
assert tree.render(Colors(colors), 80) == []
def test_build_tree_session_created_shows_header() -> None:
"""After session_created, render() returns the 'Session' heading line."""
from tmuxp.cli._colors import Colors
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "my-session"})
lines = tree.render(Colors(ColorMode.NEVER), 80)
assert lines == ["Session"]
def test_build_tree_window_started_no_pane_yet() -> None:
"""window_started adds a window line with just the name (no pane info)."""
from tmuxp.cli._colors import Colors
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "my-session"})
tree.on_event({"event": "window_started", "name": "editor", "pane_total": 2})
lines = tree.render(Colors(ColorMode.NEVER), 80)
assert len(lines) == 2
assert lines[1] == "- editor"
def test_build_tree_pane_creating_shows_progress() -> None:
"""pane_creating updates the last window to show pane N of M."""
from tmuxp.cli._colors import Colors
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "my-session"})
tree.on_event({"event": "window_started", "name": "editor", "pane_total": 3})
tree.on_event({"event": "pane_creating", "pane_num": 2, "pane_total": 3})
lines = tree.render(Colors(ColorMode.NEVER), 80)
assert lines[1] == "- editor, pane (2 of 3)"
def test_build_tree_window_done_shows_checkmark() -> None:
"""window_done marks the window as done; render shows checkmark."""
from tmuxp.cli._colors import Colors
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "my-session"})
tree.on_event({"event": "window_started", "name": "editor", "pane_total": 1})
tree.on_event({"event": "pane_creating", "pane_num": 1, "pane_total": 1})
tree.on_event({"event": "window_done"})
lines = tree.render(Colors(ColorMode.NEVER), 80)
assert lines[1] == "- ✓ editor"
def test_build_tree_workspace_built_marks_all_done() -> None:
"""workspace_built marks all windows as done."""
from tmuxp.cli._colors import Colors
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "my-session"})
tree.on_event({"event": "window_started", "name": "editor", "pane_total": 1})
tree.on_event({"event": "window_started", "name": "logs", "pane_total": 1})
tree.on_event({"event": "workspace_built"})
lines = tree.render(Colors(ColorMode.NEVER), 80)
assert lines[1] == "- ✓ editor"
assert lines[2] == "- ✓ logs"
def test_build_tree_multiple_windows_accumulate() -> None:
"""Multiple window_started events accumulate into separate tree lines."""
from tmuxp.cli._colors import Colors
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "my-session"})
tree.on_event({"event": "window_started", "name": "editor", "pane_total": 2})
tree.on_event({"event": "window_done"})
tree.on_event({"event": "window_started", "name": "logging", "pane_total": 1})
tree.on_event({"event": "pane_creating", "pane_num": 1, "pane_total": 1})
lines = tree.render(Colors(ColorMode.NEVER), 80)
assert lines[1] == "- ✓ editor"
assert lines[2] == "- logging, pane (1 of 1)"
def test_spinner_on_build_event_delegates_to_tree() -> None:
"""Spinner.on_build_event() updates the internal BuildTree state."""
import io
stream = io.StringIO()
stream.isatty = lambda: False # type: ignore[method-assign]
spinner = Spinner(message="Building...", color_mode=ColorMode.NEVER, stream=stream)
spinner.on_build_event({"event": "session_created", "name": "test-session"})
spinner.on_build_event(
{"event": "window_started", "name": "editor", "pane_total": 1}
)
assert spinner._build_tree.session_name == "test-session"
assert len(spinner._build_tree.windows) == 1
assert spinner._build_tree.windows[0].name == "editor"
# BuildTree.format_inline tests
def test_build_tree_format_inline_empty() -> None:
"""format_inline returns base unchanged when no session has been created."""
tree = BuildTree()
assert tree.format_inline("Building projects...") == "Building projects..."
def test_build_tree_format_inline_session_only() -> None:
"""format_inline returns 'base session' after session_created with no windows."""
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "cihai", "window_total": 3})
assert tree.format_inline("Building projects...") == "Building projects... cihai"
def test_build_tree_format_inline_with_window_total() -> None:
"""format_inline shows window index/total bracket after window_started."""
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "cihai", "window_total": 3})
tree.on_event({"event": "window_started", "name": "gp-libs", "pane_total": 2})
result = tree.format_inline("Building projects...")
assert result == "Building projects... cihai [1 of 3 windows] gp-libs"
def test_build_tree_format_inline_with_panes() -> None:
"""format_inline includes pane progress once pane_creating fires."""
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "cihai", "window_total": 3})
tree.on_event({"event": "window_started", "name": "gp-libs", "pane_total": 2})
tree.on_event({"event": "pane_creating", "pane_num": 1, "pane_total": 2})
result = tree.format_inline("Building projects...")
assert result == "Building projects... cihai [1 of 3 windows, 1 of 2 panes] gp-libs"
def test_build_tree_format_inline_no_window_total() -> None:
"""format_inline omits window count bracket when window_total is absent."""
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "cihai"})
tree.on_event({"event": "window_started", "name": "main", "pane_total": 1})
tree.on_event({"event": "pane_creating", "pane_num": 1, "pane_total": 1})
result = tree.format_inline("Building...")
assert result == "Building... cihai [1 of 1 panes] main"
def test_spinner_on_build_event_updates_message() -> None:
"""on_build_event updates spinner.message via format_inline after each event."""
stream = io.StringIO()
stream.isatty = lambda: False # type: ignore[method-assign]
spinner = Spinner(
message="Building...",
color_mode=ColorMode.NEVER,
stream=stream,
progress_format=None,
)
assert spinner.message == "Building..."
spinner.on_build_event(
{"event": "session_created", "name": "cihai", "window_total": 2}
)
assert spinner.message == "Building... cihai"
spinner.on_build_event(
{"event": "window_started", "name": "editor", "pane_total": 3}
)
assert spinner.message == "Building... cihai [1 of 2 windows] editor"
spinner.on_build_event({"event": "pane_creating", "pane_num": 2, "pane_total": 3})
assert spinner.message == "Building... cihai [1 of 2 windows, 2 of 3 panes] editor"
# resolve_progress_format tests
def test_resolve_progress_format_preset_name() -> None:
"""A known preset name resolves to its format string."""
assert resolve_progress_format("default") == PROGRESS_PRESETS["default"]
assert resolve_progress_format("minimal") == PROGRESS_PRESETS["minimal"]
assert resolve_progress_format("verbose") == PROGRESS_PRESETS["verbose"]
def test_resolve_progress_format_raw_string() -> None:
"""A raw template string is returned unchanged."""
raw = "{session} w{window_progress}"
assert resolve_progress_format(raw) == raw
def test_resolve_progress_format_unknown_name() -> None:
"""An unknown name not in presets is returned as-is (raw template pass-through)."""
assert resolve_progress_format("not-a-preset") == "not-a-preset"
# BuildTree.format_template tests
def test_build_tree_format_template_before_session() -> None:
"""format_template returns '' before session_created fires."""
tree = BuildTree()
assert tree.format_template("{session} [{progress}] {window}") == ""
def test_build_tree_format_template_session_only() -> None:
"""After session_created alone, progress and window are empty."""
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "cihai", "window_total": 3})
assert tree.format_template("{session} [{progress}] {window}") == "cihai [] "
def test_build_tree_format_template_with_window() -> None:
"""After window_started, window progress appears but pane progress does not."""
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "cihai", "window_total": 3})
tree.on_event({"event": "window_started", "name": "editor", "pane_total": 4})
assert (
tree.format_template("{session} [{progress}] {window}")
== "cihai [1/3 win] editor"
)
def test_build_tree_format_template_with_pane() -> None:
"""After pane_creating, both window and pane progress appear."""
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "cihai", "window_total": 3})
tree.on_event({"event": "window_started", "name": "editor", "pane_total": 4})
tree.on_event({"event": "pane_creating", "pane_num": 2, "pane_total": 4})
assert (
tree.format_template("{session} [{progress}] {window}")
== "cihai [1/3 win · 2/4 pane] editor"
)
def test_build_tree_format_template_minimal() -> None:
"""The minimal preset-style template shows only window fraction."""
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "cihai", "window_total": 3})
tree.on_event({"event": "window_started", "name": "editor", "pane_total": 4})
assert tree.format_template("{session} [{window_progress}]") == "cihai [1/3]"
def test_build_tree_format_template_verbose() -> None:
"""Verbose template shows window/pane indices and totals explicitly."""
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "cihai", "window_total": 12})
tree.on_event({"event": "window_started", "name": "editor", "pane_total": 4})
tree.on_event({"event": "pane_creating", "pane_num": 2, "pane_total": 4})
result = tree.format_template(PROGRESS_PRESETS["verbose"])
assert result == "Loading workspace: cihai [window 1 of 12 · pane 2 of 4] editor"
def test_build_tree_format_template_bad_token() -> None:
"""Unknown tokens are left as {name}, known tokens still resolve."""
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "cihai", "window_total": 3})
result = tree.format_template("{session} {unknown}")
# _SafeFormatMap: {session} resolves, {unknown} stays as-is
assert result == "cihai {unknown}"
# Spinner.progress_format integration tests
def test_spinner_progress_format_updates_message() -> None:
"""Spinner with explicit progress_format uses format_template for updates."""
stream = io.StringIO()
stream.isatty = lambda: False # type: ignore[method-assign]
# Use an explicit format string rather than "default" preset to avoid
# coupling this test to the preset definition (which now includes {bar}).
spinner = Spinner(
message="Building...",
color_mode=ColorMode.NEVER,
stream=stream,
progress_format="{session} [{progress}] {window}",
)
assert spinner.message == "Building..."
spinner.on_build_event(
{"event": "session_created", "name": "cihai", "window_total": 3}
)
# No windows yet — falls back to base message to avoid showing empty brackets.
assert spinner.message == "Building..."
spinner.on_build_event(
{"event": "window_started", "name": "editor", "pane_total": 4}
)
assert spinner.message == "cihai [1/3 win] editor"
spinner.on_build_event({"event": "pane_creating", "pane_num": 2, "pane_total": 4})
assert spinner.message == "cihai [1/3 win · 2/4 pane] editor"
def test_spinner_progress_format_none_uses_inline() -> None:
"""Spinner with progress_format=None preserves the format_inline path."""
stream = io.StringIO()
stream.isatty = lambda: False # type: ignore[method-assign]
spinner = Spinner(
message="Building...",
color_mode=ColorMode.NEVER,
stream=stream,
progress_format=None,
)
spinner.on_build_event(
{"event": "session_created", "name": "cihai", "window_total": 2}
)
assert spinner.message == "Building... cihai"
spinner.on_build_event(
{"event": "window_started", "name": "editor", "pane_total": 3}
)
assert spinner.message == "Building... cihai [1 of 2 windows] editor"
# render_bar tests
def test_render_bar_empty() -> None:
"""render_bar with done=0 produces an all-empty bar."""
assert render_bar(0, 10) == "░░░░░░░░░░"
def test_render_bar_half() -> None:
"""render_bar with done=5, total=10 fills exactly half."""
assert render_bar(5, 10) == "█████░░░░░"
def test_render_bar_full() -> None:
"""render_bar with done=total fills the entire bar."""
assert render_bar(10, 10) == "██████████"
def test_render_bar_zero_total() -> None:
"""render_bar with total=0 returns empty string."""
assert render_bar(0, 0) == ""
def test_render_bar_custom_width() -> None:
"""render_bar with custom width produces bar of that inner width."""
assert render_bar(3, 10, width=5) == "█░░░░"
def test_render_bar_width_constant() -> None:
"""BAR_WIDTH is the default inner width used by render_bar."""
bar = render_bar(0, 10)
assert len(bar) == BAR_WIDTH
# BuildTree new token tests
def test_build_tree_context_session_pane_total() -> None:
"""session_pane_total token reflects count from session_created event."""
tree = BuildTree()
tree.on_event(
{
"event": "session_created",
"name": "s",
"window_total": 2,
"session_pane_total": 8,
}
)
ctx = tree._context()
assert ctx["session_pane_total"] == 8
assert ctx["session_pane_progress"] == "0/8"
assert ctx["overall_percent"] == 0
def test_build_tree_context_window_progress_rel() -> None:
"""window_progress_rel is 0/N from session_created, increments on window_done."""
tree = BuildTree()
tree.on_event(
{
"event": "session_created",
"name": "s",
"window_total": 3,
"session_pane_total": 6,
}
)
assert tree._context()["window_progress_rel"] == "0/3"
tree.on_event({"event": "window_started", "name": "w1", "pane_total": 2})
assert tree._context()["window_progress_rel"] == "0/3"
tree.on_event({"event": "window_done"})
assert tree._context()["window_progress_rel"] == "1/3"
def test_build_tree_context_pane_progress_rel() -> None:
"""pane_progress_rel shows 0/M after window_started, N/M after pane_creating."""
tree = BuildTree()
tree.on_event(
{
"event": "session_created",
"name": "s",
"window_total": 1,
"session_pane_total": 4,
}
)
tree.on_event({"event": "window_started", "name": "w1", "pane_total": 4})
assert tree._context()["pane_progress_rel"] == "0/4"
tree.on_event({"event": "pane_creating", "pane_num": 2, "pane_total": 4})
assert tree._context()["pane_progress_rel"] == "2/4"
assert tree._context()["pane_done"] == 2
assert tree._context()["pane_remaining"] == 2
def test_build_tree_context_overall_percent() -> None:
"""overall_percent is pane-based 0-100; updates on window_done."""
tree = BuildTree()
tree.on_event(
{
"event": "session_created",
"name": "s",
"window_total": 2,
"session_pane_total": 8,
}
)
assert tree._context()["overall_percent"] == 0
tree.on_event({"event": "window_started", "name": "w1", "pane_total": 4})
tree.on_event({"event": "window_done"})
assert tree._context()["session_panes_done"] == 4
assert tree._context()["overall_percent"] == 50
def test_build_tree_before_script_event_toggle() -> None:
"""before_script_started sets the Event; before_script_done clears it."""
tree = BuildTree()
assert not tree._before_script_event.is_set()
tree.on_event({"event": "before_script_started"})
assert tree._before_script_event.is_set()
tree.on_event({"event": "before_script_done"})
assert not tree._before_script_event.is_set()
def test_build_tree_zero_pane_window() -> None:
"""Windows with pane_total=0 do not cause division-by-zero or exceptions."""
tree = BuildTree()
tree.on_event(
{
"event": "session_created",
"name": "s",
"window_total": 1,
"session_pane_total": 0,
}
)
tree.on_event({"event": "window_started", "name": "w1", "pane_total": 0})
tree.on_event({"event": "window_done"})
assert tree.session_panes_done == 0
assert tree.windows_done == 1
ctx = tree._context()
assert ctx["session_pane_progress"] == ""
assert ctx["overall_percent"] == 0
def test_format_template_extra_backward_compat() -> None:
"""format_template(fmt) without extra still works as before."""
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "cihai", "window_total": 3})
result = tree.format_template("{session} [{progress}] {window}")
assert result == "cihai [] "
def test_format_template_extra_injected() -> None:
"""format_template resolves extra tokens from the extra dict."""
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "cihai", "window_total": 3})
result = tree.format_template("{session} {bar}", extra={"bar": "[TEST_BAR]"})
assert result == "cihai [TEST_BAR]"
def test_format_template_unknown_token_preserved() -> None:
"""Unknown tokens in the format string render as {name}, not blank or raw fmt."""
tree = BuildTree()
tree.on_event({"event": "session_created", "name": "cihai", "window_total": 3})
result = tree.format_template("{session} {unknown_token}")
assert result == "cihai {unknown_token}"
# Spinner bar token tests
def test_spinner_bar_token_no_color() -> None:
"""With ColorMode.NEVER, {bar} token in message contains bar characters."""
stream = io.StringIO()
stream.isatty = lambda: False # type: ignore[method-assign]
spinner = Spinner(
message="Building...",
color_mode=ColorMode.NEVER,
stream=stream,
progress_format="{session} {bar} {progress} {window}",
)
spinner.on_build_event(
{
"event": "session_created",
"name": "cihai",
"window_total": 3,
"session_pane_total": 6,
}
)
spinner.on_build_event(
{"event": "window_started", "name": "editor", "pane_total": 2}
)
spinner.on_build_event({"event": "pane_creating", "pane_num": 1, "pane_total": 2})
assert "░" in spinner.message or "█" in spinner.message
def test_spinner_pane_bar_preset() -> None:
"""The 'pane' preset wires {pane_bar} and {session_pane_progress}."""
stream = io.StringIO()
stream.isatty = lambda: False # type: ignore[method-assign]
spinner = Spinner(
message="Building...",
color_mode=ColorMode.NEVER,
stream=stream,
progress_format="pane",
)
spinner.on_build_event(
{
"event": "session_created",
"name": "s",
"window_total": 2,
"session_pane_total": 4,
}
)
spinner.on_build_event({"event": "window_started", "name": "w1", "pane_total": 2})
spinner.on_build_event({"event": "window_done"})
assert "2/4" in spinner.message
assert "░" in spinner.message or "█" in spinner.message
def test_spinner_before_script_event_via_events() -> None:
"""before_script_started / before_script_done toggle the BuildTree Event flag."""
stream = io.StringIO()
stream.isatty = lambda: False # type: ignore[method-assign]
spinner = Spinner(
message="Building...",
color_mode=ColorMode.NEVER,
stream=stream,
progress_format="default",
)
spinner.on_build_event({"event": "before_script_started"})
assert spinner._build_tree._before_script_event.is_set()
spinner.on_build_event({"event": "before_script_done"})
assert not spinner._build_tree._before_script_event.is_set()
def test_progress_presets_have_expected_keys() -> None:
"""All expected preset names are present in PROGRESS_PRESETS."""
for name in ("default", "minimal", "window", "pane", "verbose"):
assert name in PROGRESS_PRESETS, f"Missing preset: {name}"
def test_progress_presets_default_includes_bar() -> None:
"""The 'default' preset includes the {bar} token."""
assert "{bar}" in PROGRESS_PRESETS["default"]
def test_progress_presets_minimal_format() -> None:
"""The 'minimal' preset includes the Loading prefix and window_progress token."""
expected = "Loading workspace: {session} [{window_progress}]"
assert PROGRESS_PRESETS["minimal"] == expected
# BuildTree remaining token tests
class RemainingTokenFixture(t.NamedTuple):
"""Test fixture for windows_remaining and session_panes_remaining tokens."""
test_id: str
events: list[dict[str, t.Any]]
token: str
expected: int
REMAINING_TOKEN_FIXTURES: list[RemainingTokenFixture] = [
RemainingTokenFixture(
"windows_remaining_initial",
[
{
"event": "session_created",
"name": "s",
"window_total": 3,
"session_pane_total": 6,
},
],
"windows_remaining",
3,
),
RemainingTokenFixture(
"windows_remaining_after_done",
[
{
"event": "session_created",
"name": "s",
"window_total": 3,
"session_pane_total": 6,
},
{"event": "window_started", "name": "w1", "pane_total": 2},
{"event": "window_done"},
],
"windows_remaining",
2,
),
RemainingTokenFixture(
"session_panes_remaining_initial",
[
{
"event": "session_created",
"name": "s",
"window_total": 2,
"session_pane_total": 5,
},
],
"session_panes_remaining",
5,
),
RemainingTokenFixture(
"session_panes_remaining_after_window",
[
{
"event": "session_created",
"name": "s",
"window_total": 2,
"session_pane_total": 5,
},
{"event": "window_started", "name": "w1", "pane_total": 3},
{"event": "window_done"},
],
"session_panes_remaining",
2,
),
]
@pytest.mark.parametrize(
list(RemainingTokenFixture._fields),
REMAINING_TOKEN_FIXTURES,
ids=[f.test_id for f in REMAINING_TOKEN_FIXTURES],
)
def test_build_tree_remaining_tokens(
test_id: str,
events: list[dict[str, t.Any]],
token: str,
expected: int,
) -> None:
"""Remaining tokens decrement correctly as windows/panes complete."""
tree = BuildTree()
for ev in events:
tree.on_event(ev)
assert tree._context()[token] == expected
# _visible_len tests
class VisibleLenFixture(t.NamedTuple):
"""Test fixture for _visible_len ANSI-aware length calculation."""
test_id: str
text: str
expected_len: int
VISIBLE_LEN_FIXTURES: list[VisibleLenFixture] = [
VisibleLenFixture("plain_text", "hello", 5),
VisibleLenFixture("ansi_green", "\033[32mgreen\033[0m", 5),
VisibleLenFixture("empty_string", "", 0),
VisibleLenFixture("nested_ansi", "\033[1m\033[31mbold red\033[0m", 8),
VisibleLenFixture("ansi_only", "\033[0m", 0),
]
@pytest.mark.parametrize(
list(VisibleLenFixture._fields),
VISIBLE_LEN_FIXTURES,
ids=[f.test_id for f in VISIBLE_LEN_FIXTURES],
)
def test_visible_len(
test_id: str,
text: str,
expected_len: int,
) -> None:
"""_visible_len returns the visible character count, ignoring ANSI escapes."""
assert _visible_len(text) == expected_len
# Spinner.add_output_line non-TTY write-through tests
class OutputLineFixture(t.NamedTuple):
"""Test fixture for add_output_line TTY vs non-TTY behavior."""
test_id: str
isatty: bool
lines: list[str]
expected_deque: list[str]
expected_stream_contains: str
OUTPUT_LINE_FIXTURES: list[OutputLineFixture] = [
OutputLineFixture(
"tty_accumulates_in_deque",
isatty=True,
lines=["line1\n", "line2\n"],
expected_deque=["line1", "line2"],
expected_stream_contains="",
),
OutputLineFixture(
"non_tty_writes_to_stream",
isatty=False,
lines=["hello\n", "world\n"],
expected_deque=[],
expected_stream_contains="hello\nworld\n",
),
OutputLineFixture(
"blank_lines_ignored",
isatty=True,
lines=["", "\n"],
expected_deque=[],
expected_stream_contains="",
),
]
@pytest.mark.parametrize(
list(OutputLineFixture._fields),
OUTPUT_LINE_FIXTURES,
ids=[f.test_id for f in OUTPUT_LINE_FIXTURES],
)
def test_spinner_output_line_behavior(
test_id: str,
isatty: bool,
lines: list[str],
expected_deque: list[str],
expected_stream_contains: str,
) -> None:
"""add_output_line accumulates in deque (TTY) or writes to stream (non-TTY)."""
stream = io.StringIO()
stream.isatty = lambda: isatty # type: ignore[method-assign]
spinner = Spinner(message="Test", color_mode=ColorMode.NEVER, stream=stream)
for line in lines:
spinner.add_output_line(line)
assert list(spinner._output_lines) == expected_deque
assert expected_stream_contains in stream.getvalue()
# Spinner.success tests
# Panel lines special values tests
class PanelLinesFixture(t.NamedTuple):
"""Test fixture for Spinner panel_lines special values."""
test_id: str
output_lines: int
expected_maxlen: int | None # None = unbounded
expected_hidden: bool
add_count: int
expected_retained: int
PANEL_LINES_FIXTURES: list[PanelLinesFixture] = [
PanelLinesFixture("zero_hides_panel", 0, 1, True, 10, 1),
PanelLinesFixture("negative_unlimited", -1, None, False, 100, 100),
PanelLinesFixture("positive_normal", 5, 5, False, 10, 5),
PanelLinesFixture("default_three", 3, 3, False, 5, 3),
]
@pytest.mark.parametrize(
list(PanelLinesFixture._fields),
PANEL_LINES_FIXTURES,
ids=[f.test_id for f in PANEL_LINES_FIXTURES],
)
def test_spinner_panel_lines_special_values(
test_id: str,
output_lines: int,
expected_maxlen: int | None,
expected_hidden: bool,
add_count: int,
expected_retained: int,
) -> None:
"""Spinner panel_lines=0 hides, -1 is unlimited, positive caps normally."""
stream = io.StringIO()
stream.isatty = lambda: True # type: ignore[method-assign]