Update AEMET-OpenData to v0.3.0 (#98810)

This commit is contained in:
Álvaro Fernández Rojas 2023-08-22 23:21:42 +02:00 committed by GitHub
parent 6399d74c15
commit 30628766ae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
14 changed files with 114 additions and 153 deletions

View File

@ -6,6 +6,7 @@ from aemet_opendata.interface import AEMET
from homeassistant.config_entries import ConfigEntry from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_API_KEY, CONF_LATITUDE, CONF_LONGITUDE, CONF_NAME from homeassistant.const import CONF_API_KEY, CONF_LATITUDE, CONF_LONGITUDE, CONF_NAME
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from homeassistant.helpers import aiohttp_client
from .const import ( from .const import (
CONF_STATION_UPDATES, CONF_STATION_UPDATES,
@ -27,7 +28,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
longitude = entry.data[CONF_LONGITUDE] longitude = entry.data[CONF_LONGITUDE]
station_updates = entry.options.get(CONF_STATION_UPDATES, True) station_updates = entry.options.get(CONF_STATION_UPDATES, True)
aemet = AEMET(api_key) aemet = AEMET(aiohttp_client.async_get_clientsession(hass), api_key)
weather_coordinator = WeatherUpdateCoordinator( weather_coordinator = WeatherUpdateCoordinator(
hass, aemet, latitude, longitude, station_updates hass, aemet, latitude, longitude, station_updates
) )

View File

@ -2,12 +2,13 @@
from __future__ import annotations from __future__ import annotations
from aemet_opendata import AEMET from aemet_opendata import AEMET
from aemet_opendata.exceptions import AuthError
import voluptuous as vol import voluptuous as vol
from homeassistant import config_entries from homeassistant import config_entries
from homeassistant.const import CONF_API_KEY, CONF_LATITUDE, CONF_LONGITUDE, CONF_NAME from homeassistant.const import CONF_API_KEY, CONF_LATITUDE, CONF_LONGITUDE, CONF_NAME
from homeassistant.core import callback from homeassistant.core import callback
import homeassistant.helpers.config_validation as cv from homeassistant.helpers import aiohttp_client, config_validation as cv
from homeassistant.helpers.schema_config_entry_flow import ( from homeassistant.helpers.schema_config_entry_flow import (
SchemaFlowFormStep, SchemaFlowFormStep,
SchemaOptionsFlowHandler, SchemaOptionsFlowHandler,
@ -39,8 +40,13 @@ class AemetConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
await self.async_set_unique_id(f"{latitude}-{longitude}") await self.async_set_unique_id(f"{latitude}-{longitude}")
self._abort_if_unique_id_configured() self._abort_if_unique_id_configured()
api_online = await _is_aemet_api_online(self.hass, user_input[CONF_API_KEY]) aemet = AEMET(
if not api_online: aiohttp_client.async_get_clientsession(self.hass),
user_input[CONF_API_KEY],
)
try:
await aemet.get_conventional_observation_stations(False)
except AuthError:
errors["base"] = "invalid_api_key" errors["base"] = "invalid_api_key"
if not errors: if not errors:
@ -70,10 +76,3 @@ class AemetConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
) -> SchemaOptionsFlowHandler: ) -> SchemaOptionsFlowHandler:
"""Get the options flow for this handler.""" """Get the options flow for this handler."""
return SchemaOptionsFlowHandler(config_entry, OPTIONS_FLOW) return SchemaOptionsFlowHandler(config_entry, OPTIONS_FLOW)
async def _is_aemet_api_online(hass, api_key):
aemet = AEMET(api_key)
return await hass.async_add_executor_job(
aemet.get_conventional_observation_stations, False
)

View File

@ -6,5 +6,5 @@
"documentation": "https://www.home-assistant.io/integrations/aemet", "documentation": "https://www.home-assistant.io/integrations/aemet",
"iot_class": "cloud_polling", "iot_class": "cloud_polling",
"loggers": ["aemet_opendata"], "loggers": ["aemet_opendata"],
"requirements": ["AEMET-OpenData==0.2.2"] "requirements": ["AEMET-OpenData==0.3.0"]
} }

View File

@ -146,13 +146,13 @@ class WeatherUpdateCoordinator(DataUpdateCoordinator):
async def _get_aemet_weather(self): async def _get_aemet_weather(self):
"""Poll weather data from AEMET OpenData.""" """Poll weather data from AEMET OpenData."""
weather = await self.hass.async_add_executor_job(self._get_weather_and_forecast) weather = await self._get_weather_and_forecast()
return weather return weather
def _get_weather_station(self): async def _get_weather_station(self):
if not self._station: if not self._station:
self._station = ( self._station = (
self._aemet.get_conventional_observation_station_by_coordinates( await self._aemet.get_conventional_observation_station_by_coordinates(
self._latitude, self._longitude self._latitude, self._longitude
) )
) )
@ -171,9 +171,9 @@ class WeatherUpdateCoordinator(DataUpdateCoordinator):
) )
return self._station return self._station
def _get_weather_town(self): async def _get_weather_town(self):
if not self._town: if not self._town:
self._town = self._aemet.get_town_by_coordinates( self._town = await self._aemet.get_town_by_coordinates(
self._latitude, self._longitude self._latitude, self._longitude
) )
if self._town: if self._town:
@ -192,18 +192,20 @@ class WeatherUpdateCoordinator(DataUpdateCoordinator):
raise TownNotFound raise TownNotFound
return self._town return self._town
def _get_weather_and_forecast(self): async def _get_weather_and_forecast(self):
"""Get weather and forecast data from AEMET OpenData.""" """Get weather and forecast data from AEMET OpenData."""
self._get_weather_town() await self._get_weather_town()
daily = self._aemet.get_specific_forecast_town_daily(self._town[AEMET_ATTR_ID]) daily = await self._aemet.get_specific_forecast_town_daily(
self._town[AEMET_ATTR_ID]
)
if not daily: if not daily:
_LOGGER.error( _LOGGER.error(
'Error fetching daily data for town "%s"', self._town[AEMET_ATTR_ID] 'Error fetching daily data for town "%s"', self._town[AEMET_ATTR_ID]
) )
hourly = self._aemet.get_specific_forecast_town_hourly( hourly = await self._aemet.get_specific_forecast_town_hourly(
self._town[AEMET_ATTR_ID] self._town[AEMET_ATTR_ID]
) )
if not hourly: if not hourly:
@ -212,8 +214,8 @@ class WeatherUpdateCoordinator(DataUpdateCoordinator):
) )
station = None station = None
if self._station_updates and self._get_weather_station(): if self._station_updates and await self._get_weather_station():
station = self._aemet.get_conventional_observation_station_data( station = await self._aemet.get_conventional_observation_station_data(
self._station[AEMET_ATTR_IDEMA] self._station[AEMET_ATTR_IDEMA]
) )
if not station: if not station:

