""" Tests for the SettingsDialog. Since SettingsDialog inherits from Gtk.Dialog which is mocked during tests, we can't easily test the actual class methods. Instead, we test the core logic that the settings dialog is supposed to execute. UX Design Notes tested: - Instant-apply pattern: settings apply immediately when changed - No action buttons - uses title bar close (GNOME HIG) """ import sys import time import unittest from unittest.mock import MagicMock, Mock, call, patch # Mock GTK before importing anything that might use it sys.modules["gi"] = MagicMock() sys.modules["gi.repository"] = MagicMock() sys.modules["gi.repository.Gtk"] = MagicMock() sys.modules["gi.repository.GLib"] = MagicMock() sys.modules["gi.repository.Gdk"] = MagicMock() sys.modules["gi.repository.Pango"] = MagicMock() from vocalinux.common_types import RecognitionState # noqa: E402 # Create mock for speech engine mock_speech_engine = Mock() mock_speech_engine.state = RecognitionState.IDLE mock_speech_engine.reconfigure = Mock() mock_speech_engine.start_recognition = Mock() mock_speech_engine.stop_recognition = Mock() mock_speech_engine.register_text_callback = Mock() mock_speech_engine.unregister_text_callback = Mock() # Create mock for config manager mock_config_manager = Mock() mock_config_manager.get = Mock( return_value={ "speech_recognition": { "engine": "vosk", "language": "en-us", "model_size": "small", "vad_sensitivity": 3, "silence_timeout": 2.0, } } ) mock_config_manager.update_speech_recognition_settings = Mock() mock_config_manager.set = Mock() mock_config_manager.save_settings = Mock() def apply_settings_internal(dialog, settings: dict) -> bool: """ Simplified version of SettingsDialog._apply_settings_internal for testing. This is a test helper that mirrors the real implementation behavior. """ try: # 1. Update Config Manager sr_settings = {k: v for k, v in settings.items() if not k.startswith("whispercpp_")} advanced_settings = {k: v for k, v in settings.items() if k.startswith("whispercpp_")} dialog.config_manager.update_speech_recognition_settings(sr_settings) for key, value in advanced_settings.items(): dialog.config_manager.set("advanced", key, value) dialog.config_manager.save_settings() # 2. Reconfigure Speech Engine # Stop engine before reconfiguring if it's running was_running = dialog.speech_engine.state != RecognitionState.IDLE if was_running: dialog.speech_engine.stop_recognition() # Give it a moment to fully stop time.sleep(0.01) # Shortened for tests dialog.speech_engine.reconfigure(**settings) return True except Exception: return False class TestSettingsDialog(unittest.TestCase): """Test cases for the settings dialog behavior.""" def setUp(self): """Set up test fixtures.""" # Reset mocks before each test mock_speech_engine.reset_mock() mock_config_manager.reset_mock() mock_speech_engine.state = RecognitionState.IDLE # Create a mock dialog object directly self.dialog = Mock() # Set mock attributes on dialog self.dialog.config_manager = mock_config_manager self.dialog.speech_engine = mock_speech_engine # Default test settings self.test_settings = { "engine": "vosk", "model_size": "small", "vad_sensitivity": 3, "silence_timeout": 2.0, } def test_apply_settings_success(self): """Test the apply_settings method calls config and engine methods.""" # Use larger model to test settings actually change settings = { "engine": "vosk", "language": "en-us", "model_size": "large", "vad_sensitivity": 3, "silence_timeout": 2.0, } # Ensure reconfigure doesn't raise an exception mock_speech_engine.reconfigure.side_effect = None # Call the method under test result = apply_settings_internal(self.dialog, settings) # Verify the result self.assertTrue(result) # Verify mocks were called with the right parameters mock_config_manager.update_speech_recognition_settings.assert_called_once_with(settings) mock_config_manager.save_settings.assert_called_once() mock_speech_engine.reconfigure.assert_called_once_with(**settings) def test_apply_settings_persists_whispercpp_settings_to_advanced_section(self): """Test whisper.cpp settings are saved outside speech_recognition config.""" settings = { "engine": "whisper_cpp", "language": "auto", "model_size": "tiny", "vad_sensitivity": 3, "silence_timeout": 2.0, "whispercpp_no_timestamps": False, "whispercpp_temperature": 0.5, "whispercpp_initial_prompt": "Meeting notes", } mock_speech_engine.reconfigure.side_effect = None result = apply_settings_internal(self.dialog, settings) self.assertTrue(result) mock_config_manager.update_speech_recognition_settings.assert_called_once_with( { "engine": "whisper_cpp", "language": "auto", "model_size": "tiny", "vad_sensitivity": 3, "silence_timeout": 2.0, } ) mock_config_manager.set.assert_has_calls( [ call("advanced", "whispercpp_no_timestamps", False), call("advanced", "whispercpp_temperature", 0.5), call("advanced", "whispercpp_initial_prompt", "Meeting notes"), ], any_order=True, ) mock_config_manager.save_settings.assert_called_once() mock_speech_engine.reconfigure.assert_called_once_with(**settings) def test_apply_settings_stops_engine_if_running(self): """Test apply_settings stops the engine if it was running.""" # Set the engine state to running mock_speech_engine.state = RecognitionState.LISTENING # Ensure reconfigure doesn't raise an exception mock_speech_engine.reconfigure.side_effect = None # Call the method under test result = apply_settings_internal(self.dialog, self.test_settings) # Verify the result self.assertTrue(result) # Verify engine was stopped before reconfigure mock_speech_engine.stop_recognition.assert_called_once() mock_speech_engine.reconfigure.assert_called_once() def test_apply_settings_failure_reconfigure(self): """Test apply_settings handles errors during engine reconfiguration.""" # Set up the reconfigure method to raise an exception mock_speech_engine.reconfigure.side_effect = Exception("Model load failed") # Call the method under test result = apply_settings_internal(self.dialog, self.test_settings) # Verify the result self.assertFalse(result) # Verify mocks were called mock_config_manager.update_speech_recognition_settings.assert_called_once() mock_config_manager.save_settings.assert_called_once() mock_speech_engine.reconfigure.assert_called_once() class TestSettingsDialogCSS(unittest.TestCase): """Test cases for SettingsDialog CSS styling.""" def setUp(self): """Set up test fixtures.""" # Clear any cached imports if "vocalinux.ui.settings_dialog" in sys.modules: del sys.modules["vocalinux.ui.settings_dialog"] def test_settings_css_exists(self): """Test that SETTINGS_CSS constant is defined.""" from vocalinux.ui.settings_dialog import SETTINGS_CSS self.assertIsInstance(SETTINGS_CSS, str) def test_settings_css_has_dialog_class(self): """Test that CSS includes settings-dialog class.""" from vocalinux.ui.settings_dialog import SETTINGS_CSS self.assertIn(".settings-dialog", SETTINGS_CSS) def test_settings_css_has_preferences_group(self): """Test that CSS includes preferences-group class.""" from vocalinux.ui.settings_dialog import SETTINGS_CSS self.assertIn(".preferences-group", SETTINGS_CSS) def test_settings_css_has_preference_row(self): """Test that CSS includes preference-row class.""" from vocalinux.ui.settings_dialog import SETTINGS_CSS self.assertIn(".preference-row", SETTINGS_CSS) def test_settings_css_uses_theme_variables(self): """Test that CSS uses GTK theme variables.""" from vocalinux.ui.settings_dialog import SETTINGS_CSS # Should use theme variables for proper light/dark mode support self.assertIn("@theme_bg_color", SETTINGS_CSS) self.assertIn("@theme_base_color", SETTINGS_CSS) def test_settings_css_has_status_classes(self): """Test that CSS includes status indicator classes.""" from vocalinux.ui.settings_dialog import SETTINGS_CSS self.assertIn(".status-success", SETTINGS_CSS) self.assertIn(".status-warning", SETTINGS_CSS) self.assertIn(".status-error", SETTINGS_CSS) class TestSettingsDialogClasses(unittest.TestCase): """Test cases for SettingsDialog helper classes.""" def setUp(self): """Set up test fixtures.""" if "vocalinux.ui.settings_dialog" in sys.modules: del sys.modules["vocalinux.ui.settings_dialog"] def test_preferences_group_class_exists(self): """Test that PreferencesGroup class exists.""" from vocalinux.ui.settings_dialog import PreferencesGroup self.assertTrue(callable(PreferencesGroup)) def test_preference_row_class_exists(self): """Test that PreferenceRow class exists.""" from vocalinux.ui.settings_dialog import PreferenceRow self.assertTrue(callable(PreferenceRow)) def test_model_download_dialog_class_exists(self): """Test that ModelDownloadDialog class exists.""" from vocalinux.ui.settings_dialog import ModelDownloadDialog self.assertTrue(callable(ModelDownloadDialog)) class TestSettingsDialogInstantApply(unittest.TestCase): """Test cases for instant-apply behavior (no action buttons).""" def setUp(self): """Set up test fixtures.""" if "vocalinux.ui.settings_dialog" in sys.modules: del sys.modules["vocalinux.ui.settings_dialog"] def test_settings_dialog_has_auto_apply_method(self): """Test that SettingsDialog has _auto_apply_settings method in source.""" import os source_path = os.path.join( os.path.dirname(__file__), "..", "src", "vocalinux", "ui", "settings_dialog.py", ) with open(source_path, "r") as f: source_code = f.read() self.assertIn("def _auto_apply_settings(self", source_code) def test_settings_dialog_has_close_button_only(self): """Test that SettingsDialog has a Close button but no Apply button. A Close button is required for window managers that hide the title bar close button on Gtk.Dialog windows (fixes #323). The instant-apply pattern means settings are applied immediately, so no Apply button is needed. """ import os source_path = os.path.join( os.path.dirname(__file__), "..", "src", "vocalinux", "ui", "settings_dialog.py", ) with open(source_path, "r") as f: source_code = f.read() # Should have a Close button for WM compatibility self.assertIn("ResponseType.CLOSE", source_code) # Should NOT have Apply button - uses instant-apply pattern self.assertNotIn("_Apply", source_code) self.assertNotIn("ResponseType.APPLY", source_code) def test_settings_dialog_no_revert_settings(self): """Test that SettingsDialog does NOT have _revert_settings (removed).""" from vocalinux.ui.settings_dialog import SettingsDialog # _revert_settings was removed as part of no-action-buttons pattern self.assertFalse(hasattr(SettingsDialog, "_revert_settings")) def test_settings_dialog_no_show_applied_message(self): """Test that SettingsDialog does NOT have _show_settings_applied_message (removed).""" from vocalinux.ui.settings_dialog import SettingsDialog # _show_settings_applied_message was removed as part of instant-apply pattern self.assertFalse(hasattr(SettingsDialog, "_show_settings_applied_message")) def test_advanced_initial_prompt_defers_auto_apply_while_typing(self): import os source_path = os.path.join( os.path.dirname(__file__), "..", "src", "vocalinux", "ui", "settings_dialog.py", ) with open(source_path, "r") as f: source_code = f.read() self.assertNotIn("focus-out-event", source_code) self.assertNotIn( 'advanced_initial_prompt_buffer.connect("changed", self._on_advanced_param_changed)', source_code, ) self.assertIn( 'advanced_initial_prompt_buffer.connect("changed", self._on_advanced_prompt_changed)', source_code, ) self.assertIn("def _flush_advanced_prompt_if_dirty", source_code) self.assertIn("self._advanced_prompt_dirty = True", source_code) self.assertIn("self._flush_advanced_prompt_if_dirty()", source_code) def test_advanced_initial_prompt_has_help_tooltip(self): import os source_path = os.path.join( os.path.dirname(__file__), "..", "src", "vocalinux", "ui", "settings_dialog.py", ) with open(source_path, "r") as f: source_code = f.read() self.assertIn("initial_prompt_help", source_code) self.assertIn("Leave blank for normal dictation.", source_code) self.assertIn("prompt_scrolled.set_tooltip_text(initial_prompt_help)", source_code) self.assertIn("initial_prompt_row.set_tooltip_text(initial_prompt_help)", source_code) def test_advanced_panel_has_reset_to_defaults_button(self): import os source_path = os.path.join( os.path.dirname(__file__), "..", "src", "vocalinux", "ui", "settings_dialog.py", ) with open(source_path, "r") as f: source_code = f.read() self.assertIn('Gtk.Button(label="Reset to Defaults")', source_code) self.assertIn('"clicked", self._on_reset_advanced_clicked', source_code) self.assertIn("def _on_reset_advanced_clicked(self, widget):", source_code) self.assertIn('defaults = DEFAULT_CONFIG["advanced"]', source_code) self.assertIn("self.advanced_reset_button", source_code) self.assertIn( "action_area.set_child_secondary(self.advanced_reset_button, True)", source_code ) self.assertNotIn("reset_box.pack_start(self.advanced_reset_button", source_code) def test_advanced_reset_button_is_contextual_footer_action(self): import os source_path = os.path.join( os.path.dirname(__file__), "..", "src", "vocalinux", "ui", "settings_dialog.py", ) with open(source_path, "r") as f: source_code = f.read() self.assertIn("self.advanced_page_num = notebook.append_page", source_code) self.assertIn( 'notebook.connect("switch-page", self._on_settings_page_switched)', source_code ) self.assertIn("def _update_advanced_reset_button_visibility", source_code) self.assertIn( "self.advanced_reset_button.set_visible(page_num == self.advanced_page_num)", source_code, ) def test_advanced_panel_omits_unsupported_non_speech_token_setting(self): import os source_path = os.path.join( os.path.dirname(__file__), "..", "src", "vocalinux", "ui", "settings_dialog.py", ) with open(source_path, "r") as f: source_code = f.read() self.assertNotIn("Suppress Non-Speech Tokens", source_code) self.assertNotIn("advanced_suppress_nst_switch", source_code) def test_close_button_uses_dialog_padding(self): import os source_path = os.path.join( os.path.dirname(__file__), "..", "src", "vocalinux", "ui", "settings_dialog.py", ) with open(source_path, "r") as f: source_code = f.read() self.assertIn("action_area = self.get_action_area()", source_code) self.assertIn("action_area.set_margin_start(16)", source_code) self.assertIn("action_area.set_margin_end(16)", source_code) def test_advanced_disclaimer_appears_before_controls(self): import os source_path = os.path.join( os.path.dirname(__file__), "..", "src", "vocalinux", "ui", "settings_dialog.py", ) with open(source_path, "r") as f: source_code = f.read() self.assertLess( source_code.index("controls_box.pack_start(info_box"), source_code.index("controls_box.pack_start(group"), ) def test_remote_api_section_in_speech_engine_tab(self): import os source_path = os.path.join( os.path.dirname(__file__), "..", "src", "vocalinux", "ui", "settings_dialog.py", ) with open(source_path, "r") as f: source_code = f.read() self.assertIn("self.content_box.pack_start(self.remote_server_group", source_code) self.assertIn("self.content_box.pack_start(self.remote_status_label", source_code) self.assertNotIn("advanced_tab.pack_start(self.remote_server_group", source_code) self.assertNotIn("advanced_tab.pack_start(self.remote_status_label", source_code) self.assertNotIn("self.use_remote_switch", source_code) def test_connection_test_uses_session(self): import os source_path = os.path.join( os.path.dirname(__file__), "..", "src", "vocalinux", "ui", "settings_dialog.py", ) with open(source_path, "r") as f: source_code = f.read() self.assertIn("session = requests.Session()", source_code) self.assertIn("session.close()", source_code) class TestSettingsDialogHelperFunctions(unittest.TestCase): """Test cases for settings dialog helper functions.""" def setUp(self): """Set up test fixtures.""" if "vocalinux.ui.settings_dialog" in sys.modules: del sys.modules["vocalinux.ui.settings_dialog"] def test_format_size_function_exists(self): """Test that _format_size function exists.""" from vocalinux.ui.settings_dialog import _format_size self.assertTrue(callable(_format_size)) def test_format_size_mb(self): """Test _format_size with MB values.""" from vocalinux.ui.settings_dialog import _format_size self.assertEqual(_format_size(100), "100 MB") self.assertEqual(_format_size(500), "500 MB") def test_format_size_gb(self): """Test _format_size with GB values.""" from vocalinux.ui.settings_dialog import _format_size self.assertEqual(_format_size(1000), "1.0 GB") self.assertEqual(_format_size(2500), "2.5 GB") def test_is_whisper_model_downloaded_function_exists(self): """Test that _is_whisper_model_downloaded function exists.""" from vocalinux.ui.settings_dialog import _is_whisper_model_downloaded self.assertTrue(callable(_is_whisper_model_downloaded)) def test_is_vosk_model_downloaded_function_exists(self): """Test that _is_vosk_model_downloaded function exists.""" from vocalinux.ui.settings_dialog import _is_vosk_model_downloaded self.assertTrue(callable(_is_vosk_model_downloaded)) def test_get_recommended_whisper_model_function_exists(self): """Test that _get_recommended_whisper_model function exists.""" from vocalinux.ui.settings_dialog import _get_recommended_whisper_model self.assertTrue(callable(_get_recommended_whisper_model)) def test_get_recommended_vosk_model_function_exists(self): """Test that _get_recommended_vosk_model function exists.""" from vocalinux.ui.settings_dialog import _get_recommended_vosk_model self.assertTrue(callable(_get_recommended_vosk_model)) def test_whispercpp_settings_use_size_buckets(self): """Test that whisper.cpp settings split size from specialization.""" from vocalinux.ui.settings_dialog import ENGINE_MODELS, WHISPERCPP_MODEL_INFO self.assertEqual( ENGINE_MODELS["whisper_cpp"], ["tiny", "base", "small", "medium", "large"], ) self.assertIn("large-v3-turbo", WHISPERCPP_MODEL_INFO) self.assertIn("large-v3-turbo-q5_0", WHISPERCPP_MODEL_INFO) self.assertNotIn("small.en-tdrz", WHISPERCPP_MODEL_INFO) def test_model_display_name_large_v3_turbo(self): """Test display labels for whisper.cpp model variants.""" from vocalinux.ui.settings_dialog import _model_display_name self.assertEqual(_model_display_name("large"), "Large v3") self.assertEqual(_model_display_name("large-v3-turbo"), "Large v3 Turbo") self.assertEqual(_model_display_name("large-v3-turbo-q5_0"), "Large v3 Turbo Q5_0") self.assertEqual(_model_display_name("tiny.en-q5_1"), "Tiny EN Q5_1") def test_model_specialization_display_name(self): """Test concise specialization labels for the second whisper.cpp dropdown.""" from vocalinux.ui.settings_dialog import _model_specialization_display_name self.assertEqual(_model_specialization_display_name("medium"), "Standard multilingual") self.assertEqual(_model_specialization_display_name("medium.en"), "English-only") self.assertEqual( _model_specialization_display_name("medium.en-q5_0"), "English-only Q5_0", ) self.assertEqual(_model_specialization_display_name("large"), "Standard v3") self.assertEqual(_model_specialization_display_name("large-v3-turbo"), "Turbo") self.assertEqual(_model_specialization_display_name("large-v2-q5_0"), "v2 Q5_0") self.assertEqual(_model_specialization_display_name("large-v3-q5_0"), "v3 Q5_0") def test_model_picker_tooltips_explain_when_to_choose_variants(self): """Test hover guidance for model picker choices.""" from vocalinux.ui.settings_dialog import ( LANGUAGE_TOOLTIP, MODEL_SIZE_TOOLTIP, MODEL_SPECIALIZATION_TOOLTIP, _model_specialization_tooltip, ) self.assertIn("largest model", MODEL_SIZE_TOOLTIP) self.assertIn("Standard multilingual", MODEL_SPECIALIZATION_TOOLTIP) self.assertIn("English-only", LANGUAGE_TOOLTIP) self.assertIn("only in English", _model_specialization_tooltip("medium.en")) self.assertIn("lower-memory systems", _model_specialization_tooltip("medium-q5_0")) self.assertIn("Turbo", _model_specialization_tooltip("large-v3-turbo")) self.assertIn("legacy large model", _model_specialization_tooltip("large-v2")) self.assertIn("most users", _model_specialization_tooltip("small")) def test_model_picker_rows_have_hover_tooltips(self): """Test that model picker rows expose the guidance as hover text.""" import os source_path = os.path.join( os.path.dirname(__file__), "..", "src", "vocalinux", "ui", "settings_dialog.py", ) with open(source_path, "r") as f: source_code = f.read() self.assertIn("self.model_combo.set_tooltip_text(MODEL_SIZE_TOOLTIP)", source_code) self.assertIn("self.model_row.set_tooltip_text(MODEL_SIZE_TOOLTIP)", source_code) self.assertIn( "self.model_variant_row.set_tooltip_text(specialization_tooltip)", source_code, ) self.assertIn("self.language_row.set_tooltip_text(LANGUAGE_TOOLTIP)", source_code) def test_whispercpp_recommendation_uses_language_for_specialization(self): """Test that English language nudges recommendations to .en variants.""" from vocalinux.ui.settings_dialog import ( _default_whispercpp_variant_for_size, _recommended_whispercpp_variant_for_language, ) self.assertEqual( _recommended_whispercpp_variant_for_language( "medium", "mock hardware reason", "en-us", ), ("medium.en", "mock hardware reason; English language selected"), ) self.assertEqual(_default_whispercpp_variant_for_size("medium", "en-us"), "medium.en") self.assertEqual( _recommended_whispercpp_variant_for_language( "medium", "mock hardware reason", "auto", ), ("medium", "mock hardware reason"), ) self.assertEqual(_default_whispercpp_variant_for_size("medium", "auto"), "medium") if __name__ == "__main__": unittest.main()