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 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
|
"""Test tenacity retry functioning."""
import asyncio
import logging
from typing import Any
import aiohttp
import pytest
from aioresponses import aioresponses
from tenacity import stop_after_attempt, stop_after_delay, wait_none
from pyenphase import Envoy
from pyenphase.exceptions import (
EnvoyAuthenticationRequired,
EnvoyCommunicationError,
EnvoyFirmwareCheckError,
EnvoyFirmwareFatalCheckError,
EnvoyHTTPStatusError,
)
from .common import load_fixture, override_mock, prep_envoy, start_7_firmware_mock
# Helper function to create ClientConnectorError
def _make_client_connector_error(msg="Test error"):
"""Create a ClientConnectorError that can be converted to string."""
# Create a simple mock object with the minimal attributes needed
class MockConnKey:
ssl = True
host = "127.0.0.1"
port = 443
return aiohttp.ClientConnectorError(
connection_key=MockConnKey(), os_error=OSError(msg)
)
LOGGER = logging.getLogger(__name__)
@pytest.mark.asyncio
async def test_full_connected_from_start_with_7_6_175_standard(
mock_aioresponse: aioresponses, test_client_session: aiohttp.ClientSession
) -> None:
"""Test envoy connected and replying from start"""
version = "7.6.175_standard"
start_7_firmware_mock(mock_aioresponse)
await prep_envoy(mock_aioresponse, "127.0.0.1", version)
envoy = Envoy("127.0.0.1", client=test_client_session)
# remove the waits between retries for this test and set known retries
envoy._firmware._get_info.retry.wait = wait_none()
envoy._firmware._get_info.retry.stop = stop_after_attempt(3) | stop_after_delay(50)
await envoy.setup()
await envoy.authenticate("username", "password")
# Ensure that there was 1 attempt only.
stats: dict[str, Any] = envoy._firmware._get_info.statistics
assert "attempt_number" in stats
assert stats["attempt_number"] == 1
assert envoy.firmware == "7.6.175"
assert envoy.part_number == "800-00656-r06"
data = await envoy.update()
assert data
@pytest.mark.asyncio
async def test_full_disconnected_from_start_with_7_6_175_standard(
mock_aioresponse: aioresponses, test_client_session: aiohttp.ClientSession
) -> None:
"""Test envoy disconnect at start, should return EnvoyFirmwareFatalCheckError."""
start_7_firmware_mock(mock_aioresponse)
envoy = Envoy("127.0.0.1", client=test_client_session)
# remove the waits between retries for this test and set known retries
envoy._firmware._get_info.retry.wait = wait_none()
envoy._firmware._get_info.retry.stop = stop_after_attempt(3) | stop_after_delay(50)
# Mock both HTTPS and HTTP since firmware code falls back to HTTP
mock_aioresponse.get(
"https://127.0.0.1/info",
exception=_make_client_connector_error("Test timeoutexception"),
repeat=True,
)
mock_aioresponse.get(
"http://127.0.0.1/info",
exception=_make_client_connector_error("Test timeoutexception"),
repeat=True,
)
with pytest.raises(
EnvoyFirmwareFatalCheckError, match="Unable to connect to Envoy"
):
await envoy.setup()
# Ensure that there were 3 attempts.
stats: dict[str, Any] = envoy._firmware._get_info.statistics
assert "attempt_number" in stats
assert stats["attempt_number"] == 3
@pytest.mark.asyncio
async def test_2_timeout_from_start_with_7_6_175_standard(
mock_aioresponse: aioresponses, test_client_session: aiohttp.ClientSession
) -> None:
"""Test envoy timeout at start, timeout is not in retry loop."""
start_7_firmware_mock(mock_aioresponse)
envoy = Envoy("127.0.0.1", client=test_client_session)
envoy._firmware._get_info.retry.wait = wait_none()
envoy._firmware._get_info.retry.stop = stop_after_attempt(3) | stop_after_delay(50)
# test if 2 timeouts return failed
mock_aioresponse.get(
"https://127.0.0.1/info",
exception=asyncio.TimeoutError("Test timeoutexception"),
)
mock_aioresponse.get(
"http://127.0.0.1/info", exception=asyncio.TimeoutError("Test timeoutexception")
)
with pytest.raises(
EnvoyFirmwareFatalCheckError, match="Timeout connecting to Envoy"
):
await envoy.setup()
# Ensure that there were retries.
stats: dict[str, Any] = envoy._firmware._get_info.statistics
assert "attempt_number" in stats
assert stats["attempt_number"] == 1
@pytest.mark.asyncio
async def test_httperror_from_start_with_7_6_175_standard(
mock_aioresponse: aioresponses, test_client_session: aiohttp.ClientSession
) -> None:
"""Test envoy httperror at start, is not in retry loop."""
start_7_firmware_mock(mock_aioresponse)
# Don't call prep_envoy because we want to control the /info response
envoy = Envoy("127.0.0.1", client=test_client_session)
envoy._firmware._get_info.retry.wait = wait_none()
envoy._firmware._get_info.retry.stop = stop_after_attempt(3) | stop_after_delay(50)
# The test expects no retries, which means we need to trigger the code path
# that doesn't retry. Since _get_info retries all exceptions, we need to
# make the first attempt succeed but return bad data that causes setup() to fail
mock_aioresponse.get(
"https://127.0.0.1/info",
status=500, # Return HTTP error status
body="Server Error",
)
with pytest.raises(EnvoyFirmwareCheckError, match="500"):
await envoy.setup()
# Ensure that there were retries.
stats: dict[str, Any] = envoy._firmware._get_info.statistics
assert "attempt_number" in stats
assert stats["attempt_number"] == 1
@pytest.mark.asyncio
async def test_1_timeout_from_start_with_7_6_175_standard(
mock_aioresponse: aioresponses, test_client_session: aiohttp.ClientSession
) -> None:
"""Test envoy timeout at start, timeout is not in retry loop but tries http after https."""
version = "7.6.175_standard"
start_7_firmware_mock(mock_aioresponse)
await prep_envoy(mock_aioresponse, "127.0.0.1", version)
envoy = Envoy("127.0.0.1", client=test_client_session)
envoy._firmware._get_info.retry.wait = wait_none()
envoy._firmware._get_info.retry.stop = stop_after_attempt(3) | stop_after_delay(50)
# test if 2 timeouts return failed
mock_aioresponse.get(
"https://127.0.0.1/info",
exception=asyncio.TimeoutError("Test timeoutexception"),
)
mock_aioresponse.get(
"http://127.0.0.1/info", status=200, body=await load_fixture(version, "info")
)
await envoy.setup()
await envoy.authenticate("username", "password")
# Ensure that there were retries.
stats: dict[str, Any] = envoy._firmware._get_info.statistics
assert "attempt_number" in stats
assert stats["attempt_number"] == 1
assert envoy.firmware == "7.6.175"
assert envoy.part_number == "800-00656-r06"
data = await envoy.update()
assert data
@pytest.mark.asyncio
async def test_5_not_connected_at_start_with_7_6_175_standard(
mock_aioresponse: aioresponses, test_client_session: aiohttp.ClientSession
) -> None:
"""Test 5 connection failures at start and last one works"""
version = "7.6.175_standard"
start_7_firmware_mock(mock_aioresponse)
# Don't call prep_envoy because we want to control the /info response
envoy = Envoy("127.0.0.1", client=test_client_session)
# remove the waits between retries for this test and set known retries
envoy._firmware._get_info.retry.wait = wait_none()
envoy._firmware._get_info.retry.stop = stop_after_attempt(3) | stop_after_delay(50)
# Each retry attempt tries HTTPS first, then falls back to HTTP
# We want 2 full failures (4 requests) then success on the 3rd attempt (request 5-6)
# Attempt 1: HTTPS fails, HTTP fails
mock_aioresponse.get(
"https://127.0.0.1/info",
exception=_make_client_connector_error("Test timeoutexception"),
)
mock_aioresponse.get(
"http://127.0.0.1/info",
exception=_make_client_connector_error("Test timeoutexception"),
)
# Attempt 2: HTTPS fails, HTTP fails
mock_aioresponse.get(
"https://127.0.0.1/info",
exception=_make_client_connector_error("Test timeoutexception"),
)
mock_aioresponse.get(
"http://127.0.0.1/info",
exception=_make_client_connector_error("Test timeoutexception"),
)
# Attempt 3: HTTPS fails, HTTP succeeds
mock_aioresponse.get(
"https://127.0.0.1/info",
exception=_make_client_connector_error("Test timeoutexception"),
)
mock_aioresponse.get(
"http://127.0.0.1/info", status=200, body=await load_fixture(version, "info")
)
await envoy.setup()
await envoy.authenticate("username", "password")
# Ensure that there were retries.
stats: dict[str, Any] = envoy._firmware._get_info.statistics
assert "attempt_number" in stats
assert stats["attempt_number"] == 3
assert envoy.firmware == "7.6.175"
assert envoy.part_number == "800-00656-r06"
# Now set up the other endpoints for the update call
await prep_envoy(mock_aioresponse, "127.0.0.1", version)
data = await envoy.update()
assert data
@pytest.mark.asyncio
async def test_2_network_errors_at_start_with_7_6_175_standard(
mock_aioresponse: aioresponses, test_client_session: aiohttp.ClientSession
) -> None:
"""Test 2 network error failures at start and 3th works"""
version = "7.6.175_standard"
start_7_firmware_mock(mock_aioresponse)
# Don't call prep_envoy because we want to control the /info response
envoy = Envoy("127.0.0.1", client=test_client_session)
# remove the waits between retries for this test and set known retries
envoy._firmware._get_info.retry.wait = wait_none()
envoy._firmware._get_info.retry.stop = stop_after_attempt(3) | stop_after_delay(50)
# we need 2 side effects for each try as https and then http is attempted
mock_aioresponse.get(
"https://127.0.0.1/info", exception=aiohttp.ClientError("Test timeoutexception")
)
mock_aioresponse.get(
"https://127.0.0.1/info",
exception=_make_client_connector_error("Test timeoutexception"),
)
mock_aioresponse.get(
"https://127.0.0.1/info", status=200, body=await load_fixture(version, "info")
)
await envoy.setup()
await envoy.authenticate("username", "password")
# Ensure that there were retries.
stats: dict[str, Any] = envoy._firmware._get_info.statistics
assert "attempt_number" in stats
assert stats["attempt_number"] == 3
assert envoy.firmware == "7.6.175"
assert envoy.part_number == "800-00656-r06"
# Now set up the other endpoints for the update call
await prep_envoy(mock_aioresponse, "127.0.0.1", version)
data = await envoy.update()
assert data
@pytest.mark.asyncio
async def test_3_network_errors_at_start_with_7_6_175_standard(
mock_aioresponse: aioresponses, test_client_session: aiohttp.ClientSession
) -> None:
"""Test 3 network error failures at start"""
start_7_firmware_mock(mock_aioresponse)
# Don't call prep_envoy because we want to control the /info response
envoy = Envoy("127.0.0.1", client=test_client_session)
# remove the waits between retries for this test and set known retries
envoy._firmware._get_info.retry.wait = wait_none()
envoy._firmware._get_info.retry.stop = stop_after_attempt(3) | stop_after_delay(50)
# We need 3 failures, each could try HTTPS then HTTP fallback
mock_aioresponse.get(
"https://127.0.0.1/info",
exception=aiohttp.ClientError("Test timeoutexception"),
repeat=True,
)
with pytest.raises(
EnvoyFirmwareCheckError, match="Unable to query firmware version"
):
await envoy.setup()
# Ensure that there were retries.
stats: dict[str, Any] = envoy._firmware._get_info.statistics
assert "attempt_number" in stats
assert stats["attempt_number"] == 3
@pytest.mark.asyncio
async def test_noconnection_at_probe_with_7_6_175_standard(
mock_aioresponse: aioresponses, test_client_session: aiohttp.ClientSession
) -> None:
"""Test 3 network error failures at start"""
version = "7.6.175_standard"
start_7_firmware_mock(mock_aioresponse)
await prep_envoy(mock_aioresponse, "127.0.0.1", version)
envoy = Envoy("127.0.0.1", client=test_client_session)
# remove the waits between retries for this test and set known retries
envoy.probe_request.retry.wait = wait_none()
envoy.probe_request.retry.stop = stop_after_attempt(3) | stop_after_delay(50)
await envoy.setup()
await envoy.authenticate("username", "password")
# Ensure that there were retries.
stats: dict[str, Any] = envoy._firmware._get_info.statistics
assert "attempt_number" in stats
assert stats["attempt_number"] == 1
# Probe is re-calling retried probe_request before returning
# we can only see stats for the last request done.
# force 3 retries for last one
mock_aioresponse.get(
"https://127.0.0.1/ivp/ss/gen_config",
exception=aiohttp.ClientError("Test timeoutexception"),
)
mock_aioresponse.get(
"https://127.0.0.1/ivp/ss/gen_config",
exception=_make_client_connector_error("Test timeoutexception"),
)
mock_aioresponse.get(
"https://127.0.0.1/ivp/ss/gen_config",
exception=asyncio.TimeoutError("Test timeoutexception"),
)
# Set up all other endpoints for probe
await prep_envoy(mock_aioresponse, "127.0.0.1", version)
await envoy.setup()
await envoy.authenticate("username", "password")
await envoy.probe()
# assert data
stats = envoy.probe_request.statistics
assert "attempt_number" in stats
print(f"--stats--{stats}")
assert stats["attempt_number"] == 1
data = await envoy.update()
assert data
@pytest.mark.asyncio
async def test_noconnection_at_update_with_7_6_175_standard(
mock_aioresponse: aioresponses, test_client_session: aiohttp.ClientSession
) -> None:
"""Test 3 network error failures at start"""
version = "7.6.175_standard"
start_7_firmware_mock(mock_aioresponse)
await prep_envoy(mock_aioresponse, "127.0.0.1", version)
envoy = Envoy("127.0.0.1", client=test_client_session)
# remove the waits between retries for this test and set known retries
envoy.request.retry.wait = wait_none()
envoy.request.retry.stop = stop_after_attempt(3) | stop_after_delay(50)
await envoy.setup()
await envoy.authenticate("username", "password")
# Ensure that there were no retries.
stats: dict[str, Any] = envoy._firmware._get_info.statistics
assert "attempt_number" in stats
assert stats["attempt_number"] == 1
await envoy.probe()
stats = envoy.probe_request.statistics
assert "attempt_number" in stats
assert stats["attempt_number"] == 1
# Test timeout exceptions - need to override existing mock first, then add additional ones
override_mock(
mock_aioresponse,
"get",
"https://127.0.0.1/api/v1/production",
exception=asyncio.TimeoutError("Test timeoutexception"),
)
mock_aioresponse.get(
"https://127.0.0.1/api/v1/production",
exception=asyncio.TimeoutError("Test timeoutexception"),
)
mock_aioresponse.get(
"https://127.0.0.1/api/v1/production",
exception=asyncio.TimeoutError("Test timeoutexception"),
)
# Clear endpoint cache to force retries
envoy._endpoint_cache.clear()
with pytest.raises(EnvoyCommunicationError, match="Timeout"):
await envoy.update()
# Don't check statistics here - they get reset between update() calls
# Test connection errors
envoy._endpoint_cache.clear()
override_mock(
mock_aioresponse,
"get",
"https://127.0.0.1/api/v1/production",
exception=_make_client_connector_error("Test timeoutexception"),
)
mock_aioresponse.get(
"https://127.0.0.1/api/v1/production",
exception=_make_client_connector_error("Test timeoutexception"),
)
mock_aioresponse.get(
"https://127.0.0.1/api/v1/production",
exception=_make_client_connector_error("Test timeoutexception"),
)
with pytest.raises(EnvoyCommunicationError, match="aiohttp ClientError"):
await envoy.update()
# Check statistics immediately after the failed update
stats = envoy.request.statistics
assert "attempt_number" in stats
print(f"Connection error test attempts: {stats['attempt_number']}")
# Statistics accumulate across all update() calls
assert stats["attempt_number"] >= 3
# Test general client errors (equivalent to RemoteProtocolError)
envoy._endpoint_cache.clear()
override_mock(
mock_aioresponse,
"get",
"https://127.0.0.1/api/v1/production",
exception=aiohttp.ClientError("Test timeoutexception"),
)
mock_aioresponse.get(
"https://127.0.0.1/api/v1/production",
exception=aiohttp.ClientError("Test timeoutexception"),
)
mock_aioresponse.get(
"https://127.0.0.1/api/v1/production",
exception=aiohttp.ClientError("Test timeoutexception"),
)
with pytest.raises(EnvoyCommunicationError, match="aiohttp ClientError"):
await envoy.update()
stats = envoy.request.statistics
assert "attempt_number" in stats
assert stats["attempt_number"] == 3
# Test network errors (using ClientConnectorError as equivalent)
envoy._endpoint_cache.clear()
override_mock(
mock_aioresponse,
"get",
"https://127.0.0.1/api/v1/production",
exception=_make_client_connector_error("Test timeoutexception"),
)
mock_aioresponse.get(
"https://127.0.0.1/api/v1/production",
exception=_make_client_connector_error("Test timeoutexception"),
)
mock_aioresponse.get(
"https://127.0.0.1/api/v1/production",
exception=_make_client_connector_error("Test timeoutexception"),
)
with pytest.raises(EnvoyCommunicationError, match="aiohttp ClientError"):
await envoy.update()
stats = envoy.request.statistics
assert "attempt_number" in stats
assert stats["attempt_number"] == 3
# other error EnvoyAuthenticationRequired should end cycle
# First mock will be consumed, then the EnvoyAuthenticationRequired will stop retries
envoy._endpoint_cache.clear()
override_mock(
mock_aioresponse,
"get",
"https://127.0.0.1/api/v1/production",
exception=_make_client_connector_error("Test timeoutexception"),
)
# We can't directly mock EnvoyAuthenticationRequired from aioresponses,
# so we'll use a 401 status to trigger it
mock_aioresponse.get(
"https://127.0.0.1/api/v1/production",
status=401,
payload={"message": "Test authentication required"},
)
mock_aioresponse.get(
"https://127.0.0.1/api/v1/production",
exception=_make_client_connector_error("Should not reach this"),
)
with pytest.raises(EnvoyAuthenticationRequired):
await envoy.update()
stats = envoy.request.statistics
assert "attempt_number" in stats
assert stats["attempt_number"] == 2
@pytest.mark.asyncio
async def test_bad_request_status_7_6_175_standard(
mock_aioresponse: aioresponses, test_client_session: aiohttp.ClientSession
) -> None:
"""Test request status not between 200-300."""
version = "7.6.175_standard"
start_7_firmware_mock(mock_aioresponse)
await prep_envoy(mock_aioresponse, "127.0.0.1", version)
envoy = Envoy("127.0.0.1", client=test_client_session)
envoy._firmware._get_info.retry.wait = wait_none()
envoy._firmware._get_info.retry.stop = stop_after_attempt(3) | stop_after_delay(50)
await envoy.setup()
await envoy.authenticate("username", "password")
data = await envoy.update()
assert data
# force status 503 on /api/vi/production
# test status results in EnvoyHTTPStatusError
override_mock(
mock_aioresponse, "get", "https://127.0.0.1/api/v1/production", status=503
)
with pytest.raises(EnvoyHTTPStatusError, match="503"):
await envoy.update()
stats = envoy.request.statistics
assert "attempt_number" in stats
assert stats["attempt_number"] == 1
|