core/tests/components/purpleair/conftest.py

"""Define fixtures for PurpleAir tests."""
from unittest.mock import AsyncMock, Mock, patch

from aiopurpleair.endpoints.sensors import NearbySensorResult
from aiopurpleair.models.sensors import GetSensorsResponse
import pytest

from homeassistant.components.purpleair import DOMAIN
from homeassistant.setup import async_setup_component

from tests.common import MockConfigEntry, load_fixture


@pytest.fixture(name="api")
def api_fixture(check_api_key, get_nearby_sensors, get_sensors):
    """Define a fixture to return a mocked aiopurple API object."""
    api = Mock(async_check_api_key=check_api_key)
    api.sensors.async_get_nearby_sensors = get_nearby_sensors
    api.sensors.async_get_sensors = get_sensors
    return api


@pytest.fixture(name="check_api_key")
def check_api_key_fixture():
    """Define a fixture to mock the method to check an API key's validity."""
    return AsyncMock()


@pytest.fixture(name="config_entry")
def config_entry_fixture(hass, config_entry_data, config_entry_options):
    """Define a config entry fixture."""
    entry = MockConfigEntry(
        domain=DOMAIN,
        title="abcde",
        unique_id="abcde12345",
        data=config_entry_data,
        options=config_entry_options,
    )
    entry.add_to_hass(hass)
    return entry


@pytest.fixture(name="config_entry_data")
def config_entry_data_fixture():
    """Define a config entry data fixture."""
    return {
        "api_key": "abcde12345",
    }


@pytest.fixture(name="config_entry_options")
def config_entry_options_fixture():
    """Define a config entry options fixture."""
    return {
        "sensor_indices": [123456],
    }


@pytest.fixture(name="get_nearby_sensors")
def get_nearby_sensors_fixture(get_sensors_response):
    """Define a mocked API.sensors.async_get_nearby_sensors."""
    return AsyncMock(
        return_value=[
            NearbySensorResult(sensor=sensor, distance=1.0)
            for sensor in get_sensors_response.data.values()
        ]
    )


@pytest.fixture(name="get_sensors")
def get_sensors_fixture(get_sensors_response):
    """Define a mocked API.sensors.async_get_sensors."""
    return AsyncMock(return_value=get_sensors_response)


@pytest.fixture(name="get_sensors_response", scope="package")
def get_sensors_response_fixture():
    """Define a fixture to mock an aiopurpleair GetSensorsResponse object."""
    return GetSensorsResponse.parse_raw(
        load_fixture("get_sensors_response.json", "purpleair")
    )


@pytest.fixture(name="setup_purpleair")
async def setup_purpleair_fixture(hass, api, config_entry_data):
    """Define a fixture to set up PurpleAir."""
    with patch(
        "homeassistant.components.purpleair.config_flow.API", return_value=api
    ), patch("homeassistant.components.purpleair.coordinator.API", return_value=api):
        assert await async_setup_component(hass, DOMAIN, config_entry_data)
        await hass.async_block_till_done()
        yield