test(coverage): improve test coverage from 57% to 80%+ (#327)

* test(coverage): improve test coverage from 57% to 80%+

Add 30 new test files with 861 additional test cases to improve
overall test coverage from 57% to 80%+ (statement coverage).

Key modules covered:
- recognition_manager.py: 43% → 69% (audio device detection, transcription,
  model download, engine initialization, buffer management)
- text_injector.py: improved coverage for X11/Wayland text injection,
  environment detection, clipboard fallback, shortcut injection
- ibus_engine.py: 22% → 73% (engine lifecycle, text injection, socket server)
- evdev_backend.py: 11% → 78% (device detection, key event handling)
- pynput_backend.py: 43% → 76% (start/stop, key handling, callbacks)
- keyboard_backends/__init__.py: 54% → improved (backend creation, env detection)
- whispercpp_model_info.py: 32% → improved (GPU detection, model recommendations)
- about_dialog.py, first_run_dialog.py, main.py, single_instance.py,
  common_types.py, config_manager.py, autostart_manager.py: various improvements

All 1433 tests pass with proper test isolation to prevent mock pollution
between test modules.

* test(quality): audit and fix test quality issues

Code review audit identified and fixed the following issues:

- Remove bare try/except blocks that swallow all errors (7 tests fixed
  in recognition_manager_deep, replaced with proper assertions or deleted)
- Delete source code inspection tests that read .py files as strings
  instead of testing behavior (deleted test_about_dialog_coverage.py and
  test_first_run_dialog_coverage.py entirely - ~35 useless tests removed)
- Add meaningful assertions replacing weak assertIsNotNone/assertIsInstance
  checks (common_types_coverage, ibus_engine_coverage, keyboard_backends_extra)
- Fix tests that mock the system under test instead of its dependencies
  (text_injector_extra now mocks subprocess.run instead of injection methods)
- Add missing assertions to tests with no verification
  (ibus_engine focus_out, log window info, copy to clipboard)
- Verify download tests check requests.get was called with correct URLs
  (coverage_boost download tests)
- Fix pytest warning by renaming test_audio_input import to avoid
  pytest collecting it as a test function

All 1356 tests pass with 0 failures and 0 warnings.
Statement coverage: 80.3% (3257/4054 lines covered).

* style(tests): fix black formatting and isort import ordering

Auto-format all new test files with black and isort to pass CI lint checks.

* fix(tests): resolve CI hangs and rename test files for clarity

- Fix CI hangs by properly mocking gi/GTK/IBus in all test files
- Fix sys.modules pollution in recognition manager tests by using tmp_path
- Add pytest-timeout to prevent future hangs
- Rename 28 test files to use descriptive, consistent names mapping to source modules

* fix(tests): resolve Python 3.13 CI failures

- Fix _load_stdlib_module() in test_recognition_manager_downloads.py to
  handle stdlib modules that are packages (directories with __init__.py)
  rather than single .py files. In Python 3.13, zipfile became a package,
  causing FileNotFoundError during test collection (exit code 2).

- Fix invalid escape sequence '$' in test_cross_distro_compatibility.py
  by using a raw string. Python 3.13 reports this as SyntaxWarning and
  Python 3.14 will make it a SyntaxError.

* fix(tests): use direct import for zipfile instead of _load_stdlib_module

The _load_stdlib_module approach fails on Python 3.13 where zipfile is a
package (zipfile/__init__.py). Loading it via spec_from_file_location with
a custom name breaks relative imports inside the package (e.g.
'from ._path import ...' resolves to '_stdlib_zipfile._path' which doesn't
exist).

Simply import zipfile at module level before any test mocks can pollute
sys.modules — this is safe because the module-level code runs during test
collection, before any test fixtures or patches are applied.

* fix(tests): mock gi/GTK in conftest to prevent CI hangs

On CI, real PyGObject is installed and module-level imports in vocalinux
source files (ibus_engine, tray_indicator, settings_dialog, etc.) trigger
GTK initialization or IBus daemon connections that hang indefinitely in
headless environments. pytest-timeout's signal-based timeout cannot
interrupt these C-level blocking calls.

Fix by mocking gi and gi.repository in conftest.py (which runs before any
test module is collected), ensuring all test files are protected regardless
of whether they remember to mock individually.

Also add timeout-minutes: 10 to the CI test job as a safety net so that
any remaining hangs fail fast instead of running indefinitely.

* fix(tests): unconditionally mock gi in conftest for CI

The previous 'if gi not in sys.modules' guard was ineffective on CI
because PyGObject is installed via pip, so the real gi module is already
loaded. This caused GTK initialization and IBus daemon connections that
hang indefinitely in headless CI environments.

Now unconditionally replace gi and gi.repository with mocks during test
collection, regardless of whether the real package is installed.

* fix(tests): reduce timeout to 10s and use thread-based timeout

Use timeout_method=thread instead of signal (default) so that
pytest-timeout can interrupt C-level blocking calls (GTK operations,
socket accepts, subprocess waits) that the signal-based method cannot
handle. Also reduce per-test timeout from 30s to 10s since no legitimate
unit test should take longer, and hanging tests were consuming the entire
CI job timeout budget.

* fix(tests): set global socket timeout to prevent blocking on CI

Tests in test_ibus_engine.py create real Unix sockets with daemon threads
that block on socket.accept(). When tests fail or timeout, these threads
remain blocked indefinitely, preventing pytest from completing. The
thread-based timeout catches the hang but cannot terminate the blocking
accept() call.

Set socket.setdefaulttimeout(5) in conftest.py so all socket operations
(accept, connect, recv) will raise socket.timeout after 5 seconds instead
of blocking forever.

* fix(tests): add cleanup fixture for IBus socket server threads

Add autouse fixture that stops any leftover VocalinuxEngine socket server
threads after each test. Tests that trigger _start_socket_server() spawn
daemon threads blocking on socket.accept() that persist after the test
completes, eventually causing pytest-timeout to kill the process.

The cleanup fixture sets _server_running=False and closes the server
socket, which unblocks the accept() call and allows the daemon thread
to terminate.

* fix(tests): reduce socket timeout to 0.1s to avoid slowing tests

The 5-second socket timeout caused socket operations in daemon threads
to block for 5 seconds per iteration before timing out, significantly
slowing the test suite on CI. Reduce to 0.1s so blocking socket calls
fail fast without noticeably impacting test execution time.

* fix(tests): use 2s socket timeout and increase CI timeout to 15min

The 0.1s socket timeout was too aggressive and caused legitimate test
socket operations to fail. Use 2s which is long enough for test sockets
to work but short enough to unblock daemon threads.

Increase CI job timeout to 15 minutes to accommodate the socket timeout
overhead from daemon threads that retry every 2 seconds.

* fix(tests): block known-blocking daemon threads to prevent CI hangs

Instead of using socket timeouts (which either break tests or are too
slow), prevent specific known-blocking daemon threads from starting:
- ibus_engine.server_thread: blocks on socket.accept()
- evdev_backend._monitor_devices: blocks on select.select()

These threads are identified by their target function name and skipped
during Thread.start(). The thread is marked as started/stopped so
join() calls in cleanup code don't raise RuntimeError.

Test-created daemon threads (e.g. mock socket servers) are unaffected
since they use different target function names.

* fix(tests): patch Thread.join for Python 3.13 compatibility

Python 3.13 changed threading internals — join() now uses _handle.join()
which raises 'thread not started' for threads that were never actually
started. Instead of trying to fake internal state, patch join() to be a
no-op for threads that were skipped by our _safe_thread_start guard.

This fixes the 2 remaining test_evdev_backend_ext failures on Python 3.13.
This commit is contained in:
Jatin K Malik
2026-03-17 14:05:16 -07:00
committed by GitHub
parent 9c16ab0aad
commit fa4da40e7b
32 changed files with 12708 additions and 2 deletions
+378
View File
@@ -0,0 +1,378 @@
"""
Final comprehensive tests for IBus engine.
These tests exercise code paths to improve coverage without platform-specific issues.
"""
import subprocess
import sys
import unittest
from unittest.mock import MagicMock, patch
# Mock GI imports before importing any vocalinux modules that use gi.
# On CI, real gi/IBus may be installed; importing ibus_engine without mocks
# would set IBUS_AVAILABLE=True and VocalinuxEngine would inherit from real
# IBus.Engine, causing hangs when super().__init__() tries to connect to IBus.
_mock_gi = MagicMock()
_mock_ibus = MagicMock()
_mock_glib = MagicMock()
_mock_gobject = MagicMock()
_mock_ibus.Engine = MagicMock
_mock_glib.MainLoop = MagicMock
_mock_gi_repo = MagicMock()
_mock_gi_repo.IBus = _mock_ibus
_mock_gi_repo.GLib = _mock_glib
_mock_gi_repo.GObject = _mock_gobject
sys.modules["gi"] = _mock_gi
sys.modules["gi.repository"] = _mock_gi_repo
# Force reload ibus_engine so it picks up mocks (in case it was already imported)
for _key in list(sys.modules.keys()):
if "vocalinux" in _key and "ibus_engine" in _key:
del sys.modules[_key]
class TestIBusSetupError(unittest.TestCase):
"""Tests for IBusSetupError exception."""
def test_ibus_setup_error_is_runtime_error(self):
"""Test that IBusSetupError is a RuntimeError."""
from vocalinux.text_injection.ibus_engine import IBusSetupError
self.assertTrue(issubclass(IBusSetupError, RuntimeError))
def test_ibus_setup_error_accepts_message(self):
"""Test that IBusSetupError accepts a message."""
from vocalinux.text_injection.ibus_engine import IBusSetupError
msg = "Test error message"
error = IBusSetupError(msg)
self.assertEqual(str(error), msg)
class TestEnsureIBusDir(unittest.TestCase):
"""Tests for ensure_ibus_dir function."""
@patch("pathlib.Path.mkdir")
@patch("pathlib.Path.chmod")
def test_ensure_ibus_dir_creates_and_secures(self, mock_chmod, mock_mkdir):
"""Test that ensure_ibus_dir creates directory with proper permissions."""
from vocalinux.text_injection.ibus_engine import ensure_ibus_dir
ensure_ibus_dir()
mock_mkdir.assert_called_once_with(parents=True, exist_ok=True)
mock_chmod.assert_called_once_with(0o700)
class TestIsIBusAvailable(unittest.TestCase):
"""Tests for is_ibus_available function."""
@patch("vocalinux.text_injection.ibus_engine.IBUS_AVAILABLE", True)
def test_is_ibus_available_true(self):
"""Test is_ibus_available when IBus is available."""
from vocalinux.text_injection.ibus_engine import is_ibus_available
result = is_ibus_available()
# Verify the function returns True when IBUS_AVAILABLE flag is True
self.assertTrue(result)
# Verify it's checking the flag, not just always returning a value
self.assertEqual(result, True)
@patch("vocalinux.text_injection.ibus_engine.IBUS_AVAILABLE", False)
def test_is_ibus_available_false(self):
"""Test is_ibus_available when IBus is not available."""
from vocalinux.text_injection.ibus_engine import is_ibus_available
result = is_ibus_available()
self.assertFalse(result)
class TestIsIBusDaemonRunning(unittest.TestCase):
"""Tests for is_ibus_daemon_running function."""
@patch("subprocess.run")
def test_is_ibus_daemon_running_true(self, mock_run):
"""Test is_ibus_daemon_running returns True when daemon is running."""
from vocalinux.text_injection.ibus_engine import is_ibus_daemon_running
mock_run.return_value.returncode = 0
result = is_ibus_daemon_running()
self.assertTrue(result)
@patch("subprocess.run")
def test_is_ibus_daemon_running_false(self, mock_run):
"""Test is_ibus_daemon_running returns False when daemon is not running."""
from vocalinux.text_injection.ibus_engine import is_ibus_daemon_running
mock_run.return_value.returncode = 1
result = is_ibus_daemon_running()
self.assertFalse(result)
@patch("subprocess.run", side_effect=FileNotFoundError("pgrep not found"))
def test_is_ibus_daemon_running_file_not_found(self, mock_run):
"""Test is_ibus_daemon_running handles FileNotFoundError."""
from vocalinux.text_injection.ibus_engine import is_ibus_daemon_running
result = is_ibus_daemon_running()
self.assertFalse(result)
class TestIsIBusActiveInputMethod(unittest.TestCase):
"""Tests for is_ibus_active_input_method function."""
@patch.dict("os.environ", {"GTK_IM_MODULE": "ibus"})
def test_is_ibus_active_gtk_im_module(self):
"""Test detection via GTK_IM_MODULE."""
from vocalinux.text_injection.ibus_engine import is_ibus_active_input_method
result = is_ibus_active_input_method()
self.assertTrue(result)
@patch.dict("os.environ", {"QT_IM_MODULE": "ibus"}, clear=True)
def test_is_ibus_active_qt_im_module(self):
"""Test detection via QT_IM_MODULE."""
from vocalinux.text_injection.ibus_engine import is_ibus_active_input_method
result = is_ibus_active_input_method()
self.assertTrue(result)
@patch.dict("os.environ", {"XMODIFIERS": "@im=ibus"}, clear=True)
def test_is_ibus_active_xmodifiers(self):
"""Test detection via XMODIFIERS."""
from vocalinux.text_injection.ibus_engine import is_ibus_active_input_method
result = is_ibus_active_input_method()
self.assertTrue(result)
@patch.dict("os.environ", {}, clear=True)
def test_is_ibus_active_not_active(self):
"""Test when IBus is not the active input method."""
from vocalinux.text_injection.ibus_engine import is_ibus_active_input_method
result = is_ibus_active_input_method()
self.assertFalse(result)
class TestStartIBusDaemon(unittest.TestCase):
"""Tests for start_ibus_daemon function."""
@patch("vocalinux.text_injection.ibus_engine.is_ibus_daemon_running")
def test_start_ibus_daemon_already_running(self, mock_is_running):
"""Test when daemon is already running."""
from vocalinux.text_injection.ibus_engine import start_ibus_daemon
mock_is_running.return_value = True
result = start_ibus_daemon()
self.assertTrue(result)
@patch("vocalinux.text_injection.ibus_engine.is_ibus_available")
@patch("vocalinux.text_injection.ibus_engine.is_ibus_daemon_running")
def test_start_ibus_daemon_not_available(self, mock_is_running, mock_available):
"""Test when IBus is not available."""
from vocalinux.text_injection.ibus_engine import start_ibus_daemon
mock_is_running.return_value = False
mock_available.return_value = False
result = start_ibus_daemon()
self.assertFalse(result)
class TestGetExpectedComponentXml(unittest.TestCase):
"""Tests for _get_expected_component_xml function."""
def test_get_expected_component_xml_returns_string(self):
"""Test that function returns valid XML string."""
from vocalinux.text_injection.ibus_engine import _get_expected_component_xml
result = _get_expected_component_xml()
self.assertIsInstance(result, str)
self.assertIn("<?xml", result)
self.assertIn("</component>", result)
def test_get_expected_component_xml_contains_vocalinux(self):
"""Test that XML contains Vocalinux references."""
from vocalinux.text_injection.ibus_engine import _get_expected_component_xml
result = _get_expected_component_xml()
self.assertIn("vocalinux", result.lower())
class TestIsComponentUpToDate(unittest.TestCase):
"""Tests for is_component_up_to_date function."""
@patch("pathlib.Path.exists")
def test_is_component_up_to_date_not_exists(self, mock_exists):
"""Test when component file doesn't exist."""
from vocalinux.text_injection.ibus_engine import is_component_up_to_date
mock_exists.return_value = False
result = is_component_up_to_date()
self.assertFalse(result)
@patch("vocalinux.text_injection.ibus_engine._get_expected_component_xml")
@patch("pathlib.Path.read_text")
@patch("pathlib.Path.exists")
def test_is_component_up_to_date_matches(self, mock_exists, mock_read, mock_get_xml):
"""Test when XML matches."""
from vocalinux.text_injection.ibus_engine import is_component_up_to_date
xml_content = "<?xml><component></component>"
mock_exists.return_value = True
mock_read.return_value = xml_content
mock_get_xml.return_value = xml_content
result = is_component_up_to_date()
self.assertTrue(result)
@patch("vocalinux.text_injection.ibus_engine._get_expected_component_xml")
@patch("pathlib.Path.read_text")
@patch("pathlib.Path.exists")
def test_is_component_up_to_date_mismatch(self, mock_exists, mock_read, mock_get_xml):
"""Test when XML differs."""
from vocalinux.text_injection.ibus_engine import is_component_up_to_date
mock_exists.return_value = True
mock_read.return_value = "<?xml><old></old>"
mock_get_xml.return_value = "<?xml><new></new>"
result = is_component_up_to_date()
self.assertFalse(result)
class TestIsEngineRegistered(unittest.TestCase):
"""Tests for is_engine_registered function."""
@patch("vocalinux.text_injection.ibus_engine.IBUS_AVAILABLE", False)
def test_is_engine_registered_not_available(self):
"""Test when IBus is not available."""
from vocalinux.text_injection.ibus_engine import is_engine_registered
result = is_engine_registered()
self.assertFalse(result)
@patch("subprocess.run")
@patch("vocalinux.text_injection.ibus_engine.IBUS_AVAILABLE", True)
def test_is_engine_registered_true(self, mock_run):
"""Test when engine is registered."""
from vocalinux.text_injection.ibus_engine import ENGINE_NAME, is_engine_registered
mock_run.return_value.stdout = f"other\n{ENGINE_NAME}\nmore"
result = is_engine_registered()
self.assertTrue(result)
@patch("subprocess.run")
@patch("vocalinux.text_injection.ibus_engine.IBUS_AVAILABLE", True)
def test_is_engine_registered_false(self, mock_run):
"""Test when engine is not registered."""
from vocalinux.text_injection.ibus_engine import is_engine_registered
mock_run.return_value.stdout = "other\nengines"
result = is_engine_registered()
self.assertFalse(result)
class TestIsEngineActive(unittest.TestCase):
"""Tests for is_engine_active function."""
@patch("subprocess.run")
def test_is_engine_active_true(self, mock_run):
"""Test when engine is active."""
from vocalinux.text_injection.ibus_engine import ENGINE_NAME, is_engine_active
mock_run.return_value.returncode = 0
mock_run.return_value.stdout = ENGINE_NAME
result = is_engine_active()
self.assertTrue(result)
@patch("subprocess.run")
def test_is_engine_active_false(self, mock_run):
"""Test when engine is not active."""
from vocalinux.text_injection.ibus_engine import is_engine_active
mock_run.return_value.returncode = 0
mock_run.return_value.stdout = "other"
result = is_engine_active()
self.assertFalse(result)
class TestGetCurrentEngine(unittest.TestCase):
"""Tests for get_current_engine function."""
@patch("subprocess.run")
def test_get_current_engine_success(self, mock_run):
"""Test successfully retrieving current engine."""
from vocalinux.text_injection.ibus_engine import get_current_engine
mock_run.return_value.returncode = 0
mock_run.return_value.stdout = "test-engine\n"
result = get_current_engine()
self.assertEqual(result, "test-engine")
@patch("subprocess.run", side_effect=FileNotFoundError("ibus not found"))
def test_get_current_engine_not_found(self, mock_run):
"""Test when ibus command is not found."""
from vocalinux.text_injection.ibus_engine import get_current_engine
result = get_current_engine()
self.assertIsNone(result)
class TestSwitchEngine(unittest.TestCase):
"""Tests for switch_engine function."""
@patch("vocalinux.text_injection.ibus_engine.get_current_engine")
@patch("time.sleep")
@patch("subprocess.run")
def test_switch_engine_success(self, mock_run, mock_sleep, mock_get_engine):
"""Test successfully switching engines."""
from vocalinux.text_injection.ibus_engine import switch_engine
mock_get_engine.return_value = "vocalinux"
result = switch_engine("vocalinux")
self.assertTrue(result)
@patch("vocalinux.text_injection.ibus_engine.get_current_engine")
@patch("time.sleep")
@patch("subprocess.run")
def test_switch_engine_failure(self, mock_run, mock_sleep, mock_get_engine):
"""Test when engine switch fails."""
from vocalinux.text_injection.ibus_engine import switch_engine
mock_get_engine.return_value = "other"
result = switch_engine("vocalinux")
self.assertFalse(result)
class TestIsEngineProcessRunning(unittest.TestCase):
"""Tests for is_engine_process_running function."""
@patch("pathlib.Path.exists")
def test_is_engine_process_running_no_pid_file(self, mock_exists):
"""Test when PID file doesn't exist."""
from vocalinux.text_injection.ibus_engine import is_engine_process_running
mock_exists.return_value = False
result = is_engine_process_running()
self.assertFalse(result)
class TestStopEngineProcess(unittest.TestCase):
"""Tests for stop_engine_process function."""
@patch("pathlib.Path.exists")
def test_stop_engine_process_no_pid_file(self, mock_exists):
"""Test when no PID file exists."""
from vocalinux.text_injection.ibus_engine import stop_engine_process
mock_exists.return_value = False
# Should not raise any exception
result = stop_engine_process()
# Verify the function handles missing PID file gracefully
self.assertIsNone(result)
if __name__ == "__main__":
unittest.main()