Jatin K MalikandGitHub
fa4da40e7b
* 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.
201 lines
7.0 KiB
Python
201 lines
7.0 KiB
Python
"""
|
|
Tests for single_instance module.
|
|
|
|
Tests cover lock acquisition, release, PID file handling, and process checking.
|
|
"""
|
|
|
|
import fcntl
|
|
import os
|
|
import tempfile
|
|
import unittest
|
|
from pathlib import Path
|
|
from unittest.mock import MagicMock, Mock, call, mock_open, patch
|
|
|
|
import vocalinux.single_instance as single_instance_module
|
|
|
|
|
|
class TestAcquireLock(unittest.TestCase):
|
|
"""Tests for acquire_lock() function."""
|
|
|
|
def setUp(self):
|
|
"""Reset global state before each test."""
|
|
single_instance_module._lock_file = None
|
|
|
|
def tearDown(self):
|
|
"""Clean up after each test."""
|
|
single_instance_module._lock_file = None
|
|
|
|
@patch("vocalinux.single_instance._get_lock_file_fd")
|
|
@patch("os.ftruncate")
|
|
@patch("os.write")
|
|
@patch("os.lseek")
|
|
@patch("fcntl.flock")
|
|
@patch("os.getpid")
|
|
def test_acquire_lock_success(
|
|
self, mock_getpid, mock_flock, mock_lseek, mock_write, mock_ftruncate, mock_get_fd
|
|
):
|
|
"""Test successfully acquiring lock on first run."""
|
|
mock_getpid.return_value = 12345
|
|
mock_get_fd.return_value = 5
|
|
|
|
result = single_instance_module.acquire_lock()
|
|
|
|
self.assertTrue(result)
|
|
mock_flock.assert_called_once_with(5, fcntl.LOCK_EX | fcntl.LOCK_NB)
|
|
mock_ftruncate.assert_called_once_with(5, 0)
|
|
mock_write.assert_called_once_with(5, b"12345\n")
|
|
mock_lseek.assert_called_once_with(5, 0, os.SEEK_SET)
|
|
|
|
@patch("vocalinux.single_instance._get_lock_file_fd")
|
|
@patch("fcntl.flock")
|
|
def test_acquire_lock_already_running_oserror(self, mock_flock, mock_get_fd):
|
|
"""Test acquiring lock when another instance is running (OSError)."""
|
|
mock_get_fd.return_value = 5
|
|
mock_flock.side_effect = OSError("Resource temporarily unavailable")
|
|
|
|
result = single_instance_module.acquire_lock()
|
|
|
|
self.assertFalse(result)
|
|
mock_flock.assert_called_once_with(5, fcntl.LOCK_EX | fcntl.LOCK_NB)
|
|
|
|
@patch("vocalinux.single_instance._get_lock_file_fd")
|
|
@patch("fcntl.flock")
|
|
def test_acquire_lock_already_running_ioerror(self, mock_flock, mock_get_fd):
|
|
"""Test acquiring lock when another instance is running (IOError)."""
|
|
mock_get_fd.return_value = 5
|
|
mock_flock.side_effect = IOError("Device or resource busy")
|
|
|
|
result = single_instance_module.acquire_lock()
|
|
|
|
self.assertFalse(result)
|
|
|
|
@patch("vocalinux.single_instance._get_lock_file_fd")
|
|
@patch("fcntl.flock")
|
|
def test_acquire_lock_unexpected_error(self, mock_flock, mock_get_fd):
|
|
"""Test acquiring lock with unexpected error (fails open)."""
|
|
mock_get_fd.return_value = 5
|
|
mock_flock.side_effect = Exception("Unexpected error")
|
|
|
|
result = single_instance_module.acquire_lock()
|
|
|
|
# Should return True (fail open) but log error
|
|
self.assertTrue(result)
|
|
|
|
|
|
class TestReleaseLock(unittest.TestCase):
|
|
"""Tests for release_lock() function."""
|
|
|
|
def setUp(self):
|
|
"""Reset global state before each test."""
|
|
single_instance_module._lock_file = None
|
|
|
|
def tearDown(self):
|
|
"""Clean up after each test."""
|
|
single_instance_module._lock_file = None
|
|
|
|
@patch("fcntl.flock")
|
|
@patch("os.close")
|
|
def test_release_lock_success(self, mock_close, mock_flock):
|
|
"""Test successfully releasing lock."""
|
|
single_instance_module._lock_file = 5
|
|
|
|
single_instance_module.release_lock()
|
|
|
|
mock_flock.assert_called_once_with(5, fcntl.LOCK_UN)
|
|
mock_close.assert_called_once_with(5)
|
|
self.assertIsNone(single_instance_module._lock_file)
|
|
|
|
@patch("fcntl.flock")
|
|
@patch("os.close")
|
|
def test_release_lock_oserror(self, mock_close, mock_flock):
|
|
"""Test release_lock with OSError (still cleans up)."""
|
|
single_instance_module._lock_file = 5
|
|
mock_flock.side_effect = OSError("Bad file descriptor")
|
|
|
|
single_instance_module.release_lock()
|
|
|
|
# Should still clear the global state even on error
|
|
self.assertIsNone(single_instance_module._lock_file)
|
|
|
|
@patch("fcntl.flock")
|
|
@patch("os.close")
|
|
def test_release_lock_ioerror(self, mock_close, mock_flock):
|
|
"""Test release_lock with IOError (still cleans up)."""
|
|
single_instance_module._lock_file = 5
|
|
mock_flock.side_effect = IOError("I/O error")
|
|
|
|
single_instance_module.release_lock()
|
|
|
|
self.assertIsNone(single_instance_module._lock_file)
|
|
|
|
def test_release_lock_no_lock_held(self):
|
|
"""Test releasing lock when none is held."""
|
|
single_instance_module._lock_file = None
|
|
|
|
# Should not raise, just do nothing
|
|
single_instance_module.release_lock()
|
|
|
|
self.assertIsNone(single_instance_module._lock_file)
|
|
|
|
|
|
class TestGetLockFileFd(unittest.TestCase):
|
|
"""Tests for _get_lock_file_fd() function."""
|
|
|
|
def setUp(self):
|
|
"""Reset global state before each test."""
|
|
single_instance_module._lock_file = None
|
|
|
|
def tearDown(self):
|
|
"""Clean up after each test."""
|
|
single_instance_module._lock_file = None
|
|
|
|
@patch("vocalinux.single_instance.LOCK_FILE_DIR")
|
|
@patch("os.open")
|
|
def test_get_lock_file_fd_creates_directory(self, mock_os_open, mock_lock_dir):
|
|
"""Test that directory is created if it doesn't exist."""
|
|
mock_lock_dir_instance = MagicMock(spec=Path)
|
|
mock_lock_dir_instance.__truediv__ = MagicMock(return_value=MagicMock(spec=Path))
|
|
mock_lock_dir = mock_lock_dir_instance
|
|
|
|
with patch("vocalinux.single_instance.LOCK_FILE_DIR", mock_lock_dir_instance):
|
|
mock_os_open.return_value = 5
|
|
|
|
fd = single_instance_module._get_lock_file_fd()
|
|
|
|
self.assertEqual(fd, 5)
|
|
mock_os_open.assert_called_once()
|
|
|
|
@patch("vocalinux.single_instance.LOCK_FILE_DIR")
|
|
@patch("os.open")
|
|
def test_get_lock_file_fd_reuses_existing_fd(self, mock_os_open, mock_lock_dir):
|
|
"""Test that existing file descriptor is reused."""
|
|
single_instance_module._lock_file = 5
|
|
|
|
fd = single_instance_module._get_lock_file_fd()
|
|
|
|
self.assertEqual(fd, 5)
|
|
# os.open should not be called if fd already exists
|
|
mock_os_open.assert_not_called()
|
|
|
|
|
|
class TestLockFileConstants(unittest.TestCase):
|
|
"""Tests for lock file constants."""
|
|
|
|
def test_lock_file_path_is_in_home_directory(self):
|
|
"""Test that lock file is in ~/.local/share/vocalinux/."""
|
|
self.assertIn(".local", str(single_instance_module.LOCK_FILE_PATH))
|
|
self.assertIn("share", str(single_instance_module.LOCK_FILE_PATH))
|
|
self.assertIn("vocalinux", str(single_instance_module.LOCK_FILE_PATH))
|
|
|
|
def test_lock_file_path_is_path_object(self):
|
|
"""Test that lock file path is a Path object."""
|
|
self.assertIsInstance(single_instance_module.LOCK_FILE_PATH, Path)
|
|
|
|
def test_lock_file_dir_is_path_object(self):
|
|
"""Test that lock file dir is a Path object."""
|
|
self.assertIsInstance(single_instance_module.LOCK_FILE_DIR, Path)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|