* ✨ Implement optional API token in config-flow + options to make the data download from an authenticated path in ESIOS server As this is an *alternative* access, and current public path works for the PVPC, no user (current or new) is compelled to obtain a token, and it can be enabled anytime in options, or doing the setup again When enabling the token, it is verified (or "invalid_auth" error), and a 'reauth' flow is implemented, which can change or disable the token if it starts failing. The 1st step of config/options flow adds a bool to enable this private access, - if unchecked (default), entry is set for public access (like before) - if checked, a 2nd step opens to input the token, with instructions of how to get one (with a direct link to create a 'request email'). If the token is valid, the entry is set for authenticated access The 'reauth' flow shows the boolean flag so the user could disable a bad token by unchecking the boolean flag 'use_api_token' * ♻️ Remove storage of flag 'use_api_token' in config entry leaving it only to enable/disable the optional token in the config-flow * ♻️ Adjust async_update_options * ✨ Add new price sensors with API token access New price sensors added: - Injection price: price of excess energy from self-consumption - OMIE price: electricity price in the 'open' market - MAG price: Temporal tax cost for gas compensation * ✅ Adapt tests to work with multiple sensors * 🐛 Fix all integration sensors going unavailable when any sensor lacks data for the current day (usually the 'OMIE price') * Fix rebase * Customize icons and display precision for new sensors * Disable MAG Tax and OMIE price sensors by default * Move logic to assign sensor unique ids to integration * Move helper functions to helpers.py * Fix sensor activation for API download
87 lines
3.2 KiB
Python
87 lines
3.2 KiB
Python
"""Tests for the pvpc_hourly_pricing integration."""
|
|
from http import HTTPStatus
|
|
|
|
import pytest
|
|
|
|
from homeassistant.components.pvpc_hourly_pricing import ATTR_TARIFF, DOMAIN
|
|
from homeassistant.const import ATTR_UNIT_OF_MEASUREMENT, CURRENCY_EURO, UnitOfEnergy
|
|
|
|
from tests.common import load_fixture
|
|
from tests.test_util.aiohttp import AiohttpClientMocker
|
|
|
|
FIXTURE_JSON_PUBLIC_DATA_2023_01_06 = "PVPC_DATA_2023_01_06.json"
|
|
FIXTURE_JSON_ESIOS_DATA_PVPC_2023_01_06 = "PRICES_ESIOS_1001_2023_01_06.json"
|
|
_ESIOS_INDICATORS_FOR_EACH_SENSOR = ("1001", "1739", "1900", "10211")
|
|
|
|
|
|
def check_valid_state(state, tariff: str, value=None, key_attr=None):
|
|
"""Ensure that sensor has a valid state and attributes."""
|
|
assert state
|
|
assert (
|
|
state.attributes[ATTR_UNIT_OF_MEASUREMENT]
|
|
== f"{CURRENCY_EURO}/{UnitOfEnergy.KILO_WATT_HOUR}"
|
|
)
|
|
try:
|
|
_ = float(state.state)
|
|
# safety margins for current electricity price (it shouldn't be out of [0, 0.5])
|
|
assert -0.1 < float(state.state) < 0.5
|
|
assert state.attributes[ATTR_TARIFF] == tariff
|
|
except ValueError:
|
|
pass
|
|
|
|
if value is not None and isinstance(value, str):
|
|
assert state.state == value
|
|
elif value is not None:
|
|
assert abs(float(state.state) - value) < 1e-6
|
|
if key_attr is not None:
|
|
assert abs(float(state.state) - state.attributes[key_attr]) < 1e-6
|
|
|
|
|
|
@pytest.fixture
|
|
def pvpc_aioclient_mock(aioclient_mock: AiohttpClientMocker):
|
|
"""Create a mock config entry."""
|
|
mask_url_public = (
|
|
"https://api.esios.ree.es/archives/70/download_json?locale=es&date={0}"
|
|
)
|
|
mask_url_esios = (
|
|
"https://api.esios.ree.es/indicators/{0}"
|
|
"?start_date={1}T00:00&end_date={1}T23:59"
|
|
)
|
|
example_day = "2023-01-06"
|
|
aioclient_mock.get(
|
|
mask_url_public.format(example_day),
|
|
text=load_fixture(f"{DOMAIN}/{FIXTURE_JSON_PUBLIC_DATA_2023_01_06}"),
|
|
)
|
|
for esios_ind in _ESIOS_INDICATORS_FOR_EACH_SENSOR:
|
|
aioclient_mock.get(
|
|
mask_url_esios.format(esios_ind, example_day),
|
|
text=load_fixture(f"{DOMAIN}/{FIXTURE_JSON_ESIOS_DATA_PVPC_2023_01_06}"),
|
|
)
|
|
|
|
# simulate missing days
|
|
aioclient_mock.get(
|
|
mask_url_public.format("2023-01-07"),
|
|
status=HTTPStatus.OK,
|
|
text='{"message":"No values for specified archive"}',
|
|
)
|
|
for esios_ind in _ESIOS_INDICATORS_FOR_EACH_SENSOR:
|
|
aioclient_mock.get(
|
|
mask_url_esios.format(esios_ind, "2023-01-07"),
|
|
status=HTTPStatus.OK,
|
|
text=(
|
|
'{"indicator":{"name":"Término de facturación de energía activa del '
|
|
'PVPC 2.0TD","short_name":"PVPC T. 2.0TD","id":1001,"composited":false,'
|
|
'"step_type":"linear","disaggregated":true,"magnitud":'
|
|
'[{"name":"Precio","id":23}],"tiempo":[{"name":"Hora","id":4}],"geos":[],'
|
|
'"values_updated_at":null,"values":[]}}'
|
|
).replace("1001", esios_ind),
|
|
)
|
|
# simulate bad authentication
|
|
for esios_ind in _ESIOS_INDICATORS_FOR_EACH_SENSOR:
|
|
aioclient_mock.get(
|
|
mask_url_esios.format(esios_ind, "2023-01-08"),
|
|
status=HTTPStatus.UNAUTHORIZED,
|
|
text="HTTP Token: Access denied.",
|
|
)
|
|
|
|
return aioclient_mock
|