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 455 456
|
"""common test functions for pyenphase."""
import asyncio
import json
import logging
from collections.abc import Generator
from contextlib import contextmanager
from os import listdir
from os.path import isfile, join
from pathlib import Path
from typing import Any
import aiohttp
import orjson
from aioresponses import aioresponses
from awesomeversion import AwesomeVersion
from pyenphase import AUTH_TOKEN_MIN_VERSION, Envoy
from pyenphase.envoy import SupportedFeatures
from pyenphase.updaters.base import EnvoyUpdater
@contextmanager
def temporary_log_level(logger_name: str, level: int) -> Generator[None, None, None]:
"""Temporarily change the log level of a logger."""
logger = logging.getLogger(logger_name)
original_level = logger.level
logger.setLevel(level)
try:
yield
finally:
logger.setLevel(original_level)
def _fixtures_dir() -> Path:
"""Return location of fixture folder."""
return Path(__file__).parent / "fixtures"
def _load_fixture(path: str) -> str:
"""Return fixture file content as text."""
with open(path) as read_in:
return read_in.read()
async def load_fixture(version: str, name: str) -> str:
"""Return fixture file content as text in executor."""
path: str = f"{_fixtures_dir()}/{version}/{name}"
content: str = await asyncio.get_running_loop().run_in_executor(
None, _load_fixture, path
)
return content
async def load_json_fixture(version: str, name: str) -> dict[str, Any]:
"""Return fixture file content as JSON."""
json: str = await load_fixture(version, name)
return orjson.loads(json)
async def load_json_list_fixture(version: str, name: str) -> list[dict[str, Any]]:
"""Return list[json] fixture file content as json"""
json: str = await load_fixture(version, name)
return orjson.loads(json)
def _fixture_files(path: str) -> list[str]:
"""Get fixture files list"""
return [f for f in listdir(path) if isfile(join(path, f))]
async def fixture_files(version: str) -> list[str]:
"""Get fixture files list in executor"""
path: str = f"{_fixtures_dir()}/{version}"
files: list[str] = await asyncio.get_running_loop().run_in_executor(
None, _fixture_files, path
)
return files
def start_7_firmware_mock(mock_aioresponse: aioresponses) -> None:
"""Setup response mocks for Enlighten and Envoy token requests."""
# Use repeat=True since auth might create its own session
# Mock both with and without the trailing ?
mock_aioresponse.post(
"https://enlighten.enphaseenergy.com/login/login.json?",
status=200,
payload={
"session_id": "1234567890",
"user_id": "1234567890",
"user_name": "test",
"first_name": "Test",
"is_consumer": True,
"manager_token": "1234567890",
},
repeat=True,
)
mock_aioresponse.post(
"https://enlighten.enphaseenergy.com/login/login.json",
status=200,
payload={
"session_id": "1234567890",
"user_id": "1234567890",
"user_name": "test",
"first_name": "Test",
"is_consumer": True,
"manager_token": "1234567890",
},
repeat=True,
)
mock_aioresponse.post(
"https://entrez.enphaseenergy.com/tokens",
status=200,
body="token",
repeat=True,
)
# Mock the JWT check endpoint on the Envoy
mock_aioresponse.get("https://127.0.0.1/auth/check_jwt", status=200, repeat=True)
async def get_mock_envoy(
client_session: aiohttp.ClientSession | None, update: bool = True
) -> Envoy:
"""Return a mock Envoy."""
host = "127.0.0.1"
envoy = Envoy(host, client=client_session)
await envoy.setup()
await envoy.authenticate("username", "password")
if update:
await envoy.update()
await envoy.update() # make sure we can update twice
return envoy
def latest_request(
mock_aioresponse: aioresponses, method: str, url: str
) -> tuple[int, bytes]:
"""Return count of matched request and last request data."""
requests = [
req
for req in mock_aioresponse.requests
if req[0] == method and url in str(req[1])
]
if not requests:
return 0, b""
return len(requests), mock_aioresponse.requests[requests[-1]][-1].kwargs.get("data")
def override_mock(
mock_aioresponse: aioresponses, method: str, url: str, **kwargs: Any
) -> None:
"""Override an existing mock by removing it first and adding a new one."""
from yarl import URL
url_obj = URL(url)
# Remove existing mocks for this URL and method from _matches
keys_to_remove = []
for key, matcher in mock_aioresponse._matches.items():
# Check if this matches our URL and method
url_matches = False
if hasattr(matcher.url_or_pattern, "match"):
# It's a regex pattern
url_matches = bool(matcher.url_or_pattern.match(str(url_obj)))
else:
# It's a URL
url_matches = str(matcher.url_or_pattern).rstrip("/") == str(
url_obj
).rstrip("/")
if url_matches and matcher.method.lower() == method.lower():
keys_to_remove.append(key)
# Remove the matching mocks
for key in keys_to_remove:
del mock_aioresponse._matches[key]
# Add the new mock
getattr(mock_aioresponse, method.lower())(url, **kwargs)
def endpoint_path(version: str, host: str) -> str:
return f"http{'s' if AwesomeVersion(version.split('_')[0]) >= AUTH_TOKEN_MIN_VERSION else ''}://{host}"
async def prep_envoy(
mock_aioresponse: aioresponses,
host: str,
version: str, #: name of version folder to read fixtures from
) -> list[str]:
"""Setup response mocks for envoy requests and return list of found mock files."""
files: list[str] = await fixture_files(version)
# Helper to create full URLs
full_host = endpoint_path(version, host)
def url(path: str) -> str:
return f"{full_host}{path}"
def url_https(path: str) -> str:
return f"https://{host}{path}"
def url_http(path: str) -> str:
return f"http://{host}{path}"
mock_aioresponse.get(
url_http("/info"),
status=200,
body=await load_fixture(version, "info"),
repeat=True,
)
mock_aioresponse.get(
url_https("/info"),
status=200,
body=await load_fixture(version, "info"),
repeat=True,
)
mock_aioresponse.get(url("/info.xml"), status=200, body="", repeat=True)
if "ivp_meters" in files:
try:
mock_aioresponse.get(
url("/ivp/meters"),
status=200,
payload=(await load_json_fixture(version, "ivp_meters")),
repeat=True,
)
except json.decoder.JSONDecodeError:
# v3 fw with html return 401
mock_aioresponse.get(url("/ivp/meters"), status=401, repeat=True)
# mock_aioresponse.get(url_http("/ivp/meters"), status=401, repeat=True)
else:
mock_aioresponse.get(url("/ivp/meters"), status=404, repeat=True)
# mock_aioresponse.get(url_http("/ivp/meters"), status=404, repeat=True)
if "ivp_meters_readings" in files:
mock_aioresponse.get(
url("/ivp/meters/readings"),
status=200,
payload=await load_json_fixture(version, "ivp_meters_readings"),
repeat=True,
)
else:
mock_aioresponse.get(url("/ivp/meters/readings"), status=404, repeat=True)
# mock_aioresponse.get(url_http("/ivp/meters/readings"), status=404, repeat=True)
if "production" in files:
try:
json_data = await load_json_fixture(version, "production")
mock_aioresponse.get(
url("/production"), status=200, payload=json_data, repeat=True
)
except json.decoder.JSONDecodeError:
# v3 fw reports production in html format
mock_aioresponse.get(
url("/production"),
status=200,
body=await load_fixture(version, "production"),
repeat=True,
)
else:
mock_aioresponse.get(url("/production"), status=404, repeat=True)
# mock_aioresponse.get(url_http("/production"), status=404, repeat=True)
if "production.json" in files:
try:
json_data = await load_json_fixture(version, "production.json")
mock_aioresponse.get(
url("/production.json"), status=200, payload=json_data, repeat=True
)
mock_aioresponse.get(
url("/production.json?details=1"),
status=200,
payload=json_data,
repeat=True,
)
except json.decoder.JSONDecodeError:
mock_aioresponse.get(url("/production.json"), status=404, repeat=True)
# mock_aioresponse.get(url_http("/production.json"), status=404, repeat=True)
mock_aioresponse.get(
url("/production.json?details=1"), status=404, repeat=True
)
else:
mock_aioresponse.get(url("/production.json"), status=404, repeat=True)
if "api_v1_production" in files:
# Check if this is a bad_auth version by looking at the fixture content
api_v1_prod_data = await load_json_fixture(version, "api_v1_production")
status = (
401
if "status" in api_v1_prod_data and api_v1_prod_data["status"] == 401
else 200
)
mock_aioresponse.get(
url("/api/v1/production"),
status=status,
payload=api_v1_prod_data,
repeat=True,
)
else:
mock_aioresponse.get(url("/api/v1/production"), status=404, repeat=True)
if "api_v1_production_inverters" in files:
# Check if this is a bad_auth version by looking at the fixture content
api_v1_inv_data = await load_json_fixture(
version, "api_v1_production_inverters"
)
status = (
401
if isinstance(api_v1_inv_data, dict)
and "status" in api_v1_inv_data
and api_v1_inv_data["status"] == 401
else 200
)
mock_aioresponse.get(
url("/api/v1/production/inverters"),
status=status,
payload=api_v1_inv_data,
repeat=True,
)
else:
mock_aioresponse.get(
url("/api/v1/production/inverters"), status=404, repeat=True
)
if "ivp_ensemble_inventory" in files:
mock_aioresponse.get(
url("/ivp/ensemble/inventory"),
status=200,
payload=await load_json_fixture(version, "ivp_ensemble_inventory"),
repeat=True,
)
mock_aioresponse.get(
url_http("/ivp/ensemble/inventory"),
status=200,
payload=await load_json_fixture(version, "ivp_ensemble_inventory"),
repeat=True,
)
else:
mock_aioresponse.get(url("/ivp/ensemble/inventory"), status=404, repeat=True)
mock_aioresponse.get(
url_http("/ivp/ensemble/inventory"), status=404, repeat=True
)
if "ivp_ensemble_dry_contacts" in files:
try:
json_data = await load_json_fixture(version, "ivp_ensemble_dry_contacts")
except json.decoder.JSONDecodeError:
json_data = {}
mock_aioresponse.get(
url("/ivp/ensemble/dry_contacts"),
status=200,
payload=json_data,
repeat=True,
)
mock_aioresponse.post(
url("/ivp/ensemble/dry_contacts"),
status=200,
payload=json_data,
repeat=True,
)
if "ivp_ss_dry_contact_settings" in files:
try:
json_data = await load_json_fixture(version, "ivp_ss_dry_contact_settings")
except json.decoder.JSONDecodeError:
json_data = {}
mock_aioresponse.get(
url("/ivp/ss/dry_contact_settings"),
status=200,
payload=json_data,
repeat=True,
)
mock_aioresponse.post(
url("/ivp/ss/dry_contact_settings"),
status=200,
payload=json_data,
repeat=True,
)
if "ivp_ensemble_power" in files:
try:
json_data = await load_json_fixture(version, "ivp_ensemble_power")
except json.decoder.JSONDecodeError:
json_data = {}
mock_aioresponse.get(
url("/ivp/ensemble/power"), status=200, payload=json_data, repeat=True
)
if "ivp_ensemble_secctrl" in files:
try:
json_data = await load_json_fixture(version, "ivp_ensemble_secctrl")
except json.decoder.JSONDecodeError:
json_data = {}
mock_aioresponse.get(
url("/ivp/ensemble/secctrl"), status=200, payload=json_data, repeat=True
)
if "admin_lib_tariff" in files:
try:
json_data = await load_json_fixture(version, "admin_lib_tariff")
except json.decoder.JSONDecodeError:
json_data = {}
mock_aioresponse.get(
url("/admin/lib/tariff"), status=200, payload=json_data, repeat=True
)
mock_aioresponse.get(
url_http("/admin/lib/tariff"), status=200, payload=json_data, repeat=True
)
mock_aioresponse.put(
url("/admin/lib/tariff"), status=200, payload=json_data, repeat=True
)
else:
mock_aioresponse.get(url("/admin/lib/tariff"), status=404, repeat=True)
if "ivp_ss_gen_config" in files:
try:
json_data = await load_json_fixture(version, "ivp_ss_gen_config")
except json.decoder.JSONDecodeError:
json_data = {}
mock_aioresponse.get(
url("/ivp/ss/gen_config"), status=200, payload=json_data, repeat=True
)
else:
mock_aioresponse.get(
url("/ivp/ss/gen_config"), status=200, payload={}, repeat=True
)
if "home" in files:
mock_aioresponse.get(
url("/home"),
status=200,
payload=await load_json_fixture(version, "home"),
repeat=True,
)
else:
mock_aioresponse.get(url("/home"), status=404, repeat=True)
if "ivp_pdm_device_data" in files:
mock_aioresponse.get(
url("/ivp/pdm/device_data"),
status=200,
payload=await load_json_fixture(version, "ivp_pdm_device_data"),
repeat=True,
)
else:
mock_aioresponse.get(url("/ivp/pdm/device_data"), status=404, repeat=True)
return files
def updater_features(updaters: list[EnvoyUpdater]) -> dict[str, SupportedFeatures]:
"""Return the updater supported features flags"""
return {type(updater).__name__: updater._supported_features for updater in updaters}
|