-
Notifications
You must be signed in to change notification settings - Fork 695
Expand file tree
/
Copy pathtest_main_modes_repl.py
More file actions
1330 lines (1071 loc) · 53.1 KB
/
Copy pathtest_main_modes_repl.py
File metadata and controls
1330 lines (1071 loc) · 53.1 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
from __future__ import annotations
import builtins
from collections.abc import Generator, Iterator
from dataclasses import dataclass
from io import StringIO
import os
from types import SimpleNamespace
from typing import Any, Literal, cast
from prompt_toolkit.formatted_text import to_formatted_text, to_plain_text
import pymysql
import pytest
import mycli.main_modes.repl as repl_mode
from mycli.packages.sqlresult import SQLResult
class DummyLogger:
def __init__(self) -> None:
self.debug_calls: list[tuple[tuple[Any, ...], dict[str, Any]]] = []
self.error_calls: list[tuple[tuple[Any, ...], dict[str, Any]]] = []
def debug(self, *args: Any, **kwargs: Any) -> None:
self.debug_calls.append((args, kwargs))
def error(self, *args: Any, **kwargs: Any) -> None:
self.error_calls.append((args, kwargs))
class HashableNamespace:
pass
@dataclass
class DummyFormatterWithQuery:
query: str = ''
class FakeApp:
def __init__(self, text: str = '', render_counter: int = 0) -> None:
self.current_buffer = SimpleNamespace(text=text)
self.render_counter = render_counter
self.ttimeoutlen: float | None = None
class FakePromptOutput:
def __init__(self, columns: int = 80, rows: int = 24) -> None:
self.columns = columns
self.rows = rows
self.bell_count = 0
def get_size(self) -> SimpleNamespace:
return SimpleNamespace(columns=self.columns, rows=self.rows)
def bell(self) -> None:
self.bell_count += 1
class FakePromptSession:
def __init__(self, responses: list[Any] | None = None, columns: int = 80, rows: int = 24) -> None:
self.responses = list(responses or [])
self.output = FakePromptOutput(columns=columns, rows=rows)
self.app = FakeApp()
self.prompt_calls: list[dict[str, Any]] = []
def prompt(self, **kwargs: Any) -> str:
self.prompt_calls.append(dict(kwargs))
if not self.responses:
raise EOFError()
response = self.responses.pop(0)
if isinstance(response, BaseException):
raise response
return response
class FakeCursorBase:
def __init__(
self,
rows: list[tuple[Any, ...]] | None = None,
rowcount: int = 0,
warning_count: int = 0,
) -> None:
self._rows = list(rows or [])
self.rowcount = rowcount
self.warning_count = warning_count
def __iter__(self) -> Iterator[tuple[Any, ...]]:
return iter(self._rows)
class FakeConnection:
def __init__(self, ping_exc: Exception | None = None, cursor_value: Any = 'cursor') -> None:
self.ping_exc = ping_exc
self.cursor_value = cursor_value
self.ping_calls: list[bool] = []
def ping(self, reconnect: bool = False) -> None:
self.ping_calls.append(reconnect)
if self.ping_exc is not None:
raise self.ping_exc
def cursor(self) -> Any:
return self.cursor_value
class ReusableLock:
def __enter__(self) -> 'ReusableLock':
return self
def __exit__(self, exc_type: Any, exc: Any, tb: Any) -> Literal[False]:
return False
def sqlresult_generator(*results: SQLResult) -> Generator[SQLResult, None, None]:
for result in results:
yield result
class FakeResourceTree:
def __init__(self, files: dict[str, str], path: str | None = None) -> None:
self.files = files
self.path = path
def joinpath(self, path: str) -> 'FakeResourceTree':
return FakeResourceTree(self.files, path)
def open(self, mode: str) -> StringIO:
assert self.path is not None
if self.path not in self.files:
raise FileNotFoundError(self.path)
return StringIO(self.files[self.path])
def make_repl_cli(sqlexecute: Any | None = None) -> Any:
cli: Any = HashableNamespace()
cli.logger = DummyLogger()
cli.query_history = []
cli.last_prompt_message = repl_mode.ANSI('')
cli.last_custom_toolbar_message = repl_mode.ANSI('')
cli.prompt_lines = 0
cli.default_prompt = r'\t \u@\h:\d> '
cli.default_prompt_splitln = r'\u@\h\n(\t):\d>'
cli.max_len_prompt = 45
cli.prompt_format = cli.default_prompt
cli.multiline_continuation_char = '>'
cli.toolbar_format = 'default'
cli.verbosity = -1
cli.keepalive_ticks = None
cli._keepalive_counter = 0
cli.auto_vertical_output = False
cli.beep_after_seconds = 0.0
cli.show_warnings = False
cli.null_string = '<null>'
cli.numeric_alignment = 'right'
cli.binary_display = None
cli.prompt_session = None
cli.post_redirect_command = None
cli.logfile = None
cli.smart_completion = False
cli.config = {'main': {'history_file': '~/.mycli-history-testing'}}
cli.key_bindings = 'emacs'
cli.wider_completion_menu = False
cli.login_path = None
cli.login_path_as_host = False
cli.dsn_alias = None
cli.terminal_tab_title_format = ''
cli.terminal_window_title_format = ''
cli.multiplex_window_title_format = ''
cli.multiplex_pane_title_format = ''
cli._completer_lock = ReusableLock()
cli.completer = object()
cli.syntax_style = 'native'
cli.cli_style = {}
cli.emacs_ttimeoutlen = 1.0
cli.vi_ttimeoutlen = 2.0
cli.sandbox_mode = False
cli.destructive_warning = False
cli.destructive_keywords = ['drop']
cli.llm_prompt_field_truncate = 0
cli.llm_prompt_section_truncate = 0
cli.main_formatter = DummyFormatterWithQuery()
cli.redirect_formatter = DummyFormatterWithQuery()
cli.pager_configured = 0
refresh_calls: list[bool] = []
output_calls: list[tuple[list[str], Any, bool]] = []
echo_calls: list[str] = []
timing_calls: list[tuple[str, bool]] = []
log_queries: list[str] = []
cli.refresh_calls = refresh_calls
cli.output_calls = output_calls
cli.echo_calls = echo_calls
cli.timing_calls = timing_calls
cli.log_queries = log_queries
cli.title_calls = 0
cli.sqlexecute = sqlexecute
cli.get_reserved_space = lambda: 3
cli.get_last_query = lambda: cli.query_history[-1].query if cli.query_history else None
cli.configure_pager = lambda: setattr(cli, 'pager_configured', cli.pager_configured + 1)
def refresh_completions(reset: bool = False) -> list[SQLResult]:
cli.refresh_calls.append(reset)
return [SQLResult(status='refresh')]
cli.refresh_completions = refresh_completions
def output_timing(timing: str, is_warnings_style: bool = False) -> None:
cli.timing_calls.append((timing, is_warnings_style))
cli.output_timing = output_timing
def log_query(text: str) -> None:
cli.log_queries.append(text)
cli.log_query = log_query
cli.reconnect = lambda database='': False
def echo(message: Any, **kwargs: Any) -> None:
cli.echo_calls.append(str(message))
cli.echo = echo
def format_sqlresult(result: SQLResult, **kwargs: Any) -> Iterator[str]:
return iter([str(kwargs.get('max_width')), result.status_plain or 'row'])
cli.format_sqlresult = format_sqlresult
def output(formatted: Any, result: Any, is_warnings_style: bool = False) -> None:
cli.output_calls.append((list(formatted), result, is_warnings_style))
cli.output = output
return cli
def patch_repl_runtime_defaults(monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setattr(repl_mode.special, 'set_expanded_output', lambda value: None)
monkeypatch.setattr(repl_mode.special, 'set_forced_horizontal_output', lambda value: None)
monkeypatch.setattr(repl_mode.special, 'is_llm_command', lambda text: False)
monkeypatch.setattr(repl_mode.special, 'is_expanded_output', lambda: False)
monkeypatch.setattr(repl_mode.special, 'is_redirected', lambda: False)
monkeypatch.setattr(repl_mode.special, 'is_timing_enabled', lambda: False)
monkeypatch.setattr(repl_mode.special, 'write_tee', lambda *args, **kwargs: None)
monkeypatch.setattr(repl_mode.special, 'unset_once_if_written', lambda *args, **kwargs: None)
monkeypatch.setattr(repl_mode.special, 'flush_pipe_once_if_written', lambda *args, **kwargs: None)
monkeypatch.setattr(repl_mode.special, 'close_tee', lambda: None)
monkeypatch.setattr(repl_mode, 'handle_editor_command', lambda mycli, text, inputhook, loaded_message_fn: text)
monkeypatch.setattr(repl_mode, 'handle_clip_command', lambda mycli, text: False)
monkeypatch.setattr(repl_mode, 'is_redirect_command', lambda text: False)
monkeypatch.setattr(repl_mode, 'confirm_destructive_query', lambda keywords, text: None)
monkeypatch.setattr(repl_mode, 'need_completion_refresh', lambda text: False)
monkeypatch.setattr(repl_mode, 'need_completion_reset', lambda text: False)
monkeypatch.setattr(repl_mode, 'is_dropping_database', lambda text, dbname: False)
monkeypatch.setattr(repl_mode, 'is_mutating', lambda status: False)
def test_complete_while_typing_filter_covers_threshold_and_word_rules(monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setattr(repl_mode, 'MIN_COMPLETION_TRIGGER', 3)
monkeypatch.setattr(repl_mode, 'get_app', lambda: SimpleNamespace(current_buffer=SimpleNamespace(text='ab')))
assert repl_mode.complete_while_typing_filter() is False
monkeypatch.setattr(repl_mode, 'get_app', lambda: SimpleNamespace(current_buffer=SimpleNamespace(text='abc')))
assert repl_mode.complete_while_typing_filter() is True
monkeypatch.setattr(repl_mode, 'get_app', lambda: SimpleNamespace(current_buffer=SimpleNamespace(text='source xyz')))
assert repl_mode.complete_while_typing_filter() is True
monkeypatch.setattr(repl_mode, 'get_app', lambda: SimpleNamespace(current_buffer=SimpleNamespace(text='source x/')))
assert repl_mode.complete_while_typing_filter() is False
monkeypatch.setattr(repl_mode, 'get_app', lambda: SimpleNamespace(current_buffer=SimpleNamespace(text='\\. abc')))
assert repl_mode.complete_while_typing_filter() is True
monkeypatch.setattr(repl_mode, 'get_app', lambda: SimpleNamespace(current_buffer=SimpleNamespace(text='\\. a/')))
assert repl_mode.complete_while_typing_filter() is False
monkeypatch.setattr(repl_mode, 'get_app', lambda: SimpleNamespace(current_buffer=SimpleNamespace(text='select abc')))
assert repl_mode.complete_while_typing_filter() is True
monkeypatch.setattr(repl_mode, 'get_app', lambda: SimpleNamespace(current_buffer=SimpleNamespace(text='select a!')))
assert repl_mode.complete_while_typing_filter() is False
monkeypatch.setattr(repl_mode, 'MIN_COMPLETION_TRIGGER', 1)
assert repl_mode.complete_while_typing_filter() is True
def test_complete_while_typing_filter_always_completes_slash_commands(
monkeypatch: pytest.MonkeyPatch,
) -> None:
monkeypatch.setattr(repl_mode, 'MIN_COMPLETION_TRIGGER', 3)
monkeypatch.setattr(repl_mode, 'get_app', lambda: SimpleNamespace(current_buffer=SimpleNamespace(text='/')))
assert repl_mode.complete_while_typing_filter() is True
def test_complete_while_typing_filter_does_not_treat_block_comments_as_slash_commands(
monkeypatch: pytest.MonkeyPatch,
) -> None:
monkeypatch.setattr(repl_mode, 'MIN_COMPLETION_TRIGGER', 3)
monkeypatch.setattr(repl_mode, 'get_app', lambda: SimpleNamespace(current_buffer=SimpleNamespace(text='/*')))
assert repl_mode.complete_while_typing_filter() is False
def test_repl_create_history(monkeypatch: pytest.MonkeyPatch) -> None:
cli = make_repl_cli()
monkeypatch.setenv('MYCLI_HISTFILE', '~/override-history')
monkeypatch.setattr(repl_mode, 'dir_path_exists', lambda path: True)
monkeypatch.setattr(repl_mode, 'FileHistoryWithTimestamp', lambda path: f'history:{path}')
history = cast(Any, repl_mode._create_history(cli))
assert history == f'history:{os.path.expanduser("~/override-history")}'
monkeypatch.delenv('MYCLI_HISTFILE')
monkeypatch.setattr(repl_mode, 'dir_path_exists', lambda path: False)
assert repl_mode._create_history(cli) is None
assert 'Unable to open the history file' in cli.echo_calls[-1]
def test_repl_picker_helpers_cover_present_and_missing_resources(monkeypatch: pytest.MonkeyPatch) -> None:
files = {
'AUTHORS': '* Alice\n* Bob\n',
'SPONSORS': '* Carol\n',
'TIPS': '# comment\nTip 1\n\nTip 2\n',
}
monkeypatch.setattr(repl_mode.resources, 'files', lambda package: FakeResourceTree(files))
monkeypatch.setattr(repl_mode.random, 'choice', lambda seq: seq[0])
assert repl_mode._contributors_picker() == 'Alice'
assert repl_mode._sponsors_picker() == 'Carol'
assert repl_mode._tips_picker() == 'Tip 1'
monkeypatch.setattr(repl_mode.resources, 'files', lambda package: FakeResourceTree({}))
assert repl_mode._contributors_picker() == 'our contributors'
assert repl_mode._sponsors_picker() == 'our sponsors'
assert repl_mode._tips_picker() == r'\? or "help" for help!'
def test_repl_show_startup_banner_and_prompt_helpers(monkeypatch: pytest.MonkeyPatch) -> None:
cli = make_repl_cli(SimpleNamespace(server_info='Server'))
printed: list[str] = []
monkeypatch.setattr(builtins, 'print', lambda *args, **kwargs: printed.append(' '.join(str(x) for x in args)))
monkeypatch.setattr(repl_mode.random, 'random', lambda: 0.4)
monkeypatch.setattr(repl_mode, '_contributors_picker', lambda: 'Alice')
monkeypatch.setattr(repl_mode, '_sponsors_picker', lambda: 'Carol')
monkeypatch.setattr(repl_mode, '_tips_picker', lambda: 'Tip')
cli.verbosity = 0
repl_mode._show_startup_banner(cli, cli.sqlexecute)
monkeypatch.setattr(repl_mode.random, 'random', lambda: 0.6)
repl_mode._show_startup_banner(cli, cli.sqlexecute)
cli.verbosity = -1
repl_mode._show_startup_banner(cli, cli.sqlexecute)
assert any('Thanks to the contributor' in line for line in printed)
assert any('Tip — Tip' in line for line in printed)
monkeypatch.setattr(
repl_mode,
'render_prompt_string',
lambda mycli, string, render_counter: to_formatted_text('0123456') if string == cli.default_prompt else 'a\nb',
)
cli.max_len_prompt = 5
prompt_text = to_plain_text(repl_mode._get_prompt_message(cli, cast(Any, FakeApp(text='', render_counter=2))))
assert prompt_text == 'a\nb'
assert cli.prompt_lines == 2
cli.last_prompt_message = repl_mode.ANSI('cached')
assert to_plain_text(repl_mode._get_prompt_message(cli, cast(Any, FakeApp(text='typing', render_counter=3)))) == 'cached'
cli.prompt_format = 'custom'
cli.prompt_lines = 0
monkeypatch.setattr(repl_mode, 'render_prompt_string', lambda mycli, string, render_counter: to_formatted_text('single'))
assert to_plain_text(repl_mode._get_prompt_message(cli, cast(Any, FakeApp(text='', render_counter=4)))) == 'single'
assert cli.prompt_lines == 1
assert repl_mode._get_continuation(cli, 4, 0, 0) == [('class:continuation', ' > ')]
cli.multiline_continuation_char = ''
assert repl_mode._get_continuation(cli, 4, 0, 0) == [('class:continuation', '')]
cli.multiline_continuation_char = None
assert repl_mode._get_continuation(cli, 4, 0, 0) == [('class:continuation', ' ')]
def test_repl_show_startup_banner_thanks_sponsor(monkeypatch: pytest.MonkeyPatch) -> None:
cli = make_repl_cli(SimpleNamespace(server_info='Server'))
cli.verbosity = 0
printed: list[str] = []
monkeypatch.setattr(builtins, 'print', lambda *args, **kwargs: printed.append(' '.join(str(x) for x in args)))
monkeypatch.setattr(repl_mode.random, 'random', lambda: 0.25)
monkeypatch.setattr(repl_mode, '_sponsors_picker', lambda: 'Carol')
repl_mode._show_startup_banner(cli, cli.sqlexecute)
assert any('Thanks to the sponsor' in line and 'Carol' in line for line in printed)
def test_prompt_toolbar_and_title_helpers(monkeypatch: pytest.MonkeyPatch) -> None:
class PromptCursor:
def __enter__(self) -> 'PromptCursor':
return self
def __exit__(self, exc_type: Any, exc: Any, tb: Any) -> Literal[False]:
return False
class PromptConnection:
def cursor(self) -> PromptCursor:
return PromptCursor()
sqlexecute = SimpleNamespace(
user='alice',
host='127.0.0.1',
dbname='db',
port=3307,
socket='/tmp/mysql.sock',
server_info=SimpleNamespace(species=SimpleNamespace(name='TiDB')),
conn=None,
)
cli = make_repl_cli(sqlexecute)
cli.login_path = 'prod'
cli.login_path_as_host = True
cli.dsn_alias = 'dsn'
prompt = repl_mode.render_prompt_string(cli, r'\h|\H|\A|\y|\Y|\T|\w|\W', 0)
prompt_plain = to_plain_text(prompt)
assert prompt_plain == 'prod|prod|dsn|(none)|(none)|(none)|(none)|'
sqlexecute.conn = PromptConnection()
cli.login_path_as_host = False
monkeypatch.setattr(repl_mode, 'get_uptime', lambda cur: 123)
monkeypatch.setattr(repl_mode, 'format_uptime', lambda uptime: f'uptime:{uptime}')
monkeypatch.setattr(repl_mode, 'get_ssl_version', lambda cur: 'TLSv1.3')
monkeypatch.setattr(repl_mode, 'get_warning_count', lambda cur: 7)
prompt = repl_mode.render_prompt_string(cli, r'\H|\y|\Y|\T|\w|\W', 1)
prompt_plain = to_plain_text(prompt)
assert prompt_plain == '127.0.0.1|123|uptime:123|TLSv1.3|7|7'
cli.prompt_session = None
assert to_plain_text(repl_mode.get_custom_toolbar(cli, 'fmt')) == ''
cli.prompt_session = cast(Any, SimpleNamespace(app=None))
assert to_plain_text(repl_mode.get_custom_toolbar(cli, 'fmt')) == ''
cli.prompt_session = cast(Any, FakePromptSession())
cli.last_custom_toolbar_message = repl_mode.ANSI('cached')
cli.prompt_session.app.current_buffer.text = 'typing'
assert repl_mode.get_custom_toolbar(cli, 'fmt') == cli.last_custom_toolbar_message
cli.prompt_session.app.current_buffer.text = ''
monkeypatch.setattr(repl_mode, 'render_prompt_string', lambda mycli, string, render_counter: f'title:{string}')
assert 'title:fmt' in str(repl_mode.get_custom_toolbar(cli, 'fmt'))
cli.terminal_tab_title_format = 'tab'
cli.terminal_window_title_format = 'window'
cli.multiplex_window_title_format = 'mux-window'
cli.multiplex_pane_title_format = 'mux-pane'
monkeypatch.setattr(repl_mode, 'sanitize_terminal_title', lambda title: title.upper())
monkeypatch.setattr(repl_mode.sys.stderr, 'isatty', lambda: True)
printed: list[str] = []
monkeypatch.setattr(builtins, 'print', lambda *args, **kwargs: printed.append(args[0]))
tmux_calls: list[tuple[Any, ...]] = []
monkeypatch.setattr(repl_mode.subprocess, 'run', lambda *args, **kwargs: tmux_calls.append(args))
monkeypatch.setenv('TMUX', '1')
repl_mode.set_all_external_titles(cli)
assert printed[0].startswith('\x1b]1;TITLE:TAB')
assert printed[1].startswith('\x1b]2;TITLE:WINDOW')
assert printed[2].startswith('\x1b]2;TITLE:MUX-PANE')
assert tmux_calls
monkeypatch.setattr(repl_mode.sys.stderr, 'isatty', lambda: False)
repl_mode.set_external_terminal_tab_title(cli)
repl_mode.set_external_terminal_window_title(cli)
repl_mode.set_external_multiplex_pane_title(cli)
monkeypatch.delenv('TMUX', raising=False)
repl_mode.set_external_multiplex_window_title(cli)
monkeypatch.setenv('TMUX', '1')
monkeypatch.setattr(repl_mode.subprocess, 'run', lambda *args, **kwargs: (_ for _ in ()).throw(FileNotFoundError()))
repl_mode.set_external_multiplex_window_title(cli)
def test_prompt_and_title_helper_early_returns_and_remaining_prompt_branches(monkeypatch: pytest.MonkeyPatch) -> None:
class PromptCursor:
def __enter__(self) -> 'PromptCursor':
return self
def __exit__(self, exc_type: Any, exc: Any, tb: Any) -> Literal[False]:
return False
class PromptConnection:
def cursor(self) -> PromptCursor:
return PromptCursor()
cli = make_repl_cli(
SimpleNamespace(
user='alice',
host=None,
dbname='db',
port=3306,
socket=None,
server_info=SimpleNamespace(species=SimpleNamespace(name='MySQL')),
conn=PromptConnection(),
)
)
cli.prompt_session = cast(Any, FakePromptSession())
monkeypatch.setattr(repl_mode, 'get_uptime', lambda cur: 123)
monkeypatch.setattr(repl_mode, 'format_uptime', lambda uptime: f'uptime:{uptime}')
monkeypatch.setattr(repl_mode, 'get_ssl_version', lambda cur: 'TLSv1.3')
monkeypatch.setattr(repl_mode, 'get_warning_count', lambda cur: 7)
prompt = repl_mode.render_prompt_string(cli, r'\h|\H|\y|\Y', 0)
prompt_plain = to_plain_text(prompt)
assert prompt_plain == f'{repl_mode.DEFAULT_HOST}|{repl_mode.DEFAULT_HOST}|123|uptime:123'
prompt = repl_mode.render_prompt_string(cli, r'\h|\H|\w|\W', 1)
prompt_plain = to_plain_text(prompt)
assert prompt_plain == f'{repl_mode.DEFAULT_HOST}|{repl_mode.DEFAULT_HOST}|7|7'
prompt = repl_mode.render_prompt_string(cli, r'\h|\H|\T', 2)
prompt_plain = to_plain_text(prompt)
assert prompt_plain == f'{repl_mode.DEFAULT_HOST}|{repl_mode.DEFAULT_HOST}|TLSv1.3'
monkeypatch.setattr(repl_mode.sys.stderr, 'isatty', lambda: True)
monkeypatch.setattr(builtins, 'print', lambda *args, **kwargs: (_ for _ in ()).throw(AssertionError('unexpected print')))
monkeypatch.setattr(
repl_mode.subprocess,
'run',
lambda *args, **kwargs: (_ for _ in ()).throw(AssertionError('unexpected tmux call')),
)
cli.terminal_tab_title_format = ''
repl_mode.set_external_terminal_tab_title(cli)
cli.terminal_tab_title_format = 'tab'
cli.prompt_session = None
repl_mode.set_external_terminal_tab_title(cli)
cli.prompt_session = cast(Any, FakePromptSession())
cli.terminal_window_title_format = ''
repl_mode.set_external_terminal_window_title(cli)
cli.terminal_window_title_format = 'window'
cli.prompt_session = None
repl_mode.set_external_terminal_window_title(cli)
cli.prompt_session = cast(Any, FakePromptSession())
cli.multiplex_window_title_format = ''
repl_mode.set_external_multiplex_window_title(cli)
cli.multiplex_window_title_format = 'mux-window'
monkeypatch.setenv('TMUX', '1')
cli.prompt_session = None
repl_mode.set_external_multiplex_window_title(cli)
cli.prompt_session = cast(Any, FakePromptSession())
cli.multiplex_pane_title_format = ''
repl_mode.set_external_multiplex_pane_title(cli)
cli.multiplex_pane_title_format = 'mux-pane'
monkeypatch.delenv('TMUX', raising=False)
repl_mode.set_external_multiplex_pane_title(cli)
monkeypatch.setenv('TMUX', '1')
cli.prompt_session = None
repl_mode.set_external_multiplex_pane_title(cli)
def test_maybe_html_escape() -> None:
assert repl_mode.maybe_html_escape('plain', False) == 'plain'
assert repl_mode.maybe_html_escape('a&b<1>', True) == 'a&b<1>'
def test_render_prompt_string_html() -> None:
repl_mode.render_prompt_string.cache_clear()
cli = make_repl_cli(
SimpleNamespace(
user='ab',
host='db.example.com',
dbname='nameprod',
port=3306,
socket=None,
server_info=SimpleNamespace(species=SimpleNamespace(name='MySQL')),
conn=None,
)
)
cli.dsn_alias = 'aliasone'
html_prompt = repl_mode.render_prompt_string(cli, r'\<html><b>\u@\d|\A</b>\</html>', 0)
assert to_plain_text(html_prompt) == 'ab@nameprod|aliasone'
bad_html_prompt = repl_mode.render_prompt_string(cli, r'\<html><b>\u', 1)
assert to_plain_text(bad_html_prompt) == '(cannot parse HTML prompt string)'
ansi_prompt = repl_mode.render_prompt_string(cli, r'\x1b[31mred\x1b[0m', 2)
assert to_plain_text(ansi_prompt) == 'red'
def test_render_prompt_string_ansi() -> None:
repl_mode.render_prompt_string.cache_clear()
cli = make_repl_cli(
SimpleNamespace(
user='ab',
host='db.example.com',
dbname='nameprod',
port=3306,
socket=None,
server_info=SimpleNamespace(species=SimpleNamespace(name='MySQL')),
conn=None,
)
)
cli.dsn_alias = 'aliasone'
ansi_prompt = repl_mode.render_prompt_string(cli, r'\x1b[31mred\x1b[0m', 2)
assert to_plain_text(ansi_prompt) == 'red'
def test_output_results_covers_watch_warning_timing_beep_and_interrupts(monkeypatch: pytest.MonkeyPatch) -> None:
class FakeSQLExecute:
def run(self, text: str) -> list[SQLResult]:
assert text == 'SHOW WARNINGS'
return [SQLResult(status='warning', rows=[('warn',)])]
cli = make_repl_cli(FakeSQLExecute())
cli.auto_vertical_output = True
cli.prompt_session = FakePromptSession(columns=91)
cli.beep_after_seconds = 0.1
state = repl_mode.ReplState()
format_widths: list[int | None] = []
def format_sqlresult(result: SQLResult, **kwargs: Any) -> Iterator[str]:
format_widths.append(kwargs.get('max_width'))
return iter([result.status_plain or 'row'])
cli.format_sqlresult = format_sqlresult
time_values = iter([0.2, 1.0, 2.0, 3.0, 3.2])
monkeypatch.setattr(repl_mode.time, 'time', lambda: next(time_values))
monkeypatch.setattr(repl_mode.special, 'is_expanded_output', lambda: False)
monkeypatch.setattr(repl_mode.special, 'is_redirected', lambda: False)
monkeypatch.setattr(repl_mode.special, 'is_show_warnings_enabled', lambda: True)
monkeypatch.setattr(repl_mode.special, 'is_timing_enabled', lambda: True)
monkeypatch.setattr(repl_mode, 'Cursor', FakeCursorBase)
monkeypatch.setattr(repl_mode, 'is_select', lambda status: False)
monkeypatch.setattr(repl_mode, 'is_mutating', lambda status: status == 'mut')
results = sqlresult_generator(
SQLResult(status='watch', command={'name': 'watch', 'seconds': '1'}),
SQLResult(status='mut', rows=cast(Any, FakeCursorBase(rowcount=1, warning_count=1))),
)
repl_mode._output_results(cli, state, results, start=0.0)
assert state.mutating is True
assert format_widths[:2] == [91, 91]
assert cli.prompt_session.output.bell_count == 2
assert '' in cli.echo_calls
assert any(is_warnings_style is True for _, _, is_warnings_style in cli.output_calls)
assert any(is_warnings_style is False for _, is_warnings_style in cli.timing_calls)
assert any(is_warnings_style is True for _, is_warnings_style in cli.timing_calls)
cli_interrupt = make_repl_cli(SimpleNamespace())
cli_interrupt.echo = lambda message, **kwargs: (
(_ for _ in ()).throw(KeyboardInterrupt()) if message == '' else cli_interrupt.echo_calls.append(str(message))
)
cli_interrupt.output = lambda formatted, result, is_warnings_style=False: (_ for _ in ()).throw(KeyboardInterrupt())
monkeypatch.setattr(repl_mode.special, 'is_timing_enabled', lambda: False)
monkeypatch.setattr(repl_mode, 'is_select', lambda status: False)
monkeypatch.setattr(repl_mode.time, 'time', lambda: 0.0)
repl_mode._output_results(
cli_interrupt,
repl_mode.ReplState(),
sqlresult_generator(SQLResult(status='first'), SQLResult(status='second')),
start=0.0,
)
def test_output_results_handles_abort_default_width_and_bad_watch(monkeypatch: pytest.MonkeyPatch) -> None:
cli = make_repl_cli(SimpleNamespace())
cli.auto_vertical_output = True
widths: list[int | None] = []
def format_sqlresult_with_width(result: SQLResult, **kwargs: Any) -> Iterator[str]:
widths.append(kwargs.get('max_width'))
return iter([result.status_plain or 'row'])
cli.format_sqlresult = format_sqlresult_with_width
monkeypatch.setattr(repl_mode, 'Cursor', FakeCursorBase)
monkeypatch.setattr(repl_mode, 'is_select', lambda status: status == 'select')
monkeypatch.setattr(repl_mode, 'confirm', lambda text: False)
repl_mode._output_results(
cli,
repl_mode.ReplState(),
sqlresult_generator(SQLResult(status='select', rows=cast(Any, FakeCursorBase(rowcount=1001)))),
start=0.0,
)
assert 'The result set has more than 1000 rows.' in cli.echo_calls
assert 'Aborted!' in cli.echo_calls
repl_mode._output_results(
cli,
repl_mode.ReplState(),
sqlresult_generator(SQLResult(status='ok')),
start=0.0,
)
assert widths[-1] == repl_mode.DEFAULT_WIDTH
monkeypatch.setattr(repl_mode, 'is_select', lambda status: False)
with pytest.raises(SystemExit):
repl_mode._output_results(
cli,
repl_mode.ReplState(),
sqlresult_generator(
SQLResult(status='watch', command={'name': 'watch', 'seconds': '1'}),
SQLResult(status='watch', command={'name': 'watch', 'seconds': 'bad'}),
),
start=0.0,
)
def test_keepalive_hook_covers_threshold_and_errors() -> None:
cli = make_repl_cli(SimpleNamespace(conn=FakeConnection()))
repl_mode._keepalive_hook(cli, None)
assert cli._keepalive_counter == 0
cli.keepalive_ticks = 0
repl_mode._keepalive_hook(cli, None)
assert cli._keepalive_counter == 0
cli.keepalive_ticks = 1
repl_mode._keepalive_hook(cli, None)
assert cli._keepalive_counter == 1
repl_mode._keepalive_hook(cli, None)
assert cli._keepalive_counter == 0
assert cli.sqlexecute.conn.ping_calls == [False]
cli.sqlexecute.conn = FakeConnection(ping_exc=RuntimeError('boom'))
repl_mode._keepalive_hook(cli, None)
repl_mode._keepalive_hook(cli, None)
assert any('keepalive ping error' in call[0][0] for call in cli.logger.debug_calls)
def test_build_prompt_session_covers_toolbar_modes_and_editing_modes(monkeypatch: pytest.MonkeyPatch) -> None:
captured_kwargs: list[dict[str, Any]] = []
toolbar_help: list[bool] = []
def fake_prompt_session(**kwargs: Any) -> FakePromptSession:
captured_kwargs.append(kwargs)
return FakePromptSession()
monkeypatch.setattr(repl_mode, 'PromptSession', fake_prompt_session)
monkeypatch.setattr(repl_mode, 'style_factory_ptoolkit', lambda *args, **kwargs: 'style')
monkeypatch.setattr(repl_mode, 'cli_is_multiline', lambda mycli: False)
def fake_toolbar_tokens(mycli: Any, show_help: Any, fmt: str, custom_toolbar: Any) -> str:
toolbar_help.append(show_help())
assert callable(custom_toolbar)
return 'toolbar'
monkeypatch.setattr(repl_mode, 'create_toolbar_tokens_func', fake_toolbar_tokens)
cli = make_repl_cli(SimpleNamespace())
state = repl_mode.ReplState()
cli.toolbar_format = 'none'
cli.key_bindings = 'vi'
cli.wider_completion_menu = True
repl_mode._build_prompt_session(cli, state, history=cast(Any, 'history'), key_bindings=cast(Any, 'bindings'))
first_kwargs = captured_kwargs[-1]
assert first_kwargs['bottom_toolbar'] is None
assert first_kwargs['complete_style'] == repl_mode.CompleteStyle.MULTI_COLUMN
assert first_kwargs['editing_mode'] == repl_mode.EditingMode.VI
assert cli.prompt_session.app.ttimeoutlen == cli.vi_ttimeoutlen
cli.toolbar_format = 'default'
cli.key_bindings = 'emacs'
cli.wider_completion_menu = False
state.iterations = 0
repl_mode._build_prompt_session(cli, state, history=cast(Any, 'history'), key_bindings=cast(Any, 'bindings'))
latest_kwargs = captured_kwargs[-1]
assert latest_kwargs['bottom_toolbar'] == 'toolbar'
assert latest_kwargs['complete_style'] == repl_mode.CompleteStyle.COLUMN
assert latest_kwargs['editing_mode'] == repl_mode.EditingMode.EMACS
assert toolbar_help == [True]
assert cli.prompt_session.app.ttimeoutlen == cli.emacs_ttimeoutlen
assert latest_kwargs['prompt_continuation'](4, 0, 0) == [('class:continuation', ' > ')]
def test_one_iteration_handles_prompt_interrupt_empty_editor_clip_and_clip_true(monkeypatch: pytest.MonkeyPatch) -> None:
patch_repl_runtime_defaults(monkeypatch)
cli = make_repl_cli(SimpleNamespace(run=lambda text: iter([SQLResult(status='ok')]), conn=FakeConnection()))
cli.keepalive_ticks = 1
cli.prompt_session = FakePromptSession([KeyboardInterrupt(), ' ', 'edit-error', 'clip-error', 'clip-stop'])
repl_mode._one_iteration(cli, repl_mode.ReplState())
assert cli.query_history == []
repl_mode._one_iteration(cli, repl_mode.ReplState())
assert cli.query_history == []
inputhook = cli.prompt_session.prompt_calls[-1]['inputhook']
assert inputhook is not None
inputhook(None)
monkeypatch.setattr(repl_mode, 'handle_editor_command', lambda *args: (_ for _ in ()).throw(RuntimeError('edit boom')))
repl_mode._one_iteration(cli, repl_mode.ReplState())
assert 'edit boom' in cli.echo_calls[-1]
monkeypatch.setattr(repl_mode, 'handle_editor_command', lambda mycli, text, inputhook, loaded_message_fn: text)
monkeypatch.setattr(repl_mode, 'handle_clip_command', lambda mycli, text: (_ for _ in ()).throw(RuntimeError('clip boom')))
repl_mode._one_iteration(cli, repl_mode.ReplState())
assert 'clip boom' in cli.echo_calls[-1]
monkeypatch.setattr(repl_mode, 'handle_clip_command', lambda mycli, text: True)
repl_mode._one_iteration(cli, repl_mode.ReplState())
assert cli.query_history == []
def test_one_iteration_covers_llm_paths(monkeypatch: pytest.MonkeyPatch) -> None:
patch_repl_runtime_defaults(monkeypatch)
click_output: list[str] = []
monkeypatch.setattr(repl_mode.click, 'echo', lambda message='', **kwargs: click_output.append(str(message)))
monkeypatch.setattr(repl_mode.special, 'is_timing_enabled', lambda: True)
monkeypatch.setattr(repl_mode.special, 'is_llm_command', lambda text: text.startswith('\\llm'))
class FakeSQLExecute:
def __init__(self) -> None:
self.dbname = 'db'
self.conn = FakeConnection(cursor_value='cursor')
def run(self, text: str) -> Iterator[SQLResult]:
return iter([SQLResult(status=f'ran:{text}')])
monkeypatch.setattr(
repl_mode.special,
'handle_llm',
lambda text, cur, dbname, field_truncate, section_truncate: ('context', 'select 1', 1.25),
)
cli = make_repl_cli(FakeSQLExecute())
cli.prompt_session = FakePromptSession(['\\llm ask', 'select 1'])
repl_mode._one_iteration(
cli,
repl_mode.ReplState(),
)
assert click_output[:3] == ['LLM Response:', 'context', '---']
assert cli.output_calls[0][0] == ['None', 'ran:select 1']
cli_finish = make_repl_cli(FakeSQLExecute())
cli_finish.prompt_session = FakePromptSession(['\\llm finish'])
cli_finish.format_sqlresult = lambda result, **kwargs: iter([result.status_plain or 'row'])
monkeypatch.setattr(
repl_mode.special,
'handle_llm',
lambda *args, **kwargs: (_ for _ in ()).throw(repl_mode.special.FinishIteration(iter([SQLResult(status='done')]))),
)
repl_mode._one_iteration(cli_finish, repl_mode.ReplState())
assert cli_finish.output_calls[0][0] == ['done']
cli_empty = make_repl_cli(FakeSQLExecute())
cli_empty.prompt_session = FakePromptSession(['\\llm empty'])
monkeypatch.setattr(
repl_mode.special,
'handle_llm',
lambda *args, **kwargs: (_ for _ in ()).throw(repl_mode.special.FinishIteration(None)),
)
repl_mode._one_iteration(cli_empty, repl_mode.ReplState())
assert cli_empty.output_calls == []
cli_err = make_repl_cli(FakeSQLExecute())
cli_err.prompt_session = FakePromptSession(['\\llm err'])
monkeypatch.setattr(
repl_mode.special,
'handle_llm',
lambda *args, **kwargs: (_ for _ in ()).throw(RuntimeError('llm boom')),
)
repl_mode._one_iteration(cli_err, repl_mode.ReplState())
assert 'llm boom' in cli_err.echo_calls[-1]
cli_interrupt = make_repl_cli(FakeSQLExecute())
cli_interrupt.prompt_session = FakePromptSession(['\\llm stop'])
monkeypatch.setattr(
repl_mode.special,
'handle_llm',
lambda *args, **kwargs: (_ for _ in ()).throw(KeyboardInterrupt()),
)
repl_mode._one_iteration(cli_interrupt, repl_mode.ReplState())
assert cli_interrupt.output_calls == []
cli_quiet = make_repl_cli(FakeSQLExecute())
cli_quiet.prompt_session = FakePromptSession(['\\llm quiet', 'select 2'])
monkeypatch.setattr(repl_mode.special, 'is_timing_enabled', lambda: False)
monkeypatch.setattr(
repl_mode.special,
'handle_llm',
lambda text, cur, dbname, field_truncate, section_truncate: ('', 'select 2', 0.5),
)
repl_mode._one_iteration(cli_quiet, repl_mode.ReplState())
assert cli_quiet.output_calls[0][0] == ['None', 'ran:select 2']
@pytest.mark.parametrize(
'text, expected',
[
('', True),
(' ', True),
("ALTER USER 'root'@'localhost' IDENTIFIED BY 'new'", True),
('alter user root identified by "pw"', True),
("SET PASSWORD = 'newpass'", True),
("set password = 'newpass'", True),
('quit', True),
('exit', True),
('\\q', True),
('SELECT 1', False),
('DROP TABLE t', False),
('USE mydb', False),
('SHOW DATABASES', False),
],
)
def test_is_sandbox_allowed(text: str, expected: bool) -> None:
from mycli.packages.sql_utils import is_sandbox_allowed
assert is_sandbox_allowed(text) is expected
@pytest.mark.parametrize(
'text, expected',
[
("ALTER USER 'root'@'localhost' IDENTIFIED BY 'new'", True),
("SET PASSWORD = 'newpass'", True),
('SELECT 1', False),
('quit', False),
],
)
def test_is_password_change(text: str, expected: bool) -> None:
from mycli.packages.sql_utils import is_password_change
assert is_password_change(text) is expected
@pytest.mark.parametrize(
'text, expected',
[
("ALTER USER 'root'@'localhost' IDENTIFIED BY 'newpass'", 'newpass'),
("SET PASSWORD = 'secret123'", 'secret123'),
("ALTER USER root IDENTIFIED BY 'p@ss w0rd!'", 'p@ss w0rd!'),
('ALTER USER root IDENTIFIED WITH mysql_native_password', None),
('SELECT 1', None),
],
)
def test_extract_new_password(text: str, expected: str | None) -> None:
from mycli.packages.sql_utils import extract_new_password
assert extract_new_password(text) == expected
def test_one_iteration_blocks_disallowed_in_sandbox_mode(monkeypatch: pytest.MonkeyPatch) -> None:
patch_repl_runtime_defaults(monkeypatch)
class FakeSQLExecute:
def __init__(self) -> None:
self.dbname = 'db'
self.connection_id = 0
def run(self, text: str) -> Iterator[SQLResult]:
return iter([SQLResult(status=f'ran:{text}')])
cli = make_repl_cli(FakeSQLExecute())
cli.sandbox_mode = True
repl_mode._one_iteration(cli, repl_mode.ReplState(), 'SELECT 1')
assert any('ERROR 1820' in msg for msg in cli.echo_calls)
assert not cli.query_history
def test_one_iteration_allows_alter_user_in_sandbox_mode(monkeypatch: pytest.MonkeyPatch) -> None:
patch_repl_runtime_defaults(monkeypatch)
class FakeSQLExecute:
def __init__(self) -> None:
self.dbname = 'db'
self.connection_id = 0
self.password = 'old'
self.connect_calls: list[bool] = []
def connect(self) -> None:
self.connect_calls.append(True)
def run(self, text: str) -> Iterator[SQLResult]:
return iter([SQLResult(status='OK')])
sqlexecute = FakeSQLExecute()
cli = make_repl_cli(sqlexecute)
cli.sandbox_mode = True
monkeypatch.setattr(repl_mode, 'is_mutating', lambda status: False)
repl_mode._one_iteration(cli, repl_mode.ReplState(), "ALTER USER 'root'@'localhost' IDENTIFIED BY 'newpass'")
assert cli.sandbox_mode is False
assert sqlexecute.password == 'newpass'
assert sqlexecute.connect_calls == [True]
assert any('Reconnected' in msg for msg in cli.echo_calls)
def test_one_iteration_sandbox_reconnect_failure(monkeypatch: pytest.MonkeyPatch) -> None:
patch_repl_runtime_defaults(monkeypatch)
class FakeSQLExecute:
def __init__(self) -> None:
self.dbname = 'db'
self.connection_id = 0
self.password = 'old'
def connect(self) -> None:
raise RuntimeError('connection refused')