core/tests/components/vizio/conftest.py

"""Configure py.test."""

from collections.abc import Generator
from unittest.mock import AsyncMock, patch

import pytest
from pyvizio.api.apps import AppConfig
from pyvizio.const import DEVICE_CLASS_SPEAKER, MAX_VOLUME

from .const import (
    ACCESS_TOKEN,
    APP_LIST,
    CH_TYPE,
    CURRENT_APP_CONFIG,
    CURRENT_EQ,
    CURRENT_INPUT,
    EQ_LIST,
    INPUT_LIST,
    INPUT_LIST_WITH_APPS,
    MODEL,
    RESPONSE_TOKEN,
    UNIQUE_ID,
    VERSION,
    ZEROCONF_HOST,
    MockCompletePairingResponse,
    MockStartPairingResponse,
)


class MockInput:
    """Mock Vizio device input."""

    def __init__(self, name) -> None:
        """Initialize mock Vizio device input."""
        self.meta_name = name
        self.name = name


def get_mock_inputs(input_list) -> list[MockInput]:
    """Return list of MockInput."""
    return [MockInput(device_input) for device_input in input_list]


@pytest.fixture(name="vizio_get_unique_id", autouse=True)
def vizio_get_unique_id_fixture() -> Generator[None]:
    """Mock get vizio unique ID."""
    with patch(
        "homeassistant.components.vizio.config_flow.VizioAsync.get_unique_id",
        AsyncMock(return_value=UNIQUE_ID),
    ):
        yield


@pytest.fixture(name="vizio_data_coordinator_update", autouse=True)
def vizio_data_coordinator_update_fixture() -> Generator[None]:
    """Mock get data coordinator update."""
    with patch(
        "homeassistant.components.vizio.coordinator.gen_apps_list_from_url",
        return_value=APP_LIST,
    ):
        yield


@pytest.fixture(name="vizio_data_coordinator_update_failure")
def vizio_data_coordinator_update_failure_fixture() -> Generator[None]:
    """Mock get data coordinator update failure."""
    with patch(
        "homeassistant.components.vizio.coordinator.gen_apps_list_from_url",
        return_value=None,
    ):
        yield


@pytest.fixture(name="vizio_no_unique_id")
def vizio_no_unique_id_fixture() -> Generator[None]:
    """Mock no vizio unique ID returrned."""
    with patch(
        "homeassistant.components.vizio.config_flow.VizioAsync.get_unique_id",
        return_value=None,
    ):
        yield


@pytest.fixture(name="vizio_connect")
def vizio_connect_fixture() -> Generator[None]:
    """Mock valid vizio device and entry setup."""
    with patch(
        "homeassistant.components.vizio.config_flow.VizioAsync.validate_ha_config",
        AsyncMock(return_value=True),
    ):
        yield


@pytest.fixture(name="vizio_complete_pairing")
def vizio_complete_pairing_fixture() -> Generator[None]:
    """Mock complete vizio pairing workflow."""
    with (
        patch(
            "homeassistant.components.vizio.config_flow.VizioAsync.start_pair",
            return_value=MockStartPairingResponse(CH_TYPE, RESPONSE_TOKEN),
        ),
        patch(
            "homeassistant.components.vizio.config_flow.VizioAsync.pair",
            return_value=MockCompletePairingResponse(ACCESS_TOKEN),
        ),
    ):
        yield


@pytest.fixture(name="vizio_start_pairing_failure")
def vizio_start_pairing_failure_fixture() -> Generator[None]:
    """Mock vizio start pairing failure."""
    with patch(
        "homeassistant.components.vizio.config_flow.VizioAsync.start_pair",
        return_value=None,
    ):
        yield


@pytest.fixture(name="vizio_invalid_pin_failure")
def vizio_invalid_pin_failure_fixture() -> Generator[None]:
    """Mock vizio failure due to invalid pin."""
    with (
        patch(
            "homeassistant.components.vizio.config_flow.VizioAsync.start_pair",
            return_value=MockStartPairingResponse(CH_TYPE, RESPONSE_TOKEN),
        ),
        patch(
            "homeassistant.components.vizio.config_flow.VizioAsync.pair",
            return_value=None,
        ),
    ):
        yield


@pytest.fixture(name="vizio_bypass_setup")
def vizio_bypass_setup_fixture() -> Generator[None]:
    """Mock component setup."""
    with patch("homeassistant.components.vizio.async_setup_entry", return_value=True):
        yield


