155 lines
4.2 KiB
Python
155 lines
4.2 KiB
Python
"""Conftest for TTS tests.
|
|
|
|
From http://doc.pytest.org/en/latest/example/simple.html#making-test-result-information-available-in-fixtures
|
|
"""
|
|
from collections.abc import Generator
|
|
from typing import Any
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
import pytest
|
|
|
|
from homeassistant.components.tts import _get_cache_files
|
|
from homeassistant.config import async_process_ha_core_config
|
|
from homeassistant.config_entries import ConfigFlow
|
|
from homeassistant.core import HomeAssistant
|
|
|
|
from .common import (
|
|
DEFAULT_LANG,
|
|
TEST_DOMAIN,
|
|
MockProvider,
|
|
MockTTS,
|
|
MockTTSEntity,
|
|
mock_config_entry_setup,
|
|
mock_setup,
|
|
)
|
|
|
|
from tests.common import MockModule, mock_config_flow, mock_integration, mock_platform
|
|
|
|
|
|
@pytest.hookimpl(tryfirst=True, hookwrapper=True)
|
|
def pytest_runtest_makereport(item, call):
|
|
"""Add test report to node."""
|
|
# execute all other hooks to obtain the report object
|
|
outcome = yield
|
|
rep = outcome.get_result()
|
|
|
|
# set a report attribute for each phase of a call, which can
|
|
# be "setup", "call", "teardown"
|
|
setattr(item, f"rep_{rep.when}", rep)
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def mock_get_cache_files():
|
|
"""Mock the list TTS cache function."""
|
|
with patch(
|
|
"homeassistant.components.tts._get_cache_files", return_value={}
|
|
) as mock_cache_files:
|
|
yield mock_cache_files
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def mock_init_cache_dir(
|
|
init_cache_dir_side_effect: Any,
|
|
) -> Generator[MagicMock, None, None]:
|
|
"""Mock the TTS cache dir in memory."""
|
|
with patch(
|
|
"homeassistant.components.tts._init_tts_cache_dir",
|
|
side_effect=init_cache_dir_side_effect,
|
|
) as mock_cache_dir:
|
|
yield mock_cache_dir
|
|
|
|
|
|
@pytest.fixture
|
|
def init_cache_dir_side_effect() -> Any:
|
|
"""Return the cache dir."""
|
|
return None
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def empty_cache_dir(tmp_path, mock_init_cache_dir, mock_get_cache_files, request):
|
|
"""Mock the TTS cache dir with empty dir."""
|
|
mock_init_cache_dir.return_value = str(tmp_path)
|
|
|
|
# Restore original get cache files behavior, we're working with a real dir.
|
|
mock_get_cache_files.side_effect = _get_cache_files
|
|
|
|
yield tmp_path
|
|
|
|
if request.node.rep_call.passed:
|
|
return
|
|
|
|
# Print contents of dir if failed
|
|
print("Content of dir for", request.node.nodeid) # noqa: T201
|
|
for fil in tmp_path.iterdir():
|
|
print(fil.relative_to(tmp_path)) # noqa: T201
|
|
|
|
# To show the log.
|
|
pytest.fail("Test failed, see log for details")
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def mutagen_mock():
|
|
"""Mock writing tags."""
|
|
with patch(
|
|
"homeassistant.components.tts.SpeechManager.write_tags",
|
|
side_effect=lambda *args: args[1],
|
|
) as mock_write_tags:
|
|
yield mock_write_tags
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
async def internal_url_mock(hass: HomeAssistant) -> None:
|
|
"""Mock internal URL of the instance."""
|
|
await async_process_ha_core_config(
|
|
hass,
|
|
{"internal_url": "http://example.local:8123"},
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
async def mock_tts(hass: HomeAssistant, mock_provider) -> None:
|
|
"""Mock TTS."""
|
|
mock_integration(hass, MockModule(domain="test"))
|
|
mock_platform(hass, "test.tts", MockTTS(mock_provider))
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_provider() -> MockProvider:
|
|
"""Test TTS provider."""
|
|
return MockProvider(DEFAULT_LANG)
|
|
|
|
|
|
@pytest.fixture
|
|
def mock_tts_entity() -> MockTTSEntity:
|
|
"""Test TTS entity."""
|
|
return MockTTSEntity(DEFAULT_LANG)
|
|
|
|
|
|
class TTSFlow(ConfigFlow):
|
|
"""Test flow."""
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def config_flow_fixture(hass: HomeAssistant) -> Generator[None, None, None]:
|
|
"""Mock config flow."""
|
|
mock_platform(hass, f"{TEST_DOMAIN}.config_flow")
|
|
|
|
with mock_config_flow(TEST_DOMAIN, TTSFlow):
|
|
yield
|
|
|
|
|
|
@pytest.fixture(name="setup")
|
|
async def setup_fixture(
|
|
hass: HomeAssistant,
|
|
request: pytest.FixtureRequest,
|
|
mock_provider: MockProvider,
|
|
mock_tts_entity: MockTTSEntity,
|
|
) -> None:
|
|
"""Set up the test environment."""
|
|
if request.param == "mock_setup":
|
|
await mock_setup(hass, mock_provider)
|
|
elif request.param == "mock_config_entry_setup":
|
|
await mock_config_entry_setup(hass, mock_tts_entity)
|
|
else:
|
|
raise RuntimeError("Invalid setup fixture")
|