-
-
Notifications
You must be signed in to change notification settings - Fork 274
/
Copy pathtest_ui_tools.py
1252 lines (1092 loc) · 48.3 KB
/
test_ui_tools.py
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 collections import OrderedDict
import pytest
import urwid
from pytest import param as case
from urwid import Divider
from zulipterminal.config.keys import keys_for_command, primary_key_for_command
from zulipterminal.config.symbols import STATUS_ACTIVE
from zulipterminal.helper import powerset
from zulipterminal.ui_tools.views import (
SIDE_PANELS_MOUSE_SCROLL_LINES,
LeftColumnView,
MessageView,
MiddleColumnView,
ModListWalker,
RightColumnView,
StreamsView,
StreamsViewDivider,
TabView,
TopicsView,
UsersView,
)
SUBDIR = "zulipterminal.ui_tools"
VIEWS = SUBDIR + ".views"
MESSAGEVIEW = VIEWS + ".MessageView"
MIDCOLVIEW = VIEWS + ".MiddleColumnView"
class TestModListWalker:
@pytest.fixture
def mod_walker(self, mocker):
read_message = mocker.Mock(spec=lambda: None)
return ModListWalker(contents=[list(range(1))], action=read_message)
@pytest.mark.parametrize(
"num_items, focus_position",
[
(5, 0),
(0, 0),
],
)
def test_extend(self, num_items, focus_position, mod_walker, mocker):
items = list(range(num_items))
mocker.patch.object(mod_walker, "_set_focus")
mod_walker.extend(items)
mod_walker._set_focus.assert_called_once_with(focus_position)
def test__set_focus(self, mod_walker, mocker):
mod_walker._action.assert_not_called()
mod_walker._set_focus(0)
mod_walker._action.assert_called_once_with()
def test_set_focus(self, mod_walker, mocker):
mod_walker._action.assert_not_called()
mod_walker.set_focus(0)
mod_walker._action.assert_called_once_with()
class TestMessageView:
@pytest.fixture(autouse=True)
def mock_external_classes(self, mocker):
self.model = mocker.MagicMock()
self.view = mocker.Mock()
self.urwid = mocker.patch(VIEWS + ".urwid")
@pytest.fixture
def msg_view(self, mocker, msg_box):
mocker.patch(MESSAGEVIEW + ".main_view", return_value=[msg_box])
mocker.patch(MESSAGEVIEW + ".read_message")
mocker.patch(MESSAGEVIEW + ".set_focus")
msg_view = MessageView(self.model, self.view)
msg_view.log = mocker.Mock()
msg_view.body = mocker.Mock()
return msg_view
def test_init(self, mocker, msg_view, msg_box):
assert msg_view.model == self.model
msg_view.set_focus.assert_called_once_with(0)
assert msg_view.old_loading is False
assert msg_view.new_loading is False
@pytest.mark.parametrize(
"narrow_focus_pos, expected_focus_msg", [(None, 1), (0, 0)]
)
def test_main_view(self, mocker, narrow_focus_pos, expected_focus_msg):
mocker.patch(MESSAGEVIEW + ".read_message")
self.urwid.SimpleFocusListWalker.return_value = mocker.Mock()
mocker.patch(MESSAGEVIEW + ".set_focus")
msg_list = ["MSG1", "MSG2"]
mocker.patch(VIEWS + ".create_msg_box_list", return_value=msg_list)
self.model.get_focus_in_current_narrow.return_value = narrow_focus_pos
msg_view = MessageView(self.model, self.view)
assert msg_view.focus_msg == expected_focus_msg
@pytest.mark.parametrize(
"messages_fetched",
[
{},
{201: "M1"},
OrderedDict([(201, "M1"), (202, "M2")]),
],
)
@pytest.mark.parametrize(
"ids_in_narrow",
[
set(),
{0}, # Shouldn't apply to empty log case?
],
)
def test_load_old_messages_empty_log(
self, mocker, msg_view, ids_in_narrow, messages_fetched
):
# Expand parameters to use in test
new_msg_ids = set(messages_fetched.keys())
new_msg_widgets = list(messages_fetched.values())
mocker.patch.object(
msg_view.model,
"get_message_ids_in_current_narrow",
side_effect=[ids_in_narrow, ids_in_narrow | new_msg_ids],
)
create_msg_box_list = mocker.patch(
VIEWS + ".create_msg_box_list", return_value=new_msg_widgets
)
# Specific to this version of the test
msg_view.log = []
msg_view.load_old_messages(0)
assert msg_view.old_loading is False
assert msg_view.log == list(messages_fetched.values()) # code vs orig
if messages_fetched:
create_msg_box_list.assert_called_once_with(msg_view.model, new_msg_ids)
self.model.controller.update_screen.assert_called_once_with()
else:
create_msg_box_list.assert_not_called()
self.model.controller.update_screen.assert_not_called()
self.model.get_messages.assert_called_once_with(
num_before=30, num_after=0, anchor=0
)
@pytest.mark.parametrize(
"messages_fetched",
[
{},
{201: "M1"},
OrderedDict([(201, "M1"), (202, "M2")]),
],
)
@pytest.mark.parametrize(
"top_id_in_narrow, other_ids_in_narrow",
[
(99, set()),
(99, {101}),
(99, {101, 103}),
],
)
def test_load_old_messages_mocked_log(
self, mocker, msg_view, top_id_in_narrow, other_ids_in_narrow, messages_fetched
):
# Expand parameters to use in test
new_msg_ids = set(messages_fetched.keys())
new_msg_widgets = list(messages_fetched.values())
# Parameter constraints
assert top_id_in_narrow not in other_ids_in_narrow
assert top_id_in_narrow not in new_msg_ids
assert other_ids_in_narrow & new_msg_ids == set()
top_widget = mocker.Mock()
top_widget.original_widget.message = {"id": top_id_in_narrow}
ids_in_narrow = {top_id_in_narrow} | other_ids_in_narrow
mocker.patch.object(
msg_view.model,
"get_message_ids_in_current_narrow",
side_effect=[ids_in_narrow, ids_in_narrow | new_msg_ids],
)
create_msg_box_list = mocker.patch(
VIEWS + ".create_msg_box_list",
return_value=(new_msg_widgets + [top_widget]),
)
initial_log = [top_widget] + len(other_ids_in_narrow) * ["existing"]
msg_view.log = initial_log[:]
msg_view.load_old_messages(0)
assert msg_view.old_loading is False
assert msg_view.log == new_msg_widgets + initial_log
if messages_fetched:
create_msg_box_list.assert_called_once_with(
msg_view.model, {top_id_in_narrow} | new_msg_ids
)
self.model.controller.update_screen.assert_called_once_with()
else:
create_msg_box_list.assert_not_called()
self.model.controller.update_screen.assert_not_called()
self.model.get_messages.assert_called_once_with(
num_before=30, num_after=0, anchor=0
)
# FIXME: Improve this test by covering more parameters
@pytest.mark.parametrize(
"ids_in_narrow",
[
({0}),
],
)
def test_load_new_messages_empty_log(self, mocker, msg_view, ids_in_narrow):
mocker.patch.object(
msg_view.model,
"get_message_ids_in_current_narrow",
return_value=ids_in_narrow,
)
create_msg_box_list = mocker.patch(
VIEWS + ".create_msg_box_list", return_value=["M1", "M2"]
)
msg_view.log = []
msg_view.load_new_messages(0)
assert msg_view.new_loading is False
assert msg_view.log == ["M1", "M2"]
create_msg_box_list.assert_called_once_with(
msg_view.model, set(), last_message=None
)
self.model.controller.update_screen.assert_called_once_with()
self.model.get_messages.assert_called_once_with(
num_before=0, num_after=30, anchor=0
)
# FIXME: Improve this test by covering more parameters
@pytest.mark.parametrize(
"ids_in_narrow",
[
({0}),
],
)
def test_load_new_messages_mocked_log(self, mocker, msg_view, ids_in_narrow):
mocker.patch.object(
msg_view.model,
"get_message_ids_in_current_narrow",
return_value=ids_in_narrow,
)
create_msg_box_list = mocker.patch(
VIEWS + ".create_msg_box_list", return_value=["M1", "M2"]
)
msg_view.log = [mocker.Mock()]
msg_view.load_new_messages(0)
assert msg_view.new_loading is False
assert msg_view.log[-2:] == ["M1", "M2"]
expected_last_msg = msg_view.log[0].original_widget.message
create_msg_box_list.assert_called_once_with(
msg_view.model, set(), last_message=expected_last_msg
)
self.model.controller.update_screen.assert_called_once_with()
self.model.get_messages.assert_called_once_with(
num_before=0, num_after=30, anchor=0
)
def test_mouse_event(self, mocker, msg_view, mouse_scroll_event, widget_size):
event, button, keypress = mouse_scroll_event
mocker.patch.object(msg_view, "keypress")
size = widget_size(msg_view)
msg_view.mouse_event(size, event, button, 0, 0, mocker.Mock())
msg_view.keypress.assert_called_once_with(size, keypress)
@pytest.mark.parametrize("key", keys_for_command("GO_DOWN"))
def test_keypress_GO_DOWN(self, mocker, msg_view, key, widget_size):
size = widget_size(msg_view)
msg_view.new_loading = False
mocker.patch(MESSAGEVIEW + ".focus_position", return_value=0)
mocker.patch(MESSAGEVIEW + ".set_focus_valign")
msg_view.log.next_position.return_value = 1
msg_view.keypress(size, key)
msg_view.log.next_position.assert_called_once_with(msg_view.focus_position)
msg_view.set_focus.assert_called_with(1, "above")
msg_view.set_focus_valign.assert_called_once_with("middle")
@pytest.mark.parametrize("view_is_focused", [True, False])
@pytest.mark.parametrize("key", keys_for_command("GO_DOWN"))
def test_keypress_GO_DOWN_exception(
self, mocker, msg_view, key, widget_size, view_is_focused
):
size = widget_size(msg_view)
msg_view.new_loading = False
mocker.patch(MESSAGEVIEW + ".focus_position", return_value=0)
mocker.patch(MESSAGEVIEW + ".set_focus_valign")
msg_view.log.next_position = Exception()
mocker.patch(
MESSAGEVIEW + ".focus",
mocker.MagicMock() if view_is_focused else None,
)
mocker.patch.object(msg_view, "load_new_messages")
return_value = msg_view.keypress(size, key)
if view_is_focused:
msg_view.load_new_messages.assert_called_once_with(
msg_view.focus.original_widget.message["id"],
)
else:
msg_view.load_new_messages.assert_not_called()
assert return_value == key
@pytest.mark.parametrize("key", keys_for_command("GO_UP"))
def test_keypress_GO_UP(self, mocker, msg_view, key, widget_size):
size = widget_size(msg_view)
mocker.patch(MESSAGEVIEW + ".focus_position", return_value=0)
mocker.patch(MESSAGEVIEW + ".set_focus_valign")
msg_view.old_loading = False
msg_view.log.prev_position.return_value = 1
msg_view.keypress(size, key)
msg_view.log.prev_position.assert_called_once_with(msg_view.focus_position)
msg_view.set_focus.assert_called_with(1, "below")
msg_view.set_focus_valign.assert_called_once_with("middle")
@pytest.mark.parametrize("view_is_focused", [True, False])
@pytest.mark.parametrize("key", keys_for_command("GO_UP"))
def test_keypress_GO_UP_exception(
self, mocker, msg_view, key, widget_size, view_is_focused
):
size = widget_size(msg_view)
msg_view.old_loading = False
mocker.patch(MESSAGEVIEW + ".focus_position", return_value=0)
mocker.patch(MESSAGEVIEW + ".set_focus_valign")
msg_view.log.prev_position = Exception()
mocker.patch(
MESSAGEVIEW + ".focus",
mocker.MagicMock() if view_is_focused else None,
)
mocker.patch.object(msg_view, "load_old_messages")
return_value = msg_view.keypress(size, key)
if view_is_focused:
msg_view.load_old_messages.assert_called_once_with(
msg_view.focus.original_widget.message["id"],
)
else:
msg_view.load_old_messages.assert_not_called()
assert return_value == key
def test_read_message(self, mocker, msg_box):
mocker.patch(MESSAGEVIEW + ".main_view", return_value=[msg_box])
self.urwid.SimpleFocusListWalker.return_value = mocker.Mock()
mocker.patch(MESSAGEVIEW + ".set_focus")
mocker.patch(MESSAGEVIEW + ".update_search_box_narrow")
msg_view = MessageView(self.model, self.view)
msg_view.model.is_search_narrow = lambda: False
msg_view.model.controller.in_explore_mode = False
msg_view.log = mocker.Mock()
msg_view.body = mocker.Mock()
msg_w = mocker.MagicMock()
msg_view.model.controller.view = mocker.Mock()
msg_view.model.controller.view.body.focus_col = 1
msg_w.attr_map = {None: "unread"}
msg_w.original_widget.message = {"id": 1}
msg_w.set_attr_map.return_value = None
msg_view.body.get_focus.return_value = (msg_w, 0)
msg_view.body.get_prev.return_value = (None, 1)
msg_view.model.narrow = []
msg_view.model.index = {
"messages": {
1: {
"flags": [],
}
},
"pointer": {"[]": 0},
}
mocker.patch(MESSAGEVIEW + ".focus_position")
msg_view.focus_position = 1
msg_view.model.controller.view.body.focus_col = 1
msg_view.log = list(msg_view.model.index["messages"])
msg_view.read_message()
assert msg_view.update_search_box_narrow.called
assert msg_view.model.index["messages"][1]["flags"] == ["read"]
self.model.mark_message_ids_as_read.assert_called_once_with([1])
def test_message_calls_search_and_header_bar(self, mocker, msg_view):
msg_w = mocker.MagicMock()
msg_w.original_widget.message = {"id": 1}
msg_view.update_search_box_narrow(msg_w.original_widget)
msg_w.original_widget.recipient_header.assert_called_once_with()
msg_w.original_widget.top_search_bar.assert_called_once_with()
def test_read_message_no_msgw(self, mocker, msg_view):
# MSG_W is NONE CASE
msg_view.body.get_focus.return_value = (None, 0)
msg_view.read_message()
self.model.mark_message_ids_as_read.assert_not_called()
def test_read_message_in_explore_mode(self, mocker, msg_box):
mocker.patch(MESSAGEVIEW + ".main_view", return_value=[msg_box])
mocker.patch(MESSAGEVIEW + ".set_focus")
mocker.patch(MESSAGEVIEW + ".update_search_box_narrow")
msg_view = MessageView(self.model, self.view)
msg_w = mocker.Mock()
msg_view.body = mocker.Mock()
msg_view.body.get_focus.return_value = (msg_w, 0)
msg_view.model.is_search_narrow = lambda: False
msg_view.model.controller.in_explore_mode = True
msg_view.read_message()
assert msg_view.update_search_box_narrow.called
assert not self.model.mark_message_ids_as_read.called
def test_read_message_search_narrow(self, mocker, msg_box):
mocker.patch(MESSAGEVIEW + ".main_view", return_value=[msg_box])
mocker.patch(MESSAGEVIEW + ".set_focus")
mocker.patch(MESSAGEVIEW + ".update_search_box_narrow")
msg_view = MessageView(self.model, self.view)
msg_view.model.controller.view = mocker.Mock()
msg_w = mocker.Mock()
msg_view.body = mocker.Mock()
msg_view.body.get_focus.return_value = (msg_w, 0)
msg_view.model.is_search_narrow = lambda: True
msg_view.model.controller.in_explore_mode = False
msg_view.read_message()
assert msg_view.update_search_box_narrow.called
assert not self.model.mark_message_ids_as_read.called
def test_read_message_last_unread_message_focused(
self, mocker, message_fixture, empty_index, msg_box
):
mocker.patch(MESSAGEVIEW + ".main_view", return_value=[msg_box])
mocker.patch(MESSAGEVIEW + ".set_focus")
msg_view = MessageView(self.model, self.view)
msg_view.model.is_search_narrow = lambda: False
msg_view.model.controller.in_explore_mode = False
msg_view.log = [0, 1]
msg_view.body = mocker.Mock()
msg_view.update_search_box_narrow = mocker.Mock()
self.model.controller.view = mocker.Mock()
self.model.controller.view.body.focus_col = 0
self.model.index = empty_index
msg_w = mocker.Mock()
msg_w.attr_map = {None: "unread"}
msg_w.original_widget.message = message_fixture
msg_view.body.get_focus.return_value = (msg_w, 1)
msg_view.body.get_prev.return_value = (None, 0)
msg_view.read_message(1)
self.model.mark_message_ids_as_read.assert_called_once_with(
[message_fixture["id"]]
)
class TestStreamsViewDivider:
def test_init(self):
streams_view_divider = StreamsViewDivider()
assert isinstance(streams_view_divider, Divider)
assert streams_view_divider.stream_id == -1
assert streams_view_divider.stream_name == ""
class TestStreamsView:
@pytest.fixture
def stream_view(self, mocker):
mocker.patch(VIEWS + ".threading.Lock")
self.view = mocker.Mock()
self.stream_search_box = mocker.patch(VIEWS + ".PanelSearchBox")
stream_btn = mocker.Mock()
stream_btn.stream_name = "FOO"
self.streams_btn_list = [stream_btn]
return StreamsView(self.streams_btn_list, view=self.view)
def test_init(self, mocker, stream_view):
assert stream_view.view == self.view
assert stream_view.streams_btn_list == self.streams_btn_list
assert stream_view.stream_search_box
self.stream_search_box.assert_called_once_with(
stream_view, "SEARCH_STREAMS", stream_view.update_streams
)
@pytest.mark.parametrize(
"new_text, expected_log, to_pin",
[
# NOTE: '' represents StreamsViewDivider's stream name.
("f", ["fan", "FOO", "foo", "FOOBAR"], []),
("bar", ["bar"], []),
("foo", ["FOO", "foo", "FOOBAR"], []),
("FOO", ["FOO", "foo", "FOOBAR"], []),
("test", ["test here"], []),
("here", ["test here"], []),
("test here", ["test here"], []),
# With 'foo' pinned.
("f", ["foo", "", "fan", "FOO", "FOOBAR"], ["foo"]),
("FOO", ["foo", "", "FOO", "FOOBAR"], ["foo"]),
# With 'bar' pinned.
("bar", ["bar"], ["bar"]),
("baar", "search error", []),
],
)
def test_update_streams(self, mocker, stream_view, new_text, expected_log, to_pin):
stream_names = ["FOO", "FOOBAR", "foo", "fan", "boo", "BOO", "bar", "test here"]
stream_names.sort(key=lambda stream_name: stream_name.lower())
self.view.pinned_streams = [{"name": name} for name in to_pin]
stream_names.sort(
key=lambda stream_name: stream_name in to_pin,
reverse=True,
)
self.view.controller.is_in_editor_mode = lambda: True
search_box = stream_view.stream_search_box
stream_view.streams_btn_list = [
mocker.Mock(stream_name=stream_name) for stream_name in stream_names
]
stream_view.update_streams(search_box, new_text)
if expected_log != "search error":
assert [stream.stream_name for stream in stream_view.log] == expected_log
else:
assert hasattr(stream_view.log[0].original_widget, "text")
self.view.controller.update_screen.assert_called_once_with()
def test_mouse_event(self, mocker, stream_view, mouse_scroll_event, widget_size):
event, button, key = mouse_scroll_event
stream_view_keypress = mocker.patch.object(stream_view, "keypress")
size = widget_size(stream_view)
col = 1
row = 1
focus = "WIDGET"
stream_view.mouse_event(size, event, button, col, row, focus)
stream_view_keypress.assert_has_calls(
[mocker.call(size, key)] * SIDE_PANELS_MOUSE_SCROLL_LINES
)
@pytest.mark.parametrize("key", keys_for_command("SEARCH_STREAMS"))
def test_keypress_SEARCH_STREAMS(self, mocker, stream_view, key, widget_size):
size = widget_size(stream_view)
mocker.patch.object(stream_view, "set_focus")
mocker.patch.object(stream_view.stream_search_box, "set_caption")
stream_view.log.extend(["FOO", "foo", "fan", "boo", "BOO"])
stream_view.log.set_focus(3)
stream_view.keypress(size, key)
assert stream_view.focus_index_before_search == 3
stream_view.set_focus.assert_called_once_with("header")
stream_view.stream_search_box.set_caption.assert_called_once_with(" ")
self.view.controller.enter_editor_mode_with.assert_called_once_with(
stream_view.stream_search_box
)
@pytest.mark.parametrize("key", keys_for_command("CLEAR_SEARCH"))
def test_keypress_CLEAR_SEARCH(self, mocker, stream_view, key, widget_size):
size = widget_size(stream_view)
mocker.patch.object(stream_view, "set_focus")
mocker.patch(VIEWS + ".urwid.Frame.keypress")
mocker.patch.object(stream_view.stream_search_box, "reset_search_text")
stream_view.streams_btn_list = ["FOO", "foo", "fan", "boo", "BOO"]
stream_view.focus_index_before_search = 3
# Simulate search
stream_view.log.clear()
stream_view.log.extend(stream_view.streams_btn_list[3])
stream_view.log.set_focus(0)
stream_view.keypress(size, primary_key_for_command("GO_DOWN"))
assert stream_view.log.get_focus()[1] != stream_view.focus_index_before_search
# Exit search
stream_view.keypress(size, key)
# Check state reset after search
stream_view.set_focus.assert_called_once_with("body")
assert stream_view.stream_search_box.reset_search_text.called
assert stream_view.log == stream_view.streams_btn_list
assert stream_view.log.get_focus()[1] == stream_view.focus_index_before_search
class TestTopicsView:
@pytest.fixture
def topic_view(self, mocker, stream_button):
self.stream_button = stream_button
mocker.patch(VIEWS + ".threading.Lock")
self.topic_search_box = mocker.patch(VIEWS + ".PanelSearchBox")
self.view = mocker.Mock()
self.view.controller = mocker.Mock()
topic_btn = mocker.Mock()
topic_btn.caption = "BOO"
self.topics_btn_list = [topic_btn]
self.header_list = mocker.patch(VIEWS + ".urwid.Pile")
self.divider = mocker.patch(VIEWS + ".urwid.Divider")
return TopicsView(self.topics_btn_list, self.view, self.stream_button)
def test_init(self, mocker, topic_view):
assert topic_view.stream_button == self.stream_button
assert topic_view.view == self.view
assert topic_view.topic_search_box
self.topic_search_box.assert_called_once_with(
topic_view, "SEARCH_TOPICS", topic_view.update_topics
)
self.header_list.assert_called_once_with(
[
topic_view.stream_button,
self.divider("─"),
topic_view.topic_search_box,
self.divider("─"),
]
)
@pytest.mark.parametrize(
"stream_id, saved_topic_state, expected_focus_index",
[
case(1, None, 0, id="initial_condition_no_topic_is_stored"),
case(2, "Topic 3", 2, id="topic_is_stored_and_present_in_topic_list"),
case(3, "Topic 4", 0, id="topic_is_stored_but_not_present_in_topic_list"),
],
)
def test__focus_position_for_topic_name(
self, mocker, stream_id, saved_topic_state, topic_view, expected_focus_index
):
topic_view.stream_button.stream_id = stream_id
topic_view.list_box = mocker.MagicMock(spec=urwid.ListBox)
topic_view.list_box.body = [
mocker.Mock(topic_name="Topic 1"),
mocker.Mock(topic_name="Topic 2"),
mocker.Mock(topic_name="Topic 3"),
]
topic_view.log = urwid.SimpleFocusListWalker(topic_view.list_box.body)
mocker.patch.object(
topic_view.view, "saved_topic_in_stream_id", return_value=saved_topic_state
)
new_focus_index = topic_view._focus_position_for_topic_name()
assert new_focus_index == expected_focus_index
@pytest.mark.parametrize(
"new_text, expected_log",
[
("f", ["FOO", "FOOBAR", "foo", "fan"]),
("a", ["FOOBAR", "fan", "bar"]),
("bar", ["FOOBAR", "bar"]),
("foo", ["FOO", "FOOBAR", "foo"]),
("FOO", ["FOO", "FOOBAR", "foo"]),
("(no", ["(no topic)"]),
("topic", ["(no topic)"]),
("cc", "search error"),
],
)
def test_update_topics(self, mocker, topic_view, new_text, expected_log):
topic_names = ["FOO", "FOOBAR", "foo", "fan", "boo", "BOO", "bar", "(no topic)"]
self.view.controller.is_in_editor_mode = lambda: True
new_text = new_text
search_box = topic_view.topic_search_box
topic_view.topics_btn_list = [
mocker.Mock(topic_name=topic_name) for topic_name in topic_names
]
topic_view.update_topics(search_box, new_text)
if expected_log != "search error":
assert [topic.topic_name for topic in topic_view.log] == expected_log
else:
assert hasattr(topic_view.log[0].original_widget, "text")
self.view.controller.update_screen.assert_called_once_with()
@pytest.mark.parametrize(
"topic_name, topic_initial_log, topic_final_log",
[
("TOPIC3", ["TOPIC2", "TOPIC3", "TOPIC1"], ["TOPIC3", "TOPIC2", "TOPIC1"]),
("TOPIC1", ["TOPIC1", "TOPIC2", "TOPIC3"], ["TOPIC1", "TOPIC2", "TOPIC3"]),
(
"TOPIC4",
["TOPIC1", "TOPIC2", "TOPIC3"],
["TOPIC4", "TOPIC1", "TOPIC2", "TOPIC3"],
),
("TOPIC1", [], ["TOPIC1"]),
],
ids=[
"reorder_topic3",
"topic1_discussion_continues",
"new_topic4",
"first_topic_1",
],
)
def test_update_topics_list(
self, mocker, topic_view, topic_name, topic_initial_log, topic_final_log
):
mocker.patch(SUBDIR + ".buttons.TopButton.__init__", return_value=None)
set_focus_valign = mocker.patch(VIEWS + ".urwid.ListBox.set_focus_valign")
topic_view.view.controller.model.stream_dict = {86: {"name": "PTEST"}}
topic_view.view.controller.model.is_muted_topic = mocker.Mock(
return_value=False
)
topic_view.log = [
mocker.Mock(topic_name=topic_name) for topic_name in topic_initial_log
]
topic_view.update_topics_list(86, topic_name, 1001)
assert [topic.topic_name for topic in topic_view.log] == topic_final_log
set_focus_valign.assert_called_once_with("bottom")
@pytest.mark.parametrize("key", keys_for_command("SEARCH_TOPICS"))
def test_keypress_SEARCH_TOPICS(self, mocker, topic_view, key, widget_size):
size = widget_size(topic_view)
mocker.patch(VIEWS + ".TopicsView.set_focus")
mocker.patch.object(topic_view.topic_search_box, "set_caption")
topic_view.log.extend(["FOO", "foo", "fan", "boo", "BOO"])
topic_view.log.set_focus(3)
topic_view.keypress(size, key)
topic_view.set_focus.assert_called_once_with("header")
topic_view.header_list.set_focus.assert_called_once_with(2)
assert topic_view.focus_index_before_search == 3
topic_view.topic_search_box.set_caption.assert_called_once_with(" ")
self.view.controller.enter_editor_mode_with.assert_called_once_with(
topic_view.topic_search_box
)
@pytest.mark.parametrize("key", keys_for_command("CLEAR_SEARCH"))
def test_keypress_CLEAR_SEARCH(self, mocker, topic_view, key, widget_size):
size = widget_size(topic_view)
mocker.patch(VIEWS + ".TopicsView.set_focus")
mocker.patch(VIEWS + ".urwid.Frame.keypress")
mocker.patch.object(topic_view.topic_search_box, "reset_search_text")
topic_view.topics_btn_list = ["FOO", "foo", "fan", "boo", "BOO"]
topic_view.focus_index_before_search = 3
# Simulate search
topic_view.log.clear()
topic_view.log.extend(topic_view.topics_btn_list[3])
topic_view.log.set_focus(0)
topic_view.keypress(size, primary_key_for_command("GO_DOWN"))
assert topic_view.log.get_focus()[1] != topic_view.focus_index_before_search
# Exit search
topic_view.keypress(size, key)
# Check state reset after search
topic_view.set_focus.assert_called_once_with("body")
assert topic_view.topic_search_box.reset_search_text.called
assert topic_view.log == topic_view.topics_btn_list
assert topic_view.log.get_focus()[1] == topic_view.focus_index_before_search
def test_mouse_event(self, mocker, topic_view, mouse_scroll_event, widget_size):
event, button, key = mouse_scroll_event
topic_view_keypress = mocker.patch.object(topic_view, "keypress")
size = widget_size(topic_view)
col = 1
row = 1
focus = "WIDGET"
topic_view.mouse_event(size, event, button, col, row, focus)
topic_view_keypress.assert_has_calls(
[mocker.call(size, key)] * SIDE_PANELS_MOUSE_SCROLL_LINES
)
class TestUsersView:
@pytest.fixture
def user_view(self, mocker):
mocker.patch(VIEWS + ".urwid.SimpleFocusListWalker", return_value=[])
controller = mocker.Mock()
return UsersView(controller, "USER_BTN_LIST")
def test_mouse_event(self, mocker, user_view, mouse_scroll_event, widget_size):
event, button, key = mouse_scroll_event
user_view_keypress = mocker.patch.object(user_view, "keypress")
size = widget_size(user_view)
col = 1
row = 1
focus = "WIDGET"
user_view.mouse_event(size, event, button, col, row, focus)
user_view_keypress.assert_has_calls(
[mocker.call(size, key)] * SIDE_PANELS_MOUSE_SCROLL_LINES
)
def test_mouse_event_left_click(
self, mocker, user_view, widget_size, compose_box_is_open
):
super_mouse_event = mocker.patch(VIEWS + ".urwid.ListBox.mouse_event")
user_view.controller.is_in_editor_mode.return_value = compose_box_is_open
size = widget_size(user_view)
focus = mocker.Mock()
user_view.mouse_event(size, "mouse press", 1, 1, 1, focus)
if compose_box_is_open:
super_mouse_event.assert_not_called()
else:
super_mouse_event.assert_called_once_with(
size, "mouse press", 1, 1, 1, focus
)
@pytest.mark.parametrize(
"event, button",
[
("mouse release", 0),
("mouse press", 3),
("mouse release", 4),
],
ids=[
"unsupported_mouse_release_action",
"unsupported_right_click_mouse_press_action",
"invalid_event_button_combination",
],
)
def test_mouse_event_invalid(self, user_view, event, button, widget_size):
size = widget_size(user_view)
col = 1
row = 1
focus = "WIDGET"
return_value = user_view.mouse_event(size, event, button, col, row, focus)
assert return_value is False
class TestMiddleColumnView:
@pytest.fixture(autouse=True)
def mock_external_classes(self, mocker):
mocker.patch(MESSAGEVIEW + "", return_value="MSG_LIST")
self.model = mocker.Mock()
self.view = mocker.Mock()
self.write_box = mocker.Mock()
self.search_box = mocker.Mock()
self.super = mocker.patch(VIEWS + ".urwid.Frame.__init__")
self.super_keypress = mocker.patch(VIEWS + ".urwid.Frame.keypress")
self.model.controller = mocker.Mock()
@pytest.fixture
def mid_col_view(self):
return MiddleColumnView(self.view, self.model, self.write_box, self.search_box)
def test_init(self, mid_col_view):
assert mid_col_view.model == self.model
assert mid_col_view.controller == self.model.controller
assert mid_col_view.search_box == self.search_box
assert self.view.message_view == "MSG_LIST"
self.super.assert_called_once_with(
"MSG_LIST", header=self.search_box, footer=self.write_box
)
@pytest.mark.parametrize("key", keys_for_command("SEARCH_MESSAGES"))
def test_keypress_focus_header(self, mid_col_view, mocker, key, widget_size):
size = widget_size(mid_col_view)
mid_col_view.focus_part = "header"
mid_col_view.keypress(size, key)
self.super_keypress.assert_called_once_with(size, key)
@pytest.mark.parametrize("key", keys_for_command("SEARCH_MESSAGES"))
def test_keypress_SEARCH_MESSAGES(self, mid_col_view, mocker, key, widget_size):
size = widget_size(mid_col_view)
mocker.patch(MIDCOLVIEW + ".focus_position")
mocker.patch(MIDCOLVIEW + ".set_focus")
mid_col_view.keypress(size, key)
mid_col_view.controller.enter_editor_mode_with.assert_called_once_with(
mid_col_view.search_box
)
mid_col_view.set_focus.assert_called_once_with("header")
@pytest.mark.parametrize("reply_message_key", keys_for_command("REPLY_MESSAGE"))
def test_keypress_REPLY_MESSAGE(
self, mid_col_view, mocker, widget_size, reply_message_key
):
size = widget_size(mid_col_view)
mocker.patch(MIDCOLVIEW + ".body")
mocker.patch(MIDCOLVIEW + ".footer")
mocker.patch(MIDCOLVIEW + ".focus_position")
mocker.patch(MIDCOLVIEW + ".set_focus")
mid_col_view.keypress(size, reply_message_key)
mid_col_view.body.keypress.assert_called_once_with(size, reply_message_key)
mid_col_view.set_focus.assert_called_once_with("footer")
assert mid_col_view.footer.focus_position == 1
@pytest.mark.parametrize("key", keys_for_command("STREAM_MESSAGE"))
def test_keypress_STREAM_MESSAGE(self, mid_col_view, mocker, key, widget_size):
size = widget_size(mid_col_view)
mocker.patch(MIDCOLVIEW + ".body")
mocker.patch(MIDCOLVIEW + ".footer")
mocker.patch(MIDCOLVIEW + ".focus_position")
mocker.patch(MIDCOLVIEW + ".set_focus")
mid_col_view.keypress(size, key)
mid_col_view.body.keypress.assert_called_once_with(size, key)
mid_col_view.set_focus.assert_called_once_with("footer")
assert mid_col_view.footer.focus_position == 0
@pytest.mark.parametrize("key", keys_for_command("REPLY_AUTHOR"))
def test_keypress_REPLY_AUTHOR(self, mid_col_view, mocker, key, widget_size):
size = widget_size(mid_col_view)
mocker.patch(MIDCOLVIEW + ".body")
mocker.patch(MIDCOLVIEW + ".footer")
mocker.patch(MIDCOLVIEW + ".focus_position")
mocker.patch(MIDCOLVIEW + ".set_focus")
mid_col_view.keypress(size, key)
mid_col_view.body.keypress.assert_called_once_with(size, key)
mid_col_view.set_focus.assert_called_once_with("footer")
assert mid_col_view.footer.focus_position == 1
@pytest.mark.parametrize("key", keys_for_command("NEXT_UNREAD_TOPIC"))
def test_keypress_NEXT_UNREAD_TOPIC_stream(
self, mid_col_view, mocker, widget_size, key
):
size = widget_size(mid_col_view)
mocker.patch(MIDCOLVIEW + ".focus_position")
mocker.patch.object(self.view, "message_view")
mid_col_view.model.stream_dict = {1: {"name": "stream"}}
mid_col_view.model.next_unread_topic_from_message_id.return_value = (1, "topic")
return_value = mid_col_view.keypress(size, key)
mid_col_view.controller.narrow_to_topic.assert_called_once_with(
stream_name="stream", topic_name="topic"
)
assert return_value == key
@pytest.mark.parametrize("key", keys_for_command("NEXT_UNREAD_TOPIC"))
def test_keypress_NEXT_UNREAD_TOPIC_no_stream(
self, mid_col_view, mocker, widget_size, key
):
size = widget_size(mid_col_view)
mocker.patch(MIDCOLVIEW + ".focus_position")
mocker.patch.object(self.view, "message_view")
mid_col_view.model.next_unread_topic_from_message_id.return_value = None
return_value = mid_col_view.keypress(size, key)
assert mid_col_view.controller.narrow_to_topic.called is False
assert return_value == key
@pytest.mark.parametrize("key", keys_for_command("NEXT_UNREAD_PM"))
def test_keypress_NEXT_UNREAD_PM_stream(
self, mid_col_view, mocker, key, widget_size
):
size = widget_size(mid_col_view)
mocker.patch(MIDCOLVIEW + ".focus_position")
mid_col_view.model.user_id_email_dict = {1: "EMAIL"}
mid_col_view.model.get_next_unread_pm.return_value = 1
mid_col_view.keypress(size, key)
mid_col_view.controller.narrow_to_user.assert_called_once_with(
recipient_emails=["EMAIL"],
contextual_message_id=1,
)
@pytest.mark.parametrize("key", keys_for_command("NEXT_UNREAD_PM"))
def test_keypress_NEXT_UNREAD_PM_no_pm(
self, mid_col_view, mocker, key, widget_size
):
size = widget_size(mid_col_view)
mocker.patch(MIDCOLVIEW + ".focus_position")
mid_col_view.model.get_next_unread_pm.return_value = None
return_value = mid_col_view.keypress(size, key)
assert return_value == key
@pytest.mark.parametrize("key", keys_for_command("PRIVATE_MESSAGE"))
def test_keypress_PRIVATE_MESSAGE(self, mid_col_view, mocker, key, widget_size):
size = widget_size(mid_col_view)
mocker.patch(MIDCOLVIEW + ".focus_position")
mid_col_view.model.get_next_unread_pm.return_value = None
mid_col_view.footer = mocker.Mock()
return_value = mid_col_view.keypress(size, key)
mid_col_view.footer.private_box_view.assert_called_once_with()
assert mid_col_view.footer.focus_position == 0
assert return_value == key
class TestRightColumnView:
@pytest.fixture(autouse=True)
def mock_external_classes(self, mocker):
self.view = mocker.Mock()
self.user_search = mocker.patch(VIEWS + ".PanelSearchBox")
self.connect_signal = mocker.patch(VIEWS + ".urwid.connect_signal")
self.pile = mocker.patch(VIEWS + ".urwid.Pile")
self.thread = mocker.patch(VIEWS + ".threading")
self.super = mocker.patch(VIEWS + ".urwid.Frame.__init__")
self.view.model.unread_counts = { # Minimal, though an UnreadCounts
"unread_pms": {
1: 1,
2: 1,
}
}