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
|
# Unit tests for chat_presenter.py methods.
#
# Copyright 2025 Igalia, S.L.
# Author: Joanmarie Diggs <jdiggs@igalia.com>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the
# Free Software Foundation, Inc., Franklin Street, Fifth Floor,
# Boston MA 02110-1301 USA.
# pylint: disable=wrong-import-position
# pylint: disable=import-outside-toplevel
# pylint: disable=protected-access
"""Unit tests for chat_presenter.py methods."""
from __future__ import annotations
from typing import TYPE_CHECKING
import gi
import pytest
gi.require_version("Atspi", "2.0")
from gi.repository import Atspi
if TYPE_CHECKING:
from unittest.mock import Mock
from .orca_test_context import OrcaTestContext
@pytest.mark.unit
class TestConversation:
"""Test Conversation class methods."""
def _setup_dependencies(self, test_context: OrcaTestContext) -> dict[str, Mock]:
"""Returns dependencies for chat module testing."""
essential_modules = test_context.setup_shared_dependencies(
[
"orca.ax_utilities",
"orca.ax_text",
"orca.input_event_manager",
"orca.braille_presenter",
"orca.presentation_manager",
],
)
debug_mock = essential_modules["orca.debug"]
debug_mock.print_message = test_context.Mock()
debug_mock.print_tokens = test_context.Mock()
return essential_modules
def test_init(self, test_context: OrcaTestContext) -> None:
"""Test Conversation.__init__."""
self._setup_dependencies(test_context)
from orca.chat_presenter import Conversation
mock_log = test_context.Mock(spec=Atspi.Accessible)
conversation = Conversation("TestRoom", mock_log)
assert conversation.get_name() == "TestRoom"
assert conversation._log == mock_log
assert not conversation.has_messages()
assert conversation.get_message_count() == 0
def test_get_name(self, test_context: OrcaTestContext) -> None:
"""Test Conversation.get_name returns the conversation name."""
self._setup_dependencies(test_context)
from orca.chat_presenter import Conversation
mock_log = test_context.Mock(spec=Atspi.Accessible)
conversation = Conversation("MyChannel", mock_log)
assert conversation.get_name() == "MyChannel"
def test_is_log(self, test_context: OrcaTestContext) -> None:
"""Test Conversation.is_log identifies the log object."""
self._setup_dependencies(test_context)
from orca.chat_presenter import Conversation
mock_log = test_context.Mock(spec=Atspi.Accessible)
other_obj = test_context.Mock(spec=Atspi.Accessible)
conversation = Conversation("TestRoom", mock_log)
assert conversation.is_log(mock_log) is True
assert conversation.is_log(other_obj) is False
def test_add_and_get_message(self, test_context: OrcaTestContext) -> None:
"""Test Conversation.add_message and get_message."""
self._setup_dependencies(test_context)
from orca.chat_presenter import Conversation
mock_log = test_context.Mock(spec=Atspi.Accessible)
conversation = Conversation("TestRoom", mock_log)
conversation.add_message("Hello")
conversation.add_message("World")
assert conversation.get_message(-1) == "World"
assert conversation.get_message(-2) == "Hello"
def test_has_messages_and_count(self, test_context: OrcaTestContext) -> None:
"""Test Conversation.has_messages and get_message_count."""
self._setup_dependencies(test_context)
from orca.chat_presenter import Conversation
mock_log = test_context.Mock(spec=Atspi.Accessible)
conversation = Conversation("TestRoom", mock_log)
assert not conversation.has_messages()
assert conversation.get_message_count() == 0
conversation.add_message("Message 1")
assert conversation.has_messages()
assert conversation.get_message_count() == 1
conversation.add_message("Message 2")
assert conversation.get_message_count() == 2
def test_message_history_limit(self, test_context: OrcaTestContext) -> None:
"""Test that Conversation respects HISTORY_SIZE limit."""
self._setup_dependencies(test_context)
from orca.chat_presenter import Conversation
mock_log = test_context.Mock(spec=Atspi.Accessible)
conversation = Conversation("TestRoom", mock_log)
# Add more messages than HISTORY_SIZE
for i in range(Conversation.HISTORY_SIZE + 3):
conversation.add_message(f"Message {i}")
assert conversation.get_message_count() == Conversation.HISTORY_SIZE
# Oldest messages should have been dropped
assert conversation.get_message(-1) == f"Message {Conversation.HISTORY_SIZE + 2}"
def test_typing_status(self, test_context: OrcaTestContext) -> None:
"""Test Conversation typing status methods."""
self._setup_dependencies(test_context)
from orca.chat_presenter import Conversation
mock_log = test_context.Mock(spec=Atspi.Accessible)
conversation = Conversation("TestRoom", mock_log)
assert conversation.get_typing_status() == ""
conversation.set_typing_status("User is typing...")
assert conversation.get_typing_status() == "User is typing..."
def test_get_message_invalid_index(self, test_context: OrcaTestContext) -> None:
"""Test Conversation.get_message raises IndexError for invalid index."""
self._setup_dependencies(test_context)
from orca.chat_presenter import Conversation
mock_log = test_context.Mock(spec=Atspi.Accessible)
conversation = Conversation("TestRoom", mock_log)
# Empty conversation should raise IndexError
with pytest.raises(IndexError):
conversation.get_message(-1)
# Add one message
conversation.add_message("Hello")
# Valid indices work
assert conversation.get_message(-1) == "Hello"
# Out of bounds still raises
with pytest.raises(IndexError):
conversation.get_message(-2)
@pytest.mark.unit
class TestConversationList:
"""Test ConversationList class methods."""
def _setup_dependencies(self, test_context: OrcaTestContext) -> dict[str, Mock]:
"""Returns dependencies for chat module testing."""
essential_modules = test_context.setup_shared_dependencies(
[
"orca.ax_utilities",
"orca.ax_text",
"orca.input_event_manager",
"orca.braille_presenter",
"orca.presentation_manager",
],
)
return essential_modules
def test_init(self, test_context: OrcaTestContext) -> None:
"""Test ConversationList.__init__."""
self._setup_dependencies(test_context)
from orca.chat_presenter import ConversationList
conv_list = ConversationList()
assert not conv_list.has_messages()
assert conv_list.get_message_count() == 0
def test_add_message_without_conversation(self, test_context: OrcaTestContext) -> None:
"""Test ConversationList.add_message with no conversation."""
self._setup_dependencies(test_context)
from orca.chat_presenter import ConversationList
conv_list = ConversationList()
conv_list.add_message("Hello", None)
assert conv_list.has_messages()
assert conv_list.get_message_count() == 1
message, name, log = conv_list.get_message_and_name(-1)
assert message == "Hello"
assert name == ""
assert log is None
def test_add_message_with_conversation(self, test_context: OrcaTestContext) -> None:
"""Test ConversationList.add_message with a conversation."""
self._setup_dependencies(test_context)
from orca.chat_presenter import Conversation, ConversationList
mock_log = test_context.Mock(spec=Atspi.Accessible)
conversation = Conversation("TestRoom", mock_log)
conv_list = ConversationList()
conv_list.add_message("Hello from room", conversation)
message, name, log = conv_list.get_message_and_name(-1)
assert message == "Hello from room"
assert name == "TestRoom"
assert log is mock_log
def test_iteration(self, test_context: OrcaTestContext) -> None:
"""Test ConversationList iteration."""
self._setup_dependencies(test_context)
from orca.chat_presenter import Conversation, ConversationList
mock_log1 = test_context.Mock(spec=Atspi.Accessible)
mock_log2 = test_context.Mock(spec=Atspi.Accessible)
conv1 = Conversation("Room1", mock_log1)
conv2 = Conversation("Room2", mock_log2)
conv_list = ConversationList()
conv_list.add_message("Msg1", conv1)
conv_list.add_message("Msg2", conv2)
conversations = list(conv_list)
assert len(conversations) == 2
assert conv1 in conversations
assert conv2 in conversations
def test_iteration_empty(self, test_context: OrcaTestContext) -> None:
"""Test ConversationList iteration when empty."""
self._setup_dependencies(test_context)
from orca.chat_presenter import ConversationList
conv_list = ConversationList()
conversations = list(conv_list)
assert len(conversations) == 0
def test_message_history_limit(self, test_context: OrcaTestContext) -> None:
"""Test that ConversationList respects HISTORY_SIZE limit."""
self._setup_dependencies(test_context)
from orca.chat_presenter import Conversation, ConversationList
conv_list = ConversationList()
# Add more messages than HISTORY_SIZE
for i in range(Conversation.HISTORY_SIZE + 3):
conv_list.add_message(f"Message {i}", None)
assert conv_list.get_message_count() == Conversation.HISTORY_SIZE
def test_get_message_and_name_invalid_index(self, test_context: OrcaTestContext) -> None:
"""Test ConversationList.get_message_and_name raises IndexError for invalid index."""
self._setup_dependencies(test_context)
from orca.chat_presenter import ConversationList
conv_list = ConversationList()
# Empty list should raise IndexError
with pytest.raises(IndexError):
conv_list.get_message_and_name(-1)
# Add one message
conv_list.add_message("Hello", None)
# Valid index works
message, _, _ = conv_list.get_message_and_name(-1)
assert message == "Hello"
# Out of bounds still raises
with pytest.raises(IndexError):
conv_list.get_message_and_name(-2)
@pytest.mark.unit
class TestChat:
"""Test Chat class methods."""
def _setup_dependencies(self, test_context: OrcaTestContext) -> dict[str, Mock]:
"""Returns dependencies for Chat class testing."""
essential_modules = test_context.setup_shared_dependencies(
[
"orca.ax_utilities",
"orca.ax_text",
"orca.input_event_manager",
"orca.braille_presenter",
"orca.presentation_manager",
],
)
debug_mock = essential_modules["orca.debug"]
debug_mock.print_message = test_context.Mock()
debug_mock.print_tokens = test_context.Mock()
cmdnames_mock = essential_modules["orca.cmdnames"]
cmdnames_mock.CHAT_TOGGLE_ROOM_NAME_PREFIX = "Toggle room name prefix"
cmdnames_mock.CHAT_TOGGLE_BUDDY_TYPING = "Toggle buddy typing"
cmdnames_mock.CHAT_TOGGLE_MESSAGE_HISTORIES = "Toggle message histories"
cmdnames_mock.CHAT_PREVIOUS_MESSAGE = "Previous message"
cmdnames_mock.CHAT_NEXT_MESSAGE = "Next message"
messages_mock = essential_modules["orca.messages"]
messages_mock.CHAT_NO_MESSAGES = "No chat messages"
messages_mock.CHAT_LIST_TOP = "Top"
messages_mock.CHAT_LIST_BOTTOM = "Bottom"
messages_mock.CHAT_ROOM_NAME_PREFIX_ON = "Room name prefix on"
messages_mock.CHAT_ROOM_NAME_PREFIX_OFF = "Room name prefix off"
messages_mock.CHAT_BUDDY_TYPING_ON = "Buddy typing on"
messages_mock.CHAT_BUDDY_TYPING_OFF = "Buddy typing off"
messages_mock.CHAT_SEPARATE_HISTORIES_ON = "Separate histories on"
messages_mock.CHAT_SEPARATE_HISTORIES_OFF = "Separate histories off"
input_event_mock = essential_modules["orca.input_event"]
input_event_handler_mock = test_context.Mock()
input_event_mock.InputEventHandler = test_context.Mock(
return_value=input_event_handler_mock,
)
keybindings_mock = essential_modules["orca.keybindings"]
keybindings_mock.NO_MODIFIER_MASK = 0
keybindings_mock.ORCA_MODIFIER_MASK = 4
from orca import gsettings_registry
registry = gsettings_registry.get_registry()
registry.clear_runtime_values()
return essential_modules
def test_init(self, test_context: OrcaTestContext) -> None:
"""Test Chat.__init__."""
self._setup_dependencies(test_context)
from orca.chat_presenter import Chat
mock_script = test_context.Mock()
chat = Chat(mock_script)
assert chat._script == mock_script
def test_get_conversation_for_object_name_mismatch(self, test_context: OrcaTestContext) -> None:
"""Test get_conversation_for_object when name doesn't match log's room."""
self._setup_dependencies(test_context)
from orca.chat_presenter import Chat, Conversation
mock_script = test_context.Mock()
chat = Chat(mock_script)
mock_log1 = test_context.Mock(spec=Atspi.Accessible)
conversation1 = Conversation("Room1", mock_log1)
chat._conversation_list.add_message("Hello", conversation1)
test_context.patch_object(chat, "get_chat_room_name", return_value="Room2")
result = chat.get_conversation_for_object(mock_log1)
assert result is None
@pytest.mark.unit
class TestChatPresenter:
"""Test ChatPresenter class methods."""
def _setup_dependencies(self, test_context: OrcaTestContext) -> dict[str, Mock]:
"""Returns dependencies for ChatPresenter class testing."""
essential_modules = test_context.setup_shared_dependencies(
[
"orca.ax_utilities",
"orca.ax_text",
"orca.input_event_manager",
"orca.braille_presenter",
"orca.presentation_manager",
],
)
debug_mock = essential_modules["orca.debug"]
debug_mock.print_message = test_context.Mock()
debug_mock.print_tokens = test_context.Mock()
cmdnames_mock = essential_modules["orca.cmdnames"]
cmdnames_mock.CHAT_TOGGLE_ROOM_NAME_PREFIX = "Toggle room name prefix"
cmdnames_mock.CHAT_TOGGLE_BUDDY_TYPING = "Toggle buddy typing"
cmdnames_mock.CHAT_TOGGLE_MESSAGE_HISTORIES = "Toggle message histories"
cmdnames_mock.CHAT_PREVIOUS_MESSAGE = "Previous message"
cmdnames_mock.CHAT_NEXT_MESSAGE = "Next message"
messages_mock = essential_modules["orca.messages"]
messages_mock.CHAT_ROOM_NAME_PREFIX_ON = "Room name prefix on"
messages_mock.CHAT_ROOM_NAME_PREFIX_OFF = "Room name prefix off"
messages_mock.CHAT_BUDDY_TYPING_ON = "Buddy typing on"
messages_mock.CHAT_BUDDY_TYPING_OFF = "Buddy typing off"
messages_mock.CHAT_SEPARATE_HISTORIES_ON = "Separate histories on"
messages_mock.CHAT_SEPARATE_HISTORIES_OFF = "Separate histories off"
messages_mock.CHAT_NO_MESSAGES = "No messages"
messages_mock.CHAT_LIST_TOP = "Top of chat"
messages_mock.CHAT_LIST_BOTTOM = "Bottom of chat"
messages_mock.CHAT_MESSAGE_FROM_ROOM = "Message from %s"
input_event_mock = essential_modules["orca.input_event"]
input_event_handler_mock = test_context.Mock()
input_event_mock.InputEventHandler = test_context.Mock(
return_value=input_event_handler_mock,
)
keybindings_mock = essential_modules["orca.keybindings"]
keybindings_mock.NO_MODIFIER_MASK = 0
keybindings_mock.ORCA_MODIFIER_MASK = 4
keybindings_mock.DEFAULT_MODIFIER_MASK = 8
from orca import gsettings_registry
registry = gsettings_registry.get_registry()
registry.clear_runtime_values()
return essential_modules
def test_get_handlers(self, test_context: OrcaTestContext) -> None:
"""Test ChatPresenter registers commands with CommandManager."""
self._setup_dependencies(test_context)
from orca import command_manager
from orca.chat_presenter import get_presenter
presenter = get_presenter()
presenter.set_up_commands()
cmd_manager = command_manager.get_manager()
assert cmd_manager.get_keyboard_command("chat_previous_message") is not None
assert cmd_manager.get_keyboard_command("chat_next_message") is not None
assert cmd_manager.get_keyboard_command("chat_toggle_room_name_prefix") is not None
assert cmd_manager.get_keyboard_command("chat_toggle_buddy_typing") is not None
assert cmd_manager.get_keyboard_command("chat_toggle_message_histories") is not None
def test_toggle_prefix_on_to_off(self, test_context: OrcaTestContext) -> None:
"""Test toggle_prefix from on to off."""
essential_modules = self._setup_dependencies(test_context)
from orca.chat_presenter import get_presenter
mock_script = test_context.Mock()
presenter = get_presenter()
presenter.set_speak_room_name(True)
pres_manager = essential_modules["orca.presentation_manager"].get_manager()
pres_manager.present_message.reset_mock()
result = presenter.toggle_prefix(mock_script, None)
assert result is True
assert presenter.get_speak_room_name() is False
pres_manager.present_message.assert_called_with(
essential_modules["orca.messages"].CHAT_ROOM_NAME_PREFIX_OFF,
)
def test_toggle_prefix_off_to_on(self, test_context: OrcaTestContext) -> None:
"""Test toggle_prefix from off to on."""
essential_modules = self._setup_dependencies(test_context)
from orca.chat_presenter import get_presenter
mock_script = test_context.Mock()
presenter = get_presenter()
pres_manager = essential_modules["orca.presentation_manager"].get_manager()
pres_manager.present_message.reset_mock()
result = presenter.toggle_prefix(mock_script, None)
assert result is True
assert presenter.get_speak_room_name() is True
pres_manager.present_message.assert_called_with(
essential_modules["orca.messages"].CHAT_ROOM_NAME_PREFIX_ON,
)
def test_toggle_buddy_typing_on_to_off(self, test_context: OrcaTestContext) -> None:
"""Test toggle_buddy_typing from on to off."""
essential_modules = self._setup_dependencies(test_context)
from orca.chat_presenter import get_presenter
mock_script = test_context.Mock()
presenter = get_presenter()
presenter.set_announce_buddy_typing(True)
pres_manager = essential_modules["orca.presentation_manager"].get_manager()
pres_manager.present_message.reset_mock()
result = presenter.toggle_buddy_typing(mock_script, None)
assert result is True
assert presenter.get_announce_buddy_typing() is False
pres_manager.present_message.assert_called_with(
essential_modules["orca.messages"].CHAT_BUDDY_TYPING_OFF,
)
def test_toggle_buddy_typing_off_to_on(self, test_context: OrcaTestContext) -> None:
"""Test toggle_buddy_typing from off to on."""
essential_modules = self._setup_dependencies(test_context)
from orca.chat_presenter import get_presenter
mock_script = test_context.Mock()
presenter = get_presenter()
pres_manager = essential_modules["orca.presentation_manager"].get_manager()
pres_manager.present_message.reset_mock()
result = presenter.toggle_buddy_typing(mock_script, None)
assert result is True
assert presenter.get_announce_buddy_typing() is True
pres_manager.present_message.assert_called_with(
essential_modules["orca.messages"].CHAT_BUDDY_TYPING_ON,
)
def test_toggle_message_histories_on_to_off(self, test_context: OrcaTestContext) -> None:
"""Test toggle_message_histories from on to off."""
essential_modules = self._setup_dependencies(test_context)
from orca.chat_presenter import get_presenter
mock_script = test_context.Mock()
presenter = get_presenter()
presenter.set_room_histories(True)
pres_manager = essential_modules["orca.presentation_manager"].get_manager()
pres_manager.present_message.reset_mock()
result = presenter.toggle_message_histories(mock_script, None)
assert result is True
assert presenter.get_room_histories() is False
pres_manager.present_message.assert_called_with(
essential_modules["orca.messages"].CHAT_SEPARATE_HISTORIES_OFF,
)
def test_toggle_message_histories_off_to_on(self, test_context: OrcaTestContext) -> None:
"""Test toggle_message_histories from off to on."""
essential_modules = self._setup_dependencies(test_context)
from orca.chat_presenter import get_presenter
mock_script = test_context.Mock()
presenter = get_presenter()
pres_manager = essential_modules["orca.presentation_manager"].get_manager()
pres_manager.present_message.reset_mock()
result = presenter.toggle_message_histories(mock_script, None)
assert result is True
assert presenter.get_room_histories() is True
pres_manager.present_message.assert_called_with(
essential_modules["orca.messages"].CHAT_SEPARATE_HISTORIES_ON,
)
def _setup_navigation_mocks(
self,
test_context: OrcaTestContext,
essential_modules: dict[str, Mock],
) -> Mock:
"""Setup additional mocks needed for navigation tests. Returns mock_script."""
script_manager_mock = essential_modules["orca.script_manager"]
script_manager_instance = script_manager_mock.get_manager.return_value
script_manager_instance.get_active_script = test_context.Mock(return_value=None)
mock_script = test_context.Mock()
speech_gen = test_context.Mock()
speech_gen.voice = test_context.Mock(return_value=None)
mock_script.get_speech_generator = test_context.Mock(return_value=speech_gen)
mock_script.speak_message = test_context.Mock()
mock_script.display_message = test_context.Mock()
mock_script.app = test_context.Mock()
return mock_script
def test_present_previous_no_messages(self, test_context: OrcaTestContext) -> None:
"""Test present_previous_message with no messages."""
essential_modules = self._setup_dependencies(test_context)
from orca.chat_presenter import Chat, get_presenter
mock_script = test_context.Mock()
chat = Chat(mock_script)
mock_script.chat = chat
presenter = get_presenter()
pres_manager = essential_modules["orca.presentation_manager"].get_manager()
pres_manager.present_message.reset_mock()
result = presenter.present_previous_message(mock_script, None)
assert result is True
pres_manager.present_message.assert_called_with(
essential_modules["orca.messages"].CHAT_NO_MESSAGES,
)
def test_present_next_no_messages(self, test_context: OrcaTestContext) -> None:
"""Test present_next_message with no messages."""
essential_modules = self._setup_dependencies(test_context)
from orca.chat_presenter import Chat, get_presenter
mock_script = test_context.Mock()
chat = Chat(mock_script)
mock_script.chat = chat
presenter = get_presenter()
pres_manager = essential_modules["orca.presentation_manager"].get_manager()
pres_manager.present_message.reset_mock()
result = presenter.present_next_message(mock_script, None)
assert result is True
pres_manager.present_message.assert_called_with(
essential_modules["orca.messages"].CHAT_NO_MESSAGES,
)
def test_navigation_with_messages(self, test_context: OrcaTestContext) -> None:
"""Test navigation through message history."""
essential_modules = self._setup_dependencies(test_context)
from orca.chat_presenter import Chat, Conversation, get_presenter
mock_script = self._setup_navigation_mocks(test_context, essential_modules)
chat = Chat(mock_script)
mock_script.chat = chat
mock_log = test_context.Mock(spec=Atspi.Accessible)
conversation = Conversation("TestRoom", mock_log)
chat._conversation_list.add_message("Message 1", conversation)
chat._conversation_list.add_message("Message 2", conversation)
chat._conversation_list.add_message("Message 3", conversation)
presenter = get_presenter()
presenter.present_previous_message(mock_script, None)
assert chat._current_index == -1
presenter.present_previous_message(mock_script, None)
assert chat._current_index == -2
presenter.present_next_message(mock_script, None)
assert chat._current_index == -1
def test_navigation_top_boundary(self, test_context: OrcaTestContext) -> None:
"""Test navigation stops at top boundary."""
essential_modules = self._setup_dependencies(test_context)
from orca.chat_presenter import Chat, Conversation, get_presenter
mock_script = self._setup_navigation_mocks(test_context, essential_modules)
chat = Chat(mock_script)
mock_script.chat = chat
mock_log = test_context.Mock(spec=Atspi.Accessible)
conversation = Conversation("TestRoom", mock_log)
chat._conversation_list.add_message("Message 1", conversation)
chat._conversation_list.add_message("Message 2", conversation)
presenter = get_presenter()
pres_manager = essential_modules["orca.presentation_manager"].get_manager()
presenter.present_previous_message(mock_script, None)
presenter.present_previous_message(mock_script, None)
pres_manager.present_message.reset_mock()
presenter.present_previous_message(mock_script, None)
pres_manager.present_message.assert_called_with(
essential_modules["orca.messages"].CHAT_LIST_TOP,
)
def test_navigation_bottom_boundary(self, test_context: OrcaTestContext) -> None:
"""Test navigation stops at bottom boundary."""
essential_modules = self._setup_dependencies(test_context)
from orca.chat_presenter import Chat, Conversation, get_presenter
mock_script = self._setup_navigation_mocks(test_context, essential_modules)
chat = Chat(mock_script)
mock_script.chat = chat
mock_log = test_context.Mock(spec=Atspi.Accessible)
conversation = Conversation("TestRoom", mock_log)
chat._conversation_list.add_message("Message 1", conversation)
chat._conversation_list.add_message("Message 2", conversation)
presenter = get_presenter()
pres_manager = essential_modules["orca.presentation_manager"].get_manager()
presenter.present_previous_message(mock_script, None)
pres_manager.present_message.reset_mock()
presenter.present_next_message(mock_script, None)
pres_manager.present_message.assert_called_with(
essential_modules["orca.messages"].CHAT_LIST_BOTTOM,
)
def _setup_verbosity_test(
self,
test_context: OrcaTestContext,
verbosity: int,
) -> tuple[dict[str, Mock], Mock]:
"""Sets up mocks for utter_message verbosity tests. Returns (modules, script)."""
essential_modules = self._setup_dependencies(test_context)
mock_script = self._setup_navigation_mocks(test_context, essential_modules)
nick_map = {0: "all", 1: "all-if-focused", 2: "focused-channel", 3: "active-channel"}
from orca import gsettings_registry
gsettings_registry.get_registry().set_runtime_value(
"chat",
"message-verbosity",
nick_map[verbosity],
)
return essential_modules, mock_script
def test_utter_message_all_speaks_regardless(self, test_context: OrcaTestContext) -> None:
"""Test that ALL verbosity speaks regardless of focus or active channel."""
essential_modules, mock_script = self._setup_verbosity_test(test_context, 0)
from orca.chat_presenter import get_presenter
presenter = get_presenter()
pres_manager = essential_modules["orca.presentation_manager"].get_manager()
pres_manager.speak_accessible_text.reset_mock()
mock_obj = test_context.Mock()
presenter.utter_message(
mock_script,
mock_obj,
"Room",
"Hello",
focused=False,
active_channel=False,
)
pres_manager.speak_accessible_text.assert_called_once()
def test_utter_message_active_channel_speaks_when_active(
self,
test_context: OrcaTestContext,
) -> None:
"""Test that ACTIVE_CHANNEL verbosity speaks when active_channel=True."""
essential_modules, mock_script = self._setup_verbosity_test(test_context, 3)
from orca.chat_presenter import get_presenter
presenter = get_presenter()
pres_manager = essential_modules["orca.presentation_manager"].get_manager()
pres_manager.speak_accessible_text.reset_mock()
mock_obj = test_context.Mock()
presenter.utter_message(
mock_script,
mock_obj,
"Room",
"Hello",
focused=False,
active_channel=True,
)
pres_manager.speak_accessible_text.assert_called_once()
def test_utter_message_active_channel_silent_when_inactive(
self,
test_context: OrcaTestContext,
) -> None:
"""Test that ACTIVE_CHANNEL verbosity is silent when active_channel=False."""
essential_modules, mock_script = self._setup_verbosity_test(test_context, 3)
from orca.chat_presenter import get_presenter
presenter = get_presenter()
pres_manager = essential_modules["orca.presentation_manager"].get_manager()
pres_manager.speak_accessible_text.reset_mock()
mock_obj = test_context.Mock()
presenter.utter_message(
mock_script,
mock_obj,
"Room",
"Hello",
focused=False,
active_channel=False,
)
pres_manager.speak_accessible_text.assert_not_called()
def test_utter_message_focused_channel_silent_when_unfocused(
self,
test_context: OrcaTestContext,
) -> None:
"""Test that FOCUSED_CHANNEL is silent when unfocused even if active_channel=True."""
essential_modules, mock_script = self._setup_verbosity_test(test_context, 2)
from orca.chat_presenter import get_presenter
presenter = get_presenter()
pres_manager = essential_modules["orca.presentation_manager"].get_manager()
pres_manager.speak_accessible_text.reset_mock()
mock_obj = test_context.Mock()
presenter.utter_message(
mock_script,
mock_obj,
"Room",
"Hello",
focused=False,
active_channel=True,
)
pres_manager.speak_accessible_text.assert_not_called()
def test_utter_message_focused_channel_speaks_when_focused(
self,
test_context: OrcaTestContext,
) -> None:
"""Test that FOCUSED_CHANNEL speaks when focused=True."""
essential_modules, mock_script = self._setup_verbosity_test(test_context, 2)
from orca.chat_presenter import get_presenter
presenter = get_presenter()
pres_manager = essential_modules["orca.presentation_manager"].get_manager()
pres_manager.speak_accessible_text.reset_mock()
mock_obj = test_context.Mock()
presenter.utter_message(
mock_script,
mock_obj,
"",
"Hello",
focused=True,
active_channel=True,
)
pres_manager.speak_accessible_text.assert_called_once()
|