File: conftest.py

package info (click to toggle)
python-aiopvpc 4.3.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 592 kB
  • sloc: python: 1,415; makefile: 7
file content (169 lines) | stat: -rw-r--r-- 6,178 bytes parent folder | download
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
"""Tests for aiopvpc."""

from __future__ import annotations

import json
import logging
import pathlib
import zoneinfo
from datetime import date, datetime, timedelta
from typing import TYPE_CHECKING

from aiopvpc.const import (
    ESIOS_INJECTION,
    ESIOS_MAG,
    ESIOS_MARKET_ADJUSTMENT,
    ESIOS_OMIE,
    ESIOS_PVPC,
    KEY_PVPC,
)

if TYPE_CHECKING:
    from aiopvpc.pvpc_data import EsiosApiData, PVPCData

TEST_EXAMPLES_PATH = pathlib.Path(__file__).parent / "api_examples"
TZ_TEST = zoneinfo.ZoneInfo("Atlantic/Canary")

_FIXTURE_DATA_2021_10_30 = "PVPC_CURV_DD_2021_10_30.json"
_FIXTURE_DATA_2021_10_31 = "PVPC_CURV_DD_2021_10_31.json"
_FIXTURE_DATA_2022_03_27 = "PVPC_CURV_DD_2022_03_27.json"
_FIXTURE_DATA_2021_06_01 = "PVPC_CURV_DD_2021_06_01.json"
_FIXTURE_ESIOS_PVPC_2021_10_30 = "PRICES_ESIOS_1001_2021_10_30.json"
_FIXTURE_ESIOS_PVPC_2021_10_31 = "PRICES_ESIOS_1001_2021_10_31.json"
_FIXTURE_ESIOS_PVPC_2021_06_01 = "PRICES_ESIOS_1001_2021_06_01.json"
_FIXTURE_ESIOS_PVPC_2024_03_09 = "PRICES_ESIOS_1001_2024_03_09.json"
_FIXTURE_ESIOS_INJECTION_2021_10_30 = "PRICES_ESIOS_1739_2021_10_30.json"
_FIXTURE_ESIOS_INJECTION_2021_10_31 = "PRICES_ESIOS_1739_2021_10_31.json"
_FIXTURE_ESIOS_INJECTION_2024_03_09 = "PRICES_ESIOS_1739_2024_03_09.json"
_FIXTURE_ESIOS_OMIE_2021_10_30 = "PRICES_ESIOS_10211_2021_10_30.json"
_FIXTURE_ESIOS_OMIE_2021_10_31 = "PRICES_ESIOS_10211_2021_10_31.json"
_FIXTURE_ESIOS_OMIE_2024_03_09 = "PRICES_ESIOS_10211_2024_03_09.json"
_FIXTURE_ESIOS_MAG_2024_03_09 = "PRICES_ESIOS_1900_2024_03_09.json"
_FIXTURE_ESIOS_ADJUSTMENT_2024_03_09 = "PRICES_ESIOS_2108_2024_03_09.json"

_DEFAULT_EMPTY_VALUE = {"message": "No values for specified archive"}
_DEFAULT_UNAUTH_MSG = "HTTP Token: Access denied (TEST)."