View File

@ -2,7 +2,7 @@
-r requirements.txt -r requirements.txt
# homeassistant.components.aemet # homeassistant.components.aemet
AEMET-OpenData==0.2.2 AEMET-OpenData==0.3.0
# homeassistant.components.aladdin_connect # homeassistant.components.aladdin_connect
AIOAladdinConnect==0.1.57 AIOAladdinConnect==0.1.57

View File

@ -4,7 +4,7 @@
-r requirements_test.txt -r requirements_test.txt
# homeassistant.components.aemet # homeassistant.components.aemet
AEMET-OpenData==0.2.2 AEMET-OpenData==0.3.0
# homeassistant.components.aladdin_connect # homeassistant.components.aladdin_connect
AIOAladdinConnect==0.1.57 AIOAladdinConnect==0.1.57

View File

@ -1,6 +0,0 @@
{
"descripcion": "exito",
"estado": 200,
"datos": "https://opendata.aemet.es/opendata/sh/208c3ca3",
"metadatos": "https://opendata.aemet.es/opendata/sh/55c2971b"
}

View File

@ -1,6 +0,0 @@
{
"descripcion": "exito",
"estado": 200,
"datos": "https://opendata.aemet.es/opendata/sh/2c55192f",
"metadatos": "https://opendata.aemet.es/opendata/sh/55c2971b"
}

View File

@ -1,6 +0,0 @@
{
"descripcion": "exito",
"estado": 200,
"datos": "https://opendata.aemet.es/opendata/sh/64e29abb",
"metadatos": "https://opendata.aemet.es/opendata/sh/dfd88b22"
}

View File

@ -1,6 +0,0 @@
{
"descripcion": "exito",
"estado": 200,
"datos": "https://opendata.aemet.es/opendata/sh/18ca1886",
"metadatos": "https://opendata.aemet.es/opendata/sh/93a7c63d"
}

View File