@pytest.fixture(name="vizio_bypass_update")
def vizio_bypass_update_fixture() -> Generator[None]:
    """Mock component update."""
    with (
        patch(
            "homeassistant.components.vizio.media_player.VizioAsync.can_connect_with_auth_check",
            return_value=True,
        ),
        patch("homeassistant.components.vizio.media_player.VizioDevice.async_update"),
    ):
        yield


@pytest.fixture(name="vizio_guess_device_type")
def vizio_guess_device_type_fixture() -> Generator[None]:
    """Mock vizio async_guess_device_type function."""
    with patch(
        "homeassistant.components.vizio.config_flow.async_guess_device_type",
        return_value="speaker",
    ):
        yield


@pytest.fixture(name="vizio_cant_connect")
def vizio_cant_connect_fixture() -> Generator[None]:
    """Mock vizio device can't connect with valid auth."""
    with (
        patch(
            "homeassistant.components.vizio.config_flow.VizioAsync.validate_ha_config",
            AsyncMock(return_value=False),
        ),
        patch(
            "homeassistant.components.vizio.media_player.VizioAsync.get_power_state",
            return_value=None,
        ),
    ):
        yield


@pytest.fixture(name="vizio_update")
def vizio_update_fixture() -> Generator[None]:
    """Mock valid updates to vizio device."""
    with (
        patch(
            "homeassistant.components.vizio.media_player.VizioAsync.can_connect_with_auth_check",
            return_value=True,
        ),
        patch(
            "homeassistant.components.vizio.media_player.VizioAsync.get_all_settings",
            return_value={
                "volume": int(MAX_VOLUME[DEVICE_CLASS_SPEAKER] / 2),
                "eq": CURRENT_EQ,
                "mute": "Off",
            },
        ),
        patch(
            "homeassistant.components.vizio.media_player.VizioAsync.get_setting_options",
            return_value=EQ_LIST,
        ),
        patch(
            "homeassistant.components.vizio.media_player.VizioAsync.get_current_input",
            return_value=CURRENT_INPUT,
        ),
        patch(
            "homeassistant.components.vizio.media_player.VizioAsync.get_inputs_list",
            return_value=get_mock_inputs(INPUT_LIST),
        ),
        patch(
            "homeassistant.components.vizio.media_player.VizioAsync.get_power_state",
            return_value=True,
        ),
        patch(
            "homeassistant.components.vizio.media_player.VizioAsync.get_model_name",
            return_value=MODEL,
        ),
        patch(
            "homeassistant.components.vizio.media_player.VizioAsync.get_version",
            return_value=VERSION,
        ),
    ):
        yield


@pytest.fixture(name="vizio_update_with_apps")
def vizio_update_with_apps_fixture(vizio_update: None) -> Generator[None]:
    """Mock valid updates to vizio device that supports apps."""
    with (
        patch(
            "homeassistant.components.vizio.media_player.VizioAsync.get_inputs_list",
            return_value=get_mock_inputs(INPUT_LIST_WITH_APPS),
        ),
        patch(
            "homeassistant.components.vizio.media_player.VizioAsync.get_current_input",
            return_value="CAST",
        ),
        patch(
            "homeassistant.components.vizio.media_player.VizioAsync.get_current_app_config",
            return_value=AppConfig(**CURRENT_APP_CONFIG),
        ),
    ):
        yield


@pytest.fixture(name="vizio_update_with_apps_on_input")
def vizio_update_with_apps_on_input_fixture(vizio_update: None) -> Generator[None]:
    """Mock valid updates to vizio device that supports apps but is on a TV input."""
    with (
        patch(
            "homeassistant.components.vizio.media_player.VizioAsync.get_inputs_list",
            return_value=get_mock_inputs(INPUT_LIST_WITH_APPS),
        ),
        patch(
            "homeassistant.components.vizio.media_player.VizioAsync.get_current_input",
            return_value=CURRENT_INPUT,
        ),
        patch(
            "homeassistant.components.vizio.media_player.VizioAsync.get_current_app_config",
            return_value=AppConfig("unknown", 1, "app"),
        ),
    ):
        yield


@pytest.fixture(name="vizio_hostname_check")
def vizio_hostname_check() -> Generator[None]:
    """Mock vizio hostname resolution."""
    with patch(
        "homeassistant.components.vizio.config_flow.socket.gethostbyname",
        return_value=ZEROCONF_HOST,
    ):
        yield