core/tests/components/apcupsd/test_init.py

"""Test init of APCUPSd integration."""
import asyncio
from collections import OrderedDict
from unittest.mock import patch

import pytest

from homeassistant.components.apcupsd.const import DOMAIN
from homeassistant.components.apcupsd.coordinator import UPDATE_INTERVAL
from homeassistant.config_entries import SOURCE_USER, ConfigEntryState
from homeassistant.const import STATE_UNAVAILABLE
from homeassistant.core import HomeAssistant
from homeassistant.helpers import device_registry as dr
from homeassistant.util import utcnow

from . import CONF_DATA, MOCK_MINIMAL_STATUS, MOCK_STATUS, async_init_integration

from tests.common import MockConfigEntry, async_fire_time_changed


@pytest.mark.parametrize("status", (MOCK_STATUS, MOCK_MINIMAL_STATUS))
async def test_async_setup_entry(hass: HomeAssistant, status: OrderedDict) -> None:
    """Test a successful setup entry."""
    # Minimal status does not contain "SERIALNO" field, which is used to determine the
    # unique ID of this integration. But, the integration should work fine without it.
    await async_init_integration(hass, status=status)

    # Verify successful setup by querying the status sensor.
    state = hass.states.get("binary_sensor.ups_online_status")
    assert state is not None
    assert state.state != STATE_UNAVAILABLE
    assert state.state == "on"


@pytest.mark.parametrize(
    "status",
    (
        # We should not create device entries if SERIALNO is not reported.
        MOCK_MINIMAL_STATUS,
        # We should set the device name to be the friendly UPSNAME field if available.
        MOCK_MINIMAL_STATUS | {"SERIALNO": "XXXX", "UPSNAME": "MyUPS"},
        # Otherwise, we should fall back to default device name --- "APC UPS".
        MOCK_MINIMAL_STATUS | {"SERIALNO": "XXXX"},
        # We should create all fields of the device entry if they are available.
        MOCK_STATUS,
    ),
)
async def test_device_entry(
    hass: HomeAssistant, status: OrderedDict, device_registry: dr.DeviceRegistry
) -> None:
    """Test successful setup of device entries."""
    await async_init_integration(hass, status=status)

    # Verify device info is properly set up.
    if "SERIALNO" not in status:
        assert len(device_registry.devices) == 0
        return

    assert len(device_registry.devices) == 1
    entry = device_registry.async_get_device({(DOMAIN, status["SERIALNO"])})
    assert entry is not None
    # Specify the mapping between field name and the expected fields in device entry.
    fields = {
        "UPSNAME": entry.name,
        "MODEL": entry.model,
        "VERSION": entry.sw_version,
        "FIRMWARE": entry.hw_version,
    }

    for field, entry_value in fields.items():
        if field in status:
            assert entry_value == status[field]
        # Even if UPSNAME is not available, we must fall back to default "APC UPS".
        elif field == "UPSNAME":
            assert entry_value == "APC UPS"
        else:
            assert not entry_value

    assert entry.manufacturer == "APC"


async def test_multiple_integrations(hass: HomeAssistant) -> None:
    """Test successful setup for multiple entries."""
    # Load two integrations from two mock hosts.
    status1 = MOCK_STATUS | {"LOADPCT": "15.0 Percent", "SERIALNO": "XXXXX1"}
    status2 = MOCK_STATUS | {"LOADPCT": "16.0 Percent", "SERIALNO": "XXXXX2"}
    entries = (
        await async_init_integration(hass, host="test1", status=status1),
        await async_init_integration(hass, host="test2", status=status2),
    )

    assert len(hass.config_entries.async_entries(DOMAIN)) == 2
    assert all(entry.state is ConfigEntryState.LOADED for entry in entries)

    state1 = hass.states.get("sensor.ups_load")
    state2 = hass.states.get("sensor.ups_load_2")
    assert state1 is not None and state2 is not None
    assert state1.state != state2.state


@pytest.mark.parametrize(
    "error",
    (OSError(), asyncio.IncompleteReadError(partial=b"", expected=0)),
)
async def test_connection_error(hass: HomeAssistant, error: Exception) -> None:
    """Test connection error during integration setup."""
    entry = MockConfigEntry(
        version=1,
        domain=DOMAIN,
        title="APCUPSd",
        data=CONF_DATA,
        source=SOURCE_USER,
    )

    entry.add_to_hass(hass)

    with patch("aioapcaccess.request_status", side_effect=error):
        await hass.config_entries.async_setup(entry.entry_id)
        assert entry.state is ConfigEntryState.SETUP_RETRY


async def test_unload_remove_entry(hass: HomeAssistant) -> None:
    """Test successful unload and removal of an entry."""
    # Load two integrations from two mock hosts.
    entries = (
        await async_init_integration(hass, host="test1", status=MOCK_STATUS),
        await async_init_integration(hass, host="test2", status=MOCK_MINIMAL_STATUS),
    )

    # Assert they are loaded.
    assert len(hass.config_entries.async_entries(DOMAIN)) == 2
    assert all(entry.state is ConfigEntryState.LOADED for entry in entries)

    # Unload the first entry.
    assert await hass.config_entries.async_unload(entries[0].entry_id)
    await hass.async_block_till_done()
    assert entries[0].state is ConfigEntryState.NOT_LOADED
    assert entries[1].state is ConfigEntryState.LOADED

    # Unload the second entry.
    assert await hass.config_entries.async_unload(entries[1].entry_id)
    await hass.async_block_till_done()
    assert all(entry.state is ConfigEntryState.NOT_LOADED for entry in entries)

    # Remove both entries.
    for entry in entries:
        await hass.config_entries.async_remove(entry.entry_id)
    await hass.async_block_till_done()
    assert len(hass.config_entries.async_entries(DOMAIN)) == 0


async def test_availability(hass: HomeAssistant) -> None:
    """Ensure that we mark the entity's availability properly when network is down / back up."""
    await async_init_integration(hass)

    state = hass.states.get("sensor.ups_load")
    assert state
    assert state.state != STATE_UNAVAILABLE
    assert pytest.approx(float(state.state)) == 14.0

    with patch("aioapcaccess.request_status") as mock_request_status:
        # Mock a network error and then trigger an auto-polling event.
        mock_request_status.side_effect = OSError()
        future = utcnow() + UPDATE_INTERVAL
        async_fire_time_changed(hass, future)
        await hass.async_block_till_done()

        # Sensors should be marked as unavailable.
        state = hass.states.get("sensor.ups_load")
        assert state
        assert state.state == STATE_UNAVAILABLE

        # Reset the API to return a new status and update.
        mock_request_status.side_effect = None
        mock_request_status.return_value = MOCK_STATUS | {"LOADPCT": "15.0 Percent"}
        future = future + UPDATE_INTERVAL
        async_fire_time_changed(hass, future)
        await hass.async_block_till_done()

        # Sensors should be online now with the new value.
        state = hass.states.get("sensor.ups_load")
        assert state
        assert state.state != STATE_UNAVAILABLE
        assert pytest.approx(float(state.state)) == 15.0