soubarnak
ea7be5f111
The fork takes its own name everywhere a user can see it: binaries (voculinux, voculinux-gui), desktop entry, autostart, tray, D-Bus namespace (com.voculinux.Voculinux, no alias for the old name), config/data/cache dirs, single-instance lock, IBus engine identity, tray icons, resource prefixes, VOCULINUX_* environment names, and the update-checker user agent. The internal Python module stays vocalinux and the distribution metadata keeps the upstream URLs as provenance. On first run a previous Vocalinux install's config.json, custom dictionary, and portal restore token are copied once into the new locations (new config always wins, no merge, no write-back); models re-resolve through the pinned-checksum download path. An offline naming-sweep test proves no old-name strings remain on user-visible surfaces outside the allowlist. Refs #18
832 lines
33 KiB
Python
832 lines
33 KiB
Python
"""Tests for Settings → Test Dictation start failure vs real no-speech."""
|
|
|
|
import importlib
|
|
import sys
|
|
import threading
|
|
from typing import Any, Optional
|
|
from unittest.mock import MagicMock, Mock, patch
|
|
|
|
from vocalinux.common_types import RecognitionState
|
|
|
|
|
|
def _load_settings_dialog() -> Any:
|
|
"""Import settings_dialog with real bases so unbound methods stay callable.
|
|
|
|
conftest swaps gi for a MagicMock, which leaves every ``class X(Gtk.Y)`` as
|
|
a mock. Handing the three bases a real class keeps the methods intact.
|
|
|
|
Restore both sys.modules and the vocalinux.ui.settings_dialog attribute.
|
|
Python 3.9/3.10 mock follows the package attribute, so leaving a private
|
|
copy there makes later tests patch a different module than they imported.
|
|
"""
|
|
import vocalinux.ui as ui_pkg
|
|
|
|
repository = sys.modules["gi.repository"]
|
|
bases = {name: type(name, (), {}) for name in ("Box", "ListBoxRow", "Dialog")}
|
|
saved = sys.modules.pop("vocalinux.ui.settings_dialog", None)
|
|
try:
|
|
with patch.object(repository, "Gtk", MagicMock(**bases)):
|
|
module = importlib.import_module("vocalinux.ui.settings_dialog")
|
|
finally:
|
|
sys.modules.pop("vocalinux.ui.settings_dialog", None)
|
|
if saved is not None:
|
|
sys.modules["vocalinux.ui.settings_dialog"] = saved
|
|
ui_pkg.settings_dialog = saved
|
|
else:
|
|
ui_pkg.__dict__.pop("settings_dialog", None)
|
|
return module
|
|
|
|
|
|
settings_dialog = _load_settings_dialog()
|
|
SettingsDialog = settings_dialog.SettingsDialog
|
|
|
|
|
|
def _text_buffer() -> Mock:
|
|
"""Minimal stand-in for Gtk.TextBuffer used by the test output pane."""
|
|
buf = Mock()
|
|
buf._text = ""
|
|
|
|
def set_text(text: str) -> None:
|
|
buf._text = text
|
|
|
|
def get_text(*_args: Any, **_kwargs: Any) -> str:
|
|
return buf._text
|
|
|
|
def insert(_iter: Any, text: str) -> None:
|
|
buf._text += text
|
|
|
|
buf.set_text.side_effect = set_text
|
|
buf.get_text.side_effect = get_text
|
|
buf.insert.side_effect = insert
|
|
buf.get_start_iter.return_value = Mock()
|
|
buf.get_end_iter.return_value = Mock()
|
|
buf.get_insert.return_value = Mock()
|
|
return buf
|
|
|
|
|
|
def _dialog_for_test(
|
|
*, start_return: bool, model_ready: bool = True, is_auto_paused: bool = False
|
|
) -> Mock:
|
|
dialog = Mock()
|
|
dialog._test_active = False
|
|
dialog._test_token = 0
|
|
dialog._test_cancelled = False
|
|
dialog._applying_settings = False
|
|
dialog.test_button = Mock()
|
|
dialog.test_cancel_button = Mock()
|
|
dialog.test_output_revealer = Mock()
|
|
dialog.test_buffer = _text_buffer()
|
|
dialog.test_textview = Mock()
|
|
dialog.config_manager = Mock()
|
|
dialog.config_manager.get_settings.return_value = {
|
|
"speech_recognition": {
|
|
"engine": "whisper_cpp",
|
|
"model_size": "tiny",
|
|
"silence_timeout": 2.0,
|
|
"vad_sensitivity": 3,
|
|
}
|
|
}
|
|
dialog.get_selected_settings = Mock(
|
|
return_value={
|
|
"engine": "whisper_cpp",
|
|
"model_size": "tiny",
|
|
"silence_timeout": 2.0,
|
|
"vad_sensitivity": 3,
|
|
}
|
|
)
|
|
dialog.apply_settings = Mock(return_value=True)
|
|
dialog.connect_to_recognition_manager = Mock()
|
|
dialog.update_recognition_progress = Mock()
|
|
dialog._test_text_callback = Mock()
|
|
dialog._stop_test_after_delay = SettingsDialog._stop_test_after_delay.__get__(dialog)
|
|
|
|
engine = Mock()
|
|
engine.state = RecognitionState.IDLE
|
|
engine.engine = "whisper_cpp"
|
|
engine.model_size = "tiny"
|
|
engine.start_recognition = Mock(return_value=start_return)
|
|
engine.stop_recognition = Mock()
|
|
engine.get_text_callbacks = Mock(return_value=[])
|
|
engine.set_text_callbacks = Mock()
|
|
engine.model_ready = model_ready
|
|
engine.is_auto_paused = is_auto_paused
|
|
dialog.speech_engine = engine
|
|
return dialog
|
|
|
|
|
|
def test_test_dictation_missing_model_skips_listen_timer() -> None:
|
|
dialog = _dialog_for_test(start_return=False, model_ready=False)
|
|
|
|
with patch.object(settings_dialog.threading, "Thread") as thread_cls:
|
|
SettingsDialog._on_test_clicked(dialog, None)
|
|
|
|
thread_cls.assert_not_called()
|
|
assert dialog._test_active is False
|
|
assert (
|
|
dialog.test_buffer._text
|
|
== "Tiny is not downloaded yet. Press Download on the Speech Model page first, "
|
|
"or pick a downloaded model."
|
|
)
|
|
assert "No speech detected" not in dialog.test_buffer._text
|
|
dialog.apply_settings.assert_not_called()
|
|
dialog.test_button.set_label.assert_not_called()
|
|
dialog.test_output_revealer.set_reveal_child.assert_called_with(True)
|
|
|
|
|
|
def test_cancelled_settings_apply_does_not_start_test_dictation() -> None:
|
|
dialog = _dialog_for_test(start_return=True)
|
|
dialog.get_selected_settings.return_value["model_size"] = "small"
|
|
dialog.apply_settings.return_value = False
|
|
|
|
with (
|
|
patch.object(settings_dialog, "_undownloaded_model_info", return_value=None),
|
|
patch.object(settings_dialog.threading, "Thread") as thread_cls,
|
|
):
|
|
SettingsDialog._on_test_clicked(dialog, None)
|
|
|
|
dialog.apply_settings.assert_called_once()
|
|
dialog.speech_engine.start_recognition.assert_not_called()
|
|
thread_cls.assert_not_called()
|
|
assert dialog._test_active is False
|
|
assert dialog.test_buffer._text == "Failed to apply settings. Please try again."
|
|
|
|
|
|
def test_test_dictation_auto_paused_message() -> None:
|
|
dialog = _dialog_for_test(start_return=False, is_auto_paused=True)
|
|
|
|
with (
|
|
patch.object(settings_dialog, "_undownloaded_model_info", return_value=None),
|
|
patch.object(settings_dialog.threading, "Thread") as thread_cls,
|
|
):
|
|
SettingsDialog._on_test_clicked(dialog, None)
|
|
|
|
thread_cls.assert_not_called()
|
|
assert "paused" in dialog.test_buffer._text.lower()
|
|
assert "No speech detected" not in dialog.test_buffer._text
|
|
|
|
|
|
def test_test_dictation_start_failure_generic_message() -> None:
|
|
dialog = _dialog_for_test(start_return=False, model_ready=True, is_auto_paused=False)
|
|
|
|
with (
|
|
patch.object(settings_dialog, "_undownloaded_model_info", return_value=None),
|
|
patch.object(settings_dialog.threading, "Thread") as thread_cls,
|
|
):
|
|
SettingsDialog._on_test_clicked(dialog, None)
|
|
|
|
thread_cls.assert_not_called()
|
|
assert dialog.test_buffer._text == "Could not start recognition test."
|
|
|
|
|
|
def test_test_dictation_started_arms_listen_timer() -> None:
|
|
dialog = _dialog_for_test(start_return=True)
|
|
|
|
with (
|
|
patch.object(settings_dialog, "_undownloaded_model_info", return_value=None),
|
|
patch.object(settings_dialog.threading, "Thread") as thread_cls,
|
|
):
|
|
SettingsDialog._on_test_clicked(dialog, None)
|
|
|
|
thread_cls.assert_called_once()
|
|
assert thread_cls.call_args.kwargs["args"] == (4.0, 1)
|
|
assert dialog._test_active is True
|
|
assert dialog._test_cancelled is False
|
|
dialog.test_button.set_label.assert_called_with("Testing… Speak Now!")
|
|
dialog.test_cancel_button.show.assert_called_once()
|
|
dialog.apply_settings.assert_not_called()
|
|
|
|
|
|
def test_test_dictation_cancel_runs_off_thread_and_restores_callbacks() -> None:
|
|
dialog = _dialog_for_test(start_return=True)
|
|
with (
|
|
patch.object(settings_dialog.threading, "Thread"),
|
|
patch.object(settings_dialog, "_undownloaded_model_info", return_value=None),
|
|
):
|
|
SettingsDialog._on_test_clicked(dialog, None)
|
|
live_callbacks = dialog.speech_engine.get_text_callbacks.return_value
|
|
dialog.speech_engine.cancel_transcription.side_effect = RuntimeError("cancel failed")
|
|
|
|
with patch.object(settings_dialog.threading, "Thread") as thread_cls:
|
|
SettingsDialog._on_test_cancel_clicked(dialog, None)
|
|
|
|
assert dialog._test_cancelled is True
|
|
dialog.test_button.set_sensitive.assert_called_with(False)
|
|
dialog.test_cancel_button.set_sensitive.assert_called_with(False)
|
|
dialog.test_button.set_label.assert_called_with("Cancelling…")
|
|
thread_cls.assert_called_once()
|
|
assert thread_cls.call_args.kwargs["daemon"] is True
|
|
assert thread_cls.call_args.kwargs["name"] == "voculinux-test-dictation-cancel"
|
|
|
|
with patch.object(settings_dialog, "GLib") as glib:
|
|
thread_cls.call_args.kwargs["target"]()
|
|
glib.idle_add.assert_called_once_with(dialog._finish_test_after_user_cancel)
|
|
result = SettingsDialog._finish_test_after_user_cancel(dialog)
|
|
assert result is False
|
|
glib.timeout_add.assert_not_called()
|
|
|
|
dialog.speech_engine.cancel_transcription.assert_called_once()
|
|
dialog.speech_engine.set_text_callbacks.assert_called_with(live_callbacks)
|
|
assert dialog.speech_engine.test_capture_ceiling is not None
|
|
assert dialog.test_buffer._text == "(Test cancelled)"
|
|
assert dialog._test_active is False
|
|
dialog.test_cancel_button.hide.assert_called()
|
|
dialog.update_recognition_progress.assert_called_with("Idle")
|
|
|
|
|
|
def test_cancelled_test_ignores_a_queued_text_callback() -> None:
|
|
dialog = Mock()
|
|
dialog._test_cancelled = True
|
|
dialog.test_buffer = _text_buffer()
|
|
|
|
assert SettingsDialog._append_test_result(dialog, "late result") is False
|
|
assert dialog.test_buffer._text == ""
|
|
|
|
|
|
def test_test_dictation_reconfigures_when_live_engine_differs_from_ui() -> None:
|
|
"""UI matches the file but the live manager is still on another engine."""
|
|
dialog = _dialog_for_test(start_return=True, model_ready=True)
|
|
dialog.speech_engine.engine = "vosk"
|
|
dialog.speech_engine.model_size = "small"
|
|
dialog.speech_engine.model_ready = False
|
|
|
|
def _apply_and_sync() -> bool:
|
|
dialog.speech_engine.engine = "whisper_cpp"
|
|
dialog.speech_engine.model_size = "tiny"
|
|
dialog.speech_engine.model_ready = True
|
|
return True
|
|
|
|
dialog.apply_settings.side_effect = _apply_and_sync
|
|
|
|
with (
|
|
patch.object(settings_dialog, "_undownloaded_model_info", return_value=None),
|
|
patch.object(settings_dialog.threading, "Thread") as thread_cls,
|
|
):
|
|
SettingsDialog._on_test_clicked(dialog, None)
|
|
|
|
dialog.apply_settings.assert_called_once()
|
|
thread_cls.assert_called_once()
|
|
assert dialog._test_active is True
|
|
|
|
|
|
def test_check_test_result_empty_buffer_is_no_speech() -> None:
|
|
dialog = Mock()
|
|
dialog.test_buffer = _text_buffer()
|
|
dialog.test_buffer.set_text("")
|
|
|
|
SettingsDialog._check_test_result(dialog)
|
|
|
|
assert dialog.test_buffer._text == "(No speech detected during test)"
|
|
|
|
|
|
def test_check_test_result_keeps_captured_text() -> None:
|
|
dialog = Mock()
|
|
dialog.test_buffer = _text_buffer()
|
|
dialog.test_buffer.set_text("hello world")
|
|
|
|
SettingsDialog._check_test_result(dialog)
|
|
|
|
assert dialog.test_buffer._text == "hello world"
|
|
|
|
|
|
def test_append_test_result_shows_callback_text() -> None:
|
|
dialog = Mock()
|
|
dialog.test_buffer = _text_buffer()
|
|
dialog.test_textview = Mock()
|
|
|
|
SettingsDialog._append_test_result(dialog, "hello")
|
|
|
|
assert dialog.test_buffer._text == "hello"
|
|
|
|
|
|
def _dialog_for_finalize(
|
|
*,
|
|
state: RecognitionState,
|
|
buffered_reload: bool = False,
|
|
saved_callbacks: Optional[list[Any]] = None,
|
|
has_cancel: bool = True,
|
|
pending_transcription: bool = False,
|
|
) -> Mock:
|
|
"""Minimal dialog wired for _finalize_test / idle-wait helpers."""
|
|
dialog = Mock()
|
|
dialog._test_active = True
|
|
dialog._test_token = 2
|
|
dialog._test_cancelled = False
|
|
dialog._test_idle_wait_ticks = 0
|
|
dialog._test_timeout_cancel_attempted = False
|
|
dialog.test_button = Mock()
|
|
dialog.test_cancel_button = Mock()
|
|
dialog.test_buffer = _text_buffer()
|
|
dialog.update_recognition_progress = Mock()
|
|
dialog._saved_text_callbacks = (
|
|
list(saved_callbacks) if saved_callbacks is not None else [Mock(name="live")]
|
|
)
|
|
dialog._test_text_callback = Mock(name="test_cb")
|
|
dialog._restore_callbacks_and_check_result = (
|
|
SettingsDialog._restore_callbacks_and_check_result.__get__(dialog)
|
|
)
|
|
dialog._wait_for_idle_then_restore_callbacks = (
|
|
SettingsDialog._wait_for_idle_then_restore_callbacks.__get__(dialog)
|
|
)
|
|
dialog._on_test_idle_wait_timeout = SettingsDialog._on_test_idle_wait_timeout.__get__(dialog)
|
|
dialog._cancel_buffered_reload_then_restore = (
|
|
SettingsDialog._cancel_buffered_reload_then_restore.__get__(dialog)
|
|
)
|
|
dialog._on_buffered_cancel_failed = SettingsDialog._on_buffered_cancel_failed.__get__(dialog)
|
|
dialog._finish_test_after_buffered_cancel = (
|
|
SettingsDialog._finish_test_after_buffered_cancel.__get__(dialog)
|
|
)
|
|
dialog._keep_waiting_after_timeout = SettingsDialog._keep_waiting_after_timeout.__get__(dialog)
|
|
dialog._finish_test_restore_ui = SettingsDialog._finish_test_restore_ui.__get__(dialog)
|
|
dialog._finish_test_after_user_cancel = SettingsDialog._finish_test_after_user_cancel.__get__(
|
|
dialog
|
|
)
|
|
dialog._test_engine_busy = SettingsDialog._test_engine_busy.__get__(dialog)
|
|
dialog._check_test_result = Mock(return_value=False)
|
|
|
|
if has_cancel:
|
|
engine = Mock()
|
|
engine._cancel_reload_recording = Mock()
|
|
else:
|
|
# getattr(..., "_cancel_reload_recording", None) must miss.
|
|
engine = Mock(
|
|
spec=[
|
|
"state",
|
|
"_buffered_reload_session",
|
|
"stop_recognition",
|
|
"set_text_callbacks",
|
|
"has_pending_transcription",
|
|
]
|
|
)
|
|
engine.state = state
|
|
engine._buffered_reload_session = buffered_reload
|
|
engine.has_pending_transcription = Mock(return_value=pending_transcription)
|
|
engine.stop_recognition = Mock()
|
|
engine.set_text_callbacks = Mock()
|
|
dialog.speech_engine = engine
|
|
return dialog
|
|
|
|
|
|
def test_stale_finalize_token_does_not_stop_new_test() -> None:
|
|
dialog = _dialog_for_finalize(state=RecognitionState.LISTENING)
|
|
|
|
assert SettingsDialog._finalize_test(dialog, token=1) is False
|
|
|
|
dialog.speech_engine.stop_recognition.assert_not_called()
|
|
assert dialog._test_active is True
|
|
|
|
|
|
def test_open_dictation_pad_row_invokes_callback_on_click() -> None:
|
|
callback = Mock()
|
|
dialog = Mock()
|
|
dialog.dictation_pad_open_callback = callback
|
|
dialog._on_dictation_pad_open_clicked = SettingsDialog._on_dictation_pad_open_clicked.__get__(
|
|
dialog
|
|
)
|
|
group = Mock()
|
|
button = Mock()
|
|
row = Mock()
|
|
|
|
with (
|
|
patch.object(settings_dialog.Gtk, "Button", return_value=button),
|
|
patch.object(settings_dialog, "PreferenceRow", return_value=row) as row_factory,
|
|
):
|
|
SettingsDialog._add_dictation_pad_open_row(dialog, group)
|
|
|
|
group.add_row.assert_called_once_with(row)
|
|
row_factory.assert_called_once_with(
|
|
title="Open Dictation Pad",
|
|
subtitle="Show the Dictation Pad window",
|
|
widget=button,
|
|
keywords=("pad", "window", "open"),
|
|
)
|
|
click_callback = button.connect.call_args.args[1]
|
|
click_callback(button)
|
|
callback.assert_called_once_with()
|
|
|
|
|
|
def test_open_dictation_pad_row_is_absent_without_callback() -> None:
|
|
dialog = Mock()
|
|
dialog.dictation_pad_open_callback = None
|
|
group = Mock()
|
|
|
|
with patch.object(settings_dialog.Gtk, "Button") as button_factory:
|
|
SettingsDialog._add_dictation_pad_open_row(dialog, group)
|
|
|
|
button_factory.assert_not_called()
|
|
group.add_row.assert_not_called()
|
|
assert dialog.dictation_pad_open_button is None
|
|
|
|
|
|
def test_dictation_pad_switch_persists_routing_preference() -> None:
|
|
dialog = Mock()
|
|
dialog._initializing = False
|
|
dialog._applying_settings = False
|
|
dialog.config_manager = Mock()
|
|
|
|
assert SettingsDialog._on_dictation_pad_toggled(dialog, Mock(), True) is False
|
|
|
|
dialog.config_manager.set.assert_called_once_with("text_injection", "dictate_to_pad", True)
|
|
dialog.config_manager.save_settings.assert_called_once()
|
|
|
|
|
|
def test_finalize_test_buffered_reload_waits_for_idle_before_restore() -> None:
|
|
"""Stop recognition runs off the GTK thread while test callbacks remain installed."""
|
|
dialog = _dialog_for_finalize(state=RecognitionState.PROCESSING, buffered_reload=True)
|
|
live = dialog._saved_text_callbacks[0]
|
|
|
|
with (
|
|
patch.object(settings_dialog, "GLib") as glib,
|
|
patch.object(settings_dialog.threading, "Thread") as thread_cls,
|
|
):
|
|
SettingsDialog._finalize_test(dialog)
|
|
|
|
dialog.speech_engine.stop_recognition.assert_not_called()
|
|
thread_cls.assert_called_once()
|
|
assert thread_cls.call_args.kwargs["daemon"] is True
|
|
assert thread_cls.call_args.kwargs["name"] == "voculinux-test-dictation-stop"
|
|
thread_cls.call_args.kwargs["target"]()
|
|
dialog.speech_engine.stop_recognition.assert_called_once()
|
|
# Must not restore live injector yet — worker still holds the utterance.
|
|
dialog.speech_engine.set_text_callbacks.assert_not_called()
|
|
assert dialog._saved_text_callbacks == [live]
|
|
assert dialog._test_active is True
|
|
dialog.test_button.set_label.assert_called_with("Processing…")
|
|
dialog.test_cancel_button.set_sensitive.assert_called_with(True)
|
|
dialog.test_cancel_button.show.assert_called_once()
|
|
glib.timeout_add.assert_called_once_with(100, dialog._wait_for_idle_then_restore_callbacks)
|
|
|
|
|
|
def test_wait_for_idle_keeps_polling_while_processing() -> None:
|
|
dialog = _dialog_for_finalize(state=RecognitionState.PROCESSING, buffered_reload=True)
|
|
|
|
assert SettingsDialog._wait_for_idle_then_restore_callbacks(dialog) is True
|
|
dialog.speech_engine.set_text_callbacks.assert_not_called()
|
|
assert dialog._test_active is True
|
|
assert dialog._test_idle_wait_ticks == 1
|
|
|
|
|
|
def test_wait_for_idle_restores_only_after_idle() -> None:
|
|
dialog = _dialog_for_finalize(state=RecognitionState.IDLE, buffered_reload=False)
|
|
live = dialog._saved_text_callbacks[0]
|
|
|
|
with patch.object(settings_dialog, "GLib") as glib:
|
|
result = SettingsDialog._wait_for_idle_then_restore_callbacks(dialog)
|
|
|
|
assert result is False
|
|
dialog.speech_engine.set_text_callbacks.assert_called_once_with([live])
|
|
assert not hasattr(dialog, "_saved_text_callbacks")
|
|
assert dialog._test_active is False
|
|
dialog.test_button.set_label.assert_called_with("Test Dictation")
|
|
glib.timeout_add.assert_called_once_with(300, dialog._check_test_result)
|
|
|
|
|
|
def test_wait_for_idle_treats_buffered_flag_as_busy_even_if_state_idle() -> None:
|
|
"""Defensive: session flag can lag a frame behind state transitions."""
|
|
dialog = _dialog_for_finalize(state=RecognitionState.IDLE, buffered_reload=True)
|
|
|
|
assert SettingsDialog._wait_for_idle_then_restore_callbacks(dialog) is True
|
|
dialog.speech_engine.set_text_callbacks.assert_not_called()
|
|
|
|
|
|
def test_finalize_test_idle_path_still_polls_after_threaded_stop() -> None:
|
|
"""Even an already-idle session uses the off-thread stop and idle poll."""
|
|
dialog = _dialog_for_finalize(state=RecognitionState.IDLE, buffered_reload=False)
|
|
|
|
with (
|
|
patch.object(settings_dialog, "GLib") as glib,
|
|
patch.object(settings_dialog.threading, "Thread") as thread_cls,
|
|
):
|
|
SettingsDialog._finalize_test(dialog)
|
|
|
|
dialog.speech_engine.stop_recognition.assert_not_called()
|
|
assert dialog._test_active is True
|
|
dialog.test_button.set_label.assert_called_with("Processing…")
|
|
dialog.test_cancel_button.show.assert_called_once()
|
|
thread_cls.assert_called_once()
|
|
glib.timeout_add.assert_called_once_with(100, dialog._wait_for_idle_then_restore_callbacks)
|
|
assert hasattr(dialog, "_saved_text_callbacks")
|
|
|
|
|
|
def test_cancel_during_processing_restores_once_without_result_check() -> None:
|
|
"""A queued poll after cancellation must not restore callbacks a second time."""
|
|
dialog = _dialog_for_finalize(state=RecognitionState.PROCESSING, buffered_reload=False)
|
|
live = dialog._saved_text_callbacks[0]
|
|
|
|
with (
|
|
patch.object(settings_dialog, "GLib") as glib,
|
|
patch.object(settings_dialog.threading, "Thread") as thread_cls,
|
|
):
|
|
SettingsDialog._finalize_test(dialog)
|
|
|
|
assert thread_cls.call_args.kwargs["name"] == "voculinux-test-dictation-stop"
|
|
dialog._test_cancelled = True
|
|
assert SettingsDialog._finish_test_after_user_cancel(dialog) is False
|
|
assert dialog.test_buffer._text == "(Test cancelled)"
|
|
dialog.speech_engine.set_text_callbacks.assert_called_once_with([live])
|
|
|
|
assert SettingsDialog._wait_for_idle_then_restore_callbacks(dialog) is False
|
|
dialog.speech_engine.set_text_callbacks.assert_called_once_with([live])
|
|
dialog._check_test_result.assert_not_called()
|
|
assert glib.timeout_add.call_count == 1
|
|
|
|
|
|
def test_idle_poll_does_not_restore_after_cancel_flag() -> None:
|
|
dialog = _dialog_for_finalize(state=RecognitionState.IDLE, buffered_reload=False)
|
|
dialog._test_cancelled = True
|
|
|
|
assert SettingsDialog._wait_for_idle_then_restore_callbacks(dialog) is False
|
|
dialog.speech_engine.set_text_callbacks.assert_not_called()
|
|
dialog._check_test_result.assert_not_called()
|
|
|
|
|
|
def test_finalize_waits_for_pending_transcription_and_keeps_test_callback() -> None:
|
|
"""Late recognition text stays on the test path after state becomes IDLE."""
|
|
live_text: list[str] = []
|
|
|
|
def live_callback(text: str) -> None:
|
|
live_text.append(text)
|
|
|
|
dialog = _dialog_for_finalize(state=RecognitionState.IDLE)
|
|
dialog._saved_text_callbacks = [live_callback]
|
|
dialog.speech_engine.has_pending_transcription = Mock(side_effect=[True, False])
|
|
dialog._test_text_callback = SettingsDialog._test_text_callback.__get__(dialog)
|
|
dialog._append_test_result = SettingsDialog._append_test_result.__get__(dialog)
|
|
|
|
with (
|
|
patch.object(settings_dialog, "GLib") as glib,
|
|
patch.object(settings_dialog.threading, "Thread"),
|
|
):
|
|
glib.idle_add.side_effect = lambda callback, *args: callback(*args)
|
|
SettingsDialog._finalize_test(dialog)
|
|
|
|
dialog.speech_engine.set_text_callbacks.assert_not_called()
|
|
assert dialog._test_active is True
|
|
|
|
dialog._test_text_callback("hello world")
|
|
assert dialog.test_buffer._text == "hello world"
|
|
assert live_text == []
|
|
|
|
assert SettingsDialog._wait_for_idle_then_restore_callbacks(dialog) is True
|
|
dialog.speech_engine.set_text_callbacks.assert_not_called()
|
|
assert SettingsDialog._wait_for_idle_then_restore_callbacks(dialog) is False
|
|
|
|
dialog.speech_engine.set_text_callbacks.assert_called_once_with([live_callback])
|
|
assert live_text == []
|
|
assert not hasattr(dialog, "_saved_text_callbacks")
|
|
glib.timeout_add.assert_any_call(100, dialog._wait_for_idle_then_restore_callbacks)
|
|
|
|
|
|
def test_timeout_does_not_restore_live_while_buffered_starts_cancel() -> None:
|
|
"""At ~3min timeout while buffered, cancel off-thread; do not restore yet."""
|
|
dialog = _dialog_for_finalize(state=RecognitionState.PROCESSING, buffered_reload=True)
|
|
live = dialog._saved_text_callbacks[0]
|
|
dialog._test_idle_wait_ticks = 1799
|
|
|
|
with patch.object(settings_dialog.threading, "Thread") as thread_cls:
|
|
result = SettingsDialog._wait_for_idle_then_restore_callbacks(dialog)
|
|
|
|
assert result is False
|
|
dialog.speech_engine.set_text_callbacks.assert_not_called()
|
|
assert dialog._saved_text_callbacks == [live]
|
|
assert dialog._test_active is True
|
|
dialog.test_button.set_label.assert_called_with("Cancelling…")
|
|
thread_cls.assert_called_once()
|
|
assert thread_cls.call_args.kwargs["target"] == dialog._cancel_buffered_reload_then_restore
|
|
assert thread_cls.call_args.kwargs["daemon"] is True
|
|
|
|
|
|
def test_nonbuffered_timeout_keeps_waiting_for_pending_transcription() -> None:
|
|
"""Do not invoke buffered cancellation for a non-buffered active worker."""
|
|
dialog = _dialog_for_finalize(
|
|
state=RecognitionState.IDLE,
|
|
pending_transcription=True,
|
|
)
|
|
dialog._test_idle_wait_ticks = 1799
|
|
|
|
with patch.object(settings_dialog.threading, "Thread") as thread_cls:
|
|
result = SettingsDialog._wait_for_idle_then_restore_callbacks(dialog)
|
|
|
|
assert result is True
|
|
thread_cls.assert_not_called()
|
|
dialog.speech_engine._cancel_reload_recording.assert_not_called()
|
|
dialog.speech_engine.set_text_callbacks.assert_not_called()
|
|
assert dialog._test_active is True
|
|
assert dialog._test_idle_wait_ticks == 1800
|
|
assert dialog._test_timeout_cancel_attempted is True
|
|
|
|
|
|
def test_timeout_without_cancel_keeps_waiting_active() -> None:
|
|
"""If cancel API is missing, keep polling with test callbacks / _test_active."""
|
|
dialog = _dialog_for_finalize(
|
|
state=RecognitionState.PROCESSING, buffered_reload=True, has_cancel=False
|
|
)
|
|
live = dialog._saved_text_callbacks[0]
|
|
dialog._test_idle_wait_ticks = 1799
|
|
|
|
with patch.object(settings_dialog.threading, "Thread") as thread_cls:
|
|
result = SettingsDialog._wait_for_idle_then_restore_callbacks(dialog)
|
|
|
|
assert result is True
|
|
thread_cls.assert_not_called()
|
|
dialog.speech_engine.set_text_callbacks.assert_not_called()
|
|
assert dialog._saved_text_callbacks == [live]
|
|
assert dialog._test_active is True
|
|
assert dialog._test_timeout_cancel_attempted is True
|
|
dialog.test_button.set_sensitive.assert_called_with(False)
|
|
dialog.test_button.set_label.assert_called_with("Still processing…")
|
|
assert "Timed out" in dialog.test_buffer._text
|
|
assert "Still waiting" in dialog.test_buffer._text
|
|
|
|
# Subsequent ticks past timeout must keep waiting, not restore.
|
|
result2 = SettingsDialog._wait_for_idle_then_restore_callbacks(dialog)
|
|
assert result2 is True
|
|
dialog.speech_engine.set_text_callbacks.assert_not_called()
|
|
|
|
|
|
def test_finish_after_buffered_cancel_restores_live_callbacks() -> None:
|
|
"""Only after cancel completes is it safe to put live injectors back."""
|
|
dialog = _dialog_for_finalize(state=RecognitionState.IDLE, buffered_reload=False)
|
|
live = dialog._saved_text_callbacks[0]
|
|
|
|
with patch.object(settings_dialog, "GLib") as glib:
|
|
result = SettingsDialog._finish_test_after_buffered_cancel(dialog)
|
|
|
|
assert result is False
|
|
dialog.speech_engine.set_text_callbacks.assert_called_once_with([live])
|
|
assert not hasattr(dialog, "_saved_text_callbacks")
|
|
glib.timeout_add.assert_called_once_with(300, dialog._check_test_result)
|
|
|
|
|
|
def test_finish_after_buffered_cancel_resumes_waiting_if_work_remains() -> None:
|
|
dialog = _dialog_for_finalize(
|
|
state=RecognitionState.IDLE,
|
|
pending_transcription=True,
|
|
)
|
|
|
|
with patch.object(settings_dialog, "GLib") as glib:
|
|
result = SettingsDialog._finish_test_after_buffered_cancel(dialog)
|
|
|
|
assert result is False
|
|
dialog.speech_engine.set_text_callbacks.assert_not_called()
|
|
assert dialog._test_active is True
|
|
glib.timeout_add.assert_called_once_with(100, dialog._wait_for_idle_then_restore_callbacks)
|
|
|
|
|
|
def test_cancel_buffered_reload_then_restore_schedules_finish() -> None:
|
|
dialog = _dialog_for_finalize(state=RecognitionState.PROCESSING, buffered_reload=True)
|
|
|
|
with patch.object(settings_dialog, "GLib") as glib:
|
|
SettingsDialog._cancel_buffered_reload_then_restore(dialog)
|
|
|
|
dialog.speech_engine._cancel_reload_recording.assert_called_once_with()
|
|
glib.idle_add.assert_called_once_with(dialog._finish_test_after_buffered_cancel)
|
|
|
|
|
|
def test_cancel_buffered_reload_failure_resumes_idle_wait() -> None:
|
|
dialog = _dialog_for_finalize(state=RecognitionState.PROCESSING, buffered_reload=True)
|
|
live = dialog._saved_text_callbacks[0]
|
|
dialog._test_timeout_cancel_attempted = True
|
|
dialog.speech_engine._cancel_reload_recording.side_effect = RuntimeError("boom")
|
|
|
|
with patch.object(settings_dialog, "GLib") as glib:
|
|
SettingsDialog._cancel_buffered_reload_then_restore(dialog)
|
|
|
|
glib.idle_add.assert_called_once_with(dialog._on_buffered_cancel_failed)
|
|
|
|
with patch.object(settings_dialog, "GLib") as glib2:
|
|
SettingsDialog._on_buffered_cancel_failed(dialog)
|
|
|
|
dialog.speech_engine.set_text_callbacks.assert_not_called()
|
|
assert dialog._saved_text_callbacks == [live]
|
|
assert dialog._test_active is True
|
|
dialog.test_button.set_sensitive.assert_called_with(False)
|
|
dialog.test_button.set_label.assert_called_with("Still processing…")
|
|
assert "cancel" in dialog.test_buffer._text.lower()
|
|
glib2.timeout_add.assert_called_once_with(100, dialog._wait_for_idle_then_restore_callbacks)
|
|
|
|
# Resumed poll must not restore while still busy, and must not re-cancel.
|
|
with patch.object(settings_dialog.threading, "Thread") as thread_cls:
|
|
assert SettingsDialog._wait_for_idle_then_restore_callbacks(dialog) is True
|
|
thread_cls.assert_not_called()
|
|
dialog.speech_engine.set_text_callbacks.assert_not_called()
|
|
|
|
|
|
def test_keep_waiting_then_idle_restores_live_callbacks() -> None:
|
|
"""After a no-cancel timeout, IDLE eventually restores live injectors."""
|
|
dialog = _dialog_for_finalize(
|
|
state=RecognitionState.PROCESSING, buffered_reload=True, has_cancel=False
|
|
)
|
|
live = dialog._saved_text_callbacks[0]
|
|
dialog._test_idle_wait_ticks = 1799
|
|
SettingsDialog._wait_for_idle_then_restore_callbacks(dialog)
|
|
assert dialog._test_active is True
|
|
|
|
dialog.speech_engine.state = RecognitionState.IDLE
|
|
dialog.speech_engine._buffered_reload_session = False
|
|
with patch.object(settings_dialog, "GLib") as glib:
|
|
result = SettingsDialog._wait_for_idle_then_restore_callbacks(dialog)
|
|
|
|
assert result is False
|
|
dialog.speech_engine.set_text_callbacks.assert_called_once_with([live])
|
|
assert not hasattr(dialog, "_saved_text_callbacks")
|
|
assert dialog._test_active is False
|
|
glib.timeout_add.assert_called_once_with(300, dialog._check_test_result)
|
|
|
|
|
|
def test_timeout_cancel_flag_resets_on_new_finalize_wait() -> None:
|
|
"""A later Test Dictation session must be allowed to cancel again."""
|
|
dialog = _dialog_for_finalize(state=RecognitionState.PROCESSING, buffered_reload=True)
|
|
dialog._test_timeout_cancel_attempted = True
|
|
dialog._test_idle_wait_ticks = 0
|
|
|
|
with patch.object(settings_dialog, "GLib") as glib:
|
|
SettingsDialog._finalize_test(dialog)
|
|
|
|
assert dialog._test_timeout_cancel_attempted is False
|
|
assert dialog._test_idle_wait_ticks == 0
|
|
glib.timeout_add.assert_called_once_with(100, dialog._wait_for_idle_then_restore_callbacks)
|
|
|
|
dialog._test_idle_wait_ticks = 1799
|
|
with patch.object(settings_dialog.threading, "Thread") as thread_cls:
|
|
assert SettingsDialog._wait_for_idle_then_restore_callbacks(dialog) is False
|
|
thread_cls.assert_called_once()
|
|
assert thread_cls.call_args.kwargs["target"] == dialog._cancel_buffered_reload_then_restore
|
|
|
|
|
|
def test_cancel_worker_reraises_unexpected_defect() -> None:
|
|
"""Programming defects must not be swallowed as cancel-failed recovery."""
|
|
dialog = _dialog_for_finalize(state=RecognitionState.PROCESSING, buffered_reload=True)
|
|
dialog.speech_engine._cancel_reload_recording.side_effect = KeyError("bug")
|
|
|
|
with patch.object(settings_dialog, "GLib") as glib:
|
|
try:
|
|
SettingsDialog._cancel_buffered_reload_then_restore(dialog)
|
|
raised = False
|
|
except KeyError:
|
|
raised = True
|
|
|
|
assert raised is True
|
|
glib.idle_add.assert_not_called()
|
|
|
|
|
|
def test_audio_test_cancellation_invalidates_queued_results() -> None:
|
|
"""A closed dialog and a superseded test must never receive stale UI work."""
|
|
dialog = Mock()
|
|
old_cancel = threading.Event()
|
|
dialog._audio_test_cancel = old_cancel
|
|
SettingsDialog._cancel_audio_test(dialog)
|
|
assert old_cancel.is_set()
|
|
assert dialog._audio_test_cancel is None
|
|
assert SettingsDialog._complete_audio_test(dialog, {}, old_cancel) is False
|
|
dialog._handle_audio_test_result.assert_not_called()
|
|
|
|
current = threading.Event()
|
|
dialog._audio_test_cancel = current
|
|
assert SettingsDialog._complete_audio_test(dialog, {}, threading.Event()) is False
|
|
dialog._handle_audio_test_result.assert_not_called()
|
|
assert SettingsDialog._complete_audio_test(dialog, {"success": True}, current) is False
|
|
dialog._handle_audio_test_result.assert_called_once_with({"success": True})
|
|
assert dialog._audio_test_cancel is None
|
|
|
|
|
|
def test_settings_close_cancels_audio_before_persisting_edits() -> None:
|
|
"""The response path cancels even if the caller delays destruction."""
|
|
dialog = Mock()
|
|
SettingsDialog._on_settings_dialog_response(
|
|
dialog, dialog, settings_dialog.Gtk.ResponseType.CLOSE
|
|
)
|
|
assert dialog.method_calls[0][0] == "_cancel_audio_test"
|
|
dialog._cancel_audio_test.assert_called_once_with()
|
|
|
|
|
|
def test_settings_audio_worker_propagates_cancellation() -> None:
|
|
"""Closing Settings cancels the predicate held by its background worker."""
|
|
dialog = Mock()
|
|
dialog._audio_test_cancel = None
|
|
dialog.audio_device_combo.get_active_id.return_value = "-1"
|
|
dialog._cancel_audio_test = SettingsDialog._cancel_audio_test.__get__(dialog)
|
|
with (
|
|
patch.object(settings_dialog.threading, "Thread") as thread_cls,
|
|
patch.object(settings_dialog, "GLib") as glib,
|
|
patch("vocalinux.speech_recognition.recognition_manager.test_audio_input") as test_audio,
|
|
):
|
|
SettingsDialog._on_test_audio_clicked(dialog, None)
|
|
worker = thread_cls.call_args.kwargs["target"]
|
|
cancel = dialog._audio_test_cancel
|
|
|
|
def capture(**kwargs: Any) -> dict:
|
|
assert kwargs["device_index"] is None
|
|
assert kwargs["should_continue"]()
|
|
dialog._cancel_audio_test()
|
|
assert not kwargs["should_continue"]()
|
|
return {"success": False, "error": "cancelled"}
|
|
|
|
test_audio.side_effect = capture
|
|
worker()
|
|
assert cancel.is_set()
|
|
glib.idle_add.assert_called_once()
|
|
callback, result, token = glib.idle_add.call_args.args
|
|
assert callback == dialog._complete_audio_test
|
|
assert result["success"] is False
|
|
assert token is cancel
|