1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
|
"""Tests for the EnergyZero REST API."""
# pylint: disable=protected-access
import json
from datetime import date, timedelta
import pytest
from aresponses import ResponsesMockServer
from energyzero import EnergyPrices, EnergyZero, PriceType
from energyzero.exceptions import EnergyZeroConnectionError, EnergyZeroNoDataError
from . import load_fixtures
async def test_rest_electricity_prices_quarter_hour(
aresponses: ResponsesMockServer, energyzero_client: EnergyZero
) -> None:
"""Test getting quarter-hour electricity prices from REST API."""
aresponses.add(
"public.api.energyzero.nl",
"/public/v1/prices",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=load_fixtures("rest/electricity_quarter_response.json"),
),
)
result = await energyzero_client.get_electricity_prices(
start_date=date(2025, 12, 17),
end_date=date(2025, 12, 17),
interval="INTERVAL_QUARTER",
price_type=PriceType.ALL_IN,
)
assert result is not None
assert result.average_price is not None
assert len(result.prices) > 0
await energyzero_client.close()
async def test_rest_electricity_prices_hourly(
aresponses: ResponsesMockServer, energyzero_client: EnergyZero
) -> None:
"""Test getting hourly electricity prices from REST API."""
aresponses.add(
"public.api.energyzero.nl",
"/public/v1/prices",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=load_fixtures("rest/electricity_hour_response.json"),
),
)
result = await energyzero_client.get_electricity_prices(
start_date=date(2025, 12, 17),
end_date=date(2025, 12, 17),
interval="INTERVAL_HOUR",
price_type=PriceType.ALL_IN,
)
assert result is not None
assert result.average_price is not None
assert len(result.prices) > 0
await energyzero_client.close()
async def test_rest_electricity_prices_market(
aresponses: ResponsesMockServer, energyzero_client: EnergyZero
) -> None:
"""Test getting market electricity prices from REST API."""
aresponses.add(
"public.api.energyzero.nl",
"/public/v1/prices",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=load_fixtures("rest/electricity_hour_response.json"),
),
)
result = await energyzero_client.get_electricity_prices(
start_date=date(2025, 12, 17),
end_date=date(2025, 12, 17),
price_type=PriceType.MARKET,
)
assert result is not None
assert result.average_price is not None
assert len(result.prices) > 0
# Verify market prices are lower than all-in prices
# (since they don't include energy tax)
await energyzero_client.close()
async def test_rest_gas_prices(
aresponses: ResponsesMockServer, energyzero_client: EnergyZero
) -> None:
"""Test getting gas prices from REST API."""
aresponses.add(
"public.api.energyzero.nl",
"/public/v1/prices",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=load_fixtures("rest/gas_day_response.json"),
),
)
result = await energyzero_client.get_gas_prices(
start_date=date(2025, 12, 17),
end_date=date(2025, 12, 17),
price_type=PriceType.ALL_IN,
)
assert result is not None
assert result.average_price is not None
assert len(result.prices) > 0
await energyzero_client.close()
async def test_rest_electricity_no_data(
aresponses: ResponsesMockServer, energyzero_client: EnergyZero
) -> None:
"""Test handling of empty response from REST API."""
aresponses.add(
"public.api.energyzero.nl",
"/public/v1/prices",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=json.dumps(
{
"interval": 2,
"range": {},
"base": [],
"base_with_vat": [],
"all_in": [],
"all_in_with_vat": [],
}
),
),
)
with pytest.raises(EnergyZeroNoDataError):
await energyzero_client.get_electricity_prices(
start_date=date(2025, 12, 17),
end_date=date(2025, 12, 17),
)
await energyzero_client.close()
async def test_rest_gas_no_data(
aresponses: ResponsesMockServer, energyzero_client: EnergyZero
) -> None:
"""Test handling of empty gas response from REST API."""
aresponses.add(
"public.api.energyzero.nl",
"/public/v1/prices",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=json.dumps(
{
"interval": 4,
"range": {},
"base": [],
"base_with_vat": [],
"all_in": [],
"all_in_with_vat": [],
}
),
),
)
with pytest.raises(EnergyZeroNoDataError):
await energyzero_client.get_gas_prices(
start_date=date(2025, 12, 17),
end_date=date(2025, 12, 17),
)
await energyzero_client.close()
async def test_rest_url_building(
aresponses: ResponsesMockServer, energyzero_client: EnergyZero
) -> None:
"""Test that REST API URLs are built correctly."""
aresponses.add(
"public.api.energyzero.nl",
"/public/v1/prices",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=load_fixtures("rest/electricity_hour_response.json"),
),
)
# This should use public.api.energyzero.nl instead of api.energyzero.nl
result = await energyzero_client.get_electricity_prices(
start_date=date(2025, 12, 17),
end_date=date(2025, 12, 17),
)
assert result is not None
await energyzero_client.close()
async def test_rest_electricity_invalid_range(
energyzero_client: EnergyZero,
) -> None:
"""Ensure REST backend raises when multiple days requested."""
start_date = date(2025, 12, 17)
end_date = start_date + timedelta(days=1)
with pytest.raises(ValueError, match="single-day"):
await energyzero_client.get_electricity_prices(
start_date=start_date,
end_date=end_date,
)
async def test_rest_gas_invalid_range(energyzero_client: EnergyZero) -> None:
"""Ensure REST backend raises when multiple days requested for gas."""
start_date = date(2025, 12, 17)
end_date = start_date + timedelta(days=1)
with pytest.raises(ValueError, match="single-day"):
await energyzero_client.get_gas_prices(
start_date=start_date,
end_date=end_date,
)
async def test_rest_bad_request(
aresponses: ResponsesMockServer, energyzero_client: EnergyZero
) -> None:
"""Ensure REST backend surfaces HTTP errors."""
aresponses.add(
"public.api.energyzero.nl",
"/public/v1/prices",
"GET",
aresponses.Response(
status=400,
headers={"Content-Type": "application/json"},
text=load_fixtures("rest/error_response.json"),
),
)
with pytest.raises(EnergyZeroConnectionError):
await energyzero_client.get_electricity_prices(
start_date=date(2025, 12, 17),
)
await energyzero_client.close()
async def test_rest_bad_request_invalid_json_payload(
aresponses: ResponsesMockServer, energyzero_client: EnergyZero
) -> None:
"""Ensure REST backend handles invalid JSON error payloads."""
aresponses.add(
"public.api.energyzero.nl",
"/public/v1/prices",
"GET",
aresponses.Response(
status=400,
headers={"Content-Type": "text/plain"},
text="not-json",
),
)
with pytest.raises(EnergyZeroConnectionError) as err:
await energyzero_client.get_electricity_prices(
start_date=date(2025, 12, 17),
)
assert err.value.data is None
await energyzero_client.close()
async def test_rest_future_date_returns_no_data(
aresponses: ResponsesMockServer, energyzero_client: EnergyZero
) -> None:
"""Ensure future dates raise a no-data error (404)."""
aresponses.add(
"public.api.energyzero.nl",
"/public/v1/prices",
"GET",
aresponses.Response(
status=404,
headers={"Content-Type": "application/json"},
text='{"code":3,"message":"not found"}',
),
)
with pytest.raises(EnergyZeroNoDataError):
await energyzero_client.get_electricity_prices(
start_date=date(2030, 1, 1),
)
async def test_rest_electricity_filtered_out_by_date(
aresponses: ResponsesMockServer, energyzero_client: EnergyZero
) -> None:
"""Ensure filtered-out entries raise no-data errors."""
payload = {
"interval": 2,
"range": {},
"base": [
{
"start": "2025-12-20T00:00:00Z",
"end": "2025-12-20T00:15:00Z",
"price": {"value": "0.10"},
}
],
"base_with_vat": [
{
"start": "2025-12-20T00:00:00Z",
"end": "2025-12-20T00:15:00Z",
"price": {"value": "0.12"},
}
],
"all_in_with_vat": [
{
"start": "2025-12-20T00:00:00Z",
"end": "2025-12-20T00:15:00Z",
"price": {"value": "0.15"},
}
],
}
aresponses.add(
"public.api.energyzero.nl",
"/public/v1/prices",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=json.dumps(payload),
),
)
with pytest.raises(EnergyZeroNoDataError):
await energyzero_client.get_electricity_prices(
start_date=date(2025, 12, 17),
)
await energyzero_client.close()
async def test_rest_gas_filtered_out_by_date(
aresponses: ResponsesMockServer, energyzero_client: EnergyZero
) -> None:
"""Ensure gas filtering raises no-data errors."""
payload = {
"interval": 4,
"range": {},
"base": [
{
"start": "2025-12-20T00:00:00Z",
"end": "2025-12-21T00:00:00Z",
"price": {"value": "1.10"},
}
],
"base_with_vat": [
{
"start": "2025-12-20T00:00:00Z",
"end": "2025-12-21T00:00:00Z",
"price": {"value": "1.12"},
}
],
"all_in_with_vat": [
{
"start": "2025-12-20T00:00:00Z",
"end": "2025-12-21T00:00:00Z",
"price": {"value": "1.15"},
}
],
}
aresponses.add(
"public.api.energyzero.nl",
"/public/v1/prices",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=json.dumps(payload),
),
)
with pytest.raises(EnergyZeroNoDataError):
await energyzero_client.get_gas_prices(
start_date=date(2025, 12, 17),
)
await energyzero_client.close()
def test_rest_from_rest_dict_without_filter_date() -> None:
"""Ensure parsing works for each price type without filtering."""
payload = {
"base": [
{
"start": "2025-12-17T00:00:00Z",
"end": "2025-12-17T00:15:00Z",
"price": {"value": "0.05"},
}
],
"base_with_vat": [
{
"start": "2025-12-17T00:00:00Z",
"end": "2025-12-17T00:15:00Z",
"price": {"value": "0.06"},
}
],
"all_in": [
{
"start": "2025-12-17T00:00:00Z",
"end": "2025-12-17T00:15:00Z",
"price": {"value": "0.07"},
}
],
"all_in_with_vat": [
{
"start": "2025-12-17T00:00:00Z",
"end": "2025-12-17T00:15:00Z",
"price": {"value": "0.08"},
}
],
}
assert EnergyPrices.from_rest_dict(payload, PriceType.MARKET).average_price == 0.05
assert (
EnergyPrices.from_rest_dict(payload, PriceType.MARKET_WITH_VAT).average_price
== 0.06
)
assert (
EnergyPrices.from_rest_dict(payload, PriceType.ALL_IN_EXCL_VAT).average_price
== 0.07
)
assert EnergyPrices.from_rest_dict(payload, PriceType.ALL_IN).average_price == 0.08
|