class MockAsyncSession:
    """Mock GET requests to esios API."""

    status: int = 200
    _counter: int = 0
    _raw_response = None

    def __aenter__(self):
        return self

    async def __aexit__(self, exc_type, exc_val, exc_tb):
        pass

    def __await__(self):
        yield
        return self

    async def close(self, *_args):
        pass

    def __init__(self, status=200, exc=None):
        """Set up desired mock response"""
        self._raw_response = _DEFAULT_EMPTY_VALUE
        self.status = status
        self.exc = exc

        self.responses_public = {
            date(2022, 3, 27): load_fixture(_FIXTURE_DATA_2022_03_27),
            date(2021, 10, 30): load_fixture(_FIXTURE_DATA_2021_10_30),
            date(2021, 10, 31): load_fixture(_FIXTURE_DATA_2021_10_31),
            date(2021, 6, 1): load_fixture(_FIXTURE_DATA_2021_06_01),
        }
        self.responses_token = {
            ESIOS_PVPC: {
                date(2021, 10, 30): load_fixture(_FIXTURE_ESIOS_PVPC_2021_10_30),
                date(2021, 10, 31): load_fixture(_FIXTURE_ESIOS_PVPC_2021_10_31),
                date(2021, 6, 1): load_fixture(_FIXTURE_ESIOS_PVPC_2021_06_01),
                date(2024, 3, 9): load_fixture(_FIXTURE_ESIOS_PVPC_2024_03_09),
            },
            ESIOS_INJECTION: {
                date(2021, 10, 30): load_fixture(_FIXTURE_ESIOS_INJECTION_2021_10_30),
                date(2021, 10, 31): load_fixture(_FIXTURE_ESIOS_INJECTION_2021_10_31),
                date(2024, 3, 9): load_fixture(_FIXTURE_ESIOS_INJECTION_2024_03_09),
            },
            ESIOS_MAG: {
                date(2024, 3, 9): load_fixture(_FIXTURE_ESIOS_MAG_2024_03_09),
            },
            ESIOS_OMIE: {
                date(2021, 10, 30): load_fixture(_FIXTURE_ESIOS_OMIE_2021_10_30),
                date(2021, 10, 31): load_fixture(_FIXTURE_ESIOS_OMIE_2021_10_31),
                date(2024, 3, 9): load_fixture(_FIXTURE_ESIOS_OMIE_2024_03_09),
            },
            ESIOS_MARKET_ADJUSTMENT: {
                date(2024, 3, 9): load_fixture(_FIXTURE_ESIOS_ADJUSTMENT_2024_03_09)
            },
        }

    async def json(self, *_args, **_kwargs):
        """Dumb await."""
        return self._raw_response

    async def get(self, url: str, *_args, **_kwargs):
        """Dumb await."""
        self._counter += 1
        if self.exc:
            raise self.exc

        prefix_public = "https://api.esios.ree.es/archives/"
        prefix_token = "https://api.esios.ree.es/indicators/"
        key = datetime.fromisoformat(url.split("=")[-1]).date()
        if url.startswith(prefix_token):
            indicator = url.removeprefix(prefix_token).split("?")[0]
            self._raw_response = self.responses_token.get(indicator, {}).get(
                key, _DEFAULT_UNAUTH_MSG
            )
        elif url.startswith(prefix_public) and key in self.responses_public:
            self._raw_response = self.responses_public[key]
        else:
            self._raw_response = _DEFAULT_EMPTY_VALUE
        return self

    @property
    def call_count(self) -> int:
        """Return call counter."""
        return self._counter


def load_fixture(filename: str):
    """Load stored example for esios API response."""
    return json.loads((TEST_EXAMPLES_PATH / filename).read_text())


async def run_h_step(
    mock_session: MockAsyncSession,
    pvpc_data: PVPCData,
    api_data: EsiosApiData | None,
    start: datetime,
    should_fail: bool = False,
) -> tuple[datetime, EsiosApiData]:
    current_prices = api_data.sensors[KEY_PVPC] if api_data else {}
    if current_prices:
        logging.debug(
            "[Calls=%d]-> start=%s --> %s -> %s (%d prices)",
            mock_session.call_count,
            start,
            next(iter(current_prices)).strftime("%Y-%m-%d %Hh"),
            list(current_prices)[-1].strftime("%Y-%m-%d %Hh"),
            len(current_prices),
        )
    api_data = await pvpc_data.async_update_all(api_data, start)
    state_ok = pvpc_data.process_state_and_attributes(api_data, KEY_PVPC, start)
    assert should_fail is not state_ok
    start += timedelta(hours=1)
    return start, api_data


def check_num_datapoints(
    api_data: EsiosApiData, sensor_keys: tuple[str, ...], expected: int
):
    for key in sensor_keys:
        num_points = len(api_data.sensors[key])
        assert num_points == expected, (key, expected, num_points)