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
+373
View File
@@ -0,0 +1,373 @@
"""
Tests for keyboard backends __init__.py module.
This module tests:
- DesktopEnvironment.detect() for all cases (wayland, x11, unknown, fallback env vars)
- create_backend() for all branches (preferred evdev, preferred pynput, unknown preferred,
wayland auto, x11 auto, no backends)
- Mocking EVDEV_AVAILABLE, PYNPUT_AVAILABLE, and backend classes
"""
import os
import sys
from unittest.mock import MagicMock, Mock, patch
import pytest
# Import the module under test
import vocalinux.ui.keyboard_backends as kb_module
from vocalinux.ui.keyboard_backends import (
EVDEV_AVAILABLE,
PYNPUT_AVAILABLE,
DesktopEnvironment,
create_backend,
)
class TestDesktopEnvironmentDetect:
"""Test DesktopEnvironment.detect() method."""
def test_detect_xdg_session_type_wayland(self):
"""Test detection of Wayland via XDG_SESSION_TYPE."""
with patch.dict(os.environ, {"XDG_SESSION_TYPE": "wayland"}, clear=False):
result = DesktopEnvironment.detect()
assert result == DesktopEnvironment.WAYLAND
def test_detect_xdg_session_type_x11(self):
"""Test detection of X11 via XDG_SESSION_TYPE."""
with patch.dict(os.environ, {"XDG_SESSION_TYPE": "x11"}, clear=False):
result = DesktopEnvironment.detect()
assert result == DesktopEnvironment.X11
def test_detect_xdg_session_type_case_insensitive(self):
"""Test that XDG_SESSION_TYPE detection is case-insensitive."""
with patch.dict(os.environ, {"XDG_SESSION_TYPE": "WAYLAND"}, clear=False):
result = DesktopEnvironment.detect()
assert result == DesktopEnvironment.WAYLAND
def test_detect_xdg_session_type_mixed_case(self):
"""Test that XDG_SESSION_TYPE detection handles mixed case."""
with patch.dict(os.environ, {"XDG_SESSION_TYPE": "Wayland"}, clear=False):
result = DesktopEnvironment.detect()
assert result == DesktopEnvironment.WAYLAND
def test_detect_wayland_display_env_var(self):
"""Test detection of Wayland via WAYLAND_DISPLAY env var (fallback)."""
env = {
"WAYLAND_DISPLAY": "wayland-0",
}
with patch.dict(os.environ, env, clear=True):
result = DesktopEnvironment.detect()
assert result == DesktopEnvironment.WAYLAND
def test_detect_display_env_var(self):
"""Test detection of X11 via DISPLAY env var (fallback)."""
env = {
"DISPLAY": ":0",
}
with patch.dict(os.environ, env, clear=True):
result = DesktopEnvironment.detect()
assert result == DesktopEnvironment.X11
def test_detect_wayland_display_priority_over_display(self):
"""Test that WAYLAND_DISPLAY takes priority over DISPLAY."""
env = {
"WAYLAND_DISPLAY": "wayland-0",
"DISPLAY": ":0",
}
with patch.dict(os.environ, env, clear=True):
result = DesktopEnvironment.detect()
assert result == DesktopEnvironment.WAYLAND
def test_detect_xdg_session_type_priority_over_env_vars(self):
"""Test that XDG_SESSION_TYPE takes priority over WAYLAND_DISPLAY/DISPLAY."""
env = {
"XDG_SESSION_TYPE": "x11",
"WAYLAND_DISPLAY": "wayland-0",
}
with patch.dict(os.environ, env, clear=True):
result = DesktopEnvironment.detect()
assert result == DesktopEnvironment.X11
def test_detect_unknown_no_env_vars(self):
"""Test detection returns unknown when no env vars are set."""
with patch.dict(os.environ, {}, clear=True):
result = DesktopEnvironment.detect()
assert result == DesktopEnvironment.UNKNOWN
def test_detect_unknown_xdg_session_type_unknown(self):
"""Test detection returns unknown for unknown XDG_SESSION_TYPE."""
with patch.dict(os.environ, {"XDG_SESSION_TYPE": "unknown_session"}, clear=True):
result = DesktopEnvironment.detect()
assert result == DesktopEnvironment.UNKNOWN
def test_constants_defined(self):
"""Test that DesktopEnvironment constants are defined."""
assert DesktopEnvironment.X11 == "x11"
assert DesktopEnvironment.WAYLAND == "wayland"
assert DesktopEnvironment.UNKNOWN == "unknown"
class TestCreateBackendPreferred:
"""Test create_backend() with preferred backend specified."""
def test_create_backend_preferred_evdev_available_and_usable(self):
"""Test preferred evdev backend when available and usable."""
mock_evdev_backend = MagicMock()
mock_evdev_backend.is_available.return_value = True
with patch("vocalinux.ui.keyboard_backends.EVDEV_AVAILABLE", True):
with patch(
"vocalinux.ui.keyboard_backends.EvdevKeyboardBackend",
return_value=mock_evdev_backend,
):
result = create_backend(preferred_backend="evdev")
assert result == mock_evdev_backend
mock_evdev_backend.is_available.assert_called_once()
def test_create_backend_preferred_evdev_not_available(self):
"""Test preferred evdev backend when module not available."""
with patch("vocalinux.ui.keyboard_backends.EVDEV_AVAILABLE", False):
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", False):
result = create_backend(preferred_backend="evdev")
assert result is None
def test_create_backend_preferred_evdev_available_but_not_usable(self):
"""Test preferred evdev backend when available but not usable."""
mock_evdev_backend = MagicMock()
mock_evdev_backend.is_available.return_value = False
mock_evdev_backend.get_permission_hint.return_value = "Permission denied"
with patch("vocalinux.ui.keyboard_backends.EVDEV_AVAILABLE", True):
with patch(
"vocalinux.ui.keyboard_backends.EvdevKeyboardBackend",
return_value=mock_evdev_backend,
):
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", False):
result = create_backend(preferred_backend="evdev")
assert result is None
def test_create_backend_preferred_pynput_available(self):
"""Test preferred pynput backend when available."""
mock_pynput_backend = MagicMock()
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", True):
with patch(
"vocalinux.ui.keyboard_backends.PynputKeyboardBackend",
return_value=mock_pynput_backend,
):
result = create_backend(preferred_backend="pynput")
assert result == mock_pynput_backend
def test_create_backend_preferred_pynput_not_available(self):
"""Test preferred pynput backend when not available."""
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", False):
with patch("vocalinux.ui.keyboard_backends.EVDEV_AVAILABLE", False):
result = create_backend(preferred_backend="pynput")
assert result is None
def test_create_backend_preferred_unknown_backend(self):
"""Test create_backend with unknown preferred backend."""
with patch("vocalinux.ui.keyboard_backends.EVDEV_AVAILABLE", False):
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", False):
result = create_backend(preferred_backend="unknown_backend")
assert result is None
def test_create_backend_preferred_with_custom_shortcut(self):
"""Test that shortcut parameter is passed to backend."""
mock_pynput_backend = MagicMock()
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", True):
with patch(
"vocalinux.ui.keyboard_backends.PynputKeyboardBackend",
return_value=mock_pynput_backend,
) as mock_constructor:
result = create_backend(
preferred_backend="pynput", shortcut="alt+alt", mode="push_to_talk"
)
mock_constructor.assert_called_once_with(shortcut="alt+alt", mode="push_to_talk")
assert result == mock_pynput_backend
def test_create_backend_preferred_with_custom_mode(self):
"""Test that mode parameter is passed to backend."""
mock_evdev_backend = MagicMock()
mock_evdev_backend.is_available.return_value = True
with patch("vocalinux.ui.keyboard_backends.EVDEV_AVAILABLE", True):
with patch(
"vocalinux.ui.keyboard_backends.EvdevKeyboardBackend",
return_value=mock_evdev_backend,
) as mock_constructor:
result = create_backend(preferred_backend="evdev", mode="push_to_talk")
mock_constructor.assert_called_once()
call_kwargs = mock_constructor.call_args[1]
assert call_kwargs["mode"] == "push_to_talk"
class TestCreateBackendAutoDetect:
"""Test create_backend() with auto-detection based on desktop environment."""
def test_create_backend_wayland_evdev_available_and_usable(self):
"""Test Wayland environment auto-selects evdev when available."""
mock_evdev_backend = MagicMock()
mock_evdev_backend.is_available.return_value = True
with patch.dict(os.environ, {"XDG_SESSION_TYPE": "wayland"}, clear=True):
with patch("vocalinux.ui.keyboard_backends.EVDEV_AVAILABLE", True):
with patch(
"vocalinux.ui.keyboard_backends.EvdevKeyboardBackend",
return_value=mock_evdev_backend,
):
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", False):
result = create_backend()
assert result == mock_evdev_backend
def test_create_backend_wayland_evdev_not_available(self):
"""Test Wayland returns None when evdev not available."""
with patch.dict(os.environ, {"XDG_SESSION_TYPE": "wayland"}, clear=True):
with patch("vocalinux.ui.keyboard_backends.EVDEV_AVAILABLE", False):
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", False):
result = create_backend()
assert result is None
def test_create_backend_wayland_evdev_available_but_not_usable(self):
"""Test Wayland returns None when evdev not usable."""
mock_evdev_backend = MagicMock()
mock_evdev_backend.is_available.return_value = False
mock_evdev_backend.get_permission_hint.return_value = "Permission denied"
with patch.dict(os.environ, {"XDG_SESSION_TYPE": "wayland"}, clear=True):
with patch("vocalinux.ui.keyboard_backends.EVDEV_AVAILABLE", True):
with patch(
"vocalinux.ui.keyboard_backends.EvdevKeyboardBackend",
return_value=mock_evdev_backend,
):
result = create_backend()
assert result is None
def test_create_backend_x11_pynput_available(self):
"""Test X11 environment auto-selects pynput."""
mock_pynput_backend = MagicMock()
with patch.dict(os.environ, {"XDG_SESSION_TYPE": "x11"}, clear=True):
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", True):
with patch(
"vocalinux.ui.keyboard_backends.PynputKeyboardBackend",
return_value=mock_pynput_backend,
):
result = create_backend()
assert result == mock_pynput_backend
def test_create_backend_x11_pynput_not_available_evdev_available(self):
"""Test X11 falls back to evdev when pynput not available."""
mock_evdev_backend = MagicMock()
mock_evdev_backend.is_available.return_value = True
with patch.dict(os.environ, {"XDG_SESSION_TYPE": "x11"}, clear=True):
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", False):
with patch("vocalinux.ui.keyboard_backends.EVDEV_AVAILABLE", True):
with patch(
"vocalinux.ui.keyboard_backends.EvdevKeyboardBackend",
return_value=mock_evdev_backend,
):
result = create_backend()
assert result == mock_evdev_backend
def test_create_backend_unknown_env_pynput_available(self):
"""Test unknown environment defaults to pynput."""
mock_pynput_backend = MagicMock()
with patch.dict(os.environ, {}, clear=True):
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", True):
with patch(
"vocalinux.ui.keyboard_backends.PynputKeyboardBackend",
return_value=mock_pynput_backend,
):
result = create_backend()
assert result == mock_pynput_backend
def test_create_backend_unknown_env_no_backends(self):
"""Test unknown environment returns None when no backends available."""
with patch.dict(os.environ, {}, clear=True):
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", False):
with patch("vocalinux.ui.keyboard_backends.EVDEV_AVAILABLE", False):
result = create_backend()
assert result is None
def test_create_backend_no_backends_available(self):
"""Test create_backend returns None when no backends available at all."""
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", False):
with patch("vocalinux.ui.keyboard_backends.EVDEV_AVAILABLE", False):
result = create_backend()
assert result is None
def test_create_backend_with_custom_parameters(self):
"""Test that custom parameters are passed to auto-selected backend."""
mock_pynput_backend = MagicMock()
with patch.dict(os.environ, {"XDG_SESSION_TYPE": "x11"}, clear=True):
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", True):
with patch(
"vocalinux.ui.keyboard_backends.PynputKeyboardBackend",
return_value=mock_pynput_backend,
) as mock_constructor:
result = create_backend(shortcut="alt+alt", mode="push_to_talk")
mock_constructor.assert_called_once_with(
shortcut="alt+alt", mode="push_to_talk"
)
def test_create_backend_default_parameters(self):
"""Test that default parameters are used when not specified."""
mock_pynput_backend = MagicMock()
with patch.dict(os.environ, {"XDG_SESSION_TYPE": "x11"}, clear=True):
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", True):
with patch(
"vocalinux.ui.keyboard_backends.PynputKeyboardBackend",
return_value=mock_pynput_backend,
) as mock_constructor:
result = create_backend()
# Check that the constructor was called with some default shortcut/mode
mock_constructor.assert_called_once()
call_kwargs = mock_constructor.call_args[1]
# Shortcut and mode should be passed as defaults
assert "shortcut" in call_kwargs
assert "mode" in call_kwargs
class TestCreateBackendFallback:
"""Test create_backend() fallback scenarios."""
def test_create_backend_pynput_not_available_evdev_available_not_usable(self):
"""Test fallback to evdev when pynput unavailable and evdev not usable."""
mock_evdev_backend = MagicMock()
mock_evdev_backend.is_available.return_value = False
mock_evdev_backend.get_permission_hint.return_value = "Permission denied"
with patch.dict(os.environ, {"XDG_SESSION_TYPE": "x11"}, clear=True):
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", False):
with patch("vocalinux.ui.keyboard_backends.EVDEV_AVAILABLE", True):
with patch(
"vocalinux.ui.keyboard_backends.EvdevKeyboardBackend",
return_value=mock_evdev_backend,
):
result = create_backend()
assert result is None
def test_create_backend_wayland_preferred_pynput_fails_evdev_available(self):
"""Test that preferred pynput on Wayland fails and then tries evdev."""
# When preferred_backend is pynput and Wayland is detected,
# if pynput is not available, it falls back to auto-detection which tries evdev
mock_evdev_backend = MagicMock()
mock_evdev_backend.is_available.return_value = True
with patch.dict(os.environ, {"XDG_SESSION_TYPE": "wayland"}, clear=True):
with patch("vocalinux.ui.keyboard_backends.PYNPUT_AVAILABLE", False):
with patch("vocalinux.ui.keyboard_backends.EVDEV_AVAILABLE", True):
with patch(
"vocalinux.ui.keyboard_backends.EvdevKeyboardBackend",
return_value=mock_evdev_backend,
):
result = create_backend(preferred_backend="pynput")
# Falls back to auto-detection which selects evdev on Wayland
assert result == mock_evdev_backend