Debian Codegraph @

tests/unit_tests/test_braille_presenter.py

raw
1 # Unit tests for braille_presenter.py methods.
2 #
3 # Copyright 2025-2026 Igalia, S.L.
4 # Author: Joanmarie Diggs <[email protected]>
5 #
6 # This library is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU Lesser General Public
8 # License as published by the Free Software Foundation; either
9 # version 2.1 of the License, or (at your option) any later version.
10 #
11 # This library is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # Lesser General Public License for more details.
15 #
16 # You should have received a copy of the GNU Lesser General Public
17 # License along with this library; if not, write to the
18 # Free Software Foundation, Inc., Franklin Street, Fifth Floor,
19 # Boston MA 02110-1301 USA.
20
21 # pylint: disable=wrong-import-position
22 # pylint: disable=import-outside-toplevel
23 # pylint: disable=protected-access
24 # pylint: disable=too-many-public-methods
25 # pylint: disable=too-many-lines
26
27 """Unit tests for braille_presenter.py methods."""
28
29 from __future__ import annotations
30
31 import unittest.mock
32 from typing import TYPE_CHECKING
33
34 import gi
35
36 gi.require_version("Gtk", "3.0")
37
38 import pytest
39
40 if TYPE_CHECKING:
41 from unittest.mock import MagicMock
42
43 from .orca_test_context import OrcaTestContext
44
45
46 @pytest.mark.unit
47 class TestBraillePresenter:
48 """Test BraillePresenter methods."""
49
50 def _setup_dependencies(self, test_context: OrcaTestContext) -> dict[str, MagicMock]:
51 """Set up mocks for braille_presenter dependencies."""
52
53 additional_modules = ["orca.braille", "orca.braille_monitor", "orca.orca_platform"]
54 essential_modules = test_context.setup_shared_dependencies(additional_modules)
55
56 platform_mock = essential_modules["orca.orca_platform"]
57 platform_mock.tablesdir = "/usr/share/liblouis/tables"
58
59 from orca import gsettings_registry
60
61 registry = gsettings_registry.get_registry()
62 registry.clear_runtime_values()
63
64 test_context.patch(
65 "orca.braille_presenter.BraillePresenter._get_table_files",
66 return_value=[
67 "en-us-g1.ctb",
68 "en-us-g2.ctb",
69 "en-us-comp8.ctb",
70 "fr-bfu-g2.ctb",
71 "de-g2.ctb",
72 ],
73 )
74
75 return essential_modules
76
77 def test_get_braille_is_enabled(self, test_context: OrcaTestContext):
78 """Test getting braille enabled status."""
79
80 self._setup_dependencies(test_context)
81 from orca.braille_presenter import get_presenter
82
83 presenter = get_presenter()
84
85 assert presenter.get_braille_is_enabled() is True
86
87 presenter.set_braille_is_enabled(False)
88 assert presenter.get_braille_is_enabled() is False
89
90 def test_set_braille_is_enabled(self, test_context: OrcaTestContext):
91 """Test setting braille enabled status."""
92
93 self._setup_dependencies(test_context)
94 from orca.braille_presenter import get_presenter
95
96 presenter = get_presenter()
97
98 result = presenter.set_braille_is_enabled(True)
99 assert result is True
100 assert presenter.get_braille_is_enabled() is True
101
102 result = presenter.set_braille_is_enabled(False)
103 assert result is True
104 assert presenter.get_braille_is_enabled() is False
105
106 def test_get_contraction_table(self, test_context: OrcaTestContext):
107 """Test getting contraction table."""
108
109 self._setup_dependencies(test_context)
110 from orca.braille_presenter import get_presenter
111
112 presenter = get_presenter()
113
114 assert presenter.get_contraction_table() == ""
115
116 presenter.set_contraction_table("en-us-g2")
117 assert presenter.get_contraction_table() == "en-us-g2"
118
119 def test_get_available_contraction_tables(self, test_context: OrcaTestContext):
120 """Test getting available contraction tables."""
121
122 self._setup_dependencies(test_context)
123 from orca.braille_presenter import get_presenter
124
125 presenter = get_presenter()
126
127 tables = presenter.get_available_contraction_tables()
128 expected = ["en-us-g1", "en-us-g2", "en-us-comp8", "fr-bfu-g2", "de-g2"]
129 assert tables == expected
130
131 def test_set_contraction_table_valid(self, test_context: OrcaTestContext):
132 """Test setting valid contraction table."""
133
134 self._setup_dependencies(test_context)
135 from orca.braille_presenter import get_presenter
136
137 presenter = get_presenter()
138
139 result = presenter.set_contraction_table("en-us-g2")
140 assert result is True
141 assert presenter.get_contraction_table_path() == "/usr/share/liblouis/tables/en-us-g2.ctb"
142
143 result = presenter.set_contraction_table("en-us-g1.ctb")
144 assert result is True
145 assert presenter.get_contraction_table_path() == "/usr/share/liblouis/tables/en-us-g1.ctb"
146
147 def test_set_contraction_table_invalid(self, test_context: OrcaTestContext):
148 """Test setting invalid contraction table."""
149
150 self._setup_dependencies(test_context)
151 from orca.braille_presenter import get_presenter
152
153 presenter = get_presenter()
154
155 result = presenter.set_contraction_table("nonexistent")
156 assert result is False
157
158 result = presenter.set_contraction_table("nonexistent.ctb")
159 assert result is False
160
161 def test_set_contraction_table_empty_string(self, test_context: OrcaTestContext):
162 """Test setting empty contraction table returns False."""
163
164 self._setup_dependencies(test_context)
165 from orca.braille_presenter import get_presenter
166
167 presenter = get_presenter()
168
169 result = presenter.set_contraction_table("")
170 assert result is False
171
172 def test_get_indicator_styles(self, test_context: OrcaTestContext):
173 """Test getting indicator styles."""
174
175 self._setup_dependencies(test_context)
176 from orca.braille_presenter import get_presenter
177
178 presenter = get_presenter()
179
180 assert presenter.get_selector_indicator() == "dots78"
181 assert presenter.get_link_indicator() == "dots78"
182 assert presenter.get_text_attributes_indicator() == "none"
183
184 presenter.set_link_indicator("dot7")
185 assert presenter.get_link_indicator() == "dot7"
186
187 def test_set_indicator_styles(self, test_context: OrcaTestContext):
188 """Test setting indicator styles."""
189
190 self._setup_dependencies(test_context)
191 from orca.braille_presenter import get_presenter
192
193 presenter = get_presenter()
194
195 result = presenter.set_selector_indicator("dots78")
196 assert result is True
197 assert presenter.get_selector_indicator() == "dots78"
198
199 result = presenter.set_link_indicator("dot8")
200 assert result is True
201 assert presenter.get_link_indicator() == "dot8"
202
203 result = presenter.set_text_attributes_indicator("none")
204 assert result is True
205 assert presenter.get_text_attributes_indicator() == "none"
206
207 result = presenter.set_selector_indicator("invalid")
208 assert result is False
209
210 result = presenter.set_link_indicator("invalid")
211 assert result is False
212
213 result = presenter.set_text_attributes_indicator("invalid")
214 assert result is False
215
216 def test_end_of_line_indicator(self, test_context: OrcaTestContext):
217 """Test end of line indicator settings."""
218
219 self._setup_dependencies(test_context)
220 from orca.braille_presenter import get_presenter
221
222 presenter = get_presenter()
223
224 assert presenter.get_end_of_line_indicator_is_enabled() is True
225
226 result = presenter.set_end_of_line_indicator_is_enabled(False)
227 assert result is True
228 assert presenter.get_end_of_line_indicator_is_enabled() is False
229
230 result = presenter.set_end_of_line_indicator_is_enabled(True)
231 assert result is True
232 assert presenter.get_end_of_line_indicator_is_enabled() is True
233
234 def test_use_braille(self, test_context: OrcaTestContext):
235 """Test use_braille method."""
236
237 self._setup_dependencies(test_context)
238 from orca.braille_presenter import get_presenter
239
240 presenter = get_presenter()
241
242 presenter.set_monitor_is_enabled(False)
243 assert presenter.use_braille() is True
244
245 presenter.set_braille_is_enabled(False)
246 presenter.set_monitor_is_enabled(True)
247 assert presenter.use_braille() is True
248
249 presenter.set_monitor_is_enabled(False)
250 assert presenter.use_braille() is False
251
252 def test_use_verbose_braille(self, test_context: OrcaTestContext):
253 """Test use_verbose_braille method."""
254
255 self._setup_dependencies(test_context)
256 from orca.braille_presenter import get_presenter
257
258 presenter = get_presenter()
259
260 assert presenter.use_verbose_braille() is True
261
262 presenter.set_verbosity_level("brief")
263 assert presenter.use_verbose_braille() is False
264
265 def test_get_verbosity_level(self, test_context: OrcaTestContext):
266 """Test getting verbosity level."""
267
268 self._setup_dependencies(test_context)
269 from orca.braille_presenter import get_presenter
270
271 presenter = get_presenter()
272
273 assert presenter.get_verbosity_level() == "verbose"
274
275 presenter.set_verbosity_level("brief")
276 assert presenter.get_verbosity_level() == "brief"
277
278 def test_set_verbosity_level(self, test_context: OrcaTestContext):
279 """Test setting verbosity level."""
280
281 self._setup_dependencies(test_context)
282 from orca.braille_presenter import get_presenter
283
284 presenter = get_presenter()
285
286 result = presenter.set_verbosity_level("brief")
287 assert result is True
288 assert presenter.get_verbosity_level() == "brief"
289
290 result = presenter.set_verbosity_level("verbose")
291 assert result is True
292 assert presenter.get_verbosity_level() == "verbose"
293
294 result = presenter.set_verbosity_level("invalid")
295 assert result is False
296
297 def test_use_full_rolenames(self, test_context: OrcaTestContext):
298 """Test use_full_rolenames method."""
299
300 self._setup_dependencies(test_context)
301 from orca.braille_presenter import get_presenter
302
303 presenter = get_presenter()
304
305 assert presenter.use_full_rolenames() is True
306
307 presenter.set_rolename_style("brief")
308 assert presenter.use_full_rolenames() is False
309
310 def test_get_rolename_style(self, test_context: OrcaTestContext):
311 """Test getting rolename style."""
312
313 self._setup_dependencies(test_context)
314 from orca.braille_presenter import get_presenter
315
316 presenter = get_presenter()
317
318 assert presenter.get_rolename_style() == "verbose"
319
320 presenter.set_rolename_style("brief")
321 assert presenter.get_rolename_style() == "brief"
322
323 def test_set_rolename_style(self, test_context: OrcaTestContext):
324 """Test setting rolename style."""
325
326 self._setup_dependencies(test_context)
327 from orca.braille_presenter import get_presenter
328
329 presenter = get_presenter()
330
331 result = presenter.set_rolename_style("brief")
332 assert result is True
333 assert presenter.get_rolename_style() == "brief"
334
335 result = presenter.set_rolename_style("verbose")
336 assert result is True
337 assert presenter.get_rolename_style() == "verbose"
338
339 result = presenter.set_rolename_style("invalid")
340 assert result is False
341
342 def test_get_display_ancestors(self, test_context: OrcaTestContext):
343 """Test getting display ancestors setting."""
344
345 self._setup_dependencies(test_context)
346 from orca.braille_presenter import get_presenter
347
348 presenter = get_presenter()
349
350 assert presenter.get_display_ancestors() is True
351
352 presenter.set_display_ancestors(False)
353 assert presenter.get_display_ancestors() is False
354
355 def test_set_display_ancestors(self, test_context: OrcaTestContext):
356 """Test setting display ancestors."""
357
358 self._setup_dependencies(test_context)
359 from orca.braille_presenter import get_presenter
360
361 presenter = get_presenter()
362
363 result = presenter.set_display_ancestors(True)
364 assert result is True
365 assert presenter.get_display_ancestors() is True
366
367 result = presenter.set_display_ancestors(False)
368 assert result is True
369 assert presenter.get_display_ancestors() is False
370
371 def test_get_contracted_braille_is_enabled(self, test_context: OrcaTestContext):
372 """Test getting contracted braille enabled status."""
373
374 self._setup_dependencies(test_context)
375 from orca.braille_presenter import get_presenter
376
377 presenter = get_presenter()
378
379 assert presenter.get_contracted_braille_is_enabled() is False
380
381 presenter.set_contracted_braille_is_enabled(True)
382 assert presenter.get_contracted_braille_is_enabled() is True
383
384 def test_set_contracted_braille_is_enabled(self, test_context: OrcaTestContext):
385 """Test setting contracted braille enabled status."""
386
387 self._setup_dependencies(test_context)
388 from orca.braille_presenter import get_presenter
389
390 presenter = get_presenter()
391
392 result = presenter.set_contracted_braille_is_enabled(True)
393 assert result is True
394 assert presenter.get_contracted_braille_is_enabled() is True
395
396 result = presenter.set_contracted_braille_is_enabled(False)
397 assert result is True
398 assert presenter.get_contracted_braille_is_enabled() is False
399
400 def test_get_computer_braille_at_cursor_is_enabled(self, test_context: OrcaTestContext):
401 """Test getting computer braille at cursor enabled status."""
402
403 self._setup_dependencies(test_context)
404 from orca.braille_presenter import get_presenter
405
406 presenter = get_presenter()
407
408 assert presenter.get_computer_braille_at_cursor_is_enabled() is True
409
410 presenter.set_computer_braille_at_cursor_is_enabled(False)
411 assert presenter.get_computer_braille_at_cursor_is_enabled() is False
412
413 def test_set_computer_braille_at_cursor_is_enabled(self, test_context: OrcaTestContext):
414 """Test setting computer braille at cursor enabled status."""
415
416 self._setup_dependencies(test_context)
417 from orca.braille_presenter import get_presenter
418
419 presenter = get_presenter()
420
421 result = presenter.set_computer_braille_at_cursor_is_enabled(True)
422 assert result is True
423 assert presenter.get_computer_braille_at_cursor_is_enabled() is True
424
425 result = presenter.set_computer_braille_at_cursor_is_enabled(False)
426 assert result is True
427 assert presenter.get_computer_braille_at_cursor_is_enabled() is False
428
429 def test_get_word_wrap_is_enabled(self, test_context: OrcaTestContext):
430 """Test getting word wrap enabled status."""
431
432 self._setup_dependencies(test_context)
433 from orca.braille_presenter import get_presenter
434
435 presenter = get_presenter()
436
437 assert presenter.get_word_wrap_is_enabled() is False
438
439 presenter.set_word_wrap_is_enabled(True)
440 assert presenter.get_word_wrap_is_enabled() is True
441
442 def test_set_word_wrap_is_enabled(self, test_context: OrcaTestContext):
443 """Test setting word wrap enabled status."""
444
445 self._setup_dependencies(test_context)
446 from orca.braille_presenter import get_presenter
447
448 presenter = get_presenter()
449
450 result = presenter.set_word_wrap_is_enabled(True)
451 assert result is True
452 assert presenter.get_word_wrap_is_enabled() is True
453
454 result = presenter.set_word_wrap_is_enabled(False)
455 assert result is True
456 assert presenter.get_word_wrap_is_enabled() is False
457
458 def test_get_flash_messages_are_enabled(self, test_context: OrcaTestContext):
459 """Test getting flash messages enabled status."""
460
461 self._setup_dependencies(test_context)
462 from orca.braille_presenter import get_presenter
463
464 presenter = get_presenter()
465
466 assert presenter.get_flash_messages_are_enabled() is True
467
468 presenter.set_flash_messages_are_enabled(False)
469 assert presenter.get_flash_messages_are_enabled() is False
470
471 def test_set_flash_messages_are_enabled(self, test_context: OrcaTestContext):
472 """Test setting flash messages enabled status."""
473
474 self._setup_dependencies(test_context)
475 from orca.braille_presenter import get_presenter
476
477 presenter = get_presenter()
478
479 result = presenter.set_flash_messages_are_enabled(True)
480 assert result is True
481 assert presenter.get_flash_messages_are_enabled() is True
482
483 result = presenter.set_flash_messages_are_enabled(False)
484 assert result is True
485 assert presenter.get_flash_messages_are_enabled() is False
486
487 def test_get_flashtime_from_settings(self, test_context: OrcaTestContext):
488 """Test getting flashtime from settings."""
489
490 self._setup_dependencies(test_context)
491 from orca.braille_presenter import get_presenter
492
493 presenter = get_presenter()
494
495 presenter.set_flash_messages_are_persistent(True)
496 assert presenter.get_flashtime_from_settings() == -1
497
498 presenter.set_flash_messages_are_persistent(False)
499 presenter.set_flash_message_duration(3000)
500 assert presenter.get_flashtime_from_settings() == 3000
501
502 def test_get_flash_message_duration(self, test_context: OrcaTestContext):
503 """Test getting flash message duration."""
504
505 self._setup_dependencies(test_context)
506 from orca.braille_presenter import get_presenter
507
508 presenter = get_presenter()
509
510 assert presenter.get_flash_message_duration() == 5000
511
512 def test_set_flash_message_duration(self, test_context: OrcaTestContext):
513 """Test setting flash message duration."""
514
515 self._setup_dependencies(test_context)
516 from orca.braille_presenter import get_presenter
517
518 presenter = get_presenter()
519
520 result = presenter.set_flash_message_duration(4000)
521 assert result is True
522 assert presenter.get_flash_message_duration() == 4000
523
524 def test_get_flash_messages_are_persistent(self, test_context: OrcaTestContext):
525 """Test getting flash messages persistent status."""
526
527 self._setup_dependencies(test_context)
528 from orca.braille_presenter import get_presenter
529
530 presenter = get_presenter()
531
532 assert presenter.get_flash_messages_are_persistent() is False
533
534 presenter.set_flash_messages_are_persistent(True)
535 assert presenter.get_flash_messages_are_persistent() is True
536
537 def test_set_flash_messages_are_persistent(self, test_context: OrcaTestContext):
538 """Test setting flash messages persistent status."""
539
540 self._setup_dependencies(test_context)
541 from orca.braille_presenter import get_presenter
542
543 presenter = get_presenter()
544
545 result = presenter.set_flash_messages_are_persistent(True)
546 assert result is True
547 assert presenter.get_flash_messages_are_persistent() is True
548
549 result = presenter.set_flash_messages_are_persistent(False)
550 assert result is True
551 assert presenter.get_flash_messages_are_persistent() is False
552
553 def test_get_flash_messages_are_detailed(self, test_context: OrcaTestContext):
554 """Test getting flash messages detailed status."""
555
556 self._setup_dependencies(test_context)
557 from orca.braille_presenter import get_presenter
558
559 presenter = get_presenter()
560
561 assert presenter.get_flash_messages_are_detailed() is True
562
563 presenter.set_flash_messages_are_detailed(False)
564 assert presenter.get_flash_messages_are_detailed() is False
565
566 def test_set_flash_messages_are_detailed(self, test_context: OrcaTestContext):
567 """Test setting flash messages detailed status."""
568
569 self._setup_dependencies(test_context)
570 from orca.braille_presenter import get_presenter
571
572 presenter = get_presenter()
573
574 result = presenter.set_flash_messages_are_detailed(True)
575 assert result is True
576 assert presenter.get_flash_messages_are_detailed() is True
577
578 result = presenter.set_flash_messages_are_detailed(False)
579 assert result is True
580 assert presenter.get_flash_messages_are_detailed() is False
581
582 def test_get_verbosity_is_detailed(self, test_context: OrcaTestContext):
583 """Test _get_verbosity_is_detailed returns correct boolean."""
584
585 self._setup_dependencies(test_context)
586 from orca.braille_presenter import get_presenter
587
588 presenter = get_presenter()
589
590 assert presenter._get_verbosity_is_detailed() is True
591
592 presenter.set_verbosity_level("brief")
593 assert presenter._get_verbosity_is_detailed() is False
594
595 def test_set_verbosity_is_detailed(self, test_context: OrcaTestContext):
596 """Test _set_verbosity_is_detailed sets verbosity level from boolean."""
597
598 self._setup_dependencies(test_context)
599 from orca.braille_presenter import get_presenter
600
601 presenter = get_presenter()
602
603 result = presenter._set_verbosity_is_detailed(True)
604 assert result is True
605 assert presenter.get_verbosity_level() == "verbose"
606
607 result = presenter._set_verbosity_is_detailed(False)
608 assert result is True
609 assert presenter.get_verbosity_level() == "brief"
610
611 def test_get_eol_enabled(self, test_context: OrcaTestContext):
612 """Test get_end_of_line_indicator_is_enabled returns default then setter value."""
613
614 self._setup_dependencies(test_context)
615 from orca.braille_presenter import get_presenter
616
617 presenter = get_presenter()
618
619 assert presenter.get_end_of_line_indicator_is_enabled() is True
620
621 presenter.set_end_of_line_indicator_is_enabled(False)
622 assert presenter.get_end_of_line_indicator_is_enabled() is False
623
624 def test_set_eol_enabled(self, test_context: OrcaTestContext):
625 """Test set_end_of_line_indicator_is_enabled sets end-of-line-indicator."""
626
627 self._setup_dependencies(test_context)
628 from orca.braille_presenter import get_presenter
629
630 presenter = get_presenter()
631
632 result = presenter.set_end_of_line_indicator_is_enabled(True)
633 assert result is True
634 assert presenter.get_end_of_line_indicator_is_enabled() is True
635
636 result = presenter.set_end_of_line_indicator_is_enabled(False)
637 assert result is True
638 assert presenter.get_end_of_line_indicator_is_enabled() is False
639
640 def test_get_use_abbreviated_rolenames(self, test_context: OrcaTestContext):
641 """Test _get_use_abbreviated_rolenames returns True when brief style."""
642
643 self._setup_dependencies(test_context)
644 from orca.braille_presenter import get_presenter
645
646 presenter = get_presenter()
647
648 assert presenter._get_use_abbreviated_rolenames() is False
649
650 presenter.set_rolename_style("brief")
651 assert presenter._get_use_abbreviated_rolenames() is True
652
653 def test_set_use_abbreviated_rolenames(self, test_context: OrcaTestContext):
654 """Test _set_use_abbreviated_rolenames sets rolename style from boolean."""
655
656 self._setup_dependencies(test_context)
657 from orca.braille_presenter import get_presenter
658
659 presenter = get_presenter()
660
661 result = presenter._set_use_abbreviated_rolenames(True)
662 assert result is True
663 assert presenter.get_rolename_style() == "brief"
664
665 result = presenter._set_use_abbreviated_rolenames(False)
666 assert result is True
667 assert presenter.get_rolename_style() == "verbose"
668
669 def test_get_flash_duration_seconds(self, test_context: OrcaTestContext):
670 """Test _get_flash_duration_seconds converts milliseconds to seconds."""
671
672 self._setup_dependencies(test_context)
673 from orca.braille_presenter import get_presenter
674
675 presenter = get_presenter()
676
677 assert presenter._get_flash_duration_seconds() == 5
678
679 presenter.set_flash_message_duration(2500)
680 assert presenter._get_flash_duration_seconds() == 2
681
682 presenter.set_flash_message_duration(1000)
683 assert presenter._get_flash_duration_seconds() == 1
684
685 def test_set_flash_duration_seconds(self, test_context: OrcaTestContext):
686 """Test _set_flash_duration_seconds converts seconds to milliseconds."""
687
688 self._setup_dependencies(test_context)
689 from orca.braille_presenter import get_presenter
690
691 presenter = get_presenter()
692
693 presenter._set_flash_duration_seconds(5)
694 assert presenter.get_flash_message_duration() == 5000
695
696 presenter._set_flash_duration_seconds(1)
697 assert presenter.get_flash_message_duration() == 1000
698
699 presenter._set_flash_duration_seconds(10)
700 assert presenter.get_flash_message_duration() == 10000
701
702 def test_get_present_mnemonics(self, test_context: OrcaTestContext):
703 """Test getting present mnemonics setting."""
704
705 self._setup_dependencies(test_context)
706 from orca.braille_presenter import get_presenter
707
708 presenter = get_presenter()
709
710 assert presenter.get_present_mnemonics() is True
711
712 presenter.set_present_mnemonics(False)
713 assert presenter.get_present_mnemonics() is False
714
715 def test_set_present_mnemonics(self, test_context: OrcaTestContext):
716 """Test setting present mnemonics."""
717
718 self._setup_dependencies(test_context)
719 from orca.braille_presenter import get_presenter
720
721 presenter = get_presenter()
722
723 result = presenter.set_present_mnemonics(True)
724 assert result is True
725 assert presenter.get_present_mnemonics() is True
726
727 result = presenter.set_present_mnemonics(False)
728 assert result is True
729 assert presenter.get_present_mnemonics() is False
730
731 def test_get_set_monitor_is_enabled(self, test_context: OrcaTestContext):
732 """Test getting and setting braille monitor enabled status."""
733
734 self._setup_dependencies(test_context)
735 from orca.braille_presenter import get_presenter
736
737 presenter = get_presenter()
738
739 result = presenter.set_monitor_is_enabled(True)
740 assert result is True
741 assert presenter.get_monitor_is_enabled() is True
742
743 result = presenter.set_monitor_is_enabled(False)
744 assert result is True
745 assert presenter.get_monitor_is_enabled() is False
746
747 def test_set_braille_monitor_disabled_destroys_monitor(self, test_context: OrcaTestContext):
748 """Test explicitly disabling braille monitor destroys the monitor widget."""
749
750 self._setup_dependencies(test_context)
751 from orca.braille_presenter import get_presenter
752
753 presenter = get_presenter()
754 mock_monitor = test_context.Mock()
755 presenter._monitor = mock_monitor
756
757 presenter.set_monitor_is_enabled(False)
758
759 mock_monitor.destroy.assert_called_once()
760 assert presenter._monitor is None
761
762 def test_init_braille_registers_monitor_callback(self, test_context: OrcaTestContext):
763 """Test init_braille registers the monitor callback with braille."""
764
765 essential_modules = self._setup_dependencies(test_context)
766 braille_mock = essential_modules["orca.braille"]
767 from orca.braille_presenter import get_presenter
768
769 presenter = get_presenter()
770
771 presenter.init_braille()
772
773 braille_mock.set_monitor_callback.assert_called_once_with(presenter.update_monitor)
774
775 def test_update_monitor_creates_when_enabled(self, test_context: OrcaTestContext):
776 """Test update_monitor creates monitor on demand when enabled."""
777
778 essential_modules = self._setup_dependencies(test_context)
779 braille_monitor_mock = essential_modules["orca.braille_monitor"]
780 from orca.braille_presenter import get_presenter
781
782 presenter = get_presenter()
783 presenter.set_monitor_is_enabled(True)
784 presenter.set_monitor_cell_count(40)
785 mock_monitor = test_context.Mock()
786 braille_monitor_mock.BrailleMonitor.return_value = mock_monitor
787
788 presenter.update_monitor(1, "hello", None, 40)
789
790 braille_monitor_mock.BrailleMonitor.assert_called_once_with(
791 40,
792 on_close=unittest.mock.ANY,
793 foreground=unittest.mock.ANY,
794 background=unittest.mock.ANY,
795 )
796 mock_monitor.show_all.assert_called_once()
797 mock_monitor.write_text.assert_called_once_with(1, "hello", None)
798
799 def test_update_monitor_uses_cell_count_setting(self, test_context: OrcaTestContext):
800 """Test update_monitor uses the configured cell count instead of display size."""
801
802 essential_modules = self._setup_dependencies(test_context)
803 braille_monitor_mock = essential_modules["orca.braille_monitor"]
804 from orca.braille_presenter import get_presenter
805
806 presenter = get_presenter()
807 presenter.set_monitor_is_enabled(True)
808 presenter.set_monitor_cell_count(20)
809 mock_monitor = test_context.Mock()
810 braille_monitor_mock.BrailleMonitor.return_value = mock_monitor
811
812 presenter.update_monitor(1, "hello", None, 40)
813
814 braille_monitor_mock.BrailleMonitor.assert_called_once_with(
815 20,
816 on_close=unittest.mock.ANY,
817 foreground=unittest.mock.ANY,
818 background=unittest.mock.ANY,
819 )
820
821 def test_update_monitor_skips_when_disabled(self, test_context: OrcaTestContext):
822 """Test update_monitor skips update when disabled without destroying."""
823
824 self._setup_dependencies(test_context)
825 from orca.braille_presenter import get_presenter
826
827 presenter = get_presenter()
828 presenter.set_monitor_is_enabled(False)
829 mock_monitor = test_context.Mock()
830 presenter._monitor = mock_monitor
831
832 presenter.update_monitor(1, "hello", None, 40)
833
834 mock_monitor.write_text.assert_not_called()
835 assert presenter._monitor is mock_monitor
836
837 def test_destroy_monitor(self, test_context: OrcaTestContext):
838 """Test destroy_monitor destroys existing monitor."""
839
840 self._setup_dependencies(test_context)
841 from orca.braille_presenter import get_presenter
842
843 presenter = get_presenter()
844 mock_monitor = test_context.Mock()
845 presenter._monitor = mock_monitor
846
847 presenter.destroy_monitor()
848
849 mock_monitor.destroy.assert_called_once()
850 assert presenter._monitor is None
851
852 def test_destroy_monitor_no_op_when_none(self, test_context: OrcaTestContext):
853 """Test destroy_monitor does nothing when no monitor exists."""
854
855 self._setup_dependencies(test_context)
856 from orca.braille_presenter import get_presenter
857
858 presenter = get_presenter()
859 assert presenter._monitor is None
860
861 presenter.destroy_monitor()
862
863 assert presenter._monitor is None
864
865 def test_shutdown_braille_does_not_destroy_monitor(self, test_context: OrcaTestContext):
866 """Test shutdown_braille does not destroy the monitor."""
867
868 essential_modules = self._setup_dependencies(test_context)
869 from orca.braille_presenter import get_presenter
870
871 presenter = get_presenter()
872 mock_monitor = test_context.Mock()
873 presenter._monitor = mock_monitor
874
875 presenter.shutdown_braille()
876
877 mock_monitor.destroy.assert_not_called()
878 assert presenter._monitor is mock_monitor
879 essential_modules["orca.braille"].shutdown.assert_called_once()
880
881 def test_set_braille_disabled_keeps_monitor(self, test_context: OrcaTestContext):
882 """Test disabling braille does not destroy the monitor."""
883
884 self._setup_dependencies(test_context)
885 from orca.braille_presenter import get_presenter
886
887 presenter = get_presenter()
888 mock_monitor = test_context.Mock()
889 presenter._monitor = mock_monitor
890
891 presenter.set_braille_is_enabled(False)
892
893 mock_monitor.destroy.assert_not_called()
894 assert presenter._monitor is mock_monitor
895
896
897 @pytest.mark.unit
898 class TestBraillePreferencesGridUI:
899 """Test Braille preferences grid UI creation."""
900
901 # pylint: disable-next=too-many-statements
902 def _setup_dependencies(self, test_context: OrcaTestContext) -> dict[str, MagicMock]:
903 """Set up mocks for braille_presenter GUI dependencies."""
904
905 additional_modules = ["orca.braille", "orca.braille_monitor", "orca.orca_platform"]
906 essential_modules = test_context.setup_shared_dependencies(additional_modules)
907
908 platform_mock = essential_modules["orca.orca_platform"]
909 platform_mock.tablesdir = "/usr/share/liblouis/tables"
910
911 from orca import gsettings_registry
912
913 registry = gsettings_registry.get_registry()
914 registry.clear_runtime_values()
915
916 test_context.patch(
917 "orca.braille_presenter.BraillePresenter._get_table_files",
918 return_value=[
919 "en-us-g1.ctb",
920 "en-us-g2.ctb",
921 ],
922 )
923
924 guilabels_mock = essential_modules["orca.guilabels"]
925 guilabels_mock.BRAILLE_ENABLE_BRAILLE_SUPPORT = "Braille support"
926 guilabels_mock.OBJECT_PRESENTATION_IS_DETAILED = "Detailed"
927 guilabels_mock.BRAILLE_SHOW_CONTEXT = "Show context"
928 guilabels_mock.BRAILLE_ABBREVIATED_ROLE_NAMES = "Abbreviated role names"
929 guilabels_mock.PRESENT_OBJECT_MNEMONICS = "Present mnemonics"
930 guilabels_mock.VERBOSITY = "Verbosity"
931 guilabels_mock.BRAILLE_ENABLE_CONTRACTED_BRAILLE = "Enable contracted braille"
932 guilabels_mock.BRAILLE_COMPUTER_BRAILLE_AT_CURSOR = "Expand word at cursor"
933 guilabels_mock.BRAILLE_ENABLE_END_OF_LINE_SYMBOL = "End of line symbol"
934 guilabels_mock.BRAILLE_ENABLE_WORD_WRAP = "Enable word wrap"
935 guilabels_mock.BRAILLE_CONTRACTION_TABLE = "Contraction table"
936 guilabels_mock.BRAILLE_HYPERLINK_INDICATOR = "Hyperlink indicator"
937 guilabels_mock.BRAILLE_DOT_NONE = "None"
938 guilabels_mock.BRAILLE_DOT_7 = "Dot 7"
939 guilabels_mock.BRAILLE_DOT_8 = "Dot 8"
940 guilabels_mock.BRAILLE_DOT_7_8 = "Dots 7 and 8"
941 guilabels_mock.BRAILLE_INDICATORS = "Indicators"
942 guilabels_mock.BRAILLE_SELECTION_INDICATOR = "Selection indicator"
943 guilabels_mock.BRAILLE_TEXT_ATTRIBUTES_INDICATOR = "Text attributes indicator"
944 guilabels_mock.BRAILLE_DISPLAY_SETTINGS = "Display Settings"
945 guilabels_mock.BRAILLE_MESSAGES_ARE_PERSISTENT = "Messages are persistent"
946 guilabels_mock.BRAILLE_ENABLE_FLASH_MESSAGES = "Enable flash messages"
947 guilabels_mock.BRAILLE_MESSAGES_ARE_DETAILED = "Messages are detailed"
948 guilabels_mock.BRAILLE_DURATION_SECS = "Duration (secs)"
949 guilabels_mock.BRAILLE_FLASH_MESSAGES = "Flash Messages"
950 guilabels_mock.GENERAL_BRAILLE_UPDATES = "Braille updates"
951 guilabels_mock.GENERAL_FREQUENCY_SECS = "Frequency (secs)"
952 guilabels_mock.GENERAL_APPLIES_TO = "Applies to"
953 guilabels_mock.PROGRESS_BAR_ALL = "All"
954 guilabels_mock.PROGRESS_BAR_APPLICATION = "Application"
955 guilabels_mock.PROGRESS_BAR_WINDOW = "Window"
956 guilabels_mock.PROGRESS_BARS = "Progress Bars"
957 guilabels_mock.BRAILLE = "Braille"
958 guilabels_mock.BRAILLE_MONITOR = "On-screen braille"
959 guilabels_mock.ON_SCREEN_DISPLAY = "On-Screen Display"
960 guilabels_mock.BRAILLE_MONITOR_CELL_COUNT = "Cell count"
961 guilabels_mock.BRAILLE_MONITOR_SHOW_DOTS = "Show braille dot patterns"
962 guilabels_mock.BRAILLE_MONITOR_FOREGROUND = "Text color"
963 guilabels_mock.BRAILLE_MONITOR_BACKGROUND = "Background color"
964 guilabels_mock.BRAILLE_MONITOR_INFO = "On-screen braille info"
965
966 return essential_modules
967
968 def test_braille_verbosity_grid_creates_widgets(self, test_context: OrcaTestContext) -> None:
969 """Test BrailleVerbosityPreferencesGrid creates correct widgets."""
970
971 from gi.repository import Gtk
972
973 self._setup_dependencies(test_context)
974 from orca.braille_presenter import (
975 BraillePresenter,
976 BrailleVerbosityPreferencesGrid,
977 )
978
979 presenter = BraillePresenter()
980 grid = BrailleVerbosityPreferencesGrid(presenter)
981
982 assert isinstance(grid, Gtk.Grid)
983 assert len(grid._widgets) == 4
984
985 def test_braille_display_settings_grid_creates_widgets(
986 self,
987 test_context: OrcaTestContext,
988 ) -> None:
989 """Test BrailleDisplaySettingsPreferencesGrid creates correct widgets."""
990
991 from gi.repository import Gtk
992
993 self._setup_dependencies(test_context)
994 from orca.braille_presenter import (
995 BrailleDisplaySettingsPreferencesGrid,
996 BraillePresenter,
997 )
998
999 presenter = BraillePresenter()
1000 grid = BrailleDisplaySettingsPreferencesGrid(presenter)
1001
1002 assert isinstance(grid, Gtk.Grid)
1003 assert len(grid._widgets) == 8
1004
1005 def test_braille_display_settings_grid_has_contracted_control(
1006 self,
1007 test_context: OrcaTestContext,
1008 ) -> None:
1009 """Test BrailleDisplaySettingsPreferencesGrid has contracted control."""
1010
1011 self._setup_dependencies(test_context)
1012 from orca.braille_presenter import (
1013 BrailleDisplaySettingsPreferencesGrid,
1014 BraillePresenter,
1015 )
1016
1017 presenter = BraillePresenter()
1018 grid = BrailleDisplaySettingsPreferencesGrid(presenter)
1019
1020 contracted_switch = grid.get_widget(2)
1021 assert contracted_switch is not None
1022
1023 computer_braille_at_cursor_switch = grid.get_widget(3)
1024 assert computer_braille_at_cursor_switch is not None
1025
1026 contraction_table_combo = grid.get_widget(4)
1027 assert contraction_table_combo is not None
1028
1029 def test_braille_flash_messages_grid_creates_widgets(
1030 self,
1031 test_context: OrcaTestContext,
1032 ) -> None:
1033 """Test BrailleFlashMessagesPreferencesGrid creates correct widgets."""
1034
1035 from gi.repository import Gtk
1036
1037 self._setup_dependencies(test_context)
1038 from orca.braille_presenter import (
1039 BrailleFlashMessagesPreferencesGrid,
1040 BraillePresenter,
1041 )
1042
1043 presenter = BraillePresenter()
1044 grid = BrailleFlashMessagesPreferencesGrid(presenter)
1045
1046 assert isinstance(grid, Gtk.Grid)
1047 assert len(grid._widgets) == 4
1048
1049 def test_braille_flash_messages_grid_has_persistent_control(
1050 self,
1051 test_context: OrcaTestContext,
1052 ) -> None:
1053 """Test BrailleFlashMessagesPreferencesGrid has persistent control."""
1054
1055 self._setup_dependencies(test_context)
1056 from orca.braille_presenter import (
1057 BrailleFlashMessagesPreferencesGrid,
1058 BraillePresenter,
1059 )
1060
1061 presenter = BraillePresenter()
1062 grid = BrailleFlashMessagesPreferencesGrid(presenter)
1063
1064 persistent_switch = grid.get_widget(2)
1065 assert persistent_switch is not None
1066
1067 duration_spinbutton = grid.get_widget(3)
1068 assert duration_spinbutton is not None
1069
1070 def test_braille_progress_bars_grid_creates_widgets(
1071 self,
1072 test_context: OrcaTestContext,
1073 ) -> None:
1074 """Test BrailleProgressBarsPreferencesGrid creates correct widgets."""
1075
1076 from gi.repository import Gtk
1077
1078 self._setup_dependencies(test_context)
1079 from orca.braille_presenter import (
1080 BraillePresenter,
1081 BrailleProgressBarsPreferencesGrid,
1082 )
1083
1084 presenter = BraillePresenter()
1085 grid = BrailleProgressBarsPreferencesGrid(presenter)
1086
1087 assert isinstance(grid, Gtk.Grid)
1088 assert len(grid._widgets) == 3
1089
1090 def test_braille_preferences_grid_creates_multi_page_stack(
1091 self,
1092 test_context: OrcaTestContext,
1093 ) -> None:
1094 """Test BraillePreferencesGrid creates multi-page stack."""
1095
1096 from gi.repository import Gtk
1097
1098 self._setup_dependencies(test_context)
1099 from orca.braille_presenter import BraillePreferencesGrid, BraillePresenter
1100
1101 presenter = BraillePresenter()
1102 grid = BraillePreferencesGrid(presenter)
1103
1104 assert isinstance(grid, Gtk.Grid)
1105 assert grid._verbosity_grid is not None
1106 assert grid._display_settings_grid is not None
1107 assert grid._flash_messages_grid is not None
1108 assert grid._progress_bars_grid is not None
1109
1110 def test_braille_preferences_grid_save_settings(self, test_context: OrcaTestContext) -> None:
1111 """Test BraillePreferencesGrid save_settings returns combined dict."""
1112
1113 self._setup_dependencies(test_context)
1114 from orca.braille_presenter import BraillePreferencesGrid, BraillePresenter
1115
1116 presenter = BraillePresenter()
1117 grid = BraillePreferencesGrid(presenter)
1118
1119 result = grid.save_settings()
1120
1121 assert isinstance(result, dict)
1122 assert "verbosity-level" in result
1123 assert "end-of-line-indicator" in result
1124 assert "flash-messages" in result
1125 assert "braille-progress-bar-updates" in result
1126
1127 def test_braille_preferences_grid_title_callback(self, test_context: OrcaTestContext) -> None:
1128 """Test BraillePreferencesGrid stores title change callback."""
1129
1130 self._setup_dependencies(test_context)
1131 from orca.braille_presenter import BraillePreferencesGrid, BraillePresenter
1132
1133 presenter = BraillePresenter()
1134 callback_calls: list[str] = []
1135
1136 def title_callback(title: str) -> None:
1137 callback_calls.append(title)
1138
1139 grid = BraillePreferencesGrid(presenter, title_change_callback=title_callback)
1140
1141 assert grid._title_change_callback is title_callback
1142
1143 def test_verbosity_grid_switch_reflects_initial_value(
1144 self,
1145 test_context: OrcaTestContext,
1146 ) -> None:
1147 """Test verbosity grid switch shows correct initial value."""
1148
1149 self._setup_dependencies(test_context)
1150
1151 from orca.braille_presenter import (
1152 BraillePresenter,
1153 BrailleVerbosityPreferencesGrid,
1154 )
1155
1156 presenter = BraillePresenter()
1157 presenter.set_verbosity_level("verbose")
1158 grid = BrailleVerbosityPreferencesGrid(presenter)
1159
1160 detailed_switch = grid.get_widget(0)
1161 assert detailed_switch is not None
1162 assert detailed_switch.get_active() is True
1163
1164 def test_verbosity_grid_switch_toggle_updates_setting(
1165 self,
1166 test_context: OrcaTestContext,
1167 ) -> None:
1168 """Test toggling verbosity switch updates the setting."""
1169
1170 self._setup_dependencies(test_context)
1171
1172 from orca.braille_presenter import (
1173 BraillePresenter,
1174 BrailleVerbosityPreferencesGrid,
1175 )
1176
1177 presenter = BraillePresenter()
1178 presenter.set_verbosity_level("brief")
1179 grid = BrailleVerbosityPreferencesGrid(presenter)
1180
1181 detailed_switch = grid.get_widget(0)
1182 assert detailed_switch is not None
1183 assert detailed_switch.get_active() is False
1184
1185 grid._initializing = False
1186 detailed_switch.set_active(True)
1187
1188 result = grid.save_settings()
1189 assert result["verbosity-level"] == "verbose"
1190
1191 def test_flash_messages_duration_initial_value(self, test_context: OrcaTestContext) -> None:
1192 """Test flash duration spinbutton shows correct initial value."""
1193
1194 self._setup_dependencies(test_context)
1195
1196 from orca.braille_presenter import (
1197 BrailleFlashMessagesPreferencesGrid,
1198 BraillePresenter,
1199 )
1200
1201 presenter = BraillePresenter()
1202 presenter.set_flash_message_duration(3000)
1203 grid = BrailleFlashMessagesPreferencesGrid(presenter)
1204
1205 duration_spinbutton = grid.get_widget(3)
1206 assert duration_spinbutton is not None
1207 assert duration_spinbutton.get_value() == 3
1208
1209 def test_display_settings_combobox_initial_value(self, test_context: OrcaTestContext) -> None:
1210 """Test indicator combobox shows correct initial selection."""
1211
1212 self._setup_dependencies(test_context)
1213
1214 from orca.braille_presenter import (
1215 BrailleDisplaySettingsPreferencesGrid,
1216 BraillePresenter,
1217 )
1218
1219 presenter = BraillePresenter()
1220 presenter.set_link_indicator("dot7")
1221 grid = BrailleDisplaySettingsPreferencesGrid(presenter)
1222
1223 link_combo = grid.get_widget(5)
1224 assert link_combo is not None
1225 assert link_combo.get_active() == 1