core/tests/components/paperless_ngx/test_update.py

131 lines
4.0 KiB
Python

"""Tests for Paperless-ngx update platform."""
from unittest.mock import AsyncMock, MagicMock
from freezegun.api import FrozenDateTimeFactory
from pypaperless.exceptions import PaperlessConnectionError
from pypaperless.models import RemoteVersion
import pytest
from homeassistant.components.paperless_ngx.update import SCAN_INTERVAL
from homeassistant.const import STATE_OFF, STATE_ON, STATE_UNAVAILABLE, Platform
from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er
from . import setup_integration
from tests.common import (
MockConfigEntry,
SnapshotAssertion,
async_fire_time_changed,
patch,
snapshot_platform,
)
@pytest.mark.usefixtures("entity_registry_enabled_by_default")
async def test_update_platfom(
hass: HomeAssistant,
mock_config_entry: MockConfigEntry,
entity_registry: er.EntityRegistry,
snapshot: SnapshotAssertion,
) -> None:
"""Test paperless_ngx update sensors."""
with patch("homeassistant.components.paperless_ngx.PLATFORMS", [Platform.UPDATE]):
await setup_integration(hass, mock_config_entry)
await snapshot_platform(hass, entity_registry, snapshot, mock_config_entry.entry_id)
@pytest.mark.usefixtures("init_integration")
async def test_update_sensor_downgrade_upgrade(
hass: HomeAssistant,
mock_paperless: AsyncMock,
freezer: FrozenDateTimeFactory,
init_integration: MockConfigEntry,
) -> None:
"""Ensure update entities are updating properly on downgrade and upgrade."""
state = hass.states.get("update.paperless_ngx_software")
assert state.state == STATE_OFF
# downgrade host version
mock_paperless.host_version = "2.2.0"
freezer.tick(SCAN_INTERVAL)
async_fire_time_changed(hass)
await hass.async_block_till_done()
state = hass.states.get("update.paperless_ngx_software")
assert state.state == STATE_ON
# upgrade host version
mock_paperless.host_version = "2.3.0"
freezer.tick(SCAN_INTERVAL)
async_fire_time_changed(hass)
await hass.async_block_till_done()
state = hass.states.get("update.paperless_ngx_software")
assert state.state == STATE_OFF
@pytest.mark.usefixtures("init_integration")
async def test_update_sensor_state_on_error(
hass: HomeAssistant,
mock_paperless: AsyncMock,
freezer: FrozenDateTimeFactory,
mock_remote_version_data: MagicMock,
) -> None:
"""Ensure update entities handle errors properly."""
# simulate error
mock_paperless.remote_version.side_effect = PaperlessConnectionError
freezer.tick(SCAN_INTERVAL)
async_fire_time_changed(hass)
await hass.async_block_till_done()
state = hass.states.get("update.paperless_ngx_software")
assert state.state == STATE_UNAVAILABLE
# recover from not auth errors
mock_paperless.remote_version = AsyncMock(
return_value=RemoteVersion.create_with_data(
mock_paperless, data=mock_remote_version_data, fetched=True
)
)
freezer.tick(SCAN_INTERVAL)
async_fire_time_changed(hass)
await hass.async_block_till_done()
state = hass.states.get("update.paperless_ngx_software")
assert state.state == STATE_OFF
@pytest.mark.usefixtures("init_integration")
async def test_update_sensor_version_unavailable(
hass: HomeAssistant,
mock_paperless: AsyncMock,
freezer: FrozenDateTimeFactory,
mock_remote_version_data_unavailable: MagicMock,
) -> None:
"""Ensure update entities handle version unavailable properly."""
state = hass.states.get("update.paperless_ngx_software")
assert state.state == STATE_OFF
# set version unavailable
mock_paperless.remote_version = AsyncMock(
return_value=RemoteVersion.create_with_data(
mock_paperless, data=mock_remote_version_data_unavailable, fetched=True
)
)
freezer.tick(SCAN_INTERVAL)
async_fire_time_changed(hass)
await hass.async_block_till_done()
state = hass.states.get("update.paperless_ngx_software")
assert state.state == STATE_UNAVAILABLE