Files
cthulhu/tests/test_sound_presenter.py

236 lines
8.1 KiB
Python

# Unit tests for sound_presenter.py methods.
#
# Copyright 2025 Igalia, S.L.
# Author: Joanmarie Diggs <jdiggs@igalia.com>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the
# Free Software Foundation, Inc., Franklin Street, Fifth Floor,
# Boston MA 02110-1301 USA.
# pylint: disable=wrong-import-position
# pylint: disable=import-outside-toplevel
# pylint: disable=protected-access
"""Unit tests for sound_presenter.py methods."""
from __future__ import annotations
from typing import TYPE_CHECKING
import pytest
if TYPE_CHECKING:
from unittest.mock import MagicMock
from cthulhu_test_context import CthulhuTestContext
@pytest.mark.unit
class TestSoundPresenter:
"""Test SoundPresenter class methods."""
def _setup_dependencies(self, test_context: CthulhuTestContext) -> dict[str, MagicMock]:
"""Set up mocks for sound_presenter dependencies."""
essential_modules = test_context.setup_shared_dependencies([])
debug_mock = essential_modules["cthulhu.debug"]
debug_mock.print_message = test_context.Mock()
debug_mock.LEVEL_INFO = 800
dbus_service_mock = essential_modules["cthulhu.dbus_service"]
controller_mock = test_context.Mock()
controller_mock.register_decorated_module = test_context.Mock()
dbus_service_mock.get_remote_controller = test_context.Mock(return_value=controller_mock)
dbus_service_mock.getter = lambda func: func
dbus_service_mock.setter = lambda func: func
essential_modules["controller"] = controller_mock
from cthulhu import gsettings_registry
registry = gsettings_registry.get_registry()
registry.clear_runtime_values()
return essential_modules
def test_initialization_registers_dbus_module(self, test_context: CthulhuTestContext) -> None:
"""Test that SoundPresenter registers itself with D-Bus on initialization."""
mocks = self._setup_dependencies(test_context)
from cthulhu import sound_presenter
presenter = sound_presenter.SoundPresenter()
mocks["controller"].register_decorated_module.assert_called_with(
"SoundPresenter",
presenter,
)
def test_get_sound_is_enabled_returns_setting(self, test_context: CthulhuTestContext) -> None:
"""Test get_sound_is_enabled returns the enableSound setting."""
self._setup_dependencies(test_context)
from cthulhu.sound_presenter import SoundPresenter
presenter = SoundPresenter()
assert presenter.get_sound_is_enabled() is True
presenter.set_sound_is_enabled(False)
assert presenter.get_sound_is_enabled() is False
def test_set_sound_is_enabled_updates_setting(self, test_context: CthulhuTestContext) -> None:
"""Test set_sound_is_enabled updates the enableSound setting."""
self._setup_dependencies(test_context)
from cthulhu.sound_presenter import SoundPresenter
presenter = SoundPresenter()
result = presenter.set_sound_is_enabled(False)
assert result is True
assert presenter.get_sound_is_enabled() is False
def test_get_sound_volume_returns_setting(self, test_context: CthulhuTestContext) -> None:
"""Test get_sound_volume returns the soundVolume setting."""
self._setup_dependencies(test_context)
from cthulhu.sound_presenter import SoundPresenter
presenter = SoundPresenter()
presenter.set_sound_volume(0.75)
assert presenter.get_sound_volume() == 0.75
def test_set_sound_volume_updates_setting(self, test_context: CthulhuTestContext) -> None:
"""Test set_sound_volume updates the soundVolume setting."""
self._setup_dependencies(test_context)
from cthulhu.sound_presenter import SoundPresenter
presenter = SoundPresenter()
result = presenter.set_sound_volume(0.8)
assert result is True
assert presenter.get_sound_volume() == 0.8
def test_get_beep_progress_bar_updates_returns_setting(
self,
test_context: CthulhuTestContext,
) -> None:
"""Test get_beep_progress_bar_updates returns the beepProgressBarUpdates setting."""
self._setup_dependencies(test_context)
from cthulhu.sound_presenter import SoundPresenter
presenter = SoundPresenter()
presenter.set_beep_progress_bar_updates(True)
assert presenter.get_beep_progress_bar_updates() is True
presenter.set_beep_progress_bar_updates(False)
assert presenter.get_beep_progress_bar_updates() is False
def test_set_beep_progress_bar_updates_updates_setting(
self,
test_context: CthulhuTestContext,
) -> None:
"""Test set_beep_progress_bar_updates updates the beepProgressBarUpdates setting."""
self._setup_dependencies(test_context)
from cthulhu.sound_presenter import SoundPresenter
presenter = SoundPresenter()
result = presenter.set_beep_progress_bar_updates(True)
assert result is True
assert presenter.get_beep_progress_bar_updates() is True
def test_get_progress_bar_beep_interval_returns_setting(
self,
test_context: CthulhuTestContext,
) -> None:
"""Test get_progress_bar_beep_interval returns the progressBarBeepInterval setting."""
self._setup_dependencies(test_context)
from cthulhu.sound_presenter import SoundPresenter
presenter = SoundPresenter()
presenter.set_progress_bar_beep_interval(10)
assert presenter.get_progress_bar_beep_interval() == 10
def test_set_progress_bar_beep_interval_updates_setting(
self,
test_context: CthulhuTestContext,
) -> None:
"""Test set_progress_bar_beep_interval updates the progressBarBeepInterval setting."""
self._setup_dependencies(test_context)
from cthulhu.sound_presenter import SoundPresenter
presenter = SoundPresenter()
result = presenter.set_progress_bar_beep_interval(15)
assert result is True
assert presenter.get_progress_bar_beep_interval() == 15
def test_get_progress_bar_beep_verbosity_returns_setting(
self,
test_context: CthulhuTestContext,
) -> None:
"""Test get_progress_bar_beep_verbosity returns the progressBarBeepVerbosity setting."""
self._setup_dependencies(test_context)
from cthulhu.sound_presenter import SoundPresenter
presenter = SoundPresenter()
presenter.set_progress_bar_beep_verbosity(2)
assert presenter.get_progress_bar_beep_verbosity() == 2
def test_set_progress_bar_beep_verbosity_updates_setting(
self,
test_context: CthulhuTestContext,
) -> None:
"""Test set_progress_bar_beep_verbosity updates the progressBarBeepVerbosity setting."""
self._setup_dependencies(test_context)
from cthulhu.sound_presenter import SoundPresenter
presenter = SoundPresenter()
result = presenter.set_progress_bar_beep_verbosity(2)
assert result is True
assert presenter.get_progress_bar_beep_verbosity() == 2
def test_get_presenter_returns_singleton(self, test_context: CthulhuTestContext) -> None:
"""Test get_presenter returns the module-level presenter instance."""
self._setup_dependencies(test_context)
from cthulhu import sound_presenter
presenter1 = sound_presenter.get_presenter()
presenter2 = sound_presenter.get_presenter()
assert presenter1 is presenter2
assert isinstance(presenter1, sound_presenter.SoundPresenter)