jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-28 15:47:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add debug logs to trace enphase auth process at load. (#148117)

Browse Source
This commit is contained in:
Arie Catsman 2025-07-05 00:14:51 +02:00 committed by GitHub
parent 76be2fdba1
commit 12b90f3c8e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 47 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
homeassistant/components/enphase_envoy/coordinator.py
View File

@ -220,6 +220,7 @@ class EnphaseUpdateCoordinator(DataUpdateCoordinator[dict[str, Any]]):
await envoy.setup() await envoy.setup()
assert envoy.serial_number is not None assert envoy.serial_number is not None
self.envoy_serial_number = envoy.serial_number self.envoy_serial_number = envoy.serial_number
_LOGGER.debug("Envoy setup complete for serial: %s", self.envoy_serial_number)
if token := self.config_entry.data.get(CONF_TOKEN): if token := self.config_entry.data.get(CONF_TOKEN):
with contextlib.suppress(*INVALID_AUTH_ERRORS): with contextlib.suppress(*INVALID_AUTH_ERRORS):
# Always set the username and password # Always set the username and password
@ -227,6 +228,7 @@ class EnphaseUpdateCoordinator(DataUpdateCoordinator[dict[str, Any]]):
await envoy.authenticate( await envoy.authenticate(
username=self.username, password=self.password, token=token username=self.username, password=self.password, token=token
) )
_LOGGER.debug("Authorized, validating token lifetime")
# The token is valid, but we still want # The token is valid, but we still want
# to refresh it if it's stale right away # to refresh it if it's stale right away
self._async_refresh_token_if_needed(dt_util.utcnow()) self._async_refresh_token_if_needed(dt_util.utcnow())
@ -234,6 +236,8 @@ class EnphaseUpdateCoordinator(DataUpdateCoordinator[dict[str, Any]]):
# token likely expired or firmware changed # token likely expired or firmware changed
# so we fall through to authenticate with # so we fall through to authenticate with
# username/password # username/password
_LOGGER.debug("setup and auth got INVALID_AUTH_ERRORS")
_LOGGER.debug("Authenticate with username/password only")
await self.envoy.authenticate(username=self.username, password=self.password) await self.envoy.authenticate(username=self.username, password=self.password)
# Password auth succeeded, so we can update the token # Password auth succeeded, so we can update the token
# if we are using EnvoyTokenAuth # if we are using EnvoyTokenAuth
@ -262,13 +266,16 @@ class EnphaseUpdateCoordinator(DataUpdateCoordinator[dict[str, Any]]):
for tries in range(2): for tries in range(2):
try: try:
if not self._setup_complete: if not self._setup_complete:
_LOGGER.debug("update on try %s, setup not complete", tries)
await self._async_setup_and_authenticate() await self._async_setup_and_authenticate()
self._async_mark_setup_complete() self._async_mark_setup_complete()
# dump all received data in debug mode to assist troubleshooting # dump all received data in debug mode to assist troubleshooting
envoy_data = await envoy.update() envoy_data = await envoy.update()
except INVALID_AUTH_ERRORS as err: except INVALID_AUTH_ERRORS as err:
_LOGGER.debug("update on try %s, INVALID_AUTH_ERRORS %s", tries, err)
if self._setup_complete and tries == 0: if self._setup_complete and tries == 0:
# token likely expired or firmware changed, try to re-authenticate # token likely expired or firmware changed, try to re-authenticate
_LOGGER.debug("update on try %s, setup was complete, retry", tries)
self._setup_complete = False self._setup_complete = False
continue continue
raise ConfigEntryAuthFailed( raise ConfigEntryAuthFailed(
@ -280,6 +287,7 @@ class EnphaseUpdateCoordinator(DataUpdateCoordinator[dict[str, Any]]):
}, },
) from err ) from err
except EnvoyError as err: except EnvoyError as err:
_LOGGER.debug("update on try %s, EnvoyError %s", tries, err)
raise UpdateFailed( raise UpdateFailed(
translation_domain=DOMAIN, translation_domain=DOMAIN,
translation_key="envoy_error", translation_key="envoy_error",

39
tests/components/enphase_envoy/test_init.py
View File

@ -229,6 +229,45 @@ async def test_coordinator_token_refresh_error(
assert entity_state.state == "116" assert entity_state.state == "116"
@respx.mock
@pytest.mark.freeze_time("2024-07-23 00:00:00+00:00")
async def test_coordinator_first_update_auth_error(
hass: HomeAssistant,
mock_envoy: AsyncMock,
) -> None:
"""Test coordinator update error handling."""
current_token = encode(
# some time in future
payload={"name": "envoy", "exp": 1927314600},
key="secret",
algorithm="HS256",
)
# mock envoy with expired token in config
entry = MockConfigEntry(
domain=DOMAIN,
entry_id="45a36e55aaddb2007c5f6602e0c38e72",
title="Envoy 1234",
unique_id="1234",
data={
CONF_HOST: "1.1.1.1",
CONF_NAME: "Envoy 1234",
CONF_USERNAME: "test-username",
CONF_PASSWORD: "test-password",
CONF_TOKEN: current_token,
},
)
mock_envoy.auth = EnvoyTokenAuth(
"127.0.0.1",
token=current_token,
envoy_serial="1234",
cloud_username="test_username",
cloud_password="test_password",
)
mock_envoy.authenticate.side_effect = EnvoyAuthenticationError("Failing test")
await setup_integration(hass, entry, ConfigEntryState.SETUP_ERROR)
async def test_config_no_unique_id( async def test_config_no_unique_id(
hass: HomeAssistant, hass: HomeAssistant,
mock_envoy: AsyncMock, mock_envoy: AsyncMock,