@ -1,8 +1,8 @@
"""Define tests for the AEMET OpenData config flow.""" """Define tests for the AEMET OpenData config flow."""
from unittest.mock import AsyncMock, MagicMock, patch from unittest.mock import AsyncMock, MagicMock, patch
from aemet_opendata.exceptions import AuthError
import pytest import pytest
import requests_mock
from homeassistant import data_entry_flow from homeassistant import data_entry_flow
from homeassistant.components.aemet.const import CONF_STATION_UPDATES, DOMAIN from homeassistant.components.aemet.const import CONF_STATION_UPDATES, DOMAIN
@ -11,7 +11,7 @@ from homeassistant.const import CONF_API_KEY, CONF_LATITUDE, CONF_LONGITUDE, CON
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
import homeassistant.util.dt as dt_util import homeassistant.util.dt as dt_util
from .util import aemet_requests_mock from .util import mock_api_call
from tests.common import MockConfigEntry from tests.common import MockConfigEntry
@ -28,9 +28,10 @@ CONFIG = {
async def test_form(hass: HomeAssistant, mock_setup_entry: AsyncMock) -> None: async def test_form(hass: HomeAssistant, mock_setup_entry: AsyncMock) -> None:
"""Test that the form is served with valid input.""" """Test that the form is served with valid input."""
with requests_mock.mock() as _m: with patch(
aemet_requests_mock(_m) "homeassistant.components.aemet.AEMET.api_call",
side_effect=mock_api_call,
):
result = await hass.config_entries.flow.async_init( result = await hass.config_entries.flow.async_init(
DOMAIN, context={"source": SOURCE_USER} DOMAIN, context={"source": SOURCE_USER}
) )
@ -64,9 +65,10 @@ async def test_form_options(hass: HomeAssistant) -> None:
now = dt_util.parse_datetime("2021-01-09 12:00:00+00:00") now = dt_util.parse_datetime("2021-01-09 12:00:00+00:00")
with patch("homeassistant.util.dt.now", return_value=now), patch( with patch("homeassistant.util.dt.now", return_value=now), patch(
"homeassistant.util.dt.utcnow", return_value=now "homeassistant.util.dt.utcnow", return_value=now
), requests_mock.mock() as _m: ), patch(
aemet_requests_mock(_m) "homeassistant.components.aemet.AEMET.api_call",
side_effect=mock_api_call,
):
entry = MockConfigEntry( entry = MockConfigEntry(
domain=DOMAIN, unique_id="40.30403754--3.72935236", data=CONFIG domain=DOMAIN, unique_id="40.30403754--3.72935236", data=CONFIG
) )
@ -120,9 +122,10 @@ async def test_form_duplicated_id(hass: HomeAssistant) -> None:
now = dt_util.parse_datetime("2021-01-09 12:00:00+00:00") now = dt_util.parse_datetime("2021-01-09 12:00:00+00:00")
with patch("homeassistant.util.dt.now", return_value=now), patch( with patch("homeassistant.util.dt.now", return_value=now), patch(
"homeassistant.util.dt.utcnow", return_value=now "homeassistant.util.dt.utcnow", return_value=now
), requests_mock.mock() as _m: ), patch(
aemet_requests_mock(_m) "homeassistant.components.aemet.AEMET.api_call",
side_effect=mock_api_call,
):
entry = MockConfigEntry( entry = MockConfigEntry(
domain=DOMAIN, unique_id="40.30403754--3.72935236", data=CONFIG domain=DOMAIN, unique_id="40.30403754--3.72935236", data=CONFIG
) )
@ -136,11 +139,10 @@ async def test_form_duplicated_id(hass: HomeAssistant) -> None:
assert result["reason"] == "already_configured" assert result["reason"] == "already_configured"
async def test_form_api_offline(hass: HomeAssistant) -> None: async def test_form_auth_error(hass: HomeAssistant) -> None:
"""Test setting up with api call error.""" """Test setting up with api auth error."""
mocked_aemet = MagicMock() mocked_aemet = MagicMock()
mocked_aemet.get_conventional_observation_stations.side_effect = AuthError
mocked_aemet.get_conventional_observation_stations.return_value = None
with patch( with patch(
"homeassistant.components.aemet.config_flow.AEMET", "homeassistant.components.aemet.config_flow.AEMET",

View File

@ -1,15 +1,13 @@
"""Define tests for the AEMET OpenData init.""" """Define tests for the AEMET OpenData init."""
from unittest.mock import patch from unittest.mock import patch
import requests_mock
from homeassistant.components.aemet.const import DOMAIN from homeassistant.components.aemet.const import DOMAIN
from homeassistant.config_entries import ConfigEntryState from homeassistant.config_entries import ConfigEntryState
from homeassistant.const import CONF_API_KEY, CONF_LATITUDE, CONF_LONGITUDE, CONF_NAME from homeassistant.const import CONF_API_KEY, CONF_LATITUDE, CONF_LONGITUDE, CONF_NAME
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
import homeassistant.util.dt as dt_util import homeassistant.util.dt as dt_util
from .util import aemet_requests_mock from .util import mock_api_call
from tests.common import MockConfigEntry from tests.common import MockConfigEntry
@ -27,9 +25,10 @@ async def test_unload_entry(hass: HomeAssistant) -> None:
now = dt_util.parse_datetime("2021-01-09 12:00:00+00:00") now = dt_util.parse_datetime("2021-01-09 12:00:00+00:00")
with patch("homeassistant.util.dt.now", return_value=now), patch( with patch("homeassistant.util.dt.now", return_value=now), patch(
"homeassistant.util.dt.utcnow", return_value=now "homeassistant.util.dt.utcnow", return_value=now
), requests_mock.mock() as _m: ), patch(
aemet_requests_mock(_m) "homeassistant.components.aemet.AEMET.api_call",
side_effect=mock_api_call,
):
config_entry = MockConfigEntry( config_entry = MockConfigEntry(
domain=DOMAIN, unique_id="aemet_unique_id", data=CONFIG domain=DOMAIN, unique_id="aemet_unique_id", data=CONFIG
) )

View File

@ -4,7 +4,6 @@ from unittest.mock import patch
from freezegun.api import FrozenDateTimeFactory from freezegun.api import FrozenDateTimeFactory
import pytest import pytest
import requests_mock
from syrupy.assertion import SnapshotAssertion from syrupy.assertion import SnapshotAssertion
from homeassistant.components.aemet.const import ATTRIBUTION, DOMAIN from homeassistant.components.aemet.const import ATTRIBUTION, DOMAIN
@ -36,7 +35,7 @@ from homeassistant.core import HomeAssistant
from homeassistant.helpers import entity_registry as er from homeassistant.helpers import entity_registry as er
import homeassistant.util.dt as dt_util import homeassistant.util.dt as dt_util
from .util import aemet_requests_mock, async_init_integration from .util import async_init_integration, mock_api_call
from tests.typing import WebSocketGenerator from tests.typing import WebSocketGenerator
@ -191,8 +190,10 @@ async def test_forecast_subscription(
assert forecast1 == snapshot assert forecast1 == snapshot
with requests_mock.mock() as _m: with patch(
aemet_requests_mock(_m) "homeassistant.components.aemet.AEMET.api_call",
side_effect=mock_api_call,
):
freezer.tick(WEATHER_UPDATE_INTERVAL + datetime.timedelta(seconds=1)) freezer.tick(WEATHER_UPDATE_INTERVAL + datetime.timedelta(seconds=1))
await hass.async_block_till_done() await hass.async_block_till_done()
msg = await client.receive_json() msg = await client.receive_json()

View File

@ -1,93 +1,74 @@
"""Tests for the AEMET OpenData integration.""" """Tests for the AEMET OpenData integration."""
from typing import Any
from unittest.mock import patch
import requests_mock from aemet_opendata.const import ATTR_DATA
from homeassistant.components.aemet import DOMAIN from homeassistant.components.aemet import DOMAIN
from homeassistant.const import CONF_API_KEY, CONF_LATITUDE, CONF_LONGITUDE, CONF_NAME from homeassistant.const import CONF_API_KEY, CONF_LATITUDE, CONF_LONGITUDE, CONF_NAME
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from tests.common import MockConfigEntry, load_fixture from tests.common import MockConfigEntry, load_json_value_fixture
FORECAST_DAILY_DATA_MOCK = {
ATTR_DATA: load_json_value_fixture("aemet/town-28065-forecast-daily-data.json"),
}
FORECAST_HOURLY_DATA_MOCK = {
ATTR_DATA: load_json_value_fixture("aemet/town-28065-forecast-hourly-data.json"),
}
STATION_DATA_MOCK = {
ATTR_DATA: load_json_value_fixture("aemet/station-3195-data.json"),
}
STATIONS_DATA_MOCK = {
ATTR_DATA: load_json_value_fixture("aemet/station-list-data.json"),
}
TOWN_DATA_MOCK = {
ATTR_DATA: load_json_value_fixture("aemet/town-id28065.json"),
}
TOWNS_DATA_MOCK = {
ATTR_DATA: load_json_value_fixture("aemet/town-list.json"),
}
def aemet_requests_mock(mock): def mock_api_call(cmd: str, fetch_data: bool = False) -> dict[str, Any]:
"""Mock requests performed to AEMET OpenData API.""" """Mock AEMET OpenData API calls."""
if cmd == "maestro/municipio/id28065":
station_3195_fixture = "aemet/station-3195.json" return TOWN_DATA_MOCK
station_3195_data_fixture = "aemet/station-3195-data.json" if cmd == "maestro/municipios":
station_list_fixture = "aemet/station-list.json" return TOWNS_DATA_MOCK
station_list_data_fixture = "aemet/station-list-data.json" if cmd == "observacion/convencional/datos/estacion/3195":
return STATION_DATA_MOCK
town_28065_forecast_daily_fixture = "aemet/town-28065-forecast-daily.json" if cmd == "observacion/convencional/todas":
town_28065_forecast_daily_data_fixture = "aemet/town-28065-forecast-daily-data.json" return STATIONS_DATA_MOCK
town_28065_forecast_hourly_fixture = "aemet/town-28065-forecast-hourly.json" if cmd == "prediccion/especifica/municipio/diaria/28065":
town_28065_forecast_hourly_data_fixture = ( return FORECAST_DAILY_DATA_MOCK
"aemet/town-28065-forecast-hourly-data.json" if cmd == "prediccion/especifica/municipio/horaria/28065":
) return FORECAST_HOURLY_DATA_MOCK
town_id28065_fixture = "aemet/town-id28065.json" return {}
town_list_fixture = "aemet/town-list.json"
mock.get(
"https://opendata.aemet.es/opendata/api/observacion/convencional/datos/estacion/3195",
text=load_fixture(station_3195_fixture),
)
mock.get(
"https://opendata.aemet.es/opendata/sh/208c3ca3",
text=load_fixture(station_3195_data_fixture),
)
mock.get(
"https://opendata.aemet.es/opendata/api/observacion/convencional/todas",
text=load_fixture(station_list_fixture),
)
mock.get(
"https://opendata.aemet.es/opendata/sh/2c55192f",
text=load_fixture(station_list_data_fixture),
)
mock.get(
"https://opendata.aemet.es/opendata/api/prediccion/especifica/municipio/diaria/28065",
text=load_fixture(town_28065_forecast_daily_fixture),
)
mock.get(
"https://opendata.aemet.es/opendata/sh/64e29abb",
text=load_fixture(town_28065_forecast_daily_data_fixture),
)
mock.get(
"https://opendata.aemet.es/opendata/api/prediccion/especifica/municipio/horaria/28065",
text=load_fixture(town_28065_forecast_hourly_fixture),
)
mock.get(
"https://opendata.aemet.es/opendata/sh/18ca1886",
text=load_fixture(town_28065_forecast_hourly_data_fixture),
)
mock.get(
"https://opendata.aemet.es/opendata/api/maestro/municipio/id28065",
text=load_fixture(town_id28065_fixture),
)
mock.get(
"https://opendata.aemet.es/opendata/api/maestro/municipios",
text=load_fixture(town_list_fixture),
)
async def async_init_integration( async def async_init_integration(hass: HomeAssistant):
hass: HomeAssistant,
skip_setup: bool = False,
):
"""Set up the AEMET OpenData integration in Home Assistant.""" """Set up the AEMET OpenData integration in Home Assistant."""
with requests_mock.mock() as _m: config_entry = MockConfigEntry(
aemet_requests_mock(_m) domain=DOMAIN,
data={
CONF_API_KEY: "api-key",
CONF_LATITUDE: "40.30403754",
CONF_LONGITUDE: "-3.72935236",
CONF_NAME: "AEMET",
},
)
config_entry.add_to_hass(hass)
entry = MockConfigEntry( with patch(
domain=DOMAIN, "homeassistant.components.aemet.AEMET.api_call",
data={ side_effect=mock_api_call,
CONF_API_KEY: "mock", ):
CONF_LATITUDE: "40.30403754", await hass.config_entries.async_setup(config_entry.entry_id)
CONF_LONGITUDE: "-3.72935236", await hass.async_block_till_done()
CONF_NAME: "AEMET",
},
)
entry.add_to_hass(hass)
if not skip_setup:
await hass.config_entries.async_setup(entry.entry_id)
await hass.async_block_till_done()