From 562f1375500547fe2b0feec89466fbfa1559340e Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 13 Oct 2023 14:55:34 -0400 Subject: [PATCH 001/226] call property methods on keepalive/relogin in __init__ to make sure not None --- pyadtpulse/__init__.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index b4d3f06..87585ee 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -162,8 +162,8 @@ def __init__( self._last_login_time: int = 0 self._site: Optional[ADTPulseSite] = None - self.keepalive_interval = keepalive_interval - self.relogin_interval = relogin_interval + self.keepalive_interval = self.keepalive_interval + self.relogin_interval = self.relogin_interval # authenticate the user if do_login and websession is None: From d614755110dc5d2aedfa6c093de1079cb05973b6 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 13 Oct 2023 14:57:44 -0400 Subject: [PATCH 002/226] revert previous commit --- pyadtpulse/__init__.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 87585ee..b4d3f06 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -162,8 +162,8 @@ def __init__( self._last_login_time: int = 0 self._site: Optional[ADTPulseSite] = None - self.keepalive_interval = self.keepalive_interval - self.relogin_interval = self.relogin_interval + self.keepalive_interval = keepalive_interval + self.relogin_interval = relogin_interval # authenticate the user if do_login and websession is None: From 5de6a1def80b62ad9016a658c449a4d5020925a4 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 13 Oct 2023 16:31:39 -0400 Subject: [PATCH 003/226] change wait_for_update to return False if an update failed --- example-client.py | 96 +++++++++++++++++++++++++----------------- pyadtpulse/__init__.py | 46 ++++++++++++++------ 2 files changed, 91 insertions(+), 51 deletions(-) diff --git a/example-client.py b/example-client.py index 56030d4..cb87985 100755 --- a/example-client.py +++ b/example-client.py @@ -452,13 +452,19 @@ async def async_test_alarm(adt: PyADTPulse) -> None: print( f"FAIL: Arming home pending check failed {adt.site.alarm_control_panel} " ) - await adt.wait_for_update() - if adt.site.alarm_control_panel.is_home: - print("Arm stay no longer pending") + if await adt.wait_for_update(): + if adt.site.alarm_control_panel.is_home: + print("Arm stay no longer pending") + else: + while not adt.site.alarm_control_panel.is_home: + pprint( + f"FAIL: Arm stay value incorrect {adt.site.alarm_control_panel}" + ) + if not await adt.wait_for_update(): + print("ERROR: Alarm update failed") + break else: - while not adt.site.alarm_control_panel.is_home: - pprint(f"FAIL: Arm stay value incorrect {adt.site.alarm_control_panel}") - await adt.wait_for_update() + print("ERROR: Alarm update failed") print("Testing invalid alarm state change from armed home to armed away") if await adt.site.async_arm_away(): @@ -488,16 +494,18 @@ async def async_test_alarm(adt: PyADTPulse) -> None: print("Disarm pending success") else: pprint(f"FAIL: Disarm pending fail {adt.site.alarm_control_panel}") - await adt.wait_for_update() - if adt.site.alarm_control_panel.is_disarmed: - print("Success update to disarm") - else: - while not adt.site.alarm_control_panel.is_disarmed: - pprint( - "FAIL: did not set to disarm after update " - f"{adt.site.alarm_control_panel}" - ) - await adt.wait_for_update() + if await adt.wait_for_update(): + if adt.site.alarm_control_panel.is_disarmed: + print("Success update to disarm") + else: + while not adt.site.alarm_control_panel.is_disarmed: + pprint( + "FAIL: did not set to disarm after update " + f"{adt.site.alarm_control_panel}" + ) + if not await adt.wait_for_update(): + print("ERROR: Alarm update failed") + break print("Test finally succeeded") print("Testing disarming twice") if await adt.site.async_disarm(): @@ -511,17 +519,21 @@ async def async_test_alarm(adt: PyADTPulse) -> None: "FAIL: Double disarm state is not disarming " f"{adt.site.alarm_control_panel}" ) - await adt.wait_for_update() - if adt.site.alarm_control_panel.is_disarmed: - print("Double disarm success") - else: - while not adt.site.alarm_control_panel.is_disarmed: - pprint( - "FAIL: Double disarm state is not disarmed " - f"{adt.site.alarm_control_panel}" - ) - await adt.wait_for_update() + if await adt.wait_for_update(): + if adt.site.alarm_control_panel.is_disarmed: + print("Double disarm success") + else: + while not adt.site.alarm_control_panel.is_disarmed: + pprint( + "FAIL: Double disarm state is not disarmed " + f"{adt.site.alarm_control_panel}" + ) + if not await adt.wait_for_update(): + print("ERROR: Alarm update failed") + break print("Test finally succeeded") + else: + print("ERROR: Alarm update failed") else: print("Disarming failed") print("Arming alarm away") @@ -531,17 +543,21 @@ async def async_test_alarm(adt: PyADTPulse) -> None: print("Arm away arm pending") else: pprint(f"FAIL: arm away call not pending {adt.site.alarm_control_panel}") - await adt.wait_for_update() - if adt.site.alarm_control_panel.is_away: - print("Arm away call after update succeed") - else: - while not adt.site.alarm_control_panel.is_away: - pprint( - "FAIL: arm away call after update failed " - "f{adt.site.alarm_control_panel}" - ) - await adt.wait_for_update() + if await adt.wait_for_update(): + if adt.site.alarm_control_panel.is_away: + print("Arm away call after update succeed") + else: + while not adt.site.alarm_control_panel.is_away: + pprint( + "FAIL: arm away call after update failed " + "f{adt.site.alarm_control_panel}" + ) + if not await adt.wait_for_update(): + print("ERROR: Alarm update failed") + break print("Test finally succeeded") + else: + print("ERROR: Alarm update failed") else: print("Arm away failed") await adt.site.async_disarm() @@ -615,9 +631,11 @@ async def async_example( break print("\nZones:") pprint(adt.site.zones, compact=True) - await adt.wait_for_update() - print("Updates exist, refreshing") - # no need to call an update method + if await adt.wait_for_update(): + print("Updates exist, refreshing") + # no need to call an update method + else: + print("Warning, update failed, retrying") except KeyboardInterrupt: print("exiting...") done = True diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index b4d3f06..8285df6 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -66,6 +66,7 @@ class PyADTPulse: "_login_exception", "_relogin_interval", "_keepalive_interval", + "_update_succeded", ) @staticmethod @@ -164,6 +165,7 @@ def __init__( self._site: Optional[ADTPulseSite] = None self.keepalive_interval = keepalive_interval self.relogin_interval = relogin_interval + self._update_succeded = True # authenticate the user if do_login and websession is None: @@ -662,6 +664,16 @@ def logout(self) -> None: if sync_thread is not None: sync_thread.join() + def _set_update_failed(self, resp: ClientResponse | None) -> None: + """Sets update failed, sets updates_exist to notify wait_for_update + and closes response if necessary.""" + with self._attribute_lock: + self._update_succeded = False + if resp is not None: + close_response(resp) + if self._updates_exist is not None: + self._updates_exist.set() + async def _sync_check_task(self) -> None: # this should never be true if self._sync_task is not None: @@ -693,16 +705,17 @@ async def _sync_check_task(self) -> None: ) if response is None: + self._set_update_failed(response) continue retry_after = self._check_retry_after(response, f"{task_name}") if retry_after != 0: - close_response(response) + self._set_update_failed(response) continue text = await response.text() if not handle_response( response, logging.ERROR, "Error querying ADT sync" ): - close_response(response) + self._set_update_failed(response) continue close_response(response) pattern = r"\d+[-]\d+[-]\d+" @@ -713,7 +726,8 @@ async def _sync_check_task(self) -> None: LOG.debug("Received %s from ADT Pulse site", text) await self._do_logout_query() if not await self.async_quick_relogin(): - LOG.error("%s couldn't re-login, exiting.", task_name) + LOG.error("%s couldn't re-login", task_name) + self._set_update_failed(None) continue if text != last_sync_text: LOG.debug("Updates exist: %s, requerying", text) @@ -736,6 +750,19 @@ async def _sync_check_task(self) -> None: close_response(response) return + def _check_update_succeeded(self) -> bool: + """Check if update succeeded, clears the update event and + resets _update_succeeded. + """ + with self._attribute_lock: + old_update_succeded = self._update_succeded + self._update_succeded = True + if self._updates_exist is None: + return False + if self._updates_exist.is_set(): + self._updates_exist.clear() + return old_update_succeded + @property def updates_exist(self) -> bool: """Check if updated data exists. @@ -755,19 +782,14 @@ def updates_exist(self) -> bool: self._sync_task = loop.create_task( coro, name=f"{SYNC_CHECK_TASK_NAME}: Sync session" ) - if self._updates_exist is None: - return False - - if self._updates_exist.is_set(): - self._updates_exist.clear() - return True - return False + return self._check_update_succeeded() - async def wait_for_update(self) -> None: + async def wait_for_update(self) -> bool: """Wait for update. Blocks current async task until Pulse system signals an update + FIXME?: This code probably won't work with multiple waiters. """ with self._attribute_lock: if self._sync_task is None: @@ -779,7 +801,7 @@ async def wait_for_update(self) -> None: raise RuntimeError("Update event does not exist") await self._updates_exist.wait() - self._updates_exist.clear() + return self._check_update_succeeded() @property def is_connected(self) -> bool: From 8f412ee55490be93cc7443a030d1435a54def778 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 13 Oct 2023 17:56:43 -0400 Subject: [PATCH 004/226] change optional property setters to int | None --- pyadtpulse/__init__.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 8285df6..824c9f6 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -250,7 +250,7 @@ def relogin_interval(self) -> int: return self._relogin_interval @relogin_interval.setter - def relogin_interval(self, interval: Optional[int]) -> None: + def relogin_interval(self, interval: int | None) -> None: """Set re-login interval. Args: @@ -280,7 +280,7 @@ def keepalive_interval(self) -> int: return self._keepalive_interval @keepalive_interval.setter - def keepalive_interval(self, interval: Optional[int]) -> None: + def keepalive_interval(self, interval: int | None) -> None: """Set the keepalive interval in minutes. If set to None, resets to ADT_DEFAULT_KEEPALIVE_INTERVAL From 11210b1705d37c1ac7a5c44beba82d3e999277b3 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 13 Oct 2023 18:16:42 -0400 Subject: [PATCH 005/226] back off relogin with multiple sync check fails --- pyadtpulse/__init__.py | 15 ++++++++++++++- pyadtpulse/const.py | 1 + 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 824c9f6..970a529 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -24,6 +24,7 @@ ADT_LOGIN_URI, ADT_LOGOUT_URI, ADT_MAX_KEEPALIVE_INTERVAL, + ADT_MAX_RELOGIN_BACKOFF, ADT_MIN_RELOGIN_INTERVAL, ADT_SUMMARY_URI, ADT_SYNC_CHECK_URI, @@ -684,6 +685,9 @@ async def _sync_check_task(self) -> None: LOG.debug("creating %s", task_name) response = None retry_after = 0 + inital_relogin_interval = ( + current_relogin_interval + ) = self.site.gateway.poll_interval last_sync_text = "0-0-0" if self._updates_exist is None: raise RuntimeError(f"{task_name} started without update event initialized") @@ -721,14 +725,23 @@ async def _sync_check_task(self) -> None: pattern = r"\d+[-]\d+[-]\d+" if not re.match(pattern, text): LOG.warning( - "Unexpected sync check format (%s), forcing re-auth", pattern + "Unexpected sync check format (%s), " + "forcing re-auth after %f seconds", + pattern, + current_relogin_interval, ) LOG.debug("Received %s from ADT Pulse site", text) await self._do_logout_query() + await asyncio.sleep(current_relogin_interval) + current_relogin_interval = min( + ADT_MAX_RELOGIN_BACKOFF, current_relogin_interval * 2 + ) if not await self.async_quick_relogin(): LOG.error("%s couldn't re-login", task_name) self._set_update_failed(None) continue + else: + current_relogin_interval = inital_relogin_interval if text != last_sync_text: LOG.debug("Updates exist: %s, requerying", text) last_sync_text = text diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index aa6268d..9fe9de6 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -27,6 +27,7 @@ # than that ADT_DEFAULT_POLL_INTERVAL = 2.0 ADT_GATEWAY_OFFLINE_POLL_INTERVAL = 90.0 +ADT_MAX_RELOGIN_BACKOFF: float = 15.0 * 60.0 ADT_DEFAULT_HTTP_HEADERS = { "User-Agent": ( "Mozilla/5.0 (Windows NT 10.0; Win64; x64) " From 214b3529dc0477139bbccb6a14cff9b9c2c0f3b6 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 13 Oct 2023 19:01:28 -0400 Subject: [PATCH 006/226] re-factor async_query and async_fetch_version --- pyadtpulse/pulse_connection.py | 158 +++++++++++++-------------------- 1 file changed, 60 insertions(+), 98 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 7eb950f..46bd50c 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -19,14 +19,12 @@ from .const import ( ADT_DEFAULT_HTTP_HEADERS, ADT_DEFAULT_VERSION, - ADT_DEVICE_URI, ADT_HTTP_REFERER_URIS, ADT_LOGIN_URI, ADT_ORB_URI, - ADT_SYSTEM_URI, API_PREFIX, ) -from .util import DebugRLock, close_response, make_soup +from .util import DebugRLock, make_soup RECOVERABLE_ERRORS = [429, 500, 502, 503, 504] LOG = logging.getLogger(__name__) @@ -121,86 +119,78 @@ async def async_query( method: str = "GET", extra_params: Optional[Dict[str, str]] = None, extra_headers: Optional[Dict[str, str]] = None, - timeout=1, + timeout: int = 1, ) -> Optional[ClientResponse]: - """Query ADT Pulse async. + """ + Query ADT Pulse async. Args: uri (str): URI to query method (str, optional): method to use. Defaults to "GET". - extra_params (Optional[Dict], optional): query parameters. Defaults to None. + extra_params (Optional[Dict], optional): query parameters. + Defaults to None. extra_headers (Optional[Dict], optional): extra HTTP headers. - Defaults to None. + Defaults to None. timeout (int, optional): timeout in seconds. Defaults to 1. Returns: Optional[ClientResponse]: aiohttp.ClientResponse object - None on failure - ClientResponse will already be closed. + None on failure + ClientResponse will already be closed. """ - response = None with ADTPulseConnection._class_threadlock: if ADTPulseConnection._api_version == ADT_DEFAULT_VERSION: await self.async_fetch_version() url = self.make_url(uri) - if uri in ADT_HTTP_REFERER_URIS: - new_headers = {"Accept": ADT_DEFAULT_HTTP_HEADERS["Accept"]} - else: - new_headers = {"Accept": "*/*"} - LOG.debug("Updating HTTP headers: %s", new_headers) - self._session.headers.update(new_headers) + headers = {"Accept": ADT_DEFAULT_HTTP_HEADERS["Accept"]} + if uri not in ADT_HTTP_REFERER_URIS: + headers["Accept"] = "*/*" + + self._session.headers.update(headers) LOG.debug( "Attempting %s %s params=%s timeout=%d", method, uri, extra_params, timeout ) - # FIXME: reauthenticate if received: - # "You have not yet signed in or you - # have been signed out due to inactivity." - - # define connection method retry = 0 max_retries = 3 + response: Optional[ClientResponse] = None while retry < max_retries: try: - if method == "GET": - async with self._session.get( - url, headers=extra_headers, params=extra_params, timeout=timeout - ) as response: - await response.text() - elif method == "POST": - async with self._session.post( - url, headers=extra_headers, data=extra_params, timeout=timeout - ) as response: - await response.text() - else: - LOG.error("Invalid request method %s", method) - return None - - if response.status in RECOVERABLE_ERRORS: - retry = retry + 1 - LOG.info( - "query returned recoverable error code %s, " - "retrying (count = %d)", - response.status, - retry, - ) - if retry == max_retries: - LOG.warning( - "Exceeded max retries of %d, giving up", max_retries + async with self._session.request( + method, + url, + headers=extra_headers, + params=extra_params, + data=extra_params if method == "POST" else None, + timeout=timeout, + ) as response: + await response.text() + + if response.status in RECOVERABLE_ERRORS: + retry += 1 + LOG.info( + "query returned recoverable error code %s, " + "retrying (count = %d)", + response.status, + retry, ) - response.raise_for_status() - await asyncio.sleep(2**retry + uniform(0.0, 1.0)) - continue - - response.raise_for_status() - # success, break loop - retry = 4 + if retry == max_retries: + LOG.warning( + "Exceeded max retries of %d, giving up", max_retries + ) + response.raise_for_status() + await asyncio.sleep(2**retry + uniform(0.0, 1.0)) + continue + + response.raise_for_status() + retry = 4 # success, break loop except ( asyncio.TimeoutError, ClientConnectionError, ClientConnectorError, + ClientResponseError, ) as ex: LOG.debug( "Error %s occurred making %s request to %s, retrying", @@ -209,25 +199,6 @@ async def async_query( url, exc_info=True, ) - await asyncio.sleep(2**retry + uniform(0.0, 1.0)) - continue - except ClientResponseError as err: - code = err.code - LOG.exception( - "Received HTTP error code %i in request to ADT Pulse", code - ) - return None - - # success! - # FIXME? login uses redirects so final url is wrong - if uri in ADT_HTTP_REFERER_URIS: - if uri == ADT_DEVICE_URI: - referer = self.make_url(ADT_SYSTEM_URI) - else: - if response is not None and response.url is not None: - referer = str(response.url) - LOG.debug("Setting Referer to: %s", referer) - self._session.headers.update({"Referer": referer}) return response @@ -288,41 +259,32 @@ def make_url(self, uri: str) -> str: async def async_fetch_version(self) -> None: """Fetch ADT Pulse version.""" + response: Optional[ClientResponse] = None with ADTPulseConnection._class_threadlock: if ADTPulseConnection._api_version != ADT_DEFAULT_VERSION: return - response = None - signin_url = f"{self.service_host}/myhome{ADT_LOGIN_URI}" - if self._session: - try: - async with self._session.get(signin_url) as response: - # we only need the headers here, don't parse response - response.raise_for_status() - except (ClientResponseError, ClientConnectionError): - LOG.warning( - "Error occurred during API version fetch, defaulting to %s", - ADT_DEFAULT_VERSION, - ) - close_response(response) - return - if response is None: + signin_url = f"{self.service_host}/myhome{ADT_LOGIN_URI}" + try: + async with self._session.get(signin_url) as response: + # we only need the headers here, don't parse response + response.raise_for_status() + except (ClientResponseError, ClientConnectionError): LOG.warning( "Error occurred during API version fetch, defaulting to %s", ADT_DEFAULT_VERSION, ) return - - m = re.search("/myhome/(.+)/[a-z]*/", response.real_url.path) - close_response(response) - if m is not None: - ADTPulseConnection._api_version = m.group(1) - LOG.debug( - "Discovered ADT Pulse version %s at %s", - ADTPulseConnection._api_version, - self.service_host, - ) - return + if response is not None: + m = re.search("/myhome/(.+)/[a-z]*/", response.real_url.path) + if m is not None: + ADTPulseConnection._api_version = m.group(1) + LOG.debug( + "Discovered ADT Pulse version %s at %s", + ADTPulseConnection._api_version, + self.service_host, + ) + return LOG.warning( "Couldn't auto-detect ADT Pulse version, defaulting to %s", From 709cc4ccc3c8e00a0e9395be9e81cdb3d66bf801 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 13 Oct 2023 19:04:15 -0400 Subject: [PATCH 007/226] move _sync_check near _keepalive_task to make them easier to find --- pyadtpulse/__init__.py | 176 ++++++++++++++++++++--------------------- 1 file changed, 88 insertions(+), 88 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 970a529..99336d6 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -427,6 +427,94 @@ async def _keepalive_task(self) -> None: close_response(response) return + async def _sync_check_task(self) -> None: + # this should never be true + if self._sync_task is not None: + task_name = self._sync_task.get_name() + else: + task_name = f"{SYNC_CHECK_TASK_NAME} - possible internal error" + + LOG.debug("creating %s", task_name) + response = None + retry_after = 0 + inital_relogin_interval = ( + current_relogin_interval + ) = self.site.gateway.poll_interval + last_sync_text = "0-0-0" + if self._updates_exist is None: + raise RuntimeError(f"{task_name} started without update event initialized") + have_updates = False + while True: + try: + self.site.gateway.adjust_backoff_poll_interval() + if not have_updates: + pi = self.site.gateway.poll_interval + else: + pi = 0.0 + if retry_after == 0: + await asyncio.sleep(pi) + else: + await asyncio.sleep(retry_after) + response = await self._pulse_connection.async_query( + ADT_SYNC_CHECK_URI, + extra_params={"ts": str(int(time.time() * 1000))}, + ) + + if response is None: + self._set_update_failed(response) + continue + retry_after = self._check_retry_after(response, f"{task_name}") + if retry_after != 0: + self._set_update_failed(response) + continue + text = await response.text() + if not handle_response( + response, logging.ERROR, "Error querying ADT sync" + ): + self._set_update_failed(response) + continue + close_response(response) + pattern = r"\d+[-]\d+[-]\d+" + if not re.match(pattern, text): + LOG.warning( + "Unexpected sync check format (%s), " + "forcing re-auth after %f seconds", + pattern, + current_relogin_interval, + ) + LOG.debug("Received %s from ADT Pulse site", text) + await self._do_logout_query() + await asyncio.sleep(current_relogin_interval) + current_relogin_interval = min( + ADT_MAX_RELOGIN_BACKOFF, current_relogin_interval * 2 + ) + if not await self.async_quick_relogin(): + LOG.error("%s couldn't re-login", task_name) + self._set_update_failed(None) + continue + else: + current_relogin_interval = inital_relogin_interval + if text != last_sync_text: + LOG.debug("Updates exist: %s, requerying", text) + last_sync_text = text + have_updates = True + continue + if have_updates: + have_updates = False + if await self.async_update() is False: + LOG.debug("Pulse data update from %s failed", task_name) + continue + self._updates_exist.set() + else: + LOG.debug( + "Sync token %s indicates no remote updates to process", text + ) + + except asyncio.CancelledError: + LOG.debug("%s cancelled", task_name) + close_response(response) + return + def _pulse_session_thread(self) -> None: # lock is released in sync_loop() self._attribute_lock.acquire() @@ -675,94 +763,6 @@ def _set_update_failed(self, resp: ClientResponse | None) -> None: if self._updates_exist is not None: self._updates_exist.set() - async def _sync_check_task(self) -> None: - # this should never be true - if self._sync_task is not None: - task_name = self._sync_task.get_name() - else: - task_name = f"{SYNC_CHECK_TASK_NAME} - possible internal error" - - LOG.debug("creating %s", task_name) - response = None - retry_after = 0 - inital_relogin_interval = ( - current_relogin_interval - ) = self.site.gateway.poll_interval - last_sync_text = "0-0-0" - if self._updates_exist is None: - raise RuntimeError(f"{task_name} started without update event initialized") - have_updates = False - while True: - try: - self.site.gateway.adjust_backoff_poll_interval() - if not have_updates: - pi = self.site.gateway.poll_interval - else: - pi = 0.0 - if retry_after == 0: - await asyncio.sleep(pi) - else: - await asyncio.sleep(retry_after) - response = await self._pulse_connection.async_query( - ADT_SYNC_CHECK_URI, - extra_params={"ts": str(int(time.time() * 1000))}, - ) - - if response is None: - self._set_update_failed(response) - continue - retry_after = self._check_retry_after(response, f"{task_name}") - if retry_after != 0: - self._set_update_failed(response) - continue - text = await response.text() - if not handle_response( - response, logging.ERROR, "Error querying ADT sync" - ): - self._set_update_failed(response) - continue - close_response(response) - pattern = r"\d+[-]\d+[-]\d+" - if not re.match(pattern, text): - LOG.warning( - "Unexpected sync check format (%s), " - "forcing re-auth after %f seconds", - pattern, - current_relogin_interval, - ) - LOG.debug("Received %s from ADT Pulse site", text) - await self._do_logout_query() - await asyncio.sleep(current_relogin_interval) - current_relogin_interval = min( - ADT_MAX_RELOGIN_BACKOFF, current_relogin_interval * 2 - ) - if not await self.async_quick_relogin(): - LOG.error("%s couldn't re-login", task_name) - self._set_update_failed(None) - continue - else: - current_relogin_interval = inital_relogin_interval - if text != last_sync_text: - LOG.debug("Updates exist: %s, requerying", text) - last_sync_text = text - have_updates = True - continue - if have_updates: - have_updates = False - if await self.async_update() is False: - LOG.debug("Pulse data update from %s failed", task_name) - continue - self._updates_exist.set() - else: - LOG.debug( - "Sync token %s indicates no remote updates to process", text - ) - - except asyncio.CancelledError: - LOG.debug("%s cancelled", task_name) - close_response(response) - return - def _check_update_succeeded(self) -> bool: """Check if update succeeded, clears the update event and resets _update_succeeded. From a2223f736c30b80bfdd492250fa7153efaba5a81 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 14 Oct 2023 03:29:15 -0400 Subject: [PATCH 008/226] refactor sync check task --- pyadtpulse/__init__.py | 167 +++++++++++++++++++++++++---------------- 1 file changed, 102 insertions(+), 65 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 99336d6..71d856d 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -373,13 +373,21 @@ def _check_retry_after( ) return retval + def _get_task_name(self, task, default_name) -> str: + if task is not None: + return task.get_name() + return f"{default_name} - possible internal error" + + def _get_sync_task_name(self) -> str: + return self._get_task_name(self._sync_task, SYNC_CHECK_TASK_NAME) + + def _get_timeout_task_name(self) -> str: + return self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) + async def _keepalive_task(self) -> None: retry_after = 0 response: ClientResponse | None = None - if self._timeout_task is not None: - task_name = self._timeout_task.get_name() - else: - task_name = f"{KEEPALIVE_TASK_NAME} - possible internal error" + task_name = self._get_timeout_task_name() LOG.debug("creating %s", task_name) with self._attribute_lock: if self._authenticated is None: @@ -428,93 +436,122 @@ async def _keepalive_task(self) -> None: return async def _sync_check_task(self) -> None: - # this should never be true - if self._sync_task is not None: - task_name = self._sync_task.get_name() - else: - task_name = f"{SYNC_CHECK_TASK_NAME} - possible internal error" - + task_name = self._get_sync_task_name() LOG.debug("creating %s", task_name) + response = None retry_after = 0 - inital_relogin_interval = ( + initial_relogin_interval = ( current_relogin_interval ) = self.site.gateway.poll_interval last_sync_text = "0-0-0" - if self._updates_exist is None: - raise RuntimeError(f"{task_name} started without update event initialized") + + self._validate_updates_exist(task_name) + have_updates = False while True: try: self.site.gateway.adjust_backoff_poll_interval() - if not have_updates: - pi = self.site.gateway.poll_interval - else: - pi = 0.0 - if retry_after == 0: - await asyncio.sleep(pi) - else: - await asyncio.sleep(retry_after) - response = await self._pulse_connection.async_query( - ADT_SYNC_CHECK_URI, - extra_params={"ts": str(int(time.time() * 1000))}, - ) + pi = self.site.gateway.poll_interval if not have_updates else 0.0 + await asyncio.sleep(max(retry_after, pi)) - if response is None: - self._set_update_failed(response) - continue - retry_after = self._check_retry_after(response, f"{task_name}") - if retry_after != 0: - self._set_update_failed(response) + response = await self._perform_sync_check_query() + + if response is None or self._check_and_handle_retry( + response, task_name + ): + close_response(response) continue + text = await response.text() - if not handle_response( - response, logging.ERROR, "Error querying ADT sync" + if not self._validate_sync_check_response( + response, text, task_name, current_relogin_interval ): - self._set_update_failed(response) - continue - close_response(response) - pattern = r"\d+[-]\d+[-]\d+" - if not re.match(pattern, text): - LOG.warning( - "Unexpected sync check format (%s), " - "forcing re-auth after %f seconds", - pattern, - current_relogin_interval, - ) - LOG.debug("Received %s from ADT Pulse site", text) - await self._do_logout_query() - await asyncio.sleep(current_relogin_interval) current_relogin_interval = min( ADT_MAX_RELOGIN_BACKOFF, current_relogin_interval * 2 ) - if not await self.async_quick_relogin(): - LOG.error("%s couldn't re-login", task_name) - self._set_update_failed(None) + close_response(response) continue - else: - current_relogin_interval = inital_relogin_interval - if text != last_sync_text: - LOG.debug("Updates exist: %s, requerying", text) - last_sync_text = text + current_relogin_interval = initial_relogin_interval + close_response(response) + + if self._handle_updates_exist(text, last_sync_text): have_updates = True continue - if have_updates: - have_updates = False - if await self.async_update() is False: - LOG.debug("Pulse data update from %s failed", task_name) - continue - self._updates_exist.set() - else: - LOG.debug( - "Sync token %s indicates no remote updates to process", text - ) + + await self._handle_no_updates_exist(have_updates, task_name, text) + have_updates = False except asyncio.CancelledError: LOG.debug("%s cancelled", task_name) close_response(response) return + def _validate_updates_exist(self, task_name: str) -> None: + if self._updates_exist is None: + raise RuntimeError(f"{task_name} started without update event initialized") + + async def _perform_sync_check_query(self): + return await self._pulse_connection.async_query( + ADT_SYNC_CHECK_URI, extra_params={"ts": str(int(time.time() * 1000))} + ) + + def _check_and_handle_retry(self, response, task_name): + retry_after = self._check_retry_after(response, f"{task_name}") + if retry_after != 0: + self._set_update_failed(response) + return True + return False + + async def _validate_sync_check_response( + self, + response: ClientResponse, + text: str, + task_name: str, + current_relogin_interval: float, + ) -> bool: + if not handle_response(response, logging.ERROR, "Error querying ADT sync"): + self._set_update_failed(response) + return False + + pattern = r"\d+[-]\d+[-]\d+" + if not re.match(pattern, text): + LOG.warning( + "Unexpected sync check format (%s), " + "forcing re-auth after %f seconds", + pattern, + current_relogin_interval, + ) + LOG.debug("Received %s from ADT Pulse site", text) + await self._do_logout_query() + await asyncio.sleep(current_relogin_interval) + if not await self.async_quick_relogin(): + LOG.error("%s couldn't re-login", task_name) + self._set_update_failed(None) + return False + return True + + def _handle_updates_exist(self, text: str, last_sync_text: str): + if text != last_sync_text: + LOG.debug("Updates exist: %s, requerying", text) + last_sync_text = text + return True + return False + + async def _handle_no_updates_exist( + self, have_updates: bool, task_name: str, text: str + ) -> None: + if have_updates: + have_updates = False + if await self.async_update() is False: + LOG.debug("Pulse data update from %s failed", task_name) + return + # shouldn't need to call _validate_updates_exist, but just in case + self._validate_updates_exist(task_name) + self._updates_exist.set() + else: + LOG.debug("Sync token %s indicates no remote updates to process", text) + def _pulse_session_thread(self) -> None: # lock is released in sync_loop() self._attribute_lock.acquire() From b2a66e549a8071c4afd9f9d01cf01a6820d3e246 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 14 Oct 2023 05:07:49 -0400 Subject: [PATCH 009/226] refactor keepalive_task --- pyadtpulse/__init__.py | 158 ++++++++++++++++++++++++++--------------- 1 file changed, 100 insertions(+), 58 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 71d856d..06e149c 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -5,10 +5,9 @@ import datetime import re import time -from contextlib import suppress from random import randint from threading import RLock, Thread -from typing import List, Optional, Union +from typing import List, Optional, Tuple, Union from warnings import warn import uvloop @@ -385,56 +384,113 @@ def _get_timeout_task_name(self) -> str: return self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) async def _keepalive_task(self) -> None: - retry_after = 0 + retry_after: int = 0 response: ClientResponse | None = None - task_name = self._get_timeout_task_name() + task_name: str = self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) LOG.debug("creating %s", task_name) + with self._attribute_lock: - if self._authenticated is None: - raise RuntimeError( - "Keepalive task is running without an authenticated event" - ) + self._validate_authenticated_event() while self._authenticated.is_set(): - relogin_interval = self.relogin_interval * 60 - if relogin_interval != 0 and time.time() - self._last_login_time > randint( - int(0.75 * relogin_interval), relogin_interval - ): - LOG.info("Login timeout reached, re-logging in") - # FIXME?: should we just pause the task? - with self._attribute_lock: - if self._sync_task is not None: - self._sync_task.cancel() - with suppress(Exception): - await self._sync_task - await self._do_logout_query() - if not await self.async_quick_relogin(): - LOG.error("%s could not re-login, exiting", task_name) - return - if self._sync_task is not None: - coro = self._sync_check_task() - self._sync_task = asyncio.create_task( - coro, name=f"{SYNC_CHECK_TASK_NAME}: Async session" - ) + relogin_interval = self.relogin_interval + if self._should_relogin(relogin_interval): + if not await self._handle_relogin(task_name): + return try: - await asyncio.sleep(self.keepalive_interval * 60.0 + retry_after) + await asyncio.sleep(self._calculate_sleep_time(retry_after)) LOG.debug("Resetting timeout") - response = await self._pulse_connection.async_query( - ADT_TIMEOUT_URI, "POST" - ) - if not handle_response( - response, logging.INFO, "Failed resetting ADT Pulse cloud timeout" - ): - retry_after = self._check_retry_after(response, "Keepalive task") - close_response(response) + response = await self._reset_pulse_cloud_timeout() + if ( + not handle_response( + response, + logging.WARNING, + "Could not reset ADT Pulse cloud timeout", + ) + or response is None + ): # shut up linter continue - close_response(response) - if self.site.gateway.next_update < time.time(): - await self.site._set_device(ADT_GATEWAY_STRING) + success, retry_after = self._handle_timeout_response(response) + if not success: + continue + await self._update_gateway_device_if_needed() + except asyncio.CancelledError: LOG.debug("%s cancelled", task_name) close_response(response) return + def _validate_authenticated_event(self) -> None: + if self._authenticated is None: + raise RuntimeError( + "Keepalive task is running without an authenticated event" + ) + + def _should_relogin(self, relogin_interval: int) -> bool: + return relogin_interval != 0 and time.time() - self._last_login_time > randint( + int(0.75 * relogin_interval), relogin_interval + ) + + async def _handle_relogin(self, task_name: str) -> bool: + """Do a relogin from keepalive task.""" + LOG.info("Login timeout reached, re-logging in") + with self._attribute_lock: + try: + await self._cancel_task(self._sync_task) + except Exception as e: + LOG.warning("Unhandled exception %s while cancelling %s", e, task_name) + return await self._do_logout_and_relogin(0.0) + + async def _cancel_task(self, task: asyncio.Task | None) -> None: + if task is None: + return + task_name = task.get_name() + LOG.debug("cancelling %s", task_name) + try: + task.cancel() + except asyncio.CancelledError: + LOG.debug("%s successfully cancelled", task_name) + await task + + async def _do_logout_and_relogin(self, relogin_wait_time: float) -> bool: + current_task = asyncio.current_task() + await self._do_logout_query() + await asyncio.sleep(relogin_wait_time) + if not await self.async_quick_relogin(): + task_name: str | None = None + if current_task is not None: + task_name = current_task.get_name() + LOG.error("%s could not re-login, exiting", task_name or "(Unknown task)") + return False + if current_task is not None and current_task == self._sync_task: + return True + with self._attribute_lock: + if self._sync_task is not None: + coro = self._sync_check_task() + self._sync_task = asyncio.create_task( + coro, name=f"{SYNC_CHECK_TASK_NAME}: Async session" + ) + return True + + def _calculate_sleep_time(self, retry_after: int) -> int: + return self.keepalive_interval * 60 + retry_after + + async def _reset_pulse_cloud_timeout(self) -> ClientResponse | None: + return await self._pulse_connection.async_query(ADT_TIMEOUT_URI, "POST") + + def _handle_timeout_response(self, response: ClientResponse) -> Tuple[bool, int]: + if not handle_response( + response, logging.INFO, "Failed resetting ADT Pulse cloud timeout" + ): + retry_after = self._check_retry_after(response, "Keepalive task") + close_response(response) + return False, retry_after + close_response(response) + return True, 0 + + async def _update_gateway_device_if_needed(self) -> None: + if self.site.gateway.next_update < time.time(): + await self.site._set_device(ADT_GATEWAY_STRING) + async def _sync_check_task(self) -> None: task_name = self._get_sync_task_name() LOG.debug("creating %s", task_name) @@ -465,7 +521,7 @@ async def _sync_check_task(self) -> None: text = await response.text() if not self._validate_sync_check_response( - response, text, task_name, current_relogin_interval + response, text, current_relogin_interval ): current_relogin_interval = min( ADT_MAX_RELOGIN_BACKOFF, current_relogin_interval * 2 @@ -507,7 +563,6 @@ async def _validate_sync_check_response( self, response: ClientResponse, text: str, - task_name: str, current_relogin_interval: float, ) -> bool: if not handle_response(response, logging.ERROR, "Error querying ADT sync"): @@ -523,10 +578,7 @@ async def _validate_sync_check_response( current_relogin_interval, ) LOG.debug("Received %s from ADT Pulse site", text) - await self._do_logout_query() - await asyncio.sleep(current_relogin_interval) - if not await self.async_quick_relogin(): - LOG.error("%s couldn't re-login", task_name) + await self._do_logout_and_relogin(current_relogin_interval) self._set_update_failed(None) return False return True @@ -761,18 +813,8 @@ async def async_login(self) -> bool: async def async_logout(self) -> None: """Logout of ADT Pulse async.""" LOG.info("Logging %s out of ADT Pulse", self._username) - if self._timeout_task is not None: - try: - self._timeout_task.cancel() - except asyncio.CancelledError: - LOG.debug("%s successfully cancelled", KEEPALIVE_TASK_NAME) - await self._timeout_task - if self._sync_task is not None: - try: - self._sync_task.cancel() - except asyncio.CancelledError: - LOG.debug("%s successfully cancelled", SYNC_CHECK_TASK_NAME) - await self._sync_task + await self._cancel_task(self._timeout_task) + await self._cancel_task(self._sync_task) self._timeout_task = self._sync_task = None await self._do_logout_query() if self._authenticated is not None: From 6e1811e5b4f9040ba76c61583af6c2489758d427 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 14 Oct 2023 05:18:21 -0400 Subject: [PATCH 010/226] refactor _fetch_devices --- pyadtpulse/site.py | 70 ++++++++++++++++++---------------------------- 1 file changed, 27 insertions(+), 43 deletions(-) diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 2f9b85e..e6c7cf5 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -252,17 +252,6 @@ async def _set_device(self, device_id: str) -> None: LOG.debug("Zone %s is not an integer, skipping", device_id) async def _fetch_devices(self, soup: Optional[BeautifulSoup]) -> bool: - """Fetch devices for a site. - - Args: - soup (BeautifulSoup, Optional): a BS4 object with data fetched from - ADT Pulse web site - Returns: - ADTPulseZones - - None if an error occurred - """ - task_list: list[Task] = [] if not soup: response = await self._pulse_connection.async_query(ADT_SYSTEM_URI) soup = await make_soup( @@ -273,22 +262,26 @@ async def _fetch_devices(self, soup: Optional[BeautifulSoup]) -> bool: if not soup: return False - regexDevice = r"goToUrl\('device.jsp\?id=(\d*)'\);" + regex_device = r"goToUrl\('device.jsp\?id=(\d*)'\);" + task_list: list[Task] = [] + with self._site_lock: for row in soup.find_all("tr", {"class": "p_listRow", "onclick": True}): device_name = row.find("a").get_text() row_tds = row.find_all("td") zone_id = None - # see if we can create a zone without calling device.jsp - if row_tds is not None and len(row_tds) > 4: + # Check if we can create a zone without calling device.jsp + if row_tds and len(row_tds) > 4: zone_name = row_tds[1].get_text().strip() zone_id = row_tds[2].get_text().strip() zone_type = row_tds[4].get_text().strip() zone_status = row_tds[0].find("canvas").get("title").strip() + if ( - zone_id.isdecimal() - and zone_name is not None - and zone_type is not None + zone_id is not None + and zone_id.isdecimal() + and zone_name + and zone_type ): self._zones.update_zone_attributes( { @@ -299,42 +292,33 @@ async def _fetch_devices(self, soup: Optional[BeautifulSoup]) -> bool: } ) continue - onClickValueText = row.get("onclick") + + on_click_value_text = row.get("onclick") + if ( - onClickValueText == "goToUrl('gateway.jsp');" + on_click_value_text in ("goToUrl('gateway.jsp');", "Gateway") or device_name == "Gateway" ): task_list.append(create_task(self._set_device(ADT_GATEWAY_STRING))) - continue - result = re.findall(regexDevice, onClickValueText) - - # only proceed if regex succeeded, as some users have onClick - # links that include gateway.jsp - if not result: - LOG.debug( - "Failed regex match #%s on #%s " - "from ADT Pulse service, ignoring", - regexDevice, - onClickValueText, - ) - continue - # alarm panel case - if result[0] == "1" or device_name == "Security Panel": - task_list.append(create_task(self._set_device(result[0]))) - continue - # zone case if we couldn't just call update_zone_attributes - if zone_id is not None and zone_id.isdecimal(): - task_list.append(create_task(self._set_device(result[0]))) - continue else: - LOG.debug("Skipping %s as it doesn't have an ID", device_name) + result = re.findall(regex_device, on_click_value_text) + + if result: + device_id = result[0] + + if device_id == "1" or device_name == "Security Panel": + task_list.append(create_task(self._set_device(device_id))) + elif zone_id and zone_id.isdecimal(): + task_list.append(create_task(self._set_device(device_id))) + else: + LOG.debug( + "Skipping %s as it doesn't have an ID", device_name + ) await gather(*task_list) self._last_updated = int(time()) return True - # FIXME: ensure the zones for the correct site are being loaded!!! - async def _async_update_zones_as_dict( self, soup: Optional[BeautifulSoup] ) -> Optional[ADTPulseZones]: From 800e24f8d74e1adba3c95ce59c687b1e43d52bca Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 14 Oct 2023 05:48:37 -0400 Subject: [PATCH 011/226] refactor zones --- pyadtpulse/site.py | 20 +++++++------- pyadtpulse/zones.py | 63 ++++++++++++++++----------------------------- 2 files changed, 32 insertions(+), 51 deletions(-) diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index e6c7cf5..9e5234f 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -203,37 +203,37 @@ def history(self): async def _get_device_attributes(self, device_id: str) -> Optional[dict[str, str]]: result: dict[str, str] = {} if device_id == ADT_GATEWAY_STRING: - deviceResponse = await self._pulse_connection.async_query( + device_response = await self._pulse_connection.async_query( "/system/gateway.jsp", timeout=10 ) else: - deviceResponse = await self._pulse_connection.async_query( + device_response = await self._pulse_connection.async_query( ADT_DEVICE_URI, extra_params={"id": device_id} ) - deviceResponseSoup = await make_soup( - deviceResponse, + device_response_soup = await make_soup( + device_response, logging.DEBUG, "Failed loading device attributes from ADT Pulse service", ) - if deviceResponseSoup is None: + if device_response_soup is None: return None - for devInfoRow in deviceResponseSoup.find_all( + for dev_info_row in device_response_soup.find_all( "td", {"class", "InputFieldDescriptionL"} ): - identityText = ( - str(devInfoRow.get_text()) + identity_text = ( + str(dev_info_row.get_text()) .lower() .strip() .rstrip(":") .replace(" ", "_") .replace("/", "_") ) - sibling = devInfoRow.find_next_sibling() + sibling = dev_info_row.find_next_sibling() if not sibling: value = "Unknown" else: value = str(sibling.get_text()).strip() - result.update({identityText: value}) + result.update({identity_text: value}) return result async def _set_device(self, device_id: str) -> None: diff --git a/pyadtpulse/zones.py b/pyadtpulse/zones.py index 1402b7e..ada60e8 100644 --- a/pyadtpulse/zones.py +++ b/pyadtpulse/zones.py @@ -79,17 +79,6 @@ def _check_key(key: int) -> None: if not isinstance(key, int): raise ValueError("ADT Pulse Zone must be an integer") - def __getitem__(self, key: int) -> ADTPulseZoneData: - """Get a Zone. - - Args: - key (int): zone id - - Returns: - ADTPulseZoneData: zone data - """ - return super().__getitem__(key) - def _get_zonedata(self, key: int) -> ADTPulseZoneData: self._check_key(key) result: ADTPulseZoneData = self.data[key] @@ -119,9 +108,7 @@ def update_status(self, key: int, status: str) -> None: key (int): zone id to change status (str): status to set """ """""" - temp = self._get_zonedata(key) - temp.status = status - self.__setitem__(key, temp) + self[key]["status"] = status def update_state(self, key: int, state: str) -> None: """Update zone state. @@ -130,9 +117,7 @@ def update_state(self, key: int, state: str) -> None: key (int): zone id to change state (str): state to set """ - temp = self._get_zonedata(key) - temp.state = state - self.__setitem__(key, temp) + self[key]["state"] = state def update_last_activity_timestamp(self, key: int, dt: datetime) -> None: """Update timestamp. @@ -141,9 +126,7 @@ def update_last_activity_timestamp(self, key: int, dt: datetime) -> None: key (int): zone id to change dt (datetime): timestamp to set """ - temp = self._get_zonedata(key) - temp.last_activity_timestamp = int(dt.timestamp()) - self.__setitem__(key, temp) + self[key]["last_activity_timestamp"] = dt.timestamp() def update_device_info( self, @@ -164,11 +147,9 @@ def update_device_info( last_activity (datetime, optional): last_activity_datetime. Defaults to datetime.now(). """ - temp = self._get_zonedata(key) - temp.state = state - temp.status = status - temp.last_activity_timestamp = int(last_activity.timestamp()) - self.__setitem__(key, temp) + self.update_last_activity_timestamp(key, last_activity) + self.update_status(key, status) + self.update_state(key, state) def flatten(self) -> List[ADTPulseFlattendZone]: """Flattens ADTPulseZones into a list of ADTPulseFlattenedZones. @@ -195,39 +176,39 @@ def flatten(self) -> List[ADTPulseFlattendZone]: def update_zone_attributes(self, dev_attr: dict[str, str]) -> None: """Update zone attributes.""" - dName = dev_attr.get("name", "Unknown") - dType = dev_attr.get("type_model", "Unknown") - dZone = dev_attr.get("zone", "Unknown") - dStatus = dev_attr.get("status", "Unknown") + d_name = dev_attr.get("name", "Unknown") + d_type = dev_attr.get("type_model", "Unknown") + d_zone = dev_attr.get("zone", "Unknown") + d_status = dev_attr.get("status", "Unknown") - if dZone != "Unknown": + if d_zone != "Unknown": tags = None for search_term, default_tags in ADT_NAME_TO_DEFAULT_TAGS.items(): # convert to uppercase first - if search_term.upper() in dType.upper(): + if search_term.upper() in d_type.upper(): tags = default_tags break if not tags: LOG.warning( - "Unknown sensor type for '%s', defaulting to doorWindow", dType + "Unknown sensor type for '%s', defaulting to doorWindow", d_type ) tags = ("sensor", "doorWindow") LOG.debug( "Retrieved sensor %s id: sensor-%s Status: %s, tags %s", - dName, - dZone, - dStatus, + d_name, + d_zone, + d_status, tags, ) - if "Unknown" in (dName, dStatus, dZone) or not dZone.isdecimal(): + if "Unknown" in (d_name, d_status, d_zone) or not d_zone.isdecimal(): LOG.debug("Zone data incomplete, skipping...") else: - tmpzone = ADTPulseZoneData(dName, f"sensor-{dZone}", tags, dStatus) - self.update({int(dZone): tmpzone}) + tmpzone = ADTPulseZoneData(d_name, f"sensor-{d_zone}", tags, d_status) + self.update({int(d_zone): tmpzone}) else: LOG.debug( "Skipping incomplete zone name: %s, zone: %s status: %s", - dName, - dZone, - dStatus, + d_name, + d_zone, + d_status, ) From f9bd90896970ecdb670880916a345858240739a9 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 14 Oct 2023 06:23:50 -0400 Subject: [PATCH 012/226] add docstrings, make a few things constants --- pyadtpulse/__init__.py | 149 ++++++++++++++++++++++++++++++++- pyadtpulse/pulse_connection.py | 5 +- pyadtpulse/site.py | 46 +++++++++- 3 files changed, 193 insertions(+), 7 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 06e149c..5fb480f 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -303,10 +303,16 @@ async def _update_sites(self, soup: BeautifulSoup) -> None: self._site._update_zone_from_soup(soup) async def _initialize_sites(self, soup: BeautifulSoup) -> None: + """ + Initializes the sites in the ADT Pulse account. + + Args: + soup (BeautifulSoup): The parsed HTML soup object. + """ # typically, ADT Pulse accounts have only a single site (premise/location) - singlePremise = soup.find("span", {"id": "p_singlePremise"}) - if singlePremise: - site_name = singlePremise.text + single_premise = soup.find("span", {"id": "p_singlePremise"}) + if single_premise: + site_name = single_premise.text # FIXME: this code works, but it doesn't pass the linter signout_link = str( @@ -347,6 +353,17 @@ async def _initialize_sites(self, soup: BeautifulSoup) -> None: def _check_retry_after( self, response: Optional[ClientResponse], task_name: str ) -> int: + """ + Check the "Retry-After" header in the response and return the number of seconds + to wait before retrying the task. + + Parameters: + response (Optional[ClientResponse]): The response object. + task_name (str): The name of the task. + + Returns: + int: The number of seconds to wait before retrying the task. + """ if response is None: return 0 header_value = response.headers.get("Retry-After") @@ -373,6 +390,16 @@ def _check_retry_after( return retval def _get_task_name(self, task, default_name) -> str: + """ + Get the name of a task. + + Parameters: + task (Task): The task object. + default_name (str): The default name to use if the task is None. + + Returns: + str: The name of the task if it is not None, otherwise the default name with a suffix indicating a possible internal error. + """ if task is not None: return task.get_name() return f"{default_name} - possible internal error" @@ -384,6 +411,10 @@ def _get_timeout_task_name(self) -> str: return self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) async def _keepalive_task(self) -> None: + """ + Asynchronous function that runs a keepalive task to maintain the connection + with the ADT Pulse cloud. + """ retry_after: int = 0 response: ClientResponse | None = None task_name: str = self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) @@ -426,6 +457,16 @@ def _validate_authenticated_event(self) -> None: ) def _should_relogin(self, relogin_interval: int) -> bool: + """ + Checks if the user should re-login based on the relogin interval and the time + since the last login. + + Parameters: + relogin_interval (int): The interval in seconds between re-logins. + + Returns: + bool: True if the user should re-login, False otherwise. + """ return relogin_interval != 0 and time.time() - self._last_login_time > randint( int(0.75 * relogin_interval), relogin_interval ) @@ -441,6 +482,12 @@ async def _handle_relogin(self, task_name: str) -> bool: return await self._do_logout_and_relogin(0.0) async def _cancel_task(self, task: asyncio.Task | None) -> None: + """ + Cancel a given asyncio task. + + Args: + task (asyncio.Task | None): The task to be cancelled. + """ if task is None: return task_name = task.get_name() @@ -452,6 +499,15 @@ async def _cancel_task(self, task: asyncio.Task | None) -> None: await task async def _do_logout_and_relogin(self, relogin_wait_time: float) -> bool: + """ + Performs a logout and re-login process. + + Args: + relogin_wait_time (float): The amount of time to wait before re-logging in. + + Returns: + bool: True if the re-login process is successful, False otherwise. + """ current_task = asyncio.current_task() await self._do_logout_query() await asyncio.sleep(relogin_wait_time) @@ -478,6 +534,17 @@ async def _reset_pulse_cloud_timeout(self) -> ClientResponse | None: return await self._pulse_connection.async_query(ADT_TIMEOUT_URI, "POST") def _handle_timeout_response(self, response: ClientResponse) -> Tuple[bool, int]: + """ + Handle the timeout response from the client. + + Args: + response (ClientResponse): The client response object. + + Returns: + Tuple[bool, int]: A tuple containing a boolean value indicating whether the + response was handled successfully and an integer indicating the + retry after value. + """ if not handle_response( response, logging.INFO, "Failed resetting ADT Pulse cloud timeout" ): @@ -492,6 +559,35 @@ async def _update_gateway_device_if_needed(self) -> None: await self.site._set_device(ADT_GATEWAY_STRING) async def _sync_check_task(self) -> None: + """ + Asynchronous function that performs a synchronization check task. + + This function is responsible for performing a synchronization check task. + It then initializes variables for the response, retry after, initial relogin + interval, and last sync text. + + The function validates that updates exist for the sync task and enters into + a loop. + + Within the loop, it adjusts the backoff poll interval, sleeps for a + maximum of the retry after value or the poll interval, and performs a sync check + query. + + The function then checks if the response is valid and handles any retry + scenarios. + + If the response is valid, it retrieves the text from the response + and validates the sync check response. + If the response is not valid, it increases the current relogin interval and + continues to the next iteration of the loop. + If the response is valid, it resets the relogin interval and handles + any updates. + If updates exist, it continues to the next iteration of the loop. + If no updates exist, it handles the scenario where no updates exist and resets + the have_updates flag to False. + + If the function is cancelled, it logs a debug message and returns. + """ task_name = self._get_sync_task_name() LOG.debug("creating %s", task_name) @@ -565,6 +661,17 @@ async def _validate_sync_check_response( text: str, current_relogin_interval: float, ) -> bool: + """ + Validates the sync check response received from the ADT Pulse site. + + Args: + response (ClientResponse): The HTTP response object. + text (str): The response text. + current_relogin_interval (float): The current relogin interval. + + Returns: + bool: True if the sync check response is valid, False otherwise. + """ if not handle_response(response, logging.ERROR, "Error querying ADT sync"): self._set_update_failed(response) return False @@ -605,6 +712,14 @@ async def _handle_no_updates_exist( LOG.debug("Sync token %s indicates no remote updates to process", text) def _pulse_session_thread(self) -> None: + """ + Pulse the session thread. + + Acquires the attribute lock and creates a background thread for the ADT + Pulse API. The thread runs the synchronous loop `_sync_loop()` until completion. + Once the loop finishes, the thread is closed, the pulse connection's event loop + is set to `None`, and the session thread is set to `None`. + """ # lock is released in sync_loop() self._attribute_lock.acquire() @@ -619,6 +734,22 @@ def _pulse_session_thread(self) -> None: self._session_thread = None async def _sync_loop(self) -> None: + """ + Asynchronous function that represents the main loop of the synchronization + process. + + This function is responsible for executing the synchronization logic. It starts + by calling the `async_login` method to perform the login operation. After that, + it releases the `_attribute_lock` to allow other tasks to access the attributes. + If the login operation was successful, it waits for the `_timeout_task` to + complete using the `asyncio.wait` function. If the `_timeout_task` is not set, + it raises a `RuntimeError` to indicate that background tasks were not created. + + After the waiting process, it enters a while loop that continues as long as the + `_authenticated` event is set. Inside the loop, it waits for 0.5 seconds using + the `asyncio.sleep` function. This wait allows the logout process to complete + before continuing with the synchronization logic. + """ result = await self.async_login() self._attribute_lock.release() if result: @@ -707,6 +838,17 @@ def quick_relogin(self) -> bool: ).result() async def _do_login_query(self, timeout: int = 30) -> ClientResponse | None: + """ + Performs a login query to the Pulse site. + + Args: + timeout (int, optional): The timeout value for the query in seconds. + Defaults to 30. + + Returns: + ClientResponse | None: The response from the query or None if the login + was unsuccessful. + """ try: retval = await self._pulse_connection.async_query( ADT_LOGIN_URI, @@ -738,6 +880,7 @@ async def _do_login_query(self, timeout: int = 30) -> ClientResponse | None: return retval async def _do_logout_query(self) -> None: + """Performs a logout query to the ADT Pulse site.""" params = {} network: ADTPulseSite = self.site if network is not None: diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 46bd50c..b4cb748 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -29,6 +29,8 @@ RECOVERABLE_ERRORS = [429, 500, 502, 503, 504] LOG = logging.getLogger(__name__) +MAX_RETRIES = 3 + class ADTPulseConnection: """ADT Pulse connection related attributes.""" @@ -154,9 +156,8 @@ async def async_query( ) retry = 0 - max_retries = 3 response: Optional[ClientResponse] = None - while retry < max_retries: + while retry < MAX_RETRIES: try: async with self._session.request( method, diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 9e5234f..9a55110 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -20,6 +20,9 @@ LOG = logging.getLogger(__name__) +SECURITY_PANEL_ID = "1" +SECURITY_PANEL_NAME = "Security Panel" + class ADTPulseSite: """Represents an individual ADT Pulse site.""" @@ -201,6 +204,17 @@ def history(self): # of data from ADT Pulse async def _get_device_attributes(self, device_id: str) -> Optional[dict[str, str]]: + """ + Retrieves the attributes of a device. + + Args: + device_id (str): The ID of the device to retrieve attributes for. + + Returns: + Optional[dict[str, str]]: A dictionary of attribute names and their + corresponding values, + or None if the device response soup is None. + """ result: dict[str, str] = {} if device_id == ADT_GATEWAY_STRING: device_response = await self._pulse_connection.async_query( @@ -237,13 +251,19 @@ async def _get_device_attributes(self, device_id: str) -> Optional[dict[str, str return result async def _set_device(self, device_id: str) -> None: + """ + Sets the device attributes for the given device ID. + + Args: + device_id (str): The ID of the device. + """ dev_attr = await self._get_device_attributes(device_id) if dev_attr is None: return if device_id == ADT_GATEWAY_STRING: self._gateway.set_gateway_attributes(dev_attr) return - if device_id == "1": + if device_id == SECURITY_PANEL_ID: self._alarm_panel.set_alarm_attributes(dev_attr) return if device_id.isdigit(): @@ -252,6 +272,16 @@ async def _set_device(self, device_id: str) -> None: LOG.debug("Zone %s is not an integer, skipping", device_id) async def _fetch_devices(self, soup: Optional[BeautifulSoup]) -> bool: + """ + Fetches the devices from the given BeautifulSoup object and updates the zone attributes. + + Args: + soup (Optional[BeautifulSoup]): The BeautifulSoup object containing the devices. + + Returns: + bool: True if the devices were fetched and zone attributes were updated successfully, + False otherwise. + """ if not soup: response = await self._pulse_connection.async_query(ADT_SYSTEM_URI) soup = await make_soup( @@ -306,7 +336,10 @@ async def _fetch_devices(self, soup: Optional[BeautifulSoup]) -> bool: if result: device_id = result[0] - if device_id == "1" or device_name == "Security Panel": + if ( + device_id == SECURITY_PANEL_ID + or device_name == SECURITY_PANEL_NAME + ): task_list.append(create_task(self._set_device(device_id))) elif zone_id and zone_id.isdecimal(): task_list.append(create_task(self._set_device(device_id))) @@ -343,6 +376,15 @@ async def _async_update_zones_as_dict( return self._update_zone_from_soup(soup) def _update_zone_from_soup(self, soup: BeautifulSoup) -> Optional[ADTPulseZones]: + """ + Updates the zone information based on the provided BeautifulSoup object. + + Args: + soup (BeautifulSoup): The BeautifulSoup object containing the parsed HTML. + + Returns: + Optional[ADTPulseZones]: The updated ADTPulseZones object, or None if no zones exist. + """ # parse ADT's convulated html to get sensor status with self._site_lock: gateway_online = False From 8e5a3beb552c72d217ff60596d30f86492eeba4d Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 14 Oct 2023 06:55:39 -0400 Subject: [PATCH 013/226] partial revert 800e24f8d74e1adba3c95ce59c687b1e43d52bca --- pyadtpulse/zones.py | 63 +++++++++++++++++++++++++++++---------------- 1 file changed, 41 insertions(+), 22 deletions(-) diff --git a/pyadtpulse/zones.py b/pyadtpulse/zones.py index ada60e8..1402b7e 100644 --- a/pyadtpulse/zones.py +++ b/pyadtpulse/zones.py @@ -79,6 +79,17 @@ def _check_key(key: int) -> None: if not isinstance(key, int): raise ValueError("ADT Pulse Zone must be an integer") + def __getitem__(self, key: int) -> ADTPulseZoneData: + """Get a Zone. + + Args: + key (int): zone id + + Returns: + ADTPulseZoneData: zone data + """ + return super().__getitem__(key) + def _get_zonedata(self, key: int) -> ADTPulseZoneData: self._check_key(key) result: ADTPulseZoneData = self.data[key] @@ -108,7 +119,9 @@ def update_status(self, key: int, status: str) -> None: key (int): zone id to change status (str): status to set """ """""" - self[key]["status"] = status + temp = self._get_zonedata(key) + temp.status = status + self.__setitem__(key, temp) def update_state(self, key: int, state: str) -> None: """Update zone state. @@ -117,7 +130,9 @@ def update_state(self, key: int, state: str) -> None: key (int): zone id to change state (str): state to set """ - self[key]["state"] = state + temp = self._get_zonedata(key) + temp.state = state + self.__setitem__(key, temp) def update_last_activity_timestamp(self, key: int, dt: datetime) -> None: """Update timestamp. @@ -126,7 +141,9 @@ def update_last_activity_timestamp(self, key: int, dt: datetime) -> None: key (int): zone id to change dt (datetime): timestamp to set """ - self[key]["last_activity_timestamp"] = dt.timestamp() + temp = self._get_zonedata(key) + temp.last_activity_timestamp = int(dt.timestamp()) + self.__setitem__(key, temp) def update_device_info( self, @@ -147,9 +164,11 @@ def update_device_info( last_activity (datetime, optional): last_activity_datetime. Defaults to datetime.now(). """ - self.update_last_activity_timestamp(key, last_activity) - self.update_status(key, status) - self.update_state(key, state) + temp = self._get_zonedata(key) + temp.state = state + temp.status = status + temp.last_activity_timestamp = int(last_activity.timestamp()) + self.__setitem__(key, temp) def flatten(self) -> List[ADTPulseFlattendZone]: """Flattens ADTPulseZones into a list of ADTPulseFlattenedZones. @@ -176,39 +195,39 @@ def flatten(self) -> List[ADTPulseFlattendZone]: def update_zone_attributes(self, dev_attr: dict[str, str]) -> None: """Update zone attributes.""" - d_name = dev_attr.get("name", "Unknown") - d_type = dev_attr.get("type_model", "Unknown") - d_zone = dev_attr.get("zone", "Unknown") - d_status = dev_attr.get("status", "Unknown") + dName = dev_attr.get("name", "Unknown") + dType = dev_attr.get("type_model", "Unknown") + dZone = dev_attr.get("zone", "Unknown") + dStatus = dev_attr.get("status", "Unknown") - if d_zone != "Unknown": + if dZone != "Unknown": tags = None for search_term, default_tags in ADT_NAME_TO_DEFAULT_TAGS.items(): # convert to uppercase first - if search_term.upper() in d_type.upper(): + if search_term.upper() in dType.upper(): tags = default_tags break if not tags: LOG.warning( - "Unknown sensor type for '%s', defaulting to doorWindow", d_type + "Unknown sensor type for '%s', defaulting to doorWindow", dType ) tags = ("sensor", "doorWindow") LOG.debug( "Retrieved sensor %s id: sensor-%s Status: %s, tags %s", - d_name, - d_zone, - d_status, + dName, + dZone, + dStatus, tags, ) - if "Unknown" in (d_name, d_status, d_zone) or not d_zone.isdecimal(): + if "Unknown" in (dName, dStatus, dZone) or not dZone.isdecimal(): LOG.debug("Zone data incomplete, skipping...") else: - tmpzone = ADTPulseZoneData(d_name, f"sensor-{d_zone}", tags, d_status) - self.update({int(d_zone): tmpzone}) + tmpzone = ADTPulseZoneData(dName, f"sensor-{dZone}", tags, dStatus) + self.update({int(dZone): tmpzone}) else: LOG.debug( "Skipping incomplete zone name: %s, zone: %s status: %s", - d_name, - d_zone, - d_status, + dName, + dZone, + dStatus, ) From 4fd8384163d454e61118bb2356ce1ca31cd8c489 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 14 Oct 2023 06:57:31 -0400 Subject: [PATCH 014/226] change zones variables to snake case --- pyadtpulse/zones.py | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/pyadtpulse/zones.py b/pyadtpulse/zones.py index 1402b7e..e35539f 100644 --- a/pyadtpulse/zones.py +++ b/pyadtpulse/zones.py @@ -195,39 +195,39 @@ def flatten(self) -> List[ADTPulseFlattendZone]: def update_zone_attributes(self, dev_attr: dict[str, str]) -> None: """Update zone attributes.""" - dName = dev_attr.get("name", "Unknown") - dType = dev_attr.get("type_model", "Unknown") - dZone = dev_attr.get("zone", "Unknown") - dStatus = dev_attr.get("status", "Unknown") + d_name = dev_attr.get("name", "Unknown") + d_type = dev_attr.get("type_model", "Unknown") + d_zone = dev_attr.get("zone", "Unknown") + d_status = dev_attr.get("status", "Unknown") - if dZone != "Unknown": + if d_zone != "Unknown": tags = None for search_term, default_tags in ADT_NAME_TO_DEFAULT_TAGS.items(): # convert to uppercase first - if search_term.upper() in dType.upper(): + if search_term.upper() in d_type.upper(): tags = default_tags break if not tags: LOG.warning( - "Unknown sensor type for '%s', defaulting to doorWindow", dType + "Unknown sensor type for '%s', defaulting to doorWindow", d_type ) tags = ("sensor", "doorWindow") LOG.debug( "Retrieved sensor %s id: sensor-%s Status: %s, tags %s", - dName, - dZone, - dStatus, + d_name, + d_zone, + d_status, tags, ) - if "Unknown" in (dName, dStatus, dZone) or not dZone.isdecimal(): + if "Unknown" in (d_name, d_status, d_zone) or not d_zone.isdecimal(): LOG.debug("Zone data incomplete, skipping...") else: - tmpzone = ADTPulseZoneData(dName, f"sensor-{dZone}", tags, dStatus) - self.update({int(dZone): tmpzone}) + tmpzone = ADTPulseZoneData(d_name, f"sensor-{d_zone}", tags, d_status) + self.update({int(d_zone): tmpzone}) else: LOG.debug( "Skipping incomplete zone name: %s, zone: %s status: %s", - dName, - dZone, - dStatus, + d_name, + d_zone, + d_status, ) From 1cdf1b0e11531497645b7ac96868525b0e852447 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 16 Oct 2023 02:46:58 -0400 Subject: [PATCH 015/226] rework sync_check_task --- pyadtpulse/__init__.py | 57 ++++++++++++------------------------------ 1 file changed, 16 insertions(+), 41 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 5fb480f..b3e240c 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -559,35 +559,7 @@ async def _update_gateway_device_if_needed(self) -> None: await self.site._set_device(ADT_GATEWAY_STRING) async def _sync_check_task(self) -> None: - """ - Asynchronous function that performs a synchronization check task. - - This function is responsible for performing a synchronization check task. - It then initializes variables for the response, retry after, initial relogin - interval, and last sync text. - - The function validates that updates exist for the sync task and enters into - a loop. - - Within the loop, it adjusts the backoff poll interval, sleeps for a - maximum of the retry after value or the poll interval, and performs a sync check - query. - - The function then checks if the response is valid and handles any retry - scenarios. - - If the response is valid, it retrieves the text from the response - and validates the sync check response. - If the response is not valid, it increases the current relogin interval and - continues to the next iteration of the loop. - If the response is valid, it resets the relogin interval and handles - any updates. - If updates exist, it continues to the next iteration of the loop. - If no updates exist, it handles the scenario where no updates exist and resets - the have_updates flag to False. - - If the function is cancelled, it logs a debug message and returns. - """ + """Asynchronous function that performs a synchronization check task.""" task_name = self._get_sync_task_name() LOG.debug("creating %s", task_name) @@ -600,11 +572,15 @@ async def _sync_check_task(self) -> None: self._validate_updates_exist(task_name) - have_updates = False + last_sync_check_was_different = False while True: try: self.site.gateway.adjust_backoff_poll_interval() - pi = self.site.gateway.poll_interval if not have_updates else 0.0 + pi = ( + self.site.gateway.poll_interval + if not last_sync_check_was_different + else 0.0 + ) await asyncio.sleep(max(retry_after, pi)) response = await self._perform_sync_check_query() @@ -616,7 +592,7 @@ async def _sync_check_task(self) -> None: continue text = await response.text() - if not self._validate_sync_check_response( + if not await self._validate_sync_check_response( response, text, current_relogin_interval ): current_relogin_interval = min( @@ -626,14 +602,15 @@ async def _sync_check_task(self) -> None: continue current_relogin_interval = initial_relogin_interval close_response(response) - if self._handle_updates_exist(text, last_sync_text): - have_updates = True + last_sync_check_was_different = True + last_sync_text = text + continue + if await self._handle_no_updates_exist( + last_sync_check_was_different, task_name, text + ): + last_sync_check_was_different = False continue - - await self._handle_no_updates_exist(have_updates, task_name, text) - have_updates = False - except asyncio.CancelledError: LOG.debug("%s cancelled", task_name) close_response(response) @@ -690,10 +667,9 @@ async def _validate_sync_check_response( return False return True - def _handle_updates_exist(self, text: str, last_sync_text: str): + def _handle_updates_exist(self, text: str, last_sync_text: str) -> bool: if text != last_sync_text: LOG.debug("Updates exist: %s, requerying", text) - last_sync_text = text return True return False @@ -701,7 +677,6 @@ async def _handle_no_updates_exist( self, have_updates: bool, task_name: str, text: str ) -> None: if have_updates: - have_updates = False if await self.async_update() is False: LOG.debug("Pulse data update from %s failed", task_name) return From 2c978b061199bdbf031e9b0fe3ca32f59d1669d4 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 16 Oct 2023 04:26:28 -0400 Subject: [PATCH 016/226] add gateway pytests --- pyadtpulse/tests/test_gateway.py | 278 +++++++++++++++++++++++++++++++ 1 file changed, 278 insertions(+) create mode 100644 pyadtpulse/tests/test_gateway.py diff --git a/pyadtpulse/tests/test_gateway.py b/pyadtpulse/tests/test_gateway.py new file mode 100644 index 0000000..bd7177e --- /dev/null +++ b/pyadtpulse/tests/test_gateway.py @@ -0,0 +1,278 @@ +# Generated by CodiumAI +from datetime import datetime, time, timedelta +from ipaddress import IPv4Address + +import pytest + +from pyadtpulse.const import ( + ADT_DEFAULT_POLL_INTERVAL, + ADT_GATEWAY_OFFLINE_POLL_INTERVAL, +) +from pyadtpulse.gateway import ADTPulseGateway + + +class TestADTPulseGateway: + # create an instance of ADTPulseGateway with default values + def test_create_instance_with_default_values(self): + gateway = ADTPulseGateway() + assert gateway.manufacturer == "Unknown" + assert gateway._status_text == "OFFLINE" + assert gateway._current_poll_interval == ADT_DEFAULT_POLL_INTERVAL + assert gateway._initial_poll_interval == ADT_DEFAULT_POLL_INTERVAL + assert gateway.model is None + assert gateway.serial_number is None + assert gateway.next_update == 0 + assert gateway.last_update == 0 + assert gateway.firmware_version is None + assert gateway.hardware_version is None + assert gateway.primary_connection_type is None + assert gateway.broadband_connection_status is None + assert gateway.cellular_connection_status is None + assert gateway.cellular_connection_signal_strength == 0.0 + assert gateway.broadband_lan_ip_address is None + assert gateway.broadband_lan_mac is None + assert gateway.device_lan_ip_address is None + assert gateway.device_lan_mac is None + assert gateway.router_lan_ip_address is None + assert gateway.router_wan_ip_address is None + + # set is_online to True and check that it returns True + def test_set_is_online_true(self): + gateway = ADTPulseGateway() + gateway.is_online = True + assert gateway.is_online is True + + # set is_online to False and check that it returns False + def test_set_is_online_false(self): + gateway = ADTPulseGateway() + gateway.is_online = False + assert gateway.is_online is False + + # set poll_interval to a valid value and check that it returns the same value + def test_set_poll_interval_valid_value(self): + gateway = ADTPulseGateway() + gateway.poll_interval = 10.0 + assert gateway.poll_interval == 10.0 + + # set poll_interval to None and check that it returns ADT_DEFAULT_POLL_INTERVAL + def test_set_poll_interval_none(self): + gateway = ADTPulseGateway() + gateway.poll_interval = None + assert gateway.poll_interval == ADT_DEFAULT_POLL_INTERVAL + + # set gateway attributes using set_gateway_attributes method and check that + # they are set correctly + def test_set_gateway_attributes(self): + gateway = ADTPulseGateway() + attributes = { + "manufacturer": "ADT", + "_status_text": "ONLINE", + "model": "1234", + "serial_number": "5678", + "next_update": "Today 9:03 AM", + "last_update": "Yesterday 11:55 PM", + "firmware_version": "1.0", + "hardware_version": "2.0", + "primary_connection_type": "Ethernet", + "broadband_connection_status": "Connected", + "cellular_connection_status": "Disconnected", + "cellular_connection_signal_strength": 3.5, + "broadband_lan_ip_address": IPv4Address("192.168.1.1"), + "broadband_lan_mac": "00:11:22:33:44:55", + "device_lan_ip_address": IPv4Address("192.168.1.2"), + "device_lan_mac": "AA:BB:CC:DD:EE:FF", + "router_lan_ip_address": IPv4Address("192.168.1.3"), + "router_wan_ip_address": IPv4Address("10.0.0.1"), + } + gateway.set_gateway_attributes(attributes) + assert gateway.manufacturer == "ADT" + assert gateway.model == "1234" + assert gateway.serial_number == "5678" + now = datetime.now() + yesterday = now - timedelta(days=1) + assert gateway.next_update == int( + datetime.combine(now.date(), time(9, 3)).timestamp() + ) + assert gateway.last_update == int( + datetime.combine(yesterday.date(), time(11, 55)).timestamp() + ) + assert gateway.firmware_version == "1.0" + assert gateway.hardware_version == "2.0" + assert gateway.primary_connection_type == "Ethernet" + assert gateway.broadband_connection_status == "Connected" + assert gateway.cellular_connection_status == "Disconnected" + assert gateway.cellular_connection_signal_strength == 3.5 + assert gateway.broadband_lan_ip_address == IPv4Address("192.168.1.1") + assert gateway.broadband_lan_mac == "00:11:22:33:44:55" + assert gateway.device_lan_ip_address == IPv4Address("192.168.1.2") + assert gateway.device_lan_mac == "AA:BB:CC:DD:EE:FF" + assert gateway.router_lan_ip_address == IPv4Address("192.168.1.3") + assert gateway.router_wan_ip_address == IPv4Address("10.0.0.1") + + # set poll_interval to a negative value and check that it raises a ValueError + def test_set_poll_interval_negative_value(self): + gateway = ADTPulseGateway() + with pytest.raises(ValueError): + gateway.poll_interval = -10.0 + + # set gateway attributes with invalid IP address and check that it + # sets the attribute to None + def test_set_gateway_attributes_invalid_ip_address(self): + gateway = ADTPulseGateway() + attributes = { + "broadband_lan_ip_address": "invalid_ip_address", + "device_lan_ip_address": "invalid_ip_address", + "router_lan_ip_address": "invalid_ip_address", + "router_wan_ip_address": "invalid_ip_address", + } + gateway.set_gateway_attributes(attributes) + assert gateway.broadband_lan_ip_address is None + assert gateway.device_lan_ip_address is None + assert gateway.router_lan_ip_address is None + assert gateway.router_wan_ip_address is None + + # set gateway attributes with invalid datetime and check that it + # sets the attribute to None + def test_set_gateway_attributes_invalid_datetime(self): + gateway = ADTPulseGateway() + attributes = { + "next_update": "invalid_datetime", + "last_update": "invalid_datetime", + } + gateway.set_gateway_attributes(attributes) + assert gateway.next_update is None + assert gateway.last_update is None + + # set is_online to True when it is already True and check that it does not + # change the status + def test_set_is_online_true_already_true(self): + gateway = ADTPulseGateway() + gateway.is_online = True + gateway.is_online = True + assert gateway.is_online is True + + # set is_online to False when it is already False and check that it does + # not change the status + def test_set_is_online_false_already_false(self): + gateway = ADTPulseGateway() + gateway.is_online = False + gateway.is_online = False + assert gateway.is_online is False + + # Check that adjust_backoff_poll_interval method sets the current poll + # interval correctly + def test_adjust_backoff_poll_interval_fixed(self): + gateway = ADTPulseGateway() + gateway.poll_interval = ADT_DEFAULT_POLL_INTERVAL + gateway.adjust_backoff_poll_interval() + assert gateway._current_poll_interval == ADT_DEFAULT_POLL_INTERVAL * 2 + gateway.is_online = True + gateway.adjust_backoff_poll_interval() + assert gateway._current_poll_interval == ADT_DEFAULT_POLL_INTERVAL + gateway.is_online = False + gateway.adjust_backoff_poll_interval() + assert gateway._current_poll_interval == ADT_DEFAULT_POLL_INTERVAL + gateway.adjust_backoff_poll_interval() + assert gateway._current_poll_interval == ADT_DEFAULT_POLL_INTERVAL * 2 + gateway.adjust_backoff_poll_interval() + assert gateway._current_poll_interval == ADT_DEFAULT_POLL_INTERVAL * 4 + gateway.is_online = True + gateway.adjust_backoff_poll_interval() + assert gateway._current_poll_interval == ADT_DEFAULT_POLL_INTERVAL + + # check that is_online setter changes the poll interval correctly + def test_is_online_setter_changes_poll_interval(self): + gateway = ADTPulseGateway() + gateway.is_online = True + assert gateway._status_text == "ONLINE" + assert gateway._current_poll_interval == ADT_DEFAULT_POLL_INTERVAL + gateway.is_online = False + assert gateway._status_text == "OFFLINE" + assert gateway._current_poll_interval == ADT_GATEWAY_OFFLINE_POLL_INTERVAL + + # check that poll_interval setter changes the poll interval correctly + def test_poll_interval_setter_changes_poll_interval(self): + gateway = ADTPulseGateway() + gateway.poll_interval = 60.0 + assert gateway._initial_poll_interval == 60.0 + assert gateway._current_poll_interval == 60.0 + gateway.poll_interval = None + assert gateway._initial_poll_interval == ADT_DEFAULT_POLL_INTERVAL + assert gateway._current_poll_interval == ADT_DEFAULT_POLL_INTERVAL + + # check that set_gateway_attributes method sets None for empty strings + def test_set_gateway_attributes_sets_none_for_empty_strings(self): + gateway = ADTPulseGateway() + attributes = { + "manufacturer": "", + "model": "", + "serial_number": "", + "firmware_version": "", + "hardware_version": "", + "primary_connection_type": "", + "broadband_connection_status": "", + "cellular_connection_status": "", + "broadband_lan_mac": "", + "device_lan_mac": "", + "router_lan_ip_address": "", + "router_wan_ip_address": "", + } + gateway.set_gateway_attributes(attributes) + assert gateway.manufacturer is None + assert gateway.model is None + assert gateway.serial_number is None + assert gateway.firmware_version is None + assert gateway.hardware_version is None + assert gateway.primary_connection_type is None + assert gateway.broadband_connection_status is None + assert gateway.cellular_connection_status is None + assert gateway.broadband_lan_mac is None + assert gateway.device_lan_mac is None + assert gateway.router_lan_ip_address is None + assert gateway.router_wan_ip_address is None + + # Check that set_gateway_attributes method sets None for None values and throws an + # exception for mandatory parameters set to None + def test_set_gateway_attributes_sets_none_for_none_values(self): + gateway = ADTPulseGateway() + attributes = { + "manufacturer": None, + "_status_text": None, + "_current_poll_interval": None, + "_initial_poll_interval": None, + "model": None, + "serial_number": None, + "next_update": None, + "last_update": None, + "firmware_version": None, + "hardware_version": None, + "primary_connection_type": None, + "broadband_connection_status": None, + "cellular_connection_status": None, + "cellular_connection_signal_strength": None, + "broadband_lan_ip_address": None, + "broadband_lan_mac": None, + "device_lan_ip_address": None, + "device_lan_mac": None, + "router_lan_ip_address": None, + "router_wan_ip_address": None, + } + gateway.set_gateway_attributes(attributes) + assert gateway.manufacturer is None + assert gateway._initial_poll_interval == ADT_DEFAULT_POLL_INTERVAL + assert gateway.model is None + assert gateway.serial_number is None + assert gateway.next_update is None + assert gateway.last_update is None + assert gateway.firmware_version is None + assert gateway.hardware_version is None + assert gateway.primary_connection_type is None + assert gateway.broadband_connection_status is None + assert gateway.cellular_connection_status is None + assert gateway.cellular_connection_signal_strength is None + assert gateway.broadband_lan_ip_address is None + assert gateway.broadband_lan_mac is None + assert gateway.device_lan_ip_address is None + assert gateway.device_lan_mac is None + assert gateway.router_lan_ip_address is None + assert gateway.router_wan_ip_address is None From 0395876ba91943d24e99fe9ec29cbfbf96dd1fcc Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 16 Oct 2023 05:15:05 -0400 Subject: [PATCH 017/226] add alarm panel tests --- pyadtpulse/tests/test_alarm_panel.py | 279 +++++++++++++++++++++++++++ 1 file changed, 279 insertions(+) create mode 100644 pyadtpulse/tests/test_alarm_panel.py diff --git a/pyadtpulse/tests/test_alarm_panel.py b/pyadtpulse/tests/test_alarm_panel.py new file mode 100644 index 0000000..26bbf2b --- /dev/null +++ b/pyadtpulse/tests/test_alarm_panel.py @@ -0,0 +1,279 @@ +# Generated by CodiumAI + +import logging +import asyncio +import time +from threading import RLock + +# Dependencies: +# pip install pytest-mock +import pytest +from bs4 import BeautifulSoup + +from pyadtpulse.alarm_panel import ( + ADT_ALARM_ARMING, + ADT_ALARM_AWAY, + ADT_ALARM_HOME, + ADT_ALARM_OFF, + ADTPulseAlarmPanel, +) +from pyadtpulse.const import ADT_ARM_DISARM_URI +from pyadtpulse.pulse_connection import ADTPulseConnection + + +class TestADTPulseAlarmPanel: + # ADTPulseAlarmPanel object is created with default values + def test_default_values(self): + alarm_panel = ADTPulseAlarmPanel() + assert alarm_panel.model == "Unknown" + assert alarm_panel._sat == "" + assert alarm_panel._status == "Unknown" + assert alarm_panel.manufacturer == "ADT" + assert alarm_panel.online == True + assert alarm_panel._is_force_armed == False + assert isinstance(alarm_panel._state_lock, RLock) + assert alarm_panel._last_arm_disarm == int(time()) + + # ADTPulseAlarmPanel status is updated correctly after arming/disarming + def test_status_update(self, mocker): + alarm_panel = ADTPulseAlarmPanel() + connection_mock = mocker.Mock() + connection_mock.async_query.return_value = "response" + make_soup_mock = mocker.patch("pyadpulse.alarm_panel.make_soup") + make_soup_mock.return_value = "soup" + alarm_panel._status = ADT_ALARM_OFF + alarm_panel._arm(connection_mock, ADT_ALARM_AWAY, False) + connection_mock.async_query.assert_called_once_with( + ADT_ARM_DISARM_URI, + method="POST", + extra_params={ + "href": "rest/adt/ui/client/security/setArmState", + "armstate": ADT_ALARM_OFF, + "arm": ADT_ALARM_AWAY, + "sat": "", + }, + timeout=10, + ) + make_soup_mock.assert_called_once_with( + "response", + logging.WARNING, + f"Failed updating ADT Pulse alarm {alarm_panel._sat} to {ADT_ALARM_AWAY}", + ) + assert alarm_panel._status == ADT_ALARM_ARMING + assert alarm_panel._last_arm_disarm == int(time()) + + # ADTPulseAlarmPanel is force armed and disarmed correctly + def test_force_arm_disarm(self, mocker): + alarm_panel = ADTPulseAlarmPanel() + connection_mock = mocker.Mock() + connection_mock.async_query.return_value = "response" + make_soup_mock = mocker.patch("pyadpulse.alarm_panel.make_soup") + make_soup_mock.return_value = "soup" + alarm_panel._status = ADT_ALARM_OFF + alarm_panel._arm(connection_mock, ADT_ALARM_AWAY, True) + connection_mock.async_query.assert_called_once_with( + ADT_ARM_DISARM_URI, + method="POST", + extra_params={ + "href": "rest/adt/ui/client/security/setForceArm", + "armstate": "forcearm", + "arm": ADT_ALARM_AWAY, + "sat": "", + }, + timeout=10, + ) + make_soup_mock.assert_called_once_with( + "response", + logging.WARNING, + f"Failed updating ADT Pulse alarm {alarm_panel._sat} to {ADT_ALARM_AWAY}", + ) + assert alarm_panel._status == ADT_ALARM_ARMING + assert alarm_panel._is_force_armed == True + assert alarm_panel._last_arm_disarm == int(time()) + + # ADTPulseAlarmPanel attributes are set correctly + def test_set_attributes(self): + alarm_panel = ADTPulseAlarmPanel() + alarm_attributes = { + "type_model": "Model", + "manufacturer_provider": "Manufacturer", + "status": "Online", + } + alarm_panel.set_alarm_attributes(alarm_attributes) + assert alarm_panel.model == "Model" + assert alarm_panel.manufacturer == "Manufacturer" + assert alarm_panel.online == True + + # ADTPulseAlarmPanel is updated correctly from HTML soup + def test_update_from_soup(self, mocker): + alarm_panel = ADTPulseAlarmPanel() + summary_html_soup_mock = mocker.Mock() + value_mock = mocker.Mock() + value_mock.text = "Armed Away" + summary_html_soup_mock.find.return_value = value_mock + alarm_panel._update_alarm_from_soup(summary_html_soup_mock) + assert alarm_panel._status == ADT_ALARM_AWAY + assert alarm_panel._last_arm_disarm == int(time()) + + # ADTPulseAlarmPanel is already in the requested status + def test_already_in_requested_status(self, mocker): + alarm_panel = ADTPulseAlarmPanel() + connection_mock = mocker.Mock() + connection_mock.async_query.return_value = "response" + make_soup_mock = mocker.patch("pyadpulse.alarm_panel.make_soup") + make_soup_mock.return_value = "soup" + alarm_panel._status = ADT_ALARM_AWAY + result = alarm_panel._arm(connection_mock, ADT_ALARM_AWAY, False) + assert result == False + connection_mock.async_query.assert_not_called() + make_soup_mock.assert_not_called() + assert alarm_panel._status == ADT_ALARM_AWAY + assert alarm_panel._last_arm_disarm == int(time()) + + # ADTPulseAlarmPanel is already armed and another arm request is made + def test_already_armed_and_arm_request(self, mocker): + alarm_panel = ADTPulseAlarmPanel() + connection_mock = mocker.Mock() + connection_mock.async_query.return_value = "response" + make_soup_mock = mocker.patch("pyadpulse.alarm_panel.make_soup") + make_soup_mock.return_value = "soup" + alarm_panel._status = ADT_ALARM_AWAY + result = alarm_panel._arm(connection_mock, ADT_ALARM_HOME, False) + assert result == False + connection_mock.async_query.assert_not_called() + make_soup_mock.assert_not_called() + assert alarm_panel._status == ADT_ALARM_AWAY + assert alarm_panel._last_arm_disarm == int(time()) + + # ADTPulseAlarmPanel is already disarmed and another disarm request is made + def test_already_disarmed_and_disarm_request(self, mocker): + alarm_panel = ADTPulseAlarmPanel() + connection_mock = mocker.Mock() + connection_mock.async_query.return_value = "response" + assert False + + # ADTPulseAlarmPanel is unable to extract sat + @pytest.mark.asyncio + async def test_unable_to_extract_sat(self, mocker): + # Mock the dependencies + mocker.patch("pyadpulse.adt_pulse_alarm_panel.make_soup", return_value=None) + + # Create an instance of ADTPulseAlarmPanel + alarm_panel = ADTPulseAlarmPanel() + + # Call the method that should extract sat + alarm_panel._update_alarm_from_soup(BeautifulSoup()) + + # Assert that the sat is still empty + assert alarm_panel._sat == "" + + # ADTPulseAlarmPanel is unable to set alarm status + @pytest.mark.asyncio + async def test_unable_to_set_alarm_status(self, mocker): + # Mock the dependencies + mocker.patch( + "pyadpulse.adt_pulse_alarm_panel.make_soup", return_value=BeautifulSoup() + ) + mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ARM_DISARM_URI") + mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_OFF", "OFF") + mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_ARMING", "ARMING") + + # Create an instance of ADTPulseAlarmPanel + alarm_panel = ADTPulseAlarmPanel() + + # Call the method that should set the alarm status + await alarm_panel._arm(ADTPulseConnection(), "OFF", False) + + # Assert that the status is still unknown + assert alarm_panel._status == "Unknown" + + # ADTPulseAlarmPanel is able to handle concurrent requests + @pytest.mark.asyncio + async def test_concurrent_requests(self, mocker): + # Mock the dependencies + mocker.patch( + "pyadpulse.adt_pulse_alarm_panel.make_soup", return_value=BeautifulSoup() + ) + mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ARM_DISARM_URI") + mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_OFF", "OFF") + mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_ARMING", "ARMING") + + # Create an instance of ADTPulseAlarmPanel + alarm_panel = ADTPulseAlarmPanel() + + # Call the method that should set the alarm status concurrently + await asyncio.gather( + alarm_panel._arm(ADTPulseConnection(), "OFF", False), + alarm_panel._arm(ADTPulseConnection(), "ARMING", False), + ) + + # Assert that the status is updated correctly + assert alarm_panel._status == "ARMING" + + # ADTPulseAlarmPanel is able to handle invalid input + def test_handle_invalid_input(self, mocker): + # Mock dependencies + mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ARM_DISARM_URI") + mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_AWAY") + mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_HOME") + mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_OFF") + mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_UNKNOWN") + mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_ARMING") + mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_DISARMING") + mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ARM_DISARM_TIMEOUT") + + # Create instance of ADTPulseAlarmPanel + alarm_panel = ADTPulseAlarmPanel() + + # Test invalid input + assert alarm_panel.arm_away(None) == False + assert alarm_panel.arm_home(None) == False + assert alarm_panel.disarm(None) == False + + # ADTPulseAlarmPanel is able to handle connection errors + @pytest.mark.asyncio + async def test_handle_connection_errors(self, mocker): + # Mock ADTPulseConnection + mock_connection = mocker.Mock() + mock_connection.async_query.side_effect = ConnectionError + + # Create ADTPulseAlarmPanel instance + alarm_panel = ADTPulseAlarmPanel() + + # Call the method that should handle connection errors + result = await alarm_panel._arm(mock_connection, ADT_ALARM_AWAY, False) + + # Verify that the method returns False + assert result == False + + # ADTPulseAlarmPanel is able to handle timeouts + @pytest.mark.asyncio + async def test_handle_timeouts(self, mocker): + # Mock ADTPulseConnection + mock_connection = mocker.Mock() + mock_connection.async_query.side_effect = TimeoutError + + # Create ADTPulseAlarmPanel instance + alarm_panel = ADTPulseAlarmPanel() + + # Call the method that should handle timeouts + result = await alarm_panel._arm(mock_connection, ADT_ALARM_AWAY, False) + + # Verify that the method returns False + assert result == False + + # ADTPulseAlarmPanel is able to handle unexpected HTML soup + @pytest.mark.asyncio + async def test_handle_unexpected_html_soup(self, mocker): + # Mock ADTPulseConnection + mock_connection = mocker.Mock() + mock_connection.async_query.return_value = '
Error
' + + # Create ADTPulseAlarmPanel instance + alarm_panel = ADTPulseAlarmPanel() + + # Call the method that should handle unexpected HTML soup + result = await alarm_panel._arm(mock_connection, ADT_ALARM_AWAY, False) + + # Verify that the method returns False + assert result == False From 734465e9f97165791f3575aa43ec60d23205258c Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Mon, 16 Oct 2023 13:53:58 -0400 Subject: [PATCH 018/226] fix extra whitespace in util.py --- pyadtpulse/util.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyadtpulse/util.py b/pyadtpulse/util.py index 15fa564..efcabcc 100644 --- a/pyadtpulse/util.py +++ b/pyadtpulse/util.py @@ -60,7 +60,7 @@ def remove_prefix(text: str, prefix: str) -> str: Returns: str: modified string """ - return text[text.startswith(prefix) and len(prefix) :] + return text[text.startswith(prefix) and len(prefix):] async def make_soup( From 5b3f563d5b736ab2317691273c7e414f3b78941a Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Mon, 16 Oct 2023 13:55:12 -0400 Subject: [PATCH 019/226] fix extra whitespace in util.py --- pyadtpulse/util.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyadtpulse/util.py b/pyadtpulse/util.py index efcabcc..15fa564 100644 --- a/pyadtpulse/util.py +++ b/pyadtpulse/util.py @@ -60,7 +60,7 @@ def remove_prefix(text: str, prefix: str) -> str: Returns: str: modified string """ - return text[text.startswith(prefix) and len(prefix):] + return text[text.startswith(prefix) and len(prefix) :] async def make_soup( From 68c93e93a5d157aa76b235f4f3fe2dc88f696835 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Mon, 16 Oct 2023 15:00:59 -0400 Subject: [PATCH 020/226] add test_util.py --- pyadtpulse/tests/test_util.py | 375 ++++++++++++++++++++++++++++++++++ 1 file changed, 375 insertions(+) create mode 100644 pyadtpulse/tests/test_util.py diff --git a/pyadtpulse/tests/test_util.py b/pyadtpulse/tests/test_util.py new file mode 100644 index 0000000..32c3900 --- /dev/null +++ b/pyadtpulse/tests/test_util.py @@ -0,0 +1,375 @@ +# Generated by +import logging +from datetime import datetime, timedelta +from bs4 import BeautifulSoup +from pyadtpulse.util import ( + handle_response, + close_response, + remove_prefix, + make_soup, + parse_pulse_datetime, +) + + +class TestHandleResponse: + # Returns True if response is not None and response.ok is True + def test_returns_true_if_response_is_not_none_and_response_ok_is_true(self, mocker): + response = mocker.Mock() + response.ok = True + assert handle_response(response, 0, "") is True + + # Logs nothing if response is not None and response.ok is True + def test_logs_nothing_if_response_is_not_none_and_response_ok_is_true(self, mocker): + response = mocker.Mock() + response.ok = True + mocker.patch("logging.log") + handle_response(response, 0, "") + logging.log.assert_not_called() + + # Logs nothing if response is None + def test_logs_nothing_if_response_is_none_fixed(self, mocker): + mocker.patch("logging.log") + handle_response(None, 0, "") + logging.log.assert_not_called() + + # Returns False if response is None + def test_returns_false_if_response_is_none(self, mocker): + assert handle_response(None, 0, "") is False + + # Logs an error message if response is None + def test_logs_error_message_if_response_is_none(self, mocker): + mocker.patch("logging.log") + handle_response(None, 0, "error") + logging.log.assert_called_once_with(0, "error") + + # Returns False if response.ok is False + def test_returns_false_if_response_ok_is_false(self, mocker): + response = mocker.Mock() + response.ok = False + assert handle_response(response, 0, "") is False + + # Logs an error message if response.ok is False + def test_logs_error_message_if_response_ok_is_false(self, mocker): + response = mocker.Mock() + response.ok = False + response.status = 404 + mocker.patch("logging.log") + handle_response(response, 0, "error") + logging.log.assert_called_once_with(0, "error: error code = 404") + + # Returns False if response is not None but response.ok is False + def test_returns_false_if_response_is_not_none_but_response_ok_is_false( + self, mocker + ): + response = mocker.Mock() + response.ok = False + assert handle_response(response, 0, "") is False + + # Closes the response if it is not None + def test_closes_response_if_it_is_not_none(self, mocker): + response = mocker.Mock() + response.ok = True + handle_response(response, 0, "") + assert response.close.call_count == 0 + + # Logs the error message and response status if response is not None but response.ok is False + def test_logs_error_message_and_response_status_if_response_is_not_none_but_response_ok_is_false( + self, mocker + ): + response = mocker.Mock() + response.ok = False + response.status = 404 + logger_mock = mocker.patch("logging.log") + handle_response(response, 0, "error") + logger_mock.log.assert_called_once_with(0, "error: error code = 404") + + # Logs the error message and response status with the specified logging level + def test_logs_error_message_and_response_status_with_specified_logging_level( + self, mocker + ): + response = mocker.Mock() + response.ok = False + response.status = 404 + mocker.patch("logging.log") + handle_response(response, 1, "error") + logging.log.assert_called_once_with(1, "error: error code = 404") + + # Returns True if response is not None and response.ok is True, even if logging fails + def test_returns_true_if_response_is_not_none_and_response_ok_is_true_even_if_logging_fails( + self, mocker + ): + response = mocker.Mock() + response.ok = True + mocker.patch("logging.log", side_effect=Exception) + assert handle_response(response, 0, "") is True + + +# Generated by CodiumAI + +# Dependencies: +# pip install pytest-mock +import pytest + + +class TestCloseResponse: + # Close a response object that is not None and not already closed. + def test_close_response_not_none_not_closed(self, mocker): + response = mocker.Mock() + response.closed = False + close_response(response) + response.close.assert_called_once() + + # Close a response object that is None. + def test_close_response_none(self, mocker): + response = None + close_response(response) + + # Close a response object that is already closed. + def test_close_response_already_closed(self, mocker): + response = mocker.Mock() + response.closed = True + close_response(response) + response.close.assert_not_called() + + # Close a response object that has already been closed and is None. + def test_close_response_closed_none_fixed(self, mocker): + response = None + close_response(response) + + # Close a response object that has already been closed and is not None. + def test_close_response_closed_not_none(self, mocker): + response = mocker.Mock() + response.closed = True + close_response(response) + response.close.assert_not_called() + + # Close a response object that is not None but has a 'closed' attribute that is not a boolean. + def test_close_response_non_boolean_closed_attribute(self, mocker): + response = mocker.Mock() + response.closed = "True" + close_response(response) + response.close.assert_not_called() + + # Close a response object that is not None but has a 'closed' attribute that is not readable. + def test_close_response_non_readable_closed_attribute(self, mocker): + response = mocker.Mock() + response.closed = mocker.PropertyMock(side_effect=AttributeError) + close_response(response) + response.close.assert_not_called() + + +class TestRemovePrefix: + # prefix is at the beginning of the text + def test_prefix_at_beginning(self): + assert remove_prefix("hello world", "hello") == " world" + + # prefix is not in the text + def test_prefix_not_in_text(self): + assert remove_prefix("hello world", "hi") == "hello world" + + # prefix is an empty string + def test_empty_prefix(self): + assert remove_prefix("hello world", "") == "hello world" + + # prefix is the entire text + def test_entire_text_as_prefix(self): + assert remove_prefix("hello world", "hello world") == "" + + # prefix is longer than the text + def test_longer_prefix(self): + assert remove_prefix("hello", "hello world") == "hello" + + # text is an empty string + def test_empty_text(self): + assert remove_prefix("", "hello") == "" + + +# Generated by CodiumAI + +# Dependencies: +# pip install pytest-mock +import pytest + + +class TestMakeSoup: + # Returns a BeautifulSoup object when given a valid response + @pytest.mark.asyncio + async def test_valid_response(self, mocker): + response = mocker.Mock() + response.ok = True + response.text.return_value = "

Test

" + make_soup_mock = mocker.patch("module.make_soup", side_effect=make_soup) + result = await make_soup(response, 1, "Error") + assert isinstance(result, BeautifulSoup) + assert result.text == "

Test

" + make_soup_mock.assert_called_once_with(response, 1, "Error") + + # Closes the response object after extracting text + @pytest.mark.asyncio + async def test_close_response(self, mocker): + response = mocker.Mock() + response.ok = True + response.text.return_value = "

Test

" + close_mock = mocker.patch.object(response, "close") + await make_soup(response, 1, "Error") + close_mock.assert_called_once() + + # Returns None when given a None response + @pytest.mark.asyncio + async def test_none_response(self, mocker): + result = await make_soup(None, 1, "Error") + assert result is None + + # Returns None when given a response with a non-OK status code + @pytest.mark.asyncio + async def test_non_ok_response(self, mocker): + response = mocker.Mock() + response.ok = False + response.status = 404 + result = await make_soup(response, 1, "Error") + assert result is None + + # Returns None when an exception is raised while extracting text + @pytest.mark.asyncio + async def test_exception_raised(self, mocker): + response = mocker.Mock() + response.ok = True + response.text.side_effect = Exception("Error") + result = await make_soup(response, 1, "Error") + assert result is None + + # Logs an error message when given a None response + @pytest.mark.asyncio + async def test_log_none_response(self, mocker): + mocker.patch("logging.log") + await make_soup(None, 1, "Error") + logging.log.assert_called_once_with(1, "Error") + + # Logs an error message when given a response with a non-OK status code + @pytest.mark.asyncio + async def test_log_non_ok_response(self, mocker): + mocker.patch("logging.log") + response = mocker.Mock() + response.ok = False + response.status = 404 + await make_soup(response, 1, "Error") + logging.log.assert_called_once_with(1, "Error: error code = 404") + + # Handles a response with an empty body + @pytest.mark.asyncio + async def test_empty_body(self, mocker): + response = mocker.Mock() + response.ok = True + response.text.return_value = "" + result = await make_soup(response, 1, "Error") + assert result is None + + # Handles a response with a non-HTML content type + @pytest.mark.asyncio + async def test_non_html_content_type(self, mocker): + response = mocker.Mock() + response.ok = True + response.headers = {"Content-Type": "application/json"} + result = await make_soup(response, 1, "Error") + assert result is None + + # Handles a response with a malformed HTML body + @pytest.mark.asyncio + async def test_malformed_html_body(self, mocker): + response = mocker.Mock() + response.ok = True + response.text.return_value = "

Test

" + result = await make_soup(response, 1, "Error") + assert result is None + + +class TestParsePulseDatetime: + + # Parses a valid datestring with "Today" as the first element of the split string and an extra string after the time + def test_parses_valid_datestring_with_today_with_extra_string(self): + datestring = "Today\xa012:34PM" + expected_result = datetime.combine(datetime.today(), datetime.strptime("12:34PM", "%I:%M%p").time()) + assert parse_pulse_datetime(datestring) == expected_result + + # Parses a valid datestring with "Yesterday" as the first element of the split string, with a valid time string as the second element of the split string + def test_parses_valid_datestring_with_yesterday_fixed_fixed(self): + datestring = "Yesterday\xa0\xa012:34PM" + expected_result = datetime.combine(datetime.today() - timedelta(days=1), datetime.strptime("12:34PM", "%I:%M%p").time()) + assert parse_pulse_datetime(datestring) == expected_result + + # Parses a valid datestring with a date string as the first element of the split string + def test_parses_valid_datestring_with_date_string(self): + datestring = "01/01\xa0\xa012:34PM" + expected_result = datetime.combine(datetime(datetime.now().year, 1, 1), datetime.strptime("12:34PM", "%I:%M%p").time()) + assert parse_pulse_datetime(datestring) == expected_result + + # Parses a valid datestring with a time string as the second element of the split string + def test_parses_valid_datestring_with_time_string(self): + datestring = "Today\xa012:34PM\xa0" + expected_result = datetime.combine(datetime.today(), datetime.strptime("12:34PM", "%I:%M%p").time()) + assert parse_pulse_datetime(datestring) == expected_result + + # Parses a valid datestring with a time period string as the third element of the split string + def test_parses_valid_datestring_with_time_period_string(self): + datestring = "Today\xa0\xa012:34PM" + expected_result = datetime.combine(datetime.today(), datetime.strptime("12:34PM", "%I:%M%p").time()) + assert parse_pulse_datetime(datestring) == expected_result + + # Returns a datetime object for a valid datestring + def test_returns_datetime_object_for_valid_datestring(self): + datestring = "Today\xa012:34PM\xa0" + assert isinstance(parse_pulse_datetime(datestring), datetime) + + # Raises a ValueError for an invalid datestring with less than 3 elements + def test_raises_value_error_for_invalid_datestring_with_less_than_3_elements(self): + datestring = "Today" + with pytest.raises(ValueError): + parse_pulse_datetime(datestring) + + # Raises a ValueError for an invalid datestring with an invalid date string as the first element of the split string + def test_raises_value_error_for_invalid_datestring_with_invalid_date_string(self): + datestring = "InvalidDate\xa012:34PM" + with pytest.raises(ValueError): + parse_pulse_datetime(datestring) + + # Raises a ValueError for an invalid datestring with an invalid time string as the second element of the split string + def test_raises_value_error_for_invalid_datestring_with_invalid_time_string(self): + datestring = "Today\xa0InvalidTime" + with pytest.raises(ValueError): + parse_pulse_datetime(datestring) + + # Raises a ValueError for an invalid datestring with an invalid time period string as the third element of the split string + def test_raises_value_error_for_invalid_datestring_with_invalid_time_period_string(self): + datestring = "Today\xa012:34InvalidPeriod" + with pytest.raises(ValueError): + parse_pulse_datetime(datestring) + + # Returns a datetime object for a valid datestring with a year greater than the current year + def test_returns_datetime_object_for_valid_datestring_with_year_greater_than_current_year(self): + datestring = "01/01/2023\xa0\xa012:34PM" + expected_result = datetime.combine(datetime.strptime("01/01/2023", "%m/%d/%Y"), datetime.strptime("12:34PM", "%I:%M%p").time()) + assert parse_pulse_datetime(datestring) == expected_result + + # Returns a datetime object with the current year for a valid datestring with a year less than the current year + def test_returns_datetime_object_with_current_year_for_valid_datestring_with_year_less_than_current_year(self): + datestring = "01/01\xa0\xa012:34PM" + expected_result = datetime.combine(datetime.strptime("01/01", "%m/%d").replace(year=datetime.now().year), datetime.strptime("12:34PM", "%I:%M%p").time()) + assert parse_pulse_datetime(datestring) == expected_result + + # Parses a valid datestring with "Today" as the first element of the split string + def test_parses_valid_datestring_with_today(self): + datestring = "Today\xa0\xa012:34PM" + expected_result = datetime.combine(datetime.today(), datetime.strptime("12:34PM", "%I:%M%p").time()) + assert parse_pulse_datetime(datestring) == expected_result + + # Parses a valid datestring with "Yesterday" as the first element of the split string + def test_parses_valid_datestring_with_yesterday(self): + datestring = "Yesterday\xa012:34PM\xa0" + expected_result = datetime.combine(datetime.today() - timedelta(days=1), datetime.strptime("12:34PM", "%I:%M%p").time()) + assert parse_pulse_datetime(datestring) == expected_result + + # Parses a valid datestring with a time string in 24-hour format + def test_parses_valid_datestring_with_24_hour_format(self): + datestring = "01/01/2022\xa012:34\xa0AM" + expected_result = datetime.combine(datetime.strptime("01/01/2022", "%m/%d/%Y"), datetime.strptime("12:34", "%I:%M").time()) + assert parse_pulse_datetime(datestring) == expected_result From 97182c3f136f50a2be7e6090b1717430130af88e Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Tue, 17 Oct 2023 13:34:09 -0400 Subject: [PATCH 021/226] parse_pulse_datetime fixes --- pyadtpulse/tests/test_gateway.py | 8 +++++--- pyadtpulse/tests/test_util.py | 10 ++++++---- pyadtpulse/util.py | 9 ++++++++- 3 files changed, 19 insertions(+), 8 deletions(-) diff --git a/pyadtpulse/tests/test_gateway.py b/pyadtpulse/tests/test_gateway.py index bd7177e..d56d3a5 100644 --- a/pyadtpulse/tests/test_gateway.py +++ b/pyadtpulse/tests/test_gateway.py @@ -69,8 +69,8 @@ def test_set_gateway_attributes(self): "_status_text": "ONLINE", "model": "1234", "serial_number": "5678", - "next_update": "Today 9:03 AM", - "last_update": "Yesterday 11:55 PM", + "next_update": "Today\xa09:03\xa0AM", + "last_update": "Yesterday\xa011:55\xa0PM", "firmware_version": "1.0", "hardware_version": "2.0", "primary_connection_type": "Ethernet", @@ -94,7 +94,7 @@ def test_set_gateway_attributes(self): datetime.combine(now.date(), time(9, 3)).timestamp() ) assert gateway.last_update == int( - datetime.combine(yesterday.date(), time(11, 55)).timestamp() + datetime.combine(yesterday.date(), time(23, 55)).timestamp() ) assert gateway.firmware_version == "1.0" assert gateway.hardware_version == "2.0" @@ -230,6 +230,8 @@ def test_set_gateway_attributes_sets_none_for_empty_strings(self): assert gateway.device_lan_mac is None assert gateway.router_lan_ip_address is None assert gateway.router_wan_ip_address is None + assert gateway._current_poll_interval == ADT_DEFAULT_POLL_INTERVAL + assert gateway._initial_poll_interval == ADT_DEFAULT_POLL_INTERVAL # Check that set_gateway_attributes method sets None for None values and throws an # exception for mandatory parameters set to None diff --git a/pyadtpulse/tests/test_util.py b/pyadtpulse/tests/test_util.py index 32c3900..59f3f07 100644 --- a/pyadtpulse/tests/test_util.py +++ b/pyadtpulse/tests/test_util.py @@ -347,8 +347,9 @@ def test_raises_value_error_for_invalid_datestring_with_invalid_time_period_stri # Returns a datetime object for a valid datestring with a year greater than the current year def test_returns_datetime_object_for_valid_datestring_with_year_greater_than_current_year(self): datestring = "01/01/2023\xa0\xa012:34PM" - expected_result = datetime.combine(datetime.strptime("01/01/2023", "%m/%d/%Y"), datetime.strptime("12:34PM", "%I:%M%p").time()) - assert parse_pulse_datetime(datestring) == expected_result + with pytest.raises(ValueError): + parse_pulse_datetime(datestring) + # Returns a datetime object with the current year for a valid datestring with a year less than the current year def test_returns_datetime_object_with_current_year_for_valid_datestring_with_year_less_than_current_year(self): @@ -371,5 +372,6 @@ def test_parses_valid_datestring_with_yesterday(self): # Parses a valid datestring with a time string in 24-hour format def test_parses_valid_datestring_with_24_hour_format(self): datestring = "01/01/2022\xa012:34\xa0AM" - expected_result = datetime.combine(datetime.strptime("01/01/2022", "%m/%d/%Y"), datetime.strptime("12:34", "%I:%M").time()) - assert parse_pulse_datetime(datestring) == expected_result + with pytest.raises(ValueError): + parse_pulse_datetime(datestring) + diff --git a/pyadtpulse/util.py b/pyadtpulse/util.py index 15fa564..d50ec82 100644 --- a/pyadtpulse/util.py +++ b/pyadtpulse/util.py @@ -1,5 +1,6 @@ """Utility functions for pyadtpulse.""" import logging +import re import string import sys from base64 import urlsafe_b64encode @@ -227,7 +228,13 @@ def parse_pulse_datetime(datestring: str) -> datetime: Returns: datetime: time value of given string """ - split_string = datestring.split("\xa0") + datestring = datestring.replace("\xa0", " ").rstrip() + split_string = [s for s in datestring.split(" ") if s.strip()] + if len(split_string) >= 2: + last_word = split_string[-1] + if last_word[-2:] in ["AM", "PM"]: + split_string[-1] = last_word[:-2] + split_string.append(last_word[-2:]) if len(split_string) < 3: raise ValueError("Invalid datestring") t = datetime.today() From 5e91ec790ad194224a1560bfc6fc1f4595424d7a Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Tue, 17 Oct 2023 14:08:35 -0400 Subject: [PATCH 022/226] attempt to fix handle_response tests --- pyadtpulse/tests/test_util.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/pyadtpulse/tests/test_util.py b/pyadtpulse/tests/test_util.py index 59f3f07..d196308 100644 --- a/pyadtpulse/tests/test_util.py +++ b/pyadtpulse/tests/test_util.py @@ -9,8 +9,8 @@ make_soup, parse_pulse_datetime, ) - - +LOG = logging.getLogger(__name__) +LOG.setLevel(logging.DEBUG) class TestHandleResponse: # Returns True if response is not None and response.ok is True def test_returns_true_if_response_is_not_none_and_response_ok_is_true(self, mocker): @@ -38,9 +38,9 @@ def test_returns_false_if_response_is_none(self, mocker): # Logs an error message if response is None def test_logs_error_message_if_response_is_none(self, mocker): - mocker.patch("logging.log") - handle_response(None, 0, "error") - logging.log.assert_called_once_with(0, "error") + mocker.patch("pyadtpulse.logging") + handle_response(None, logging.DEBUG, "error") + mocker.assert_called_once_with(logging.DEBUG, "error") # Returns False if response.ok is False def test_returns_false_if_response_ok_is_false(self, mocker): @@ -53,7 +53,7 @@ def test_logs_error_message_if_response_ok_is_false(self, mocker): response = mocker.Mock() response.ok = False response.status = 404 - mocker.patch("logging.log") + mocker.patch("logging.log.log") handle_response(response, 0, "error") logging.log.assert_called_once_with(0, "error: error code = 404") @@ -80,7 +80,7 @@ def test_logs_error_message_and_response_status_if_response_is_not_none_but_resp response.ok = False response.status = 404 logger_mock = mocker.patch("logging.log") - handle_response(response, 0, "error") + handle_response(response, logging.DEBUG, "error") logger_mock.log.assert_called_once_with(0, "error: error code = 404") # Logs the error message and response status with the specified logging level From facd6cdec47c586568e47276b6bb76c29e442880 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Sat, 21 Oct 2023 12:26:58 -0400 Subject: [PATCH 023/226] add detailed debug logging --- example-client.py | 23 +++++++++++++++++++++-- pyadtpulse/__init__.py | 22 ++++++++++++++++++++-- 2 files changed, 41 insertions(+), 4 deletions(-) diff --git a/example-client.py b/example-client.py index cb87985..50b2ba1 100755 --- a/example-client.py +++ b/example-client.py @@ -33,14 +33,22 @@ RELOGIN_INTERVAL = "relogin_interval" SERVICE_HOST = "service_host" POLL_INTERVAL = "poll_interval" - -BOOLEAN_PARAMS = {USE_ASYNC, DEBUG_LOCKS, PULSE_DEBUG, TEST_ALARM} +DETAILED_DEBUG_LOGGING = "detailed_debug_logging" + +BOOLEAN_PARAMS = { + USE_ASYNC, + DEBUG_LOCKS, + PULSE_DEBUG, + TEST_ALARM, + DETAILED_DEBUG_LOGGING, +} INT_PARAMS = {SLEEP_INTERVAL, KEEPALIVE_INTERVAL, RELOGIN_INTERVAL} FLOAT_PARAMS = {POLL_INTERVAL} # Default values DEFAULT_USE_ASYNC = True DEFAULT_DEBUG = False +DEFAULT_DETAILED_DEBUG_LOGGING = False DEFAULT_TEST_ALARM = False DEFAULT_SLEEP_INTERVAL = 5 DEFAULT_DEBUG_LOCKS = False @@ -96,6 +104,12 @@ def handle_args() -> argparse.Namespace: default=None, help="Set True to enable debugging", ) + parser.add_argument( + f"--{DETAILED_DEBUG_LOGGING}", + type=bool, + default=None, + help="Set True to enable detailed debug logging", + ) parser.add_argument( f"--{TEST_ALARM}", type=bool, @@ -162,6 +176,11 @@ def handle_args() -> argparse.Namespace: args.debug_locks if args.debug_locks is not None else DEFAULT_DEBUG_LOCKS ) args.debug = args.debug if args.debug is not None else DEFAULT_DEBUG + args.detailed_debug_logging = ( + args.detailed_debug_logging + if args.detailed_debug_logging is not None + else DEFAULT_DETAILED_DEBUG_LOGGING + ) args.test_alarm = ( args.test_alarm if args.test_alarm is not None else DEFAULT_TEST_ALARM ) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index b3e240c..6850c84 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -67,6 +67,7 @@ class PyADTPulse: "_relogin_interval", "_keepalive_interval", "_update_succeded", + "_detailed_debug_logging", ) @staticmethod @@ -106,6 +107,7 @@ def __init__( debug_locks: bool = False, keepalive_interval: Optional[int] = ADT_DEFAULT_KEEPALIVE_INTERVAL, relogin_interval: Optional[int] = ADT_DEFAULT_RELOGIN_INTERVAL, + detailed_debug_logging: bool = False, ): """Create a PyADTPulse object. @@ -134,6 +136,7 @@ def __init__( relogin_interval (int, optional): number of minutes between relogin checks defaults to ADT_DEFAULT_RELOGIN_INTERVAL, minimum is ADT_MIN_RELOGIN_INTERVAL + detailed_debug_logging (bool, optional): enable detailed debug logging """ self._check_service_host(service_host) self._init_login_info(username, password, fingerprint) @@ -165,6 +168,7 @@ def __init__( self._site: Optional[ADTPulseSite] = None self.keepalive_interval = keepalive_interval self.relogin_interval = relogin_interval + self._detailed_debug_logging = detailed_debug_logging self._update_succeded = True # authenticate the user @@ -293,6 +297,18 @@ def keepalive_interval(self, interval: int | None) -> None: self._keepalive_interval = interval LOG.debug("keepalive interval set to %d", self._keepalive_interval) + @property + def detailed_debug_logging(self) -> bool: + """Get the detailed debug logging flag.""" + with self._attribute_lock: + return self._detailed_debug_logging + + @detailed_debug_logging.setter + def detailed_debug_logging(self, value: bool) -> None: + """Set detailed debug logging flag.""" + with self._attribute_lock: + self._detailed_debug_logging = value + async def _update_sites(self, soup: BeautifulSoup) -> None: with self._attribute_lock: if self._site is None: @@ -398,7 +414,8 @@ def _get_task_name(self, task, default_name) -> str: default_name (str): The default name to use if the task is None. Returns: - str: The name of the task if it is not None, otherwise the default name with a suffix indicating a possible internal error. + str: The name of the task if it is not None, otherwise the default name + with a suffix indicating a possible internal error. """ if task is not None: return task.get_name() @@ -684,7 +701,8 @@ async def _handle_no_updates_exist( self._validate_updates_exist(task_name) self._updates_exist.set() else: - LOG.debug("Sync token %s indicates no remote updates to process", text) + if self.detailed_debug_logging: + LOG.debug("Sync token %s indicates no remote updates to process", text) def _pulse_session_thread(self) -> None: """ From 19fcb69798de1b709933880b32e112b57c4b257f Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Sat, 21 Oct 2023 12:57:20 -0400 Subject: [PATCH 024/226] max_retries -> MAX_RETRIES --- pyadtpulse/pulse_connection.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index b4cb748..3942856 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -177,9 +177,9 @@ async def async_query( response.status, retry, ) - if retry == max_retries: + if retry == MAX_RETRIES: LOG.warning( - "Exceeded max retries of %d, giving up", max_retries + "Exceeded max retries of %d, giving up", MAX_RETRIES ) response.raise_for_status() await asyncio.sleep(2**retry + uniform(0.0, 1.0)) From 6296137647a81b8ac4d6f8c819e1068817ef2128 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Sat, 21 Oct 2023 13:08:59 -0400 Subject: [PATCH 025/226] log url instead of uri in async_query() --- pyadtpulse/pulse_connection.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 3942856..14b15dc 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -152,7 +152,7 @@ async def async_query( self._session.headers.update(headers) LOG.debug( - "Attempting %s %s params=%s timeout=%d", method, uri, extra_params, timeout + "Attempting %s %s params=%s timeout=%d", method, url, extra_params, timeout ) retry = 0 From f48c9c15022465eff37c118736a0798b8ec35701 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Sat, 21 Oct 2023 13:18:18 -0400 Subject: [PATCH 026/226] update black.yml to use checkoutv4 --- .github/workflows/black.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/black.yml b/.github/workflows/black.yml index 9065b5e..81e6a94 100644 --- a/.github/workflows/black.yml +++ b/.github/workflows/black.yml @@ -6,5 +6,5 @@ jobs: lint: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: psf/black@stable From e58da5dd60d1368dd78380fac30858d4e9ad7a99 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Sat, 21 Oct 2023 13:30:45 -0400 Subject: [PATCH 027/226] add setup-python to black.yml --- .github/workflows/black.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/black.yml b/.github/workflows/black.yml index 81e6a94..4a3a46b 100644 --- a/.github/workflows/black.yml +++ b/.github/workflows/black.yml @@ -6,5 +6,6 @@ jobs: lint: runs-on: ubuntu-latest steps: + - uses: actions/setup-python@v4 - uses: actions/checkout@v4 - uses: psf/black@stable From 782093d04a736fd790b16a4e7595c8fc6d399edd Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Sat, 21 Oct 2023 15:00:37 -0400 Subject: [PATCH 028/226] add pre-commit github workflow --- .github/workflows/name: pre-commit.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 .github/workflows/name: pre-commit.yml diff --git a/.github/workflows/name: pre-commit.yml b/.github/workflows/name: pre-commit.yml new file mode 100644 index 0000000..9ef1a9c --- /dev/null +++ b/.github/workflows/name: pre-commit.yml @@ -0,0 +1,12 @@ +name: pre-commit + +on: + [push, pull_request] + +jobs: + pre-commit: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v3 + - uses: pre-commit/action@v3.0.0 \ No newline at end of file From 0c44fa99b61218718ac956b8de455ff1ab12b314 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Sat, 21 Oct 2023 15:06:13 -0400 Subject: [PATCH 029/226] update pre-commit wf action to use checkout/python setup v4 --- .github/workflows/name: pre-commit.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/name: pre-commit.yml b/.github/workflows/name: pre-commit.yml index 9ef1a9c..6662f23 100644 --- a/.github/workflows/name: pre-commit.yml +++ b/.github/workflows/name: pre-commit.yml @@ -7,6 +7,8 @@ jobs: pre-commit: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 - - uses: actions/setup-python@v3 + - uses: actions/checkout@v4 + - uses: actions/setup-python@v4 + with: + python-version: "3.11" - uses: pre-commit/action@v3.0.0 \ No newline at end of file From e673bee770054b1fc2df21002bc34f51c0cc12b2 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Sat, 21 Oct 2023 15:08:20 -0400 Subject: [PATCH 030/226] pre-commit fixes --- .github/workflows/name: pre-commit.yml | 2 +- pyadtpulse/__init__.py | 2 +- pyadtpulse/tests/test_util.py | 60 +++++++++++++++++++------- pyadtpulse/util.py | 3 +- 4 files changed, 47 insertions(+), 20 deletions(-) diff --git a/.github/workflows/name: pre-commit.yml b/.github/workflows/name: pre-commit.yml index 6662f23..8a4a9bb 100644 --- a/.github/workflows/name: pre-commit.yml +++ b/.github/workflows/name: pre-commit.yml @@ -11,4 +11,4 @@ jobs: - uses: actions/setup-python@v4 with: python-version: "3.11" - - uses: pre-commit/action@v3.0.0 \ No newline at end of file + - uses: pre-commit/action@v3.0.0 diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 6850c84..9a6057c 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -414,7 +414,7 @@ def _get_task_name(self, task, default_name) -> str: default_name (str): The default name to use if the task is None. Returns: - str: The name of the task if it is not None, otherwise the default name + str: The name of the task if it is not None, otherwise the default name with a suffix indicating a possible internal error. """ if task is not None: diff --git a/pyadtpulse/tests/test_util.py b/pyadtpulse/tests/test_util.py index d196308..8f89212 100644 --- a/pyadtpulse/tests/test_util.py +++ b/pyadtpulse/tests/test_util.py @@ -1,16 +1,21 @@ # Generated by import logging from datetime import datetime, timedelta + from bs4 import BeautifulSoup + from pyadtpulse.util import ( - handle_response, close_response, - remove_prefix, + handle_response, make_soup, parse_pulse_datetime, + remove_prefix, ) + LOG = logging.getLogger(__name__) LOG.setLevel(logging.DEBUG) + + class TestHandleResponse: # Returns True if response is not None and response.ok is True def test_returns_true_if_response_is_not_none_and_response_ok_is_true(self, mocker): @@ -284,35 +289,46 @@ async def test_malformed_html_body(self, mocker): class TestParsePulseDatetime: - # Parses a valid datestring with "Today" as the first element of the split string and an extra string after the time def test_parses_valid_datestring_with_today_with_extra_string(self): datestring = "Today\xa012:34PM" - expected_result = datetime.combine(datetime.today(), datetime.strptime("12:34PM", "%I:%M%p").time()) + expected_result = datetime.combine( + datetime.today(), datetime.strptime("12:34PM", "%I:%M%p").time() + ) assert parse_pulse_datetime(datestring) == expected_result # Parses a valid datestring with "Yesterday" as the first element of the split string, with a valid time string as the second element of the split string def test_parses_valid_datestring_with_yesterday_fixed_fixed(self): datestring = "Yesterday\xa0\xa012:34PM" - expected_result = datetime.combine(datetime.today() - timedelta(days=1), datetime.strptime("12:34PM", "%I:%M%p").time()) + expected_result = datetime.combine( + datetime.today() - timedelta(days=1), + datetime.strptime("12:34PM", "%I:%M%p").time(), + ) assert parse_pulse_datetime(datestring) == expected_result # Parses a valid datestring with a date string as the first element of the split string def test_parses_valid_datestring_with_date_string(self): datestring = "01/01\xa0\xa012:34PM" - expected_result = datetime.combine(datetime(datetime.now().year, 1, 1), datetime.strptime("12:34PM", "%I:%M%p").time()) + expected_result = datetime.combine( + datetime(datetime.now().year, 1, 1), + datetime.strptime("12:34PM", "%I:%M%p").time(), + ) assert parse_pulse_datetime(datestring) == expected_result # Parses a valid datestring with a time string as the second element of the split string def test_parses_valid_datestring_with_time_string(self): datestring = "Today\xa012:34PM\xa0" - expected_result = datetime.combine(datetime.today(), datetime.strptime("12:34PM", "%I:%M%p").time()) + expected_result = datetime.combine( + datetime.today(), datetime.strptime("12:34PM", "%I:%M%p").time() + ) assert parse_pulse_datetime(datestring) == expected_result # Parses a valid datestring with a time period string as the third element of the split string def test_parses_valid_datestring_with_time_period_string(self): datestring = "Today\xa0\xa012:34PM" - expected_result = datetime.combine(datetime.today(), datetime.strptime("12:34PM", "%I:%M%p").time()) + expected_result = datetime.combine( + datetime.today(), datetime.strptime("12:34PM", "%I:%M%p").time() + ) assert parse_pulse_datetime(datestring) == expected_result # Returns a datetime object for a valid datestring @@ -339,34 +355,47 @@ def test_raises_value_error_for_invalid_datestring_with_invalid_time_string(self parse_pulse_datetime(datestring) # Raises a ValueError for an invalid datestring with an invalid time period string as the third element of the split string - def test_raises_value_error_for_invalid_datestring_with_invalid_time_period_string(self): + def test_raises_value_error_for_invalid_datestring_with_invalid_time_period_string( + self, + ): datestring = "Today\xa012:34InvalidPeriod" with pytest.raises(ValueError): parse_pulse_datetime(datestring) # Returns a datetime object for a valid datestring with a year greater than the current year - def test_returns_datetime_object_for_valid_datestring_with_year_greater_than_current_year(self): + def test_returns_datetime_object_for_valid_datestring_with_year_greater_than_current_year( + self, + ): datestring = "01/01/2023\xa0\xa012:34PM" with pytest.raises(ValueError): parse_pulse_datetime(datestring) - # Returns a datetime object with the current year for a valid datestring with a year less than the current year - def test_returns_datetime_object_with_current_year_for_valid_datestring_with_year_less_than_current_year(self): + def test_returns_datetime_object_with_current_year_for_valid_datestring_with_year_less_than_current_year( + self, + ): datestring = "01/01\xa0\xa012:34PM" - expected_result = datetime.combine(datetime.strptime("01/01", "%m/%d").replace(year=datetime.now().year), datetime.strptime("12:34PM", "%I:%M%p").time()) + expected_result = datetime.combine( + datetime.strptime("01/01", "%m/%d").replace(year=datetime.now().year), + datetime.strptime("12:34PM", "%I:%M%p").time(), + ) assert parse_pulse_datetime(datestring) == expected_result # Parses a valid datestring with "Today" as the first element of the split string def test_parses_valid_datestring_with_today(self): datestring = "Today\xa0\xa012:34PM" - expected_result = datetime.combine(datetime.today(), datetime.strptime("12:34PM", "%I:%M%p").time()) + expected_result = datetime.combine( + datetime.today(), datetime.strptime("12:34PM", "%I:%M%p").time() + ) assert parse_pulse_datetime(datestring) == expected_result # Parses a valid datestring with "Yesterday" as the first element of the split string def test_parses_valid_datestring_with_yesterday(self): datestring = "Yesterday\xa012:34PM\xa0" - expected_result = datetime.combine(datetime.today() - timedelta(days=1), datetime.strptime("12:34PM", "%I:%M%p").time()) + expected_result = datetime.combine( + datetime.today() - timedelta(days=1), + datetime.strptime("12:34PM", "%I:%M%p").time(), + ) assert parse_pulse_datetime(datestring) == expected_result # Parses a valid datestring with a time string in 24-hour format @@ -374,4 +403,3 @@ def test_parses_valid_datestring_with_24_hour_format(self): datestring = "01/01/2022\xa012:34\xa0AM" with pytest.raises(ValueError): parse_pulse_datetime(datestring) - diff --git a/pyadtpulse/util.py b/pyadtpulse/util.py index d50ec82..b3da2e7 100644 --- a/pyadtpulse/util.py +++ b/pyadtpulse/util.py @@ -1,6 +1,5 @@ """Utility functions for pyadtpulse.""" import logging -import re import string import sys from base64 import urlsafe_b64encode @@ -232,7 +231,7 @@ def parse_pulse_datetime(datestring: str) -> datetime: split_string = [s for s in datestring.split(" ") if s.strip()] if len(split_string) >= 2: last_word = split_string[-1] - if last_word[-2:] in ["AM", "PM"]: + if last_word[-2:] in ("AM", "PM"): split_string[-1] = last_word[:-2] split_string.append(last_word[-2:]) if len(split_string) < 3: From 08d11dd90fbcd6d6ef022617546ed7e8c2b14ad5 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Sat, 21 Oct 2023 15:20:25 -0400 Subject: [PATCH 031/226] pyupgrade --py-311plus changes --- pyadtpulse/__init__.py | 32 ++++++++++++++++---------------- pyadtpulse/gateway.py | 30 +++++++++++++++--------------- pyadtpulse/pulse_connection.py | 33 +++++++++++++++------------------ pyadtpulse/site.py | 23 +++++++++++------------ pyadtpulse/util.py | 9 ++++----- pyadtpulse/zones.py | 10 +++++----- 6 files changed, 66 insertions(+), 71 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 9a6057c..52acc44 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -102,11 +102,11 @@ def __init__( fingerprint: str, service_host: str = DEFAULT_API_HOST, user_agent=ADT_DEFAULT_HTTP_HEADERS["User-Agent"], - websession: Optional[ClientSession] = None, + websession: ClientSession | None = None, do_login: bool = True, debug_locks: bool = False, - keepalive_interval: Optional[int] = ADT_DEFAULT_KEEPALIVE_INTERVAL, - relogin_interval: Optional[int] = ADT_DEFAULT_RELOGIN_INTERVAL, + keepalive_interval: int | None = ADT_DEFAULT_KEEPALIVE_INTERVAL, + relogin_interval: int | None = ADT_DEFAULT_RELOGIN_INTERVAL, detailed_debug_logging: bool = False, ): """Create a PyADTPulse object. @@ -147,25 +147,25 @@ def __init__( debug_locks=debug_locks, ) - self._sync_task: Optional[asyncio.Task] = None - self._timeout_task: Optional[asyncio.Task] = None + self._sync_task: asyncio.Task | None = None + self._timeout_task: asyncio.Task | None = None # FIXME use thread event/condition, regular condition? # defer initialization to make sure we have an event loop - self._authenticated: Optional[asyncio.locks.Event] = None - self._login_exception: Optional[BaseException] = None + self._authenticated: asyncio.locks.Event | None = None + self._login_exception: BaseException | None = None - self._updates_exist: Optional[asyncio.locks.Event] = None + self._updates_exist: asyncio.locks.Event | None = None - self._session_thread: Optional[Thread] = None - self._attribute_lock: Union[RLock, DebugRLock] + self._session_thread: Thread | None = None + self._attribute_lock: RLock | DebugRLock if not debug_locks: self._attribute_lock = RLock() else: self._attribute_lock = DebugRLock("PyADTPulse._attribute_lock") self._last_login_time: int = 0 - self._site: Optional[ADTPulseSite] = None + self._site: ADTPulseSite | None = None self.keepalive_interval = keepalive_interval self.relogin_interval = relogin_interval self._detailed_debug_logging = detailed_debug_logging @@ -367,7 +367,7 @@ async def _initialize_sites(self, soup: BeautifulSoup) -> None: # ... or perhaps better, just extract all from /system/settings.jsp def _check_retry_after( - self, response: Optional[ClientResponse], task_name: str + self, response: ClientResponse | None, task_name: str ) -> int: """ Check the "Retry-After" header in the response and return the number of seconds @@ -550,7 +550,7 @@ def _calculate_sleep_time(self, retry_after: int) -> int: async def _reset_pulse_cloud_timeout(self) -> ClientResponse | None: return await self._pulse_connection.async_query(ADT_TIMEOUT_URI, "POST") - def _handle_timeout_response(self, response: ClientResponse) -> Tuple[bool, int]: + def _handle_timeout_response(self, response: ClientResponse) -> tuple[bool, int]: """ Handle the timeout response from the client. @@ -791,7 +791,7 @@ def login(self) -> None: raise AuthenticationException(self._username) @property - def attribute_lock(self) -> Union[RLock, DebugRLock]: + def attribute_lock(self) -> RLock | DebugRLock: """Get attribute lock for PyADTPulse object. Returns: @@ -800,7 +800,7 @@ def attribute_lock(self) -> Union[RLock, DebugRLock]: return self._attribute_lock @property - def loop(self) -> Optional[asyncio.AbstractEventLoop]: + def loop(self) -> asyncio.AbstractEventLoop | None: """Get event loop. Returns: @@ -1078,7 +1078,7 @@ def update(self) -> bool: ).result() @property - def sites(self) -> List[ADTPulseSite]: + def sites(self) -> list[ADTPulseSite]: """Return all sites for this ADT Pulse account.""" warn( "multiple sites being removed, use pyADTPulse.site instead", diff --git a/pyadtpulse/gateway.py b/pyadtpulse/gateway.py index dee0393..af28805 100644 --- a/pyadtpulse/gateway.py +++ b/pyadtpulse/gateway.py @@ -4,7 +4,7 @@ from dataclasses import dataclass from ipaddress import IPv4Address, IPv6Address, ip_address from threading import RLock -from typing import Any, Optional +from typing import Any from .const import ADT_DEFAULT_POLL_INTERVAL, ADT_GATEWAY_OFFLINE_POLL_INTERVAL from .util import parse_pulse_datetime @@ -44,22 +44,22 @@ class ADTPulseGateway: _current_poll_interval: float = ADT_DEFAULT_POLL_INTERVAL _initial_poll_interval: float = ADT_DEFAULT_POLL_INTERVAL _attribute_lock = RLock() - model: Optional[str] = None - serial_number: Optional[str] = None + model: str | None = None + serial_number: str | None = None next_update: int = 0 last_update: int = 0 - firmware_version: Optional[str] = None - hardware_version: Optional[str] = None - primary_connection_type: Optional[str] = None - broadband_connection_status: Optional[str] = None - cellular_connection_status: Optional[str] = None + firmware_version: str | None = None + hardware_version: str | None = None + primary_connection_type: str | None = None + broadband_connection_status: str | None = None + cellular_connection_status: str | None = None cellular_connection_signal_strength: float = 0.0 - broadband_lan_ip_address: Optional[IPv4Address | IPv6Address] = None - broadband_lan_mac: Optional[str] = None - device_lan_ip_address: Optional[IPv4Address | IPv6Address] = None - device_lan_mac: Optional[str] = None - router_lan_ip_address: Optional[IPv4Address | IPv6Address] = None - router_wan_ip_address: Optional[IPv4Address | IPv6Address] = None + broadband_lan_ip_address: IPv4Address | IPv6Address | None = None + broadband_lan_mac: str | None = None + device_lan_ip_address: IPv4Address | IPv6Address | None = None + device_lan_mac: str | None = None + router_lan_ip_address: IPv4Address | IPv6Address | None = None + router_wan_ip_address: IPv4Address | IPv6Address | None = None @property def is_online(self) -> bool: @@ -108,7 +108,7 @@ def poll_interval(self) -> float: return self._current_poll_interval @poll_interval.setter - def poll_interval(self, new_interval: Optional[float]) -> None: + def poll_interval(self, new_interval: float | None) -> None: """Set polling interval. Args: diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 14b15dc..f2c4e6e 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -5,7 +5,6 @@ import re from random import uniform from threading import Lock, RLock -from typing import Dict, Optional, Union from aiohttp import ( ClientConnectionError, @@ -49,7 +48,7 @@ class ADTPulseConnection: def __init__( self, host: str, - session: Optional[ClientSession] = None, + session: ClientSession | None = None, user_agent: str = ADT_DEFAULT_HTTP_HEADERS["User-Agent"], debug_locks: bool = False, ): @@ -62,12 +61,12 @@ def __init__( else: self._session = session self._session.headers.update({"User-Agent": user_agent}) - self._attribute_lock: Union[RLock, DebugRLock] + self._attribute_lock: RLock | DebugRLock if not debug_locks: self._attribute_lock = RLock() else: self._attribute_lock = DebugRLock("ADTPulseConnection._attribute_lock") - self._loop: Optional[asyncio.AbstractEventLoop] = None + self._loop: asyncio.AbstractEventLoop | None = None def __del__(self): """Destructor for ADTPulseConnection.""" @@ -94,13 +93,13 @@ def service_host(self, host: str) -> None: self._api_host = host @property - def loop(self) -> Optional[asyncio.AbstractEventLoop]: + def loop(self) -> asyncio.AbstractEventLoop | None: """Get the event loop.""" with self._attribute_lock: return self._loop @loop.setter - def loop(self, loop: Optional[asyncio.AbstractEventLoop]) -> None: + def loop(self, loop: asyncio.AbstractEventLoop | None) -> None: """Set the event loop.""" with self._attribute_lock: self._loop = loop @@ -119,10 +118,10 @@ async def async_query( self, uri: str, method: str = "GET", - extra_params: Optional[Dict[str, str]] = None, - extra_headers: Optional[Dict[str, str]] = None, + extra_params: dict[str, str] | None = None, + extra_headers: dict[str, str] | None = None, timeout: int = 1, - ) -> Optional[ClientResponse]: + ) -> ClientResponse | None: """ Query ADT Pulse async. @@ -156,7 +155,7 @@ async def async_query( ) retry = 0 - response: Optional[ClientResponse] = None + response: ClientResponse | None = None while retry < MAX_RETRIES: try: async with self._session.request( @@ -188,7 +187,7 @@ async def async_query( response.raise_for_status() retry = 4 # success, break loop except ( - asyncio.TimeoutError, + TimeoutError, ClientConnectionError, ClientConnectorError, ClientResponseError, @@ -207,10 +206,10 @@ def query( self, uri: str, method: str = "GET", - extra_params: Optional[Dict[str, str]] = None, - extra_headers: Optional[Dict[str, str]] = None, + extra_params: dict[str, str] | None = None, + extra_headers: dict[str, str] | None = None, timeout=1, - ) -> Optional[ClientResponse]: + ) -> ClientResponse | None: """Query ADT Pulse async. Args: @@ -230,9 +229,7 @@ def query( coro, self.check_sync("Attempting to run sync query from async login") ).result() - async def query_orb( - self, level: int, error_message: str - ) -> Optional[BeautifulSoup]: + async def query_orb(self, level: int, error_message: str) -> BeautifulSoup | None: """Query ADT Pulse ORB. Args: @@ -260,7 +257,7 @@ def make_url(self, uri: str) -> str: async def async_fetch_version(self) -> None: """Fetch ADT Pulse version.""" - response: Optional[ClientResponse] = None + response: ClientResponse | None = None with ADTPulseConnection._class_threadlock: if ADTPulseConnection._api_version != ADT_DEFAULT_VERSION: return diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 9a55110..805639c 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -5,7 +5,6 @@ from datetime import datetime from threading import RLock from time import time -from typing import List, Optional, Union from warnings import warn # import dateparser @@ -51,7 +50,7 @@ def __init__(self, pulse_connection: ADTPulseConnection, site_id: str, name: str self._name = name self._last_updated: int = 0 self._zones = ADTPulseZones() - self._site_lock: Union[RLock, DebugRLock] + self._site_lock: RLock | DebugRLock if isinstance(self._pulse_connection._attribute_lock, DebugRLock): self._site_lock = DebugRLock("ADTPulseSite._site_lock") else: @@ -91,7 +90,7 @@ def last_updated(self) -> int: return self._last_updated @property - def site_lock(self) -> Union[RLock, DebugRLock]: + def site_lock(self) -> RLock | DebugRLock: """Get thread lock for site data. Not needed for async @@ -146,7 +145,7 @@ async def async_disarm(self) -> bool: return await self.alarm_control_panel.async_disarm(self._pulse_connection) @property - def zones(self) -> Optional[List[ADTPulseFlattendZone]]: + def zones(self) -> list[ADTPulseFlattendZone] | None: """Return all zones registered with the ADT Pulse account. (cached copy of last fetch) @@ -158,7 +157,7 @@ def zones(self) -> Optional[List[ADTPulseFlattendZone]]: return self._zones.flatten() @property - def zones_as_dict(self) -> Optional[ADTPulseZones]: + def zones_as_dict(self) -> ADTPulseZones | None: """Return zone information in dictionary form. Returns: @@ -203,7 +202,7 @@ def history(self): # if we should also update the zone details, force a fresh fetch # of data from ADT Pulse - async def _get_device_attributes(self, device_id: str) -> Optional[dict[str, str]]: + async def _get_device_attributes(self, device_id: str) -> dict[str, str] | None: """ Retrieves the attributes of a device. @@ -271,7 +270,7 @@ async def _set_device(self, device_id: str) -> None: else: LOG.debug("Zone %s is not an integer, skipping", device_id) - async def _fetch_devices(self, soup: Optional[BeautifulSoup]) -> bool: + async def _fetch_devices(self, soup: BeautifulSoup | None) -> bool: """ Fetches the devices from the given BeautifulSoup object and updates the zone attributes. @@ -353,8 +352,8 @@ async def _fetch_devices(self, soup: Optional[BeautifulSoup]) -> bool: return True async def _async_update_zones_as_dict( - self, soup: Optional[BeautifulSoup] - ) -> Optional[ADTPulseZones]: + self, soup: BeautifulSoup | None + ) -> ADTPulseZones | None: """Update zone status information asynchronously. Returns: @@ -375,7 +374,7 @@ async def _async_update_zones_as_dict( return None return self._update_zone_from_soup(soup) - def _update_zone_from_soup(self, soup: BeautifulSoup) -> Optional[ADTPulseZones]: + def _update_zone_from_soup(self, soup: BeautifulSoup) -> ADTPulseZones | None: """ Updates the zone information based on the provided BeautifulSoup object. @@ -463,7 +462,7 @@ def _update_zone_from_soup(self, soup: BeautifulSoup) -> Optional[ADTPulseZones] self._last_updated = int(time()) return self._zones - async def _async_update_zones(self) -> Optional[List[ADTPulseFlattendZone]]: + async def _async_update_zones(self) -> list[ADTPulseFlattendZone] | None: """Update zones asynchronously. Returns: @@ -479,7 +478,7 @@ async def _async_update_zones(self) -> Optional[List[ADTPulseFlattendZone]]: return None return zonelist.flatten() - def update_zones(self) -> Optional[List[ADTPulseFlattendZone]]: + def update_zones(self) -> list[ADTPulseFlattendZone] | None: """Update zone status information. Returns: diff --git a/pyadtpulse/util.py b/pyadtpulse/util.py index b3da2e7..ecc09c3 100644 --- a/pyadtpulse/util.py +++ b/pyadtpulse/util.py @@ -7,7 +7,6 @@ from pathlib import Path from random import randint from threading import RLock, current_thread -from typing import Optional from aiohttp import ClientResponse from bs4 import BeautifulSoup @@ -16,7 +15,7 @@ def handle_response( - response: Optional[ClientResponse], level: int, error_message: str + response: ClientResponse | None, level: int, error_message: str ) -> bool: """Handle the response from query(). @@ -40,7 +39,7 @@ def handle_response( return False -def close_response(response: Optional[ClientResponse]) -> None: +def close_response(response: ClientResponse | None) -> None: """Close a response object, handles None. Args: @@ -64,8 +63,8 @@ def remove_prefix(text: str, prefix: str) -> str: async def make_soup( - response: Optional[ClientResponse], level: int, error_message: str -) -> Optional[BeautifulSoup]: + response: ClientResponse | None, level: int, error_message: str +) -> BeautifulSoup | None: """Make a BS object from a Response. Args: diff --git a/pyadtpulse/zones.py b/pyadtpulse/zones.py index e35539f..077027f 100644 --- a/pyadtpulse/zones.py +++ b/pyadtpulse/zones.py @@ -3,7 +3,7 @@ from collections import UserDict from dataclasses import dataclass from datetime import datetime -from typing import List, Tuple, TypedDict +from typing import TypedDict ADT_NAME_TO_DEFAULT_TAGS = { "Door": ("sensor", "doorWindow"), @@ -38,7 +38,7 @@ class ADTPulseZoneData: name: str id_: str - tags: Tuple = ADT_NAME_TO_DEFAULT_TAGS["Window"] + tags: tuple = ADT_NAME_TO_DEFAULT_TAGS["Window"] status: str = "Unknown" state: str = "Unknown" last_activity_timestamp: int = 0 @@ -60,7 +60,7 @@ class ADTPulseFlattendZone(TypedDict): zone: int name: str id_: str - tags: Tuple + tags: tuple status: str state: str last_activity_timestamp: int @@ -170,13 +170,13 @@ def update_device_info( temp.last_activity_timestamp = int(last_activity.timestamp()) self.__setitem__(key, temp) - def flatten(self) -> List[ADTPulseFlattendZone]: + def flatten(self) -> list[ADTPulseFlattendZone]: """Flattens ADTPulseZones into a list of ADTPulseFlattenedZones. Returns: List[ADTPulseFlattendZone] """ - result: List[ADTPulseFlattendZone] = [] + result: list[ADTPulseFlattendZone] = [] for k, i in self.items(): if not isinstance(i, ADTPulseZoneData): raise ValueError("Invalid Zone data in ADTPulseZones") From 0f7b39f644681e0eaf2b74bef99be38ae48a54b2 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Sat, 21 Oct 2023 15:40:19 -0400 Subject: [PATCH 032/226] more ci fixes --- .pre-commit-config.yaml | 17 +++++++++-------- example-client.py | 3 +-- pyadtpulse/__init__.py | 1 - 3 files changed, 10 insertions(+), 11 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 800bb4a..db767ad 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,16 +1,21 @@ repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.5.0 hooks: - id: trailing-whitespace - id: end-of-file-fixer +- repo: https://github.com/asottile/pyupgrade + rev: v3.15.0 + hooks: + - id: pyupgrade + args: [--py311-plus] - repo: https://github.com/psf/black - rev: 23.9.1 + rev: 23.10.0 hooks: - id: black args: [--config=pyproject.toml] - repo: https://github.com/hadialqattan/pycln - rev: v2.2.2 + rev: v2.3.0 hooks: - id: pycln args: [--config=pyproject.toml] @@ -21,10 +26,6 @@ repos: files: "\\.(py)$" args: [--settings-path=pyproject.toml] - repo: https://github.com/dosisod/refurb - rev: v1.21.0 + rev: v1.22.1 hooks: - id: refurb -- repo: https://github.com/asottile/pyupgrade - rev: v3.13.0 - hooks: - - id: pyupgrade diff --git a/example-client.py b/example-client.py index 50b2ba1..15acd7d 100755 --- a/example-client.py +++ b/example-client.py @@ -8,7 +8,6 @@ import sys from pprint import pprint from time import sleep -from typing import Dict, Optional from pyadtpulse import PyADTPulse from pyadtpulse.const import ( @@ -208,7 +207,7 @@ def handle_args() -> argparse.Namespace: return args -def load_parameters_from_json(json_file: str) -> Optional[Dict]: +def load_parameters_from_json(json_file: str) -> dict | None: """Load parameters from a JSON file. Args: diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 52acc44..0f44163 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -7,7 +7,6 @@ import time from random import randint from threading import RLock, Thread -from typing import List, Optional, Tuple, Union from warnings import warn import uvloop From 206da3ece7bb4520ff896eed1791e486b3912ef0 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Sat, 21 Oct 2023 15:55:30 -0400 Subject: [PATCH 033/226] change pyupgrade to --py310-plus --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index db767ad..3bf84af 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -8,7 +8,7 @@ repos: rev: v3.15.0 hooks: - id: pyupgrade - args: [--py311-plus] + args: [--py310-plus] - repo: https://github.com/psf/black rev: 23.10.0 hooks: From 7278ebba1ac597984a05906db1dbeea34c4f5136 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Sat, 21 Oct 2023 16:03:54 -0400 Subject: [PATCH 034/226] put back union on RLock/DebugRlock --- pyadtpulse/__init__.py | 3 ++- pyadtpulse/site.py | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 0f44163..18f432a 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -5,6 +5,7 @@ import datetime import re import time +from typing import Union from random import randint from threading import RLock, Thread from warnings import warn @@ -790,7 +791,7 @@ def login(self) -> None: raise AuthenticationException(self._username) @property - def attribute_lock(self) -> RLock | DebugRLock: + def attribute_lock(self) -> Union[RLock, DebugRLock]: """Get attribute lock for PyADTPulse object. Returns: diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 805639c..d24a6c9 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -5,6 +5,7 @@ from datetime import datetime from threading import RLock from time import time +from typing import Union from warnings import warn # import dateparser @@ -90,7 +91,7 @@ def last_updated(self) -> int: return self._last_updated @property - def site_lock(self) -> RLock | DebugRLock: + def site_lock(self) -> Union[RLock, DebugRLock]: """Get thread lock for site data. Not needed for async From 40ae83aeb9bc287d9170902c366c09d7f6ff8e55 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Sat, 21 Oct 2023 16:05:19 -0400 Subject: [PATCH 035/226] change pyupgrade to --py39-plus to prevent rewriting unions --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 3bf84af..6f44382 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -8,7 +8,7 @@ repos: rev: v3.15.0 hooks: - id: pyupgrade - args: [--py310-plus] + args: [--py39-plus] - repo: https://github.com/psf/black rev: 23.10.0 hooks: From a7272fcac7525f3cf636482fb98a0f15f88594ab Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 21 Oct 2023 16:56:35 -0400 Subject: [PATCH 036/226] move do_login/do_logout_query to pulse_connection --- pyadtpulse/__init__.py | 71 ++++++---------------------------- pyadtpulse/pulse_connection.py | 54 +++++++++++++++++++++++++- 2 files changed, 64 insertions(+), 61 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 18f432a..60c9c88 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -5,9 +5,9 @@ import datetime import re import time -from typing import Union from random import randint from threading import RLock, Thread +from typing import Union from warnings import warn import uvloop @@ -20,8 +20,6 @@ ADT_DEFAULT_KEEPALIVE_INTERVAL, ADT_DEFAULT_RELOGIN_INTERVAL, ADT_GATEWAY_STRING, - ADT_LOGIN_URI, - ADT_LOGOUT_URI, ADT_MAX_KEEPALIVE_INTERVAL, ADT_MAX_RELOGIN_BACKOFF, ADT_MIN_RELOGIN_INTERVAL, @@ -526,7 +524,7 @@ async def _do_logout_and_relogin(self, relogin_wait_time: float) -> bool: bool: True if the re-login process is successful, False otherwise. """ current_task = asyncio.current_task() - await self._do_logout_query() + await self._pulse_connection.async_do_logout_query(self.site.id) await asyncio.sleep(relogin_wait_time) if not await self.async_quick_relogin(): task_name: str | None = None @@ -814,10 +812,13 @@ async def async_quick_relogin(self) -> bool: Doesn't do device queries or set connected event unless a failure occurs. FIXME: Should probably just re-work login logic.""" - response = await self._do_login_query() + response = await self._pulse_connection.async_do_login_query( + self.username, self._password, self._fingerprint + ) if not handle_response(response, logging.ERROR, "Could not re-login to Pulse"): await self.async_logout() return False + self._last_login_time = int(time.time()) return True def quick_relogin(self) -> bool: @@ -830,59 +831,6 @@ def quick_relogin(self) -> bool: ), ).result() - async def _do_login_query(self, timeout: int = 30) -> ClientResponse | None: - """ - Performs a login query to the Pulse site. - - Args: - timeout (int, optional): The timeout value for the query in seconds. - Defaults to 30. - - Returns: - ClientResponse | None: The response from the query or None if the login - was unsuccessful. - """ - try: - retval = await self._pulse_connection.async_query( - ADT_LOGIN_URI, - method="POST", - extra_params={ - "partner": "adt", - "e": "ns", - "usernameForm": self.username, - "passwordForm": self._password, - "fingerprint": self._fingerprint, - "sun": "yes", - }, - timeout=timeout, - ) - except Exception as e: # pylint: disable=broad-except - LOG.error("Could not log into Pulse site: %s", e) - return None - if retval is None: - LOG.error("Could not log into Pulse site.") - return None - if not handle_response( - retval, - logging.ERROR, - "Error encountered communicating with Pulse site on login", - ): - close_response(retval) - return None - self._last_login_time = int(time.time()) - return retval - - async def _do_logout_query(self) -> None: - """Performs a logout query to the ADT Pulse site.""" - params = {} - network: ADTPulseSite = self.site - if network is not None: - params.update({"network": str(network.id)}) - params.update({"partner": "adt"}) - await self._pulse_connection.async_query( - ADT_LOGOUT_URI, extra_params=params, timeout=10 - ) - async def async_login(self) -> bool: """Login asynchronously to ADT. @@ -896,9 +844,12 @@ async def async_login(self) -> bool: LOG.debug("Authenticating to ADT Pulse cloud service as %s", self._username) await self._pulse_connection.async_fetch_version() - response = await self._do_login_query() + response = await self._pulse_connection.async_do_login_query( + self.username, self._password, self._fingerprint + ) if response is None: return False + self._last_login_time = int(time.time()) if self._pulse_connection.make_url(ADT_SUMMARY_URI) != str(response.url): # more specifically: # redirect to signin.jsp = username/password error @@ -952,7 +903,7 @@ async def async_logout(self) -> None: await self._cancel_task(self._timeout_task) await self._cancel_task(self._sync_task) self._timeout_task = self._sync_task = None - await self._do_logout_query() + await self._pulse_connection.async_do_logout_query(self.site.id) if self._authenticated is not None: self._authenticated.clear() diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index f2c4e6e..4bfe09f 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -20,10 +20,11 @@ ADT_DEFAULT_VERSION, ADT_HTTP_REFERER_URIS, ADT_LOGIN_URI, + ADT_LOGOUT_URI, ADT_ORB_URI, API_PREFIX, ) -from .util import DebugRLock, make_soup +from .util import DebugRLock, close_response, handle_response, make_soup RECOVERABLE_ERRORS = [429, 500, 502, 503, 504] LOG = logging.getLogger(__name__) @@ -288,3 +289,54 @@ async def async_fetch_version(self) -> None: "Couldn't auto-detect ADT Pulse version, defaulting to %s", ADT_DEFAULT_VERSION, ) + + async def async_do_login_query( + self, username: str, password: str, fingerprint: str, timeout: int = 30 + ) -> ClientResponse | None: + """ + Performs a login query to the Pulse site. + + Args: + timeout (int, optional): The timeout value for the query in seconds. + Defaults to 30. + + Returns: + ClientResponse | None: The response from the query or None if the login + was unsuccessful. + """ + try: + retval = await self.async_query( + ADT_LOGIN_URI, + method="POST", + extra_params={ + "partner": "adt", + "e": "ns", + "usernameForm": username, + "passwordForm": password, + "fingerprint": fingerprint, + "sun": "yes", + }, + timeout=timeout, + ) + except Exception as e: # pylint: disable=broad-except + LOG.error("Could not log into Pulse site: %s", e) + return None + if retval is None: + LOG.error("Could not log into Pulse site.") + return None + if not handle_response( + retval, + logging.ERROR, + "Error encountered communicating with Pulse site on login", + ): + close_response(retval) + return None + return retval + + async def async_do_logout_query(self, site_id: str | None) -> None: + """Performs a logout query to the ADT Pulse site.""" + params = {} + if site_id is not None: + params.update({"network": site_id}) + params.update({"partner": "adt"}) + await self.async_query(ADT_LOGOUT_URI, extra_params=params, timeout=10) From f48b1af6ca9e314fad28494ac343ceca6978c1f7 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 21 Oct 2023 17:04:28 -0400 Subject: [PATCH 037/226] move last_login_time to pulse_connection --- pyadtpulse/__init__.py | 10 ++++------ pyadtpulse/pulse_connection.py | 11 +++++++++++ 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 60c9c88..df2b5d3 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -56,7 +56,6 @@ class PyADTPulse: "_updates_exist", "_session_thread", "_attribute_lock", - "_last_login_time", "_site", "_username", "_password", @@ -161,7 +160,6 @@ def __init__( self._attribute_lock = RLock() else: self._attribute_lock = DebugRLock("PyADTPulse._attribute_lock") - self._last_login_time: int = 0 self._site: ADTPulseSite | None = None self.keepalive_interval = keepalive_interval @@ -482,8 +480,10 @@ def _should_relogin(self, relogin_interval: int) -> bool: Returns: bool: True if the user should re-login, False otherwise. """ - return relogin_interval != 0 and time.time() - self._last_login_time > randint( - int(0.75 * relogin_interval), relogin_interval + return ( + relogin_interval != 0 + and time.time() - self._pulse_connection.last_login_time + > randint(int(0.75 * relogin_interval), relogin_interval) ) async def _handle_relogin(self, task_name: str) -> bool: @@ -818,7 +818,6 @@ async def async_quick_relogin(self) -> bool: if not handle_response(response, logging.ERROR, "Could not re-login to Pulse"): await self.async_logout() return False - self._last_login_time = int(time.time()) return True def quick_relogin(self) -> bool: @@ -849,7 +848,6 @@ async def async_login(self) -> bool: ) if response is None: return False - self._last_login_time = int(time.time()) if self._pulse_connection.make_url(ADT_SUMMARY_URI) != str(response.url): # more specifically: # redirect to signin.jsp = username/password error diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 4bfe09f..bd626b7 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -5,6 +5,7 @@ import re from random import uniform from threading import Lock, RLock +from time import time from aiohttp import ( ClientConnectionError, @@ -44,6 +45,7 @@ class ADTPulseConnection: "_session", "_attribute_lock", "_loop", + "_last_login_time", ) def __init__( @@ -63,6 +65,7 @@ def __init__( self._session = session self._session.headers.update({"User-Agent": user_agent}) self._attribute_lock: RLock | DebugRLock + self._last_login_time: int = 0 if not debug_locks: self._attribute_lock = RLock() else: @@ -105,6 +108,12 @@ def loop(self, loop: asyncio.AbstractEventLoop | None) -> None: with self._attribute_lock: self._loop = loop + @property + def last_login_time(self) -> int: + """Get the last login time.""" + with self._attribute_lock: + return self._last_login_time + def check_sync(self, message: str) -> asyncio.AbstractEventLoop: """Checks if sync login was performed. @@ -331,6 +340,8 @@ async def async_do_login_query( ): close_response(retval) return None + with self._attribute_lock: + self._last_login_time = int(time()) return retval async def async_do_logout_query(self, site_id: str | None) -> None: From ecb94ca194f7e50c3f8cab784a568d16ea0e9dfe Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 22 Oct 2023 03:41:29 -0400 Subject: [PATCH 038/226] fix missing bool functions in sync_check code --- pyadtpulse/__init__.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index df2b5d3..6ef7ceb 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -690,17 +690,19 @@ def _handle_updates_exist(self, text: str, last_sync_text: str) -> bool: async def _handle_no_updates_exist( self, have_updates: bool, task_name: str, text: str - ) -> None: + ) -> bool: if have_updates: if await self.async_update() is False: LOG.debug("Pulse data update from %s failed", task_name) - return + return False # shouldn't need to call _validate_updates_exist, but just in case self._validate_updates_exist(task_name) self._updates_exist.set() + return True else: if self.detailed_debug_logging: LOG.debug("Sync token %s indicates no remote updates to process", text) + return False def _pulse_session_thread(self) -> None: """ From e4b1b21ae1697a54e1b71f5c1d0d96b42d5cb316 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 22 Oct 2023 05:01:34 -0400 Subject: [PATCH 039/226] move retry_after to pulse_connection --- pyadtpulse/__init__.py | 84 ++-------------------------------- pyadtpulse/pulse_connection.py | 71 ++++++++++++++++++++++++++-- 2 files changed, 72 insertions(+), 83 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 6ef7ceb..546cf96 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -2,7 +2,6 @@ import logging import asyncio -import datetime import re import time from random import randint @@ -362,45 +361,6 @@ async def _initialize_sites(self, soup: BeautifulSoup) -> None: # # ... or perhaps better, just extract all from /system/settings.jsp - def _check_retry_after( - self, response: ClientResponse | None, task_name: str - ) -> int: - """ - Check the "Retry-After" header in the response and return the number of seconds - to wait before retrying the task. - - Parameters: - response (Optional[ClientResponse]): The response object. - task_name (str): The name of the task. - - Returns: - int: The number of seconds to wait before retrying the task. - """ - if response is None: - return 0 - header_value = response.headers.get("Retry-After") - if header_value is None: - return 0 - if header_value.isnumeric(): - retval = int(header_value) - else: - try: - retval = ( - datetime.datetime.strptime(header_value, "%a, %d %b %G %T %Z") - - datetime.datetime.now() - ).seconds - except ValueError: - return 0 - reason = "Unknown" - if response.status == 429: - reason = "Too many requests" - elif response.status == 503: - reason = "Service unavailable" - LOG.warning( - "Task %s received Retry-After %s due to %s", task_name, retval, reason - ) - return retval - def _get_task_name(self, task, default_name) -> str: """ Get the name of a task. @@ -453,9 +413,6 @@ async def _keepalive_task(self) -> None: or response is None ): # shut up linter continue - success, retry_after = self._handle_timeout_response(response) - if not success: - continue await self._update_gateway_device_if_needed() except asyncio.CancelledError: @@ -525,7 +482,7 @@ async def _do_logout_and_relogin(self, relogin_wait_time: float) -> bool: """ current_task = asyncio.current_task() await self._pulse_connection.async_do_logout_query(self.site.id) - await asyncio.sleep(relogin_wait_time) + self._pulse_connection.retry_after = relogin_wait_time + time.time() if not await self.async_quick_relogin(): task_name: str | None = None if current_task is not None: @@ -548,27 +505,6 @@ def _calculate_sleep_time(self, retry_after: int) -> int: async def _reset_pulse_cloud_timeout(self) -> ClientResponse | None: return await self._pulse_connection.async_query(ADT_TIMEOUT_URI, "POST") - def _handle_timeout_response(self, response: ClientResponse) -> tuple[bool, int]: - """ - Handle the timeout response from the client. - - Args: - response (ClientResponse): The client response object. - - Returns: - Tuple[bool, int]: A tuple containing a boolean value indicating whether the - response was handled successfully and an integer indicating the - retry after value. - """ - if not handle_response( - response, logging.INFO, "Failed resetting ADT Pulse cloud timeout" - ): - retry_after = self._check_retry_after(response, "Keepalive task") - close_response(response) - return False, retry_after - close_response(response) - return True, 0 - async def _update_gateway_device_if_needed(self) -> None: if self.site.gateway.next_update < time.time(): await self.site._set_device(ADT_GATEWAY_STRING) @@ -599,13 +535,11 @@ async def _sync_check_task(self) -> None: await asyncio.sleep(max(retry_after, pi)) response = await self._perform_sync_check_query() - - if response is None or self._check_and_handle_retry( - response, task_name + if not handle_response( + response, logging.WARNING, "Error querying ADT sync" ): close_response(response) continue - text = await response.text() if not await self._validate_sync_check_response( response, text, current_relogin_interval @@ -613,10 +547,8 @@ async def _sync_check_task(self) -> None: current_relogin_interval = min( ADT_MAX_RELOGIN_BACKOFF, current_relogin_interval * 2 ) - close_response(response) continue current_relogin_interval = initial_relogin_interval - close_response(response) if self._handle_updates_exist(text, last_sync_text): last_sync_check_was_different = True last_sync_text = text @@ -640,13 +572,6 @@ async def _perform_sync_check_query(self): ADT_SYNC_CHECK_URI, extra_params={"ts": str(int(time.time() * 1000))} ) - def _check_and_handle_retry(self, response, task_name): - retry_after = self._check_retry_after(response, f"{task_name}") - if retry_after != 0: - self._set_update_failed(response) - return True - return False - async def _validate_sync_check_response( self, response: ClientResponse, @@ -666,8 +591,9 @@ async def _validate_sync_check_response( """ if not handle_response(response, logging.ERROR, "Error querying ADT sync"): self._set_update_failed(response) + close_response(response) return False - + close_response(response) pattern = r"\d+[-]\d+[-]\d+" if not re.match(pattern, text): LOG.warning( diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index bd626b7..1de8ed7 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -2,10 +2,11 @@ import logging import asyncio +import datetime import re +import time from random import uniform from threading import Lock, RLock -from time import time from aiohttp import ( ClientConnectionError, @@ -27,7 +28,7 @@ ) from .util import DebugRLock, close_response, handle_response, make_soup -RECOVERABLE_ERRORS = [429, 500, 502, 503, 504] +RECOVERABLE_ERRORS = [500, 502, 504] LOG = logging.getLogger(__name__) MAX_RETRIES = 3 @@ -46,6 +47,7 @@ class ADTPulseConnection: "_attribute_lock", "_loop", "_last_login_time", + "_retry_after", ) def __init__( @@ -71,6 +73,7 @@ def __init__( else: self._attribute_lock = DebugRLock("ADTPulseConnection._attribute_lock") self._loop: asyncio.AbstractEventLoop | None = None + self._retry_after = time.time() def __del__(self): """Destructor for ADTPulseConnection.""" @@ -114,6 +117,20 @@ def last_login_time(self) -> int: with self._attribute_lock: return self._last_login_time + @property + def retry_after(self) -> int: + """Get the number of seconds to wait before retrying HTTP requests.""" + with self._attribute_lock: + return self._retry_after + + @retry_after.setter + def retry_after(self, seconds: int) -> None: + """Set the number of seconds to wait before retrying HTTP requests.""" + if seconds < time.time(): + raise ValueError("retry_after cannot be less than current time") + with self._attribute_lock: + self._retry_after = seconds + def check_sync(self, message: str) -> asyncio.AbstractEventLoop: """Checks if sync login was performed. @@ -124,6 +141,44 @@ def check_sync(self, message: str) -> asyncio.AbstractEventLoop: raise RuntimeError(message) return self._loop + def _set_retry_after(self, response: ClientResponse) -> None: + """ + Check the "Retry-After" header in the response and set retry_after property + based upon it. + + Parameters: + response (ClientResponse): The response object. + + Returns: + None. + """ + header_value = response.headers.get("Retry-After") + if header_value is None: + return + reason = "Unknown" + if response.status == 429: + reason = "Too many requests" + elif response.status == 503: + reason = "Service unavailable" + if header_value.isnumeric(): + retval = int(header_value) + else: + try: + retval = int( + datetime.datetime.strptime( + header_value, "%a, %d %b %G %T %Z" + ).timestamp() + ) + except ValueError: + return + LOG.warning( + "Task %s received Retry-After %s due to %s", + asyncio.current_task(), + retval, + reason, + ) + self.retry_after = int(time.time()) + retval + async def async_query( self, uri: str, @@ -149,6 +204,9 @@ async def async_query( None on failure ClientResponse will already be closed. """ + current_time = time.time() + if self.retry_after > current_time: + await asyncio.sleep(self.retry_after - current_time) with ADTPulseConnection._class_threadlock: if ADTPulseConnection._api_version == ADT_DEFAULT_VERSION: await self.async_fetch_version() @@ -195,13 +253,18 @@ async def async_query( continue response.raise_for_status() - retry = 4 # success, break loop + break except ( TimeoutError, ClientConnectionError, ClientConnectorError, ClientResponseError, ) as ex: + if response.status in (429, 503): + self._set_retry_after(response) + close_response(response) + response = None + break LOG.debug( "Error %s occurred making %s request to %s, retrying", ex.args, @@ -341,7 +404,7 @@ async def async_do_login_query( close_response(retval) return None with self._attribute_lock: - self._last_login_time = int(time()) + self._last_login_time = int(time.time()) return retval async def async_do_logout_query(self, site_id: str | None) -> None: From 9d3df80fb5f03f0387818ab26a2e9f2c4d25e1f5 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 22 Oct 2023 05:04:04 -0400 Subject: [PATCH 040/226] fix defaults on keepalive/relogin interval on pyadtpulse constructor --- pyadtpulse/__init__.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 546cf96..42b2313 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -101,8 +101,8 @@ def __init__( websession: ClientSession | None = None, do_login: bool = True, debug_locks: bool = False, - keepalive_interval: int | None = ADT_DEFAULT_KEEPALIVE_INTERVAL, - relogin_interval: int | None = ADT_DEFAULT_RELOGIN_INTERVAL, + keepalive_interval: int = ADT_DEFAULT_KEEPALIVE_INTERVAL, + relogin_interval: int = ADT_DEFAULT_RELOGIN_INTERVAL, detailed_debug_logging: bool = False, ): """Create a PyADTPulse object. From 99f1fbbb95dab24a1ed6706b7db813f52ae066c9 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 3 Nov 2023 06:14:30 -0400 Subject: [PATCH 041/226] retry after handling --- pyadtpulse/__init__.py | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 42b2313..71ecc02 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -388,7 +388,6 @@ async def _keepalive_task(self) -> None: Asynchronous function that runs a keepalive task to maintain the connection with the ADT Pulse cloud. """ - retry_after: int = 0 response: ClientResponse | None = None task_name: str = self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) LOG.debug("creating %s", task_name) @@ -397,11 +396,15 @@ async def _keepalive_task(self) -> None: self._validate_authenticated_event() while self._authenticated.is_set(): relogin_interval = self.relogin_interval - if self._should_relogin(relogin_interval): - if not await self._handle_relogin(task_name): - return try: - await asyncio.sleep(self._calculate_sleep_time(retry_after)) + await asyncio.sleep(self.keepalive_interval * 60) + if self._pulse_connection.retry_after > time.time(): + continue + if self._should_relogin(relogin_interval): + if not await self._handle_relogin(task_name): + return + else: + continue LOG.debug("Resetting timeout") response = await self._reset_pulse_cloud_timeout() if ( @@ -482,7 +485,7 @@ async def _do_logout_and_relogin(self, relogin_wait_time: float) -> bool: """ current_task = asyncio.current_task() await self._pulse_connection.async_do_logout_query(self.site.id) - self._pulse_connection.retry_after = relogin_wait_time + time.time() + self._pulse_connection.retry_after = int(relogin_wait_time + time.time()) if not await self.async_quick_relogin(): task_name: str | None = None if current_task is not None: @@ -499,9 +502,6 @@ async def _do_logout_and_relogin(self, relogin_wait_time: float) -> bool: ) return True - def _calculate_sleep_time(self, retry_after: int) -> int: - return self.keepalive_interval * 60 + retry_after - async def _reset_pulse_cloud_timeout(self) -> ClientResponse | None: return await self._pulse_connection.async_query(ADT_TIMEOUT_URI, "POST") From 57c6dbce5516aa36015a7157a677878ff4689fb5 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 3 Nov 2023 06:38:29 -0400 Subject: [PATCH 042/226] move authenticated_flag to pulse_connection, make updates exist never None --- pyadtpulse/__init__.py | 50 +++++----------------------------- pyadtpulse/pulse_connection.py | 10 ++++++- 2 files changed, 16 insertions(+), 44 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 71ecc02..5a0f752 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -148,10 +148,9 @@ def __init__( # FIXME use thread event/condition, regular condition? # defer initialization to make sure we have an event loop - self._authenticated: asyncio.locks.Event | None = None self._login_exception: BaseException | None = None - self._updates_exist: asyncio.locks.Event | None = None + self._updates_exist = asyncio.locks.Event() self._session_thread: Thread | None = None self._attribute_lock: RLock | DebugRLock @@ -392,9 +391,7 @@ async def _keepalive_task(self) -> None: task_name: str = self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) LOG.debug("creating %s", task_name) - with self._attribute_lock: - self._validate_authenticated_event() - while self._authenticated.is_set(): + while self._pulse_connection.authenticated_flag.is_set(): relogin_interval = self.relogin_interval try: await asyncio.sleep(self.keepalive_interval * 60) @@ -423,12 +420,6 @@ async def _keepalive_task(self) -> None: close_response(response) return - def _validate_authenticated_event(self) -> None: - if self._authenticated is None: - raise RuntimeError( - "Keepalive task is running without an authenticated event" - ) - def _should_relogin(self, relogin_interval: int) -> bool: """ Checks if the user should re-login based on the relogin interval and the time @@ -520,9 +511,6 @@ async def _sync_check_task(self) -> None: current_relogin_interval ) = self.site.gateway.poll_interval last_sync_text = "0-0-0" - - self._validate_updates_exist(task_name) - last_sync_check_was_different = False while True: try: @@ -563,10 +551,6 @@ async def _sync_check_task(self) -> None: close_response(response) return - def _validate_updates_exist(self, task_name: str) -> None: - if self._updates_exist is None: - raise RuntimeError(f"{task_name} started without update event initialized") - async def _perform_sync_check_query(self): return await self._pulse_connection.async_query( ADT_SYNC_CHECK_URI, extra_params={"ts": str(int(time.time() * 1000))} @@ -621,8 +605,6 @@ async def _handle_no_updates_exist( if await self.async_update() is False: LOG.debug("Pulse data update from %s failed", task_name) return False - # shouldn't need to call _validate_updates_exist, but just in case - self._validate_updates_exist(task_name) self._updates_exist.set() return True else: @@ -685,10 +667,9 @@ async def _sync_loop(self) -> None: else: # we should never get here raise RuntimeError("Background pyadtpulse tasks not created") - if self._authenticated is not None: - while self._authenticated.is_set(): - # busy wait until logout is done - await asyncio.sleep(0.5) + while self._pulse_connection.authenticated_flag.is_set(): + # busy wait until logout is done + await asyncio.sleep(0.5) def login(self) -> None: """Login to ADT Pulse and generate access token. @@ -763,11 +744,6 @@ async def async_login(self) -> bool: Returns: True if login successful """ - if self._authenticated is None: - self._authenticated = asyncio.locks.Event() - else: - self._authenticated.clear() - LOG.debug("Authenticating to ADT Pulse cloud service as %s", self._username) await self._pulse_connection.async_fetch_version() @@ -804,11 +780,10 @@ async def async_login(self) -> bool: ) return False # need to set authenticated here to prevent login loop - self._authenticated.set() await self._update_sites(soup) if self._site is None: LOG.error("Could not retrieve any sites, login failed") - self._authenticated.clear() + await self.async_logout() return False # since we received fresh data on the status of the alarm, go ahead @@ -818,8 +793,6 @@ async def async_login(self) -> bool: self._timeout_task = asyncio.create_task( self._keepalive_task(), name=f"{KEEPALIVE_TASK_NAME}" ) - if self._updates_exist is None: - self._updates_exist = asyncio.locks.Event() await asyncio.sleep(0) return True @@ -830,8 +803,6 @@ async def async_logout(self) -> None: await self._cancel_task(self._sync_task) self._timeout_task = self._sync_task = None await self._pulse_connection.async_do_logout_query(self.site.id) - if self._authenticated is not None: - self._authenticated.clear() def logout(self) -> None: """Log out of ADT Pulse.""" @@ -862,8 +833,6 @@ def _check_update_succeeded(self) -> bool: with self._attribute_lock: old_update_succeded = self._update_succeded self._update_succeded = True - if self._updates_exist is None: - return False if self._updates_exist.is_set(): self._updates_exist.clear() return old_update_succeded @@ -915,12 +884,7 @@ def is_connected(self) -> bool: Returns: bool: True if connected """ - with self._attribute_lock: - if self._authenticated is None: - return False - return self._authenticated.is_set() - - # FIXME? might have to move this to site for multiple sites + return self._pulse_connection.authenticated_flag.is_set() async def async_update(self) -> bool: """Update ADT Pulse data. diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 1de8ed7..023191d 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -48,6 +48,7 @@ class ADTPulseConnection: "_loop", "_last_login_time", "_retry_after", + "_authenticated_flag", ) def __init__( @@ -60,6 +61,7 @@ def __init__( """Initialize ADT Pulse connection.""" self._api_host = host self._allocated_session = False + self._authenticated_flag: asyncio.Event() if session is None: self._allocated_session = True self._session = ClientSession() @@ -73,7 +75,7 @@ def __init__( else: self._attribute_lock = DebugRLock("ADTPulseConnection._attribute_lock") self._loop: asyncio.AbstractEventLoop | None = None - self._retry_after = time.time() + self._retry_after = int(time.time()) def __del__(self): """Destructor for ADTPulseConnection.""" @@ -131,6 +133,12 @@ def retry_after(self, seconds: int) -> None: with self._attribute_lock: self._retry_after = seconds + @property + def authenticated_flag(self) -> asyncio.Event: + """Get the authenticated flag.""" + with self._attribute_lock: + return self._authenticated_flag + def check_sync(self, message: str) -> asyncio.AbstractEventLoop: """Checks if sync login was performed. From 8baacbb38a3f5bb69f91f0cf7c648cc54498ddc2 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 3 Nov 2023 06:55:03 -0400 Subject: [PATCH 043/226] add requires_authentication flag to async_query() --- pyadtpulse/pulse_connection.py | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 023191d..ca654a9 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -61,7 +61,7 @@ def __init__( """Initialize ADT Pulse connection.""" self._api_host = host self._allocated_session = False - self._authenticated_flag: asyncio.Event() + self._authenticated_flag = asyncio.Event() if session is None: self._allocated_session = True self._session = ClientSession() @@ -194,6 +194,7 @@ async def async_query( extra_params: dict[str, str] | None = None, extra_headers: dict[str, str] | None = None, timeout: int = 1, + requires_authentication: bool = True, ) -> ClientResponse | None: """ Query ADT Pulse async. @@ -206,6 +207,11 @@ async def async_query( extra_headers (Optional[Dict], optional): extra HTTP headers. Defaults to None. timeout (int, optional): timeout in seconds. Defaults to 1. + requires_authentication (bool, optional): True if authentication is + required to perform query. + Defaults to True. + If true and authenticated flag not + set, will wait for flag to be set. Returns: Optional[ClientResponse]: aiohttp.ClientResponse object @@ -215,9 +221,15 @@ async def async_query( current_time = time.time() if self.retry_after > current_time: await asyncio.sleep(self.retry_after - current_time) - with ADTPulseConnection._class_threadlock: - if ADTPulseConnection._api_version == ADT_DEFAULT_VERSION: - await self.async_fetch_version() + + if requires_authentication: + LOG.info("%s for %s waiting for authenticated flag to be set", method, uri) + await self._authenticated_flag.wait() + else: + with ADTPulseConnection._class_threadlock: + if ADTPulseConnection._api_version == ADT_DEFAULT_VERSION: + await self.async_fetch_version() + url = self.make_url(uri) headers = {"Accept": ADT_DEFAULT_HTTP_HEADERS["Accept"]} @@ -268,7 +280,7 @@ async def async_query( ClientConnectorError, ClientResponseError, ) as ex: - if response.status in (429, 503): + if response and response.status in (429, 503): self._set_retry_after(response) close_response(response) response = None @@ -397,6 +409,7 @@ async def async_do_login_query( "sun": "yes", }, timeout=timeout, + requires_authentication=False, ) except Exception as e: # pylint: disable=broad-except LOG.error("Could not log into Pulse site: %s", e) @@ -421,4 +434,9 @@ async def async_do_logout_query(self, site_id: str | None) -> None: if site_id is not None: params.update({"network": site_id}) params.update({"partner": "adt"}) - await self.async_query(ADT_LOGOUT_URI, extra_params=params, timeout=10) + await self.async_query( + ADT_LOGOUT_URI, + extra_params=params, + timeout=10, + requires_authentication=False, + ) From d0c343b0fcb3ca2f12ee897c42b5a6c61dad86b2 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 3 Nov 2023 06:57:44 -0400 Subject: [PATCH 044/226] move retry increment earlier in case of None response --- pyadtpulse/pulse_connection.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index ca654a9..75a0180 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -254,10 +254,10 @@ async def async_query( data=extra_params if method == "POST" else None, timeout=timeout, ) as response: + retry += 1 await response.text() if response.status in RECOVERABLE_ERRORS: - retry += 1 LOG.info( "query returned recoverable error code %s, " "retrying (count = %d)", From 618cf47a34f7bd457d605651dd0b578c08bc44d7 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 3 Nov 2023 07:06:34 -0400 Subject: [PATCH 045/226] add requires_authentication to query() --- pyadtpulse/pulse_connection.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 75a0180..9e3a3ff 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -302,6 +302,7 @@ def query( extra_params: dict[str, str] | None = None, extra_headers: dict[str, str] | None = None, timeout=1, + requires_authentication: bool = True, ) -> ClientResponse | None: """Query ADT Pulse async. @@ -312,12 +313,18 @@ def query( extra_headers (Optional[Dict], optional): extra HTTP headers. Defaults to None. timeout (int, optional): timeout in seconds. Defaults to 1. + requires_authentication (bool, optional): True if authentication is required + to perform query. Defaults to True. + If true and authenticated flag not + set, will wait for flag to be set. Returns: Optional[ClientResponse]: aiohttp.ClientResponse object None on failure ClientResponse will already be closed. """ - coro = self.async_query(uri, method, extra_params, extra_headers, timeout) + coro = self.async_query( + uri, method, extra_params, extra_headers, timeout, requires_authentication + ) return asyncio.run_coroutine_threadsafe( coro, self.check_sync("Attempting to run sync query from async login") ).result() From 958c4259049c07093518a1fda784252ada89442c Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 3 Nov 2023 07:29:44 -0400 Subject: [PATCH 046/226] remove relative imports --- pyadtpulse/__init__.py | 10 +++++----- pyadtpulse/alarm_panel.py | 6 +++--- pyadtpulse/gateway.py | 7 +++++-- pyadtpulse/pulse_connection.py | 4 ++-- pyadtpulse/site.py | 12 ++++++------ 5 files changed, 21 insertions(+), 18 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 5a0f752..23756df 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -13,8 +13,8 @@ from aiohttp import ClientResponse, ClientSession from bs4 import BeautifulSoup -from .alarm_panel import ADT_ALARM_UNKNOWN -from .const import ( +from pyadtpulse.alarm_panel import ADT_ALARM_UNKNOWN +from pyadtpulse.const import ( ADT_DEFAULT_HTTP_HEADERS, ADT_DEFAULT_KEEPALIVE_INTERVAL, ADT_DEFAULT_RELOGIN_INTERVAL, @@ -28,9 +28,9 @@ API_HOST_CA, DEFAULT_API_HOST, ) -from .pulse_connection import ADTPulseConnection -from .site import ADTPulseSite -from .util import ( +from pyadtpulse.pulse_connection import ADTPulseConnection +from pyadtpulse.site import ADTPulseSite +from pyadtpulse.util import ( AuthenticationException, DebugRLock, close_response, diff --git a/pyadtpulse/alarm_panel.py b/pyadtpulse/alarm_panel.py index 2c6a6cc..63019b5 100644 --- a/pyadtpulse/alarm_panel.py +++ b/pyadtpulse/alarm_panel.py @@ -9,9 +9,9 @@ from bs4 import BeautifulSoup -from .const import ADT_ARM_DISARM_URI -from .pulse_connection import ADTPulseConnection -from .util import make_soup +from pyadtpulse.const import ADT_ARM_DISARM_URI +from pyadtpulse.pulse_connection import ADTPulseConnection +from pyadtpulse.util import make_soup LOG = logging.getLogger(__name__) ADT_ALARM_AWAY = "away" diff --git a/pyadtpulse/gateway.py b/pyadtpulse/gateway.py index af28805..584d663 100644 --- a/pyadtpulse/gateway.py +++ b/pyadtpulse/gateway.py @@ -6,8 +6,11 @@ from threading import RLock from typing import Any -from .const import ADT_DEFAULT_POLL_INTERVAL, ADT_GATEWAY_OFFLINE_POLL_INTERVAL -from .util import parse_pulse_datetime +from pyadtpulse.const import ( + ADT_DEFAULT_POLL_INTERVAL, + ADT_GATEWAY_OFFLINE_POLL_INTERVAL, +) +from pyadtpulse.util import parse_pulse_datetime LOG = logging.getLogger(__name__) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 9e3a3ff..046a62d 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -17,7 +17,7 @@ ) from bs4 import BeautifulSoup -from .const import ( +from pyadtpulse.const import ( ADT_DEFAULT_HTTP_HEADERS, ADT_DEFAULT_VERSION, ADT_HTTP_REFERER_URIS, @@ -26,7 +26,7 @@ ADT_ORB_URI, API_PREFIX, ) -from .util import DebugRLock, close_response, handle_response, make_soup +from pyadtpulse.util import DebugRLock, close_response, handle_response, make_soup RECOVERABLE_ERRORS = [500, 502, 504] LOG = logging.getLogger(__name__) diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index d24a6c9..c439101 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -11,12 +11,12 @@ # import dateparser from bs4 import BeautifulSoup -from .alarm_panel import ADTPulseAlarmPanel -from .const import ADT_DEVICE_URI, ADT_GATEWAY_STRING, ADT_SYSTEM_URI -from .gateway import ADTPulseGateway -from .pulse_connection import ADTPulseConnection -from .util import DebugRLock, make_soup, parse_pulse_datetime, remove_prefix -from .zones import ADTPulseFlattendZone, ADTPulseZones +from pyadtpulse.alarm_panel import ADTPulseAlarmPanel +from pyadtpulse.const import ADT_DEVICE_URI, ADT_GATEWAY_STRING, ADT_SYSTEM_URI +from pyadtpulse.gateway import ADTPulseGateway +from pyadtpulse.pulse_connection import ADTPulseConnection +from pyadtpulse.util import DebugRLock, make_soup, parse_pulse_datetime, remove_prefix +from pyadtpulse.zones import ADTPulseFlattendZone, ADTPulseZones LOG = logging.getLogger(__name__) From 6b423a048fdc797485ccc2d72915d58d11af7b13 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 3 Nov 2023 07:34:59 -0400 Subject: [PATCH 047/226] set and clear authenticated flag on login/logout --- pyadtpulse/pulse_connection.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 046a62d..50b6a35 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -432,6 +432,7 @@ async def async_do_login_query( close_response(retval) return None with self._attribute_lock: + self._authenticated_flag.set() self._last_login_time = int(time.time()) return retval @@ -447,3 +448,4 @@ async def async_do_logout_query(self, site_id: str | None) -> None: timeout=10, requires_authentication=False, ) + self._authenticated_flag.clear() From 2607d10f3024853f14ad3818548bb73874ddf280 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 3 Nov 2023 09:14:42 -0400 Subject: [PATCH 048/226] re-work login/logout --- pyadtpulse/__init__.py | 133 ++++++++++++--------------------- pyadtpulse/pulse_connection.py | 8 +- 2 files changed, 56 insertions(+), 85 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 23756df..5cca69a 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -4,6 +4,7 @@ import asyncio import re import time +from datetime import datetime from random import randint from threading import RLock, Thread from typing import Union @@ -64,6 +65,7 @@ class PyADTPulse: "_keepalive_interval", "_update_succeded", "_detailed_debug_logging", + "_current_relogin_backoff", ) @staticmethod @@ -164,6 +166,7 @@ def __init__( self.relogin_interval = relogin_interval self._detailed_debug_logging = detailed_debug_logging self._update_succeded = True + self._current_relogin_backoff = 0.0 # authenticate the user if do_login and websession is None: @@ -391,17 +394,22 @@ async def _keepalive_task(self) -> None: task_name: str = self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) LOG.debug("creating %s", task_name) - while self._pulse_connection.authenticated_flag.is_set(): + while True: relogin_interval = self.relogin_interval try: await asyncio.sleep(self.keepalive_interval * 60) if self._pulse_connection.retry_after > time.time(): + LOG.debug( + "%s: Skipping actions because retry_after > now", task_name + ) + continue + if not self.is_connected: + LOG.debug("%s: Skipping relogin because not connected", task_name) + continue + elif self._should_relogin(relogin_interval): + LOG.debug("%s relogging in", task_name) + await self._do_logout_and_relogin() continue - if self._should_relogin(relogin_interval): - if not await self._handle_relogin(task_name): - return - else: - continue LOG.debug("Resetting timeout") response = await self._reset_pulse_cloud_timeout() if ( @@ -437,16 +445,6 @@ def _should_relogin(self, relogin_interval: int) -> bool: > randint(int(0.75 * relogin_interval), relogin_interval) ) - async def _handle_relogin(self, task_name: str) -> bool: - """Do a relogin from keepalive task.""" - LOG.info("Login timeout reached, re-logging in") - with self._attribute_lock: - try: - await self._cancel_task(self._sync_task) - except Exception as e: - LOG.warning("Unhandled exception %s while cancelling %s", e, task_name) - return await self._do_logout_and_relogin(0.0) - async def _cancel_task(self, task: asyncio.Task | None) -> None: """ Cancel a given asyncio task. @@ -464,7 +462,7 @@ async def _cancel_task(self, task: asyncio.Task | None) -> None: LOG.debug("%s successfully cancelled", task_name) await task - async def _do_logout_and_relogin(self, relogin_wait_time: float) -> bool: + async def _do_logout_and_relogin(self) -> bool: """ Performs a logout and re-login process. @@ -474,24 +472,17 @@ async def _do_logout_and_relogin(self, relogin_wait_time: float) -> bool: Returns: bool: True if the re-login process is successful, False otherwise. """ - current_task = asyncio.current_task() - await self._pulse_connection.async_do_logout_query(self.site.id) - self._pulse_connection.retry_after = int(relogin_wait_time + time.time()) - if not await self.async_quick_relogin(): - task_name: str | None = None - if current_task is not None: - task_name = current_task.get_name() - LOG.error("%s could not re-login, exiting", task_name or "(Unknown task)") - return False - if current_task is not None and current_task == self._sync_task: - return True - with self._attribute_lock: - if self._sync_task is not None: - coro = self._sync_check_task() - self._sync_task = asyncio.create_task( - coro, name=f"{SYNC_CHECK_TASK_NAME}: Async session" - ) - return True + await self.async_logout() + if self._current_relogin_backoff > self.relogin_interval: + await asyncio.sleep(self._current_relogin_backoff) + retval = await self.async_login() + if retval: + self._current_relogin_backoff = self.relogin_interval + else: + self._current_relogin_backoff = min( + ADT_MAX_RELOGIN_BACKOFF, self._current_relogin_backoff * 2 + ) + return retval async def _reset_pulse_cloud_timeout(self) -> ClientResponse | None: return await self._pulse_connection.async_query(ADT_TIMEOUT_URI, "POST") @@ -506,10 +497,6 @@ async def _sync_check_task(self) -> None: LOG.debug("creating %s", task_name) response = None - retry_after = 0 - initial_relogin_interval = ( - current_relogin_interval - ) = self.site.gateway.poll_interval last_sync_text = "0-0-0" last_sync_check_was_different = False while True: @@ -520,7 +507,15 @@ async def _sync_check_task(self) -> None: if not last_sync_check_was_different else 0.0 ) - await asyncio.sleep(max(retry_after, pi)) + retry_after = self._pulse_connection.retry_after + if retry_after > time.time(): + LOG.debug( + "%s: Waiting for retry after %s", + task_name, + datetime.fromtimestamp(retry_after), + ) + continue + await asyncio.sleep(pi) response = await self._perform_sync_check_query() if not handle_response( @@ -529,14 +524,8 @@ async def _sync_check_task(self) -> None: close_response(response) continue text = await response.text() - if not await self._validate_sync_check_response( - response, text, current_relogin_interval - ): - current_relogin_interval = min( - ADT_MAX_RELOGIN_BACKOFF, current_relogin_interval * 2 - ) + if not await self._validate_sync_check_response(response, text): continue - current_relogin_interval = initial_relogin_interval if self._handle_updates_exist(text, last_sync_text): last_sync_check_was_different = True last_sync_text = text @@ -560,7 +549,6 @@ async def _validate_sync_check_response( self, response: ClientResponse, text: str, - current_relogin_interval: float, ) -> bool: """ Validates the sync check response received from the ADT Pulse site. @@ -568,7 +556,6 @@ async def _validate_sync_check_response( Args: response (ClientResponse): The HTTP response object. text (str): The response text. - current_relogin_interval (float): The current relogin interval. Returns: bool: True if the sync check response is valid, False otherwise. @@ -583,11 +570,11 @@ async def _validate_sync_check_response( LOG.warning( "Unexpected sync check format (%s), " "forcing re-auth after %f seconds", - pattern, - current_relogin_interval, + text, + self._current_relogin_backoff, ) LOG.debug("Received %s from ADT Pulse site", text) - await self._do_logout_and_relogin(current_relogin_interval) + await self._do_logout_and_relogin() self._set_update_failed(None) return False return True @@ -716,29 +703,6 @@ def loop(self) -> asyncio.AbstractEventLoop | None: """ return self._pulse_connection.loop - async def async_quick_relogin(self) -> bool: - """Quickly re-login to Pulse. - - Doesn't do device queries or set connected event unless a failure occurs. - FIXME: Should probably just re-work login logic.""" - response = await self._pulse_connection.async_do_login_query( - self.username, self._password, self._fingerprint - ) - if not handle_response(response, logging.ERROR, "Could not re-login to Pulse"): - await self.async_logout() - return False - return True - - def quick_relogin(self) -> bool: - """Perform quick_relogin synchronously.""" - coro = self.async_quick_relogin() - return asyncio.run_coroutine_threadsafe( - coro, - self._pulse_connection.check_sync( - "Attempting to do call sync quick re-login from async" - ), - ).result() - async def async_login(self) -> bool: """Login asynchronously to ADT. @@ -779,7 +743,9 @@ async def async_login(self) -> bool: error, ) return False - # need to set authenticated here to prevent login loop + # if tasks are started, we've already logged in before + if self._sync_task is not None or self._timeout_task is not None: + return True await self._update_sites(soup) if self._site is None: LOG.error("Could not retrieve any sites, login failed") @@ -788,20 +754,19 @@ async def async_login(self) -> bool: # since we received fresh data on the status of the alarm, go ahead # and update the sites with the alarm status. - - if self._timeout_task is None: - self._timeout_task = asyncio.create_task( - self._keepalive_task(), name=f"{KEEPALIVE_TASK_NAME}" - ) + self._timeout_task = asyncio.create_task( + self._keepalive_task(), name=f"{KEEPALIVE_TASK_NAME}" + ) await asyncio.sleep(0) return True async def async_logout(self) -> None: """Logout of ADT Pulse async.""" LOG.info("Logging %s out of ADT Pulse", self._username) - await self._cancel_task(self._timeout_task) - await self._cancel_task(self._sync_task) - self._timeout_task = self._sync_task = None + if asyncio.current_task() not in (self._sync_task, self._timeout_task): + await self._cancel_task(self._timeout_task) + await self._cancel_task(self._sync_task) + self._timeout_task = self._sync_task = None await self._pulse_connection.async_do_logout_query(self.site.id) def logout(self) -> None: diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 50b6a35..67bfaea 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -127,7 +127,7 @@ def retry_after(self) -> int: @retry_after.setter def retry_after(self, seconds: int) -> None: - """Set the number of seconds to wait before retrying HTTP requests.""" + """Set time after which HTTP requests can be retried.""" if seconds < time.time(): raise ValueError("retry_after cannot be less than current time") with self._attribute_lock: @@ -220,6 +220,12 @@ async def async_query( """ current_time = time.time() if self.retry_after > current_time: + LOG.debug( + "Retry after set, query %s for %s waiting until %s", + method, + uri, + datetime.datetime.fromtimestamp(self.retry_after), + ) await asyncio.sleep(self.retry_after - current_time) if requires_authentication: From 99c8635357d41b5430675e7e53a5cde062dae44d Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 3 Nov 2023 09:25:58 -0400 Subject: [PATCH 049/226] fix logging for authentication flag in async_query() --- pyadtpulse/pulse_connection.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 67bfaea..2320110 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -228,7 +228,7 @@ async def async_query( ) await asyncio.sleep(self.retry_after - current_time) - if requires_authentication: + if requires_authentication and not self.authenticated_flag.is_set(): LOG.info("%s for %s waiting for authenticated flag to be set", method, uri) await self._authenticated_flag.wait() else: From ea7b9cd51f625b16ba9ad60e0ef20658f78ca196 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 3 Nov 2023 10:42:54 -0400 Subject: [PATCH 050/226] make sync_task and keepalive_task inner functions --- pyadtpulse/__init__.py | 202 +++++++++++++++++++---------------------- 1 file changed, 92 insertions(+), 110 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 5cca69a..e4f447e 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -65,7 +65,7 @@ class PyADTPulse: "_keepalive_interval", "_update_succeded", "_detailed_debug_logging", - "_current_relogin_backoff", + "_current_relogin_retry_count", ) @staticmethod @@ -166,7 +166,7 @@ def __init__( self.relogin_interval = relogin_interval self._detailed_debug_logging = detailed_debug_logging self._update_succeded = True - self._current_relogin_backoff = 0.0 + self._current_relogin_retry_count = 0 # authenticate the user if do_login and websession is None: @@ -390,6 +390,21 @@ async def _keepalive_task(self) -> None: Asynchronous function that runs a keepalive task to maintain the connection with the ADT Pulse cloud. """ + + async def reset_pulse_cloud_timeout() -> ClientResponse | None: + return await self._pulse_connection.async_query(ADT_TIMEOUT_URI, "POST") + + async def update_gateway_device_if_needed() -> None: + if self.site.gateway.next_update < time.time(): + await self.site._set_device(ADT_GATEWAY_STRING) + + def should_relogin(relogin_interval: int) -> bool: + return ( + relogin_interval != 0 + and time.time() - self._pulse_connection.last_login_time + > randint(int(0.75 * relogin_interval), relogin_interval) + ) + response: ClientResponse | None = None task_name: str = self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) LOG.debug("creating %s", task_name) @@ -406,12 +421,12 @@ async def _keepalive_task(self) -> None: if not self.is_connected: LOG.debug("%s: Skipping relogin because not connected", task_name) continue - elif self._should_relogin(relogin_interval): + elif should_relogin(relogin_interval): LOG.debug("%s relogging in", task_name) await self._do_logout_and_relogin() continue LOG.debug("Resetting timeout") - response = await self._reset_pulse_cloud_timeout() + response = await reset_pulse_cloud_timeout() if ( not handle_response( response, @@ -421,30 +436,13 @@ async def _keepalive_task(self) -> None: or response is None ): # shut up linter continue - await self._update_gateway_device_if_needed() + await update_gateway_device_if_needed() except asyncio.CancelledError: LOG.debug("%s cancelled", task_name) close_response(response) return - def _should_relogin(self, relogin_interval: int) -> bool: - """ - Checks if the user should re-login based on the relogin interval and the time - since the last login. - - Parameters: - relogin_interval (int): The interval in seconds between re-logins. - - Returns: - bool: True if the user should re-login, False otherwise. - """ - return ( - relogin_interval != 0 - and time.time() - self._pulse_connection.last_login_time - > randint(int(0.75 * relogin_interval), relogin_interval) - ) - async def _cancel_task(self, task: asyncio.Task | None) -> None: """ Cancel a given asyncio task. @@ -467,38 +465,87 @@ async def _do_logout_and_relogin(self) -> bool: Performs a logout and re-login process. Args: - relogin_wait_time (float): The amount of time to wait before re-logging in. - + None. Returns: bool: True if the re-login process is successful, False otherwise. """ await self.async_logout() - if self._current_relogin_backoff > self.relogin_interval: - await asyncio.sleep(self._current_relogin_backoff) + if self._current_relogin_retry_count != 0: + await asyncio.sleep(self._compute_login_backoff()) retval = await self.async_login() if retval: - self._current_relogin_backoff = self.relogin_interval + self._current_relogin_retry_count = 0 else: - self._current_relogin_backoff = min( - ADT_MAX_RELOGIN_BACKOFF, self._current_relogin_backoff * 2 - ) + self._current_relogin_retry_count += 1 return retval - async def _reset_pulse_cloud_timeout(self) -> ClientResponse | None: - return await self._pulse_connection.async_query(ADT_TIMEOUT_URI, "POST") - - async def _update_gateway_device_if_needed(self) -> None: - if self.site.gateway.next_update < time.time(): - await self.site._set_device(ADT_GATEWAY_STRING) - async def _sync_check_task(self) -> None: """Asynchronous function that performs a synchronization check task.""" + + async def perform_sync_check_query(): + return await self._pulse_connection.async_query( + ADT_SYNC_CHECK_URI, extra_params={"ts": str(int(time.time() * 1000))} + ) + + def set_update_failed() -> None: + """Sets update failed, sets updates_exist to notify wait_for_update.""" + with self._attribute_lock: + self._update_succeded = False + if self._updates_exist is not None: + self._updates_exist.set() + task_name = self._get_sync_task_name() LOG.debug("creating %s", task_name) response = None last_sync_text = "0-0-0" last_sync_check_was_different = False + + async def validate_sync_check_response() -> bool: + """ + Validates the sync check response received from the ADT Pulse site. + Returns: + bool: True if the sync check response is valid, False otherwise. + """ + if not handle_response(response, logging.ERROR, "Error querying ADT sync"): + set_update_failed() + close_response(response) + return False + close_response(response) + pattern = r"\d+[-]\d+[-]\d+" + if not re.match(pattern, text): + LOG.warning( + "Unexpected sync check format (%s), " + "forcing re-auth after %f seconds", + text, + self._compute_login_backoff(), + ) + LOG.debug("Received %s from ADT Pulse site", text) + await self._do_logout_and_relogin() + set_update_failed() + return False + return True + + async def handle_no_updates_exist() -> bool: + if last_sync_check_was_different: + if await self.async_update() is False: + LOG.debug("Pulse data update from %s failed", task_name) + return False + self._updates_exist.set() + return True + else: + if self.detailed_debug_logging: + LOG.debug( + "Sync token %s indicates no remote updates to process", text + ) + return False + + def handle_updates_exist() -> bool: + if text != last_sync_text: + LOG.debug("Updates exist: %s, requerying", text) + return True + return False + while True: try: self.site.gateway.adjust_backoff_poll_interval() @@ -517,22 +564,20 @@ async def _sync_check_task(self) -> None: continue await asyncio.sleep(pi) - response = await self._perform_sync_check_query() + response = await perform_sync_check_query() if not handle_response( response, logging.WARNING, "Error querying ADT sync" ): close_response(response) continue text = await response.text() - if not await self._validate_sync_check_response(response, text): + if not await validate_sync_check_response(): continue - if self._handle_updates_exist(text, last_sync_text): + if handle_updates_exist(): last_sync_check_was_different = True last_sync_text = text continue - if await self._handle_no_updates_exist( - last_sync_check_was_different, task_name, text - ): + if await handle_no_updates_exist(): last_sync_check_was_different = False continue except asyncio.CancelledError: @@ -540,65 +585,12 @@ async def _sync_check_task(self) -> None: close_response(response) return - async def _perform_sync_check_query(self): - return await self._pulse_connection.async_query( - ADT_SYNC_CHECK_URI, extra_params={"ts": str(int(time.time() * 1000))} + def _compute_login_backoff(self) -> float: + return min( + ADT_MAX_RELOGIN_BACKOFF, + self.site.gateway.poll_interval * (2 ^ self._current_relogin_retry_count), ) - async def _validate_sync_check_response( - self, - response: ClientResponse, - text: str, - ) -> bool: - """ - Validates the sync check response received from the ADT Pulse site. - - Args: - response (ClientResponse): The HTTP response object. - text (str): The response text. - - Returns: - bool: True if the sync check response is valid, False otherwise. - """ - if not handle_response(response, logging.ERROR, "Error querying ADT sync"): - self._set_update_failed(response) - close_response(response) - return False - close_response(response) - pattern = r"\d+[-]\d+[-]\d+" - if not re.match(pattern, text): - LOG.warning( - "Unexpected sync check format (%s), " - "forcing re-auth after %f seconds", - text, - self._current_relogin_backoff, - ) - LOG.debug("Received %s from ADT Pulse site", text) - await self._do_logout_and_relogin() - self._set_update_failed(None) - return False - return True - - def _handle_updates_exist(self, text: str, last_sync_text: str) -> bool: - if text != last_sync_text: - LOG.debug("Updates exist: %s, requerying", text) - return True - return False - - async def _handle_no_updates_exist( - self, have_updates: bool, task_name: str, text: str - ) -> bool: - if have_updates: - if await self.async_update() is False: - LOG.debug("Pulse data update from %s failed", task_name) - return False - self._updates_exist.set() - return True - else: - if self.detailed_debug_logging: - LOG.debug("Sync token %s indicates no remote updates to process", text) - return False - def _pulse_session_thread(self) -> None: """ Pulse the session thread. @@ -781,16 +773,6 @@ def logout(self) -> None: if sync_thread is not None: sync_thread.join() - def _set_update_failed(self, resp: ClientResponse | None) -> None: - """Sets update failed, sets updates_exist to notify wait_for_update - and closes response if necessary.""" - with self._attribute_lock: - self._update_succeded = False - if resp is not None: - close_response(resp) - if self._updates_exist is not None: - self._updates_exist.set() - def _check_update_succeeded(self) -> bool: """Check if update succeeded, clears the update event and resets _update_succeeded. From a27d7104f96dd153332a31611d8921a70d463cb9 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 3 Nov 2023 10:50:57 -0400 Subject: [PATCH 051/226] add detailed debug logging to pulse_connection --- pyadtpulse/__init__.py | 2 ++ pyadtpulse/pulse_connection.py | 28 +++++++++++++++++++++++----- 2 files changed, 25 insertions(+), 5 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index e4f447e..cf72c90 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -143,6 +143,7 @@ def __init__( session=websession, user_agent=user_agent, debug_locks=debug_locks, + detailed_debug_logging=detailed_debug_logging, ) self._sync_task: asyncio.Task | None = None @@ -305,6 +306,7 @@ def detailed_debug_logging(self, value: bool) -> None: """Set detailed debug logging flag.""" with self._attribute_lock: self._detailed_debug_logging = value + self._pulse_connection.detailed_debug_logging = value async def _update_sites(self, soup: BeautifulSoup) -> None: with self._attribute_lock: diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 2320110..ce0f2ef 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -49,6 +49,7 @@ class ADTPulseConnection: "_last_login_time", "_retry_after", "_authenticated_flag", + "_detailed_debug_logging", ) def __init__( @@ -57,6 +58,7 @@ def __init__( session: ClientSession | None = None, user_agent: str = ADT_DEFAULT_HTTP_HEADERS["User-Agent"], debug_locks: bool = False, + detailed_debug_logging: bool = False, ): """Initialize ADT Pulse connection.""" self._api_host = host @@ -76,6 +78,7 @@ def __init__( self._attribute_lock = DebugRLock("ADTPulseConnection._attribute_lock") self._loop: asyncio.AbstractEventLoop | None = None self._retry_after = int(time.time()) + self._detailed_debug_logging = detailed_debug_logging def __del__(self): """Destructor for ADTPulseConnection.""" @@ -139,6 +142,18 @@ def authenticated_flag(self) -> asyncio.Event: with self._attribute_lock: return self._authenticated_flag + @property + def detailed_debug_logging(self) -> bool: + """Get detailed debug logging.""" + with self._attribute_lock: + return self._detailed_debug_logging + + @detailed_debug_logging.setter + def detailed_debug_logging(self, value: bool) -> None: + """Set detailed debug logging.""" + with self._attribute_lock: + self._detailed_debug_logging = value + def check_sync(self, message: str) -> asyncio.AbstractEventLoop: """Checks if sync login was performed. @@ -243,11 +258,14 @@ async def async_query( headers["Accept"] = "*/*" self._session.headers.update(headers) - - LOG.debug( - "Attempting %s %s params=%s timeout=%d", method, url, extra_params, timeout - ) - + if self.detailed_debug_logging: + LOG.debug( + "Attempting %s %s params=%s timeout=%d", + method, + url, + extra_params, + timeout, + ) retry = 0 response: ClientResponse | None = None while retry < MAX_RETRIES: From 7c17592fd2f2aa9ed8d0898eca4e395f005eab78 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 3 Nov 2023 11:04:41 -0400 Subject: [PATCH 052/226] make private methods public --- pyadtpulse/__init__.py | 12 ++++++------ pyadtpulse/alarm_panel.py | 13 ++++++++++++- pyadtpulse/site.py | 27 +++++++++++++++------------ 3 files changed, 33 insertions(+), 19 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index cf72c90..e606331 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -314,8 +314,8 @@ async def _update_sites(self, soup: BeautifulSoup) -> None: await self._initialize_sites(soup) if self._site is None: raise RuntimeError("pyadtpulse could not retrieve site") - self._site.alarm_control_panel._update_alarm_from_soup(soup) - self._site._update_zone_from_soup(soup) + self._site.alarm_control_panel.update_alarm_from_soup(soup) + self._site.update_zone_from_soup(soup) async def _initialize_sites(self, soup: BeautifulSoup) -> None: """ @@ -342,12 +342,12 @@ async def _initialize_sites(self, soup: BeautifulSoup) -> None: # fetch zones first, so that we can have the status # updated with _update_alarm_status - if not await new_site._fetch_devices(None): + if not await new_site.fetch_devices(None): LOG.error("Could not fetch zones from ADT site") - new_site.alarm_control_panel._update_alarm_from_soup(soup) + new_site.alarm_control_panel.update_alarm_from_soup(soup) if new_site.alarm_control_panel.status == ADT_ALARM_UNKNOWN: new_site.gateway.is_online = False - new_site._update_zone_from_soup(soup) + new_site.update_zone_from_soup(soup) with self._attribute_lock: self._site = new_site return @@ -398,7 +398,7 @@ async def reset_pulse_cloud_timeout() -> ClientResponse | None: async def update_gateway_device_if_needed() -> None: if self.site.gateway.next_update < time.time(): - await self.site._set_device(ADT_GATEWAY_STRING) + await self.site.set_device(ADT_GATEWAY_STRING) def should_relogin(relogin_interval: int) -> bool: return ( diff --git a/pyadtpulse/alarm_panel.py b/pyadtpulse/alarm_panel.py index 63019b5..7149061 100644 --- a/pyadtpulse/alarm_panel.py +++ b/pyadtpulse/alarm_panel.py @@ -265,7 +265,18 @@ async def async_disarm(self, connection: ADTPulseConnection) -> bool: """ return await self._arm(connection, ADT_ALARM_OFF, False) - def _update_alarm_from_soup(self, summary_html_soup: BeautifulSoup) -> None: + def update_alarm_from_soup(self, summary_html_soup: BeautifulSoup) -> None: + """ + Updates the alarm status based on the information extracted from the provided + HTML soup. + + Args: + summary_html_soup (BeautifulSoup): The BeautifulSoup object representing + the HTML soup. + + Returns: + None: This function does not return anything. + """ LOG.debug("Updating alarm status") value = summary_html_soup.find("span", {"class": "p_boldNormalTextLarge"}) sat_location = "security_button_0" diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index c439101..c0bb5f3 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -250,7 +250,7 @@ async def _get_device_attributes(self, device_id: str) -> dict[str, str] | None: result.update({identity_text: value}) return result - async def _set_device(self, device_id: str) -> None: + async def set_device(self, device_id: str) -> None: """ Sets the device attributes for the given device ID. @@ -271,16 +271,18 @@ async def _set_device(self, device_id: str) -> None: else: LOG.debug("Zone %s is not an integer, skipping", device_id) - async def _fetch_devices(self, soup: BeautifulSoup | None) -> bool: + async def fetch_devices(self, soup: BeautifulSoup | None) -> bool: """ - Fetches the devices from the given BeautifulSoup object and updates the zone attributes. + Fetches the devices from the given BeautifulSoup object and updates + the zone attributes. Args: - soup (Optional[BeautifulSoup]): The BeautifulSoup object containing the devices. + soup (Optional[BeautifulSoup]): The BeautifulSoup object containing + the devices. Returns: - bool: True if the devices were fetched and zone attributes were updated successfully, - False otherwise. + bool: True if the devices were fetched and zone attributes were updated + successfully, False otherwise. """ if not soup: response = await self._pulse_connection.async_query(ADT_SYSTEM_URI) @@ -329,7 +331,7 @@ async def _fetch_devices(self, soup: BeautifulSoup | None) -> bool: on_click_value_text in ("goToUrl('gateway.jsp');", "Gateway") or device_name == "Gateway" ): - task_list.append(create_task(self._set_device(ADT_GATEWAY_STRING))) + task_list.append(create_task(self.set_device(ADT_GATEWAY_STRING))) else: result = re.findall(regex_device, on_click_value_text) @@ -340,9 +342,9 @@ async def _fetch_devices(self, soup: BeautifulSoup | None) -> bool: device_id == SECURITY_PANEL_ID or device_name == SECURITY_PANEL_NAME ): - task_list.append(create_task(self._set_device(device_id))) + task_list.append(create_task(self.set_device(device_id))) elif zone_id and zone_id.isdecimal(): - task_list.append(create_task(self._set_device(device_id))) + task_list.append(create_task(self.set_device(device_id))) else: LOG.debug( "Skipping %s as it doesn't have an ID", device_name @@ -373,9 +375,9 @@ async def _async_update_zones_as_dict( ) if soup is None: return None - return self._update_zone_from_soup(soup) + return self.update_zone_from_soup(soup) - def _update_zone_from_soup(self, soup: BeautifulSoup) -> ADTPulseZones | None: + def update_zone_from_soup(self, soup: BeautifulSoup) -> ADTPulseZones | None: """ Updates the zone information based on the provided BeautifulSoup object. @@ -383,7 +385,8 @@ def _update_zone_from_soup(self, soup: BeautifulSoup) -> ADTPulseZones | None: soup (BeautifulSoup): The BeautifulSoup object containing the parsed HTML. Returns: - Optional[ADTPulseZones]: The updated ADTPulseZones object, or None if no zones exist. + Optional[ADTPulseZones]: The updated ADTPulseZones object, or None if + no zones exist. """ # parse ADT's convulated html to get sensor status with self._site_lock: From a4097276e4d0a6b91221b313b897ddb82b420818 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 3 Nov 2023 12:30:50 -0400 Subject: [PATCH 053/226] fix parse_pulse_datetime --- pyadtpulse/util.py | 5 ----- 1 file changed, 5 deletions(-) diff --git a/pyadtpulse/util.py b/pyadtpulse/util.py index ecc09c3..0b0d8db 100644 --- a/pyadtpulse/util.py +++ b/pyadtpulse/util.py @@ -228,11 +228,6 @@ def parse_pulse_datetime(datestring: str) -> datetime: """ datestring = datestring.replace("\xa0", " ").rstrip() split_string = [s for s in datestring.split(" ") if s.strip()] - if len(split_string) >= 2: - last_word = split_string[-1] - if last_word[-2:] in ("AM", "PM"): - split_string[-1] = last_word[:-2] - split_string.append(last_word[-2:]) if len(split_string) < 3: raise ValueError("Invalid datestring") t = datetime.today() From b48bacbd7948acc158c77938c53239e96cf7d690 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 3 Nov 2023 20:09:55 -0400 Subject: [PATCH 054/226] fix _compute_login_backoff --- pyadtpulse/__init__.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index e606331..1b15f7d 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -588,9 +588,12 @@ def handle_updates_exist() -> bool: return def _compute_login_backoff(self) -> float: + if self._current_relogin_retry_count == 0: + return 0.0 return min( ADT_MAX_RELOGIN_BACKOFF, - self.site.gateway.poll_interval * (2 ^ self._current_relogin_retry_count), + self.site.gateway.poll_interval + * (2 ^ (self._current_relogin_retry_count - 1)), ) def _pulse_session_thread(self) -> None: From b724a87462826736c18f08e58b5712110e793889 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 3 Nov 2023 21:27:25 -0400 Subject: [PATCH 055/226] rework _do_relogin_with_backoff --- pyadtpulse/__init__.py | 87 +++++++++++++++++++++++------------------- 1 file changed, 48 insertions(+), 39 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 1b15f7d..39718f8 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -43,6 +43,7 @@ SYNC_CHECK_TASK_NAME = "ADT Pulse Sync Check Task" KEEPALIVE_TASK_NAME = "ADT Pulse Keepalive Task" +RELOGIN_BACKOFF_WARNING_THRESHOLD = 5.0 * 60.0 class PyADTPulse: @@ -65,7 +66,6 @@ class PyADTPulse: "_keepalive_interval", "_update_succeded", "_detailed_debug_logging", - "_current_relogin_retry_count", ) @staticmethod @@ -167,7 +167,6 @@ def __init__( self.relogin_interval = relogin_interval self._detailed_debug_logging = detailed_debug_logging self._update_succeded = True - self._current_relogin_retry_count = 0 # authenticate the user if do_login and websession is None: @@ -424,8 +423,8 @@ def should_relogin(relogin_interval: int) -> bool: LOG.debug("%s: Skipping relogin because not connected", task_name) continue elif should_relogin(relogin_interval): - LOG.debug("%s relogging in", task_name) - await self._do_logout_and_relogin() + await self.async_logout() + await self._do_login_with_backoff(task_name) continue LOG.debug("Resetting timeout") response = await reset_pulse_cloud_timeout() @@ -462,24 +461,47 @@ async def _cancel_task(self, task: asyncio.Task | None) -> None: LOG.debug("%s successfully cancelled", task_name) await task - async def _do_logout_and_relogin(self) -> bool: + def _set_update_status(self, value: bool) -> None: + """Sets update failed, sets updates_exist to notify wait_for_update.""" + with self._attribute_lock: + self._update_succeded = value + if self._updates_exist is not None and not self._updates_exist.is_set(): + self._updates_exist.set() + + async def _do_login_with_backoff(self, task_name: str) -> None: """ Performs a logout and re-login process. Args: None. Returns: - bool: True if the re-login process is successful, False otherwise. - """ - await self.async_logout() - if self._current_relogin_retry_count != 0: - await asyncio.sleep(self._compute_login_backoff()) - retval = await self.async_login() - if retval: - self._current_relogin_retry_count = 0 - else: - self._current_relogin_retry_count += 1 - return retval + None + """ + log_level = logging.DEBUG + login_backoff = 0.0 + login_successful = False + + def compute_login_backoff() -> float: + if login_backoff == 0.0: + return self.site.gateway.poll_interval + return min(ADT_MAX_RELOGIN_BACKOFF, login_backoff * 2.0) + + while not login_successful: + LOG.log( + log_level, "%s logging in with backoff %f", task_name, login_backoff + ) + await asyncio.sleep(login_backoff) + login_successful = await self.async_login() + if login_successful: + if login_backoff != 0.0: + self._set_update_status(True) + return + # only set flag on first failure + if login_backoff == 0.0: + self._set_update_status(False) + login_backoff = compute_login_backoff() + if login_backoff > RELOGIN_BACKOFF_WARNING_THRESHOLD: + log_level = logging.WARNING async def _sync_check_task(self) -> None: """Asynchronous function that performs a synchronization check task.""" @@ -489,13 +511,6 @@ async def perform_sync_check_query(): ADT_SYNC_CHECK_URI, extra_params={"ts": str(int(time.time() * 1000))} ) - def set_update_failed() -> None: - """Sets update failed, sets updates_exist to notify wait_for_update.""" - with self._attribute_lock: - self._update_succeded = False - if self._updates_exist is not None: - self._updates_exist.set() - task_name = self._get_sync_task_name() LOG.debug("creating %s", task_name) @@ -510,21 +525,19 @@ async def validate_sync_check_response() -> bool: bool: True if the sync check response is valid, False otherwise. """ if not handle_response(response, logging.ERROR, "Error querying ADT sync"): - set_update_failed() + self._set_update_status(False) close_response(response) return False close_response(response) pattern = r"\d+[-]\d+[-]\d+" if not re.match(pattern, text): LOG.warning( - "Unexpected sync check format (%s), " - "forcing re-auth after %f seconds", + "Unexpected sync check format (%s), " "forcing re-auth", text, - self._compute_login_backoff(), ) LOG.debug("Received %s from ADT Pulse site", text) - await self._do_logout_and_relogin() - set_update_failed() + await self.async_logout() + await self._do_login_with_backoff(task_name) return False return True @@ -563,6 +576,8 @@ def handle_updates_exist() -> bool: task_name, datetime.fromtimestamp(retry_after), ) + self._set_update_status(False) + await asyncio.sleep(retry_after - time.time()) continue await asyncio.sleep(pi) @@ -587,15 +602,6 @@ def handle_updates_exist() -> bool: close_response(response) return - def _compute_login_backoff(self) -> float: - if self._current_relogin_retry_count == 0: - return 0.0 - return min( - ADT_MAX_RELOGIN_BACKOFF, - self.site.gateway.poll_interval - * (2 ^ (self._current_relogin_retry_count - 1)), - ) - def _pulse_session_thread(self) -> None: """ Pulse the session thread. @@ -836,7 +842,10 @@ def is_connected(self) -> bool: Returns: bool: True if connected """ - return self._pulse_connection.authenticated_flag.is_set() + return ( + self._pulse_connection.authenticated_flag.is_set() + and self._pulse_connection.retry_after < time.time() + ) async def async_update(self) -> bool: """Update ADT Pulse data. From 86f9f72715694a4b89e7608d42b1834d72db9ce2 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 4 Nov 2023 02:53:24 -0400 Subject: [PATCH 056/226] move _check_service_host to pulse_connection --- pyadtpulse/__init__.py | 11 ----------- pyadtpulse/pulse_connection.py | 12 ++++++++++++ 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 39718f8..9b95ca4 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -26,7 +26,6 @@ ADT_SUMMARY_URI, ADT_SYNC_CHECK_URI, ADT_TIMEOUT_URI, - API_HOST_CA, DEFAULT_API_HOST, ) from pyadtpulse.pulse_connection import ADTPulseConnection @@ -68,15 +67,6 @@ class PyADTPulse: "_detailed_debug_logging", ) - @staticmethod - def _check_service_host(service_host: str) -> None: - if service_host is None or service_host == "": - raise ValueError("Service host is mandatory") - if service_host not in (DEFAULT_API_HOST, API_HOST_CA): - raise ValueError( - "Service host must be one of {DEFAULT_API_HOST}" f" or {API_HOST_CA}" - ) - @staticmethod def _check_keepalive_interval(keepalive_interval: int) -> None: if keepalive_interval > ADT_MAX_KEEPALIVE_INTERVAL or keepalive_interval <= 0: @@ -136,7 +126,6 @@ def __init__( minimum is ADT_MIN_RELOGIN_INTERVAL detailed_debug_logging (bool, optional): enable detailed debug logging """ - self._check_service_host(service_host) self._init_login_info(username, password, fingerprint) self._pulse_connection = ADTPulseConnection( service_host, diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index ce0f2ef..b1c2f27 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -24,7 +24,9 @@ ADT_LOGIN_URI, ADT_LOGOUT_URI, ADT_ORB_URI, + API_HOST_CA, API_PREFIX, + DEFAULT_API_HOST, ) from pyadtpulse.util import DebugRLock, close_response, handle_response, make_soup @@ -52,6 +54,15 @@ class ADTPulseConnection: "_detailed_debug_logging", ) + @staticmethod + def _check_service_host(service_host: str) -> None: + if service_host is None or service_host == "": + raise ValueError("Service host is mandatory") + if service_host not in (DEFAULT_API_HOST, API_HOST_CA): + raise ValueError( + "Service host must be one of {DEFAULT_API_HOST}" f" or {API_HOST_CA}" + ) + def __init__( self, host: str, @@ -61,6 +72,7 @@ def __init__( detailed_debug_logging: bool = False, ): """Initialize ADT Pulse connection.""" + self._check_service_host(host) self._api_host = host self._allocated_session = False self._authenticated_flag = asyncio.Event() From 91e3e101142351dcb9e95385c91b67cccf4778fa Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 4 Nov 2023 03:39:28 -0400 Subject: [PATCH 057/226] add pulse_connection tests --- pyadtpulse/tests/test_pulse_connection.py | 412 ++++++++++++++++++++++ 1 file changed, 412 insertions(+) create mode 100644 pyadtpulse/tests/test_pulse_connection.py diff --git a/pyadtpulse/tests/test_pulse_connection.py b/pyadtpulse/tests/test_pulse_connection.py new file mode 100644 index 0000000..7859b7a --- /dev/null +++ b/pyadtpulse/tests/test_pulse_connection.py @@ -0,0 +1,412 @@ +# Generated by CodiumAI +import asyncio +import time + +import pytest +from aiohttp import ClientConnectionError, ClientResponseError + +from pyadtpulse.const import ( + ADT_DEFAULT_VERSION, + ADT_LOGIN_URI, + ADT_LOGOUT_URI, + ADT_ORB_URI, + API_HOST_CA, + API_PREFIX, + DEFAULT_API_HOST, +) +from pyadtpulse.pulse_connection import ADTPulseConnection + + +class TestADTPulseConnection: + # can initialize ADTPulseConnection with valid service host and user agent + def test_initialize_with_valid_service_host_and_user_agent(self): + host = DEFAULT_API_HOST + user_agent = "Test User Agent" + connection = ADTPulseConnection(host, user_agent=user_agent) + + assert connection.service_host == host + assert connection._session.headers["User-Agent"] == user_agent + + # can set and get service host + def test_set_and_get_service_host(self): + host = DEFAULT_API_HOST + connection = ADTPulseConnection(host) + + new_host = API_HOST_CA + connection.service_host = new_host + + assert connection.service_host == new_host + + # can set and get event loop + def test_set_and_get_event_loop(self): + host = DEFAULT_API_HOST + connection = ADTPulseConnection(host) + + loop = asyncio.get_event_loop() + connection.loop = loop + + assert connection.loop == loop + + # can get last login time + def test_get_last_login_time(self): + host = DEFAULT_API_HOST + connection = ADTPulseConnection(host) + + assert connection.last_login_time == 0 + + # can set and get retry after time + def test_set_and_get_retry_after_time(self): + connection = ADTPulseConnection(DEFAULT_API_HOST) + + retry_after = int(time.time()) + 60 + connection.retry_after = retry_after + + assert connection.retry_after == retry_after + + # can get authenticated flag + def test_get_authenticated_flag(self): + host = DEFAULT_API_HOST + connection = ADTPulseConnection(host) + + assert not connection.authenticated_flag.is_set() + + # raises ValueError if service host is None or empty string + def test_raises_value_error_if_service_host_is_none_or_empty_string(self): + with pytest.raises(ValueError): + ADTPulseConnection(None) + + with pytest.raises(ValueError): + ADTPulseConnection("") + + # raises ValueError if service host is not DEFAULT_API_HOST or API_HOST_CA + def test_raises_value_error_if_service_host_is_not_default_api_host_or_api_host_ca( + self, + ): + with pytest.raises(ValueError): + ADTPulseConnection("example.com") + + with pytest.raises(ValueError): + ADTPulseConnection("api.example.com") + + # raises ValueError if retry_after is less than current time + def test_raises_value_error_if_retry_after_is_less_than_current_time(self): + host = DEFAULT_API_HOST + connection = ADTPulseConnection(host) + + with pytest.raises(ValueError): + connection.retry_after = int(time.time()) - 60 + + # can make url with given uri using a valid host + def test_make_url_with_given_uri_with_valid_host(self): + host = DEFAULT_API_HOST + connection = ADTPulseConnection(host) + uri = "/api/v1/status" + expected_url = f"{host}/myhome/{ADTPulseConnection._api_version}{uri}" + + url = connection.make_url(uri) + + assert url == expected_url + + # can set and get detailed debug logging + def test_set_and_get_detailed_debug_logging(self): + connection = ADTPulseConnection(DEFAULT_API_HOST) + + assert connection.detailed_debug_logging == False + + connection.detailed_debug_logging = True + assert connection.detailed_debug_logging == True + + connection.detailed_debug_logging = False + assert connection.detailed_debug_logging == False + + # can do logout query with valid site_id + @pytest.mark.asyncio + async def test_logout_query_with_valid_site_id_fixed(self, mocker): + # Mock the async_query method + mocker.patch.object(ADTPulseConnection, "async_query") + connection = ADTPulseConnection(DEFAULT_API_HOST) + + # Set up mock response + response = mocker.Mock() + response.status = 200 + ADTPulseConnection.async_query.return_value = response + + # Call the logout query method + await connection.async_do_logout_query("site_id") + + # Assert that the async_query method was called with the correct parameters + ADTPulseConnection.async_query.assert_called_once_with( + ADT_LOGOUT_URI, + extra_params={"network": "site_id", "partner": "adt"}, + timeout=10, + requires_authentication=False, + ) + + # Assert that the authenticated_flag was cleared + assert not connection.authenticated_flag.is_set() + + # can fetch api version with the recommended fix + @pytest.mark.asyncio + async def test_fetch_api_version_with_fix(self, mocker): + # Mock the session and response objects + session_mock = mocker.Mock() + response_mock = mocker.Mock() + response_mock.status = 200 + response_mock.real_url.path = "/myhome/1.0.0/" + + # Mock the __aenter__ and __aexit__ methods of the response object + response_mock.__aenter__ = mocker.AsyncMock(return_value=response_mock) + response_mock.__aexit__ = mocker.AsyncMock() + + # Mock the session request method to return the mocked response + session_mock.request.return_value = response_mock + + # Create an instance of ADTPulseConnection with the mocked session + connection = ADTPulseConnection(DEFAULT_API_HOST, session=session_mock) + + # Call the async_fetch_version method + await connection.async_fetch_version() + + # Assert that the api_version is updated correctly + assert connection.api_version == "1.0.0" + assert connection.service_host == DEFAULT_API_HOST + assert connection._session.headers["Host"] == f"{DEFAULT_API_HOST}/myhome/1.0.0" + + # Assert that the session request method was called with the correct arguments + session_mock.request.assert_called_once_with( + "GET", + f"{DEFAULT_API_HOST}/myhome/1.0.0", + headers={"Accept": "application/json"}, + params=None, + data=None, + timeout=1, + ) + + # can do login query with valid credentials with fixed host + @pytest.mark.asyncio + async def test_login_query_with_valid_credentials_with_fixed_host(self, mocker): + # Mock the necessary dependencies + session_mock = mocker.AsyncMock() + response_mock = mocker.AsyncMock() + response_mock.status = 200 + response_mock.headers = {"Retry-After": "10"} + response_mock.real_url.path = "/myhome/1.0/" + session_mock.request.return_value.__aenter__.return_value = response_mock + + # Create an instance of ADTPulseConnection with fixed host + connection = ADTPulseConnection(DEFAULT_API_HOST, session=session_mock) + + # Set the authenticated flag to True + connection._authenticated_flag.set() + + # Mock the make_soup function + make_soup_mock = mocker.patch("pyadtpulse.util.make_soup") + make_soup_mock.return_value = None + + # Call the async_query method with valid credentials + result = await connection.async_query( + ADT_LOGIN_URI, + method="POST", + extra_params={ + "partner": "adt", + "e": "ns", + "usernameForm": "test_user", + "passwordForm": "test_password", + "fingerprint": "test_fingerprint", + "sun": "yes", + }, + timeout=1, + requires_authentication=False, + ) + + # Assert that the session request method was called with the correct parameters + session_mock.request.assert_called_once_with( + "POST", + f"{DEFAULT_API_HOST}/myhome/login.jsp", + headers=None, + params={ + "partner": "adt", + "e": "ns", + "usernameForm": "test_user", + "passwordForm": "test_password", + "fingerprint": "test_fingerprint", + "sun": "yes", + }, + data={ + "partner": "adt", + "e": "ns", + "usernameForm": "test_user", + "passwordForm": "test_password", + "fingerprint": "test_fingerprint", + "sun": "yes", + }, + timeout=1, + ) + + # Assert that the response status is 200 + assert result.status == 200 + + # Assert that the make_soup function was called with the correct parameters + make_soup_mock.assert_called_once_with(response_mock, mocker.ANY, mocker.ANY) + + # raises ClientConnectionError if async_fetch_version fails + @pytest.mark.asyncio + async def test_async_fetch_version_raises_error_fixed_fixed(self, mocker): + # Mock the session object + session_mock = mocker.Mock() + session_mock.get.side_effect = ClientConnectionError() + + # Create an instance of ADTPulseConnection with the mocked session + connection = ADTPulseConnection(DEFAULT_API_HOST, session=session_mock) + + # Call async_fetch_version + await connection.async_fetch_version() + + # Assert that the api_version remains at its default value + assert connection.api_version == ADT_DEFAULT_VERSION + + # Raises RuntimeError if async_query is called from sync context with a valid service host + @pytest.mark.asyncio + async def test_raises_runtime_error_if_async_query_called_from_sync_context_with_valid_service_host( + self, mocker + ): + # Mock the check_sync method to return a loop + mocker.patch.object( + ADTPulseConnection, "check_sync", return_value=asyncio.get_event_loop() + ) + + # Create an instance of ADTPulseConnection with a valid service host + connection = ADTPulseConnection(DEFAULT_API_HOST) + + # Call the async_query method from a sync context and assert that it raises a RuntimeError + with pytest.raises(RuntimeError): + connection.query("uri") + + # async_do_logout_query does not raise an error with a valid service host + @pytest.mark.asyncio + async def test_async_do_logout_query_with_valid_service_host(self, mocker): + # Mock the async_query method to return None + mocker.patch.object(ADTPulseConnection, "async_query", return_value=None) + + # Create an instance of ADTPulseConnection with a valid service host + connection = ADTPulseConnection(DEFAULT_API_HOST) + + # Call async_do_logout_query and assert that it does not raise an error + await connection.async_do_logout_query("site_id") + + # raises RuntimeError if loop is None with a valid service host + @pytest.mark.asyncio + async def test_raises_runtime_error_if_loop_is_none_with_valid_service_host(self): + connection = ADTPulseConnection(DEFAULT_API_HOST) + connection.loop = None + + with pytest.raises(RuntimeError): + connection.check_sync("Test message") + + # can set and get allocated session + def test_set_and_get_allocated_session(self): + host = DEFAULT_API_HOST + connection = ADTPulseConnection(host) + + assert connection._allocated_session == True + assert connection._session is not None + + session = connection._session + connection._allocated_session = False + + assert connection._allocated_session == False + assert connection._session == session + + # raises Exception if async_do_login_query fails + @pytest.mark.asyncio + async def test_async_do_login_query_failure(self, mocker): + # Mock the async_query method to raise an exception + mocker.patch.object( + ADTPulseConnection, + "async_query", + side_effect=Exception("Async query failed"), + ) + + # Create an instance of ADTPulseConnection + connection = ADTPulseConnection(DEFAULT_API_HOST) + + # Call async_do_login_query and assert that it returns None + assert ( + await connection.async_do_login_query("username", "password", "fingerprint") + is None + ) + + # can make url with given uri + def test_make_url_with_given_uri(self): + host = DEFAULT_API_HOST + connection = ADTPulseConnection(host) + + uri = "/test" + expected_url = f"{host}{API_PREFIX}{ADTPulseConnection._api_version}{uri}" + + assert connection.make_url(uri) == expected_url + + # can fetch api version with async mock (fixed) + @pytest.mark.asyncio + async def test_fetch_api_version_with_async_mock_fixed(self, mocker): + host = DEFAULT_API_HOST + connection = ADTPulseConnection(host) + + response_mock = mocker.AsyncMock() + response_mock.real_url.path = "/myhome/v1/" + mocker.patch.object(response_mock, "__aenter__", return_value=response_mock) + + session_mock = mocker.Mock() + session_mock.get.return_value = response_mock + connection._session = session_mock + + await connection.async_fetch_version() + + assert ADTPulseConnection._api_version == "24.0.0-117" + + # can do login query with valid credentials + @pytest.mark.asyncio + async def test_do_login_query_with_valid_credentials(self, mocker): + host = DEFAULT_API_HOST + connection = ADTPulseConnection(host) + + response_mock = mocker.MagicMock() + response_mock.__enter__.return_value = response_mock + + session_mock = mocker.MagicMock() + session_mock.request.return_value = response_mock + connection._session = session_mock + + username = "test_user" + password = "test_password" + fingerprint = "test_fingerprint" + + await connection.async_do_login_query(username, password, fingerprint) + + assert connection.authenticated_flag.is_set() + + # raises RuntimeError if loop is None + def test_raises_runtime_error_if_loop_is_none(self): + connection = ADTPulseConnection(DEFAULT_API_HOST) + connection.loop = None + + with pytest.raises(RuntimeError): + connection.check_sync("Loop is None") + + # raises ClientResponseError if async_fetch_version fails + @pytest.mark.asyncio + async def test_raises_client_response_error_if_async_fetch_version_fails( + self, mocker + ): + connection = ADTPulseConnection(DEFAULT_API_HOST) + mocker.patch.object(connection, "async_query", side_effect=ClientResponseError) + + with pytest.raises(ClientResponseError): + await connection.async_fetch_version() + + # raises RuntimeError if async_query is called from sync context + def test_raises_runtime_error_if_async_query_called_from_sync_context(self): + connection = ADTPulseConnection(DEFAULT_API_HOST) + + with pytest.raises(RuntimeError): + connection.query(ADT_ORB_URI) From 97d6e39c97bc6417164c307c918bd453190c076a Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 6 Nov 2023 00:44:24 -0500 Subject: [PATCH 058/226] move check_service_host to pulse_connection --- pyadtpulse/__init__.py | 4 ++-- pyadtpulse/pulse_connection.py | 7 ++++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 9b95ca4..8ea04c3 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -201,7 +201,7 @@ def service_host(self, host: str) -> None: Args: host (str): name of Pulse endpoint host """ - self._check_service_host(host) + self._pulse_connection.check_service_host(host) with self._attribute_lock: self._pulse_connection.service_host = host @@ -521,7 +521,7 @@ async def validate_sync_check_response() -> bool: pattern = r"\d+[-]\d+[-]\d+" if not re.match(pattern, text): LOG.warning( - "Unexpected sync check format (%s), " "forcing re-auth", + "Unexpected sync check format (%s), forcing re-auth", text, ) LOG.debug("Received %s from ADT Pulse site", text) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index b1c2f27..abefa94 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -55,12 +55,13 @@ class ADTPulseConnection: ) @staticmethod - def _check_service_host(service_host: str) -> None: + def check_service_host(service_host: str) -> None: + """Check if service host is valid.""" if service_host is None or service_host == "": raise ValueError("Service host is mandatory") if service_host not in (DEFAULT_API_HOST, API_HOST_CA): raise ValueError( - "Service host must be one of {DEFAULT_API_HOST}" f" or {API_HOST_CA}" + f"Service host must be one of {DEFAULT_API_HOST}" f" or {API_HOST_CA}" ) def __init__( @@ -72,7 +73,7 @@ def __init__( detailed_debug_logging: bool = False, ): """Initialize ADT Pulse connection.""" - self._check_service_host(host) + self.check_service_host(host) self._api_host = host self._allocated_session = False self._authenticated_flag = asyncio.Event() From 6f65601fa1587d6341101531a8bb8ad7ced37568 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 6 Nov 2023 14:29:21 -0500 Subject: [PATCH 059/226] test fixes --- pyadtpulse/tests/test_alarm_panel.py | 211 +--------------------- pyadtpulse/tests/test_pulse_connection.py | 43 +++-- pyproject.toml | 3 + 3 files changed, 30 insertions(+), 227 deletions(-) diff --git a/pyadtpulse/tests/test_alarm_panel.py b/pyadtpulse/tests/test_alarm_panel.py index 26bbf2b..da20196 100644 --- a/pyadtpulse/tests/test_alarm_panel.py +++ b/pyadtpulse/tests/test_alarm_panel.py @@ -1,95 +1,14 @@ -# Generated by CodiumAI - -import logging -import asyncio -import time -from threading import RLock +# Initially Generated by CodiumAI # Dependencies: # pip install pytest-mock import pytest -from bs4 import BeautifulSoup -from pyadtpulse.alarm_panel import ( - ADT_ALARM_ARMING, - ADT_ALARM_AWAY, - ADT_ALARM_HOME, - ADT_ALARM_OFF, - ADTPulseAlarmPanel, -) -from pyadtpulse.const import ADT_ARM_DISARM_URI -from pyadtpulse.pulse_connection import ADTPulseConnection +from pyadtpulse.alarm_panel import ADT_ALARM_AWAY, ADTPulseAlarmPanel class TestADTPulseAlarmPanel: # ADTPulseAlarmPanel object is created with default values - def test_default_values(self): - alarm_panel = ADTPulseAlarmPanel() - assert alarm_panel.model == "Unknown" - assert alarm_panel._sat == "" - assert alarm_panel._status == "Unknown" - assert alarm_panel.manufacturer == "ADT" - assert alarm_panel.online == True - assert alarm_panel._is_force_armed == False - assert isinstance(alarm_panel._state_lock, RLock) - assert alarm_panel._last_arm_disarm == int(time()) - - # ADTPulseAlarmPanel status is updated correctly after arming/disarming - def test_status_update(self, mocker): - alarm_panel = ADTPulseAlarmPanel() - connection_mock = mocker.Mock() - connection_mock.async_query.return_value = "response" - make_soup_mock = mocker.patch("pyadpulse.alarm_panel.make_soup") - make_soup_mock.return_value = "soup" - alarm_panel._status = ADT_ALARM_OFF - alarm_panel._arm(connection_mock, ADT_ALARM_AWAY, False) - connection_mock.async_query.assert_called_once_with( - ADT_ARM_DISARM_URI, - method="POST", - extra_params={ - "href": "rest/adt/ui/client/security/setArmState", - "armstate": ADT_ALARM_OFF, - "arm": ADT_ALARM_AWAY, - "sat": "", - }, - timeout=10, - ) - make_soup_mock.assert_called_once_with( - "response", - logging.WARNING, - f"Failed updating ADT Pulse alarm {alarm_panel._sat} to {ADT_ALARM_AWAY}", - ) - assert alarm_panel._status == ADT_ALARM_ARMING - assert alarm_panel._last_arm_disarm == int(time()) - - # ADTPulseAlarmPanel is force armed and disarmed correctly - def test_force_arm_disarm(self, mocker): - alarm_panel = ADTPulseAlarmPanel() - connection_mock = mocker.Mock() - connection_mock.async_query.return_value = "response" - make_soup_mock = mocker.patch("pyadpulse.alarm_panel.make_soup") - make_soup_mock.return_value = "soup" - alarm_panel._status = ADT_ALARM_OFF - alarm_panel._arm(connection_mock, ADT_ALARM_AWAY, True) - connection_mock.async_query.assert_called_once_with( - ADT_ARM_DISARM_URI, - method="POST", - extra_params={ - "href": "rest/adt/ui/client/security/setForceArm", - "armstate": "forcearm", - "arm": ADT_ALARM_AWAY, - "sat": "", - }, - timeout=10, - ) - make_soup_mock.assert_called_once_with( - "response", - logging.WARNING, - f"Failed updating ADT Pulse alarm {alarm_panel._sat} to {ADT_ALARM_AWAY}", - ) - assert alarm_panel._status == ADT_ALARM_ARMING - assert alarm_panel._is_force_armed == True - assert alarm_panel._last_arm_disarm == int(time()) # ADTPulseAlarmPanel attributes are set correctly def test_set_attributes(self): @@ -104,132 +23,6 @@ def test_set_attributes(self): assert alarm_panel.manufacturer == "Manufacturer" assert alarm_panel.online == True - # ADTPulseAlarmPanel is updated correctly from HTML soup - def test_update_from_soup(self, mocker): - alarm_panel = ADTPulseAlarmPanel() - summary_html_soup_mock = mocker.Mock() - value_mock = mocker.Mock() - value_mock.text = "Armed Away" - summary_html_soup_mock.find.return_value = value_mock - alarm_panel._update_alarm_from_soup(summary_html_soup_mock) - assert alarm_panel._status == ADT_ALARM_AWAY - assert alarm_panel._last_arm_disarm == int(time()) - - # ADTPulseAlarmPanel is already in the requested status - def test_already_in_requested_status(self, mocker): - alarm_panel = ADTPulseAlarmPanel() - connection_mock = mocker.Mock() - connection_mock.async_query.return_value = "response" - make_soup_mock = mocker.patch("pyadpulse.alarm_panel.make_soup") - make_soup_mock.return_value = "soup" - alarm_panel._status = ADT_ALARM_AWAY - result = alarm_panel._arm(connection_mock, ADT_ALARM_AWAY, False) - assert result == False - connection_mock.async_query.assert_not_called() - make_soup_mock.assert_not_called() - assert alarm_panel._status == ADT_ALARM_AWAY - assert alarm_panel._last_arm_disarm == int(time()) - - # ADTPulseAlarmPanel is already armed and another arm request is made - def test_already_armed_and_arm_request(self, mocker): - alarm_panel = ADTPulseAlarmPanel() - connection_mock = mocker.Mock() - connection_mock.async_query.return_value = "response" - make_soup_mock = mocker.patch("pyadpulse.alarm_panel.make_soup") - make_soup_mock.return_value = "soup" - alarm_panel._status = ADT_ALARM_AWAY - result = alarm_panel._arm(connection_mock, ADT_ALARM_HOME, False) - assert result == False - connection_mock.async_query.assert_not_called() - make_soup_mock.assert_not_called() - assert alarm_panel._status == ADT_ALARM_AWAY - assert alarm_panel._last_arm_disarm == int(time()) - - # ADTPulseAlarmPanel is already disarmed and another disarm request is made - def test_already_disarmed_and_disarm_request(self, mocker): - alarm_panel = ADTPulseAlarmPanel() - connection_mock = mocker.Mock() - connection_mock.async_query.return_value = "response" - assert False - - # ADTPulseAlarmPanel is unable to extract sat - @pytest.mark.asyncio - async def test_unable_to_extract_sat(self, mocker): - # Mock the dependencies - mocker.patch("pyadpulse.adt_pulse_alarm_panel.make_soup", return_value=None) - - # Create an instance of ADTPulseAlarmPanel - alarm_panel = ADTPulseAlarmPanel() - - # Call the method that should extract sat - alarm_panel._update_alarm_from_soup(BeautifulSoup()) - - # Assert that the sat is still empty - assert alarm_panel._sat == "" - - # ADTPulseAlarmPanel is unable to set alarm status - @pytest.mark.asyncio - async def test_unable_to_set_alarm_status(self, mocker): - # Mock the dependencies - mocker.patch( - "pyadpulse.adt_pulse_alarm_panel.make_soup", return_value=BeautifulSoup() - ) - mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ARM_DISARM_URI") - mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_OFF", "OFF") - mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_ARMING", "ARMING") - - # Create an instance of ADTPulseAlarmPanel - alarm_panel = ADTPulseAlarmPanel() - - # Call the method that should set the alarm status - await alarm_panel._arm(ADTPulseConnection(), "OFF", False) - - # Assert that the status is still unknown - assert alarm_panel._status == "Unknown" - - # ADTPulseAlarmPanel is able to handle concurrent requests - @pytest.mark.asyncio - async def test_concurrent_requests(self, mocker): - # Mock the dependencies - mocker.patch( - "pyadpulse.adt_pulse_alarm_panel.make_soup", return_value=BeautifulSoup() - ) - mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ARM_DISARM_URI") - mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_OFF", "OFF") - mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_ARMING", "ARMING") - - # Create an instance of ADTPulseAlarmPanel - alarm_panel = ADTPulseAlarmPanel() - - # Call the method that should set the alarm status concurrently - await asyncio.gather( - alarm_panel._arm(ADTPulseConnection(), "OFF", False), - alarm_panel._arm(ADTPulseConnection(), "ARMING", False), - ) - - # Assert that the status is updated correctly - assert alarm_panel._status == "ARMING" - - # ADTPulseAlarmPanel is able to handle invalid input - def test_handle_invalid_input(self, mocker): - # Mock dependencies - mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ARM_DISARM_URI") - mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_AWAY") - mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_HOME") - mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_OFF") - mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_UNKNOWN") - mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_ARMING") - mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ALARM_DISARMING") - mocker.patch("pyadpulse.adt_pulse_alarm_panel.ADT_ARM_DISARM_TIMEOUT") - - # Create instance of ADTPulseAlarmPanel - alarm_panel = ADTPulseAlarmPanel() - - # Test invalid input - assert alarm_panel.arm_away(None) == False - assert alarm_panel.arm_home(None) == False - assert alarm_panel.disarm(None) == False - # ADTPulseAlarmPanel is able to handle connection errors @pytest.mark.asyncio async def test_handle_connection_errors(self, mocker): diff --git a/pyadtpulse/tests/test_pulse_connection.py b/pyadtpulse/tests/test_pulse_connection.py index 7859b7a..60a2580 100644 --- a/pyadtpulse/tests/test_pulse_connection.py +++ b/pyadtpulse/tests/test_pulse_connection.py @@ -28,7 +28,8 @@ def test_initialize_with_valid_service_host_and_user_agent(self): assert connection._session.headers["User-Agent"] == user_agent # can set and get service host - def test_set_and_get_service_host(self): + @pytest.mark.asyncio + async def test_set_and_get_service_host(self): host = DEFAULT_API_HOST connection = ADTPulseConnection(host) @@ -38,7 +39,8 @@ def test_set_and_get_service_host(self): assert connection.service_host == new_host # can set and get event loop - def test_set_and_get_event_loop(self): + @pytest.mark.asyncio + async def test_set_and_get_event_loop(self): host = DEFAULT_API_HOST connection = ADTPulseConnection(host) @@ -48,14 +50,16 @@ def test_set_and_get_event_loop(self): assert connection.loop == loop # can get last login time - def test_get_last_login_time(self): + @pytest.mark.asyncio + async def test_get_last_login_time(self): host = DEFAULT_API_HOST connection = ADTPulseConnection(host) assert connection.last_login_time == 0 # can set and get retry after time - def test_set_and_get_retry_after_time(self): + @pytest.mark.asyncio + async def test_set_and_get_retry_after_time(self): connection = ADTPulseConnection(DEFAULT_API_HOST) retry_after = int(time.time()) + 60 @@ -64,14 +68,16 @@ def test_set_and_get_retry_after_time(self): assert connection.retry_after == retry_after # can get authenticated flag - def test_get_authenticated_flag(self): + @pytest.mark.asyncio + async def test_get_authenticated_flag(self): host = DEFAULT_API_HOST connection = ADTPulseConnection(host) assert not connection.authenticated_flag.is_set() # raises ValueError if service host is None or empty string - def test_raises_value_error_if_service_host_is_none_or_empty_string(self): + @pytest.mark.asyncio + async def test_raises_value_error_if_service_host_is_none_or_empty_string(self): with pytest.raises(ValueError): ADTPulseConnection(None) @@ -79,7 +85,8 @@ def test_raises_value_error_if_service_host_is_none_or_empty_string(self): ADTPulseConnection("") # raises ValueError if service host is not DEFAULT_API_HOST or API_HOST_CA - def test_raises_value_error_if_service_host_is_not_default_api_host_or_api_host_ca( + @pytest.mark.asyncio + async def test_raises_value_error_if_service_host_is_not_default_api_host_or_api_host_ca( self, ): with pytest.raises(ValueError): @@ -89,7 +96,8 @@ def test_raises_value_error_if_service_host_is_not_default_api_host_or_api_host_ ADTPulseConnection("api.example.com") # raises ValueError if retry_after is less than current time - def test_raises_value_error_if_retry_after_is_less_than_current_time(self): + @pytest.mark.asyncio + async def test_raises_value_error_if_retry_after_is_less_than_current_time(self): host = DEFAULT_API_HOST connection = ADTPulseConnection(host) @@ -97,7 +105,8 @@ def test_raises_value_error_if_retry_after_is_less_than_current_time(self): connection.retry_after = int(time.time()) - 60 # can make url with given uri using a valid host - def test_make_url_with_given_uri_with_valid_host(self): + @pytest.mark.asyncio + async def test_make_url_with_given_uri_with_valid_host(self): host = DEFAULT_API_HOST connection = ADTPulseConnection(host) uri = "/api/v1/status" @@ -108,7 +117,8 @@ def test_make_url_with_given_uri_with_valid_host(self): assert url == expected_url # can set and get detailed debug logging - def test_set_and_get_detailed_debug_logging(self): + @pytest.mark.asyncio + async def test_set_and_get_detailed_debug_logging(self): connection = ADTPulseConnection(DEFAULT_API_HOST) assert connection.detailed_debug_logging == False @@ -153,11 +163,6 @@ async def test_fetch_api_version_with_fix(self, mocker): response_mock = mocker.Mock() response_mock.status = 200 response_mock.real_url.path = "/myhome/1.0.0/" - - # Mock the __aenter__ and __aexit__ methods of the response object - response_mock.__aenter__ = mocker.AsyncMock(return_value=response_mock) - response_mock.__aexit__ = mocker.AsyncMock() - # Mock the session request method to return the mocked response session_mock.request.return_value = response_mock @@ -304,7 +309,8 @@ async def test_raises_runtime_error_if_loop_is_none_with_valid_service_host(self connection.check_sync("Test message") # can set and get allocated session - def test_set_and_get_allocated_session(self): + @pytest.mark.asyncio + async def test_set_and_get_allocated_session(self): host = DEFAULT_API_HOST connection = ADTPulseConnection(host) @@ -377,7 +383,7 @@ async def test_do_login_query_with_valid_credentials(self, mocker): session_mock.request.return_value = response_mock connection._session = session_mock - username = "test_user" + username = "me@example.com" password = "test_password" fingerprint = "test_fingerprint" @@ -405,7 +411,8 @@ async def test_raises_client_response_error_if_async_fetch_version_fails( await connection.async_fetch_version() # raises RuntimeError if async_query is called from sync context - def test_raises_runtime_error_if_async_query_called_from_sync_context(self): + @pytest.mark.asyncio + async def test_raises_runtime_error_if_async_query_called_from_sync_context(self): connection = ADTPulseConnection(DEFAULT_API_HOST) with pytest.raises(RuntimeError): diff --git a/pyproject.toml b/pyproject.toml index b770167..aa9eeb9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -36,3 +36,6 @@ line-length = 90 [tool.pycln] all = true + +[tool.pytest.ini_options] +timeout = 30 From 68c4beb667aca2361be15be226b4a95fb9f548aa Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 6 Nov 2023 14:37:47 -0500 Subject: [PATCH 060/226] revert relative imports --- pyadtpulse/__init__.py | 10 +++++----- pyadtpulse/alarm_panel.py | 6 +++--- pyadtpulse/gateway.py | 7 ++----- pyadtpulse/pulse_connection.py | 4 ++-- pyadtpulse/site.py | 12 ++++++------ 5 files changed, 18 insertions(+), 21 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 8ea04c3..99bff33 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -14,8 +14,8 @@ from aiohttp import ClientResponse, ClientSession from bs4 import BeautifulSoup -from pyadtpulse.alarm_panel import ADT_ALARM_UNKNOWN -from pyadtpulse.const import ( +from .alarm_panel import ADT_ALARM_UNKNOWN +from .const import ( ADT_DEFAULT_HTTP_HEADERS, ADT_DEFAULT_KEEPALIVE_INTERVAL, ADT_DEFAULT_RELOGIN_INTERVAL, @@ -28,9 +28,9 @@ ADT_TIMEOUT_URI, DEFAULT_API_HOST, ) -from pyadtpulse.pulse_connection import ADTPulseConnection -from pyadtpulse.site import ADTPulseSite -from pyadtpulse.util import ( +from .pulse_connection import ADTPulseConnection +from .site import ADTPulseSite +from .util import ( AuthenticationException, DebugRLock, close_response, diff --git a/pyadtpulse/alarm_panel.py b/pyadtpulse/alarm_panel.py index 7149061..fe36573 100644 --- a/pyadtpulse/alarm_panel.py +++ b/pyadtpulse/alarm_panel.py @@ -9,9 +9,9 @@ from bs4 import BeautifulSoup -from pyadtpulse.const import ADT_ARM_DISARM_URI -from pyadtpulse.pulse_connection import ADTPulseConnection -from pyadtpulse.util import make_soup +from .const import ADT_ARM_DISARM_URI +from .pulse_connection import ADTPulseConnection +from .util import make_soup LOG = logging.getLogger(__name__) ADT_ALARM_AWAY = "away" diff --git a/pyadtpulse/gateway.py b/pyadtpulse/gateway.py index 584d663..af28805 100644 --- a/pyadtpulse/gateway.py +++ b/pyadtpulse/gateway.py @@ -6,11 +6,8 @@ from threading import RLock from typing import Any -from pyadtpulse.const import ( - ADT_DEFAULT_POLL_INTERVAL, - ADT_GATEWAY_OFFLINE_POLL_INTERVAL, -) -from pyadtpulse.util import parse_pulse_datetime +from .const import ADT_DEFAULT_POLL_INTERVAL, ADT_GATEWAY_OFFLINE_POLL_INTERVAL +from .util import parse_pulse_datetime LOG = logging.getLogger(__name__) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index abefa94..620080e 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -17,7 +17,7 @@ ) from bs4 import BeautifulSoup -from pyadtpulse.const import ( +from .const import ( ADT_DEFAULT_HTTP_HEADERS, ADT_DEFAULT_VERSION, ADT_HTTP_REFERER_URIS, @@ -28,7 +28,7 @@ API_PREFIX, DEFAULT_API_HOST, ) -from pyadtpulse.util import DebugRLock, close_response, handle_response, make_soup +from .util import DebugRLock, close_response, handle_response, make_soup RECOVERABLE_ERRORS = [500, 502, 504] LOG = logging.getLogger(__name__) diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index c0bb5f3..1ff09dc 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -11,12 +11,12 @@ # import dateparser from bs4 import BeautifulSoup -from pyadtpulse.alarm_panel import ADTPulseAlarmPanel -from pyadtpulse.const import ADT_DEVICE_URI, ADT_GATEWAY_STRING, ADT_SYSTEM_URI -from pyadtpulse.gateway import ADTPulseGateway -from pyadtpulse.pulse_connection import ADTPulseConnection -from pyadtpulse.util import DebugRLock, make_soup, parse_pulse_datetime, remove_prefix -from pyadtpulse.zones import ADTPulseFlattendZone, ADTPulseZones +from .alarm_panel import ADTPulseAlarmPanel +from .const import ADT_DEVICE_URI, ADT_GATEWAY_STRING, ADT_SYSTEM_URI +from .gateway import ADTPulseGateway +from .pulse_connection import ADTPulseConnection +from .util import DebugRLock, make_soup, parse_pulse_datetime, remove_prefix +from .zones import ADTPulseFlattendZone, ADTPulseZones LOG = logging.getLogger(__name__) From 6fd70cdf1397ca01b81f142ba50a6f64f453c17a Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 6 Nov 2023 14:46:42 -0500 Subject: [PATCH 061/226] move username/password/fingerprint validation to pulse_connection --- pyadtpulse/__init__.py | 18 ++++++------------ pyadtpulse/pulse_connection.py | 19 +++++++++++++++++++ 2 files changed, 25 insertions(+), 12 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 99bff33..77ef8c5 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -162,20 +162,14 @@ def __init__( self.login() def _init_login_info(self, username: str, password: str, fingerprint: str) -> None: - if username is None or username == "": - raise ValueError("Username is mandatory") + """Initialize login info. - pattern = r"\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}\b" - if not re.match(pattern, username): - raise ValueError("Username must be an email address") + Raises: + ValueError: if login parameters are not valid. + """ + ADTPulseConnection.check_login_parameters(username, password, fingerprint) self._username = username - - if password is None or password == "": - raise ValueError("Password is mandatory") self._password = password - - if fingerprint is None or fingerprint == "": - raise ValueError("Fingerprint is required") self._fingerprint = fingerprint def __repr__(self) -> str: @@ -201,7 +195,7 @@ def service_host(self, host: str) -> None: Args: host (str): name of Pulse endpoint host """ - self._pulse_connection.check_service_host(host) + ADTPulseConnection.check_service_host(host) with self._attribute_lock: self._pulse_connection.service_host = host diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 620080e..2457549 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -64,6 +64,22 @@ def check_service_host(service_host: str) -> None: f"Service host must be one of {DEFAULT_API_HOST}" f" or {API_HOST_CA}" ) + @staticmethod + def check_login_parameters(username: str, password: str, fingerprint: str) -> None: + """Check if login parameters are valid. + + Raises ValueError if a login parameter is not valid. + """ + if username is None or username == "": + raise ValueError("Username is mandatory") + pattern = r"\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,}\b" + if not re.match(pattern, username): + raise ValueError("Username must be an email address") + if password is None or password == "": + raise ValueError("Password is mandatory") + if fingerprint is None or fingerprint == "": + raise ValueError("Fingerprint is required") + def __init__( self, host: str, @@ -439,7 +455,10 @@ async def async_do_login_query( Returns: ClientResponse | None: The response from the query or None if the login was unsuccessful. + Raises: + ValueError: if login parameters are not correct """ + self.check_login_parameters(username, password, fingerprint) try: retval = await self.async_query( ADT_LOGIN_URI, From 4f1fbf93c4cb1850db82c5b6a6fd9abc906fa5c3 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 6 Nov 2023 15:22:10 -0500 Subject: [PATCH 062/226] site code enhanements --- pyadtpulse/site.py | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 1ff09dc..9669bef 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -298,17 +298,20 @@ async def fetch_devices(self, soup: BeautifulSoup | None) -> bool: task_list: list[Task] = [] with self._site_lock: - for row in soup.find_all("tr", {"class": "p_listRow", "onclick": True}): + device_mapping = { + ("goToUrl('gateway.jsp');", "Gateway"): ADT_GATEWAY_STRING, + (SECURITY_PANEL_ID, SECURITY_PANEL_NAME): SECURITY_PANEL_ID, + } + rows = soup.find_all("tr", {"class": "p_listRow", "onclick": True}) + for row in rows: device_name = row.find("a").get_text() row_tds = row.find_all("td") zone_id = None - # Check if we can create a zone without calling device.jsp if row_tds and len(row_tds) > 4: zone_name = row_tds[1].get_text().strip() zone_id = row_tds[2].get_text().strip() zone_type = row_tds[4].get_text().strip() zone_status = row_tds[0].find("canvas").get("title").strip() - if ( zone_id is not None and zone_id.isdecimal() @@ -324,22 +327,24 @@ async def fetch_devices(self, soup: BeautifulSoup | None) -> bool: } ) continue - on_click_value_text = row.get("onclick") - - if ( - on_click_value_text in ("goToUrl('gateway.jsp');", "Gateway") - or device_name == "Gateway" - ): - task_list.append(create_task(self.set_device(ADT_GATEWAY_STRING))) + device_id = device_mapping.get((on_click_value_text, device_name)) + if device_id: + if device_id == ADT_GATEWAY_STRING: + task_list.append(create_task(self.set_device(device_id))) + elif device_id == SECURITY_PANEL_ID: + task_list.append(create_task(self.set_device(device_id))) + elif zone_id and zone_id.isdecimal(): + task_list.append(create_task(self.set_device(device_id))) + else: + LOG.debug("Skipping %s as it doesn't have an ID", device_name) else: - result = re.findall(regex_device, on_click_value_text) - + result = str(re.findall(regex_device, on_click_value_text)) if result: device_id = result[0] - if ( - device_id == SECURITY_PANEL_ID + device_id is not None + and device_id == SECURITY_PANEL_ID or device_name == SECURITY_PANEL_NAME ): task_list.append(create_task(self.set_device(device_id))) From 587648a7f1ddc466f1eef15904f721446f7dd932 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 6 Nov 2023 15:56:55 -0500 Subject: [PATCH 063/226] revert site code enhancements --- pyadtpulse/site.py | 33 ++++++++++++++------------------- 1 file changed, 14 insertions(+), 19 deletions(-) diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 9669bef..1ff09dc 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -298,20 +298,17 @@ async def fetch_devices(self, soup: BeautifulSoup | None) -> bool: task_list: list[Task] = [] with self._site_lock: - device_mapping = { - ("goToUrl('gateway.jsp');", "Gateway"): ADT_GATEWAY_STRING, - (SECURITY_PANEL_ID, SECURITY_PANEL_NAME): SECURITY_PANEL_ID, - } - rows = soup.find_all("tr", {"class": "p_listRow", "onclick": True}) - for row in rows: + for row in soup.find_all("tr", {"class": "p_listRow", "onclick": True}): device_name = row.find("a").get_text() row_tds = row.find_all("td") zone_id = None + # Check if we can create a zone without calling device.jsp if row_tds and len(row_tds) > 4: zone_name = row_tds[1].get_text().strip() zone_id = row_tds[2].get_text().strip() zone_type = row_tds[4].get_text().strip() zone_status = row_tds[0].find("canvas").get("title").strip() + if ( zone_id is not None and zone_id.isdecimal() @@ -327,24 +324,22 @@ async def fetch_devices(self, soup: BeautifulSoup | None) -> bool: } ) continue + on_click_value_text = row.get("onclick") - device_id = device_mapping.get((on_click_value_text, device_name)) - if device_id: - if device_id == ADT_GATEWAY_STRING: - task_list.append(create_task(self.set_device(device_id))) - elif device_id == SECURITY_PANEL_ID: - task_list.append(create_task(self.set_device(device_id))) - elif zone_id and zone_id.isdecimal(): - task_list.append(create_task(self.set_device(device_id))) - else: - LOG.debug("Skipping %s as it doesn't have an ID", device_name) + + if ( + on_click_value_text in ("goToUrl('gateway.jsp');", "Gateway") + or device_name == "Gateway" + ): + task_list.append(create_task(self.set_device(ADT_GATEWAY_STRING))) else: - result = str(re.findall(regex_device, on_click_value_text)) + result = re.findall(regex_device, on_click_value_text) + if result: device_id = result[0] + if ( - device_id is not None - and device_id == SECURITY_PANEL_ID + device_id == SECURITY_PANEL_ID or device_name == SECURITY_PANEL_NAME ): task_list.append(create_task(self.set_device(device_id))) From 0633506a22169962b10724e8e651afaacea695e0 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 6 Nov 2023 18:03:20 -0500 Subject: [PATCH 064/226] fetch_devices refactoring --- pyadtpulse/site.py | 114 +++++++++++++++++++++++++-------------------- 1 file changed, 64 insertions(+), 50 deletions(-) diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 1ff09dc..31cc60d 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -9,7 +9,7 @@ from warnings import warn # import dateparser -from bs4 import BeautifulSoup +from bs4 import BeautifulSoup, ResultSet from .alarm_panel import ADTPulseAlarmPanel from .const import ADT_DEVICE_URI, ADT_GATEWAY_STRING, ADT_SYSTEM_URI @@ -284,6 +284,54 @@ async def fetch_devices(self, soup: BeautifulSoup | None) -> bool: bool: True if the devices were fetched and zone attributes were updated successfully, False otherwise. """ + regex_device = r"goToUrl\('device.jsp\?id=(\d*)'\);" + task_list: list[Task] = [] + zone_id: str | None = None + + def add_zone_from_row(row_tds: ResultSet) -> str | None: + """Adds a zone from a bs4 row. + + Returns None if successful, otherwise the zone ID if present. + """ + zone_id: str | None = None + if row_tds and len(row_tds) > 4: + zone_name: str = row_tds[1].get_text().strip() + zone_id = row_tds[2].get_text().strip() + zone_type: str = row_tds[4].get_text().strip() + zone_status: str = row_tds[0].find("canvas").get("title").strip() + if ( + zone_id is not None + and zone_id.isdecimal() + and zone_name + and zone_type + ): + self._zones.update_zone_attributes( + { + "name": zone_name, + "zone": zone_id, + "type_model": zone_type, + "status": zone_status, + } + ) + return None + return zone_id + + def check_panel_or_gateway( + regex_device: str, + device_name: str, + zone_id: str | None, + on_click_value_text: str, + ) -> Task | None: + result = re.findall(regex_device, on_click_value_text) + if result: + device_id = result[0] + if device_id == SECURITY_PANEL_ID or device_name == SECURITY_PANEL_NAME: + return create_task(self.set_device(device_id)) + if zone_id and zone_id.isdecimal(): + return create_task(self.set_device(device_id)) + LOG.debug("Skipping %s as it doesn't have an ID", device_name) + return None + if not soup: response = await self._pulse_connection.async_query(ADT_SYSTEM_URI) soup = await make_soup( @@ -293,66 +341,32 @@ async def fetch_devices(self, soup: BeautifulSoup | None) -> bool: ) if not soup: return False - - regex_device = r"goToUrl\('device.jsp\?id=(\d*)'\);" - task_list: list[Task] = [] - with self._site_lock: for row in soup.find_all("tr", {"class": "p_listRow", "onclick": True}): device_name = row.find("a").get_text() row_tds = row.find_all("td") - zone_id = None - # Check if we can create a zone without calling device.jsp - if row_tds and len(row_tds) > 4: - zone_name = row_tds[1].get_text().strip() - zone_id = row_tds[2].get_text().strip() - zone_type = row_tds[4].get_text().strip() - zone_status = row_tds[0].find("canvas").get("title").strip() - - if ( - zone_id is not None - and zone_id.isdecimal() - and zone_name - and zone_type - ): - self._zones.update_zone_attributes( - { - "name": zone_name, - "zone": zone_id, - "type_model": zone_type, - "status": zone_status, - } - ) - continue - + zone_id = add_zone_from_row(row_tds) + if zone_id is None: + continue on_click_value_text = row.get("onclick") - if ( on_click_value_text in ("goToUrl('gateway.jsp');", "Gateway") or device_name == "Gateway" ): task_list.append(create_task(self.set_device(ADT_GATEWAY_STRING))) - else: - result = re.findall(regex_device, on_click_value_text) - - if result: - device_id = result[0] - - if ( - device_id == SECURITY_PANEL_ID - or device_name == SECURITY_PANEL_NAME - ): - task_list.append(create_task(self.set_device(device_id))) - elif zone_id and zone_id.isdecimal(): - task_list.append(create_task(self.set_device(device_id))) - else: - LOG.debug( - "Skipping %s as it doesn't have an ID", device_name - ) + elif ( + result := check_panel_or_gateway( + regex_device, + device_name, + zone_id, + on_click_value_text, + ) + ) is not None: + task_list.append(result) - await gather(*task_list) - self._last_updated = int(time()) - return True + await gather(*task_list) + self._last_updated = int(time()) + return True async def _async_update_zones_as_dict( self, soup: BeautifulSoup | None From b4d15b9d6fc44ea2c982f322eec585d789f12f57 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 6 Nov 2023 23:52:59 -0500 Subject: [PATCH 065/226] add test_site --- pyadtpulse/tests/test_site.py | 188 ++++++++++++++++++++++++++++++++++ 1 file changed, 188 insertions(+) create mode 100644 pyadtpulse/tests/test_site.py diff --git a/pyadtpulse/tests/test_site.py b/pyadtpulse/tests/test_site.py new file mode 100644 index 0000000..d217279 --- /dev/null +++ b/pyadtpulse/tests/test_site.py @@ -0,0 +1,188 @@ +# Generated by CodiumAI +# Dependencies: +# pip install pytest-mock +import pytest + +from pyadtpulse.alarm_panel import ADTPulseAlarmPanel +from pyadtpulse.const import DEFAULT_API_HOST +from pyadtpulse.gateway import ADTPulseGateway +from pyadtpulse.pulse_connection import ADTPulseConnection +from pyadtpulse.site import ADTPulseSite +from pyadtpulse.zones import ADTPulseZones + + +class TestADTPulseSite: + # can create an instance of ADTPulseSite with pulse_connection, site_id, and name + def test_create_instance(self): + pulse_connection = ADTPulseConnection(DEFAULT_API_HOST) + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + assert site._pulse_connection == pulse_connection + assert site._id == "site_id" + assert site._name == "site_name" + assert site._last_updated == 0 + assert isinstance(site._zones, ADTPulseZones) + # assert isinstance(site._site_lock, RLock) or isinstance(site._site_lock, DebugRLock) + assert isinstance(site._alarm_panel, ADTPulseAlarmPanel) + assert isinstance(site._gateway, ADTPulseGateway) + + # can get the id of the site + def test_get_id(self): + pulse_connection = ADTPulseConnection(DEFAULT_API_HOST) + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + assert site.id == "site_id" + + # can get the name of the site + def test_get_name(self): + pulse_connection = ADTPulseConnection(DEFAULT_API_HOST) + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + assert site.name == "site_name" + + # can get the last_updated timestamp of the site + def test_get_last_updated(self): + pulse_connection = ADTPulseConnection(DEFAULT_API_HOST) + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + assert site.last_updated == 0 + + # can get the site_lock of the site + """ + @pytest.mark.asyncio + def test_get_site_lock(self): + pulse_connection = ADTPulseConnection(DEFAULT_API_HOST) + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + assert isinstance(site.site_lock, RLock) or isinstance(site.site_lock, DebugRLock) + """ + + # can arm the system home + def test_arm_home(self, mocker): + pulse_connection = ADTPulseConnection(DEFAULT_API_HOST) + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + site.arm_home() == True + + # Raises a RuntimeError if no control panels exist when trying to arm the system home + def test_arm_home_no_control_panels(self, mocker): + pulse_connection = ADTPulseConnection(DEFAULT_API_HOST) + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + with pytest.raises(RuntimeError): + site.arm_home() + + # Raises a RuntimeError if no zones exist when trying to get the zones of the site as a list of ADTPulseFlattendZone objects + def test_get_zones_list_no_zones(self, mocker): + pulse_connection = ADTPulseConnection(DEFAULT_API_HOST) + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + with pytest.raises(RuntimeError): + site.zones + + # Raises a RuntimeError if no zones exist when trying to get the zones of the site as a dictionary of ADTPulseZone objects + def test_get_zones_dict_no_zones(self, mocker): + pulse_connection = ADTPulseConnection(DEFAULT_API_HOST) + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + with pytest.raises(RuntimeError): + site.zones_as_dict + + # can arm the system away + @pytest.mark.asyncio + def test_arm_away(self, event_loop): + pulse_connection = ADTPulseConnection(DEFAULT_API_HOST) + pulse_connection.loop = event_loop + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + assert site.arm_away() is True + + # can disarm the system + def test_disarm_system_fixed(self, mocker): + pulse_connection = mocker.Mock(spec=ADTPulseConnection) + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + + with pytest.raises(RuntimeError): + site.disarm() + + site._alarm_panel = mocker.Mock(spec=ADTPulseAlarmPanel) + site._alarm_panel.disarm.return_value = True + + assert site.disarm() == True + + # can asynchronously arm the system home + @pytest.mark.asyncio + async def test_async_arm_home(self, mocker): + pulse_connection = mocker.Mock(spec=ADTPulseConnection) + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + + site._alarm_panel = mocker.Mock(spec=ADTPulseAlarmPanel) + site._alarm_panel.async_arm_home.return_value = True + + assert await site.async_arm_home() == True + + # can asynchronously arm the system away + @pytest.mark.asyncio + async def test_async_arm_away(self, mocker): + pulse_connection = mocker.Mock(spec=ADTPulseConnection) + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + site._alarm_panel = mocker.Mock(spec=ADTPulseAlarmPanel) + site._alarm_panel.async_arm_away.return_value = True + + assert await site.async_arm_away() is True + + # can asynchronously disarm the system + @pytest.mark.asyncio + async def test_disarm_system(self, mocker): + # Arrange + pulse_connection = mocker.Mock() + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + alarm_control_panel = mocker.Mock() + site.alarm_control_panel = alarm_control_panel + + # Act + result = await site.async_disarm() + + # Assert + alarm_control_panel.disarm.assert_called_once_with(pulse_connection) + assert result == alarm_control_panel.disarm.return_value + + # can get the zones of the site as a list of ADTPulseFlattendZone objects + def test_get_zones_as_list(self, mocker): + # Arrange + pulse_connection = mocker.Mock() + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + zones = mocker.Mock() + site._zones = zones + flattened_zones = mocker.Mock() + zones.flatten.return_value = flattened_zones + + # Act + result = site.zones + + # Assert + zones.flatten.assert_called_once_with() + assert result == flattened_zones + + # can get the zones of the site as a dictionary of ADTPulseZone objects + def test_get_zones_as_dict(self, mocker): + # Arrange + pulse_connection = mocker.Mock() + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + zones = mocker.Mock() + site._zones = zones + + # Act + result = site.zones_as_dict + + # Assert + assert result == zones + + # can get the alarm control panel of the site + def test_get_alarm_control_panel(self): + pulse_connection = ADTPulseConnection(DEFAULT_API_HOST) + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + assert isinstance(site.alarm_control_panel, ADTPulseAlarmPanel) + + # can get the gateway of the site + def test_get_gateway(self): + pulse_connection = ADTPulseConnection(DEFAULT_API_HOST) + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + assert isinstance(site.gateway, ADTPulseGateway) + + # raises a RuntimeError if no control panels exist when trying to arm the system home + def test_raise_runtime_error_when_no_control_panels_exist(self): + pulse_connection = ADTPulseConnection(DEFAULT_API_HOST) + site = ADTPulseSite(pulse_connection, "site_id", "site_name") + with pytest.raises(RuntimeError): + site.arm_home() From 0359cfe4911e3fb13f83d747afb68e56271058d6 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 00:11:49 -0500 Subject: [PATCH 066/226] add response is None check --- pyadtpulse/__init__.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 77ef8c5..f4315bf 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -570,6 +570,8 @@ def handle_updates_exist() -> bool: ): close_response(response) continue + if response is None: # shut up type checker + continue text = await response.text() if not await validate_sync_check_response(): continue From 392602b1723849860e4cf1d1f83b0000651eb74c Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 00:41:10 -0500 Subject: [PATCH 067/226] add test_pyadtpulse --- pyadtpulse/test_pyadtpulse.py | 395 ++++++++++++++++++++++++++++++++++ 1 file changed, 395 insertions(+) create mode 100644 pyadtpulse/test_pyadtpulse.py diff --git a/pyadtpulse/test_pyadtpulse.py b/pyadtpulse/test_pyadtpulse.py new file mode 100644 index 0000000..c102788 --- /dev/null +++ b/pyadtpulse/test_pyadtpulse.py @@ -0,0 +1,395 @@ +# Generated by CodiumAI +import logging +import asyncio +import time +from unittest.mock import Mock + +import pytest +from aiohttp import ClientSession +from bs4 import BeautifulSoup + +from pyadtpulse import PyADTPulse +from pyadtpulse.const import ADT_SUMMARY_URI, DEFAULT_API_HOST + + +class TestPyADTPulse: + # The class can be instantiated with a username, password, and fingerprint. + def test_instantiation_with_username_password_fingerprint(self): + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + + # Act + pulse = PyADTPulse(username, password, fingerprint, do_login=False) + + # Assert + assert pulse._username == username + assert pulse._password == password + assert pulse._fingerprint == fingerprint + + # The login method successfully logs in the user. + @pytest.mark.asyncio + async def test_login_successfully_logs_in_user(self, mocker): + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + pulse = PyADTPulse(username, password, fingerprint, do_login=False) + + async def mock_async_login(): + pulse._pulse_connection.authenticated_flag.set() + + mocker.patch.object(pulse, "async_login", side_effect=mock_async_login) + + # Act + pulse.login() + + # Assert + assert pulse._pulse_connection.authenticated_flag.is_set() + + # The logout method successfully logs out the user. + @pytest.mark.asyncio + async def test_logout_successfully_logs_out_user(self, mocker): + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + pulse = PyADTPulse(username, password, fingerprint, do_login=False) + pulse._pulse_connection.authenticated_flag.set() + + async def mock_async_logout(): + pulse._pulse_connection.authenticated_flag.clear() + + async def mock_async_login(): + pulse._pulse_connection.authenticated_flag.set() + + mocker.patch.object( + pulse._pulse_connection, + "async_do_logout_query", + side_effect=mock_async_logout, + ) + mocker.patch.object(pulse, "async_login", side_effect=mock_async_login) + + # Act + await pulse.logout() + + # Assert + assert not pulse._pulse_connection.authenticated_flag.is_set() + + # The service_host property can be set to a different host. + def test_service_host_can_be_set_to_different_host(self): + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + pulse = PyADTPulse(username, password, fingerprint, do_login=False) + new_service_host = DEFAULT_API_HOST + + # Act + pulse.service_host = new_service_host + + # Assert + assert pulse._pulse_connection.service_host == new_service_host + + # The relogin_interval property can be set to a different interval. + def test_relogin_interval_can_be_set_to_different_interval(self): + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + pulse = PyADTPulse(username, password, fingerprint, do_login=False) + new_relogin_interval = 120 + + # Act + pulse.relogin_interval = new_relogin_interval + + # Assert + assert pulse._relogin_interval == new_relogin_interval + + # The updates_exist property returns True when updates are available. + def test_updates_exist_returns_true_when_updates_available(self): + # Arrange + pulse = PyADTPulse( + "test@example.com", "password123", "fingerprint123", do_login=False + ) + pulse._updates_exist.set() + + # Act + result = pulse.updates_exist + + # Assert + assert result is True + + # The wait_for_update method waits for updates and returns True when updates are available. + @pytest.mark.asyncio + async def test_wait_for_update_returns_true_when_updates_available(self, mocker): + # Arrange + pulse = PyADTPulse( + "test@example.com", "password123", "fingerprint123", do_login=False + ) + pulse._updates_exist.set() + + # Act + result = await pulse.wait_for_update() + + # Assert + assert result is True + + # The is_connected property returns True when the user is connected to the ADT Pulse service. + def test_is_connected_returns_true_when_user_connected(self, mocker): + # Arrange + pulse = PyADTPulse( + "test@example.com", "password123", "fingerprint123", do_login=False + ) + pulse._pulse_connection.authenticated_flag.set() + pulse._pulse_connection.retry_after = time.time() - 1 + + # Act + result = pulse.is_connected + + # Assert + assert result is True + + # The async_update method successfully queries the ADT Pulse service for updates. + @pytest.mark.asyncio + async def test_async_update_successfully_queries_pulse_service_for_updates( + self, mocker + ): + # Arrange + pulse = PyADTPulse( + "email@example.com", "password", "fingerprint", do_login=False + ) + mock_query_orb = mocker.patch.object(pulse._pulse_connection, "query_orb") + mock_soup = mocker.Mock() + mock_query_orb.return_value = mock_soup + + # Act + result = await pulse.async_update() + + # Assert + assert result is True + mock_query_orb.assert_called_once_with( + logging.INFO, "Error returned from ADT Pulse service check" + ) + pulse._update_sites.assert_called_once_with(mock_soup) + + # The update method successfully queries the ADT Pulse service for updates. + def test_update_successfully_queries_pulse_service_for_updates(self, mocker): + # Arrange + pulse = PyADTPulse( + "email@example.com", "password", "fingerprint", do_login=False + ) + mock_async_update = mocker.patch.object(pulse, "async_update") + mock_async_update.return_value = True + + # Act + result = pulse.update() + + # Assert + assert result is True + mock_async_update.assert_called_once() + + # The sites property returns a list of ADTPulseSite objects. + def test_sites_property_returns_list_of_sites(self, mocker): + # Arrange + pulse = PyADTPulse("email@example.com", "password", "fingerprint") + mock_site = mocker.Mock() + pulse._site = mock_site + + # Act + result = pulse.sites + + # Assert + assert result == [mock_site] + + # The site property returns an ADTPulseSite object. + def test_site_property_returns_ADTPulseSite_object(self): + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + pulse = PyADTPulse(username, password, fingerprint, do_login=False) + + # Mock the site object + class MockADTPulseSite: + pass + + pulse._site = MockADTPulseSite() + + # Act + site = pulse.site + + # Assert + assert isinstance(site, MockADTPulseSite) + + # The class can be instantiated with optional parameters such as service_host, user_agent, websession, do_login, debug_locks, keepalive_interval, relogin_interval, and detailed_debug_logging. + def test_class_instantiation_with_optional_parameters(self): + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + service_host = DEFAULT_API_HOST + user_agent = "Test User Agent" + websession = ClientSession() + do_login = False + debug_locks = True + keepalive_interval = 10 + relogin_interval = 5 + detailed_debug_logging = True + + # Act + pulse = PyADTPulse( + username, + password, + fingerprint, + service_host=service_host, + user_agent=user_agent, + websession=websession, + do_login=do_login, + debug_locks=debug_locks, + keepalive_interval=keepalive_interval, + relogin_interval=relogin_interval, + detailed_debug_logging=detailed_debug_logging, + ) + + # Assert + assert pulse._username == username + assert pulse._password == password + assert pulse._fingerprint == fingerprint + assert pulse._pulse_connection.service_host == service_host + assert pulse._pulse_connection.user_agent == user_agent + assert pulse._pulse_connection.session == websession + assert pulse._pulse_connection.debug_locks == debug_locks + assert pulse.keepalive_interval == keepalive_interval + assert pulse.relogin_interval == relogin_interval + assert pulse._detailed_debug_logging == detailed_debug_logging + + # The keepalive_interval property can be set to a different interval. + def test_keepalive_interval_property_can_be_set(self): + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + pulse = PyADTPulse(username, password, fingerprint, do_login=False) + new_interval = 5 + + # Act + pulse.keepalive_interval = new_interval + + # Assert + assert pulse.keepalive_interval == new_interval + + # The detailed_debug_logging property can be set to True or False. + def test_detailed_debug_logging_property(self): + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + pulse = PyADTPulse(username, password, fingerprint) + + # Act + pulse.detailed_debug_logging = True + + # Assert + assert pulse.detailed_debug_logging == True + + # Act + pulse.detailed_debug_logging = False + + # Assert + assert pulse.detailed_debug_logging == False + + # The async_login method returns False if authentication fails. + @pytest.mark.asyncio + async def test_async_login_authentication_fails(self, mocker): + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + pulse = PyADTPulse(username, password, fingerprint) + response = Mock() + response.url = pulse._pulse_connection.make_url(ADT_SUMMARY_URI) + soup = BeautifulSoup( + "
Invalid username/password
", "html.parser" + ) + mocker.patch.object(pulse._pulse_connection, "async_fetch_version") + mocker.patch.object( + pulse._pulse_connection, + "async_do_login_query", + return_value=asyncio.Future(), + ) + mocker.patch.object( + pulse._pulse_connection, "query_orb", return_value=asyncio.Future() + ) + pulse._pulse_connection.async_do_login_query.return_value.set_result(response) + pulse._pulse_connection.query_orb.return_value.set_result(soup) + + # Act + result = await pulse.async_login() + + # Assert + assert result == False + + # The async_logout method successfully logs out the user. + @pytest.mark.asyncio + async def test_async_logout_successfully_logs_out_user(self, mocker): + # Arrange + pulse = PyADTPulse("test@example.com", "password123", "fingerprint123") + pulse._pulse_connection.authenticated_flag.set() + + async def mock_async_do_logout_query(site_id): + return None + + mocker.patch.object( + pulse._pulse_connection, + "async_do_logout_query", + side_effect=mock_async_do_logout_query, + ) + + # Act + await pulse.async_logout() + + # Assert + assert not pulse._pulse_connection.authenticated_flag.is_set() + + # The update method returns False if querying the ADT Pulse service fails. + @pytest.mark.asyncio + async def test_update_method_returns_false_if_querying_fails(self, mocker): + # Arrange + pulse = PyADTPulse("username", "password", "fingerprint") + mocker.patch.object(pulse._pulse_connection, "query_orb", return_value=None) + + # Act + result = await pulse.async_update() + + # Assert + assert result == False + + # The async_update method returns False if querying the ADT Pulse service fails. + @pytest.mark.asyncio + async def test_async_update_returns_false_on_query_failure(self, mocker): + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + pulse = PyADTPulse(username, password, fingerprint) + mocker.patch.object(pulse._pulse_connection, "query_orb", return_value=None) + + # Act + result = await pulse.async_update() + + # Assert + assert result == False + + # The sites property raises a RuntimeError if no sites have been retrieved. + def test_sites_property_raises_runtime_error_if_no_sites_retrieved(self, mocker): + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + pulse = PyADTPulse(username, password, fingerprint) + + # Act and Assert + with pytest.raises(RuntimeError): + pulse.sites From c4d4ecf8cdbbc03c8b86c51a7217673169862553 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 04:25:28 -0500 Subject: [PATCH 068/226] rework async_query to return tuple, remove close_response() --- pyadtpulse/__init__.py | 75 +++---- pyadtpulse/alarm_panel.py | 6 +- pyadtpulse/pulse_connection.py | 56 ++--- pyadtpulse/site.py | 12 +- pyadtpulse/tests/test_util.py | 375 +-------------------------------- pyadtpulse/util.py | 73 +++---- 6 files changed, 112 insertions(+), 485 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index f4315bf..b798692 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -11,8 +11,9 @@ from warnings import warn import uvloop -from aiohttp import ClientResponse, ClientSession +from aiohttp import ClientSession from bs4 import BeautifulSoup +from yarl import URL from .alarm_panel import ADT_ALARM_UNKNOWN from .const import ( @@ -30,13 +31,7 @@ ) from .pulse_connection import ADTPulseConnection from .site import ADTPulseSite -from .util import ( - AuthenticationException, - DebugRLock, - close_response, - handle_response, - make_soup, -) +from .util import AuthenticationException, DebugRLock, handle_response, make_soup LOG = logging.getLogger(__name__) @@ -375,7 +370,7 @@ async def _keepalive_task(self) -> None: with the ADT Pulse cloud. """ - async def reset_pulse_cloud_timeout() -> ClientResponse | None: + async def reset_pulse_cloud_timeout() -> tuple[int, str | None, URL | None]: return await self._pulse_connection.async_query(ADT_TIMEOUT_URI, "POST") async def update_gateway_device_if_needed() -> None: @@ -389,7 +384,7 @@ def should_relogin(relogin_interval: int) -> bool: > randint(int(0.75 * relogin_interval), relogin_interval) ) - response: ClientResponse | None = None + response: str | None task_name: str = self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) LOG.debug("creating %s", task_name) @@ -410,21 +405,21 @@ def should_relogin(relogin_interval: int) -> bool: await self._do_login_with_backoff(task_name) continue LOG.debug("Resetting timeout") - response = await reset_pulse_cloud_timeout() + code, response, url = await reset_pulse_cloud_timeout() if ( not handle_response( - response, + code, + url, logging.WARNING, "Could not reset ADT Pulse cloud timeout", ) or response is None - ): # shut up linter + ): continue await update_gateway_device_if_needed() except asyncio.CancelledError: LOG.debug("%s cancelled", task_name) - close_response(response) return async def _cancel_task(self, task: asyncio.Task | None) -> None: @@ -497,9 +492,11 @@ async def perform_sync_check_query(): task_name = self._get_sync_task_name() LOG.debug("creating %s", task_name) - response = None + response_text: str | None = None + code: int = 200 last_sync_text = "0-0-0" last_sync_check_was_different = False + url: URL | None = None async def validate_sync_check_response() -> bool: """ @@ -507,18 +504,20 @@ async def validate_sync_check_response() -> bool: Returns: bool: True if the sync check response is valid, False otherwise. """ - if not handle_response(response, logging.ERROR, "Error querying ADT sync"): + if not handle_response(code, url, logging.ERROR, "Error querying ADT sync"): self._set_update_status(False) - close_response(response) return False - close_response(response) + # this should have already been handled + if response_text is None: + LOG.warning("Internal Error: response_text is None") + return False pattern = r"\d+[-]\d+[-]\d+" - if not re.match(pattern, text): + if not re.match(pattern, response_text): LOG.warning( "Unexpected sync check format (%s), forcing re-auth", - text, + response_text, ) - LOG.debug("Received %s from ADT Pulse site", text) + LOG.debug("Received %s from ADT Pulse site", response_text) await self.async_logout() await self._do_login_with_backoff(task_name) return False @@ -534,13 +533,14 @@ async def handle_no_updates_exist() -> bool: else: if self.detailed_debug_logging: LOG.debug( - "Sync token %s indicates no remote updates to process", text + "Sync token %s indicates no remote updates to process", + response_text, ) return False def handle_updates_exist() -> bool: - if text != last_sync_text: - LOG.debug("Updates exist: %s, requerying", text) + if response_text != last_sync_text: + LOG.debug("Updates exist: %s, requerying", response_text) return True return False @@ -564,27 +564,25 @@ def handle_updates_exist() -> bool: continue await asyncio.sleep(pi) - response = await perform_sync_check_query() + code, response_text, url = await perform_sync_check_query() if not handle_response( - response, logging.WARNING, "Error querying ADT sync" + code, url, logging.WARNING, "Error querying ADT sync" ): - close_response(response) continue - if response is None: # shut up type checker + if response_text is None: + LOG.warning("Sync check received no response from ADT Pulse site") continue - text = await response.text() if not await validate_sync_check_response(): continue if handle_updates_exist(): last_sync_check_was_different = True - last_sync_text = text + last_sync_text = response_text continue if await handle_no_updates_exist(): last_sync_check_was_different = False continue except asyncio.CancelledError: LOG.debug("%s cancelled", task_name) - close_response(response) return def _pulse_session_thread(self) -> None: @@ -702,18 +700,23 @@ async def async_login(self) -> bool: response = await self._pulse_connection.async_do_login_query( self.username, self._password, self._fingerprint ) - if response is None: + if not handle_response( + response[0], response[2], logging.ERROR, "Error authenticating to ADT Pulse" + ): return False - if self._pulse_connection.make_url(ADT_SUMMARY_URI) != str(response.url): + if self._pulse_connection.make_url(ADT_SUMMARY_URI) != str(response[2]): # more specifically: # redirect to signin.jsp = username/password error # redirect to mfaSignin.jsp = fingerprint error LOG.error("Authentication error encountered logging into ADT Pulse") - close_response(response) return False - soup = await make_soup( - response, logging.ERROR, "Could not log into ADT Pulse site" + soup = make_soup( + response[0], + response[1], + response[2], + logging.ERROR, + "Could not log into ADT Pulse site", ) if soup is None: return False diff --git a/pyadtpulse/alarm_panel.py b/pyadtpulse/alarm_panel.py index fe36573..d023f53 100644 --- a/pyadtpulse/alarm_panel.py +++ b/pyadtpulse/alarm_panel.py @@ -161,8 +161,10 @@ async def _arm( timeout=10, ) - soup = await make_soup( - response, + soup = make_soup( + response[0], + response[1], + response[2], logging.WARNING, f"Failed updating ADT Pulse alarm {self._sat} to {mode}", ) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 2457549..a7770a2 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -16,6 +16,7 @@ ClientSession, ) from bs4 import BeautifulSoup +from yarl import URL from .const import ( ADT_DEFAULT_HTTP_HEADERS, @@ -28,7 +29,7 @@ API_PREFIX, DEFAULT_API_HOST, ) -from .util import DebugRLock, close_response, handle_response, make_soup +from .util import DebugRLock, handle_response, make_soup RECOVERABLE_ERRORS = [500, 502, 504] LOG = logging.getLogger(__name__) @@ -239,7 +240,7 @@ async def async_query( extra_headers: dict[str, str] | None = None, timeout: int = 1, requires_authentication: bool = True, - ) -> ClientResponse | None: + ) -> tuple[int, str | None, URL | None]: """ Query ADT Pulse async. @@ -258,10 +259,12 @@ async def async_query( set, will wait for flag to be set. Returns: - Optional[ClientResponse]: aiohttp.ClientResponse object - None on failure - ClientResponse will already be closed. + tuple with integer return code, optional response text, and optional URL of + response """ + response_text: str | None = None + return_code: int = 200 + response_url: URL | None = None current_time = time.time() if self.retry_after > current_time: LOG.debug( @@ -308,7 +311,9 @@ async def async_query( timeout=timeout, ) as response: retry += 1 - await response.text() + response_text = await response.text() + return_code = response.status + response_url = response.url if response.status in RECOVERABLE_ERRORS: LOG.info( @@ -335,7 +340,6 @@ async def async_query( ) as ex: if response and response.status in (429, 503): self._set_retry_after(response) - close_response(response) response = None break LOG.debug( @@ -346,7 +350,7 @@ async def async_query( exc_info=True, ) - return response + return (return_code, response_text, response_url) def query( self, @@ -356,7 +360,7 @@ def query( extra_headers: dict[str, str] | None = None, timeout=1, requires_authentication: bool = True, - ) -> ClientResponse | None: + ) -> tuple[int, str | None, URL | None]: """Query ADT Pulse async. Args: @@ -371,9 +375,8 @@ def query( If true and authenticated flag not set, will wait for flag to be set. Returns: - Optional[ClientResponse]: aiohttp.ClientResponse object - None on failure - ClientResponse will already be closed. + tuple with integer return code, optional response text, and optional URL of + response """ coro = self.async_query( uri, method, extra_params, extra_headers, timeout, requires_authentication @@ -392,9 +395,9 @@ async def query_orb(self, level: int, error_message: str) -> BeautifulSoup | Non Returns: Optional[BeautifulSoup]: A Beautiful Soup object, or None if failure """ - response = await self.async_query(ADT_ORB_URI) + code, response, url = await self.async_query(ADT_ORB_URI) - return await make_soup(response, level, error_message) + return make_soup(code, response, url, level, error_message) def make_url(self, uri: str) -> str: """Create a URL to service host from a URI. @@ -444,7 +447,7 @@ async def async_fetch_version(self) -> None: async def async_do_login_query( self, username: str, password: str, fingerprint: str, timeout: int = 30 - ) -> ClientResponse | None: + ) -> tuple[int, str | None, URL | None]: """ Performs a login query to the Pulse site. @@ -453,14 +456,17 @@ async def async_do_login_query( Defaults to 30. Returns: - ClientResponse | None: The response from the query or None if the login - was unsuccessful. + type of status code (int), response_text Optional[str], and + response url (optional) Raises: ValueError: if login parameters are not correct """ + status = 200 + response_text = None + url = None self.check_login_parameters(username, password, fingerprint) try: - retval = await self.async_query( + status, response_text, url = await self.async_query( ADT_LOGIN_URI, method="POST", extra_params={ @@ -476,21 +482,21 @@ async def async_do_login_query( ) except Exception as e: # pylint: disable=broad-except LOG.error("Could not log into Pulse site: %s", e) - return None - if retval is None: + return (status, response_text, url) + if not status: LOG.error("Could not log into Pulse site.") - return None + return (status, response_text, url) if not handle_response( - retval, + status, + url, logging.ERROR, "Error encountered communicating with Pulse site on login", ): - close_response(retval) - return None + return (status, response_text, url) with self._attribute_lock: self._authenticated_flag.set() self._last_login_time = int(time.time()) - return retval + return (status, response_text, url) async def async_do_logout_query(self, site_id: str | None) -> None: """Performs a logout query to the ADT Pulse site.""" diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 31cc60d..f4069f0 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -224,8 +224,10 @@ async def _get_device_attributes(self, device_id: str) -> dict[str, str] | None: device_response = await self._pulse_connection.async_query( ADT_DEVICE_URI, extra_params={"id": device_id} ) - device_response_soup = await make_soup( - device_response, + device_response_soup = make_soup( + device_response[0], + device_response[1], + device_response[2], logging.DEBUG, "Failed loading device attributes from ADT Pulse service", ) @@ -334,8 +336,10 @@ def check_panel_or_gateway( if not soup: response = await self._pulse_connection.async_query(ADT_SYSTEM_URI) - soup = await make_soup( - response, + soup = make_soup( + response[0], + response[1], + response[2], logging.WARNING, "Failed loading zone status from ADT Pulse service", ) diff --git a/pyadtpulse/tests/test_util.py b/pyadtpulse/tests/test_util.py index 8f89212..0e49858 100644 --- a/pyadtpulse/tests/test_util.py +++ b/pyadtpulse/tests/test_util.py @@ -1,168 +1,11 @@ -# Generated by import logging -from datetime import datetime, timedelta -from bs4 import BeautifulSoup - -from pyadtpulse.util import ( - close_response, - handle_response, - make_soup, - parse_pulse_datetime, - remove_prefix, -) +from pyadtpulse.util import remove_prefix LOG = logging.getLogger(__name__) LOG.setLevel(logging.DEBUG) -class TestHandleResponse: - # Returns True if response is not None and response.ok is True - def test_returns_true_if_response_is_not_none_and_response_ok_is_true(self, mocker): - response = mocker.Mock() - response.ok = True - assert handle_response(response, 0, "") is True - - # Logs nothing if response is not None and response.ok is True - def test_logs_nothing_if_response_is_not_none_and_response_ok_is_true(self, mocker): - response = mocker.Mock() - response.ok = True - mocker.patch("logging.log") - handle_response(response, 0, "") - logging.log.assert_not_called() - - # Logs nothing if response is None - def test_logs_nothing_if_response_is_none_fixed(self, mocker): - mocker.patch("logging.log") - handle_response(None, 0, "") - logging.log.assert_not_called() - - # Returns False if response is None - def test_returns_false_if_response_is_none(self, mocker): - assert handle_response(None, 0, "") is False - - # Logs an error message if response is None - def test_logs_error_message_if_response_is_none(self, mocker): - mocker.patch("pyadtpulse.logging") - handle_response(None, logging.DEBUG, "error") - mocker.assert_called_once_with(logging.DEBUG, "error") - - # Returns False if response.ok is False - def test_returns_false_if_response_ok_is_false(self, mocker): - response = mocker.Mock() - response.ok = False - assert handle_response(response, 0, "") is False - - # Logs an error message if response.ok is False - def test_logs_error_message_if_response_ok_is_false(self, mocker): - response = mocker.Mock() - response.ok = False - response.status = 404 - mocker.patch("logging.log.log") - handle_response(response, 0, "error") - logging.log.assert_called_once_with(0, "error: error code = 404") - - # Returns False if response is not None but response.ok is False - def test_returns_false_if_response_is_not_none_but_response_ok_is_false( - self, mocker - ): - response = mocker.Mock() - response.ok = False - assert handle_response(response, 0, "") is False - - # Closes the response if it is not None - def test_closes_response_if_it_is_not_none(self, mocker): - response = mocker.Mock() - response.ok = True - handle_response(response, 0, "") - assert response.close.call_count == 0 - - # Logs the error message and response status if response is not None but response.ok is False - def test_logs_error_message_and_response_status_if_response_is_not_none_but_response_ok_is_false( - self, mocker - ): - response = mocker.Mock() - response.ok = False - response.status = 404 - logger_mock = mocker.patch("logging.log") - handle_response(response, logging.DEBUG, "error") - logger_mock.log.assert_called_once_with(0, "error: error code = 404") - - # Logs the error message and response status with the specified logging level - def test_logs_error_message_and_response_status_with_specified_logging_level( - self, mocker - ): - response = mocker.Mock() - response.ok = False - response.status = 404 - mocker.patch("logging.log") - handle_response(response, 1, "error") - logging.log.assert_called_once_with(1, "error: error code = 404") - - # Returns True if response is not None and response.ok is True, even if logging fails - def test_returns_true_if_response_is_not_none_and_response_ok_is_true_even_if_logging_fails( - self, mocker - ): - response = mocker.Mock() - response.ok = True - mocker.patch("logging.log", side_effect=Exception) - assert handle_response(response, 0, "") is True - - -# Generated by CodiumAI - -# Dependencies: -# pip install pytest-mock -import pytest - - -class TestCloseResponse: - # Close a response object that is not None and not already closed. - def test_close_response_not_none_not_closed(self, mocker): - response = mocker.Mock() - response.closed = False - close_response(response) - response.close.assert_called_once() - - # Close a response object that is None. - def test_close_response_none(self, mocker): - response = None - close_response(response) - - # Close a response object that is already closed. - def test_close_response_already_closed(self, mocker): - response = mocker.Mock() - response.closed = True - close_response(response) - response.close.assert_not_called() - - # Close a response object that has already been closed and is None. - def test_close_response_closed_none_fixed(self, mocker): - response = None - close_response(response) - - # Close a response object that has already been closed and is not None. - def test_close_response_closed_not_none(self, mocker): - response = mocker.Mock() - response.closed = True - close_response(response) - response.close.assert_not_called() - - # Close a response object that is not None but has a 'closed' attribute that is not a boolean. - def test_close_response_non_boolean_closed_attribute(self, mocker): - response = mocker.Mock() - response.closed = "True" - close_response(response) - response.close.assert_not_called() - - # Close a response object that is not None but has a 'closed' attribute that is not readable. - def test_close_response_non_readable_closed_attribute(self, mocker): - response = mocker.Mock() - response.closed = mocker.PropertyMock(side_effect=AttributeError) - close_response(response) - response.close.assert_not_called() - - class TestRemovePrefix: # prefix is at the beginning of the text def test_prefix_at_beginning(self): @@ -187,219 +30,3 @@ def test_longer_prefix(self): # text is an empty string def test_empty_text(self): assert remove_prefix("", "hello") == "" - - -# Generated by CodiumAI - -# Dependencies: -# pip install pytest-mock -import pytest - - -class TestMakeSoup: - # Returns a BeautifulSoup object when given a valid response - @pytest.mark.asyncio - async def test_valid_response(self, mocker): - response = mocker.Mock() - response.ok = True - response.text.return_value = "

Test

" - make_soup_mock = mocker.patch("module.make_soup", side_effect=make_soup) - result = await make_soup(response, 1, "Error") - assert isinstance(result, BeautifulSoup) - assert result.text == "

Test

" - make_soup_mock.assert_called_once_with(response, 1, "Error") - - # Closes the response object after extracting text - @pytest.mark.asyncio - async def test_close_response(self, mocker): - response = mocker.Mock() - response.ok = True - response.text.return_value = "

Test

" - close_mock = mocker.patch.object(response, "close") - await make_soup(response, 1, "Error") - close_mock.assert_called_once() - - # Returns None when given a None response - @pytest.mark.asyncio - async def test_none_response(self, mocker): - result = await make_soup(None, 1, "Error") - assert result is None - - # Returns None when given a response with a non-OK status code - @pytest.mark.asyncio - async def test_non_ok_response(self, mocker): - response = mocker.Mock() - response.ok = False - response.status = 404 - result = await make_soup(response, 1, "Error") - assert result is None - - # Returns None when an exception is raised while extracting text - @pytest.mark.asyncio - async def test_exception_raised(self, mocker): - response = mocker.Mock() - response.ok = True - response.text.side_effect = Exception("Error") - result = await make_soup(response, 1, "Error") - assert result is None - - # Logs an error message when given a None response - @pytest.mark.asyncio - async def test_log_none_response(self, mocker): - mocker.patch("logging.log") - await make_soup(None, 1, "Error") - logging.log.assert_called_once_with(1, "Error") - - # Logs an error message when given a response with a non-OK status code - @pytest.mark.asyncio - async def test_log_non_ok_response(self, mocker): - mocker.patch("logging.log") - response = mocker.Mock() - response.ok = False - response.status = 404 - await make_soup(response, 1, "Error") - logging.log.assert_called_once_with(1, "Error: error code = 404") - - # Handles a response with an empty body - @pytest.mark.asyncio - async def test_empty_body(self, mocker): - response = mocker.Mock() - response.ok = True - response.text.return_value = "" - result = await make_soup(response, 1, "Error") - assert result is None - - # Handles a response with a non-HTML content type - @pytest.mark.asyncio - async def test_non_html_content_type(self, mocker): - response = mocker.Mock() - response.ok = True - response.headers = {"Content-Type": "application/json"} - result = await make_soup(response, 1, "Error") - assert result is None - - # Handles a response with a malformed HTML body - @pytest.mark.asyncio - async def test_malformed_html_body(self, mocker): - response = mocker.Mock() - response.ok = True - response.text.return_value = "

Test

" - result = await make_soup(response, 1, "Error") - assert result is None - - -class TestParsePulseDatetime: - # Parses a valid datestring with "Today" as the first element of the split string and an extra string after the time - def test_parses_valid_datestring_with_today_with_extra_string(self): - datestring = "Today\xa012:34PM" - expected_result = datetime.combine( - datetime.today(), datetime.strptime("12:34PM", "%I:%M%p").time() - ) - assert parse_pulse_datetime(datestring) == expected_result - - # Parses a valid datestring with "Yesterday" as the first element of the split string, with a valid time string as the second element of the split string - def test_parses_valid_datestring_with_yesterday_fixed_fixed(self): - datestring = "Yesterday\xa0\xa012:34PM" - expected_result = datetime.combine( - datetime.today() - timedelta(days=1), - datetime.strptime("12:34PM", "%I:%M%p").time(), - ) - assert parse_pulse_datetime(datestring) == expected_result - - # Parses a valid datestring with a date string as the first element of the split string - def test_parses_valid_datestring_with_date_string(self): - datestring = "01/01\xa0\xa012:34PM" - expected_result = datetime.combine( - datetime(datetime.now().year, 1, 1), - datetime.strptime("12:34PM", "%I:%M%p").time(), - ) - assert parse_pulse_datetime(datestring) == expected_result - - # Parses a valid datestring with a time string as the second element of the split string - def test_parses_valid_datestring_with_time_string(self): - datestring = "Today\xa012:34PM\xa0" - expected_result = datetime.combine( - datetime.today(), datetime.strptime("12:34PM", "%I:%M%p").time() - ) - assert parse_pulse_datetime(datestring) == expected_result - - # Parses a valid datestring with a time period string as the third element of the split string - def test_parses_valid_datestring_with_time_period_string(self): - datestring = "Today\xa0\xa012:34PM" - expected_result = datetime.combine( - datetime.today(), datetime.strptime("12:34PM", "%I:%M%p").time() - ) - assert parse_pulse_datetime(datestring) == expected_result - - # Returns a datetime object for a valid datestring - def test_returns_datetime_object_for_valid_datestring(self): - datestring = "Today\xa012:34PM\xa0" - assert isinstance(parse_pulse_datetime(datestring), datetime) - - # Raises a ValueError for an invalid datestring with less than 3 elements - def test_raises_value_error_for_invalid_datestring_with_less_than_3_elements(self): - datestring = "Today" - with pytest.raises(ValueError): - parse_pulse_datetime(datestring) - - # Raises a ValueError for an invalid datestring with an invalid date string as the first element of the split string - def test_raises_value_error_for_invalid_datestring_with_invalid_date_string(self): - datestring = "InvalidDate\xa012:34PM" - with pytest.raises(ValueError): - parse_pulse_datetime(datestring) - - # Raises a ValueError for an invalid datestring with an invalid time string as the second element of the split string - def test_raises_value_error_for_invalid_datestring_with_invalid_time_string(self): - datestring = "Today\xa0InvalidTime" - with pytest.raises(ValueError): - parse_pulse_datetime(datestring) - - # Raises a ValueError for an invalid datestring with an invalid time period string as the third element of the split string - def test_raises_value_error_for_invalid_datestring_with_invalid_time_period_string( - self, - ): - datestring = "Today\xa012:34InvalidPeriod" - with pytest.raises(ValueError): - parse_pulse_datetime(datestring) - - # Returns a datetime object for a valid datestring with a year greater than the current year - def test_returns_datetime_object_for_valid_datestring_with_year_greater_than_current_year( - self, - ): - datestring = "01/01/2023\xa0\xa012:34PM" - with pytest.raises(ValueError): - parse_pulse_datetime(datestring) - - # Returns a datetime object with the current year for a valid datestring with a year less than the current year - def test_returns_datetime_object_with_current_year_for_valid_datestring_with_year_less_than_current_year( - self, - ): - datestring = "01/01\xa0\xa012:34PM" - expected_result = datetime.combine( - datetime.strptime("01/01", "%m/%d").replace(year=datetime.now().year), - datetime.strptime("12:34PM", "%I:%M%p").time(), - ) - assert parse_pulse_datetime(datestring) == expected_result - - # Parses a valid datestring with "Today" as the first element of the split string - def test_parses_valid_datestring_with_today(self): - datestring = "Today\xa0\xa012:34PM" - expected_result = datetime.combine( - datetime.today(), datetime.strptime("12:34PM", "%I:%M%p").time() - ) - assert parse_pulse_datetime(datestring) == expected_result - - # Parses a valid datestring with "Yesterday" as the first element of the split string - def test_parses_valid_datestring_with_yesterday(self): - datestring = "Yesterday\xa012:34PM\xa0" - expected_result = datetime.combine( - datetime.today() - timedelta(days=1), - datetime.strptime("12:34PM", "%I:%M%p").time(), - ) - assert parse_pulse_datetime(datestring) == expected_result - - # Parses a valid datestring with a time string in 24-hour format - def test_parses_valid_datestring_with_24_hour_format(self): - datestring = "01/01/2022\xa012:34\xa0AM" - with pytest.raises(ValueError): - parse_pulse_datetime(datestring) diff --git a/pyadtpulse/util.py b/pyadtpulse/util.py index 0b0d8db..e9b0280 100644 --- a/pyadtpulse/util.py +++ b/pyadtpulse/util.py @@ -8,81 +8,66 @@ from random import randint from threading import RLock, current_thread -from aiohttp import ClientResponse from bs4 import BeautifulSoup +from yarl import URL LOG = logging.getLogger(__name__) -def handle_response( - response: ClientResponse | None, level: int, error_message: str -) -> bool: - """Handle the response from query(). +def remove_prefix(text: str, prefix: str) -> str: + """Remove prefix from a string. Args: - response (Optional[Response]): the response from the query() - level (int): Level to log on error (i.e. INFO, DEBUG) - error_message (str): the error message + text (str): original text + prefix (str): prefix to remove Returns: - bool: True if no error occurred. - """ - if response is None: - LOG.log(level, "%s", error_message) - return False - - if response.ok: - return True - - LOG.log(level, "%s: error code = %s", error_message, response.status) - - return False - - -def close_response(response: ClientResponse | None) -> None: - """Close a response object, handles None. - - Args: - response (Optional[ClientResponse]): ClientResponse object to close + str: modified string """ - if response is not None and not response.closed: - response.close() + return text[text.startswith(prefix) and len(prefix) :] -def remove_prefix(text: str, prefix: str) -> str: - """Remove prefix from a string. +def handle_response(code: int, url: URL | None, level: int, error_message: str) -> bool: + """Handle the response from query(). Args: - text (str): original text - prefix (str): prefix to remove + code (int): the return code + level (int): Level to log on error (i.e. INFO, DEBUG) + error_message (str): the error message Returns: - str: modified string + bool: True if no error occurred. """ - return text[text.startswith(prefix) and len(prefix) :] + if code >= 400: + LOG.log(level, "%s: error code = %s from %s", error_message, code, url) + return False + return True -async def make_soup( - response: ClientResponse | None, level: int, error_message: str +def make_soup( + code: int, + response_text: str | None, + url: URL | None, + level: int, + error_message: str, ) -> BeautifulSoup | None: """Make a BS object from a Response. Args: - response (Optional[Response]): the response + code (int): the return code + response_text Optional(str): the response text level (int): the logging level on error error_message (str): the error message Returns: Optional[BeautifulSoup]: a BS object, or None on failure """ - if not handle_response(response, level, error_message): + if not handle_response(code, url, level, error_message): return None - - if response is None: # shut up type checker + if response_text is None: + LOG.log(level, "%s: no response received from %s", error_message, url) return None - body_text = await response.text() - response.close() - return BeautifulSoup(body_text, "html.parser") + return BeautifulSoup(response_text, "html.parser") FINGERPRINT_LENGTH = 2292 From 00b5ab77fba81daf22d151cd6b440bb2739fd3cc Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 05:59:17 -0500 Subject: [PATCH 069/226] move build system to poetry --- poetry.lock | 1297 ++++++++++++++++++++++++++++++++++++++++++++++++ pyproject.toml | 51 +- 2 files changed, 1332 insertions(+), 16 deletions(-) create mode 100644 poetry.lock diff --git a/poetry.lock b/poetry.lock new file mode 100644 index 0000000..6066992 --- /dev/null +++ b/poetry.lock @@ -0,0 +1,1297 @@ +# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand. + +[[package]] +name = "aiohttp" +version = "3.8.6" +description = "Async http client/server framework (asyncio)" +optional = false +python-versions = ">=3.6" +files = [ + {file = "aiohttp-3.8.6-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:41d55fc043954cddbbd82503d9cc3f4814a40bcef30b3569bc7b5e34130718c1"}, + {file = "aiohttp-3.8.6-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:1d84166673694841d8953f0a8d0c90e1087739d24632fe86b1a08819168b4566"}, + {file = "aiohttp-3.8.6-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:253bf92b744b3170eb4c4ca2fa58f9c4b87aeb1df42f71d4e78815e6e8b73c9e"}, + {file = "aiohttp-3.8.6-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3fd194939b1f764d6bb05490987bfe104287bbf51b8d862261ccf66f48fb4096"}, + {file = "aiohttp-3.8.6-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:6c5f938d199a6fdbdc10bbb9447496561c3a9a565b43be564648d81e1102ac22"}, + {file = "aiohttp-3.8.6-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2817b2f66ca82ee699acd90e05c95e79bbf1dc986abb62b61ec8aaf851e81c93"}, + {file = "aiohttp-3.8.6-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0fa375b3d34e71ccccf172cab401cd94a72de7a8cc01847a7b3386204093bb47"}, + {file = "aiohttp-3.8.6-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9de50a199b7710fa2904be5a4a9b51af587ab24c8e540a7243ab737b45844543"}, + {file = "aiohttp-3.8.6-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:e1d8cb0b56b3587c5c01de3bf2f600f186da7e7b5f7353d1bf26a8ddca57f965"}, + {file = "aiohttp-3.8.6-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:8e31e9db1bee8b4f407b77fd2507337a0a80665ad7b6c749d08df595d88f1cf5"}, + {file = "aiohttp-3.8.6-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:7bc88fc494b1f0311d67f29fee6fd636606f4697e8cc793a2d912ac5b19aa38d"}, + {file = "aiohttp-3.8.6-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:ec00c3305788e04bf6d29d42e504560e159ccaf0be30c09203b468a6c1ccd3b2"}, + {file = "aiohttp-3.8.6-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:ad1407db8f2f49329729564f71685557157bfa42b48f4b93e53721a16eb813ed"}, + {file = "aiohttp-3.8.6-cp310-cp310-win32.whl", hash = "sha256:ccc360e87341ad47c777f5723f68adbb52b37ab450c8bc3ca9ca1f3e849e5fe2"}, + {file = "aiohttp-3.8.6-cp310-cp310-win_amd64.whl", hash = "sha256:93c15c8e48e5e7b89d5cb4613479d144fda8344e2d886cf694fd36db4cc86865"}, + {file = "aiohttp-3.8.6-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:6e2f9cc8e5328f829f6e1fb74a0a3a939b14e67e80832975e01929e320386b34"}, + {file = "aiohttp-3.8.6-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:e6a00ffcc173e765e200ceefb06399ba09c06db97f401f920513a10c803604ca"}, + {file = "aiohttp-3.8.6-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:41bdc2ba359032e36c0e9de5a3bd00d6fb7ea558a6ce6b70acedf0da86458321"}, + {file = "aiohttp-3.8.6-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:14cd52ccf40006c7a6cd34a0f8663734e5363fd981807173faf3a017e202fec9"}, + {file = "aiohttp-3.8.6-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:2d5b785c792802e7b275c420d84f3397668e9d49ab1cb52bd916b3b3ffcf09ad"}, + {file = "aiohttp-3.8.6-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1bed815f3dc3d915c5c1e556c397c8667826fbc1b935d95b0ad680787896a358"}, + {file = "aiohttp-3.8.6-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:96603a562b546632441926cd1293cfcb5b69f0b4159e6077f7c7dbdfb686af4d"}, + {file = "aiohttp-3.8.6-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d76e8b13161a202d14c9584590c4df4d068c9567c99506497bdd67eaedf36403"}, + {file = "aiohttp-3.8.6-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:e3f1e3f1a1751bb62b4a1b7f4e435afcdade6c17a4fd9b9d43607cebd242924a"}, + {file = "aiohttp-3.8.6-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:76b36b3124f0223903609944a3c8bf28a599b2cc0ce0be60b45211c8e9be97f8"}, + {file = "aiohttp-3.8.6-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:a2ece4af1f3c967a4390c284797ab595a9f1bc1130ef8b01828915a05a6ae684"}, + {file = "aiohttp-3.8.6-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:16d330b3b9db87c3883e565340d292638a878236418b23cc8b9b11a054aaa887"}, + {file = "aiohttp-3.8.6-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:42c89579f82e49db436b69c938ab3e1559e5a4409eb8639eb4143989bc390f2f"}, + {file = "aiohttp-3.8.6-cp311-cp311-win32.whl", hash = "sha256:efd2fcf7e7b9d7ab16e6b7d54205beded0a9c8566cb30f09c1abe42b4e22bdcb"}, + {file = "aiohttp-3.8.6-cp311-cp311-win_amd64.whl", hash = "sha256:3b2ab182fc28e7a81f6c70bfbd829045d9480063f5ab06f6e601a3eddbbd49a0"}, + {file = "aiohttp-3.8.6-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:fdee8405931b0615220e5ddf8cd7edd8592c606a8e4ca2a00704883c396e4479"}, + {file = "aiohttp-3.8.6-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d25036d161c4fe2225d1abff2bd52c34ed0b1099f02c208cd34d8c05729882f0"}, + {file = "aiohttp-3.8.6-cp36-cp36m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5d791245a894be071d5ab04bbb4850534261a7d4fd363b094a7b9963e8cdbd31"}, + {file = "aiohttp-3.8.6-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:0cccd1de239afa866e4ce5c789b3032442f19c261c7d8a01183fd956b1935349"}, + {file = "aiohttp-3.8.6-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1f13f60d78224f0dace220d8ab4ef1dbc37115eeeab8c06804fec11bec2bbd07"}, + {file = "aiohttp-3.8.6-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:8a9b5a0606faca4f6cc0d338359d6fa137104c337f489cd135bb7fbdbccb1e39"}, + {file = "aiohttp-3.8.6-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:13da35c9ceb847732bf5c6c5781dcf4780e14392e5d3b3c689f6d22f8e15ae31"}, + {file = "aiohttp-3.8.6-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:4d4cbe4ffa9d05f46a28252efc5941e0462792930caa370a6efaf491f412bc66"}, + {file = "aiohttp-3.8.6-cp36-cp36m-musllinux_1_1_ppc64le.whl", hash = "sha256:229852e147f44da0241954fc6cb910ba074e597f06789c867cb7fb0621e0ba7a"}, + {file = "aiohttp-3.8.6-cp36-cp36m-musllinux_1_1_s390x.whl", hash = "sha256:713103a8bdde61d13490adf47171a1039fd880113981e55401a0f7b42c37d071"}, + {file = "aiohttp-3.8.6-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:45ad816b2c8e3b60b510f30dbd37fe74fd4a772248a52bb021f6fd65dff809b6"}, + {file = "aiohttp-3.8.6-cp36-cp36m-win32.whl", hash = "sha256:2b8d4e166e600dcfbff51919c7a3789ff6ca8b3ecce16e1d9c96d95dd569eb4c"}, + {file = "aiohttp-3.8.6-cp36-cp36m-win_amd64.whl", hash = "sha256:0912ed87fee967940aacc5306d3aa8ba3a459fcd12add0b407081fbefc931e53"}, + {file = "aiohttp-3.8.6-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:e2a988a0c673c2e12084f5e6ba3392d76c75ddb8ebc6c7e9ead68248101cd446"}, + {file = "aiohttp-3.8.6-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ebf3fd9f141700b510d4b190094db0ce37ac6361a6806c153c161dc6c041ccda"}, + {file = "aiohttp-3.8.6-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3161ce82ab85acd267c8f4b14aa226047a6bee1e4e6adb74b798bd42c6ae1f80"}, + {file = "aiohttp-3.8.6-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d95fc1bf33a9a81469aa760617b5971331cdd74370d1214f0b3109272c0e1e3c"}, + {file = "aiohttp-3.8.6-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c43ecfef7deaf0617cee936836518e7424ee12cb709883f2c9a1adda63cc460"}, + {file = "aiohttp-3.8.6-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ca80e1b90a05a4f476547f904992ae81eda5c2c85c66ee4195bb8f9c5fb47f28"}, + {file = "aiohttp-3.8.6-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:90c72ebb7cb3a08a7f40061079817133f502a160561d0675b0a6adf231382c92"}, + {file = "aiohttp-3.8.6-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:bb54c54510e47a8c7c8e63454a6acc817519337b2b78606c4e840871a3e15349"}, + {file = "aiohttp-3.8.6-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:de6a1c9f6803b90e20869e6b99c2c18cef5cc691363954c93cb9adeb26d9f3ae"}, + {file = "aiohttp-3.8.6-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:a3628b6c7b880b181a3ae0a0683698513874df63783fd89de99b7b7539e3e8a8"}, + {file = "aiohttp-3.8.6-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:fc37e9aef10a696a5a4474802930079ccfc14d9f9c10b4662169671ff034b7df"}, + {file = "aiohttp-3.8.6-cp37-cp37m-win32.whl", hash = "sha256:f8ef51e459eb2ad8e7a66c1d6440c808485840ad55ecc3cafefadea47d1b1ba2"}, + {file = "aiohttp-3.8.6-cp37-cp37m-win_amd64.whl", hash = "sha256:b2fe42e523be344124c6c8ef32a011444e869dc5f883c591ed87f84339de5976"}, + {file = "aiohttp-3.8.6-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:9e2ee0ac5a1f5c7dd3197de309adfb99ac4617ff02b0603fd1e65b07dc772e4b"}, + {file = "aiohttp-3.8.6-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:01770d8c04bd8db568abb636c1fdd4f7140b284b8b3e0b4584f070180c1e5c62"}, + {file = "aiohttp-3.8.6-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:3c68330a59506254b556b99a91857428cab98b2f84061260a67865f7f52899f5"}, + {file = "aiohttp-3.8.6-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:89341b2c19fb5eac30c341133ae2cc3544d40d9b1892749cdd25892bbc6ac951"}, + {file = "aiohttp-3.8.6-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:71783b0b6455ac8f34b5ec99d83e686892c50498d5d00b8e56d47f41b38fbe04"}, + {file = "aiohttp-3.8.6-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f628dbf3c91e12f4d6c8b3f092069567d8eb17814aebba3d7d60c149391aee3a"}, + {file = "aiohttp-3.8.6-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b04691bc6601ef47c88f0255043df6f570ada1a9ebef99c34bd0b72866c217ae"}, + {file = "aiohttp-3.8.6-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7ee912f7e78287516df155f69da575a0ba33b02dd7c1d6614dbc9463f43066e3"}, + {file = "aiohttp-3.8.6-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:9c19b26acdd08dd239e0d3669a3dddafd600902e37881f13fbd8a53943079dbc"}, + {file = "aiohttp-3.8.6-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:99c5ac4ad492b4a19fc132306cd57075c28446ec2ed970973bbf036bcda1bcc6"}, + {file = "aiohttp-3.8.6-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:f0f03211fd14a6a0aed2997d4b1c013d49fb7b50eeb9ffdf5e51f23cfe2c77fa"}, + {file = "aiohttp-3.8.6-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:8d399dade330c53b4106160f75f55407e9ae7505263ea86f2ccca6bfcbdb4921"}, + {file = "aiohttp-3.8.6-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:ec4fd86658c6a8964d75426517dc01cbf840bbf32d055ce64a9e63a40fd7b771"}, + {file = "aiohttp-3.8.6-cp38-cp38-win32.whl", hash = "sha256:33164093be11fcef3ce2571a0dccd9041c9a93fa3bde86569d7b03120d276c6f"}, + {file = "aiohttp-3.8.6-cp38-cp38-win_amd64.whl", hash = "sha256:bdf70bfe5a1414ba9afb9d49f0c912dc524cf60141102f3a11143ba3d291870f"}, + {file = "aiohttp-3.8.6-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:d52d5dc7c6682b720280f9d9db41d36ebe4791622c842e258c9206232251ab2b"}, + {file = "aiohttp-3.8.6-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:4ac39027011414dbd3d87f7edb31680e1f430834c8cef029f11c66dad0670aa5"}, + {file = "aiohttp-3.8.6-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:3f5c7ce535a1d2429a634310e308fb7d718905487257060e5d4598e29dc17f0b"}, + {file = "aiohttp-3.8.6-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b30e963f9e0d52c28f284d554a9469af073030030cef8693106d918b2ca92f54"}, + {file = "aiohttp-3.8.6-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:918810ef188f84152af6b938254911055a72e0f935b5fbc4c1a4ed0b0584aed1"}, + {file = "aiohttp-3.8.6-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:002f23e6ea8d3dd8d149e569fd580c999232b5fbc601c48d55398fbc2e582e8c"}, + {file = "aiohttp-3.8.6-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4fcf3eabd3fd1a5e6092d1242295fa37d0354b2eb2077e6eb670accad78e40e1"}, + {file = "aiohttp-3.8.6-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:255ba9d6d5ff1a382bb9a578cd563605aa69bec845680e21c44afc2670607a95"}, + {file = "aiohttp-3.8.6-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d67f8baed00870aa390ea2590798766256f31dc5ed3ecc737debb6e97e2ede78"}, + {file = "aiohttp-3.8.6-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:86f20cee0f0a317c76573b627b954c412ea766d6ada1a9fcf1b805763ae7feeb"}, + {file = "aiohttp-3.8.6-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:39a312d0e991690ccc1a61f1e9e42daa519dcc34ad03eb6f826d94c1190190dd"}, + {file = "aiohttp-3.8.6-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:e827d48cf802de06d9c935088c2924e3c7e7533377d66b6f31ed175c1620e05e"}, + {file = "aiohttp-3.8.6-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:bd111d7fc5591ddf377a408ed9067045259ff2770f37e2d94e6478d0f3fc0c17"}, + {file = "aiohttp-3.8.6-cp39-cp39-win32.whl", hash = "sha256:caf486ac1e689dda3502567eb89ffe02876546599bbf915ec94b1fa424eeffd4"}, + {file = "aiohttp-3.8.6-cp39-cp39-win_amd64.whl", hash = "sha256:3f0e27e5b733803333bb2371249f41cf42bae8884863e8e8965ec69bebe53132"}, + {file = "aiohttp-3.8.6.tar.gz", hash = "sha256:b0cf2a4501bff9330a8a5248b4ce951851e415bdcce9dc158e76cfd55e15085c"}, +] + +[package.dependencies] +aiosignal = ">=1.1.2" +async-timeout = ">=4.0.0a3,<5.0" +attrs = ">=17.3.0" +charset-normalizer = ">=2.0,<4.0" +frozenlist = ">=1.1.1" +multidict = ">=4.5,<7.0" +yarl = ">=1.0,<2.0" + +[package.extras] +speedups = ["Brotli", "aiodns", "cchardet"] + +[[package]] +name = "aiosignal" +version = "1.3.1" +description = "aiosignal: a list of registered asynchronous callbacks" +optional = false +python-versions = ">=3.7" +files = [ + {file = "aiosignal-1.3.1-py3-none-any.whl", hash = "sha256:f8376fb07dd1e86a584e4fcdec80b36b7f81aac666ebc724e2c090300dd83b17"}, + {file = "aiosignal-1.3.1.tar.gz", hash = "sha256:54cd96e15e1649b75d6c87526a6ff0b6c1b0dd3459f43d9ca11d48c339b68cfc"}, +] + +[package.dependencies] +frozenlist = ">=1.1.0" + +[[package]] +name = "astroid" +version = "3.0.1" +description = "An abstract syntax tree for Python with inference support." +optional = false +python-versions = ">=3.8.0" +files = [ + {file = "astroid-3.0.1-py3-none-any.whl", hash = "sha256:7d5895c9825e18079c5aeac0572bc2e4c83205c95d416e0b4fee8bc361d2d9ca"}, + {file = "astroid-3.0.1.tar.gz", hash = "sha256:86b0bb7d7da0be1a7c4aedb7974e391b32d4ed89e33de6ed6902b4b15c97577e"}, +] + +[[package]] +name = "async-timeout" +version = "4.0.3" +description = "Timeout context manager for asyncio programs" +optional = false +python-versions = ">=3.7" +files = [ + {file = "async-timeout-4.0.3.tar.gz", hash = "sha256:4640d96be84d82d02ed59ea2b7105a0f7b33abe8703703cd0ab0bf87c427522f"}, + {file = "async_timeout-4.0.3-py3-none-any.whl", hash = "sha256:7405140ff1230c310e51dc27b3145b9092d659ce68ff733fb0cefe3ee42be028"}, +] + +[[package]] +name = "attrs" +version = "23.1.0" +description = "Classes Without Boilerplate" +optional = false +python-versions = ">=3.7" +files = [ + {file = "attrs-23.1.0-py3-none-any.whl", hash = "sha256:1f28b4522cdc2fb4256ac1a020c78acf9cba2c6b461ccd2c126f3aa8e8335d04"}, + {file = "attrs-23.1.0.tar.gz", hash = "sha256:6279836d581513a26f1bf235f9acd333bc9115683f14f7e8fae46c98fc50e015"}, +] + +[package.extras] +cov = ["attrs[tests]", "coverage[toml] (>=5.3)"] +dev = ["attrs[docs,tests]", "pre-commit"] +docs = ["furo", "myst-parser", "sphinx", "sphinx-notfound-page", "sphinxcontrib-towncrier", "towncrier", "zope-interface"] +tests = ["attrs[tests-no-zope]", "zope-interface"] +tests-no-zope = ["cloudpickle", "hypothesis", "mypy (>=1.1.1)", "pympler", "pytest (>=4.3.0)", "pytest-mypy-plugins", "pytest-xdist[psutil]"] + +[[package]] +name = "beautifulsoup4" +version = "4.12.2" +description = "Screen-scraping library" +optional = false +python-versions = ">=3.6.0" +files = [ + {file = "beautifulsoup4-4.12.2-py3-none-any.whl", hash = "sha256:bd2520ca0d9d7d12694a53d44ac482d181b4ec1888909b035a3dbf40d0f57d4a"}, + {file = "beautifulsoup4-4.12.2.tar.gz", hash = "sha256:492bbc69dca35d12daac71c4db1bfff0c876c00ef4a2ffacce226d4638eb72da"}, +] + +[package.dependencies] +soupsieve = ">1.2" + +[package.extras] +html5lib = ["html5lib"] +lxml = ["lxml"] + +[[package]] +name = "black" +version = "23.10.1" +description = "The uncompromising code formatter." +optional = false +python-versions = ">=3.8" +files = [ + {file = "black-23.10.1-cp310-cp310-macosx_10_16_arm64.whl", hash = "sha256:ec3f8e6234c4e46ff9e16d9ae96f4ef69fa328bb4ad08198c8cee45bb1f08c69"}, + {file = "black-23.10.1-cp310-cp310-macosx_10_16_x86_64.whl", hash = "sha256:1b917a2aa020ca600483a7b340c165970b26e9029067f019e3755b56e8dd5916"}, + {file = "black-23.10.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9c74de4c77b849e6359c6f01987e94873c707098322b91490d24296f66d067dc"}, + {file = "black-23.10.1-cp310-cp310-win_amd64.whl", hash = "sha256:7b4d10b0f016616a0d93d24a448100adf1699712fb7a4efd0e2c32bbb219b173"}, + {file = "black-23.10.1-cp311-cp311-macosx_10_16_arm64.whl", hash = "sha256:b15b75fc53a2fbcac8a87d3e20f69874d161beef13954747e053bca7a1ce53a0"}, + {file = "black-23.10.1-cp311-cp311-macosx_10_16_x86_64.whl", hash = "sha256:e293e4c2f4a992b980032bbd62df07c1bcff82d6964d6c9496f2cd726e246ace"}, + {file = "black-23.10.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7d56124b7a61d092cb52cce34182a5280e160e6aff3137172a68c2c2c4b76bcb"}, + {file = "black-23.10.1-cp311-cp311-win_amd64.whl", hash = "sha256:3f157a8945a7b2d424da3335f7ace89c14a3b0625e6593d21139c2d8214d55ce"}, + {file = "black-23.10.1-cp38-cp38-macosx_10_16_arm64.whl", hash = "sha256:cfcce6f0a384d0da692119f2d72d79ed07c7159879d0bb1bb32d2e443382bf3a"}, + {file = "black-23.10.1-cp38-cp38-macosx_10_16_x86_64.whl", hash = "sha256:33d40f5b06be80c1bbce17b173cda17994fbad096ce60eb22054da021bf933d1"}, + {file = "black-23.10.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:840015166dbdfbc47992871325799fd2dc0dcf9395e401ada6d88fe11498abad"}, + {file = "black-23.10.1-cp38-cp38-win_amd64.whl", hash = "sha256:037e9b4664cafda5f025a1728c50a9e9aedb99a759c89f760bd83730e76ba884"}, + {file = "black-23.10.1-cp39-cp39-macosx_10_16_arm64.whl", hash = "sha256:7cb5936e686e782fddb1c73f8aa6f459e1ad38a6a7b0e54b403f1f05a1507ee9"}, + {file = "black-23.10.1-cp39-cp39-macosx_10_16_x86_64.whl", hash = "sha256:7670242e90dc129c539e9ca17665e39a146a761e681805c54fbd86015c7c84f7"}, + {file = "black-23.10.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5ed45ac9a613fb52dad3b61c8dea2ec9510bf3108d4db88422bacc7d1ba1243d"}, + {file = "black-23.10.1-cp39-cp39-win_amd64.whl", hash = "sha256:6d23d7822140e3fef190734216cefb262521789367fbdc0b3f22af6744058982"}, + {file = "black-23.10.1-py3-none-any.whl", hash = "sha256:d431e6739f727bb2e0495df64a6c7a5310758e87505f5f8cde9ff6c0f2d7e4fe"}, + {file = "black-23.10.1.tar.gz", hash = "sha256:1f8ce316753428ff68749c65a5f7844631aa18c8679dfd3ca9dc1a289979c258"}, +] + +[package.dependencies] +click = ">=8.0.0" +mypy-extensions = ">=0.4.3" +packaging = ">=22.0" +pathspec = ">=0.9.0" +platformdirs = ">=2" + +[package.extras] +colorama = ["colorama (>=0.4.3)"] +d = ["aiohttp (>=3.7.4)"] +jupyter = ["ipython (>=7.8.0)", "tokenize-rt (>=3.2.0)"] +uvloop = ["uvloop (>=0.15.2)"] + +[[package]] +name = "cfgv" +version = "3.4.0" +description = "Validate configuration and produce human readable error messages." +optional = false +python-versions = ">=3.8" +files = [ + {file = "cfgv-3.4.0-py2.py3-none-any.whl", hash = "sha256:b7265b1f29fd3316bfcd2b330d63d024f2bfd8bcb8b0272f8e19a504856c48f9"}, + {file = "cfgv-3.4.0.tar.gz", hash = "sha256:e52591d4c5f5dead8e0f673fb16db7949d2cfb3f7da4582893288f0ded8fe560"}, +] + +[[package]] +name = "charset-normalizer" +version = "3.3.2" +description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet." +optional = false +python-versions = ">=3.7.0" +files = [ + {file = "charset-normalizer-3.3.2.tar.gz", hash = "sha256:f30c3cb33b24454a82faecaf01b19c18562b1e89558fb6c56de4d9118a032fd5"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:25baf083bf6f6b341f4121c2f3c548875ee6f5339300e08be3f2b2ba1721cdd3"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:06435b539f889b1f6f4ac1758871aae42dc3a8c0e24ac9e60c2384973ad73027"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9063e24fdb1e498ab71cb7419e24622516c4a04476b17a2dab57e8baa30d6e03"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6897af51655e3691ff853668779c7bad41579facacf5fd7253b0133308cf000d"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1d3193f4a680c64b4b6a9115943538edb896edc190f0b222e73761716519268e"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cd70574b12bb8a4d2aaa0094515df2463cb429d8536cfb6c7ce983246983e5a6"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8465322196c8b4d7ab6d1e049e4c5cb460d0394da4a27d23cc242fbf0034b6b5"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a9a8e9031d613fd2009c182b69c7b2c1ef8239a0efb1df3f7c8da66d5dd3d537"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:beb58fe5cdb101e3a055192ac291b7a21e3b7ef4f67fa1d74e331a7f2124341c"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:e06ed3eb3218bc64786f7db41917d4e686cc4856944f53d5bdf83a6884432e12"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:2e81c7b9c8979ce92ed306c249d46894776a909505d8f5a4ba55b14206e3222f"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:572c3763a264ba47b3cf708a44ce965d98555f618ca42c926a9c1616d8f34269"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fd1abc0d89e30cc4e02e4064dc67fcc51bd941eb395c502aac3ec19fab46b519"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-win32.whl", hash = "sha256:3d47fa203a7bd9c5b6cee4736ee84ca03b8ef23193c0d1ca99b5089f72645c73"}, + {file = "charset_normalizer-3.3.2-cp310-cp310-win_amd64.whl", hash = "sha256:10955842570876604d404661fbccbc9c7e684caf432c09c715ec38fbae45ae09"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:802fe99cca7457642125a8a88a084cef28ff0cf9407060f7b93dca5aa25480db"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:573f6eac48f4769d667c4442081b1794f52919e7edada77495aaed9236d13a96"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:549a3a73da901d5bc3ce8d24e0600d1fa85524c10287f6004fbab87672bf3e1e"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f27273b60488abe721a075bcca6d7f3964f9f6f067c8c4c605743023d7d3944f"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1ceae2f17a9c33cb48e3263960dc5fc8005351ee19db217e9b1bb15d28c02574"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:65f6f63034100ead094b8744b3b97965785388f308a64cf8d7c34f2f2e5be0c4"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:753f10e867343b4511128c6ed8c82f7bec3bd026875576dfd88483c5c73b2fd8"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4a78b2b446bd7c934f5dcedc588903fb2f5eec172f3d29e52a9096a43722adfc"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:e537484df0d8f426ce2afb2d0f8e1c3d0b114b83f8850e5f2fbea0e797bd82ae"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:eb6904c354526e758fda7167b33005998fb68c46fbc10e013ca97f21ca5c8887"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:deb6be0ac38ece9ba87dea880e438f25ca3eddfac8b002a2ec3d9183a454e8ae"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:4ab2fe47fae9e0f9dee8c04187ce5d09f48eabe611be8259444906793ab7cbce"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:80402cd6ee291dcb72644d6eac93785fe2c8b9cb30893c1af5b8fdd753b9d40f"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-win32.whl", hash = "sha256:7cd13a2e3ddeed6913a65e66e94b51d80a041145a026c27e6bb76c31a853c6ab"}, + {file = "charset_normalizer-3.3.2-cp311-cp311-win_amd64.whl", hash = "sha256:663946639d296df6a2bb2aa51b60a2454ca1cb29835324c640dafb5ff2131a77"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:0b2b64d2bb6d3fb9112bafa732def486049e63de9618b5843bcdd081d8144cd8"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:ddbb2551d7e0102e7252db79ba445cdab71b26640817ab1e3e3648dad515003b"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:55086ee1064215781fff39a1af09518bc9255b50d6333f2e4c74ca09fac6a8f6"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8f4a014bc36d3c57402e2977dada34f9c12300af536839dc38c0beab8878f38a"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a10af20b82360ab00827f916a6058451b723b4e65030c5a18577c8b2de5b3389"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8d756e44e94489e49571086ef83b2bb8ce311e730092d2c34ca8f7d925cb20aa"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:90d558489962fd4918143277a773316e56c72da56ec7aa3dc3dbbe20fdfed15b"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6ac7ffc7ad6d040517be39eb591cac5ff87416c2537df6ba3cba3bae290c0fed"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:7ed9e526742851e8d5cc9e6cf41427dfc6068d4f5a3bb03659444b4cabf6bc26"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:8bdb58ff7ba23002a4c5808d608e4e6c687175724f54a5dade5fa8c67b604e4d"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:6b3251890fff30ee142c44144871185dbe13b11bab478a88887a639655be1068"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:b4a23f61ce87adf89be746c8a8974fe1c823c891d8f86eb218bb957c924bb143"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:efcb3f6676480691518c177e3b465bcddf57cea040302f9f4e6e191af91174d4"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-win32.whl", hash = "sha256:d965bba47ddeec8cd560687584e88cf699fd28f192ceb452d1d7ee807c5597b7"}, + {file = "charset_normalizer-3.3.2-cp312-cp312-win_amd64.whl", hash = "sha256:96b02a3dc4381e5494fad39be677abcb5e6634bf7b4fa83a6dd3112607547001"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:95f2a5796329323b8f0512e09dbb7a1860c46a39da62ecb2324f116fa8fdc85c"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c002b4ffc0be611f0d9da932eb0f704fe2602a9a949d1f738e4c34c75b0863d5"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a981a536974bbc7a512cf44ed14938cf01030a99e9b3a06dd59578882f06f985"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3287761bc4ee9e33561a7e058c72ac0938c4f57fe49a09eae428fd88aafe7bb6"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:42cb296636fcc8b0644486d15c12376cb9fa75443e00fb25de0b8602e64c1714"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0a55554a2fa0d408816b3b5cedf0045f4b8e1a6065aec45849de2d6f3f8e9786"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:c083af607d2515612056a31f0a8d9e0fcb5876b7bfc0abad3ecd275bc4ebc2d5"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:87d1351268731db79e0f8e745d92493ee2841c974128ef629dc518b937d9194c"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:bd8f7df7d12c2db9fab40bdd87a7c09b1530128315d047a086fa3ae3435cb3a8"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:c180f51afb394e165eafe4ac2936a14bee3eb10debc9d9e4db8958fe36afe711"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:8c622a5fe39a48f78944a87d4fb8a53ee07344641b0562c540d840748571b811"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-win32.whl", hash = "sha256:db364eca23f876da6f9e16c9da0df51aa4f104a972735574842618b8c6d999d4"}, + {file = "charset_normalizer-3.3.2-cp37-cp37m-win_amd64.whl", hash = "sha256:86216b5cee4b06df986d214f664305142d9c76df9b6512be2738aa72a2048f99"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:6463effa3186ea09411d50efc7d85360b38d5f09b870c48e4600f63af490e56a"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:6c4caeef8fa63d06bd437cd4bdcf3ffefe6738fb1b25951440d80dc7df8c03ac"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:37e55c8e51c236f95b033f6fb391d7d7970ba5fe7ff453dad675e88cf303377a"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fb69256e180cb6c8a894fee62b3afebae785babc1ee98b81cdf68bbca1987f33"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ae5f4161f18c61806f411a13b0310bea87f987c7d2ecdbdaad0e94eb2e404238"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b2b0a0c0517616b6869869f8c581d4eb2dd83a4d79e0ebcb7d373ef9956aeb0a"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:45485e01ff4d3630ec0d9617310448a8702f70e9c01906b0d0118bdf9d124cf2"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:eb00ed941194665c332bf8e078baf037d6c35d7c4f3102ea2d4f16ca94a26dc8"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:2127566c664442652f024c837091890cb1942c30937add288223dc895793f898"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:a50aebfa173e157099939b17f18600f72f84eed3049e743b68ad15bd69b6bf99"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:4d0d1650369165a14e14e1e47b372cfcb31d6ab44e6e33cb2d4e57265290044d"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:923c0c831b7cfcb071580d3f46c4baf50f174be571576556269530f4bbd79d04"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:06a81e93cd441c56a9b65d8e1d043daeb97a3d0856d177d5c90ba85acb3db087"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-win32.whl", hash = "sha256:6ef1d82a3af9d3eecdba2321dc1b3c238245d890843e040e41e470ffa64c3e25"}, + {file = "charset_normalizer-3.3.2-cp38-cp38-win_amd64.whl", hash = "sha256:eb8821e09e916165e160797a6c17edda0679379a4be5c716c260e836e122f54b"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:c235ebd9baae02f1b77bcea61bce332cb4331dc3617d254df3323aa01ab47bd4"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5b4c145409bef602a690e7cfad0a15a55c13320ff7a3ad7ca59c13bb8ba4d45d"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:68d1f8a9e9e37c1223b656399be5d6b448dea850bed7d0f87a8311f1ff3dabb0"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:22afcb9f253dac0696b5a4be4a1c0f8762f8239e21b99680099abd9b2b1b2269"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e27ad930a842b4c5eb8ac0016b0a54f5aebbe679340c26101df33424142c143c"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1f79682fbe303db92bc2b1136016a38a42e835d932bab5b3b1bfcfbf0640e519"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b261ccdec7821281dade748d088bb6e9b69e6d15b30652b74cbbac25e280b796"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:122c7fa62b130ed55f8f285bfd56d5f4b4a5b503609d181f9ad85e55c89f4185"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d0eccceffcb53201b5bfebb52600a5fb483a20b61da9dbc885f8b103cbe7598c"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:9f96df6923e21816da7e0ad3fd47dd8f94b2a5ce594e00677c0013018b813458"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:7f04c839ed0b6b98b1a7501a002144b76c18fb1c1850c8b98d458ac269e26ed2"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:34d1c8da1e78d2e001f363791c98a272bb734000fcef47a491c1e3b0505657a8"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:ff8fa367d09b717b2a17a052544193ad76cd49979c805768879cb63d9ca50561"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-win32.whl", hash = "sha256:aed38f6e4fb3f5d6bf81bfa990a07806be9d83cf7bacef998ab1a9bd660a581f"}, + {file = "charset_normalizer-3.3.2-cp39-cp39-win_amd64.whl", hash = "sha256:b01b88d45a6fcb69667cd6d2f7a9aeb4bf53760d7fc536bf679ec94fe9f3ff3d"}, + {file = "charset_normalizer-3.3.2-py3-none-any.whl", hash = "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc"}, +] + +[[package]] +name = "click" +version = "8.1.7" +description = "Composable command line interface toolkit" +optional = false +python-versions = ">=3.7" +files = [ + {file = "click-8.1.7-py3-none-any.whl", hash = "sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28"}, + {file = "click-8.1.7.tar.gz", hash = "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de"}, +] + +[package.dependencies] +colorama = {version = "*", markers = "platform_system == \"Windows\""} + +[[package]] +name = "colorama" +version = "0.4.6" +description = "Cross-platform colored terminal text." +optional = false +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7" +files = [ + {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"}, + {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, +] + +[[package]] +name = "dill" +version = "0.3.7" +description = "serialize all of Python" +optional = false +python-versions = ">=3.7" +files = [ + {file = "dill-0.3.7-py3-none-any.whl", hash = "sha256:76b122c08ef4ce2eedcd4d1abd8e641114bfc6c2867f49f3c41facf65bf19f5e"}, + {file = "dill-0.3.7.tar.gz", hash = "sha256:cc1c8b182eb3013e24bd475ff2e9295af86c1a38eb1aff128dac8962a9ce3c03"}, +] + +[package.extras] +graph = ["objgraph (>=1.7.2)"] + +[[package]] +name = "distlib" +version = "0.3.7" +description = "Distribution utilities" +optional = false +python-versions = "*" +files = [ + {file = "distlib-0.3.7-py2.py3-none-any.whl", hash = "sha256:2e24928bc811348f0feb63014e97aaae3037f2cf48712d51ae61df7fd6075057"}, + {file = "distlib-0.3.7.tar.gz", hash = "sha256:9dafe54b34a028eafd95039d5e5d4851a13734540f1331060d31c9916e7147a8"}, +] + +[[package]] +name = "filelock" +version = "3.13.1" +description = "A platform independent file lock." +optional = false +python-versions = ">=3.8" +files = [ + {file = "filelock-3.13.1-py3-none-any.whl", hash = "sha256:57dbda9b35157b05fb3e58ee91448612eb674172fab98ee235ccb0b5bee19a1c"}, + {file = "filelock-3.13.1.tar.gz", hash = "sha256:521f5f56c50f8426f5e03ad3b281b490a87ef15bc6c526f168290f0c7148d44e"}, +] + +[package.extras] +docs = ["furo (>=2023.9.10)", "sphinx (>=7.2.6)", "sphinx-autodoc-typehints (>=1.24)"] +testing = ["covdefaults (>=2.3)", "coverage (>=7.3.2)", "diff-cover (>=8)", "pytest (>=7.4.3)", "pytest-cov (>=4.1)", "pytest-mock (>=3.12)", "pytest-timeout (>=2.2)"] +typing = ["typing-extensions (>=4.8)"] + +[[package]] +name = "frozenlist" +version = "1.4.0" +description = "A list-like structure which implements collections.abc.MutableSequence" +optional = false +python-versions = ">=3.8" +files = [ + {file = "frozenlist-1.4.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:764226ceef3125e53ea2cb275000e309c0aa5464d43bd72abd661e27fffc26ab"}, + {file = "frozenlist-1.4.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:d6484756b12f40003c6128bfcc3fa9f0d49a687e171186c2d85ec82e3758c559"}, + {file = "frozenlist-1.4.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9ac08e601308e41eb533f232dbf6b7e4cea762f9f84f6357136eed926c15d12c"}, + {file = "frozenlist-1.4.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d081f13b095d74b67d550de04df1c756831f3b83dc9881c38985834387487f1b"}, + {file = "frozenlist-1.4.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:71932b597f9895f011f47f17d6428252fc728ba2ae6024e13c3398a087c2cdea"}, + {file = "frozenlist-1.4.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:981b9ab5a0a3178ff413bca62526bb784249421c24ad7381e39d67981be2c326"}, + {file = "frozenlist-1.4.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e41f3de4df3e80de75845d3e743b3f1c4c8613c3997a912dbf0229fc61a8b963"}, + {file = "frozenlist-1.4.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6918d49b1f90821e93069682c06ffde41829c346c66b721e65a5c62b4bab0300"}, + {file = "frozenlist-1.4.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:0e5c8764c7829343d919cc2dfc587a8db01c4f70a4ebbc49abde5d4b158b007b"}, + {file = "frozenlist-1.4.0-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:8d0edd6b1c7fb94922bf569c9b092ee187a83f03fb1a63076e7774b60f9481a8"}, + {file = "frozenlist-1.4.0-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:e29cda763f752553fa14c68fb2195150bfab22b352572cb36c43c47bedba70eb"}, + {file = "frozenlist-1.4.0-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:0c7c1b47859ee2cac3846fde1c1dc0f15da6cec5a0e5c72d101e0f83dcb67ff9"}, + {file = "frozenlist-1.4.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:901289d524fdd571be1c7be054f48b1f88ce8dddcbdf1ec698b27d4b8b9e5d62"}, + {file = "frozenlist-1.4.0-cp310-cp310-win32.whl", hash = "sha256:1a0848b52815006ea6596c395f87449f693dc419061cc21e970f139d466dc0a0"}, + {file = "frozenlist-1.4.0-cp310-cp310-win_amd64.whl", hash = "sha256:b206646d176a007466358aa21d85cd8600a415c67c9bd15403336c331a10d956"}, + {file = "frozenlist-1.4.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:de343e75f40e972bae1ef6090267f8260c1446a1695e77096db6cfa25e759a95"}, + {file = "frozenlist-1.4.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:ad2a9eb6d9839ae241701d0918f54c51365a51407fd80f6b8289e2dfca977cc3"}, + {file = "frozenlist-1.4.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:bd7bd3b3830247580de99c99ea2a01416dfc3c34471ca1298bccabf86d0ff4dc"}, + {file = "frozenlist-1.4.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bdf1847068c362f16b353163391210269e4f0569a3c166bc6a9f74ccbfc7e839"}, + {file = "frozenlist-1.4.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:38461d02d66de17455072c9ba981d35f1d2a73024bee7790ac2f9e361ef1cd0c"}, + {file = "frozenlist-1.4.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d5a32087d720c608f42caed0ef36d2b3ea61a9d09ee59a5142d6070da9041b8f"}, + {file = "frozenlist-1.4.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:dd65632acaf0d47608190a71bfe46b209719bf2beb59507db08ccdbe712f969b"}, + {file = "frozenlist-1.4.0-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:261b9f5d17cac914531331ff1b1d452125bf5daa05faf73b71d935485b0c510b"}, + {file = "frozenlist-1.4.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:b89ac9768b82205936771f8d2eb3ce88503b1556324c9f903e7156669f521472"}, + {file = "frozenlist-1.4.0-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:008eb8b31b3ea6896da16c38c1b136cb9fec9e249e77f6211d479db79a4eaf01"}, + {file = "frozenlist-1.4.0-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:e74b0506fa5aa5598ac6a975a12aa8928cbb58e1f5ac8360792ef15de1aa848f"}, + {file = "frozenlist-1.4.0-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:490132667476f6781b4c9458298b0c1cddf237488abd228b0b3650e5ecba7467"}, + {file = "frozenlist-1.4.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:76d4711f6f6d08551a7e9ef28c722f4a50dd0fc204c56b4bcd95c6cc05ce6fbb"}, + {file = "frozenlist-1.4.0-cp311-cp311-win32.whl", hash = "sha256:a02eb8ab2b8f200179b5f62b59757685ae9987996ae549ccf30f983f40602431"}, + {file = "frozenlist-1.4.0-cp311-cp311-win_amd64.whl", hash = "sha256:515e1abc578dd3b275d6a5114030b1330ba044ffba03f94091842852f806f1c1"}, + {file = "frozenlist-1.4.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:f0ed05f5079c708fe74bf9027e95125334b6978bf07fd5ab923e9e55e5fbb9d3"}, + {file = "frozenlist-1.4.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:ca265542ca427bf97aed183c1676e2a9c66942e822b14dc6e5f42e038f92a503"}, + {file = "frozenlist-1.4.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:491e014f5c43656da08958808588cc6c016847b4360e327a62cb308c791bd2d9"}, + {file = "frozenlist-1.4.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:17ae5cd0f333f94f2e03aaf140bb762c64783935cc764ff9c82dff626089bebf"}, + {file = "frozenlist-1.4.0-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1e78fb68cf9c1a6aa4a9a12e960a5c9dfbdb89b3695197aa7064705662515de2"}, + {file = "frozenlist-1.4.0-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d5655a942f5f5d2c9ed93d72148226d75369b4f6952680211972a33e59b1dfdc"}, + {file = "frozenlist-1.4.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c11b0746f5d946fecf750428a95f3e9ebe792c1ee3b1e96eeba145dc631a9672"}, + {file = "frozenlist-1.4.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e66d2a64d44d50d2543405fb183a21f76b3b5fd16f130f5c99187c3fb4e64919"}, + {file = "frozenlist-1.4.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:88f7bc0fcca81f985f78dd0fa68d2c75abf8272b1f5c323ea4a01a4d7a614efc"}, + {file = "frozenlist-1.4.0-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:5833593c25ac59ede40ed4de6d67eb42928cca97f26feea219f21d0ed0959b79"}, + {file = "frozenlist-1.4.0-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:fec520865f42e5c7f050c2a79038897b1c7d1595e907a9e08e3353293ffc948e"}, + {file = "frozenlist-1.4.0-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:b826d97e4276750beca7c8f0f1a4938892697a6bcd8ec8217b3312dad6982781"}, + {file = "frozenlist-1.4.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:ceb6ec0a10c65540421e20ebd29083c50e6d1143278746a4ef6bcf6153171eb8"}, + {file = "frozenlist-1.4.0-cp38-cp38-win32.whl", hash = "sha256:2b8bcf994563466db019fab287ff390fffbfdb4f905fc77bc1c1d604b1c689cc"}, + {file = "frozenlist-1.4.0-cp38-cp38-win_amd64.whl", hash = "sha256:a6c8097e01886188e5be3e6b14e94ab365f384736aa1fca6a0b9e35bd4a30bc7"}, + {file = "frozenlist-1.4.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:6c38721585f285203e4b4132a352eb3daa19121a035f3182e08e437cface44bf"}, + {file = "frozenlist-1.4.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:a0c6da9aee33ff0b1a451e867da0c1f47408112b3391dd43133838339e410963"}, + {file = "frozenlist-1.4.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:93ea75c050c5bb3d98016b4ba2497851eadf0ac154d88a67d7a6816206f6fa7f"}, + {file = "frozenlist-1.4.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f61e2dc5ad442c52b4887f1fdc112f97caeff4d9e6ebe78879364ac59f1663e1"}, + {file = "frozenlist-1.4.0-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:aa384489fefeb62321b238e64c07ef48398fe80f9e1e6afeff22e140e0850eef"}, + {file = "frozenlist-1.4.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:10ff5faaa22786315ef57097a279b833ecab1a0bfb07d604c9cbb1c4cdc2ed87"}, + {file = "frozenlist-1.4.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:007df07a6e3eb3e33e9a1fe6a9db7af152bbd8a185f9aaa6ece10a3529e3e1c6"}, + {file = "frozenlist-1.4.0-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7f4f399d28478d1f604c2ff9119907af9726aed73680e5ed1ca634d377abb087"}, + {file = "frozenlist-1.4.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:c5374b80521d3d3f2ec5572e05adc94601985cc526fb276d0c8574a6d749f1b3"}, + {file = "frozenlist-1.4.0-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:ce31ae3e19f3c902de379cf1323d90c649425b86de7bbdf82871b8a2a0615f3d"}, + {file = "frozenlist-1.4.0-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:7211ef110a9194b6042449431e08c4d80c0481e5891e58d429df5899690511c2"}, + {file = "frozenlist-1.4.0-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:556de4430ce324c836789fa4560ca62d1591d2538b8ceb0b4f68fb7b2384a27a"}, + {file = "frozenlist-1.4.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:7645a8e814a3ee34a89c4a372011dcd817964ce8cb273c8ed6119d706e9613e3"}, + {file = "frozenlist-1.4.0-cp39-cp39-win32.whl", hash = "sha256:19488c57c12d4e8095a922f328df3f179c820c212940a498623ed39160bc3c2f"}, + {file = "frozenlist-1.4.0-cp39-cp39-win_amd64.whl", hash = "sha256:6221d84d463fb110bdd7619b69cb43878a11d51cbb9394ae3105d082d5199167"}, + {file = "frozenlist-1.4.0.tar.gz", hash = "sha256:09163bdf0b2907454042edb19f887c6d33806adc71fbd54afc14908bfdc22251"}, +] + +[[package]] +name = "identify" +version = "2.5.31" +description = "File identification library for Python" +optional = false +python-versions = ">=3.8" +files = [ + {file = "identify-2.5.31-py2.py3-none-any.whl", hash = "sha256:90199cb9e7bd3c5407a9b7e81b4abec4bb9d249991c79439ec8af740afc6293d"}, + {file = "identify-2.5.31.tar.gz", hash = "sha256:7736b3c7a28233637e3c36550646fc6389bedd74ae84cb788200cc8e2dd60b75"}, +] + +[package.extras] +license = ["ukkonen"] + +[[package]] +name = "idna" +version = "3.4" +description = "Internationalized Domain Names in Applications (IDNA)" +optional = false +python-versions = ">=3.5" +files = [ + {file = "idna-3.4-py3-none-any.whl", hash = "sha256:90b77e79eaa3eba6de819a0c442c0b4ceefc341a7a2ab77d7562bf49f425c5c2"}, + {file = "idna-3.4.tar.gz", hash = "sha256:814f528e8dead7d329833b91c5faa87d60bf71824cd12a7530b5526063d02cb4"}, +] + +[[package]] +name = "iniconfig" +version = "2.0.0" +description = "brain-dead simple config-ini parsing" +optional = false +python-versions = ">=3.7" +files = [ + {file = "iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374"}, + {file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"}, +] + +[[package]] +name = "isort" +version = "5.12.0" +description = "A Python utility / library to sort Python imports." +optional = false +python-versions = ">=3.8.0" +files = [ + {file = "isort-5.12.0-py3-none-any.whl", hash = "sha256:f84c2818376e66cf843d497486ea8fed8700b340f308f076c6fb1229dff318b6"}, + {file = "isort-5.12.0.tar.gz", hash = "sha256:8bef7dde241278824a6d83f44a544709b065191b95b6e50894bdc722fcba0504"}, +] + +[package.extras] +colors = ["colorama (>=0.4.3)"] +pipfile-deprecated-finder = ["pip-shims (>=0.5.2)", "pipreqs", "requirementslib"] +plugins = ["setuptools"] +requirements-deprecated-finder = ["pip-api", "pipreqs"] + +[[package]] +name = "libcst" +version = "1.1.0" +description = "A concrete syntax tree with AST-like properties for Python 3.5, 3.6, 3.7, 3.8, 3.9, and 3.10 programs." +optional = false +python-versions = ">=3.8" +files = [ + {file = "libcst-1.1.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:63f75656fd733dc20354c46253fde3cf155613e37643c3eaf6f8818e95b7a3d1"}, + {file = "libcst-1.1.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:8ae11eb1ea55a16dc0cdc61b41b29ac347da70fec14cc4381248e141ee2fbe6c"}, + {file = "libcst-1.1.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4bc745d0c06420fe2644c28d6ddccea9474fb68a2135904043676deb4fa1e6bc"}, + {file = "libcst-1.1.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8c1f2da45f1c45634090fd8672c15e0159fdc46853336686959b2d093b6e10fa"}, + {file = "libcst-1.1.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:003e5e83a12eed23542c4ea20fdc8de830887cc03662432bb36f84f8c4841b81"}, + {file = "libcst-1.1.0-cp310-cp310-win_amd64.whl", hash = "sha256:3ebbb9732ae3cc4ae7a0e97890bed0a57c11d6df28790c2b9c869f7da653c7c7"}, + {file = "libcst-1.1.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:d68c34e3038d3d1d6324eb47744cbf13f2c65e1214cf49db6ff2a6603c1cd838"}, + {file = "libcst-1.1.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:9dffa1795c2804d183efb01c0f1efd20a7831db6a21a0311edf90b4100d67436"}, + {file = "libcst-1.1.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cc9b6ac36d7ec9db2f053014ea488086ca2ed9c322be104fbe2c71ca759da4bb"}, + {file = "libcst-1.1.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:78b7a38ec4c1c009ac39027d51558b52851fb9234669ba5ba62283185963a31c"}, + {file = "libcst-1.1.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:5297a16e575be8173185e936b7765c89a3ca69d4ae217a4af161814a0f9745a7"}, + {file = "libcst-1.1.0-cp311-cp311-win_amd64.whl", hash = "sha256:7ccaf53925f81118aeaadb068a911fac8abaff608817d7343da280616a5ca9c1"}, + {file = "libcst-1.1.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:75816647736f7e09c6120bdbf408456f99b248d6272277eed9a58cf50fb8bc7d"}, + {file = "libcst-1.1.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:c8f26250f87ca849a7303ed7a4fd6b2c7ac4dec16b7d7e68ca6a476d7c9bfcdb"}, + {file = "libcst-1.1.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2d37326bd6f379c64190a28947a586b949de3a76be00176b0732c8ee87d67ebe"}, + {file = "libcst-1.1.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e3d8cf974cfa2487b28f23f56c4bff90d550ef16505e58b0dca0493d5293784b"}, + {file = "libcst-1.1.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:82d1271403509b0a4ee6ff7917c2d33b5a015f44d1e208abb1da06ba93b2a378"}, + {file = "libcst-1.1.0-cp312-cp312-win_amd64.whl", hash = "sha256:bca1841693941fdd18371824bb19a9702d5784cd347cb8231317dbdc7062c5bc"}, + {file = "libcst-1.1.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:f36f592e035ef84f312a12b75989dde6a5f6767fe99146cdae6a9ee9aff40dd0"}, + {file = "libcst-1.1.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:f561c9a84eca18be92f4ad90aa9bd873111efbea995449301719a1a7805dbc5c"}, + {file = "libcst-1.1.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:97fbc73c87e9040e148881041fd5ffa2a6ebf11f64b4ccb5b52e574b95df1a15"}, + {file = "libcst-1.1.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:99fdc1929703fd9e7408aed2e03f58701c5280b05c8911753a8d8619f7dfdda5"}, + {file = "libcst-1.1.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0bf69cbbab5016d938aac4d3ae70ba9ccb3f90363c588b3b97be434e6ba95403"}, + {file = "libcst-1.1.0-cp38-cp38-win_amd64.whl", hash = "sha256:fe41b33aa73635b1651f64633f429f7aa21f86d2db5748659a99d9b7b1ed2a90"}, + {file = "libcst-1.1.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:73c086705ed34dbad16c62c9adca4249a556c1b022993d511da70ea85feaf669"}, + {file = "libcst-1.1.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:3a07ecfabbbb8b93209f952a365549e65e658831e9231649f4f4e4263cad24b1"}, + {file = "libcst-1.1.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c653d9121d6572d8b7f8abf20f88b0a41aab77ff5a6a36e5a0ec0f19af0072e8"}, + {file = "libcst-1.1.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5f1cd308a4c2f71d5e4eec6ee693819933a03b78edb2e4cc5e3ad1afd5fb3f07"}, + {file = "libcst-1.1.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:8afb6101b8b3c86c5f9cec6b90ab4da16c3c236fe7396f88e8b93542bb341f7c"}, + {file = "libcst-1.1.0-cp39-cp39-win_amd64.whl", hash = "sha256:d22d1abfe49aa60fc61fa867e10875a9b3024ba5a801112f4d7ba42d8d53242e"}, + {file = "libcst-1.1.0.tar.gz", hash = "sha256:0acbacb9a170455701845b7e940e2d7b9519db35a86768d86330a0b0deae1086"}, +] + +[package.dependencies] +pyyaml = ">=5.2" +typing-extensions = ">=3.7.4.2" +typing-inspect = ">=0.4.0" + +[package.extras] +dev = ["Sphinx (>=5.1.1)", "black (==23.9.1)", "build (>=0.10.0)", "coverage (>=4.5.4)", "fixit (==2.0.0.post1)", "flake8 (>=3.7.8,<5)", "hypothesis (>=4.36.0)", "hypothesmith (>=0.0.4)", "jinja2 (==3.1.2)", "jupyter (>=1.0.0)", "maturin (>=0.8.3,<0.16)", "nbsphinx (>=0.4.2)", "prompt-toolkit (>=2.0.9)", "pyre-check (==0.9.18)", "setuptools-rust (>=1.5.2)", "setuptools-scm (>=6.0.1)", "slotscheck (>=0.7.1)", "sphinx-rtd-theme (>=0.4.3)", "ufmt (==2.2.0)", "usort (==1.0.7)"] + +[[package]] +name = "mccabe" +version = "0.7.0" +description = "McCabe checker, plugin for flake8" +optional = false +python-versions = ">=3.6" +files = [ + {file = "mccabe-0.7.0-py2.py3-none-any.whl", hash = "sha256:6c2d30ab6be0e4a46919781807b4f0d834ebdd6c6e3dca0bda5a15f863427b6e"}, + {file = "mccabe-0.7.0.tar.gz", hash = "sha256:348e0240c33b60bbdf4e523192ef919f28cb2c3d7d5c7794f74009290f236325"}, +] + +[[package]] +name = "multidict" +version = "6.0.4" +description = "multidict implementation" +optional = false +python-versions = ">=3.7" +files = [ + {file = "multidict-6.0.4-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:0b1a97283e0c85772d613878028fec909f003993e1007eafa715b24b377cb9b8"}, + {file = "multidict-6.0.4-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:eeb6dcc05e911516ae3d1f207d4b0520d07f54484c49dfc294d6e7d63b734171"}, + {file = "multidict-6.0.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:d6d635d5209b82a3492508cf5b365f3446afb65ae7ebd755e70e18f287b0adf7"}, + {file = "multidict-6.0.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c048099e4c9e9d615545e2001d3d8a4380bd403e1a0578734e0d31703d1b0c0b"}, + {file = "multidict-6.0.4-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ea20853c6dbbb53ed34cb4d080382169b6f4554d394015f1bef35e881bf83547"}, + {file = "multidict-6.0.4-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:16d232d4e5396c2efbbf4f6d4df89bfa905eb0d4dc5b3549d872ab898451f569"}, + {file = "multidict-6.0.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:36c63aaa167f6c6b04ef2c85704e93af16c11d20de1d133e39de6a0e84582a93"}, + {file = "multidict-6.0.4-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:64bdf1086b6043bf519869678f5f2757f473dee970d7abf6da91ec00acb9cb98"}, + {file = "multidict-6.0.4-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:43644e38f42e3af682690876cff722d301ac585c5b9e1eacc013b7a3f7b696a0"}, + {file = "multidict-6.0.4-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:7582a1d1030e15422262de9f58711774e02fa80df0d1578995c76214f6954988"}, + {file = "multidict-6.0.4-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:ddff9c4e225a63a5afab9dd15590432c22e8057e1a9a13d28ed128ecf047bbdc"}, + {file = "multidict-6.0.4-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:ee2a1ece51b9b9e7752e742cfb661d2a29e7bcdba2d27e66e28a99f1890e4fa0"}, + {file = "multidict-6.0.4-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:a2e4369eb3d47d2034032a26c7a80fcb21a2cb22e1173d761a162f11e562caa5"}, + {file = "multidict-6.0.4-cp310-cp310-win32.whl", hash = "sha256:574b7eae1ab267e5f8285f0fe881f17efe4b98c39a40858247720935b893bba8"}, + {file = "multidict-6.0.4-cp310-cp310-win_amd64.whl", hash = "sha256:4dcbb0906e38440fa3e325df2359ac6cb043df8e58c965bb45f4e406ecb162cc"}, + {file = "multidict-6.0.4-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:0dfad7a5a1e39c53ed00d2dd0c2e36aed4650936dc18fd9a1826a5ae1cad6f03"}, + {file = "multidict-6.0.4-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:64da238a09d6039e3bd39bb3aee9c21a5e34f28bfa5aa22518581f910ff94af3"}, + {file = "multidict-6.0.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:ff959bee35038c4624250473988b24f846cbeb2c6639de3602c073f10410ceba"}, + {file = "multidict-6.0.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:01a3a55bd90018c9c080fbb0b9f4891db37d148a0a18722b42f94694f8b6d4c9"}, + {file = "multidict-6.0.4-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c5cb09abb18c1ea940fb99360ea0396f34d46566f157122c92dfa069d3e0e982"}, + {file = "multidict-6.0.4-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:666daae833559deb2d609afa4490b85830ab0dfca811a98b70a205621a6109fe"}, + {file = "multidict-6.0.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:11bdf3f5e1518b24530b8241529d2050014c884cf18b6fc69c0c2b30ca248710"}, + {file = "multidict-6.0.4-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7d18748f2d30f94f498e852c67d61261c643b349b9d2a581131725595c45ec6c"}, + {file = "multidict-6.0.4-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:458f37be2d9e4c95e2d8866a851663cbc76e865b78395090786f6cd9b3bbf4f4"}, + {file = "multidict-6.0.4-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:b1a2eeedcead3a41694130495593a559a668f382eee0727352b9a41e1c45759a"}, + {file = "multidict-6.0.4-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:7d6ae9d593ef8641544d6263c7fa6408cc90370c8cb2bbb65f8d43e5b0351d9c"}, + {file = "multidict-6.0.4-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:5979b5632c3e3534e42ca6ff856bb24b2e3071b37861c2c727ce220d80eee9ed"}, + {file = "multidict-6.0.4-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:dcfe792765fab89c365123c81046ad4103fcabbc4f56d1c1997e6715e8015461"}, + {file = "multidict-6.0.4-cp311-cp311-win32.whl", hash = "sha256:3601a3cece3819534b11d4efc1eb76047488fddd0c85a3948099d5da4d504636"}, + {file = "multidict-6.0.4-cp311-cp311-win_amd64.whl", hash = "sha256:81a4f0b34bd92df3da93315c6a59034df95866014ac08535fc819f043bfd51f0"}, + {file = "multidict-6.0.4-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:67040058f37a2a51ed8ea8f6b0e6ee5bd78ca67f169ce6122f3e2ec80dfe9b78"}, + {file = "multidict-6.0.4-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:853888594621e6604c978ce2a0444a1e6e70c8d253ab65ba11657659dcc9100f"}, + {file = "multidict-6.0.4-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:39ff62e7d0f26c248b15e364517a72932a611a9b75f35b45be078d81bdb86603"}, + {file = "multidict-6.0.4-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:af048912e045a2dc732847d33821a9d84ba553f5c5f028adbd364dd4765092ac"}, + {file = "multidict-6.0.4-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b1e8b901e607795ec06c9e42530788c45ac21ef3aaa11dbd0c69de543bfb79a9"}, + {file = "multidict-6.0.4-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:62501642008a8b9871ddfccbf83e4222cf8ac0d5aeedf73da36153ef2ec222d2"}, + {file = "multidict-6.0.4-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:99b76c052e9f1bc0721f7541e5e8c05db3941eb9ebe7b8553c625ef88d6eefde"}, + {file = "multidict-6.0.4-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:509eac6cf09c794aa27bcacfd4d62c885cce62bef7b2c3e8b2e49d365b5003fe"}, + {file = "multidict-6.0.4-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:21a12c4eb6ddc9952c415f24eef97e3e55ba3af61f67c7bc388dcdec1404a067"}, + {file = "multidict-6.0.4-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:5cad9430ab3e2e4fa4a2ef4450f548768400a2ac635841bc2a56a2052cdbeb87"}, + {file = "multidict-6.0.4-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:ab55edc2e84460694295f401215f4a58597f8f7c9466faec545093045476327d"}, + {file = "multidict-6.0.4-cp37-cp37m-win32.whl", hash = "sha256:5a4dcf02b908c3b8b17a45fb0f15b695bf117a67b76b7ad18b73cf8e92608775"}, + {file = "multidict-6.0.4-cp37-cp37m-win_amd64.whl", hash = "sha256:6ed5f161328b7df384d71b07317f4d8656434e34591f20552c7bcef27b0ab88e"}, + {file = "multidict-6.0.4-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:5fc1b16f586f049820c5c5b17bb4ee7583092fa0d1c4e28b5239181ff9532e0c"}, + {file = "multidict-6.0.4-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1502e24330eb681bdaa3eb70d6358e818e8e8f908a22a1851dfd4e15bc2f8161"}, + {file = "multidict-6.0.4-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:b692f419760c0e65d060959df05f2a531945af31fda0c8a3b3195d4efd06de11"}, + {file = "multidict-6.0.4-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:45e1ecb0379bfaab5eef059f50115b54571acfbe422a14f668fc8c27ba410e7e"}, + {file = "multidict-6.0.4-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ddd3915998d93fbcd2566ddf9cf62cdb35c9e093075f862935573d265cf8f65d"}, + {file = "multidict-6.0.4-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:59d43b61c59d82f2effb39a93c48b845efe23a3852d201ed2d24ba830d0b4cf2"}, + {file = "multidict-6.0.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:cc8e1d0c705233c5dd0c5e6460fbad7827d5d36f310a0fadfd45cc3029762258"}, + {file = "multidict-6.0.4-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d6aa0418fcc838522256761b3415822626f866758ee0bc6632c9486b179d0b52"}, + {file = "multidict-6.0.4-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:6748717bb10339c4760c1e63da040f5f29f5ed6e59d76daee30305894069a660"}, + {file = "multidict-6.0.4-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:4d1a3d7ef5e96b1c9e92f973e43aa5e5b96c659c9bc3124acbbd81b0b9c8a951"}, + {file = "multidict-6.0.4-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:4372381634485bec7e46718edc71528024fcdc6f835baefe517b34a33c731d60"}, + {file = "multidict-6.0.4-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:fc35cb4676846ef752816d5be2193a1e8367b4c1397b74a565a9d0389c433a1d"}, + {file = "multidict-6.0.4-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:4b9d9e4e2b37daddb5c23ea33a3417901fa7c7b3dee2d855f63ee67a0b21e5b1"}, + {file = "multidict-6.0.4-cp38-cp38-win32.whl", hash = "sha256:e41b7e2b59679edfa309e8db64fdf22399eec4b0b24694e1b2104fb789207779"}, + {file = "multidict-6.0.4-cp38-cp38-win_amd64.whl", hash = "sha256:d6c254ba6e45d8e72739281ebc46ea5eb5f101234f3ce171f0e9f5cc86991480"}, + {file = "multidict-6.0.4-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:16ab77bbeb596e14212e7bab8429f24c1579234a3a462105cda4a66904998664"}, + {file = "multidict-6.0.4-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:bc779e9e6f7fda81b3f9aa58e3a6091d49ad528b11ed19f6621408806204ad35"}, + {file = "multidict-6.0.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:4ceef517eca3e03c1cceb22030a3e39cb399ac86bff4e426d4fc6ae49052cc60"}, + {file = "multidict-6.0.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:281af09f488903fde97923c7744bb001a9b23b039a909460d0f14edc7bf59706"}, + {file = "multidict-6.0.4-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:52f2dffc8acaba9a2f27174c41c9e57f60b907bb9f096b36b1a1f3be71c6284d"}, + {file = "multidict-6.0.4-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b41156839806aecb3641f3208c0dafd3ac7775b9c4c422d82ee2a45c34ba81ca"}, + {file = "multidict-6.0.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d5e3fc56f88cc98ef8139255cf8cd63eb2c586531e43310ff859d6bb3a6b51f1"}, + {file = "multidict-6.0.4-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:8316a77808c501004802f9beebde51c9f857054a0c871bd6da8280e718444449"}, + {file = "multidict-6.0.4-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:f70b98cd94886b49d91170ef23ec5c0e8ebb6f242d734ed7ed677b24d50c82cf"}, + {file = "multidict-6.0.4-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:bf6774e60d67a9efe02b3616fee22441d86fab4c6d335f9d2051d19d90a40063"}, + {file = "multidict-6.0.4-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:e69924bfcdda39b722ef4d9aa762b2dd38e4632b3641b1d9a57ca9cd18f2f83a"}, + {file = "multidict-6.0.4-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:6b181d8c23da913d4ff585afd1155a0e1194c0b50c54fcfe286f70cdaf2b7176"}, + {file = "multidict-6.0.4-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:52509b5be062d9eafc8170e53026fbc54cf3b32759a23d07fd935fb04fc22d95"}, + {file = "multidict-6.0.4-cp39-cp39-win32.whl", hash = "sha256:27c523fbfbdfd19c6867af7346332b62b586eed663887392cff78d614f9ec313"}, + {file = "multidict-6.0.4-cp39-cp39-win_amd64.whl", hash = "sha256:33029f5734336aa0d4c0384525da0387ef89148dc7191aae00ca5fb23d7aafc2"}, + {file = "multidict-6.0.4.tar.gz", hash = "sha256:3666906492efb76453c0e7b97f2cf459b0682e7402c0489a95484965dbc1da49"}, +] + +[[package]] +name = "mypy" +version = "1.6.1" +description = "Optional static typing for Python" +optional = false +python-versions = ">=3.8" +files = [ + {file = "mypy-1.6.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:e5012e5cc2ac628177eaac0e83d622b2dd499e28253d4107a08ecc59ede3fc2c"}, + {file = "mypy-1.6.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:d8fbb68711905f8912e5af474ca8b78d077447d8f3918997fecbf26943ff3cbb"}, + {file = "mypy-1.6.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:21a1ad938fee7d2d96ca666c77b7c494c3c5bd88dff792220e1afbebb2925b5e"}, + {file = "mypy-1.6.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:b96ae2c1279d1065413965c607712006205a9ac541895004a1e0d4f281f2ff9f"}, + {file = "mypy-1.6.1-cp310-cp310-win_amd64.whl", hash = "sha256:40b1844d2e8b232ed92e50a4bd11c48d2daa351f9deee6c194b83bf03e418b0c"}, + {file = "mypy-1.6.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:81af8adaa5e3099469e7623436881eff6b3b06db5ef75e6f5b6d4871263547e5"}, + {file = "mypy-1.6.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:8c223fa57cb154c7eab5156856c231c3f5eace1e0bed9b32a24696b7ba3c3245"}, + {file = "mypy-1.6.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a8032e00ce71c3ceb93eeba63963b864bf635a18f6c0c12da6c13c450eedb183"}, + {file = "mypy-1.6.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:4c46b51de523817a0045b150ed11b56f9fff55f12b9edd0f3ed35b15a2809de0"}, + {file = "mypy-1.6.1-cp311-cp311-win_amd64.whl", hash = "sha256:19f905bcfd9e167159b3d63ecd8cb5e696151c3e59a1742e79bc3bcb540c42c7"}, + {file = "mypy-1.6.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:82e469518d3e9a321912955cc702d418773a2fd1e91c651280a1bda10622f02f"}, + {file = "mypy-1.6.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:d4473c22cc296425bbbce7e9429588e76e05bc7342da359d6520b6427bf76660"}, + {file = "mypy-1.6.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:59a0d7d24dfb26729e0a068639a6ce3500e31d6655df8557156c51c1cb874ce7"}, + {file = "mypy-1.6.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:cfd13d47b29ed3bbaafaff7d8b21e90d827631afda134836962011acb5904b71"}, + {file = "mypy-1.6.1-cp312-cp312-win_amd64.whl", hash = "sha256:eb4f18589d196a4cbe5290b435d135dee96567e07c2b2d43b5c4621b6501531a"}, + {file = "mypy-1.6.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:41697773aa0bf53ff917aa077e2cde7aa50254f28750f9b88884acea38a16169"}, + {file = "mypy-1.6.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:7274b0c57737bd3476d2229c6389b2ec9eefeb090bbaf77777e9d6b1b5a9d143"}, + {file = "mypy-1.6.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bbaf4662e498c8c2e352da5f5bca5ab29d378895fa2d980630656178bd607c46"}, + {file = "mypy-1.6.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:bb8ccb4724f7d8601938571bf3f24da0da791fe2db7be3d9e79849cb64e0ae85"}, + {file = "mypy-1.6.1-cp38-cp38-win_amd64.whl", hash = "sha256:68351911e85145f582b5aa6cd9ad666c8958bcae897a1bfda8f4940472463c45"}, + {file = "mypy-1.6.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:49ae115da099dcc0922a7a895c1eec82c1518109ea5c162ed50e3b3594c71208"}, + {file = "mypy-1.6.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:8b27958f8c76bed8edaa63da0739d76e4e9ad4ed325c814f9b3851425582a3cd"}, + {file = "mypy-1.6.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:925cd6a3b7b55dfba252b7c4561892311c5358c6b5a601847015a1ad4eb7d332"}, + {file = "mypy-1.6.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:8f57e6b6927a49550da3d122f0cb983d400f843a8a82e65b3b380d3d7259468f"}, + {file = "mypy-1.6.1-cp39-cp39-win_amd64.whl", hash = "sha256:a43ef1c8ddfdb9575691720b6352761f3f53d85f1b57d7745701041053deff30"}, + {file = "mypy-1.6.1-py3-none-any.whl", hash = "sha256:4cbe68ef919c28ea561165206a2dcb68591c50f3bcf777932323bc208d949cf1"}, + {file = "mypy-1.6.1.tar.gz", hash = "sha256:4d01c00d09a0be62a4ca3f933e315455bde83f37f892ba4b08ce92f3cf44bcc1"}, +] + +[package.dependencies] +mypy-extensions = ">=1.0.0" +typing-extensions = ">=4.1.0" + +[package.extras] +dmypy = ["psutil (>=4.0)"] +install-types = ["pip"] +reports = ["lxml"] + +[[package]] +name = "mypy-extensions" +version = "1.0.0" +description = "Type system extensions for programs checked with the mypy type checker." +optional = false +python-versions = ">=3.5" +files = [ + {file = "mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d"}, + {file = "mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782"}, +] + +[[package]] +name = "nodeenv" +version = "1.8.0" +description = "Node.js virtual environment builder" +optional = false +python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*" +files = [ + {file = "nodeenv-1.8.0-py2.py3-none-any.whl", hash = "sha256:df865724bb3c3adc86b3876fa209771517b0cfe596beff01a92700e0e8be4cec"}, + {file = "nodeenv-1.8.0.tar.gz", hash = "sha256:d51e0c37e64fbf47d017feac3145cdbb58836d7eee8c6f6d3b6880c5456227d2"}, +] + +[package.dependencies] +setuptools = "*" + +[[package]] +name = "packaging" +version = "23.2" +description = "Core utilities for Python packages" +optional = false +python-versions = ">=3.7" +files = [ + {file = "packaging-23.2-py3-none-any.whl", hash = "sha256:8c491190033a9af7e1d931d0b5dacc2ef47509b34dd0de67ed209b5203fc88c7"}, + {file = "packaging-23.2.tar.gz", hash = "sha256:048fb0e9405036518eaaf48a55953c750c11e1a1b68e0dd1a9d62ed0c092cfc5"}, +] + +[[package]] +name = "pathspec" +version = "0.11.2" +description = "Utility library for gitignore style pattern matching of file paths." +optional = false +python-versions = ">=3.7" +files = [ + {file = "pathspec-0.11.2-py3-none-any.whl", hash = "sha256:1d6ed233af05e679efb96b1851550ea95bbb64b7c490b0f5aa52996c11e92a20"}, + {file = "pathspec-0.11.2.tar.gz", hash = "sha256:e0d8d0ac2f12da61956eb2306b69f9469b42f4deb0f3cb6ed47b9cce9996ced3"}, +] + +[[package]] +name = "platformdirs" +version = "3.11.0" +description = "A small Python package for determining appropriate platform-specific dirs, e.g. a \"user data dir\"." +optional = false +python-versions = ">=3.7" +files = [ + {file = "platformdirs-3.11.0-py3-none-any.whl", hash = "sha256:e9d171d00af68be50e9202731309c4e658fd8bc76f55c11c7dd760d023bda68e"}, + {file = "platformdirs-3.11.0.tar.gz", hash = "sha256:cf8ee52a3afdb965072dcc652433e0c7e3e40cf5ea1477cd4b3b1d2eb75495b3"}, +] + +[package.extras] +docs = ["furo (>=2023.7.26)", "proselint (>=0.13)", "sphinx (>=7.1.1)", "sphinx-autodoc-typehints (>=1.24)"] +test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=7.4)", "pytest-cov (>=4.1)", "pytest-mock (>=3.11.1)"] + +[[package]] +name = "pluggy" +version = "1.3.0" +description = "plugin and hook calling mechanisms for python" +optional = false +python-versions = ">=3.8" +files = [ + {file = "pluggy-1.3.0-py3-none-any.whl", hash = "sha256:d89c696a773f8bd377d18e5ecda92b7a3793cbe66c87060a6fb58c7b6e1061f7"}, + {file = "pluggy-1.3.0.tar.gz", hash = "sha256:cf61ae8f126ac6f7c451172cf30e3e43d3ca77615509771b3a984a0730651e12"}, +] + +[package.extras] +dev = ["pre-commit", "tox"] +testing = ["pytest", "pytest-benchmark"] + +[[package]] +name = "pre-commit" +version = "3.5.0" +description = "A framework for managing and maintaining multi-language pre-commit hooks." +optional = false +python-versions = ">=3.8" +files = [ + {file = "pre_commit-3.5.0-py2.py3-none-any.whl", hash = "sha256:841dc9aef25daba9a0238cd27984041fa0467b4199fc4852e27950664919f660"}, + {file = "pre_commit-3.5.0.tar.gz", hash = "sha256:5804465c675b659b0862f07907f96295d490822a450c4c40e747d0b1c6ebcb32"}, +] + +[package.dependencies] +cfgv = ">=2.0.0" +identify = ">=1.0.0" +nodeenv = ">=0.11.1" +pyyaml = ">=5.1" +virtualenv = ">=20.10.0" + +[[package]] +name = "pycln" +version = "2.3.0" +description = "A formatter for finding and removing unused import statements." +optional = false +python-versions = ">=3.6.2,<4" +files = [ + {file = "pycln-2.3.0-py3-none-any.whl", hash = "sha256:d6731e17a60728b827211de2ca4bfc9b40ea1df99a12f3e0fd06a98a0c9e6caa"}, + {file = "pycln-2.3.0.tar.gz", hash = "sha256:8759b36753234c8f95895a31dde329479ffed2218f49d1a1c77c7edccc02e09b"}, +] + +[package.dependencies] +libcst = {version = ">=0.3.10", markers = "python_version >= \"3.7\""} +pathspec = ">=0.9.0" +pyyaml = ">=5.3.1" +tomlkit = ">=0.11.1" +typer = ">=0.4.1" + +[[package]] +name = "pylint" +version = "3.0.2" +description = "python code static checker" +optional = false +python-versions = ">=3.8.0" +files = [ + {file = "pylint-3.0.2-py3-none-any.whl", hash = "sha256:60ed5f3a9ff8b61839ff0348b3624ceeb9e6c2a92c514d81c9cc273da3b6bcda"}, + {file = "pylint-3.0.2.tar.gz", hash = "sha256:0d4c286ef6d2f66c8bfb527a7f8a629009e42c99707dec821a03e1b51a4c1496"}, +] + +[package.dependencies] +astroid = ">=3.0.1,<=3.1.0-dev0" +colorama = {version = ">=0.4.5", markers = "sys_platform == \"win32\""} +dill = [ + {version = ">=0.3.7", markers = "python_version >= \"3.12\""}, + {version = ">=0.3.6", markers = "python_version >= \"3.11\" and python_version < \"3.12\""}, +] +isort = ">=4.2.5,<6" +mccabe = ">=0.6,<0.8" +platformdirs = ">=2.2.0" +tomlkit = ">=0.10.1" + +[package.extras] +spelling = ["pyenchant (>=3.2,<4.0)"] +testutils = ["gitpython (>3)"] + +[[package]] +name = "pytest" +version = "7.4.3" +description = "pytest: simple powerful testing with Python" +optional = false +python-versions = ">=3.7" +files = [ + {file = "pytest-7.4.3-py3-none-any.whl", hash = "sha256:0d009c083ea859a71b76adf7c1d502e4bc170b80a8ef002da5806527b9591fac"}, + {file = "pytest-7.4.3.tar.gz", hash = "sha256:d989d136982de4e3b29dabcc838ad581c64e8ed52c11fbe86ddebd9da0818cd5"}, +] + +[package.dependencies] +colorama = {version = "*", markers = "sys_platform == \"win32\""} +iniconfig = "*" +packaging = "*" +pluggy = ">=0.12,<2.0" + +[package.extras] +testing = ["argcomplete", "attrs (>=19.2.0)", "hypothesis (>=3.56)", "mock", "nose", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"] + +[[package]] +name = "pytest-aiohttp" +version = "1.0.5" +description = "Pytest plugin for aiohttp support" +optional = false +python-versions = ">=3.7" +files = [ + {file = "pytest-aiohttp-1.0.5.tar.gz", hash = "sha256:880262bc5951e934463b15e3af8bb298f11f7d4d3ebac970aab425aff10a780a"}, + {file = "pytest_aiohttp-1.0.5-py3-none-any.whl", hash = "sha256:63a5360fd2f34dda4ab8e6baee4c5f5be4cd186a403cabd498fced82ac9c561e"}, +] + +[package.dependencies] +aiohttp = ">=3.8.1" +pytest = ">=6.1.0" +pytest-asyncio = ">=0.17.2" + +[package.extras] +testing = ["coverage (==6.2)", "mypy (==0.931)"] + +[[package]] +name = "pytest-asyncio" +version = "0.21.1" +description = "Pytest support for asyncio" +optional = false +python-versions = ">=3.7" +files = [ + {file = "pytest-asyncio-0.21.1.tar.gz", hash = "sha256:40a7eae6dded22c7b604986855ea48400ab15b069ae38116e8c01238e9eeb64d"}, + {file = "pytest_asyncio-0.21.1-py3-none-any.whl", hash = "sha256:8666c1c8ac02631d7c51ba282e0c69a8a452b211ffedf2599099845da5c5c37b"}, +] + +[package.dependencies] +pytest = ">=7.0.0" + +[package.extras] +docs = ["sphinx (>=5.3)", "sphinx-rtd-theme (>=1.0)"] +testing = ["coverage (>=6.2)", "flaky (>=3.5.0)", "hypothesis (>=5.7.1)", "mypy (>=0.931)", "pytest-trio (>=0.7.0)"] + +[[package]] +name = "pytest-mock" +version = "3.12.0" +description = "Thin-wrapper around the mock package for easier use with pytest" +optional = false +python-versions = ">=3.8" +files = [ + {file = "pytest-mock-3.12.0.tar.gz", hash = "sha256:31a40f038c22cad32287bb43932054451ff5583ff094bca6f675df2f8bc1a6e9"}, + {file = "pytest_mock-3.12.0-py3-none-any.whl", hash = "sha256:0972719a7263072da3a21c7f4773069bcc7486027d7e8e1f81d98a47e701bc4f"}, +] + +[package.dependencies] +pytest = ">=5.0" + +[package.extras] +dev = ["pre-commit", "pytest-asyncio", "tox"] + +[[package]] +name = "pyupgrade" +version = "3.15.0" +description = "A tool to automatically upgrade syntax for newer versions." +optional = false +python-versions = ">=3.8.1" +files = [ + {file = "pyupgrade-3.15.0-py2.py3-none-any.whl", hash = "sha256:8dc8ebfaed43566e2c65994162795017c7db11f531558a74bc8aa077907bc305"}, + {file = "pyupgrade-3.15.0.tar.gz", hash = "sha256:a7fde381060d7c224f55aef7a30fae5ac93bbc428367d27e70a603bc2acd4f00"}, +] + +[package.dependencies] +tokenize-rt = ">=5.2.0" + +[[package]] +name = "pyyaml" +version = "6.0.1" +description = "YAML parser and emitter for Python" +optional = false +python-versions = ">=3.6" +files = [ + {file = "PyYAML-6.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:d858aa552c999bc8a8d57426ed01e40bef403cd8ccdd0fc5f6f04a00414cac2a"}, + {file = "PyYAML-6.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:fd66fc5d0da6d9815ba2cebeb4205f95818ff4b79c3ebe268e75d961704af52f"}, + {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"}, + {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"}, + {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"}, + {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"}, + {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"}, + {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"}, + {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"}, + {file = "PyYAML-6.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:f003ed9ad21d6a4713f0a9b5a7a0a79e08dd0f221aff4525a2be4c346ee60aab"}, + {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"}, + {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"}, + {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"}, + {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"}, + {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"}, + {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, + {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, + {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, + {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, + {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, + {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, + {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"}, + {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"}, + {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"}, + {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"}, + {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:afd7e57eddb1a54f0f1a974bc4391af8bcce0b444685d936840f125cf046d5bd"}, + {file = "PyYAML-6.0.1-cp36-cp36m-win32.whl", hash = "sha256:fca0e3a251908a499833aa292323f32437106001d436eca0e6e7833256674585"}, + {file = "PyYAML-6.0.1-cp36-cp36m-win_amd64.whl", hash = "sha256:f22ac1c3cac4dbc50079e965eba2c1058622631e526bd9afd45fedd49ba781fa"}, + {file = "PyYAML-6.0.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:b1275ad35a5d18c62a7220633c913e1b42d44b46ee12554e5fd39c70a243d6a3"}, + {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:18aeb1bf9a78867dc38b259769503436b7c72f7a1f1f4c93ff9a17de54319b27"}, + {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:596106435fa6ad000c2991a98fa58eeb8656ef2325d7e158344fb33864ed87e3"}, + {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:baa90d3f661d43131ca170712d903e6295d1f7a0f595074f151c0aed377c9b9c"}, + {file = "PyYAML-6.0.1-cp37-cp37m-win32.whl", hash = "sha256:9046c58c4395dff28dd494285c82ba00b546adfc7ef001486fbf0324bc174fba"}, + {file = "PyYAML-6.0.1-cp37-cp37m-win_amd64.whl", hash = "sha256:4fb147e7a67ef577a588a0e2c17b6db51dda102c71de36f8549b6816a96e1867"}, + {file = "PyYAML-6.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1d4c7e777c441b20e32f52bd377e0c409713e8bb1386e1099c2415f26e479595"}, + {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"}, + {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"}, + {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"}, + {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"}, + {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"}, + {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"}, + {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"}, + {file = "PyYAML-6.0.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:c8098ddcc2a85b61647b2590f825f3db38891662cfc2fc776415143f599bb859"}, + {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"}, + {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"}, + {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"}, + {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"}, + {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"}, + {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"}, + {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, +] + +[[package]] +name = "ruff" +version = "0.1.4" +description = "An extremely fast Python linter and code formatter, written in Rust." +optional = false +python-versions = ">=3.7" +files = [ + {file = "ruff-0.1.4-py3-none-macosx_10_7_x86_64.whl", hash = "sha256:864958706b669cce31d629902175138ad8a069d99ca53514611521f532d91495"}, + {file = "ruff-0.1.4-py3-none-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl", hash = "sha256:9fdd61883bb34317c788af87f4cd75dfee3a73f5ded714b77ba928e418d6e39e"}, + {file = "ruff-0.1.4-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b4eaca8c9cc39aa7f0f0d7b8fe24ecb51232d1bb620fc4441a61161be4a17539"}, + {file = "ruff-0.1.4-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:a9a1301dc43cbf633fb603242bccd0aaa34834750a14a4c1817e2e5c8d60de17"}, + {file = "ruff-0.1.4-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:78e8db8ab6f100f02e28b3d713270c857d370b8d61871d5c7d1702ae411df683"}, + {file = "ruff-0.1.4-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:80fea754eaae06335784b8ea053d6eb8e9aac75359ebddd6fee0858e87c8d510"}, + {file = "ruff-0.1.4-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:6bc02a480d4bfffd163a723698da15d1a9aec2fced4c06f2a753f87f4ce6969c"}, + {file = "ruff-0.1.4-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9862811b403063765b03e716dac0fda8fdbe78b675cd947ed5873506448acea4"}, + {file = "ruff-0.1.4-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:58826efb8b3efbb59bb306f4b19640b7e366967a31c049d49311d9eb3a4c60cb"}, + {file = "ruff-0.1.4-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:fdfd453fc91d9d86d6aaa33b1bafa69d114cf7421057868f0b79104079d3e66e"}, + {file = "ruff-0.1.4-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:e8791482d508bd0b36c76481ad3117987301b86072158bdb69d796503e1c84a8"}, + {file = "ruff-0.1.4-py3-none-musllinux_1_2_i686.whl", hash = "sha256:01206e361021426e3c1b7fba06ddcb20dbc5037d64f6841e5f2b21084dc51800"}, + {file = "ruff-0.1.4-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:645591a613a42cb7e5c2b667cbefd3877b21e0252b59272ba7212c3d35a5819f"}, + {file = "ruff-0.1.4-py3-none-win32.whl", hash = "sha256:99908ca2b3b85bffe7e1414275d004917d1e0dfc99d497ccd2ecd19ad115fd0d"}, + {file = "ruff-0.1.4-py3-none-win_amd64.whl", hash = "sha256:1dfd6bf8f6ad0a4ac99333f437e0ec168989adc5d837ecd38ddb2cc4a2e3db8a"}, + {file = "ruff-0.1.4-py3-none-win_arm64.whl", hash = "sha256:d98ae9ebf56444e18a3e3652b3383204748f73e247dea6caaf8b52d37e6b32da"}, + {file = "ruff-0.1.4.tar.gz", hash = "sha256:21520ecca4cc555162068d87c747b8f95e1e95f8ecfcbbe59e8dd00710586315"}, +] + +[[package]] +name = "setuptools" +version = "68.2.2" +description = "Easily download, build, install, upgrade, and uninstall Python packages" +optional = false +python-versions = ">=3.8" +files = [ + {file = "setuptools-68.2.2-py3-none-any.whl", hash = "sha256:b454a35605876da60632df1a60f736524eb73cc47bbc9f3f1ef1b644de74fd2a"}, + {file = "setuptools-68.2.2.tar.gz", hash = "sha256:4ac1475276d2f1c48684874089fefcd83bd7162ddaafb81fac866ba0db282a87"}, +] + +[package.extras] +docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "pygments-github-lexers (==0.0.5)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-favicon", "sphinx-hoverxref (<2)", "sphinx-inline-tabs", "sphinx-lint", "sphinx-notfound-page (>=1,<2)", "sphinx-reredirects", "sphinxcontrib-towncrier"] +testing = ["build[virtualenv]", "filelock (>=3.4.0)", "flake8-2020", "ini2toml[lite] (>=0.9)", "jaraco.develop (>=7.21)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "pip (>=19.1)", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-mypy (>=0.9.1)", "pytest-perf", "pytest-ruff", "pytest-timeout", "pytest-xdist", "tomli-w (>=1.0.0)", "virtualenv (>=13.0.0)", "wheel"] +testing-integration = ["build[virtualenv] (>=1.0.3)", "filelock (>=3.4.0)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "packaging (>=23.1)", "pytest", "pytest-enabler", "pytest-xdist", "tomli", "virtualenv (>=13.0.0)", "wheel"] + +[[package]] +name = "soupsieve" +version = "2.5" +description = "A modern CSS selector implementation for Beautiful Soup." +optional = false +python-versions = ">=3.8" +files = [ + {file = "soupsieve-2.5-py3-none-any.whl", hash = "sha256:eaa337ff55a1579b6549dc679565eac1e3d000563bcb1c8ab0d0fefbc0c2cdc7"}, + {file = "soupsieve-2.5.tar.gz", hash = "sha256:5663d5a7b3bfaeee0bc4372e7fc48f9cff4940b3eec54a6451cc5299f1097690"}, +] + +[[package]] +name = "tokenize-rt" +version = "5.2.0" +description = "A wrapper around the stdlib `tokenize` which roundtrips." +optional = false +python-versions = ">=3.8" +files = [ + {file = "tokenize_rt-5.2.0-py2.py3-none-any.whl", hash = "sha256:b79d41a65cfec71285433511b50271b05da3584a1da144a0752e9c621a285289"}, + {file = "tokenize_rt-5.2.0.tar.gz", hash = "sha256:9fe80f8a5c1edad2d3ede0f37481cc0cc1538a2f442c9c2f9e4feacd2792d054"}, +] + +[[package]] +name = "tomlkit" +version = "0.12.2" +description = "Style preserving TOML library" +optional = false +python-versions = ">=3.7" +files = [ + {file = "tomlkit-0.12.2-py3-none-any.whl", hash = "sha256:eeea7ac7563faeab0a1ed8fe12c2e5a51c61f933f2502f7e9db0241a65163ad0"}, + {file = "tomlkit-0.12.2.tar.gz", hash = "sha256:df32fab589a81f0d7dc525a4267b6d7a64ee99619cbd1eeb0fae32c1dd426977"}, +] + +[[package]] +name = "typer" +version = "0.9.0" +description = "Typer, build great CLIs. Easy to code. Based on Python type hints." +optional = false +python-versions = ">=3.6" +files = [ + {file = "typer-0.9.0-py3-none-any.whl", hash = "sha256:5d96d986a21493606a358cae4461bd8cdf83cbf33a5aa950ae629ca3b51467ee"}, + {file = "typer-0.9.0.tar.gz", hash = "sha256:50922fd79aea2f4751a8e0408ff10d2662bd0c8bbfa84755a699f3bada2978b2"}, +] + +[package.dependencies] +click = ">=7.1.1,<9.0.0" +typing-extensions = ">=3.7.4.3" + +[package.extras] +all = ["colorama (>=0.4.3,<0.5.0)", "rich (>=10.11.0,<14.0.0)", "shellingham (>=1.3.0,<2.0.0)"] +dev = ["autoflake (>=1.3.1,<2.0.0)", "flake8 (>=3.8.3,<4.0.0)", "pre-commit (>=2.17.0,<3.0.0)"] +doc = ["cairosvg (>=2.5.2,<3.0.0)", "mdx-include (>=1.4.1,<2.0.0)", "mkdocs (>=1.1.2,<2.0.0)", "mkdocs-material (>=8.1.4,<9.0.0)", "pillow (>=9.3.0,<10.0.0)"] +test = ["black (>=22.3.0,<23.0.0)", "coverage (>=6.2,<7.0)", "isort (>=5.0.6,<6.0.0)", "mypy (==0.910)", "pytest (>=4.4.0,<8.0.0)", "pytest-cov (>=2.10.0,<5.0.0)", "pytest-sugar (>=0.9.4,<0.10.0)", "pytest-xdist (>=1.32.0,<4.0.0)", "rich (>=10.11.0,<14.0.0)", "shellingham (>=1.3.0,<2.0.0)"] + +[[package]] +name = "types-beautifulsoup4" +version = "4.12.0.7" +description = "Typing stubs for beautifulsoup4" +optional = false +python-versions = ">=3.7" +files = [ + {file = "types-beautifulsoup4-4.12.0.7.tar.gz", hash = "sha256:59980028d29bf55d0db359efa305b75bacf0cb92e3f3f6b3fd408f2531df274c"}, + {file = "types_beautifulsoup4-4.12.0.7-py3-none-any.whl", hash = "sha256:8b03b054cb2e62abf82bbbeda57a07257026f4ed9010ef17d8f8eff43bb1f9b7"}, +] + +[package.dependencies] +types-html5lib = "*" + +[[package]] +name = "types-html5lib" +version = "1.1.11.15" +description = "Typing stubs for html5lib" +optional = false +python-versions = "*" +files = [ + {file = "types-html5lib-1.1.11.15.tar.gz", hash = "sha256:80e1a2062d22a3affe5c28d97da30bffbf3a076d393c80fc6f1671216c1bd492"}, + {file = "types_html5lib-1.1.11.15-py3-none-any.whl", hash = "sha256:16fe936d99b9f7fc210e2e21a2aed1b6bbbc554ad8242a6ef75f6f2bddb27e58"}, +] + +[[package]] +name = "typing-extensions" +version = "4.8.0" +description = "Backported and Experimental Type Hints for Python 3.8+" +optional = false +python-versions = ">=3.8" +files = [ + {file = "typing_extensions-4.8.0-py3-none-any.whl", hash = "sha256:8f92fc8806f9a6b641eaa5318da32b44d401efaac0f6678c9bc448ba3605faa0"}, + {file = "typing_extensions-4.8.0.tar.gz", hash = "sha256:df8e4339e9cb77357558cbdbceca33c303714cf861d1eef15e1070055ae8b7ef"}, +] + +[[package]] +name = "typing-inspect" +version = "0.9.0" +description = "Runtime inspection utilities for typing module." +optional = false +python-versions = "*" +files = [ + {file = "typing_inspect-0.9.0-py3-none-any.whl", hash = "sha256:9ee6fc59062311ef8547596ab6b955e1b8aa46242d854bfc78f4f6b0eff35f9f"}, + {file = "typing_inspect-0.9.0.tar.gz", hash = "sha256:b23fc42ff6f6ef6954e4852c1fb512cdd18dbea03134f91f856a95ccc9461f78"}, +] + +[package.dependencies] +mypy-extensions = ">=0.3.0" +typing-extensions = ">=3.7.4" + +[[package]] +name = "uvloop" +version = "0.19.0" +description = "Fast implementation of asyncio event loop on top of libuv" +optional = false +python-versions = ">=3.8.0" +files = [ + {file = "uvloop-0.19.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:de4313d7f575474c8f5a12e163f6d89c0a878bc49219641d49e6f1444369a90e"}, + {file = "uvloop-0.19.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:5588bd21cf1fcf06bded085f37e43ce0e00424197e7c10e77afd4bbefffef428"}, + {file = "uvloop-0.19.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7b1fd71c3843327f3bbc3237bedcdb6504fd50368ab3e04d0410e52ec293f5b8"}, + {file = "uvloop-0.19.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5a05128d315e2912791de6088c34136bfcdd0c7cbc1cf85fd6fd1bb321b7c849"}, + {file = "uvloop-0.19.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:cd81bdc2b8219cb4b2556eea39d2e36bfa375a2dd021404f90a62e44efaaf957"}, + {file = "uvloop-0.19.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:5f17766fb6da94135526273080f3455a112f82570b2ee5daa64d682387fe0dcd"}, + {file = "uvloop-0.19.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:4ce6b0af8f2729a02a5d1575feacb2a94fc7b2e983868b009d51c9a9d2149bef"}, + {file = "uvloop-0.19.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:31e672bb38b45abc4f26e273be83b72a0d28d074d5b370fc4dcf4c4eb15417d2"}, + {file = "uvloop-0.19.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:570fc0ed613883d8d30ee40397b79207eedd2624891692471808a95069a007c1"}, + {file = "uvloop-0.19.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5138821e40b0c3e6c9478643b4660bd44372ae1e16a322b8fc07478f92684e24"}, + {file = "uvloop-0.19.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:91ab01c6cd00e39cde50173ba4ec68a1e578fee9279ba64f5221810a9e786533"}, + {file = "uvloop-0.19.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:47bf3e9312f63684efe283f7342afb414eea4d3011542155c7e625cd799c3b12"}, + {file = "uvloop-0.19.0-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:da8435a3bd498419ee8c13c34b89b5005130a476bda1d6ca8cfdde3de35cd650"}, + {file = "uvloop-0.19.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:02506dc23a5d90e04d4f65c7791e65cf44bd91b37f24cfc3ef6cf2aff05dc7ec"}, + {file = "uvloop-0.19.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2693049be9d36fef81741fddb3f441673ba12a34a704e7b4361efb75cf30befc"}, + {file = "uvloop-0.19.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7010271303961c6f0fe37731004335401eb9075a12680738731e9c92ddd96ad6"}, + {file = "uvloop-0.19.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:5daa304d2161d2918fa9a17d5635099a2f78ae5b5960e742b2fcfbb7aefaa593"}, + {file = "uvloop-0.19.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:7207272c9520203fea9b93843bb775d03e1cf88a80a936ce760f60bb5add92f3"}, + {file = "uvloop-0.19.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:78ab247f0b5671cc887c31d33f9b3abfb88d2614b84e4303f1a63b46c046c8bd"}, + {file = "uvloop-0.19.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:472d61143059c84947aa8bb74eabbace30d577a03a1805b77933d6bd13ddebbd"}, + {file = "uvloop-0.19.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:45bf4c24c19fb8a50902ae37c5de50da81de4922af65baf760f7c0c42e1088be"}, + {file = "uvloop-0.19.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:271718e26b3e17906b28b67314c45d19106112067205119dddbd834c2b7ce797"}, + {file = "uvloop-0.19.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:34175c9fd2a4bc3adc1380e1261f60306344e3407c20a4d684fd5f3be010fa3d"}, + {file = "uvloop-0.19.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:e27f100e1ff17f6feeb1f33968bc185bf8ce41ca557deee9d9bbbffeb72030b7"}, + {file = "uvloop-0.19.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:13dfdf492af0aa0a0edf66807d2b465607d11c4fa48f4a1fd41cbea5b18e8e8b"}, + {file = "uvloop-0.19.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:6e3d4e85ac060e2342ff85e90d0c04157acb210b9ce508e784a944f852a40e67"}, + {file = "uvloop-0.19.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8ca4956c9ab567d87d59d49fa3704cf29e37109ad348f2d5223c9bf761a332e7"}, + {file = "uvloop-0.19.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f467a5fd23b4fc43ed86342641f3936a68ded707f4627622fa3f82a120e18256"}, + {file = "uvloop-0.19.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:492e2c32c2af3f971473bc22f086513cedfc66a130756145a931a90c3958cb17"}, + {file = "uvloop-0.19.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:2df95fca285a9f5bfe730e51945ffe2fa71ccbfdde3b0da5772b4ee4f2e770d5"}, + {file = "uvloop-0.19.0.tar.gz", hash = "sha256:0246f4fd1bf2bf702e06b0d45ee91677ee5c31242f39aab4ea6fe0c51aedd0fd"}, +] + +[package.extras] +docs = ["Sphinx (>=4.1.2,<4.2.0)", "sphinx-rtd-theme (>=0.5.2,<0.6.0)", "sphinxcontrib-asyncio (>=0.3.0,<0.4.0)"] +test = ["Cython (>=0.29.36,<0.30.0)", "aiohttp (==3.9.0b0)", "aiohttp (>=3.8.1)", "flake8 (>=5.0,<6.0)", "mypy (>=0.800)", "psutil", "pyOpenSSL (>=23.0.0,<23.1.0)", "pycodestyle (>=2.9.0,<2.10.0)"] + +[[package]] +name = "virtualenv" +version = "20.24.6" +description = "Virtual Python Environment builder" +optional = false +python-versions = ">=3.7" +files = [ + {file = "virtualenv-20.24.6-py3-none-any.whl", hash = "sha256:520d056652454c5098a00c0f073611ccbea4c79089331f60bf9d7ba247bb7381"}, + {file = "virtualenv-20.24.6.tar.gz", hash = "sha256:02ece4f56fbf939dbbc33c0715159951d6bf14aaf5457b092e4548e1382455af"}, +] + +[package.dependencies] +distlib = ">=0.3.7,<1" +filelock = ">=3.12.2,<4" +platformdirs = ">=3.9.1,<4" + +[package.extras] +docs = ["furo (>=2023.7.26)", "proselint (>=0.13)", "sphinx (>=7.1.2)", "sphinx-argparse (>=0.4)", "sphinxcontrib-towncrier (>=0.2.1a0)", "towncrier (>=23.6)"] +test = ["covdefaults (>=2.3)", "coverage (>=7.2.7)", "coverage-enable-subprocess (>=1)", "flaky (>=3.7)", "packaging (>=23.1)", "pytest (>=7.4)", "pytest-env (>=0.8.2)", "pytest-freezer (>=0.4.8)", "pytest-mock (>=3.11.1)", "pytest-randomly (>=3.12)", "pytest-timeout (>=2.1)", "setuptools (>=68)", "time-machine (>=2.10)"] + +[[package]] +name = "yarl" +version = "1.9.2" +description = "Yet another URL library" +optional = false +python-versions = ">=3.7" +files = [ + {file = "yarl-1.9.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:8c2ad583743d16ddbdf6bb14b5cd76bf43b0d0006e918809d5d4ddf7bde8dd82"}, + {file = "yarl-1.9.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:82aa6264b36c50acfb2424ad5ca537a2060ab6de158a5bd2a72a032cc75b9eb8"}, + {file = "yarl-1.9.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:c0c77533b5ed4bcc38e943178ccae29b9bcf48ffd1063f5821192f23a1bd27b9"}, + {file = "yarl-1.9.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ee4afac41415d52d53a9833ebae7e32b344be72835bbb589018c9e938045a560"}, + {file = "yarl-1.9.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9bf345c3a4f5ba7f766430f97f9cc1320786f19584acc7086491f45524a551ac"}, + {file = "yarl-1.9.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2a96c19c52ff442a808c105901d0bdfd2e28575b3d5f82e2f5fd67e20dc5f4ea"}, + {file = "yarl-1.9.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:891c0e3ec5ec881541f6c5113d8df0315ce5440e244a716b95f2525b7b9f3608"}, + {file = "yarl-1.9.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c3a53ba34a636a256d767c086ceb111358876e1fb6b50dfc4d3f4951d40133d5"}, + {file = "yarl-1.9.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:566185e8ebc0898b11f8026447eacd02e46226716229cea8db37496c8cdd26e0"}, + {file = "yarl-1.9.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:2b0738fb871812722a0ac2154be1f049c6223b9f6f22eec352996b69775b36d4"}, + {file = "yarl-1.9.2-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:32f1d071b3f362c80f1a7d322bfd7b2d11e33d2adf395cc1dd4df36c9c243095"}, + {file = "yarl-1.9.2-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:e9fdc7ac0d42bc3ea78818557fab03af6181e076a2944f43c38684b4b6bed8e3"}, + {file = "yarl-1.9.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:56ff08ab5df8429901ebdc5d15941b59f6253393cb5da07b4170beefcf1b2528"}, + {file = "yarl-1.9.2-cp310-cp310-win32.whl", hash = "sha256:8ea48e0a2f931064469bdabca50c2f578b565fc446f302a79ba6cc0ee7f384d3"}, + {file = "yarl-1.9.2-cp310-cp310-win_amd64.whl", hash = "sha256:50f33040f3836e912ed16d212f6cc1efb3231a8a60526a407aeb66c1c1956dde"}, + {file = "yarl-1.9.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:646d663eb2232d7909e6601f1a9107e66f9791f290a1b3dc7057818fe44fc2b6"}, + {file = "yarl-1.9.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:aff634b15beff8902d1f918012fc2a42e0dbae6f469fce134c8a0dc51ca423bb"}, + {file = "yarl-1.9.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:a83503934c6273806aed765035716216cc9ab4e0364f7f066227e1aaea90b8d0"}, + {file = "yarl-1.9.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b25322201585c69abc7b0e89e72790469f7dad90d26754717f3310bfe30331c2"}, + {file = "yarl-1.9.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:22a94666751778629f1ec4280b08eb11815783c63f52092a5953faf73be24191"}, + {file = "yarl-1.9.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8ec53a0ea2a80c5cd1ab397925f94bff59222aa3cf9c6da938ce05c9ec20428d"}, + {file = "yarl-1.9.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:159d81f22d7a43e6eabc36d7194cb53f2f15f498dbbfa8edc8a3239350f59fe7"}, + {file = "yarl-1.9.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:832b7e711027c114d79dffb92576acd1bd2decc467dec60e1cac96912602d0e6"}, + {file = "yarl-1.9.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:95d2ecefbcf4e744ea952d073c6922e72ee650ffc79028eb1e320e732898d7e8"}, + {file = "yarl-1.9.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:d4e2c6d555e77b37288eaf45b8f60f0737c9efa3452c6c44626a5455aeb250b9"}, + {file = "yarl-1.9.2-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:783185c75c12a017cc345015ea359cc801c3b29a2966c2655cd12b233bf5a2be"}, + {file = "yarl-1.9.2-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:b8cc1863402472f16c600e3e93d542b7e7542a540f95c30afd472e8e549fc3f7"}, + {file = "yarl-1.9.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:822b30a0f22e588b32d3120f6d41e4ed021806418b4c9f0bc3048b8c8cb3f92a"}, + {file = "yarl-1.9.2-cp311-cp311-win32.whl", hash = "sha256:a60347f234c2212a9f0361955007fcf4033a75bf600a33c88a0a8e91af77c0e8"}, + {file = "yarl-1.9.2-cp311-cp311-win_amd64.whl", hash = "sha256:be6b3fdec5c62f2a67cb3f8c6dbf56bbf3f61c0f046f84645cd1ca73532ea051"}, + {file = "yarl-1.9.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:38a3928ae37558bc1b559f67410df446d1fbfa87318b124bf5032c31e3447b74"}, + {file = "yarl-1.9.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ac9bb4c5ce3975aeac288cfcb5061ce60e0d14d92209e780c93954076c7c4367"}, + {file = "yarl-1.9.2-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3da8a678ca8b96c8606bbb8bfacd99a12ad5dd288bc6f7979baddd62f71c63ef"}, + {file = "yarl-1.9.2-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:13414591ff516e04fcdee8dc051c13fd3db13b673c7a4cb1350e6b2ad9639ad3"}, + {file = "yarl-1.9.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bf74d08542c3a9ea97bb8f343d4fcbd4d8f91bba5ec9d5d7f792dbe727f88938"}, + {file = "yarl-1.9.2-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6e7221580dc1db478464cfeef9b03b95c5852cc22894e418562997df0d074ccc"}, + {file = "yarl-1.9.2-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:494053246b119b041960ddcd20fd76224149cfea8ed8777b687358727911dd33"}, + {file = "yarl-1.9.2-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:52a25809fcbecfc63ac9ba0c0fb586f90837f5425edfd1ec9f3372b119585e45"}, + {file = "yarl-1.9.2-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:e65610c5792870d45d7b68c677681376fcf9cc1c289f23e8e8b39c1485384185"}, + {file = "yarl-1.9.2-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:1b1bba902cba32cdec51fca038fd53f8beee88b77efc373968d1ed021024cc04"}, + {file = "yarl-1.9.2-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:662e6016409828ee910f5d9602a2729a8a57d74b163c89a837de3fea050c7582"}, + {file = "yarl-1.9.2-cp37-cp37m-win32.whl", hash = "sha256:f364d3480bffd3aa566e886587eaca7c8c04d74f6e8933f3f2c996b7f09bee1b"}, + {file = "yarl-1.9.2-cp37-cp37m-win_amd64.whl", hash = "sha256:6a5883464143ab3ae9ba68daae8e7c5c95b969462bbe42e2464d60e7e2698368"}, + {file = "yarl-1.9.2-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:5610f80cf43b6202e2c33ba3ec2ee0a2884f8f423c8f4f62906731d876ef4fac"}, + {file = "yarl-1.9.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:b9a4e67ad7b646cd6f0938c7ebfd60e481b7410f574c560e455e938d2da8e0f4"}, + {file = "yarl-1.9.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:83fcc480d7549ccebe9415d96d9263e2d4226798c37ebd18c930fce43dfb9574"}, + {file = "yarl-1.9.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5fcd436ea16fee7d4207c045b1e340020e58a2597301cfbcfdbe5abd2356c2fb"}, + {file = "yarl-1.9.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:84e0b1599334b1e1478db01b756e55937d4614f8654311eb26012091be109d59"}, + {file = "yarl-1.9.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3458a24e4ea3fd8930e934c129b676c27452e4ebda80fbe47b56d8c6c7a63a9e"}, + {file = "yarl-1.9.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:838162460b3a08987546e881a2bfa573960bb559dfa739e7800ceeec92e64417"}, + {file = "yarl-1.9.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f4e2d08f07a3d7d3e12549052eb5ad3eab1c349c53ac51c209a0e5991bbada78"}, + {file = "yarl-1.9.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:de119f56f3c5f0e2fb4dee508531a32b069a5f2c6e827b272d1e0ff5ac040333"}, + {file = "yarl-1.9.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:149ddea5abf329752ea5051b61bd6c1d979e13fbf122d3a1f9f0c8be6cb6f63c"}, + {file = "yarl-1.9.2-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:674ca19cbee4a82c9f54e0d1eee28116e63bc6fd1e96c43031d11cbab8b2afd5"}, + {file = "yarl-1.9.2-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:9b3152f2f5677b997ae6c804b73da05a39daa6a9e85a512e0e6823d81cdad7cc"}, + {file = "yarl-1.9.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:5415d5a4b080dc9612b1b63cba008db84e908b95848369aa1da3686ae27b6d2b"}, + {file = "yarl-1.9.2-cp38-cp38-win32.whl", hash = "sha256:f7a3d8146575e08c29ed1cd287068e6d02f1c7bdff8970db96683b9591b86ee7"}, + {file = "yarl-1.9.2-cp38-cp38-win_amd64.whl", hash = "sha256:63c48f6cef34e6319a74c727376e95626f84ea091f92c0250a98e53e62c77c72"}, + {file = "yarl-1.9.2-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:75df5ef94c3fdc393c6b19d80e6ef1ecc9ae2f4263c09cacb178d871c02a5ba9"}, + {file = "yarl-1.9.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:c027a6e96ef77d401d8d5a5c8d6bc478e8042f1e448272e8d9752cb0aff8b5c8"}, + {file = "yarl-1.9.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:f3b078dbe227f79be488ffcfc7a9edb3409d018e0952cf13f15fd6512847f3f7"}, + {file = "yarl-1.9.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:59723a029760079b7d991a401386390c4be5bfec1e7dd83e25a6a0881859e716"}, + {file = "yarl-1.9.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b03917871bf859a81ccb180c9a2e6c1e04d2f6a51d953e6a5cdd70c93d4e5a2a"}, + {file = "yarl-1.9.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c1012fa63eb6c032f3ce5d2171c267992ae0c00b9e164efe4d73db818465fac3"}, + {file = "yarl-1.9.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a74dcbfe780e62f4b5a062714576f16c2f3493a0394e555ab141bf0d746bb955"}, + {file = "yarl-1.9.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:8c56986609b057b4839968ba901944af91b8e92f1725d1a2d77cbac6972b9ed1"}, + {file = "yarl-1.9.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:2c315df3293cd521033533d242d15eab26583360b58f7ee5d9565f15fee1bef4"}, + {file = "yarl-1.9.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:b7232f8dfbd225d57340e441d8caf8652a6acd06b389ea2d3222b8bc89cbfca6"}, + {file = "yarl-1.9.2-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:53338749febd28935d55b41bf0bcc79d634881195a39f6b2f767870b72514caf"}, + {file = "yarl-1.9.2-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:066c163aec9d3d073dc9ffe5dd3ad05069bcb03fcaab8d221290ba99f9f69ee3"}, + {file = "yarl-1.9.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:8288d7cd28f8119b07dd49b7230d6b4562f9b61ee9a4ab02221060d21136be80"}, + {file = "yarl-1.9.2-cp39-cp39-win32.whl", hash = "sha256:b124e2a6d223b65ba8768d5706d103280914d61f5cae3afbc50fc3dfcc016623"}, + {file = "yarl-1.9.2-cp39-cp39-win_amd64.whl", hash = "sha256:61016e7d582bc46a5378ffdd02cd0314fb8ba52f40f9cf4d9a5e7dbef88dee18"}, + {file = "yarl-1.9.2.tar.gz", hash = "sha256:04ab9d4b9f587c06d801c2abfe9317b77cdf996c65a90d5e84ecc45010823571"}, +] + +[package.dependencies] +idna = ">=2.0" +multidict = ">=4.0" + +[metadata] +lock-version = "2.0" +python-versions = "^3.11" +content-hash = "969b37ecbb98a0996441dbe205554929bda2df0d708f1132e0e404c85060ed43" diff --git a/pyproject.toml b/pyproject.toml index aa9eeb9..d825e9d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,30 +1,49 @@ -[build-system] -requires = ["setuptools>=61.0"] -build-backend = "setuptools.build_meta" - -[project] +[tool.poetry] name = "pyadtpulse" -dynamic = ["version"] -description="Python interface for ADT Pulse security systems" +version = "1.1.3" +description = "Python interface for ADT Pulse security systems" +authors = ["Ryan Snodgrass"] +maintainers = ["Robert Lippmann"] +license = "Apache-2.0" readme = "README.md" -authors = [{name = "Ryan Snodgrass"}] -maintainers = [{name = "Robert Lippmann"}] -license = {file = "LICENSE.md"} -dependencies = ["aiohttp>=3.8.1", "uvloop>=0.17.0", "beautifulsoup4>=4.11.1"] -keywords = ["security system", "adt", "home automation", "security alarm"] +repository = "https://github.com/rlippmann/pyadtpulse" classifiers = [ "Programming Language :: Python :: 3", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", ] -[project.urls] +[tool.poetry.dependencies] +python = "^3.11" +aiohttp = "^3.8.6" +beautifulsoup4 = "^4.12.2" +uvloop = "^0.19.0" + +[tool.poetry.urls] "Changelog" = "https://github.com/rlippmann/pyadtpulse/blob/master/CHANGELOG.md" -"Source" = "https://github.com/rlippmann/pyadtpulse" "Issues" = "https://github.com/rlippmann/pyadtpulse/issues" -[tool.setuptools.dynamic] -version = {attr = "pyadtpulse.const.__version__"} +[tool.poetry.group.test.dependencies] +pytest = "^7.4.3" +pytest-asyncio = "^0.21.1" +pytest-mock = "^3.12.0" +pytest-aiohttp = "^1.0.5" + + +[tool.poetry.group.dev.dependencies] +pre-commit = "^3.5.0" +ruff = "^0.1.4" +pycln = "^2.3.0" +pyupgrade = "^3.15.0" +isort = "^5.12.0" +black = "^23.10.1" +mypy = "^1.6.1" +pylint = "^3.0.2" +types-beautifulsoup4 = "^4.12.0.7" + +[build-system] +requires = ["poetry-core"] +build-backend = ["poetry.core.masonry.api"] [tool.isort] profile = "black" From 9191fd39c1f91c9352450cc923797ac76472e93b Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 09:10:09 -0500 Subject: [PATCH 070/226] bump version to 1.1.4b0 --- pyadtpulse/const.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 9fe9de6..e42a259 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -1,5 +1,5 @@ """Constants for pyadtpulse.""" -__version__ = "1.1.3" +__version__ = "1.1.4b0" DEFAULT_API_HOST = "https://portal.adtpulse.com" API_HOST_CA = "https://portal-ca.adtpulse.com" # Canada diff --git a/pyproject.toml b/pyproject.toml index d825e9d..b64230f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "pyadtpulse" -version = "1.1.3" +version = "1.1.4b0" description = "Python interface for ADT Pulse security systems" authors = ["Ryan Snodgrass"] maintainers = ["Robert Lippmann"] From 301e7c4f0e9e936b3f25004a62dd46df5522400d Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 16:24:14 -0500 Subject: [PATCH 071/226] move test_pyadtpulse.py to tests --- pyadtpulse/{ => tests}/test_pyadtpulse.py | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename pyadtpulse/{ => tests}/test_pyadtpulse.py (100%) diff --git a/pyadtpulse/test_pyadtpulse.py b/pyadtpulse/tests/test_pyadtpulse.py similarity index 100% rename from pyadtpulse/test_pyadtpulse.py rename to pyadtpulse/tests/test_pyadtpulse.py From 1df64977f7f81d68502973310ce4356b19d31ee8 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 17:26:40 -0500 Subject: [PATCH 072/226] change default http headers to new values --- pyadtpulse/const.py | 14 ++++++++++---- pyadtpulse/pulse_connection.py | 18 +++++++++--------- 2 files changed, 19 insertions(+), 13 deletions(-) diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index e42a259..14c780f 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -28,15 +28,21 @@ ADT_DEFAULT_POLL_INTERVAL = 2.0 ADT_GATEWAY_OFFLINE_POLL_INTERVAL = 90.0 ADT_MAX_RELOGIN_BACKOFF: float = 15.0 * 60.0 -ADT_DEFAULT_HTTP_HEADERS = { +ADT_DEFAULT_HTTP_USER_AGENT = { "User-Agent": ( "Mozilla/5.0 (Windows NT 10.0; Win64; x64) " "AppleWebKit/537.36 (KHTML, like Gecko) " "Chrome/100.0.4896.127 Safari/537.36 Edg/100.0.1185.44" - ), - "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + ) } +ADT_DEFAULT_HTTP_ACCEPT_HEADERS = { + "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9," + "image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7" +} +ADT_OTHER_HTTP_ACCEPT_HEADERS = { + "Accept": "*/*", +} ADT_ARM_URI = "/quickcontrol/serv/RunRRACommand" ADT_ARM_DISARM_URI = "/quickcontrol/armDisarm.jsp" @@ -44,7 +50,7 @@ ADT_DEFAULT_VERSION = "24.0.0-117" -ADT_HTTP_REFERER_URIS = (ADT_LOGIN_URI, ADT_DEVICE_URI, ADT_SUMMARY_URI, ADT_SYSTEM_URI) +ADT_HTTP_BACKGROUND_URIS = (ADT_ORB_URI, ADT_SYNC_CHECK_URI) STATE_OK = "OK" STATE_OPEN = "Open" STATE_MOTION = "Motion" diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index a7770a2..f6f8953 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -19,12 +19,14 @@ from yarl import URL from .const import ( - ADT_DEFAULT_HTTP_HEADERS, + ADT_DEFAULT_HTTP_ACCEPT_HEADERS, + ADT_DEFAULT_HTTP_USER_AGENT, ADT_DEFAULT_VERSION, - ADT_HTTP_REFERER_URIS, + ADT_HTTP_BACKGROUND_URIS, ADT_LOGIN_URI, ADT_LOGOUT_URI, ADT_ORB_URI, + ADT_OTHER_HTTP_ACCEPT_HEADERS, API_HOST_CA, API_PREFIX, DEFAULT_API_HOST, @@ -85,7 +87,7 @@ def __init__( self, host: str, session: ClientSession | None = None, - user_agent: str = ADT_DEFAULT_HTTP_HEADERS["User-Agent"], + user_agent: str = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"], debug_locks: bool = False, detailed_debug_logging: bool = False, ): @@ -100,6 +102,7 @@ def __init__( else: self._session = session self._session.headers.update({"User-Agent": user_agent}) + self._session.headers.update(ADT_DEFAULT_HTTP_ACCEPT_HEADERS) self._attribute_lock: RLock | DebugRLock self._last_login_time: int = 0 if not debug_locks: @@ -284,12 +287,9 @@ async def async_query( await self.async_fetch_version() url = self.make_url(uri) - - headers = {"Accept": ADT_DEFAULT_HTTP_HEADERS["Accept"]} - if uri not in ADT_HTTP_REFERER_URIS: - headers["Accept"] = "*/*" - - self._session.headers.update(headers) + headers = extra_headers if extra_headers is not None else {} + if uri in ADT_HTTP_BACKGROUND_URIS: + headers.setdefault("Accept", ADT_OTHER_HTTP_ACCEPT_HEADERS["Accept"]) if self.detailed_debug_logging: LOG.debug( "Attempting %s %s params=%s timeout=%d", From 493b5b01b500968fc42e4788b4c3ab1d4ec0f068 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 17:32:18 -0500 Subject: [PATCH 073/226] add data parameter to query/async_query --- pyadtpulse/pulse_connection.py | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index f6f8953..a878475 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -241,6 +241,7 @@ async def async_query( method: str = "GET", extra_params: dict[str, str] | None = None, extra_headers: dict[str, str] | None = None, + data: dict[str, str] | None = None, timeout: int = 1, requires_authentication: bool = True, ) -> tuple[int, str | None, URL | None]: @@ -254,6 +255,7 @@ async def async_query( Defaults to None. extra_headers (Optional[Dict], optional): extra HTTP headers. Defaults to None. + data (Optional[Dict], optional): data to send. Defaults to None. timeout (int, optional): timeout in seconds. Defaults to 1. requires_authentication (bool, optional): True if authentication is required to perform query. @@ -292,10 +294,11 @@ async def async_query( headers.setdefault("Accept", ADT_OTHER_HTTP_ACCEPT_HEADERS["Accept"]) if self.detailed_debug_logging: LOG.debug( - "Attempting %s %s params=%s timeout=%d", + "Attempting %s %s params=%s data=%s timeout=%d", method, url, extra_params, + data, timeout, ) retry = 0 @@ -307,7 +310,7 @@ async def async_query( url, headers=extra_headers, params=extra_params, - data=extra_params if method == "POST" else None, + data=data if method == "POST" else None, timeout=timeout, ) as response: retry += 1 @@ -358,6 +361,7 @@ def query( method: str = "GET", extra_params: dict[str, str] | None = None, extra_headers: dict[str, str] | None = None, + data: dict[str, str] | None = None, timeout=1, requires_authentication: bool = True, ) -> tuple[int, str | None, URL | None]: @@ -369,6 +373,7 @@ def query( extra_params (Optional[Dict], optional): query parameters. Defaults to None. extra_headers (Optional[Dict], optional): extra HTTP headers. Defaults to None. + data (Optional[Dict], optional): data to send. Defaults to None. timeout (int, optional): timeout in seconds. Defaults to 1. requires_authentication (bool, optional): True if authentication is required to perform query. Defaults to True. @@ -379,7 +384,13 @@ def query( response """ coro = self.async_query( - uri, method, extra_params, extra_headers, timeout, requires_authentication + uri, + method, + extra_params, + extra_headers, + data=data, + timeout=timeout, + requires_authentication=requires_authentication, ) return asyncio.run_coroutine_threadsafe( coro, self.check_sync("Attempting to run sync query from async login") From 114a87365199f83a25fe7197ba083a3f8c24ab6c Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 19:48:29 -0500 Subject: [PATCH 074/226] rework http code --- pyadtpulse/__init__.py | 4 ++-- pyadtpulse/pulse_connection.py | 30 +++++++++++++++--------------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index b798692..d1a720d 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -17,7 +17,7 @@ from .alarm_panel import ADT_ALARM_UNKNOWN from .const import ( - ADT_DEFAULT_HTTP_HEADERS, + ADT_DEFAULT_HTTP_USER_AGENT, ADT_DEFAULT_KEEPALIVE_INTERVAL, ADT_DEFAULT_RELOGIN_INTERVAL, ADT_GATEWAY_STRING, @@ -84,7 +84,7 @@ def __init__( password: str, fingerprint: str, service_host: str = DEFAULT_API_HOST, - user_agent=ADT_DEFAULT_HTTP_HEADERS["User-Agent"], + user_agent=ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"], websession: ClientSession | None = None, do_login: bool = True, debug_locks: bool = False, diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index a878475..d6c09b7 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -55,6 +55,7 @@ class ADTPulseConnection: "_retry_after", "_authenticated_flag", "_detailed_debug_logging", + "_site_id", ) @staticmethod @@ -112,6 +113,7 @@ def __init__( self._loop: asyncio.AbstractEventLoop | None = None self._retry_after = int(time.time()) self._detailed_debug_logging = detailed_debug_logging + self._site_id = "" def __del__(self): """Destructor for ADTPulseConnection.""" @@ -472,48 +474,46 @@ async def async_do_login_query( Raises: ValueError: if login parameters are not correct """ - status = 200 - response_text = None - url = None + response: tuple[int, str | None, URL | None] = (200, None, None) self.check_login_parameters(username, password, fingerprint) try: - status, response_text, url = await self.async_query( + response = await self.async_query( ADT_LOGIN_URI, method="POST", extra_params={ "partner": "adt", - "e": "ns", + "network": self._site_id, + }, + data={ "usernameForm": username, "passwordForm": password, "fingerprint": fingerprint, - "sun": "yes", }, timeout=timeout, requires_authentication=False, ) except Exception as e: # pylint: disable=broad-except LOG.error("Could not log into Pulse site: %s", e) - return (status, response_text, url) - if not status: - LOG.error("Could not log into Pulse site.") - return (status, response_text, url) + return response if not handle_response( - status, - url, + response[0], + response[2], logging.ERROR, "Error encountered communicating with Pulse site on login", ): - return (status, response_text, url) + return response with self._attribute_lock: self._authenticated_flag.set() self._last_login_time = int(time.time()) - return (status, response_text, url) + return response async def async_do_logout_query(self, site_id: str | None) -> None: """Performs a logout query to the ADT Pulse site.""" params = {} if site_id is not None: - params.update({"network": site_id}) + self._site_id = site_id + params.update({"network": self._site_id}) + params.update({"partner": "adt"}) await self.async_query( ADT_LOGOUT_URI, From 989ac526050e6b82a79c22c77d94fa900b5612ba Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 20:00:47 -0500 Subject: [PATCH 075/226] pass detailed_debug_logging in example-client --- example-client.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/example-client.py b/example-client.py index 15acd7d..d82a5c1 100755 --- a/example-client.py +++ b/example-client.py @@ -371,6 +371,7 @@ def sync_example( poll_interval: float, keepalive_interval: int, relogin_interval: int, + detailed_debug_logging: bool, ) -> None: """Run example of sync pyadtpulse calls. @@ -383,6 +384,7 @@ def sync_example( debug_locks: bool: True to enable thread lock debugging keepalive_interval (int): keepalive interval in minutes relogin_interval (int): relogin interval in minutes + detailed_debug_logging (bool): True to enable detailed debug logging """ try: adt = PyADTPulse( @@ -392,6 +394,7 @@ def sync_example( debug_locks=debug_locks, keepalive_interval=keepalive_interval, relogin_interval=relogin_interval, + detailed_debug_logging=detailed_debug_logging, ) except AuthenticationException: print("Invalid credentials for ADT Pulse site") @@ -468,7 +471,8 @@ async def async_test_alarm(adt: PyADTPulse) -> None: print("Arming stay pending check succeeded") else: print( - f"FAIL: Arming home pending check failed {adt.site.alarm_control_panel} " + "FAIL: Arming home pending check failed " + f"{adt.site.alarm_control_panel} " ) if await adt.wait_for_update(): if adt.site.alarm_control_panel.is_home: @@ -591,6 +595,7 @@ async def async_example( poll_interval: float, keepalive_interval: int, relogin_interval: int, + detailed_debug_logging: bool, ) -> None: """Run example of pytadtpulse async usage. @@ -603,6 +608,7 @@ async def async_example( poll_interval (float): polling interval in seconds keepalive_interval (int): keepalive interval in minutes relogin_interval (int): relogin interval in minutes + detailed_debug_logging (bool): enable detailed debug logging """ adt = PyADTPulse( username, @@ -612,6 +618,7 @@ async def async_example( debug_locks=debug_locks, keepalive_interval=keepalive_interval, relogin_interval=relogin_interval, + detailed_debug_logging=detailed_debug_logging, ) if not await adt.async_login(): @@ -692,6 +699,7 @@ def main(): args.poll_interval, args.keepalive_interval, args.relogin_interval, + args.detailed_debug_logging, ) else: asyncio.run( @@ -704,6 +712,7 @@ def main(): args.poll_interval, args.keepalive_interval, args.relogin_interval, + args.detailed_debug_logging, ) ) From 4a32cc3ae8353af4bf181322e46ad12db8d56d21 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 20:05:42 -0500 Subject: [PATCH 076/226] copy response_path before closing response in async_fetch_version --- pyadtpulse/pulse_connection.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index d6c09b7..0c3944c 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -426,7 +426,7 @@ def make_url(self, uri: str) -> str: async def async_fetch_version(self) -> None: """Fetch ADT Pulse version.""" - response: ClientResponse | None = None + response_path: str | None = None with ADTPulseConnection._class_threadlock: if ADTPulseConnection._api_version != ADT_DEFAULT_VERSION: return @@ -436,14 +436,15 @@ async def async_fetch_version(self) -> None: async with self._session.get(signin_url) as response: # we only need the headers here, don't parse response response.raise_for_status() + response_path = response.url.path except (ClientResponseError, ClientConnectionError): LOG.warning( "Error occurred during API version fetch, defaulting to %s", ADT_DEFAULT_VERSION, ) return - if response is not None: - m = re.search("/myhome/(.+)/[a-z]*/", response.real_url.path) + if response_path is not None: + m = re.search("/myhome/(.+)/[a-z]*/", response_path) if m is not None: ADTPulseConnection._api_version = m.group(1) LOG.debug( From dfa7ceef853ab0477a270276aa6d8c1155e13657 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 20:13:58 -0500 Subject: [PATCH 077/226] add session.close() to finally in async_query --- pyadtpulse/pulse_connection.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 0c3944c..2d80842 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -354,6 +354,8 @@ async def async_query( url, exc_info=True, ) + finally: + await self._session.close() return (return_code, response_text, response_url) From 92a6842f57139bf6abf442bd9463b5117e2ae16f Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 20:41:35 -0500 Subject: [PATCH 078/226] urlencode http login parameters --- pyadtpulse/pulse_connection.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 2d80842..25c4795 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -7,6 +7,7 @@ import time from random import uniform from threading import Lock, RLock +from urllib.parse import quote from aiohttp import ( ClientConnectionError, @@ -484,13 +485,14 @@ async def async_do_login_query( ADT_LOGIN_URI, method="POST", extra_params={ + "e": "ns", "partner": "adt", - "network": self._site_id, }, data={ - "usernameForm": username, - "passwordForm": password, - "fingerprint": fingerprint, + "usernameForm": quote(username), + "passwordForm": quote(password), + "networkid": self._site_id, + "fingerprint": quote(fingerprint), }, timeout=timeout, requires_authentication=False, @@ -515,7 +517,7 @@ async def async_do_logout_query(self, site_id: str | None) -> None: params = {} if site_id is not None: self._site_id = site_id - params.update({"network": self._site_id}) + params.update({"networkid": self._site_id}) params.update({"partner": "adt"}) await self.async_query( From 2c339c9349800339e36322d1234a4f1ac3e09165 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 21:50:52 -0500 Subject: [PATCH 079/226] move check for invalid login types to pulse_connection --- pyadtpulse/__init__.py | 37 ++------------------------- pyadtpulse/pulse_connection.py | 46 +++++++++++++++++++++++++++++----- 2 files changed, 42 insertions(+), 41 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index d1a720d..eafc9ce 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -24,14 +24,13 @@ ADT_MAX_KEEPALIVE_INTERVAL, ADT_MAX_RELOGIN_BACKOFF, ADT_MIN_RELOGIN_INTERVAL, - ADT_SUMMARY_URI, ADT_SYNC_CHECK_URI, ADT_TIMEOUT_URI, DEFAULT_API_HOST, ) from .pulse_connection import ADTPulseConnection from .site import ADTPulseSite -from .util import AuthenticationException, DebugRLock, handle_response, make_soup +from .util import AuthenticationException, DebugRLock, handle_response LOG = logging.getLogger(__name__) @@ -697,43 +696,11 @@ async def async_login(self) -> bool: LOG.debug("Authenticating to ADT Pulse cloud service as %s", self._username) await self._pulse_connection.async_fetch_version() - response = await self._pulse_connection.async_do_login_query( + soup = await self._pulse_connection.async_do_login_query( self.username, self._password, self._fingerprint ) - if not handle_response( - response[0], response[2], logging.ERROR, "Error authenticating to ADT Pulse" - ): - return False - if self._pulse_connection.make_url(ADT_SUMMARY_URI) != str(response[2]): - # more specifically: - # redirect to signin.jsp = username/password error - # redirect to mfaSignin.jsp = fingerprint error - LOG.error("Authentication error encountered logging into ADT Pulse") - return False - - soup = make_soup( - response[0], - response[1], - response[2], - logging.ERROR, - "Could not log into ADT Pulse site", - ) if soup is None: return False - - # FIXME: should probably raise exceptions - error = soup.find("div", {"id": "warnMsgContents"}) - if error: - LOG.error("Invalid ADT Pulse username/password: %s", error) - return False - error = soup.find("div", "responsiveContainer") - if error: - LOG.error( - "2FA authentiation required for ADT pulse username %s: %s", - self.username, - error, - ) - return False # if tasks are started, we've already logged in before if self._sync_task is not None or self._timeout_task is not None: return True diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 25c4795..17750d2 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -28,6 +28,7 @@ ADT_LOGOUT_URI, ADT_ORB_URI, ADT_OTHER_HTTP_ACCEPT_HEADERS, + ADT_SUMMARY_URI, API_HOST_CA, API_PREFIX, DEFAULT_API_HOST, @@ -464,7 +465,7 @@ async def async_fetch_version(self) -> None: async def async_do_login_query( self, username: str, password: str, fingerprint: str, timeout: int = 30 - ) -> tuple[int, str | None, URL | None]: + ) -> BeautifulSoup | None: """ Performs a login query to the Pulse site. @@ -473,8 +474,8 @@ async def async_do_login_query( Defaults to 30. Returns: - type of status code (int), response_text Optional[str], and - response url (optional) + soup: Optional[BeautifulSoup]: A BeautifulSoup object containing summary.jsp, + or None if failure Raises: ValueError: if login parameters are not correct """ @@ -499,18 +500,51 @@ async def async_do_login_query( ) except Exception as e: # pylint: disable=broad-except LOG.error("Could not log into Pulse site: %s", e) - return response + return None if not handle_response( response[0], response[2], logging.ERROR, "Error encountered communicating with Pulse site on login", ): - return response + return None + + soup = make_soup( + response[0], + response[1], + response[2], + logging.ERROR, + "Could not log into ADT Pulse site", + ) + # FIXME: should probably raise exceptions here + if soup is None: + return None + error = soup.find("div", {"id": "warnMsgContents"}) + if error: + LOG.error("Error logging into pulse: %s", error.get_text()) + return None + if self.make_url(ADT_SUMMARY_URI) != str(response[2]): + # more specifically: + # redirect to signin.jsp = username/password error + # redirect to mfaSignin.jsp = fingerprint error + # locked out = error == "Sign In unsuccessful. Your account has been locked + # after multiple sign in attempts.Try again in 30 minutes." + LOG.error("Authentication error encountered logging into ADT Pulse") + return None + + error = soup.find("div", "responsiveContainer") + if error: + LOG.error( + "2FA authentiation required for ADT pulse username %s: %s", + username, + error, + ) + return None + with self._attribute_lock: self._authenticated_flag.set() self._last_login_time = int(time.time()) - return response + return soup async def async_do_logout_query(self, site_id: str | None) -> None: """Performs a logout query to the ADT Pulse site.""" From 10ba7b161e1021d0bcee7ed07e33bc7a32c4b9b1 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 22:16:49 -0500 Subject: [PATCH 080/226] rework async_login again --- pyadtpulse/pulse_connection.py | 100 +++++++++++++++++++-------------- 1 file changed, 59 insertions(+), 41 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 17750d2..68b757b 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -474,12 +474,67 @@ async def async_do_login_query( Defaults to 30. Returns: - soup: Optional[BeautifulSoup]: A BeautifulSoup object containing summary.jsp, - or None if failure + soup: Optional[BeautifulSoup]: A BeautifulSoup object containing + summary.jsp, or None if failure Raises: ValueError: if login parameters are not correct """ - response: tuple[int, str | None, URL | None] = (200, None, None) + + def extract_seconds_from_string(s: str) -> int: + seconds = 0 + match = re.search(r"Try again in (\d+)", s) + if match: + seconds = int(match.group(1)) + if "minutes" in s: + seconds *= 60 + return seconds + + def check_response() -> BeautifulSoup | None: + """Check response for errors.""" + if not handle_response( + response[0], + response[2], + logging.ERROR, + "Error encountered communicating with Pulse site on login", + ): + return None + + soup = make_soup( + response[0], + response[1], + response[2], + logging.ERROR, + "Could not log into ADT Pulse site", + ) + # FIXME: should probably raise exceptions here + if soup is None: + return None + error = soup.find("div", {"id": "warnMsgContents"}) + if error: + error_text = error.get_text() + LOG.error("Error logging into pulse: %s", error_text) + if retry_after := extract_seconds_from_string(error_text) > 0: + self.retry_after = int(time.time()) + retry_after + return None + if self.make_url(ADT_SUMMARY_URI) != str(response[2]): + # more specifically: + # redirect to signin.jsp = username/password error + # redirect to mfaSignin.jsp = fingerprint error + # locked out = error == "Sign In unsuccessful. Your account has been + # locked after multiple sign in attempts.Try again in 30 minutes." + LOG.error("Authentication error encountered logging into ADT Pulse") + return None + + error = soup.find("div", "responsiveContainer") + if error: + LOG.error( + "2FA authentiation required for ADT pulse username %s: %s", + username, + error, + ) + return None + return soup + self.check_login_parameters(username, password, fingerprint) try: response = await self.async_query( @@ -501,46 +556,9 @@ async def async_do_login_query( except Exception as e: # pylint: disable=broad-except LOG.error("Could not log into Pulse site: %s", e) return None - if not handle_response( - response[0], - response[2], - logging.ERROR, - "Error encountered communicating with Pulse site on login", - ): - return None - - soup = make_soup( - response[0], - response[1], - response[2], - logging.ERROR, - "Could not log into ADT Pulse site", - ) - # FIXME: should probably raise exceptions here + soup = check_response() if soup is None: return None - error = soup.find("div", {"id": "warnMsgContents"}) - if error: - LOG.error("Error logging into pulse: %s", error.get_text()) - return None - if self.make_url(ADT_SUMMARY_URI) != str(response[2]): - # more specifically: - # redirect to signin.jsp = username/password error - # redirect to mfaSignin.jsp = fingerprint error - # locked out = error == "Sign In unsuccessful. Your account has been locked - # after multiple sign in attempts.Try again in 30 minutes." - LOG.error("Authentication error encountered logging into ADT Pulse") - return None - - error = soup.find("div", "responsiveContainer") - if error: - LOG.error( - "2FA authentiation required for ADT pulse username %s: %s", - username, - error, - ) - return None - with self._attribute_lock: self._authenticated_flag.set() self._last_login_time = int(time.time()) From 47739bb4376929e5cd0adf1d9ad6e6b282c04154 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 22:19:01 -0500 Subject: [PATCH 081/226] add refurb to development dependencies --- poetry.lock | 16 +++++++++++++++- pyproject.toml | 1 + 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/poetry.lock b/poetry.lock index 6066992..6cffafa 100644 --- a/poetry.lock +++ b/poetry.lock @@ -993,6 +993,20 @@ files = [ {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"}, ] +[[package]] +name = "refurb" +version = "1.22.1" +description = "A tool for refurbish and modernize Python codebases" +optional = false +python-versions = ">=3.10" +files = [ + {file = "refurb-1.22.1-py3-none-any.whl", hash = "sha256:7409fdcb01d73274ef249e729687656fc9cab7b454a5c72d19b8cefefc5aab74"}, + {file = "refurb-1.22.1.tar.gz", hash = "sha256:3ff6b6f503b0fab9d082a23a0d81ae7bbce59f7b906d5046e863d8ddc46ad529"}, +] + +[package.dependencies] +mypy = ">=0.981" + [[package]] name = "ruff" version = "0.1.4" @@ -1294,4 +1308,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "969b37ecbb98a0996441dbe205554929bda2df0d708f1132e0e404c85060ed43" +content-hash = "9d6ce3ab27a1fb0acb49caf512cd53ab0a701e8484a87a29a68a780a0756d1da" diff --git a/pyproject.toml b/pyproject.toml index b64230f..515c416 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -40,6 +40,7 @@ black = "^23.10.1" mypy = "^1.6.1" pylint = "^3.0.2" types-beautifulsoup4 = "^4.12.0.7" +refurb = "^1.22.1" [build-system] requires = ["poetry-core"] From f45de2e709847d7be4404bf57a54b095f5aec83e Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 22:21:57 -0500 Subject: [PATCH 082/226] put back async_do_login_query inner functions --- pyadtpulse/pulse_connection.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 68b757b..4335cd6 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -476,6 +476,8 @@ async def async_do_login_query( Returns: soup: Optional[BeautifulSoup]: A BeautifulSoup object containing summary.jsp, or None if failure + soup: Optional[BeautifulSoup]: A BeautifulSoup object containing + summary.jsp, or None if failure Raises: ValueError: if login parameters are not correct """ From 6cf93ea4b8c24f004a09e68b14ce6c5e6b9f0ab7 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 22:30:47 -0500 Subject: [PATCH 083/226] add network id to login parameters if not none --- pyadtpulse/pulse_connection.py | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 4335cd6..a1026ec 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -7,7 +7,6 @@ import time from random import uniform from threading import Lock, RLock -from urllib.parse import quote from aiohttp import ( ClientConnectionError, @@ -537,21 +536,23 @@ def check_response() -> BeautifulSoup | None: return None return soup + data = { + "usernameForm": username, + "passwordForm": password, + "fingerprint": fingerprint, + } + extra_params = {"e": "ns", "partner": "adt"} + if self._site_id != "": + data["networkid"] = self._site_id + extra_params["networkid"] = self._site_id + self.check_login_parameters(username, password, fingerprint) try: response = await self.async_query( ADT_LOGIN_URI, method="POST", - extra_params={ - "e": "ns", - "partner": "adt", - }, - data={ - "usernameForm": quote(username), - "passwordForm": quote(password), - "networkid": self._site_id, - "fingerprint": quote(fingerprint), - }, + extra_params=extra_params, + data=data, timeout=timeout, requires_authentication=False, ) From d80db03afdb1982f0d30ff01f511e665115c1cca Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 22:51:40 -0500 Subject: [PATCH 084/226] remove close session in async_query --- pyadtpulse/pulse_connection.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index a1026ec..a83e968 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -118,7 +118,11 @@ def __init__( def __del__(self): """Destructor for ADTPulseConnection.""" - if self._allocated_session and self._session is not None: + if ( + self._allocated_session + and self._session is not None + and not self._session.closed + ): self._session.detach() @property @@ -355,8 +359,6 @@ async def async_query( url, exc_info=True, ) - finally: - await self._session.close() return (return_code, response_text, response_url) From a7c35dc754450ac3d1477e7e5f8f69b111c3dff1 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 7 Nov 2023 23:07:39 -0500 Subject: [PATCH 085/226] more async_do_login_query rework --- pyadtpulse/pulse_connection.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index a83e968..e265293 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -317,7 +317,7 @@ async def async_query( url, headers=extra_headers, params=extra_params, - data=data if method == "POST" else None, + data=data, timeout=timeout, ) as response: retry += 1 @@ -543,10 +543,13 @@ def check_response() -> BeautifulSoup | None: "passwordForm": password, "fingerprint": fingerprint, } - extra_params = {"e": "ns", "partner": "adt"} + extra_params = {"partner": "adt"} if self._site_id != "": data["networkid"] = self._site_id extra_params["networkid"] = self._site_id + else: + extra_params["sun"] = "yes" + extra_params["e"] = "ns" self.check_login_parameters(username, password, fingerprint) try: From ace8b8e9fbd1d80fc893b9aab8a7ab14767a3cdb Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Wed, 8 Nov 2023 00:20:14 -0500 Subject: [PATCH 086/226] more async_query related rework --- pyadtpulse/pulse_connection.py | 40 ++++++++++++++-------------------- 1 file changed, 16 insertions(+), 24 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index e265293..e1a6c73 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -34,7 +34,8 @@ ) from .util import DebugRLock, handle_response, make_soup -RECOVERABLE_ERRORS = [500, 502, 504] +RECOVERABLE_ERRORS = {500, 502, 504} +RETRY_LATER_ERRORS = {429: "Too Many Requests", 503: "Service Unavailable"} LOG = logging.getLogger(__name__) MAX_RETRIES = 3 @@ -204,32 +205,25 @@ def check_sync(self, message: str) -> asyncio.AbstractEventLoop: raise RuntimeError(message) return self._loop - def _set_retry_after(self, response: ClientResponse) -> None: + def _set_retry_after(self, code: int, retry_after: str) -> None: """ Check the "Retry-After" header in the response and set retry_after property based upon it. Parameters: - response (ClientResponse): The response object. + code (int): The HTTP response code + retry_after (str): The value of the "Retry-After" header Returns: None. """ - header_value = response.headers.get("Retry-After") - if header_value is None: - return - reason = "Unknown" - if response.status == 429: - reason = "Too many requests" - elif response.status == 503: - reason = "Service unavailable" - if header_value.isnumeric(): - retval = int(header_value) + if retry_after.isnumeric(): + retval = int(retry_after) else: try: retval = int( datetime.datetime.strptime( - header_value, "%a, %d %b %G %T %Z" + retry_after, "%a, %d %b %G %T %Z" ).timestamp() ) except ValueError: @@ -238,7 +232,7 @@ def _set_retry_after(self, response: ClientResponse) -> None: "Task %s received Retry-After %s due to %s", asyncio.current_task(), retval, - reason, + RETRY_LATER_ERRORS.get(code, "Unknown error"), ) self.retry_after = int(time.time()) + retval @@ -309,6 +303,7 @@ async def async_query( timeout, ) retry = 0 + retry_after: str | None = None response: ClientResponse | None = None while retry < MAX_RETRIES: try: @@ -324,6 +319,7 @@ async def async_query( response_text = await response.text() return_code = response.status response_url = response.url + retry_after = response.headers.get("Retry-After") if response.status in RECOVERABLE_ERRORS: LOG.info( @@ -348,9 +344,8 @@ async def async_query( ClientConnectorError, ClientResponseError, ) as ex: - if response and response.status in (429, 503): - self._set_retry_after(response) - response = None + if retry_after is not None: + self._set_retry_after(return_code, retry_after) break LOG.debug( "Error %s occurred making %s request to %s, retrying", @@ -541,16 +536,13 @@ def check_response() -> BeautifulSoup | None: data = { "usernameForm": username, "passwordForm": password, + "networkid": self._site_id, "fingerprint": fingerprint, } - extra_params = {"partner": "adt"} if self._site_id != "": - data["networkid"] = self._site_id - extra_params["networkid"] = self._site_id + extra_params = {"partner": "adt", "networkid": self._site_id} else: - extra_params["sun"] = "yes" - extra_params["e"] = "ns" - + extra_params = None self.check_login_parameters(username, password, fingerprint) try: response = await self.async_query( From 3e6a570353d75a4c2e354bf5c0b29aec99d7a6e3 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Wed, 8 Nov 2023 01:49:04 -0500 Subject: [PATCH 087/226] add sec-fetch headers --- pyadtpulse/__init__.py | 4 +++- pyadtpulse/const.py | 6 ++++++ pyadtpulse/pulse_connection.py | 7 ++++++- 3 files changed, 15 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index eafc9ce..14bf500 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -485,7 +485,9 @@ async def _sync_check_task(self) -> None: async def perform_sync_check_query(): return await self._pulse_connection.async_query( - ADT_SYNC_CHECK_URI, extra_params={"ts": str(int(time.time() * 1000))} + ADT_SYNC_CHECK_URI, + extra_headers={"Sec-Fetch-Mode": "iframe"}, + extra_params={"ts": str(int(time.time() * 1000))}, ) task_name = self._get_sync_task_name() diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 14c780f..475f53b 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -40,6 +40,12 @@ "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9," "image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7" } +ADT_DEFAULT_SEC_FETCH_HEADERS = { + "Sec-Fetch-User": "?1", + "Sec-Ch-Ua-Mobile": "?0", + "Sec-Fetch-Site": "same-origin", + "Sec-Fetch-Mode": "navigate", +} ADT_OTHER_HTTP_ACCEPT_HEADERS = { "Accept": "*/*", } diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index e1a6c73..56be0db 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -21,6 +21,7 @@ from .const import ( ADT_DEFAULT_HTTP_ACCEPT_HEADERS, ADT_DEFAULT_HTTP_USER_AGENT, + ADT_DEFAULT_SEC_FETCH_HEADERS, ADT_DEFAULT_VERSION, ADT_HTTP_BACKGROUND_URIS, ADT_LOGIN_URI, @@ -106,6 +107,7 @@ def __init__( self._session = session self._session.headers.update({"User-Agent": user_agent}) self._session.headers.update(ADT_DEFAULT_HTTP_ACCEPT_HEADERS) + self._session.headers.update(ADT_DEFAULT_SEC_FETCH_HEADERS) self._attribute_lock: RLock | DebugRLock self._last_login_time: int = 0 if not debug_locks: @@ -408,7 +410,10 @@ async def query_orb(self, level: int, error_message: str) -> BeautifulSoup | Non Returns: Optional[BeautifulSoup]: A Beautiful Soup object, or None if failure """ - code, response, url = await self.async_query(ADT_ORB_URI) + code, response, url = await self.async_query( + ADT_ORB_URI, + extra_headers={"Sec-Fetch-Mode": "cors", "Sec-Fetch-Dest": "empty"}, + ) return make_soup(code, response, url, level, error_message) From d7a2c095faefaa9252b975dda12f1d2b706ef90d Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Wed, 8 Nov 2023 02:40:09 -0500 Subject: [PATCH 088/226] more http headers --- pyadtpulse/__init__.py | 1 + pyadtpulse/const.py | 1 + pyadtpulse/pulse_connection.py | 7 ++++--- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 14bf500..3cc933c 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -8,6 +8,7 @@ from random import randint from threading import RLock, Thread from typing import Union +from urllib.parse import quote from warnings import warn import uvloop diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 475f53b..3aa6677 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -45,6 +45,7 @@ "Sec-Ch-Ua-Mobile": "?0", "Sec-Fetch-Site": "same-origin", "Sec-Fetch-Mode": "navigate", + "Upgrade-Insecure-Requests": "1", } ADT_OTHER_HTTP_ACCEPT_HEADERS = { "Accept": "*/*", diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 56be0db..bb0a6cb 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -7,6 +7,7 @@ import time from random import uniform from threading import Lock, RLock +from urllib.parse import quote from aiohttp import ( ClientConnectionError, @@ -539,10 +540,10 @@ def check_response() -> BeautifulSoup | None: return soup data = { - "usernameForm": username, - "passwordForm": password, + "usernameForm": quote(username), + "passwordForm": quote(password), "networkid": self._site_id, - "fingerprint": fingerprint, + "fingerprint": quote(fingerprint), } if self._site_id != "": extra_params = {"partner": "adt", "networkid": self._site_id} From 26cb2d8dbb47cd2a1a69cd3e2961531577bc674d Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Wed, 8 Nov 2023 14:17:09 -0500 Subject: [PATCH 089/226] even more http header rework --- pyadtpulse/pulse_connection.py | 36 +++++++++++++++++++++------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index bb0a6cb..08009a3 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -545,23 +545,31 @@ def check_response() -> BeautifulSoup | None: "networkid": self._site_id, "fingerprint": quote(fingerprint), } + method = "GET" + extra_params = {"partner": "adt"} if self._site_id != "": - extra_params = {"partner": "adt", "networkid": self._site_id} + extra_params.update({"networkid": self._site_id}) + method = "POST" else: - extra_params = None + extra_params.update({"e": "ns"}) self.check_login_parameters(username, password, fingerprint) - try: - response = await self.async_query( - ADT_LOGIN_URI, - method="POST", - extra_params=extra_params, - data=data, - timeout=timeout, - requires_authentication=False, - ) - except Exception as e: # pylint: disable=broad-except - LOG.error("Could not log into Pulse site: %s", e) - return None + # need to perform a get before a post if there's no network id + while True: + try: + response = await self.async_query( + ADT_LOGIN_URI, + method=method, + extra_params=extra_params, + data=data if method == "POST" else None, + timeout=timeout, + requires_authentication=False, + ) + if method == "POST": + break + method = "POST" + except Exception as e: # pylint: disable=broad-except + LOG.error("Could not log into Pulse site: %s", e) + return None soup = check_response() if soup is None: return None From ad5091e804f75e63bfde7c16d1d778826bfa0fcd Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Wed, 8 Nov 2023 15:15:48 -0500 Subject: [PATCH 090/226] more header updates --- pyadtpulse/pulse_connection.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 08009a3..74ce955 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -546,6 +546,13 @@ def check_response() -> BeautifulSoup | None: "fingerprint": quote(fingerprint), } method = "GET" + self._session.cookie_jar.update_cookies( + { + "X-mobile-browser": "false", + "ICLocal": "en_US", + }, + URL(self.service_host + "/"), + ) extra_params = {"partner": "adt"} if self._site_id != "": extra_params.update({"networkid": self._site_id}) From 6651a1d9eeccf7f4af7bb600600cfb6739c4df04 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Thu, 9 Nov 2023 08:27:55 -0500 Subject: [PATCH 091/226] add connection failure reason --- pyadtpulse/__init__.py | 6 +++- pyadtpulse/const.py | 22 +++++++++++++ pyadtpulse/pulse_connection.py | 58 +++++++++++++++++++++++++++++----- 3 files changed, 77 insertions(+), 9 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 3cc933c..0d0c7bb 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -8,7 +8,6 @@ from random import randint from threading import RLock, Thread from typing import Union -from urllib.parse import quote from warnings import warn import uvloop @@ -28,6 +27,7 @@ ADT_SYNC_CHECK_URI, ADT_TIMEOUT_URI, DEFAULT_API_HOST, + ConnectionFailureReason, ) from .pulse_connection import ADTPulseConnection from .site import ADTPulseSite @@ -285,6 +285,10 @@ def detailed_debug_logging(self, value: bool) -> None: self._detailed_debug_logging = value self._pulse_connection.detailed_debug_logging = value + @property + def connection_failure_reason(self) -> ConnectionFailureReason: + return self._pulse_connection.connection_failure_reason + async def _update_sites(self, soup: BeautifulSoup) -> None: with self._attribute_lock: if self._site is None: diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 3aa6677..1c9e65e 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -1,5 +1,9 @@ """Constants for pyadtpulse.""" __version__ = "1.1.4b0" + +from enum import Enum +from http import HTTPStatus + DEFAULT_API_HOST = "https://portal.adtpulse.com" API_HOST_CA = "https://portal-ca.adtpulse.com" # Canada @@ -72,3 +76,21 @@ ADT_SENSOR_SMOKE = "smoke" ADT_SENSOR_CO = "co" ADT_SENSOR_ALARM = "alarm" + + +class ConnectionFailureReason(Enum): + """Reason for connection failure.""" + + NO_FAILURE = 0, "No Failure" + UNKNOWN = 1, "Unknown Failure" + ACCOUNT_LOCKED = 2, "Account Locked" + INVALID_CREDENTIALS = 3, "Invalid Credentials" + MFA_REQUIRED = 4, "MFA Required" + SERVICE_UNAVAILABLE = ( + HTTPStatus.SERVICE_UNAVAILABLE.value, + HTTPStatus.SERVICE_UNAVAILABLE.description, + ) + TOO_MANY_REQUESTS = ( + HTTPStatus.TOO_MANY_REQUESTS.value, + HTTPStatus.TOO_MANY_REQUESTS.description, + ) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 74ce955..767f9c8 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -5,6 +5,7 @@ import datetime import re import time +from http import HTTPStatus from random import uniform from threading import Lock, RLock from urllib.parse import quote @@ -33,11 +34,16 @@ API_HOST_CA, API_PREFIX, DEFAULT_API_HOST, + ConnectionFailureReason, ) from .util import DebugRLock, handle_response, make_soup -RECOVERABLE_ERRORS = {500, 502, 504} -RETRY_LATER_ERRORS = {429: "Too Many Requests", 503: "Service Unavailable"} +RECOVERABLE_ERRORS = { + HTTPStatus.INTERNAL_SERVER_ERROR, + HTTPStatus.BAD_GATEWAY, + HTTPStatus.GATEWAY_TIMEOUT, +} +RETRY_LATER_ERRORS = {HTTPStatus.SERVICE_UNAVAILABLE, HTTPStatus.TOO_MANY_REQUESTS} LOG = logging.getLogger(__name__) MAX_RETRIES = 3 @@ -60,6 +66,7 @@ class ADTPulseConnection: "_authenticated_flag", "_detailed_debug_logging", "_site_id", + "_connection_failure_reason", ) @staticmethod @@ -88,6 +95,12 @@ def check_login_parameters(username: str, password: str, fingerprint: str) -> No if fingerprint is None or fingerprint == "": raise ValueError("Fingerprint is required") + @staticmethod + def get_http_status_description(status_code: int) -> str: + """Get HTTP status description.""" + status = HTTPStatus(status_code) + return status.description + def __init__( self, host: str, @@ -119,6 +132,7 @@ def __init__( self._retry_after = int(time.time()) self._detailed_debug_logging = detailed_debug_logging self._site_id = "" + self._connection_failure_reason = ConnectionFailureReason.NO_FAILURE def __del__(self): """Destructor for ADTPulseConnection.""" @@ -198,6 +212,17 @@ def detailed_debug_logging(self, value: bool) -> None: with self._attribute_lock: self._detailed_debug_logging = value + @property + def connection_failure_reason(self) -> ConnectionFailureReason: + """Get the connection failure reason.""" + with self._attribute_lock: + return self._connection_failure_reason + + def _set_connection_failure_reason(self, reason: ConnectionFailureReason) -> None: + """Set the connection failure reason.""" + with self._attribute_lock: + self._connection_failure_reason = reason + def check_sync(self, message: str) -> asyncio.AbstractEventLoop: """Checks if sync login was performed. @@ -235,9 +260,14 @@ def _set_retry_after(self, code: int, retry_after: str) -> None: "Task %s received Retry-After %s due to %s", asyncio.current_task(), retval, - RETRY_LATER_ERRORS.get(code, "Unknown error"), + self.get_http_status_description(code), ) self.retry_after = int(time.time()) + retval + try: + fail_reason = ConnectionFailureReason(code) + except ValueError: + fail_reason = ConnectionFailureReason.UNKNOWN + self._set_connection_failure_reason(fail_reason) async def async_query( self, @@ -272,7 +302,7 @@ async def async_query( response """ response_text: str | None = None - return_code: int = 200 + return_code: int = HTTPStatus.OK response_url: URL | None = None current_time = time.time() if self.retry_after > current_time: @@ -324,11 +354,12 @@ async def async_query( response_url = response.url retry_after = response.headers.get("Retry-After") - if response.status in RECOVERABLE_ERRORS: + if return_code in RECOVERABLE_ERRORS: LOG.info( - "query returned recoverable error code %s, " + "query returned recoverable error code %s: %s," "retrying (count = %d)", - response.status, + return_code, + self.get_http_status_description(return_code), retry, ) if retry == MAX_RETRIES: @@ -348,7 +379,10 @@ async def async_query( ClientResponseError, ) as ex: if retry_after is not None: - self._set_retry_after(return_code, retry_after) + self._set_retry_after( + return_code, + retry_after, + ) break LOG.debug( "Error %s occurred making %s request to %s, retrying", @@ -501,6 +535,7 @@ def check_response() -> BeautifulSoup | None: logging.ERROR, "Error encountered communicating with Pulse site on login", ): + self._set_connection_failure_reason(ConnectionFailureReason.UNKNOWN) return None soup = make_soup( @@ -527,6 +562,9 @@ def check_response() -> BeautifulSoup | None: # locked out = error == "Sign In unsuccessful. Your account has been # locked after multiple sign in attempts.Try again in 30 minutes." LOG.error("Authentication error encountered logging into ADT Pulse") + self._set_connection_failure_reason( + ConnectionFailureReason.INVALID_CREDENTIALS + ) return None error = soup.find("div", "responsiveContainer") @@ -536,6 +574,9 @@ def check_response() -> BeautifulSoup | None: username, error, ) + self._set_connection_failure_reason( + ConnectionFailureReason.MFA_REQUIRED + ) return None return soup @@ -576,6 +617,7 @@ def check_response() -> BeautifulSoup | None: method = "POST" except Exception as e: # pylint: disable=broad-except LOG.error("Could not log into Pulse site: %s", e) + self._set_connection_failure_reason(ConnectionFailureReason.UNKNOWN) return None soup = check_response() if soup is None: From 7b444f0dd17a83009015dcafb695713cfd2c795e Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Thu, 9 Nov 2023 16:21:11 -0500 Subject: [PATCH 092/226] more http rework --- pyadtpulse/pulse_connection.py | 161 +++++++++++++++++---------------- 1 file changed, 83 insertions(+), 78 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 767f9c8..acae183 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -7,8 +7,7 @@ import time from http import HTTPStatus from random import uniform -from threading import Lock, RLock -from urllib.parse import quote +from threading import RLock from aiohttp import ( ClientConnectionError, @@ -47,13 +46,14 @@ LOG = logging.getLogger(__name__) MAX_RETRIES = 3 +SESSION_COOKIES = {"X-mobile-browser": "false", "ICLocal": "en_US"} class ADTPulseConnection: """ADT Pulse connection related attributes.""" _api_version = ADT_DEFAULT_VERSION - _class_threadlock = Lock() + _class_threadlock = RLock() __slots__ = ( "_api_host", @@ -110,8 +110,11 @@ def __init__( detailed_debug_logging: bool = False, ): """Initialize ADT Pulse connection.""" - self.check_service_host(host) - self._api_host = host + self._attribute_lock: RLock | DebugRLock + if not debug_locks: + self._attribute_lock = RLock() + else: + self._attribute_lock = DebugRLock("ADTPulseConnection._attribute_lock") self._allocated_session = False self._authenticated_flag = asyncio.Event() if session is None: @@ -119,15 +122,13 @@ def __init__( self._session = ClientSession() else: self._session = session + # need to initialize this after the session since we set cookies + # based on it + self.service_host = host self._session.headers.update({"User-Agent": user_agent}) self._session.headers.update(ADT_DEFAULT_HTTP_ACCEPT_HEADERS) self._session.headers.update(ADT_DEFAULT_SEC_FETCH_HEADERS) - self._attribute_lock: RLock | DebugRLock self._last_login_time: int = 0 - if not debug_locks: - self._attribute_lock = RLock() - else: - self._attribute_lock = DebugRLock("ADTPulseConnection._attribute_lock") self._loop: asyncio.AbstractEventLoop | None = None self._retry_after = int(time.time()) self._detailed_debug_logging = detailed_debug_logging @@ -158,6 +159,7 @@ def service_host(self) -> str: @service_host.setter def service_host(self, host: str) -> None: """Set the host prefix for connections.""" + self.check_service_host(host) with self._attribute_lock: self._session.headers.update({"Host": host}) self._api_host = host @@ -275,7 +277,6 @@ async def async_query( method: str = "GET", extra_params: dict[str, str] | None = None, extra_headers: dict[str, str] | None = None, - data: dict[str, str] | None = None, timeout: int = 1, requires_authentication: bool = True, ) -> tuple[int, str | None, URL | None]: @@ -285,11 +286,10 @@ async def async_query( Args: uri (str): URI to query method (str, optional): method to use. Defaults to "GET". - extra_params (Optional[Dict], optional): query parameters. + extra_params (Optional[Dict], optional): query/body parameters. Defaults to None. extra_headers (Optional[Dict], optional): extra HTTP headers. Defaults to None. - data (Optional[Dict], optional): data to send. Defaults to None. timeout (int, optional): timeout in seconds. Defaults to 1. requires_authentication (bool, optional): True if authentication is required to perform query. @@ -301,9 +301,23 @@ async def async_query( tuple with integer return code, optional response text, and optional URL of response """ - response_text: str | None = None - return_code: int = HTTPStatus.OK - response_url: URL | None = None + + async def handle_query_response( + response: ClientResponse | None, + ) -> tuple[int, str | None, URL | None, str | None]: + if response is None: + return 0, None, None, None + response_text = await response.text() + + return ( + response.status, + response_text, + response.url, + response.headers.get("Retry-After"), + ) + + if method not in ("GET", "POST"): + raise ValueError("method must be GET or POST") current_time = time.time() if self.retry_after > current_time: LOG.debug( @@ -328,38 +342,38 @@ async def async_query( headers.setdefault("Accept", ADT_OTHER_HTTP_ACCEPT_HEADERS["Accept"]) if self.detailed_debug_logging: LOG.debug( - "Attempting %s %s params=%s data=%s timeout=%d", + "Attempting %s %s params=%s timeout=%d", method, url, extra_params, - data, timeout, ) retry = 0 - retry_after: str | None = None - response: ClientResponse | None = None + return_value: tuple[int, str | None, URL | None, str | None] = ( + HTTPStatus.OK.value, + None, + None, + None, + ) while retry < MAX_RETRIES: try: async with self._session.request( method, url, headers=extra_headers, - params=extra_params, - data=data, + params=extra_params if method == "GET" else None, + data=extra_params if method == "POST" else None, timeout=timeout, ) as response: + return_value = await handle_query_response(response) retry += 1 - response_text = await response.text() - return_code = response.status - response_url = response.url - retry_after = response.headers.get("Retry-After") - if return_code in RECOVERABLE_ERRORS: + if return_value[0] in RECOVERABLE_ERRORS: LOG.info( "query returned recoverable error code %s: %s," "retrying (count = %d)", - return_code, - self.get_http_status_description(return_code), + return_value[0], + self.get_http_status_description(return_value[0]), retry, ) if retry == MAX_RETRIES: @@ -378,21 +392,21 @@ async def async_query( ClientConnectorError, ClientResponseError, ) as ex: - if retry_after is not None: + if return_value[0] is not None and return_value[3] is not None: self._set_retry_after( - return_code, - retry_after, + return_value[0], + return_value[3], ) break LOG.debug( - "Error %s occurred making %s request to %s, retrying", + "Error %s occurred making %s request to %s", ex.args, method, url, exc_info=True, ) - - return (return_code, response_text, response_url) + break + return (return_value[0], return_value[1], return_value[2]) def query( self, @@ -400,7 +414,6 @@ def query( method: str = "GET", extra_params: dict[str, str] | None = None, extra_headers: dict[str, str] | None = None, - data: dict[str, str] | None = None, timeout=1, requires_authentication: bool = True, ) -> tuple[int, str | None, URL | None]: @@ -409,10 +422,9 @@ def query( Args: uri (str): URI to query method (str, optional): method to use. Defaults to "GET". - extra_params (Optional[Dict], optional): query parameters. Defaults to None. + extra_params (Optional[Dict], optional): query/body parameters. Defaults to None. extra_headers (Optional[Dict], optional): extra HTTP headers. Defaults to None. - data (Optional[Dict], optional): data to send. Defaults to None. timeout (int, optional): timeout in seconds. Defaults to 1. requires_authentication (bool, optional): True if authentication is required to perform query. Defaults to True. @@ -427,7 +439,6 @@ def query( method, extra_params, extra_headers, - data=data, timeout=timeout, requires_authentication=requires_authentication, ) @@ -467,19 +478,24 @@ def make_url(self, uri: str) -> str: async def async_fetch_version(self) -> None: """Fetch ADT Pulse version.""" response_path: str | None = None + response_code = HTTPStatus.OK.value with ADTPulseConnection._class_threadlock: if ADTPulseConnection._api_version != ADT_DEFAULT_VERSION: return - signin_url = f"{self.service_host}/myhome{ADT_LOGIN_URI}" + signin_url = f"{self.service_host}" try: - async with self._session.get(signin_url) as response: + async with self._session.get( + signin_url, + ) as response: + response_code = response.status # we only need the headers here, don't parse response response.raise_for_status() response_path = response.url.path except (ClientResponseError, ClientConnectionError): LOG.warning( - "Error occurred during API version fetch, defaulting to %s", + "Error %i: occurred during API version fetch, defaulting to %s", + response_code, ADT_DEFAULT_VERSION, ) return @@ -527,7 +543,9 @@ def extract_seconds_from_string(s: str) -> int: seconds *= 60 return seconds - def check_response() -> BeautifulSoup | None: + def check_response( + response: tuple[int, str | None, URL | None] + ) -> BeautifulSoup | None: """Check response for errors.""" if not handle_response( response[0], @@ -581,45 +599,32 @@ def check_response() -> BeautifulSoup | None: return soup data = { - "usernameForm": quote(username), - "passwordForm": quote(password), + "usernameForm": username, + "passwordForm": password, "networkid": self._site_id, - "fingerprint": quote(fingerprint), + "fingerprint": fingerprint, } - method = "GET" - self._session.cookie_jar.update_cookies( - { - "X-mobile-browser": "false", - "ICLocal": "en_US", - }, - URL(self.service_host + "/"), - ) - extra_params = {"partner": "adt"} - if self._site_id != "": - extra_params.update({"networkid": self._site_id}) - method = "POST" - else: - extra_params.update({"e": "ns"}) self.check_login_parameters(username, password, fingerprint) - # need to perform a get before a post if there's no network id - while True: - try: - response = await self.async_query( - ADT_LOGIN_URI, - method=method, - extra_params=extra_params, - data=data if method == "POST" else None, - timeout=timeout, - requires_authentication=False, - ) - if method == "POST": - break - method = "POST" - except Exception as e: # pylint: disable=broad-except - LOG.error("Could not log into Pulse site: %s", e) - self._set_connection_failure_reason(ConnectionFailureReason.UNKNOWN) + try: + response = await self.async_query( + ADT_LOGIN_URI, + "POST", + extra_params=data, + timeout=timeout, + requires_authentication=False, + ) + if not handle_response( + response[0], + response[2], + logging.ERROR, + "Error encountered during ADT login GET", + ): return None - soup = check_response() + except Exception as e: # pylint: disable=broad-except + LOG.error("Could not log into Pulse site: %s", e) + self._set_connection_failure_reason(ConnectionFailureReason.UNKNOWN) + return None + soup = check_response(response) if soup is None: return None with self._attribute_lock: From 0e4cf6f4ff1d168a7ec4ab8c1c4a2a19ae40f19c Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Thu, 9 Nov 2023 16:23:57 -0500 Subject: [PATCH 093/226] bump to 1.1.4b1 --- pyadtpulse/const.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 1c9e65e..86e44c9 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -1,5 +1,5 @@ """Constants for pyadtpulse.""" -__version__ = "1.1.4b0" +__version__ = "1.1.4b1" from enum import Enum from http import HTTPStatus diff --git a/pyproject.toml b/pyproject.toml index 515c416..54ce8cd 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "pyadtpulse" -version = "1.1.4b0" +version = "1.1.4b1" description = "Python interface for ADT Pulse security systems" authors = ["Ryan Snodgrass"] maintainers = ["Robert Lippmann"] From 4f4198f6f8e1b2b4c0997dc817685f7818eb5ef0 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Thu, 9 Nov 2023 16:49:00 -0500 Subject: [PATCH 094/226] downgrade aiohttp to 3.8.4 --- poetry.lock | 178 ++++++++++++++++++++++++------------------------- pyproject.toml | 2 +- 2 files changed, 90 insertions(+), 90 deletions(-) diff --git a/poetry.lock b/poetry.lock index 6cffafa..3f3886d 100644 --- a/poetry.lock +++ b/poetry.lock @@ -2,98 +2,98 @@ [[package]] name = "aiohttp" -version = "3.8.6" +version = "3.8.4" description = "Async http client/server framework (asyncio)" optional = false python-versions = ">=3.6" files = [ - {file = "aiohttp-3.8.6-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:41d55fc043954cddbbd82503d9cc3f4814a40bcef30b3569bc7b5e34130718c1"}, - {file = "aiohttp-3.8.6-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:1d84166673694841d8953f0a8d0c90e1087739d24632fe86b1a08819168b4566"}, - {file = "aiohttp-3.8.6-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:253bf92b744b3170eb4c4ca2fa58f9c4b87aeb1df42f71d4e78815e6e8b73c9e"}, - {file = "aiohttp-3.8.6-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3fd194939b1f764d6bb05490987bfe104287bbf51b8d862261ccf66f48fb4096"}, - {file = "aiohttp-3.8.6-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:6c5f938d199a6fdbdc10bbb9447496561c3a9a565b43be564648d81e1102ac22"}, - {file = "aiohttp-3.8.6-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2817b2f66ca82ee699acd90e05c95e79bbf1dc986abb62b61ec8aaf851e81c93"}, - {file = "aiohttp-3.8.6-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0fa375b3d34e71ccccf172cab401cd94a72de7a8cc01847a7b3386204093bb47"}, - {file = "aiohttp-3.8.6-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9de50a199b7710fa2904be5a4a9b51af587ab24c8e540a7243ab737b45844543"}, - {file = "aiohttp-3.8.6-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:e1d8cb0b56b3587c5c01de3bf2f600f186da7e7b5f7353d1bf26a8ddca57f965"}, - {file = "aiohttp-3.8.6-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:8e31e9db1bee8b4f407b77fd2507337a0a80665ad7b6c749d08df595d88f1cf5"}, - {file = "aiohttp-3.8.6-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:7bc88fc494b1f0311d67f29fee6fd636606f4697e8cc793a2d912ac5b19aa38d"}, - {file = "aiohttp-3.8.6-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:ec00c3305788e04bf6d29d42e504560e159ccaf0be30c09203b468a6c1ccd3b2"}, - {file = "aiohttp-3.8.6-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:ad1407db8f2f49329729564f71685557157bfa42b48f4b93e53721a16eb813ed"}, - {file = "aiohttp-3.8.6-cp310-cp310-win32.whl", hash = "sha256:ccc360e87341ad47c777f5723f68adbb52b37ab450c8bc3ca9ca1f3e849e5fe2"}, - {file = "aiohttp-3.8.6-cp310-cp310-win_amd64.whl", hash = "sha256:93c15c8e48e5e7b89d5cb4613479d144fda8344e2d886cf694fd36db4cc86865"}, - {file = "aiohttp-3.8.6-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:6e2f9cc8e5328f829f6e1fb74a0a3a939b14e67e80832975e01929e320386b34"}, - {file = "aiohttp-3.8.6-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:e6a00ffcc173e765e200ceefb06399ba09c06db97f401f920513a10c803604ca"}, - {file = "aiohttp-3.8.6-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:41bdc2ba359032e36c0e9de5a3bd00d6fb7ea558a6ce6b70acedf0da86458321"}, - {file = "aiohttp-3.8.6-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:14cd52ccf40006c7a6cd34a0f8663734e5363fd981807173faf3a017e202fec9"}, - {file = "aiohttp-3.8.6-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:2d5b785c792802e7b275c420d84f3397668e9d49ab1cb52bd916b3b3ffcf09ad"}, - {file = "aiohttp-3.8.6-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1bed815f3dc3d915c5c1e556c397c8667826fbc1b935d95b0ad680787896a358"}, - {file = "aiohttp-3.8.6-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:96603a562b546632441926cd1293cfcb5b69f0b4159e6077f7c7dbdfb686af4d"}, - {file = "aiohttp-3.8.6-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d76e8b13161a202d14c9584590c4df4d068c9567c99506497bdd67eaedf36403"}, - {file = "aiohttp-3.8.6-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:e3f1e3f1a1751bb62b4a1b7f4e435afcdade6c17a4fd9b9d43607cebd242924a"}, - {file = "aiohttp-3.8.6-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:76b36b3124f0223903609944a3c8bf28a599b2cc0ce0be60b45211c8e9be97f8"}, - {file = "aiohttp-3.8.6-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:a2ece4af1f3c967a4390c284797ab595a9f1bc1130ef8b01828915a05a6ae684"}, - {file = "aiohttp-3.8.6-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:16d330b3b9db87c3883e565340d292638a878236418b23cc8b9b11a054aaa887"}, - {file = "aiohttp-3.8.6-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:42c89579f82e49db436b69c938ab3e1559e5a4409eb8639eb4143989bc390f2f"}, - {file = "aiohttp-3.8.6-cp311-cp311-win32.whl", hash = "sha256:efd2fcf7e7b9d7ab16e6b7d54205beded0a9c8566cb30f09c1abe42b4e22bdcb"}, - {file = "aiohttp-3.8.6-cp311-cp311-win_amd64.whl", hash = "sha256:3b2ab182fc28e7a81f6c70bfbd829045d9480063f5ab06f6e601a3eddbbd49a0"}, - {file = "aiohttp-3.8.6-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:fdee8405931b0615220e5ddf8cd7edd8592c606a8e4ca2a00704883c396e4479"}, - {file = "aiohttp-3.8.6-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d25036d161c4fe2225d1abff2bd52c34ed0b1099f02c208cd34d8c05729882f0"}, - {file = "aiohttp-3.8.6-cp36-cp36m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5d791245a894be071d5ab04bbb4850534261a7d4fd363b094a7b9963e8cdbd31"}, - {file = "aiohttp-3.8.6-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:0cccd1de239afa866e4ce5c789b3032442f19c261c7d8a01183fd956b1935349"}, - {file = "aiohttp-3.8.6-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1f13f60d78224f0dace220d8ab4ef1dbc37115eeeab8c06804fec11bec2bbd07"}, - {file = "aiohttp-3.8.6-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:8a9b5a0606faca4f6cc0d338359d6fa137104c337f489cd135bb7fbdbccb1e39"}, - {file = "aiohttp-3.8.6-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:13da35c9ceb847732bf5c6c5781dcf4780e14392e5d3b3c689f6d22f8e15ae31"}, - {file = "aiohttp-3.8.6-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:4d4cbe4ffa9d05f46a28252efc5941e0462792930caa370a6efaf491f412bc66"}, - {file = "aiohttp-3.8.6-cp36-cp36m-musllinux_1_1_ppc64le.whl", hash = "sha256:229852e147f44da0241954fc6cb910ba074e597f06789c867cb7fb0621e0ba7a"}, - {file = "aiohttp-3.8.6-cp36-cp36m-musllinux_1_1_s390x.whl", hash = "sha256:713103a8bdde61d13490adf47171a1039fd880113981e55401a0f7b42c37d071"}, - {file = "aiohttp-3.8.6-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:45ad816b2c8e3b60b510f30dbd37fe74fd4a772248a52bb021f6fd65dff809b6"}, - {file = "aiohttp-3.8.6-cp36-cp36m-win32.whl", hash = "sha256:2b8d4e166e600dcfbff51919c7a3789ff6ca8b3ecce16e1d9c96d95dd569eb4c"}, - {file = "aiohttp-3.8.6-cp36-cp36m-win_amd64.whl", hash = "sha256:0912ed87fee967940aacc5306d3aa8ba3a459fcd12add0b407081fbefc931e53"}, - {file = "aiohttp-3.8.6-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:e2a988a0c673c2e12084f5e6ba3392d76c75ddb8ebc6c7e9ead68248101cd446"}, - {file = "aiohttp-3.8.6-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ebf3fd9f141700b510d4b190094db0ce37ac6361a6806c153c161dc6c041ccda"}, - {file = "aiohttp-3.8.6-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3161ce82ab85acd267c8f4b14aa226047a6bee1e4e6adb74b798bd42c6ae1f80"}, - {file = "aiohttp-3.8.6-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d95fc1bf33a9a81469aa760617b5971331cdd74370d1214f0b3109272c0e1e3c"}, - {file = "aiohttp-3.8.6-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c43ecfef7deaf0617cee936836518e7424ee12cb709883f2c9a1adda63cc460"}, - {file = "aiohttp-3.8.6-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ca80e1b90a05a4f476547f904992ae81eda5c2c85c66ee4195bb8f9c5fb47f28"}, - {file = "aiohttp-3.8.6-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:90c72ebb7cb3a08a7f40061079817133f502a160561d0675b0a6adf231382c92"}, - {file = "aiohttp-3.8.6-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:bb54c54510e47a8c7c8e63454a6acc817519337b2b78606c4e840871a3e15349"}, - {file = "aiohttp-3.8.6-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:de6a1c9f6803b90e20869e6b99c2c18cef5cc691363954c93cb9adeb26d9f3ae"}, - {file = "aiohttp-3.8.6-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:a3628b6c7b880b181a3ae0a0683698513874df63783fd89de99b7b7539e3e8a8"}, - {file = "aiohttp-3.8.6-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:fc37e9aef10a696a5a4474802930079ccfc14d9f9c10b4662169671ff034b7df"}, - {file = "aiohttp-3.8.6-cp37-cp37m-win32.whl", hash = "sha256:f8ef51e459eb2ad8e7a66c1d6440c808485840ad55ecc3cafefadea47d1b1ba2"}, - {file = "aiohttp-3.8.6-cp37-cp37m-win_amd64.whl", hash = "sha256:b2fe42e523be344124c6c8ef32a011444e869dc5f883c591ed87f84339de5976"}, - {file = "aiohttp-3.8.6-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:9e2ee0ac5a1f5c7dd3197de309adfb99ac4617ff02b0603fd1e65b07dc772e4b"}, - {file = "aiohttp-3.8.6-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:01770d8c04bd8db568abb636c1fdd4f7140b284b8b3e0b4584f070180c1e5c62"}, - {file = "aiohttp-3.8.6-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:3c68330a59506254b556b99a91857428cab98b2f84061260a67865f7f52899f5"}, - {file = "aiohttp-3.8.6-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:89341b2c19fb5eac30c341133ae2cc3544d40d9b1892749cdd25892bbc6ac951"}, - {file = "aiohttp-3.8.6-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:71783b0b6455ac8f34b5ec99d83e686892c50498d5d00b8e56d47f41b38fbe04"}, - {file = "aiohttp-3.8.6-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f628dbf3c91e12f4d6c8b3f092069567d8eb17814aebba3d7d60c149391aee3a"}, - {file = "aiohttp-3.8.6-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b04691bc6601ef47c88f0255043df6f570ada1a9ebef99c34bd0b72866c217ae"}, - {file = "aiohttp-3.8.6-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7ee912f7e78287516df155f69da575a0ba33b02dd7c1d6614dbc9463f43066e3"}, - {file = "aiohttp-3.8.6-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:9c19b26acdd08dd239e0d3669a3dddafd600902e37881f13fbd8a53943079dbc"}, - {file = "aiohttp-3.8.6-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:99c5ac4ad492b4a19fc132306cd57075c28446ec2ed970973bbf036bcda1bcc6"}, - {file = "aiohttp-3.8.6-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:f0f03211fd14a6a0aed2997d4b1c013d49fb7b50eeb9ffdf5e51f23cfe2c77fa"}, - {file = "aiohttp-3.8.6-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:8d399dade330c53b4106160f75f55407e9ae7505263ea86f2ccca6bfcbdb4921"}, - {file = "aiohttp-3.8.6-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:ec4fd86658c6a8964d75426517dc01cbf840bbf32d055ce64a9e63a40fd7b771"}, - {file = "aiohttp-3.8.6-cp38-cp38-win32.whl", hash = "sha256:33164093be11fcef3ce2571a0dccd9041c9a93fa3bde86569d7b03120d276c6f"}, - {file = "aiohttp-3.8.6-cp38-cp38-win_amd64.whl", hash = "sha256:bdf70bfe5a1414ba9afb9d49f0c912dc524cf60141102f3a11143ba3d291870f"}, - {file = "aiohttp-3.8.6-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:d52d5dc7c6682b720280f9d9db41d36ebe4791622c842e258c9206232251ab2b"}, - {file = "aiohttp-3.8.6-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:4ac39027011414dbd3d87f7edb31680e1f430834c8cef029f11c66dad0670aa5"}, - {file = "aiohttp-3.8.6-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:3f5c7ce535a1d2429a634310e308fb7d718905487257060e5d4598e29dc17f0b"}, - {file = "aiohttp-3.8.6-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b30e963f9e0d52c28f284d554a9469af073030030cef8693106d918b2ca92f54"}, - {file = "aiohttp-3.8.6-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:918810ef188f84152af6b938254911055a72e0f935b5fbc4c1a4ed0b0584aed1"}, - {file = "aiohttp-3.8.6-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:002f23e6ea8d3dd8d149e569fd580c999232b5fbc601c48d55398fbc2e582e8c"}, - {file = "aiohttp-3.8.6-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4fcf3eabd3fd1a5e6092d1242295fa37d0354b2eb2077e6eb670accad78e40e1"}, - {file = "aiohttp-3.8.6-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:255ba9d6d5ff1a382bb9a578cd563605aa69bec845680e21c44afc2670607a95"}, - {file = "aiohttp-3.8.6-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d67f8baed00870aa390ea2590798766256f31dc5ed3ecc737debb6e97e2ede78"}, - {file = "aiohttp-3.8.6-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:86f20cee0f0a317c76573b627b954c412ea766d6ada1a9fcf1b805763ae7feeb"}, - {file = "aiohttp-3.8.6-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:39a312d0e991690ccc1a61f1e9e42daa519dcc34ad03eb6f826d94c1190190dd"}, - {file = "aiohttp-3.8.6-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:e827d48cf802de06d9c935088c2924e3c7e7533377d66b6f31ed175c1620e05e"}, - {file = "aiohttp-3.8.6-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:bd111d7fc5591ddf377a408ed9067045259ff2770f37e2d94e6478d0f3fc0c17"}, - {file = "aiohttp-3.8.6-cp39-cp39-win32.whl", hash = "sha256:caf486ac1e689dda3502567eb89ffe02876546599bbf915ec94b1fa424eeffd4"}, - {file = "aiohttp-3.8.6-cp39-cp39-win_amd64.whl", hash = "sha256:3f0e27e5b733803333bb2371249f41cf42bae8884863e8e8965ec69bebe53132"}, - {file = "aiohttp-3.8.6.tar.gz", hash = "sha256:b0cf2a4501bff9330a8a5248b4ce951851e415bdcce9dc158e76cfd55e15085c"}, + {file = "aiohttp-3.8.4-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:5ce45967538fb747370308d3145aa68a074bdecb4f3a300869590f725ced69c1"}, + {file = "aiohttp-3.8.4-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:b744c33b6f14ca26b7544e8d8aadff6b765a80ad6164fb1a430bbadd593dfb1a"}, + {file = "aiohttp-3.8.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:1a45865451439eb320784918617ba54b7a377e3501fb70402ab84d38c2cd891b"}, + {file = "aiohttp-3.8.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a86d42d7cba1cec432d47ab13b6637bee393a10f664c425ea7b305d1301ca1a3"}, + {file = "aiohttp-3.8.4-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ee3c36df21b5714d49fc4580247947aa64bcbe2939d1b77b4c8dcb8f6c9faecc"}, + {file = "aiohttp-3.8.4-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:176a64b24c0935869d5bbc4c96e82f89f643bcdf08ec947701b9dbb3c956b7dd"}, + {file = "aiohttp-3.8.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c844fd628851c0bc309f3c801b3a3d58ce430b2ce5b359cd918a5a76d0b20cb5"}, + {file = "aiohttp-3.8.4-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:5393fb786a9e23e4799fec788e7e735de18052f83682ce2dfcabaf1c00c2c08e"}, + {file = "aiohttp-3.8.4-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:e4b09863aae0dc965c3ef36500d891a3ff495a2ea9ae9171e4519963c12ceefd"}, + {file = "aiohttp-3.8.4-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:adfbc22e87365a6e564c804c58fc44ff7727deea782d175c33602737b7feadb6"}, + {file = "aiohttp-3.8.4-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:147ae376f14b55f4f3c2b118b95be50a369b89b38a971e80a17c3fd623f280c9"}, + {file = "aiohttp-3.8.4-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:eafb3e874816ebe2a92f5e155f17260034c8c341dad1df25672fb710627c6949"}, + {file = "aiohttp-3.8.4-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:c6cc15d58053c76eacac5fa9152d7d84b8d67b3fde92709195cb984cfb3475ea"}, + {file = "aiohttp-3.8.4-cp310-cp310-win32.whl", hash = "sha256:59f029a5f6e2d679296db7bee982bb3d20c088e52a2977e3175faf31d6fb75d1"}, + {file = "aiohttp-3.8.4-cp310-cp310-win_amd64.whl", hash = "sha256:fe7ba4a51f33ab275515f66b0a236bcde4fb5561498fe8f898d4e549b2e4509f"}, + {file = "aiohttp-3.8.4-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:3d8ef1a630519a26d6760bc695842579cb09e373c5f227a21b67dc3eb16cfea4"}, + {file = "aiohttp-3.8.4-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:5b3f2e06a512e94722886c0827bee9807c86a9f698fac6b3aee841fab49bbfb4"}, + {file = "aiohttp-3.8.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:3a80464982d41b1fbfe3154e440ba4904b71c1a53e9cd584098cd41efdb188ef"}, + {file = "aiohttp-3.8.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8b631e26df63e52f7cce0cce6507b7a7f1bc9b0c501fcde69742130b32e8782f"}, + {file = "aiohttp-3.8.4-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3f43255086fe25e36fd5ed8f2ee47477408a73ef00e804cb2b5cba4bf2ac7f5e"}, + {file = "aiohttp-3.8.4-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4d347a172f866cd1d93126d9b239fcbe682acb39b48ee0873c73c933dd23bd0f"}, + {file = "aiohttp-3.8.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a3fec6a4cb5551721cdd70473eb009d90935b4063acc5f40905d40ecfea23e05"}, + {file = "aiohttp-3.8.4-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:80a37fe8f7c1e6ce8f2d9c411676e4bc633a8462844e38f46156d07a7d401654"}, + {file = "aiohttp-3.8.4-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:d1e6a862b76f34395a985b3cd39a0d949ca80a70b6ebdea37d3ab39ceea6698a"}, + {file = "aiohttp-3.8.4-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:cd468460eefef601ece4428d3cf4562459157c0f6523db89365202c31b6daebb"}, + {file = "aiohttp-3.8.4-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:618c901dd3aad4ace71dfa0f5e82e88b46ef57e3239fc7027773cb6d4ed53531"}, + {file = "aiohttp-3.8.4-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:652b1bff4f15f6287550b4670546a2947f2a4575b6c6dff7760eafb22eacbf0b"}, + {file = "aiohttp-3.8.4-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:80575ba9377c5171407a06d0196b2310b679dc752d02a1fcaa2bc20b235dbf24"}, + {file = "aiohttp-3.8.4-cp311-cp311-win32.whl", hash = "sha256:bbcf1a76cf6f6dacf2c7f4d2ebd411438c275faa1dc0c68e46eb84eebd05dd7d"}, + {file = "aiohttp-3.8.4-cp311-cp311-win_amd64.whl", hash = "sha256:6e74dd54f7239fcffe07913ff8b964e28b712f09846e20de78676ce2a3dc0bfc"}, + {file = "aiohttp-3.8.4-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:880e15bb6dad90549b43f796b391cfffd7af373f4646784795e20d92606b7a51"}, + {file = "aiohttp-3.8.4-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bb96fa6b56bb536c42d6a4a87dfca570ff8e52de2d63cabebfd6fb67049c34b6"}, + {file = "aiohttp-3.8.4-cp36-cp36m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4a6cadebe132e90cefa77e45f2d2f1a4b2ce5c6b1bfc1656c1ddafcfe4ba8131"}, + {file = "aiohttp-3.8.4-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f352b62b45dff37b55ddd7b9c0c8672c4dd2eb9c0f9c11d395075a84e2c40f75"}, + {file = "aiohttp-3.8.4-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7ab43061a0c81198d88f39aaf90dae9a7744620978f7ef3e3708339b8ed2ef01"}, + {file = "aiohttp-3.8.4-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c9cb1565a7ad52e096a6988e2ee0397f72fe056dadf75d17fa6b5aebaea05622"}, + {file = "aiohttp-3.8.4-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:1b3ea7edd2d24538959c1c1abf97c744d879d4e541d38305f9bd7d9b10c9ec41"}, + {file = "aiohttp-3.8.4-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:7c7837fe8037e96b6dd5cfcf47263c1620a9d332a87ec06a6ca4564e56bd0f36"}, + {file = "aiohttp-3.8.4-cp36-cp36m-musllinux_1_1_ppc64le.whl", hash = "sha256:3b90467ebc3d9fa5b0f9b6489dfb2c304a1db7b9946fa92aa76a831b9d587e99"}, + {file = "aiohttp-3.8.4-cp36-cp36m-musllinux_1_1_s390x.whl", hash = "sha256:cab9401de3ea52b4b4c6971db5fb5c999bd4260898af972bf23de1c6b5dd9d71"}, + {file = "aiohttp-3.8.4-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:d1f9282c5f2b5e241034a009779e7b2a1aa045f667ff521e7948ea9b56e0c5ff"}, + {file = "aiohttp-3.8.4-cp36-cp36m-win32.whl", hash = "sha256:5e14f25765a578a0a634d5f0cd1e2c3f53964553a00347998dfdf96b8137f777"}, + {file = "aiohttp-3.8.4-cp36-cp36m-win_amd64.whl", hash = "sha256:4c745b109057e7e5f1848c689ee4fb3a016c8d4d92da52b312f8a509f83aa05e"}, + {file = "aiohttp-3.8.4-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:aede4df4eeb926c8fa70de46c340a1bc2c6079e1c40ccf7b0eae1313ffd33519"}, + {file = "aiohttp-3.8.4-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4ddaae3f3d32fc2cb4c53fab020b69a05c8ab1f02e0e59665c6f7a0d3a5be54f"}, + {file = "aiohttp-3.8.4-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c4eb3b82ca349cf6fadcdc7abcc8b3a50ab74a62e9113ab7a8ebc268aad35bb9"}, + {file = "aiohttp-3.8.4-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9bcb89336efa095ea21b30f9e686763f2be4478f1b0a616969551982c4ee4c3b"}, + {file = "aiohttp-3.8.4-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c08e8ed6fa3d477e501ec9db169bfac8140e830aa372d77e4a43084d8dd91ab"}, + {file = "aiohttp-3.8.4-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c6cd05ea06daca6ad6a4ca3ba7fe7dc5b5de063ff4daec6170ec0f9979f6c332"}, + {file = "aiohttp-3.8.4-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:b7a00a9ed8d6e725b55ef98b1b35c88013245f35f68b1b12c5cd4100dddac333"}, + {file = "aiohttp-3.8.4-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:de04b491d0e5007ee1b63a309956eaed959a49f5bb4e84b26c8f5d49de140fa9"}, + {file = "aiohttp-3.8.4-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:40653609b3bf50611356e6b6554e3a331f6879fa7116f3959b20e3528783e699"}, + {file = "aiohttp-3.8.4-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:dbf3a08a06b3f433013c143ebd72c15cac33d2914b8ea4bea7ac2c23578815d6"}, + {file = "aiohttp-3.8.4-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:854f422ac44af92bfe172d8e73229c270dc09b96535e8a548f99c84f82dde241"}, + {file = "aiohttp-3.8.4-cp37-cp37m-win32.whl", hash = "sha256:aeb29c84bb53a84b1a81c6c09d24cf33bb8432cc5c39979021cc0f98c1292a1a"}, + {file = "aiohttp-3.8.4-cp37-cp37m-win_amd64.whl", hash = "sha256:db3fc6120bce9f446d13b1b834ea5b15341ca9ff3f335e4a951a6ead31105480"}, + {file = "aiohttp-3.8.4-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:fabb87dd8850ef0f7fe2b366d44b77d7e6fa2ea87861ab3844da99291e81e60f"}, + {file = "aiohttp-3.8.4-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:91f6d540163f90bbaef9387e65f18f73ffd7c79f5225ac3d3f61df7b0d01ad15"}, + {file = "aiohttp-3.8.4-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:d265f09a75a79a788237d7f9054f929ced2e69eb0bb79de3798c468d8a90f945"}, + {file = "aiohttp-3.8.4-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3d89efa095ca7d442a6d0cbc755f9e08190ba40069b235c9886a8763b03785da"}, + {file = "aiohttp-3.8.4-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4dac314662f4e2aa5009977b652d9b8db7121b46c38f2073bfeed9f4049732cd"}, + {file = "aiohttp-3.8.4-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:fe11310ae1e4cd560035598c3f29d86cef39a83d244c7466f95c27ae04850f10"}, + {file = "aiohttp-3.8.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6ddb2a2026c3f6a68c3998a6c47ab6795e4127315d2e35a09997da21865757f8"}, + {file = "aiohttp-3.8.4-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e75b89ac3bd27d2d043b234aa7b734c38ba1b0e43f07787130a0ecac1e12228a"}, + {file = "aiohttp-3.8.4-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:6e601588f2b502c93c30cd5a45bfc665faaf37bbe835b7cfd461753068232074"}, + {file = "aiohttp-3.8.4-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:a5d794d1ae64e7753e405ba58e08fcfa73e3fad93ef9b7e31112ef3c9a0efb52"}, + {file = "aiohttp-3.8.4-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:a1f4689c9a1462f3df0a1f7e797791cd6b124ddbee2b570d34e7f38ade0e2c71"}, + {file = "aiohttp-3.8.4-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:3032dcb1c35bc330134a5b8a5d4f68c1a87252dfc6e1262c65a7e30e62298275"}, + {file = "aiohttp-3.8.4-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:8189c56eb0ddbb95bfadb8f60ea1b22fcfa659396ea36f6adcc521213cd7b44d"}, + {file = "aiohttp-3.8.4-cp38-cp38-win32.whl", hash = "sha256:33587f26dcee66efb2fff3c177547bd0449ab7edf1b73a7f5dea1e38609a0c54"}, + {file = "aiohttp-3.8.4-cp38-cp38-win_amd64.whl", hash = "sha256:e595432ac259af2d4630008bf638873d69346372d38255774c0e286951e8b79f"}, + {file = "aiohttp-3.8.4-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:5a7bdf9e57126dc345b683c3632e8ba317c31d2a41acd5800c10640387d193ed"}, + {file = "aiohttp-3.8.4-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:22f6eab15b6db242499a16de87939a342f5a950ad0abaf1532038e2ce7d31567"}, + {file = "aiohttp-3.8.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:7235604476a76ef249bd64cb8274ed24ccf6995c4a8b51a237005ee7a57e8643"}, + {file = "aiohttp-3.8.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ea9eb976ffdd79d0e893869cfe179a8f60f152d42cb64622fca418cd9b18dc2a"}, + {file = "aiohttp-3.8.4-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:92c0cea74a2a81c4c76b62ea1cac163ecb20fb3ba3a75c909b9fa71b4ad493cf"}, + {file = "aiohttp-3.8.4-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:493f5bc2f8307286b7799c6d899d388bbaa7dfa6c4caf4f97ef7521b9cb13719"}, + {file = "aiohttp-3.8.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0a63f03189a6fa7c900226e3ef5ba4d3bd047e18f445e69adbd65af433add5a2"}, + {file = "aiohttp-3.8.4-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:10c8cefcff98fd9168cdd86c4da8b84baaa90bf2da2269c6161984e6737bf23e"}, + {file = "aiohttp-3.8.4-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:bca5f24726e2919de94f047739d0a4fc01372801a3672708260546aa2601bf57"}, + {file = "aiohttp-3.8.4-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:03baa76b730e4e15a45f81dfe29a8d910314143414e528737f8589ec60cf7391"}, + {file = "aiohttp-3.8.4-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:8c29c77cc57e40f84acef9bfb904373a4e89a4e8b74e71aa8075c021ec9078c2"}, + {file = "aiohttp-3.8.4-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:03543dcf98a6619254b409be2d22b51f21ec66272be4ebda7b04e6412e4b2e14"}, + {file = "aiohttp-3.8.4-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:17b79c2963db82086229012cff93ea55196ed31f6493bb1ccd2c62f1724324e4"}, + {file = "aiohttp-3.8.4-cp39-cp39-win32.whl", hash = "sha256:34ce9f93a4a68d1272d26030655dd1b58ff727b3ed2a33d80ec433561b03d67a"}, + {file = "aiohttp-3.8.4-cp39-cp39-win_amd64.whl", hash = "sha256:41a86a69bb63bb2fc3dc9ad5ea9f10f1c9c8e282b471931be0268ddd09430b04"}, + {file = "aiohttp-3.8.4.tar.gz", hash = "sha256:bf2e1a9162c1e441bf805a1fd166e249d574ca04e03b34f97e2928769e91ab5c"}, ] [package.dependencies] @@ -1308,4 +1308,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "9d6ce3ab27a1fb0acb49caf512cd53ab0a701e8484a87a29a68a780a0756d1da" +content-hash = "4cb38e53cebc017eec0cd04d33d97a029eaced4d8565dbac5239504e886c9e38" diff --git a/pyproject.toml b/pyproject.toml index 54ce8cd..64ac4e5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -15,7 +15,7 @@ classifiers = [ [tool.poetry.dependencies] python = "^3.11" -aiohttp = "^3.8.6" +aiohttp = "3.8.4" beautifulsoup4 = "^4.12.2" uvloop = "^0.19.0" From eece1511b675a2d5ec84bf40461322503da1b7c1 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Thu, 9 Nov 2023 17:17:51 -0500 Subject: [PATCH 095/226] move examples to example subdirectory --- example-client.json => examples/example-client.json | 0 example-client.py => examples/example-client.py | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename example-client.json => examples/example-client.json (100%) rename example-client.py => examples/example-client.py (100%) diff --git a/example-client.json b/examples/example-client.json similarity index 100% rename from example-client.json rename to examples/example-client.json diff --git a/example-client.py b/examples/example-client.py similarity index 100% rename from example-client.py rename to examples/example-client.py From be9b2d94d863289f76e465884906a230f413250c Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Thu, 9 Nov 2023 17:47:45 -0500 Subject: [PATCH 096/226] add doc, examples, changelog to pyproject.toml --- pyproject.toml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/pyproject.toml b/pyproject.toml index 64ac4e5..45ed91f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,6 +12,11 @@ classifiers = [ "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", ] +include = [ + { path = "doc"}, + { path = "examples" }, + "CHANGELOG.md", +] [tool.poetry.dependencies] python = "^3.11" @@ -19,6 +24,7 @@ aiohttp = "3.8.4" beautifulsoup4 = "^4.12.2" uvloop = "^0.19.0" + [tool.poetry.urls] "Changelog" = "https://github.com/rlippmann/pyadtpulse/blob/master/CHANGELOG.md" "Issues" = "https://github.com/rlippmann/pyadtpulse/issues" From 4cac93fce02a118338e18a7c1ebb4753999ed0d0 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Thu, 9 Nov 2023 17:52:53 -0500 Subject: [PATCH 097/226] bump version to b2 --- pyadtpulse/const.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 86e44c9..9b44a86 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -1,5 +1,5 @@ """Constants for pyadtpulse.""" -__version__ = "1.1.4b1" +__version__ = "1.1.4b2" from enum import Enum from http import HTTPStatus diff --git a/pyproject.toml b/pyproject.toml index 45ed91f..158aa87 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "pyadtpulse" -version = "1.1.4b1" +version = "1.1.4b2" description = "Python interface for ADT Pulse security systems" authors = ["Ryan Snodgrass"] maintainers = ["Robert Lippmann"] From 12329881b1924cebe2cdbc5ebf20eaffbd304887 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Thu, 9 Nov 2023 18:18:59 -0500 Subject: [PATCH 098/226] move example-client back to root directory --- examples/example-client.json => example-client.json | 0 examples/example-client.py => example-client.py | 0 pyproject.toml | 3 ++- 3 files changed, 2 insertions(+), 1 deletion(-) rename examples/example-client.json => example-client.json (100%) rename examples/example-client.py => example-client.py (100%) diff --git a/examples/example-client.json b/example-client.json similarity index 100% rename from examples/example-client.json rename to example-client.json diff --git a/examples/example-client.py b/example-client.py similarity index 100% rename from examples/example-client.py rename to example-client.py diff --git a/pyproject.toml b/pyproject.toml index 158aa87..2240e4d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,7 +14,8 @@ classifiers = [ ] include = [ { path = "doc"}, - { path = "examples" }, + "example-client.py", + "example-client.json", "CHANGELOG.md", ] From 2e8d59b7ff4293870b4806649d38037c782e0db7 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 10 Nov 2023 02:01:33 -0500 Subject: [PATCH 099/226] break pulse_connection into smaller subclasses --- pyadtpulse/__init__.py | 1 + pyadtpulse/pulse_connection.py | 490 ++-------------------------- pyadtpulse/pulse_connection_info.py | 121 +++++++ pyadtpulse/pulse_query_manager.py | 352 ++++++++++++++++++++ pyadtpulse/util.py | 15 + 5 files changed, 520 insertions(+), 459 deletions(-) create mode 100644 pyadtpulse/pulse_connection_info.py create mode 100644 pyadtpulse/pulse_query_manager.py diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 0d0c7bb..833d745 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -287,6 +287,7 @@ def detailed_debug_logging(self, value: bool) -> None: @property def connection_failure_reason(self) -> ConnectionFailureReason: + """Get the connection failure reason.""" return self._pulse_connection.connection_failure_reason async def _update_sites(self, soup: BeautifulSoup) -> None: diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index acae183..01a9477 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -1,21 +1,13 @@ -"""ADT Pulse connection. End users should probably not call this directly.""" +"""ADT Pulse connection. End users should probably not call this directly. + +This is the main interface to the http functions to access ADT Pulse. +""" import logging -import asyncio -import datetime import re -import time -from http import HTTPStatus -from random import uniform -from threading import RLock +from time import time -from aiohttp import ( - ClientConnectionError, - ClientConnectorError, - ClientResponse, - ClientResponseError, - ClientSession, -) +from aiohttp import ClientSession from bs4 import BeautifulSoup from yarl import URL @@ -23,62 +15,29 @@ ADT_DEFAULT_HTTP_ACCEPT_HEADERS, ADT_DEFAULT_HTTP_USER_AGENT, ADT_DEFAULT_SEC_FETCH_HEADERS, - ADT_DEFAULT_VERSION, - ADT_HTTP_BACKGROUND_URIS, ADT_LOGIN_URI, ADT_LOGOUT_URI, - ADT_ORB_URI, - ADT_OTHER_HTTP_ACCEPT_HEADERS, ADT_SUMMARY_URI, - API_HOST_CA, - API_PREFIX, - DEFAULT_API_HOST, ConnectionFailureReason, ) -from .util import DebugRLock, handle_response, make_soup +from .pulse_query_manager import PulseQueryManager +from .util import handle_response, make_soup, set_debug_lock -RECOVERABLE_ERRORS = { - HTTPStatus.INTERNAL_SERVER_ERROR, - HTTPStatus.BAD_GATEWAY, - HTTPStatus.GATEWAY_TIMEOUT, -} -RETRY_LATER_ERRORS = {HTTPStatus.SERVICE_UNAVAILABLE, HTTPStatus.TOO_MANY_REQUESTS} LOG = logging.getLogger(__name__) -MAX_RETRIES = 3 + SESSION_COOKIES = {"X-mobile-browser": "false", "ICLocal": "en_US"} -class ADTPulseConnection: +class ADTPulseConnection(PulseQueryManager): """ADT Pulse connection related attributes.""" - _api_version = ADT_DEFAULT_VERSION - _class_threadlock = RLock() - __slots__ = ( - "_api_host", - "_allocated_session", - "_session", - "_attribute_lock", - "_loop", + "_pc_attribute_lock", "_last_login_time", - "_retry_after", - "_authenticated_flag", - "_detailed_debug_logging", "_site_id", - "_connection_failure_reason", ) - @staticmethod - def check_service_host(service_host: str) -> None: - """Check if service host is valid.""" - if service_host is None or service_host == "": - raise ValueError("Service host is mandatory") - if service_host not in (DEFAULT_API_HOST, API_HOST_CA): - raise ValueError( - f"Service host must be one of {DEFAULT_API_HOST}" f" or {API_HOST_CA}" - ) - @staticmethod def check_login_parameters(username: str, password: str, fingerprint: str) -> None: """Check if login parameters are valid. @@ -95,12 +54,6 @@ def check_login_parameters(username: str, password: str, fingerprint: str) -> No if fingerprint is None or fingerprint == "": raise ValueError("Fingerprint is required") - @staticmethod - def get_http_status_description(status_code: int) -> str: - """Get HTTP status description.""" - status = HTTPStatus(status_code) - return status.description - def __init__( self, host: str, @@ -110,410 +63,32 @@ def __init__( detailed_debug_logging: bool = False, ): """Initialize ADT Pulse connection.""" - self._attribute_lock: RLock | DebugRLock - if not debug_locks: - self._attribute_lock = RLock() - else: - self._attribute_lock = DebugRLock("ADTPulseConnection._attribute_lock") - self._allocated_session = False - self._authenticated_flag = asyncio.Event() - if session is None: - self._allocated_session = True - self._session = ClientSession() - else: - self._session = session + # need to initialize this after the session since we set cookies # based on it + self._pc_attribute_lock = set_debug_lock( + debug_locks, "pyadtpulse.pc_attribute_lock" + ) + super().__init__(host, session, detailed_debug_logging) self.service_host = host self._session.headers.update({"User-Agent": user_agent}) self._session.headers.update(ADT_DEFAULT_HTTP_ACCEPT_HEADERS) self._session.headers.update(ADT_DEFAULT_SEC_FETCH_HEADERS) - self._last_login_time: int = 0 - self._loop: asyncio.AbstractEventLoop | None = None - self._retry_after = int(time.time()) + self._last_login_time = 0 + self._detailed_debug_logging = detailed_debug_logging self._site_id = "" - self._connection_failure_reason = ConnectionFailureReason.NO_FAILURE - - def __del__(self): - """Destructor for ADTPulseConnection.""" - if ( - self._allocated_session - and self._session is not None - and not self._session.closed - ): - self._session.detach() - - @property - def api_version(self) -> str: - """Get the API version.""" - with self._class_threadlock: - return self._api_version - - @property - def service_host(self) -> str: - """Get the host prefix for connections.""" - with self._attribute_lock: - return self._api_host - - @service_host.setter - def service_host(self, host: str) -> None: - """Set the host prefix for connections.""" - self.check_service_host(host) - with self._attribute_lock: - self._session.headers.update({"Host": host}) - self._api_host = host - - @property - def loop(self) -> asyncio.AbstractEventLoop | None: - """Get the event loop.""" - with self._attribute_lock: - return self._loop - - @loop.setter - def loop(self, loop: asyncio.AbstractEventLoop | None) -> None: - """Set the event loop.""" - with self._attribute_lock: - self._loop = loop @property def last_login_time(self) -> int: """Get the last login time.""" - with self._attribute_lock: + with self._pc_attribute_lock: return self._last_login_time - @property - def retry_after(self) -> int: - """Get the number of seconds to wait before retrying HTTP requests.""" - with self._attribute_lock: - return self._retry_after - - @retry_after.setter - def retry_after(self, seconds: int) -> None: - """Set time after which HTTP requests can be retried.""" - if seconds < time.time(): - raise ValueError("retry_after cannot be less than current time") - with self._attribute_lock: - self._retry_after = seconds - - @property - def authenticated_flag(self) -> asyncio.Event: - """Get the authenticated flag.""" - with self._attribute_lock: - return self._authenticated_flag - - @property - def detailed_debug_logging(self) -> bool: - """Get detailed debug logging.""" - with self._attribute_lock: - return self._detailed_debug_logging - - @detailed_debug_logging.setter - def detailed_debug_logging(self, value: bool) -> None: - """Set detailed debug logging.""" - with self._attribute_lock: - self._detailed_debug_logging = value - - @property - def connection_failure_reason(self) -> ConnectionFailureReason: - """Get the connection failure reason.""" - with self._attribute_lock: - return self._connection_failure_reason - - def _set_connection_failure_reason(self, reason: ConnectionFailureReason) -> None: - """Set the connection failure reason.""" - with self._attribute_lock: - self._connection_failure_reason = reason - - def check_sync(self, message: str) -> asyncio.AbstractEventLoop: - """Checks if sync login was performed. - - Returns the loop to use for run_coroutine_threadsafe if so. - Raises RuntimeError with given message if not.""" - with self._attribute_lock: - if self._loop is None: - raise RuntimeError(message) - return self._loop - - def _set_retry_after(self, code: int, retry_after: str) -> None: - """ - Check the "Retry-After" header in the response and set retry_after property - based upon it. - - Parameters: - code (int): The HTTP response code - retry_after (str): The value of the "Retry-After" header - - Returns: - None. - """ - if retry_after.isnumeric(): - retval = int(retry_after) - else: - try: - retval = int( - datetime.datetime.strptime( - retry_after, "%a, %d %b %G %T %Z" - ).timestamp() - ) - except ValueError: - return - LOG.warning( - "Task %s received Retry-After %s due to %s", - asyncio.current_task(), - retval, - self.get_http_status_description(code), - ) - self.retry_after = int(time.time()) + retval - try: - fail_reason = ConnectionFailureReason(code) - except ValueError: - fail_reason = ConnectionFailureReason.UNKNOWN - self._set_connection_failure_reason(fail_reason) - - async def async_query( - self, - uri: str, - method: str = "GET", - extra_params: dict[str, str] | None = None, - extra_headers: dict[str, str] | None = None, - timeout: int = 1, - requires_authentication: bool = True, - ) -> tuple[int, str | None, URL | None]: - """ - Query ADT Pulse async. - - Args: - uri (str): URI to query - method (str, optional): method to use. Defaults to "GET". - extra_params (Optional[Dict], optional): query/body parameters. - Defaults to None. - extra_headers (Optional[Dict], optional): extra HTTP headers. - Defaults to None. - timeout (int, optional): timeout in seconds. Defaults to 1. - requires_authentication (bool, optional): True if authentication is - required to perform query. - Defaults to True. - If true and authenticated flag not - set, will wait for flag to be set. - - Returns: - tuple with integer return code, optional response text, and optional URL of - response - """ - - async def handle_query_response( - response: ClientResponse | None, - ) -> tuple[int, str | None, URL | None, str | None]: - if response is None: - return 0, None, None, None - response_text = await response.text() - - return ( - response.status, - response_text, - response.url, - response.headers.get("Retry-After"), - ) - - if method not in ("GET", "POST"): - raise ValueError("method must be GET or POST") - current_time = time.time() - if self.retry_after > current_time: - LOG.debug( - "Retry after set, query %s for %s waiting until %s", - method, - uri, - datetime.datetime.fromtimestamp(self.retry_after), - ) - await asyncio.sleep(self.retry_after - current_time) - - if requires_authentication and not self.authenticated_flag.is_set(): - LOG.info("%s for %s waiting for authenticated flag to be set", method, uri) - await self._authenticated_flag.wait() - else: - with ADTPulseConnection._class_threadlock: - if ADTPulseConnection._api_version == ADT_DEFAULT_VERSION: - await self.async_fetch_version() - - url = self.make_url(uri) - headers = extra_headers if extra_headers is not None else {} - if uri in ADT_HTTP_BACKGROUND_URIS: - headers.setdefault("Accept", ADT_OTHER_HTTP_ACCEPT_HEADERS["Accept"]) - if self.detailed_debug_logging: - LOG.debug( - "Attempting %s %s params=%s timeout=%d", - method, - url, - extra_params, - timeout, - ) - retry = 0 - return_value: tuple[int, str | None, URL | None, str | None] = ( - HTTPStatus.OK.value, - None, - None, - None, - ) - while retry < MAX_RETRIES: - try: - async with self._session.request( - method, - url, - headers=extra_headers, - params=extra_params if method == "GET" else None, - data=extra_params if method == "POST" else None, - timeout=timeout, - ) as response: - return_value = await handle_query_response(response) - retry += 1 - - if return_value[0] in RECOVERABLE_ERRORS: - LOG.info( - "query returned recoverable error code %s: %s," - "retrying (count = %d)", - return_value[0], - self.get_http_status_description(return_value[0]), - retry, - ) - if retry == MAX_RETRIES: - LOG.warning( - "Exceeded max retries of %d, giving up", MAX_RETRIES - ) - response.raise_for_status() - await asyncio.sleep(2**retry + uniform(0.0, 1.0)) - continue - - response.raise_for_status() - break - except ( - TimeoutError, - ClientConnectionError, - ClientConnectorError, - ClientResponseError, - ) as ex: - if return_value[0] is not None and return_value[3] is not None: - self._set_retry_after( - return_value[0], - return_value[3], - ) - break - LOG.debug( - "Error %s occurred making %s request to %s", - ex.args, - method, - url, - exc_info=True, - ) - break - return (return_value[0], return_value[1], return_value[2]) - - def query( - self, - uri: str, - method: str = "GET", - extra_params: dict[str, str] | None = None, - extra_headers: dict[str, str] | None = None, - timeout=1, - requires_authentication: bool = True, - ) -> tuple[int, str | None, URL | None]: - """Query ADT Pulse async. - - Args: - uri (str): URI to query - method (str, optional): method to use. Defaults to "GET". - extra_params (Optional[Dict], optional): query/body parameters. Defaults to None. - extra_headers (Optional[Dict], optional): extra HTTP headers. - Defaults to None. - timeout (int, optional): timeout in seconds. Defaults to 1. - requires_authentication (bool, optional): True if authentication is required - to perform query. Defaults to True. - If true and authenticated flag not - set, will wait for flag to be set. - Returns: - tuple with integer return code, optional response text, and optional URL of - response - """ - coro = self.async_query( - uri, - method, - extra_params, - extra_headers, - timeout=timeout, - requires_authentication=requires_authentication, - ) - return asyncio.run_coroutine_threadsafe( - coro, self.check_sync("Attempting to run sync query from async login") - ).result() - - async def query_orb(self, level: int, error_message: str) -> BeautifulSoup | None: - """Query ADT Pulse ORB. - - Args: - level (int): error level to log on failure - error_message (str): error message to use on failure - - Returns: - Optional[BeautifulSoup]: A Beautiful Soup object, or None if failure - """ - code, response, url = await self.async_query( - ADT_ORB_URI, - extra_headers={"Sec-Fetch-Mode": "cors", "Sec-Fetch-Dest": "empty"}, - ) - - return make_soup(code, response, url, level, error_message) - - def make_url(self, uri: str) -> str: - """Create a URL to service host from a URI. - - Args: - uri (str): the URI to convert - - Returns: - str: the converted string - """ - with self._attribute_lock: - return f"{self._api_host}{API_PREFIX}{ADTPulseConnection._api_version}{uri}" - - async def async_fetch_version(self) -> None: - """Fetch ADT Pulse version.""" - response_path: str | None = None - response_code = HTTPStatus.OK.value - with ADTPulseConnection._class_threadlock: - if ADTPulseConnection._api_version != ADT_DEFAULT_VERSION: - return - - signin_url = f"{self.service_host}" - try: - async with self._session.get( - signin_url, - ) as response: - response_code = response.status - # we only need the headers here, don't parse response - response.raise_for_status() - response_path = response.url.path - except (ClientResponseError, ClientConnectionError): - LOG.warning( - "Error %i: occurred during API version fetch, defaulting to %s", - response_code, - ADT_DEFAULT_VERSION, - ) - return - if response_path is not None: - m = re.search("/myhome/(.+)/[a-z]*/", response_path) - if m is not None: - ADTPulseConnection._api_version = m.group(1) - LOG.debug( - "Discovered ADT Pulse version %s at %s", - ADTPulseConnection._api_version, - self.service_host, - ) - return - - LOG.warning( - "Couldn't auto-detect ADT Pulse version, defaulting to %s", - ADT_DEFAULT_VERSION, - ) + @last_login_time.setter + def last_login_time(self, login_time: int) -> None: + with self._pc_attribute_lock: + self._last_login_time = login_time async def async_do_login_query( self, username: str, password: str, fingerprint: str, timeout: int = 30 @@ -553,7 +128,7 @@ def check_response( logging.ERROR, "Error encountered communicating with Pulse site on login", ): - self._set_connection_failure_reason(ConnectionFailureReason.UNKNOWN) + self.connection_failure_reason = ConnectionFailureReason.UNKNOWN return None soup = make_soup( @@ -571,7 +146,7 @@ def check_response( error_text = error.get_text() LOG.error("Error logging into pulse: %s", error_text) if retry_after := extract_seconds_from_string(error_text) > 0: - self.retry_after = int(time.time()) + retry_after + self.retry_after = int(time()) + retry_after return None if self.make_url(ADT_SUMMARY_URI) != str(response[2]): # more specifically: @@ -580,7 +155,7 @@ def check_response( # locked out = error == "Sign In unsuccessful. Your account has been # locked after multiple sign in attempts.Try again in 30 minutes." LOG.error("Authentication error encountered logging into ADT Pulse") - self._set_connection_failure_reason( + self.connection_failure_reason = ( ConnectionFailureReason.INVALID_CREDENTIALS ) return None @@ -592,9 +167,7 @@ def check_response( username, error, ) - self._set_connection_failure_reason( - ConnectionFailureReason.MFA_REQUIRED - ) + self.connection_failure_reason = ConnectionFailureReason.MFA_REQUIRED return None return soup @@ -622,14 +195,13 @@ def check_response( return None except Exception as e: # pylint: disable=broad-except LOG.error("Could not log into Pulse site: %s", e) - self._set_connection_failure_reason(ConnectionFailureReason.UNKNOWN) + self.connection_failure_reason = ConnectionFailureReason.UNKNOWN return None soup = check_response(response) if soup is None: return None - with self._attribute_lock: - self._authenticated_flag.set() - self._last_login_time = int(time.time()) + self.authenticated_flag.set() + self.last_login_time = int(time()) return soup async def async_do_logout_query(self, site_id: str | None) -> None: @@ -646,4 +218,4 @@ async def async_do_logout_query(self, site_id: str | None) -> None: timeout=10, requires_authentication=False, ) - self._authenticated_flag.clear() + self.authenticated_flag.clear() diff --git a/pyadtpulse/pulse_connection_info.py b/pyadtpulse/pulse_connection_info.py new file mode 100644 index 0000000..05d2e36 --- /dev/null +++ b/pyadtpulse/pulse_connection_info.py @@ -0,0 +1,121 @@ +"""Pulse connection info.""" +from asyncio import AbstractEventLoop + +from aiohttp import ClientSession + +from .const import API_HOST_CA, DEFAULT_API_HOST +from .util import set_debug_lock + + +class PulseConnectionInfo: + """Pulse connection info.""" + + __slots__ = ( + "_api_host", + "_allocated_session", + "_session", + "_loop", + "_pci_attribute_lock", + "_detailed_debug_logging", + "_debug_locks", + ) + + @staticmethod + def check_service_host(service_host: str) -> None: + """Check if service host is valid.""" + if service_host is None or service_host == "": + raise ValueError("Service host is mandatory") + if service_host not in (DEFAULT_API_HOST, API_HOST_CA): + raise ValueError( + f"Service host must be one of {DEFAULT_API_HOST}" f" or {API_HOST_CA}" + ) + + def __init__( + self, + host: str, + session: ClientSession | None = None, + detailed_debug_logging=False, + debug_locks=False, + ) -> None: + """Initialize Pulse connection information.""" + self._pci_attribute_lock = set_debug_lock( + debug_locks, "pyadtpulse.pci_attribute_lock" + ) + self.debug_locks = debug_locks + self.detailed_debug_logging = detailed_debug_logging + self._allocated_session = False + self._loop: AbstractEventLoop | None = None + if session is None: + self._allocated_session = True + self._session = ClientSession() + else: + self._session = session + self.service_host = host + + def __del__(self): + """Destructor for ADTPulseConnection.""" + if ( + self._allocated_session + and self._session is not None + and not self._session.closed + ): + self._session.detach() + + @property + def service_host(self) -> str: + """Get the service host.""" + with self._pci_attribute_lock: + return self._api_host + + @service_host.setter + def service_host(self, host: str): + """Set the service host.""" + self.check_service_host(host) + with self._pci_attribute_lock: + self._api_host = host + + @property + def detailed_debug_logging(self) -> bool: + """Get the detailed debug logging flag.""" + with self._pci_attribute_lock: + return self._detailed_debug_logging + + @detailed_debug_logging.setter + def detailed_debug_logging(self, value: bool): + """Set the detailed debug logging flag.""" + with self._pci_attribute_lock: + self._detailed_debug_logging = value + + @property + def debug_locks(self) -> bool: + """Get the debug locks flag.""" + with self._pci_attribute_lock: + return self._debug_locks + + @debug_locks.setter + def debug_locks(self, value: bool): + """Set the debug locks flag.""" + with self._pci_attribute_lock: + self._debug_locks = value + + def check_sync(self, message: str) -> AbstractEventLoop: + """Checks if sync login was performed. + + Returns the loop to use for run_coroutine_threadsafe if so. + Raises RuntimeError with given message if not.""" + with self._pci_attribute_lock: + if self._loop is None: + raise RuntimeError(message) + return self._loop + + @property + def loop(self) -> AbstractEventLoop | None: + """Get the event loop.""" + with self._pci_attribute_lock: + return self._loop + + @loop.setter + def loop(self, loop: AbstractEventLoop | None): + """Set the event loop.""" + with self._pci_attribute_lock: + self._loop = loop diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py new file mode 100644 index 0000000..f7c3675 --- /dev/null +++ b/pyadtpulse/pulse_query_manager.py @@ -0,0 +1,352 @@ +"""Pulse Query Manager.""" +from logging import getLogger +from asyncio import Event, current_task, sleep +from datetime import datetime +from http import HTTPStatus +from random import uniform +from re import search +from time import time + +from aiohttp import ( + ClientConnectionError, + ClientConnectorError, + ClientResponse, + ClientResponseError, + ClientSession, +) +from bs4 import BeautifulSoup +from yarl import URL + +from .const import ( + ADT_DEFAULT_VERSION, + ADT_HTTP_BACKGROUND_URIS, + ADT_ORB_URI, + ADT_OTHER_HTTP_ACCEPT_HEADERS, + API_PREFIX, + ConnectionFailureReason, +) +from .pulse_connection_info import PulseConnectionInfo +from .util import make_soup, set_debug_lock + +LOG = getLogger(__name__) + +RECOVERABLE_ERRORS = { + HTTPStatus.INTERNAL_SERVER_ERROR, + HTTPStatus.BAD_GATEWAY, + HTTPStatus.GATEWAY_TIMEOUT, +} +RETRY_LATER_ERRORS = {HTTPStatus.SERVICE_UNAVAILABLE, HTTPStatus.TOO_MANY_REQUESTS} +MAX_RETRIES = 3 + + +class PulseQueryManager(PulseConnectionInfo): + """Pulse Query Manager.""" + + __slots__ = ( + "_retry_after", + "_connection_failure_reason", + "_authenticated_flag", + "_api_version", + "_pcm_attribute_lock", + ) + + @staticmethod + def _get_http_status_description(status_code: int) -> str: + """Get HTTP status description.""" + status = HTTPStatus(status_code) + return status.description + + def __init__( + self, + host: str, + session: ClientSession | None = None, + detailed_debug_logging: bool = False, + debug_locks: bool = False, + ) -> None: + """Initialize Pulse Query Manager.""" + self._pcm_attribute_lock = set_debug_lock( + debug_locks, "pyadtpulse.pcm_attribute_lock" + ) + self._retry_after = int(time()) + self._connection_failure_reason = ConnectionFailureReason.NO_FAILURE + self._authenticated_flag = Event() + self._api_version = ADT_DEFAULT_VERSION + super().__init__(host, session, detailed_debug_logging, debug_locks) + + @property + def retry_after(self) -> int: + """Get the number of seconds to wait before retrying HTTP requests.""" + with self._pcm_attribute_lock: + return self._retry_after + + @retry_after.setter + def retry_after(self, seconds: int) -> None: + """Set time after which HTTP requests can be retried. + + Raises: ValueError if seconds is less than current time. + """ + if seconds < time(): + raise ValueError("retry_after cannot be less than current time") + with self._pcm_attribute_lock: + self._retry_after = seconds + + @property + def connection_failure_reason(self) -> ConnectionFailureReason: + """Get the connection failure reason.""" + with self._pcm_attribute_lock: + return self._connection_failure_reason + + @connection_failure_reason.setter + def connection_failure_reason(self, reason: ConnectionFailureReason) -> None: + """Set the connection failure reason.""" + with self._pcm_attribute_lock: + self._connection_failure_reason = reason + + def _compute_retry_after(self, code: int, retry_after: str) -> None: + """ + Check the "Retry-After" header in the response and set retry_after property + based upon it. + + Parameters: + code (int): The HTTP response code + retry_after (str): The value of the "Retry-After" header + + Returns: + None. + """ + if retry_after.isnumeric(): + retval = int(retry_after) + else: + try: + retval = int( + datetime.strptime(retry_after, "%a, %d %b %G %T %Z").timestamp() + ) + except ValueError: + return + LOG.warning( + "Task %s received Retry-After %s due to %s", + current_task(), + retval, + self._get_http_status_description(code), + ) + self.retry_after = int(time()) + retval + try: + fail_reason = ConnectionFailureReason(code) + except ValueError: + fail_reason = ConnectionFailureReason.UNKNOWN + self._connection_failure_reason = fail_reason + + async def async_query( + self, + uri: str, + method: str = "GET", + extra_params: dict[str, str] | None = None, + extra_headers: dict[str, str] | None = None, + timeout: int = 1, + requires_authentication: bool = True, + ) -> tuple[int, str | None, URL | None]: + """ + Query ADT Pulse async. + + Args: + uri (str): URI to query + method (str, optional): method to use. Defaults to "GET". + extra_params (Optional[Dict], optional): query/body parameters. + Defaults to None. + extra_headers (Optional[Dict], optional): extra HTTP headers. + Defaults to None. + timeout (int, optional): timeout in seconds. Defaults to 1. + requires_authentication (bool, optional): True if authentication is + required to perform query. + Defaults to True. + If true and authenticated flag not + set, will wait for flag to be set. + + Returns: + tuple with integer return code, optional response text, and optional URL of + response + """ + + async def handle_query_response( + response: ClientResponse | None, + ) -> tuple[int, str | None, URL | None, str | None]: + if response is None: + return 0, None, None, None + response_text = await response.text() + + return ( + response.status, + response_text, + response.url, + response.headers.get("Retry-After"), + ) + + if method not in ("GET", "POST"): + raise ValueError("method must be GET or POST") + current_time = time() + if self.retry_after > current_time: + LOG.debug( + "Retry after set, query %s for %s waiting until %s", + method, + uri, + datetime.fromtimestamp(self.retry_after), + ) + await sleep(self.retry_after - current_time) + + if requires_authentication and not self._authenticated_flag.is_set(): + LOG.info("%s for %s waiting for authenticated flag to be set", method, uri) + await self._authenticated_flag.wait() + else: + if self._api_version == ADT_DEFAULT_VERSION: + await self.async_fetch_version() + + url = self.make_url(uri) + headers = extra_headers if extra_headers is not None else {} + if uri in ADT_HTTP_BACKGROUND_URIS: + headers.setdefault("Accept", ADT_OTHER_HTTP_ACCEPT_HEADERS["Accept"]) + if self._detailed_debug_logging: + LOG.debug( + "Attempting %s %s params=%s timeout=%d", + method, + url, + extra_params, + timeout, + ) + retry = 0 + return_value: tuple[int, str | None, URL | None, str | None] = ( + HTTPStatus.OK.value, + None, + None, + None, + ) + while retry < MAX_RETRIES: + try: + async with self._session.request( + method, + url, + headers=extra_headers, + params=extra_params if method == "GET" else None, + data=extra_params if method == "POST" else None, + timeout=timeout, + ) as response: + return_value = await handle_query_response(response) + retry += 1 + + if return_value[0] in RECOVERABLE_ERRORS: + LOG.info( + "query returned recoverable error code %s: %s," + "retrying (count = %d)", + return_value[0], + self._get_http_status_description(return_value[0]), + retry, + ) + if retry == MAX_RETRIES: + LOG.warning( + "Exceeded max retries of %d, giving up", MAX_RETRIES + ) + response.raise_for_status() + await sleep(2**retry + uniform(0.0, 1.0)) + continue + + response.raise_for_status() + break + except ( + TimeoutError, + ClientConnectionError, + ClientConnectorError, + ClientResponseError, + ) as ex: + if return_value[0] is not None and return_value[3] is not None: + self._compute_retry_after( + return_value[0], + return_value[3], + ) + break + LOG.debug( + "Error %s occurred making %s request to %s", + ex.args, + method, + url, + exc_info=True, + ) + break + return (return_value[0], return_value[1], return_value[2]) + + async def query_orb(self, level: int, error_message: str) -> BeautifulSoup | None: + """Query ADT Pulse ORB. + + Args: + level (int): error level to log on failure + error_message (str): error message to use on failure + + Returns: + Optional[BeautifulSoup]: A Beautiful Soup object, or None if failure + """ + code, response, url = await self.async_query( + ADT_ORB_URI, + extra_headers={"Sec-Fetch-Mode": "cors", "Sec-Fetch-Dest": "empty"}, + ) + + return make_soup(code, response, url, level, error_message) + + def make_url(self, uri: str) -> str: + """Create a URL to service host from a URI. + + Args: + uri (str): the URI to convert + + Returns: + str: the converted string + """ + return f"{self._api_host}{API_PREFIX}{self._api_version}{uri}" + + async def async_fetch_version(self) -> None: + """Fetch ADT Pulse version.""" + response_path: str | None = None + response_code = HTTPStatus.OK.value + if self._api_version != ADT_DEFAULT_VERSION: + return + + signin_url = f"{self.service_host}" + try: + async with self._session.get( + signin_url, + ) as response: + response_code = response.status + # we only need the headers here, don't parse response + response.raise_for_status() + response_path = response.url.path + except (ClientResponseError, ClientConnectionError): + LOG.warning( + "Error %i: occurred during API version fetch, defaulting to %s", + response_code, + ADT_DEFAULT_VERSION, + ) + return + if response_path is not None: + m = search("/myhome/(.+)/[a-z]*/", response_path) + if m is not None: + self._api_version = m.group(1) + LOG.debug( + "Discovered ADT Pulse version %s at %s", + self._api_version, + self.service_host, + ) + return + + LOG.warning( + "Couldn't auto-detect ADT Pulse version, defaulting to %s", + ADT_DEFAULT_VERSION, + ) + + @property + def authenticated_flag(self) -> Event: + """Get the authenticated flag.""" + with self._pcm_attribute_lock: + return self._authenticated_flag + + @property + def api_version(self) -> str: + """Get the API version.""" + with self._pcm_attribute_lock: + return self._api_version diff --git a/pyadtpulse/util.py b/pyadtpulse/util.py index e9b0280..38b3a4a 100644 --- a/pyadtpulse/util.py +++ b/pyadtpulse/util.py @@ -232,6 +232,21 @@ def parse_pulse_datetime(datestring: str) -> datetime: return last_update +def set_debug_lock(debug_lock: bool, name: str) -> RLock | DebugRLock: + """Set lock or debug lock + + Args: + debug_lock (bool): set a debug lock + name (str): debug lock name + + Returns: + RLock | DebugRLock: lock object to return + """ + if debug_lock: + return DebugRLock(name) + return RLock() + + class AuthenticationException(RuntimeError): """Raised when a login failed.""" From c4011c7209171ad557c348c5901fdc44012ea304 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 10 Nov 2023 02:25:29 -0500 Subject: [PATCH 100/226] debug lock fixes to site --- pyadtpulse/__init__.py | 11 +++-------- pyadtpulse/site.py | 30 +++++++++++------------------- pyadtpulse/util.py | 2 +- 3 files changed, 15 insertions(+), 28 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 833d745..14a13a0 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -7,7 +7,6 @@ from datetime import datetime from random import randint from threading import RLock, Thread -from typing import Union from warnings import warn import uvloop @@ -31,7 +30,7 @@ ) from .pulse_connection import ADTPulseConnection from .site import ADTPulseSite -from .util import AuthenticationException, DebugRLock, handle_response +from .util import AuthenticationException, DebugRLock, handle_response, set_debug_lock LOG = logging.getLogger(__name__) @@ -140,11 +139,7 @@ def __init__( self._updates_exist = asyncio.locks.Event() self._session_thread: Thread | None = None - self._attribute_lock: RLock | DebugRLock - if not debug_locks: - self._attribute_lock = RLock() - else: - self._attribute_lock = DebugRLock("PyADTPulse._attribute_lock") + self._attribute_lock = set_debug_lock(debug_locks, "pyadtpulse.attribute_lock") self._site: ADTPulseSite | None = None self.keepalive_interval = keepalive_interval @@ -678,7 +673,7 @@ def login(self) -> None: raise AuthenticationException(self._username) @property - def attribute_lock(self) -> Union[RLock, DebugRLock]: + def attribute_lock(self) -> "RLock| DebugRLock": """Get attribute lock for PyADTPulse object. Returns: diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index f4069f0..883ab22 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -5,7 +5,6 @@ from datetime import datetime from threading import RLock from time import time -from typing import Union from warnings import warn # import dateparser @@ -15,7 +14,13 @@ from .const import ADT_DEVICE_URI, ADT_GATEWAY_STRING, ADT_SYSTEM_URI from .gateway import ADTPulseGateway from .pulse_connection import ADTPulseConnection -from .util import DebugRLock, make_soup, parse_pulse_datetime, remove_prefix +from .util import ( + DebugRLock, + make_soup, + parse_pulse_datetime, + remove_prefix, + set_debug_lock, +) from .zones import ADTPulseFlattendZone, ADTPulseZones LOG = logging.getLogger(__name__) @@ -52,10 +57,9 @@ def __init__(self, pulse_connection: ADTPulseConnection, site_id: str, name: str self._last_updated: int = 0 self._zones = ADTPulseZones() self._site_lock: RLock | DebugRLock - if isinstance(self._pulse_connection._attribute_lock, DebugRLock): - self._site_lock = DebugRLock("ADTPulseSite._site_lock") - else: - self._site_lock = RLock() + self._site_lock = set_debug_lock( + self._pulse_connection.debug_locks, "pyadtpulse.site_lock" + ) self._alarm_panel = ADTPulseAlarmPanel() self._gateway = ADTPulseGateway() @@ -91,7 +95,7 @@ def last_updated(self) -> int: return self._last_updated @property - def site_lock(self) -> Union[RLock, DebugRLock]: + def site_lock(self) -> "RLock| DebugRLock": """Get thread lock for site data. Not needed for async @@ -103,46 +107,34 @@ def site_lock(self) -> Union[RLock, DebugRLock]: def arm_home(self, force_arm: bool = False) -> bool: """Arm system home.""" - if self.alarm_control_panel is None: - raise RuntimeError("Cannot arm system home, no control panels exist") return self.alarm_control_panel.arm_home( self._pulse_connection, force_arm=force_arm ) def arm_away(self, force_arm: bool = False) -> bool: """Arm system away.""" - if self.alarm_control_panel is None: - raise RuntimeError("Cannot arm system away, no control panels exist") return self.alarm_control_panel.arm_away( self._pulse_connection, force_arm=force_arm ) def disarm(self) -> bool: """Disarm system.""" - if self.alarm_control_panel is None: - raise RuntimeError("Cannot disarm system, no control panels exist") return self.alarm_control_panel.disarm(self._pulse_connection) async def async_arm_home(self, force_arm: bool = False) -> bool: """Arm system home async.""" - if self.alarm_control_panel is None: - raise RuntimeError("Cannot arm system home, no control panels exist") return await self.alarm_control_panel.async_arm_home( self._pulse_connection, force_arm=force_arm ) async def async_arm_away(self, force_arm: bool = False) -> bool: """Arm system away async.""" - if self.alarm_control_panel is None: - raise RuntimeError("Cannot arm system away, no control panels exist") return await self.alarm_control_panel.async_arm_away( self._pulse_connection, force_arm=force_arm ) async def async_disarm(self) -> bool: """Disarm system async.""" - if self.alarm_control_panel is None: - raise RuntimeError("Cannot disarm system, no control panels exist") return await self.alarm_control_panel.async_disarm(self._pulse_connection) @property diff --git a/pyadtpulse/util.py b/pyadtpulse/util.py index 38b3a4a..63c2799 100644 --- a/pyadtpulse/util.py +++ b/pyadtpulse/util.py @@ -232,7 +232,7 @@ def parse_pulse_datetime(datestring: str) -> datetime: return last_update -def set_debug_lock(debug_lock: bool, name: str) -> RLock | DebugRLock: +def set_debug_lock(debug_lock: bool, name: str) -> "RLock | DebugRLock": """Set lock or debug lock Args: From e680e3849b7ca4e52f652fa4328a01d983d93a48 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 10 Nov 2023 02:28:06 -0500 Subject: [PATCH 101/226] bump version to 1.1.4b3 --- pyadtpulse/const.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 9b44a86..235dcb2 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -1,5 +1,5 @@ """Constants for pyadtpulse.""" -__version__ = "1.1.4b2" +__version__ = "1.1.4b3" from enum import Enum from http import HTTPStatus diff --git a/pyproject.toml b/pyproject.toml index 2240e4d..c083c23 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "pyadtpulse" -version = "1.1.4b2" +version = "1.1.4b3" description = "Python interface for ADT Pulse security systems" authors = ["Ryan Snodgrass"] maintainers = ["Robert Lippmann"] From 1f47577655aeb636722f5e62b6fd26ede4cd8910 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 10 Nov 2023 04:21:25 -0500 Subject: [PATCH 102/226] break pyadtpulse object into smaller classes --- pyadtpulse/__init__.py | 722 ++-------------------------- pyadtpulse/pyadtpulse_async.py | 475 ++++++++++++++++++ pyadtpulse/pyadtpulse_properties.py | 291 +++++++++++ 3 files changed, 805 insertions(+), 683 deletions(-) create mode 100644 pyadtpulse/pyadtpulse_async.py create mode 100644 pyadtpulse/pyadtpulse_properties.py diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 14a13a0..b1b2886 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -2,80 +2,28 @@ import logging import asyncio -import re import time -from datetime import datetime -from random import randint from threading import RLock, Thread -from warnings import warn import uvloop from aiohttp import ClientSession -from bs4 import BeautifulSoup -from yarl import URL -from .alarm_panel import ADT_ALARM_UNKNOWN from .const import ( ADT_DEFAULT_HTTP_USER_AGENT, ADT_DEFAULT_KEEPALIVE_INTERVAL, ADT_DEFAULT_RELOGIN_INTERVAL, - ADT_GATEWAY_STRING, - ADT_MAX_KEEPALIVE_INTERVAL, - ADT_MAX_RELOGIN_BACKOFF, - ADT_MIN_RELOGIN_INTERVAL, - ADT_SYNC_CHECK_URI, - ADT_TIMEOUT_URI, DEFAULT_API_HOST, - ConnectionFailureReason, ) -from .pulse_connection import ADTPulseConnection -from .site import ADTPulseSite -from .util import AuthenticationException, DebugRLock, handle_response, set_debug_lock +from .pyadtpulse_async import SYNC_CHECK_TASK_NAME, PyADTPulseAsync +from .util import AuthenticationException, DebugRLock, set_debug_lock LOG = logging.getLogger(__name__) -SYNC_CHECK_TASK_NAME = "ADT Pulse Sync Check Task" -KEEPALIVE_TASK_NAME = "ADT Pulse Keepalive Task" -RELOGIN_BACKOFF_WARNING_THRESHOLD = 5.0 * 60.0 - -class PyADTPulse: +class PyADTPulse(PyADTPulseAsync): """Base object for ADT Pulse service.""" - __slots__ = ( - "_pulse_connection", - "_sync_task", - "_timeout_task", - "_authenticated", - "_updates_exist", - "_session_thread", - "_attribute_lock", - "_site", - "_username", - "_password", - "_fingerprint", - "_login_exception", - "_relogin_interval", - "_keepalive_interval", - "_update_succeded", - "_detailed_debug_logging", - ) - - @staticmethod - def _check_keepalive_interval(keepalive_interval: int) -> None: - if keepalive_interval > ADT_MAX_KEEPALIVE_INTERVAL or keepalive_interval <= 0: - raise ValueError( - f"keepalive interval ({keepalive_interval}) must be " - f"greater than 0 and less than {ADT_MAX_KEEPALIVE_INTERVAL}" - ) - - @staticmethod - def _check_relogin_interval(relogin_interval: int) -> None: - if relogin_interval < ADT_MIN_RELOGIN_INTERVAL: - raise ValueError( - f"relogin interval ({relogin_interval}) must be " - f"greater than {ADT_MIN_RELOGIN_INTERVAL}" - ) + __slots__ = ("_session_thread", "_p_attribute_lock") def __init__( self, @@ -91,77 +39,25 @@ def __init__( relogin_interval: int = ADT_DEFAULT_RELOGIN_INTERVAL, detailed_debug_logging: bool = False, ): - """Create a PyADTPulse object. - - Args: - username (str): Username. - password (str): Password. - fingerprint (str): 2FA fingerprint. - service_host (str, optional): host prefix to use - i.e. https://portal.adtpulse.com or - https://portal-ca.adtpulse.com - user_agent (str, optional): User Agent. - Defaults to ADT_DEFAULT_HTTP_HEADERS["User-Agent"]. - websession (ClientSession, optional): an initialized - aiohttp.ClientSession to use, defaults to None - do_login (bool, optional): login synchronously when creating object - Should be set to False for asynchronous usage - and async_login() should be called instead - Setting websession will override this - and not login - Defaults to True - debug_locks: (bool, optional): use debugging locks - Defaults to False - keepalive_interval (int, optional): number of minutes between - keepalive checks, defaults to ADT_DEFAULT_KEEPALIVE_INTERVAL, - maxiumum is ADT_MAX_KEEPALIVE_INTERVAL - relogin_interval (int, optional): number of minutes between relogin checks - defaults to ADT_DEFAULT_RELOGIN_INTERVAL, - minimum is ADT_MIN_RELOGIN_INTERVAL - detailed_debug_logging (bool, optional): enable detailed debug logging - """ - self._init_login_info(username, password, fingerprint) - self._pulse_connection = ADTPulseConnection( + self._p_attribute_lock = set_debug_lock( + debug_locks, "pyadtpulse._p_attribute_lockattribute_lock" + ) + super().__init__( + username, + password, + fingerprint, service_host, - session=websession, - user_agent=user_agent, - debug_locks=debug_locks, - detailed_debug_logging=detailed_debug_logging, + user_agent, + websession, + debug_locks, + keepalive_interval, + relogin_interval, + detailed_debug_logging, ) - - self._sync_task: asyncio.Task | None = None - self._timeout_task: asyncio.Task | None = None - - # FIXME use thread event/condition, regular condition? - # defer initialization to make sure we have an event loop - self._login_exception: BaseException | None = None - - self._updates_exist = asyncio.locks.Event() - self._session_thread: Thread | None = None - self._attribute_lock = set_debug_lock(debug_locks, "pyadtpulse.attribute_lock") - - self._site: ADTPulseSite | None = None - self.keepalive_interval = keepalive_interval - self.relogin_interval = relogin_interval - self._detailed_debug_logging = detailed_debug_logging - self._update_succeded = True - - # authenticate the user if do_login and websession is None: self.login() - def _init_login_info(self, username: str, password: str, fingerprint: str) -> None: - """Initialize login info. - - Raises: - ValueError: if login parameters are not valid. - """ - ADTPulseConnection.check_login_parameters(username, password, fingerprint) - self._username = username - self._password = password - self._fingerprint = fingerprint - def __repr__(self) -> str: """Object representation.""" return f"<{self.__class__.__name__}: {self._username}>" @@ -170,423 +66,6 @@ def __repr__(self) -> str: # support testing as well as alternative ADT Pulse endpoints such as # portal-ca.adtpulse.com - @property - def service_host(self) -> str: - """Get the Pulse host. - - Returns: (str): the ADT Pulse endpoint host - """ - return self._pulse_connection.service_host - - @service_host.setter - def service_host(self, host: str) -> None: - """Override the Pulse host (i.e. to use portal-ca.adpulse.com). - - Args: - host (str): name of Pulse endpoint host - """ - ADTPulseConnection.check_service_host(host) - with self._attribute_lock: - self._pulse_connection.service_host = host - - def set_service_host(self, host: str) -> None: - """Backward compatibility for service host property setter.""" - self.service_host = host - - @property - def username(self) -> str: - """Get username. - - Returns: - str: the username - """ - with self._attribute_lock: - return self._username - - @property - def version(self) -> str: - """Get the ADT Pulse site version. - - Returns: - str: a string containing the version - """ - return self._pulse_connection.api_version - - @property - def relogin_interval(self) -> int: - """Get re-login interval. - - Returns: - int: number of minutes to re-login to Pulse - 0 means disabled - """ - with self._attribute_lock: - return self._relogin_interval - - @relogin_interval.setter - def relogin_interval(self, interval: int | None) -> None: - """Set re-login interval. - - Args: - interval (int): The number of minutes between logins. - If set to None, resets to ADT_DEFAULT_RELOGIN_INTERVAL - - Raises: - ValueError: if a relogin interval of less than 10 minutes - is specified - """ - if interval is None: - interval = ADT_DEFAULT_RELOGIN_INTERVAL - else: - self._check_relogin_interval(interval) - with self._attribute_lock: - self._relogin_interval = interval - LOG.debug("relogin interval set to %d", self._relogin_interval) - - @property - def keepalive_interval(self) -> int: - """Get the keepalive interval in minutes. - - Returns: - int: the keepalive interval - """ - with self._attribute_lock: - return self._keepalive_interval - - @keepalive_interval.setter - def keepalive_interval(self, interval: int | None) -> None: - """Set the keepalive interval in minutes. - - If set to None, resets to ADT_DEFAULT_KEEPALIVE_INTERVAL - """ - if interval is None: - interval = ADT_DEFAULT_KEEPALIVE_INTERVAL - else: - self._check_keepalive_interval(interval) - with self._attribute_lock: - self._keepalive_interval = interval - LOG.debug("keepalive interval set to %d", self._keepalive_interval) - - @property - def detailed_debug_logging(self) -> bool: - """Get the detailed debug logging flag.""" - with self._attribute_lock: - return self._detailed_debug_logging - - @detailed_debug_logging.setter - def detailed_debug_logging(self, value: bool) -> None: - """Set detailed debug logging flag.""" - with self._attribute_lock: - self._detailed_debug_logging = value - self._pulse_connection.detailed_debug_logging = value - - @property - def connection_failure_reason(self) -> ConnectionFailureReason: - """Get the connection failure reason.""" - return self._pulse_connection.connection_failure_reason - - async def _update_sites(self, soup: BeautifulSoup) -> None: - with self._attribute_lock: - if self._site is None: - await self._initialize_sites(soup) - if self._site is None: - raise RuntimeError("pyadtpulse could not retrieve site") - self._site.alarm_control_panel.update_alarm_from_soup(soup) - self._site.update_zone_from_soup(soup) - - async def _initialize_sites(self, soup: BeautifulSoup) -> None: - """ - Initializes the sites in the ADT Pulse account. - - Args: - soup (BeautifulSoup): The parsed HTML soup object. - """ - # typically, ADT Pulse accounts have only a single site (premise/location) - single_premise = soup.find("span", {"id": "p_singlePremise"}) - if single_premise: - site_name = single_premise.text - - # FIXME: this code works, but it doesn't pass the linter - signout_link = str( - soup.find("a", {"class": "p_signoutlink"}).get("href") # type: ignore - ) - if signout_link: - m = re.search("networkid=(.+)&", signout_link) - if m and m.group(1) and m.group(1): - site_id = m.group(1) - LOG.debug("Discovered site id %s: %s", site_id, site_name) - new_site = ADTPulseSite(self._pulse_connection, site_id, site_name) - - # fetch zones first, so that we can have the status - # updated with _update_alarm_status - if not await new_site.fetch_devices(None): - LOG.error("Could not fetch zones from ADT site") - new_site.alarm_control_panel.update_alarm_from_soup(soup) - if new_site.alarm_control_panel.status == ADT_ALARM_UNKNOWN: - new_site.gateway.is_online = False - new_site.update_zone_from_soup(soup) - with self._attribute_lock: - self._site = new_site - return - else: - LOG.warning( - "Couldn't find site id for %s in %s", site_name, signout_link - ) - else: - LOG.error("ADT Pulse accounts with MULTIPLE sites not supported!!!") - - # ...and current network id from: - # - # - # ... or perhaps better, just extract all from /system/settings.jsp - - def _get_task_name(self, task, default_name) -> str: - """ - Get the name of a task. - - Parameters: - task (Task): The task object. - default_name (str): The default name to use if the task is None. - - Returns: - str: The name of the task if it is not None, otherwise the default name - with a suffix indicating a possible internal error. - """ - if task is not None: - return task.get_name() - return f"{default_name} - possible internal error" - - def _get_sync_task_name(self) -> str: - return self._get_task_name(self._sync_task, SYNC_CHECK_TASK_NAME) - - def _get_timeout_task_name(self) -> str: - return self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) - - async def _keepalive_task(self) -> None: - """ - Asynchronous function that runs a keepalive task to maintain the connection - with the ADT Pulse cloud. - """ - - async def reset_pulse_cloud_timeout() -> tuple[int, str | None, URL | None]: - return await self._pulse_connection.async_query(ADT_TIMEOUT_URI, "POST") - - async def update_gateway_device_if_needed() -> None: - if self.site.gateway.next_update < time.time(): - await self.site.set_device(ADT_GATEWAY_STRING) - - def should_relogin(relogin_interval: int) -> bool: - return ( - relogin_interval != 0 - and time.time() - self._pulse_connection.last_login_time - > randint(int(0.75 * relogin_interval), relogin_interval) - ) - - response: str | None - task_name: str = self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) - LOG.debug("creating %s", task_name) - - while True: - relogin_interval = self.relogin_interval - try: - await asyncio.sleep(self.keepalive_interval * 60) - if self._pulse_connection.retry_after > time.time(): - LOG.debug( - "%s: Skipping actions because retry_after > now", task_name - ) - continue - if not self.is_connected: - LOG.debug("%s: Skipping relogin because not connected", task_name) - continue - elif should_relogin(relogin_interval): - await self.async_logout() - await self._do_login_with_backoff(task_name) - continue - LOG.debug("Resetting timeout") - code, response, url = await reset_pulse_cloud_timeout() - if ( - not handle_response( - code, - url, - logging.WARNING, - "Could not reset ADT Pulse cloud timeout", - ) - or response is None - ): - continue - await update_gateway_device_if_needed() - - except asyncio.CancelledError: - LOG.debug("%s cancelled", task_name) - return - - async def _cancel_task(self, task: asyncio.Task | None) -> None: - """ - Cancel a given asyncio task. - - Args: - task (asyncio.Task | None): The task to be cancelled. - """ - if task is None: - return - task_name = task.get_name() - LOG.debug("cancelling %s", task_name) - try: - task.cancel() - except asyncio.CancelledError: - LOG.debug("%s successfully cancelled", task_name) - await task - - def _set_update_status(self, value: bool) -> None: - """Sets update failed, sets updates_exist to notify wait_for_update.""" - with self._attribute_lock: - self._update_succeded = value - if self._updates_exist is not None and not self._updates_exist.is_set(): - self._updates_exist.set() - - async def _do_login_with_backoff(self, task_name: str) -> None: - """ - Performs a logout and re-login process. - - Args: - None. - Returns: - None - """ - log_level = logging.DEBUG - login_backoff = 0.0 - login_successful = False - - def compute_login_backoff() -> float: - if login_backoff == 0.0: - return self.site.gateway.poll_interval - return min(ADT_MAX_RELOGIN_BACKOFF, login_backoff * 2.0) - - while not login_successful: - LOG.log( - log_level, "%s logging in with backoff %f", task_name, login_backoff - ) - await asyncio.sleep(login_backoff) - login_successful = await self.async_login() - if login_successful: - if login_backoff != 0.0: - self._set_update_status(True) - return - # only set flag on first failure - if login_backoff == 0.0: - self._set_update_status(False) - login_backoff = compute_login_backoff() - if login_backoff > RELOGIN_BACKOFF_WARNING_THRESHOLD: - log_level = logging.WARNING - - async def _sync_check_task(self) -> None: - """Asynchronous function that performs a synchronization check task.""" - - async def perform_sync_check_query(): - return await self._pulse_connection.async_query( - ADT_SYNC_CHECK_URI, - extra_headers={"Sec-Fetch-Mode": "iframe"}, - extra_params={"ts": str(int(time.time() * 1000))}, - ) - - task_name = self._get_sync_task_name() - LOG.debug("creating %s", task_name) - - response_text: str | None = None - code: int = 200 - last_sync_text = "0-0-0" - last_sync_check_was_different = False - url: URL | None = None - - async def validate_sync_check_response() -> bool: - """ - Validates the sync check response received from the ADT Pulse site. - Returns: - bool: True if the sync check response is valid, False otherwise. - """ - if not handle_response(code, url, logging.ERROR, "Error querying ADT sync"): - self._set_update_status(False) - return False - # this should have already been handled - if response_text is None: - LOG.warning("Internal Error: response_text is None") - return False - pattern = r"\d+[-]\d+[-]\d+" - if not re.match(pattern, response_text): - LOG.warning( - "Unexpected sync check format (%s), forcing re-auth", - response_text, - ) - LOG.debug("Received %s from ADT Pulse site", response_text) - await self.async_logout() - await self._do_login_with_backoff(task_name) - return False - return True - - async def handle_no_updates_exist() -> bool: - if last_sync_check_was_different: - if await self.async_update() is False: - LOG.debug("Pulse data update from %s failed", task_name) - return False - self._updates_exist.set() - return True - else: - if self.detailed_debug_logging: - LOG.debug( - "Sync token %s indicates no remote updates to process", - response_text, - ) - return False - - def handle_updates_exist() -> bool: - if response_text != last_sync_text: - LOG.debug("Updates exist: %s, requerying", response_text) - return True - return False - - while True: - try: - self.site.gateway.adjust_backoff_poll_interval() - pi = ( - self.site.gateway.poll_interval - if not last_sync_check_was_different - else 0.0 - ) - retry_after = self._pulse_connection.retry_after - if retry_after > time.time(): - LOG.debug( - "%s: Waiting for retry after %s", - task_name, - datetime.fromtimestamp(retry_after), - ) - self._set_update_status(False) - await asyncio.sleep(retry_after - time.time()) - continue - await asyncio.sleep(pi) - - code, response_text, url = await perform_sync_check_query() - if not handle_response( - code, url, logging.WARNING, "Error querying ADT sync" - ): - continue - if response_text is None: - LOG.warning("Sync check received no response from ADT Pulse site") - continue - if not await validate_sync_check_response(): - continue - if handle_updates_exist(): - last_sync_check_was_different = True - last_sync_text = response_text - continue - if await handle_no_updates_exist(): - last_sync_check_was_different = False - continue - except asyncio.CancelledError: - LOG.debug("%s cancelled", task_name) - return - def _pulse_session_thread(self) -> None: """ Pulse the session thread. @@ -597,7 +76,7 @@ def _pulse_session_thread(self) -> None: is set to `None`, and the session thread is set to `None`. """ # lock is released in sync_loop() - self._attribute_lock.acquire() + self._p_attribute_lock.acquire() LOG.debug("Creating ADT Pulse background thread") asyncio.set_event_loop_policy(uvloop.EventLoopPolicy()) @@ -616,7 +95,8 @@ async def _sync_loop(self) -> None: This function is responsible for executing the synchronization logic. It starts by calling the `async_login` method to perform the login operation. After that, - it releases the `_attribute_lock` to allow other tasks to access the attributes. + it releases the `_p_attribute_lock` to allow other tasks to access the + attributes. If the login operation was successful, it waits for the `_timeout_task` to complete using the `asyncio.wait` function. If the `_timeout_task` is not set, it raises a `RuntimeError` to indicate that background tasks were not created. @@ -627,7 +107,7 @@ async def _sync_loop(self) -> None: before continuing with the synchronization logic. """ result = await self.async_login() - self._attribute_lock.release() + self._p_attribute_lock.release() if result: if self._timeout_task is not None: task_list = (self._timeout_task,) @@ -652,14 +132,14 @@ def login(self) -> None: Raises: AuthenticationException if could not login """ - self._attribute_lock.acquire() + self._p_attribute_lock.acquire() # probably shouldn't be a daemon thread self._session_thread = thread = Thread( target=self._pulse_session_thread, name="PyADTPulse Session", daemon=True, ) - self._attribute_lock.release() + self._p_attribute_lock.release() self._session_thread.start() time.sleep(1) @@ -667,11 +147,23 @@ def login(self) -> None: # thread will unlock after async_login, so attempt to obtain # lock to block current thread until then # if it's still alive, no exception - self._attribute_lock.acquire() - self._attribute_lock.release() + self._p_attribute_lock.acquire() + self._p_attribute_lock.release() if not thread.is_alive(): raise AuthenticationException(self._username) + def logout(self) -> None: + """Log out of ADT Pulse.""" + loop = self._pulse_connection.check_sync( + "Attempting to call sync logout without sync login" + ) + sync_thread = self._session_thread + + coro = self.async_logout() + asyncio.run_coroutine_threadsafe(coro, loop) + if sync_thread is not None: + sync_thread.join() + @property def attribute_lock(self) -> "RLock| DebugRLock": """Get attribute lock for PyADTPulse object. @@ -679,7 +171,7 @@ def attribute_lock(self) -> "RLock| DebugRLock": Returns: RLock: thread Rlock """ - return self._attribute_lock + return self._p_attribute_lock @property def loop(self) -> asyncio.AbstractEventLoop | None: @@ -691,68 +183,6 @@ def loop(self) -> asyncio.AbstractEventLoop | None: """ return self._pulse_connection.loop - async def async_login(self) -> bool: - """Login asynchronously to ADT. - - Returns: True if login successful - """ - LOG.debug("Authenticating to ADT Pulse cloud service as %s", self._username) - await self._pulse_connection.async_fetch_version() - - soup = await self._pulse_connection.async_do_login_query( - self.username, self._password, self._fingerprint - ) - if soup is None: - return False - # if tasks are started, we've already logged in before - if self._sync_task is not None or self._timeout_task is not None: - return True - await self._update_sites(soup) - if self._site is None: - LOG.error("Could not retrieve any sites, login failed") - await self.async_logout() - return False - - # since we received fresh data on the status of the alarm, go ahead - # and update the sites with the alarm status. - self._timeout_task = asyncio.create_task( - self._keepalive_task(), name=f"{KEEPALIVE_TASK_NAME}" - ) - await asyncio.sleep(0) - return True - - async def async_logout(self) -> None: - """Logout of ADT Pulse async.""" - LOG.info("Logging %s out of ADT Pulse", self._username) - if asyncio.current_task() not in (self._sync_task, self._timeout_task): - await self._cancel_task(self._timeout_task) - await self._cancel_task(self._sync_task) - self._timeout_task = self._sync_task = None - await self._pulse_connection.async_do_logout_query(self.site.id) - - def logout(self) -> None: - """Log out of ADT Pulse.""" - loop = self._pulse_connection.check_sync( - "Attempting to call sync logout without sync login" - ) - sync_thread = self._session_thread - - coro = self.async_logout() - asyncio.run_coroutine_threadsafe(coro, loop) - if sync_thread is not None: - sync_thread.join() - - def _check_update_succeeded(self) -> bool: - """Check if update succeeded, clears the update event and - resets _update_succeeded. - """ - with self._attribute_lock: - old_update_succeded = self._update_succeded - self._update_succeded = True - if self._updates_exist.is_set(): - self._updates_exist.clear() - return old_update_succeded - @property def updates_exist(self) -> bool: """Check if updated data exists. @@ -760,7 +190,7 @@ def updates_exist(self) -> bool: Returns: bool: True if updated data exists """ - with self._attribute_lock: + with self._p_attribute_lock: if self._sync_task is None: loop = self._pulse_connection.loop if loop is None: @@ -774,55 +204,6 @@ def updates_exist(self) -> bool: ) return self._check_update_succeeded() - async def wait_for_update(self) -> bool: - """Wait for update. - - Blocks current async task until Pulse system - signals an update - FIXME?: This code probably won't work with multiple waiters. - """ - with self._attribute_lock: - if self._sync_task is None: - coro = self._sync_check_task() - self._sync_task = asyncio.create_task( - coro, name=f"{SYNC_CHECK_TASK_NAME}: Async session" - ) - if self._updates_exist is None: - raise RuntimeError("Update event does not exist") - - await self._updates_exist.wait() - return self._check_update_succeeded() - - @property - def is_connected(self) -> bool: - """Check if connected to ADT Pulse. - - Returns: - bool: True if connected - """ - return ( - self._pulse_connection.authenticated_flag.is_set() - and self._pulse_connection.retry_after < time.time() - ) - - async def async_update(self) -> bool: - """Update ADT Pulse data. - - Returns: - bool: True if update succeeded. - """ - LOG.debug("Checking ADT Pulse cloud service for updates") - - # FIXME will have to query other URIs for camera/zwave/etc - soup = await self._pulse_connection.query_orb( - logging.INFO, "Error returned from ADT Pulse service check" - ) - if soup is not None: - await self._update_sites(soup) - return True - - return False - def update(self) -> bool: """Update ADT Pulse data. @@ -836,28 +217,3 @@ def update(self) -> bool: "Attempting to run sync update from async login" ), ).result() - - @property - def sites(self) -> list[ADTPulseSite]: - """Return all sites for this ADT Pulse account.""" - warn( - "multiple sites being removed, use pyADTPulse.site instead", - PendingDeprecationWarning, - stacklevel=2, - ) - with self._attribute_lock: - if self._site is None: - raise RuntimeError( - "No sites have been retrieved, have you logged in yet?" - ) - return [self._site] - - @property - def site(self) -> ADTPulseSite: - """Return the site associated with the Pulse login.""" - with self._attribute_lock: - if self._site is None: - raise RuntimeError( - "No sites have been retrieved, have you logged in yet?" - ) - return self._site diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py new file mode 100644 index 0000000..a1668f5 --- /dev/null +++ b/pyadtpulse/pyadtpulse_async.py @@ -0,0 +1,475 @@ +"""ADT Pulse Async API.""" +import logging +import asyncio +import re +import time +from datetime import datetime +from random import randint + +from aiohttp import ClientSession +from bs4 import BeautifulSoup +from yarl import URL + +from .alarm_panel import ADT_ALARM_UNKNOWN +from .const import ( + ADT_DEFAULT_HTTP_USER_AGENT, + ADT_DEFAULT_KEEPALIVE_INTERVAL, + ADT_DEFAULT_RELOGIN_INTERVAL, + ADT_GATEWAY_STRING, + ADT_MAX_RELOGIN_BACKOFF, + ADT_SYNC_CHECK_URI, + ADT_TIMEOUT_URI, + DEFAULT_API_HOST, +) +from .pyadtpulse_properties import PyADTPulseProperties +from .site import ADTPulseSite +from .util import handle_response, set_debug_lock + +LOG = logging.getLogger(__name__) +SYNC_CHECK_TASK_NAME = "ADT Pulse Sync Check Task" +KEEPALIVE_TASK_NAME = "ADT Pulse Keepalive Task" +RELOGIN_BACKOFF_WARNING_THRESHOLD = 5.0 * 60.0 + + +class PyADTPulseAsync(PyADTPulseProperties): + """ADT Pulse Async API.""" + + __slots__ = ("_sync_task", "_timeout_task", "_pa_attribute_lock") + + def __init__( + self, + username: str, + password: str, + fingerprint: str, + service_host: str = DEFAULT_API_HOST, + user_agent=ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"], + websession: ClientSession | None = None, + debug_locks: bool = False, + keepalive_interval: int = ADT_DEFAULT_KEEPALIVE_INTERVAL, + relogin_interval: int = ADT_DEFAULT_RELOGIN_INTERVAL, + detailed_debug_logging: bool = False, + ) -> None: + """Create a PyADTPulse object. + Args: + username (str): Username. + password (str): Password. + fingerprint (str): 2FA fingerprint. + service_host (str, optional): host prefix to use + i.e. https://portal.adtpulse.com or + https://portal-ca.adtpulse.com + user_agent (str, optional): User Agent. + Defaults to ADT_DEFAULT_HTTP_HEADERS["User-Agent"]. + websession (ClientSession, optional): an initialized + aiohttp.ClientSession to use, defaults to None + debug_locks: (bool, optional): use debugging locks + Defaults to False + keepalive_interval (int, optional): number of minutes between + keepalive checks, defaults to ADT_DEFAULT_KEEPALIVE_INTERVAL, + maxiumum is ADT_MAX_KEEPALIVE_INTERVAL + relogin_interval (int, optional): number of minutes between relogin checks + defaults to ADT_DEFAULT_RELOGIN_INTERVAL, + minimum is ADT_MIN_RELOGIN_INTERVAL + detailed_debug_logging (bool, optional): enable detailed debug logging + """ + self._pa_attribute_lock = set_debug_lock( + debug_locks, "pyadtpulse.pa_attribute_lock" + ) + super().__init__( + username, + password, + fingerprint, + service_host, + user_agent, + websession, + debug_locks, + keepalive_interval, + relogin_interval, + detailed_debug_logging, + ) + self._sync_task: asyncio.Task | None = None + self._timeout_task: asyncio.Task | None = None + + def __repr__(self) -> str: + """Object representation.""" + return f"<{self.__class__.__name__}: {self._username}>" + + async def _update_sites(self, soup: BeautifulSoup) -> None: + with self._pa_attribute_lock: + if self._site is None: + await self._initialize_sites(soup) + if self._site is None: + raise RuntimeError("pyadtpulse could not retrieve site") + self.site.alarm_control_panel.update_alarm_from_soup(soup) + self.site.update_zone_from_soup(soup) + + async def _initialize_sites(self, soup: BeautifulSoup) -> None: + """ + Initializes the sites in the ADT Pulse account. + + Args: + soup (BeautifulSoup): The parsed HTML soup object. + """ + # typically, ADT Pulse accounts have only a single site (premise/location) + single_premise = soup.find("span", {"id": "p_singlePremise"}) + if single_premise: + site_name = single_premise.text + + # FIXME: this code works, but it doesn't pass the linter + signout_link = str( + soup.find("a", {"class": "p_signoutlink"}).get("href") # type: ignore + ) + if signout_link: + m = re.search("networkid=(.+)&", signout_link) + if m and m.group(1) and m.group(1): + site_id = m.group(1) + LOG.debug("Discovered site id %s: %s", site_id, site_name) + new_site = ADTPulseSite(self._pulse_connection, site_id, site_name) + + # fetch zones first, so that we can have the status + # updated with _update_alarm_status + if not await new_site.fetch_devices(None): + LOG.error("Could not fetch zones from ADT site") + new_site.alarm_control_panel.update_alarm_from_soup(soup) + if new_site.alarm_control_panel.status == ADT_ALARM_UNKNOWN: + new_site.gateway.is_online = False + new_site.update_zone_from_soup(soup) + self._site = new_site + return + else: + LOG.warning( + "Couldn't find site id for %s in %s", site_name, signout_link + ) + else: + LOG.error("ADT Pulse accounts with MULTIPLE sites not supported!!!") + + # ...and current network id from: + # + # + # ... or perhaps better, just extract all from /system/settings.jsp + + def _get_task_name(self, task: asyncio.Task | None, default_name) -> str: + """ + Get the name of a task. + + Parameters: + task (Task): The task object. + default_name (str): The default name to use if the task is None. + + Returns: + str: The name of the task if it is not None, otherwise the default name + with a suffix indicating a possible internal error. + """ + if task is not None: + return task.get_name() + return f"{default_name} - possible internal error" + + def _get_sync_task_name(self) -> str: + return self._get_task_name(self._sync_task, SYNC_CHECK_TASK_NAME) + + def _get_timeout_task_name(self) -> str: + return self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) + + async def _keepalive_task(self) -> None: + """ + Asynchronous function that runs a keepalive task to maintain the connection + with the ADT Pulse cloud. + """ + + async def reset_pulse_cloud_timeout() -> tuple[int, str | None, URL | None]: + return await self._pulse_connection.async_query(ADT_TIMEOUT_URI, "POST") + + async def update_gateway_device_if_needed() -> None: + if self.site.gateway.next_update < time.time(): + await self.site.set_device(ADT_GATEWAY_STRING) + + def should_relogin(relogin_interval: int) -> bool: + return ( + relogin_interval != 0 + and time.time() - self._pulse_connection.last_login_time + > randint(int(0.75 * relogin_interval), relogin_interval) + ) + + response: str | None + task_name: str = self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) + LOG.debug("creating %s", task_name) + + while True: + relogin_interval = self.relogin_interval + try: + await asyncio.sleep(self.keepalive_interval * 60) + if self._pulse_connection.retry_after > time.time(): + LOG.debug( + "%s: Skipping actions because retry_after > now", task_name + ) + continue + if not self.is_connected: + LOG.debug("%s: Skipping relogin because not connected", task_name) + continue + elif should_relogin(relogin_interval): + await self.async_logout() + await self._do_login_with_backoff(task_name) + continue + LOG.debug("Resetting timeout") + code, response, url = await reset_pulse_cloud_timeout() + if ( + not handle_response( + code, + url, + logging.WARNING, + "Could not reset ADT Pulse cloud timeout", + ) + or response is None + ): + continue + await update_gateway_device_if_needed() + + except asyncio.CancelledError: + LOG.debug("%s cancelled", task_name) + return + + async def _cancel_task(self, task: asyncio.Task | None) -> None: + """ + Cancel a given asyncio task. + + Args: + task (asyncio.Task | None): The task to be cancelled. + """ + if task is None: + return + task_name = task.get_name() + LOG.debug("cancelling %s", task_name) + try: + task.cancel() + except asyncio.CancelledError: + LOG.debug("%s successfully cancelled", task_name) + await task + + async def _do_login_with_backoff(self, task_name: str) -> None: + """ + Performs a logout and re-login process. + + Args: + None. + Returns: + None + """ + log_level = logging.DEBUG + login_backoff = 0.0 + login_successful = False + + def compute_login_backoff() -> float: + if login_backoff == 0.0: + return self.site.gateway.poll_interval + return min(ADT_MAX_RELOGIN_BACKOFF, login_backoff * 2.0) + + while not login_successful: + LOG.log( + log_level, "%s logging in with backoff %f", task_name, login_backoff + ) + await asyncio.sleep(login_backoff) + login_successful = await self.async_login() + if login_successful: + if login_backoff != 0.0: + self._set_update_status(True) + return + # only set flag on first failure + if login_backoff == 0.0: + self._set_update_status(False) + login_backoff = compute_login_backoff() + if login_backoff > RELOGIN_BACKOFF_WARNING_THRESHOLD: + log_level = logging.WARNING + + async def _sync_check_task(self) -> None: + """Asynchronous function that performs a synchronization check task.""" + + async def perform_sync_check_query(): + return await self._pulse_connection.async_query( + ADT_SYNC_CHECK_URI, + extra_headers={"Sec-Fetch-Mode": "iframe"}, + extra_params={"ts": str(int(time.time() * 1000))}, + ) + + task_name = self._get_sync_task_name() + LOG.debug("creating %s", task_name) + + response_text: str | None = None + code: int = 200 + last_sync_text = "0-0-0" + last_sync_check_was_different = False + url: URL | None = None + + async def validate_sync_check_response() -> bool: + """ + Validates the sync check response received from the ADT Pulse site. + Returns: + bool: True if the sync check response is valid, False otherwise. + """ + if not handle_response(code, url, logging.ERROR, "Error querying ADT sync"): + self._set_update_status(False) + return False + # this should have already been handled + if response_text is None: + LOG.warning("Internal Error: response_text is None") + return False + pattern = r"\d+[-]\d+[-]\d+" + if not re.match(pattern, response_text): + LOG.warning( + "Unexpected sync check format (%s), forcing re-auth", + response_text, + ) + LOG.debug("Received %s from ADT Pulse site", response_text) + await self.async_logout() + await self._do_login_with_backoff(task_name) + return False + return True + + async def handle_no_updates_exist() -> bool: + if last_sync_check_was_different: + if await self.async_update() is False: + LOG.debug("Pulse data update from %s failed", task_name) + return False + self._updates_exist.set() + return True + else: + if self.detailed_debug_logging: + LOG.debug( + "Sync token %s indicates no remote updates to process", + response_text, + ) + return False + + def handle_updates_exist() -> bool: + if response_text != last_sync_text: + LOG.debug("Updates exist: %s, requerying", response_text) + return True + return False + + while True: + try: + self.site.gateway.adjust_backoff_poll_interval() + pi = ( + self.site.gateway.poll_interval + if not last_sync_check_was_different + else 0.0 + ) + retry_after = self._pulse_connection.retry_after + if retry_after > time.time(): + LOG.debug( + "%s: Waiting for retry after %s", + task_name, + datetime.fromtimestamp(retry_after), + ) + self._set_update_status(False) + await asyncio.sleep(retry_after - time.time()) + continue + await asyncio.sleep(pi) + + code, response_text, url = await perform_sync_check_query() + if not handle_response( + code, url, logging.WARNING, "Error querying ADT sync" + ): + continue + if response_text is None: + LOG.warning("Sync check received no response from ADT Pulse site") + continue + if not await validate_sync_check_response(): + continue + if handle_updates_exist(): + last_sync_check_was_different = True + last_sync_text = response_text + continue + if await handle_no_updates_exist(): + last_sync_check_was_different = False + continue + except asyncio.CancelledError: + LOG.debug("%s cancelled", task_name) + return + + async def async_login(self) -> bool: + """Login asynchronously to ADT. + + Returns: True if login successful + """ + LOG.debug("Authenticating to ADT Pulse cloud service as %s", self._username) + await self._pulse_connection.async_fetch_version() + + soup = await self._pulse_connection.async_do_login_query( + self.username, self._password, self._fingerprint + ) + if soup is None: + return False + # if tasks are started, we've already logged in before + if self._sync_task is not None or self._timeout_task is not None: + return True + await self._update_sites(soup) + if self._site is None: + LOG.error("Could not retrieve any sites, login failed") + await self.async_logout() + return False + + # since we received fresh data on the status of the alarm, go ahead + # and update the sites with the alarm status. + self._timeout_task = asyncio.create_task( + self._keepalive_task(), name=f"{KEEPALIVE_TASK_NAME}" + ) + await asyncio.sleep(0) + return True + + async def async_logout(self) -> None: + """Logout of ADT Pulse async.""" + LOG.info("Logging %s out of ADT Pulse", self._username) + if asyncio.current_task() not in (self._sync_task, self._timeout_task): + await self._cancel_task(self._timeout_task) + await self._cancel_task(self._sync_task) + self._timeout_task = self._sync_task = None + await self._pulse_connection.async_do_logout_query(self.site.id) + + async def async_update(self) -> bool: + """Update ADT Pulse data. + + Returns: + bool: True if update succeeded. + """ + LOG.debug("Checking ADT Pulse cloud service for updates") + + # FIXME will have to query other URIs for camera/zwave/etc + soup = await self._pulse_connection.query_orb( + logging.INFO, "Error returned from ADT Pulse service check" + ) + if soup is not None: + await self._update_sites(soup) + return True + + return False + + async def wait_for_update(self) -> bool: + """Wait for update. + + Blocks current async task until Pulse system + signals an update + FIXME?: This code probably won't work with multiple waiters. + """ + with self._pa_attribute_lock: + if self._sync_task is None: + coro = self._sync_check_task() + self._sync_task = asyncio.create_task( + coro, name=f"{SYNC_CHECK_TASK_NAME}: Async session" + ) + if self._updates_exist is None: + raise RuntimeError("Update event does not exist") + + await self._updates_exist.wait() + return self._check_update_succeeded() + + def _check_update_succeeded(self) -> bool: + """Check if update succeeded, clears the update event and + resets _update_succeeded. + """ + with self._pa_attribute_lock: + old_update_succeded = self._update_succeded + self._update_succeded = True + if self._updates_exist.is_set(): + self._updates_exist.clear() + return old_update_succeded diff --git a/pyadtpulse/pyadtpulse_properties.py b/pyadtpulse/pyadtpulse_properties.py new file mode 100644 index 0000000..cc79a51 --- /dev/null +++ b/pyadtpulse/pyadtpulse_properties.py @@ -0,0 +1,291 @@ +"""PyADTPulse Properties.""" +import logging +import asyncio +import time +from warnings import warn + +from aiohttp import ClientSession + +from .const import ( + ADT_DEFAULT_HTTP_USER_AGENT, + ADT_DEFAULT_KEEPALIVE_INTERVAL, + ADT_DEFAULT_RELOGIN_INTERVAL, + ADT_MAX_KEEPALIVE_INTERVAL, + ADT_MIN_RELOGIN_INTERVAL, + DEFAULT_API_HOST, + ConnectionFailureReason, +) +from .pulse_connection import ADTPulseConnection +from .site import ADTPulseSite +from .util import set_debug_lock + +LOG = logging.getLogger(__name__) + + +class PyADTPulseProperties: + """PyADTPulse Properties.""" + + __slots__ = ( + "_pulse_connection", + "_authenticated", + "_updates_exist", + "_pp_attribute_lock", + "_site", + "_username", + "_password", + "_fingerprint", + "_login_exception", + "_relogin_interval", + "_keepalive_interval", + "_update_succeded", + "_detailed_debug_logging", + ) + + @staticmethod + def _check_keepalive_interval(keepalive_interval: int) -> None: + if keepalive_interval > ADT_MAX_KEEPALIVE_INTERVAL or keepalive_interval <= 0: + raise ValueError( + f"keepalive interval ({keepalive_interval}) must be " + f"greater than 0 and less than {ADT_MAX_KEEPALIVE_INTERVAL}" + ) + + @staticmethod + def _check_relogin_interval(relogin_interval: int) -> None: + if relogin_interval < ADT_MIN_RELOGIN_INTERVAL: + raise ValueError( + f"relogin interval ({relogin_interval}) must be " + f"greater than {ADT_MIN_RELOGIN_INTERVAL}" + ) + + def __init__( + self, + username: str, + password: str, + fingerprint: str, + service_host: str = DEFAULT_API_HOST, + user_agent=ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"], + websession: ClientSession | None = None, + debug_locks: bool = False, + keepalive_interval: int = ADT_DEFAULT_KEEPALIVE_INTERVAL, + relogin_interval: int = ADT_DEFAULT_RELOGIN_INTERVAL, + detailed_debug_logging: bool = False, + ) -> None: + """Create a PyADTPulse properties object. + Args: + username (str): Username. + password (str): Password. + fingerprint (str): 2FA fingerprint. + service_host (str, optional): host prefix to use + i.e. https://portal.adtpulse.com or + https://portal-ca.adtpulse.com + user_agent (str, optional): User Agent. + Defaults to ADT_DEFAULT_HTTP_HEADERS["User-Agent"]. + websession (ClientSession, optional): an initialized + aiohttp.ClientSession to use, defaults to None + debug_locks: (bool, optional): use debugging locks + Defaults to False + keepalive_interval (int, optional): number of minutes between + keepalive checks, defaults to ADT_DEFAULT_KEEPALIVE_INTERVAL, + maxiumum is ADT_MAX_KEEPALIVE_INTERVAL + relogin_interval (int, optional): number of minutes between relogin checks + defaults to ADT_DEFAULT_RELOGIN_INTERVAL, + minimum is ADT_MIN_RELOGIN_INTERVAL + detailed_debug_logging (bool, optional): enable detailed debug logging + """ + self._init_login_info(username, password, fingerprint) + self._pulse_connection = ADTPulseConnection( + service_host, + session=websession, + user_agent=user_agent, + debug_locks=debug_locks, + detailed_debug_logging=detailed_debug_logging, + ) + # FIXME use thread event/condition, regular condition? + # defer initialization to make sure we have an event loop + self._login_exception: BaseException | None = None + + self._updates_exist = asyncio.locks.Event() + + self._pp_attribute_lock = set_debug_lock( + debug_locks, "pyadtpulse.async_attribute_lock" + ) + + self._site: ADTPulseSite | None = None + self.keepalive_interval = keepalive_interval + self.relogin_interval = relogin_interval + self._detailed_debug_logging = detailed_debug_logging + self._update_succeded = True + + def __repr__(self) -> str: + """Object representation.""" + return f"<{self.__class__.__name__}: {self._username}>" + + def _init_login_info(self, username: str, password: str, fingerprint: str) -> None: + """Initialize login info. + + Raises: + ValueError: if login parameters are not valid. + """ + ADTPulseConnection.check_login_parameters(username, password, fingerprint) + self._username = username + self._password = password + self._fingerprint = fingerprint + + @property + def service_host(self) -> str: + """Get the Pulse host. + + Returns: (str): the ADT Pulse endpoint host + """ + return self._pulse_connection.service_host + + @service_host.setter + def service_host(self, host: str) -> None: + """Override the Pulse host (i.e. to use portal-ca.adpulse.com). + + Args: + host (str): name of Pulse endpoint host + """ + ADTPulseConnection.check_service_host(host) + with self._pp_attribute_lock: + self._pulse_connection.service_host = host + + def set_service_host(self, host: str) -> None: + """Backward compatibility for service host property setter.""" + self.service_host = host + + @property + def username(self) -> str: + """Get username. + + Returns: + str: the username + """ + with self._pp_attribute_lock: + return self._username + + @property + def version(self) -> str: + """Get the ADT Pulse site version. + + Returns: + str: a string containing the version + """ + return self._pulse_connection.api_version + + @property + def relogin_interval(self) -> int: + """Get re-login interval. + + Returns: + int: number of minutes to re-login to Pulse + 0 means disabled + """ + with self._pp_attribute_lock: + return self._relogin_interval + + @relogin_interval.setter + def relogin_interval(self, interval: int | None) -> None: + """Set re-login interval. + + Args: + interval (int): The number of minutes between logins. + If set to None, resets to ADT_DEFAULT_RELOGIN_INTERVAL + + Raises: + ValueError: if a relogin interval of less than 10 minutes + is specified + """ + if interval is None: + interval = ADT_DEFAULT_RELOGIN_INTERVAL + else: + self._check_relogin_interval(interval) + with self._pp_attribute_lock: + self._relogin_interval = interval + LOG.debug("relogin interval set to %d", self._relogin_interval) + + @property + def keepalive_interval(self) -> int: + """Get the keepalive interval in minutes. + + Returns: + int: the keepalive interval + """ + with self._pp_attribute_lock: + return self._keepalive_interval + + @keepalive_interval.setter + def keepalive_interval(self, interval: int | None) -> None: + """Set the keepalive interval in minutes. + + If set to None, resets to ADT_DEFAULT_KEEPALIVE_INTERVAL + """ + if interval is None: + interval = ADT_DEFAULT_KEEPALIVE_INTERVAL + else: + self._check_keepalive_interval(interval) + with self._pp_attribute_lock: + self._keepalive_interval = interval + LOG.debug("keepalive interval set to %d", self._keepalive_interval) + + @property + def detailed_debug_logging(self) -> bool: + """Get the detailed debug logging flag.""" + with self._pp_attribute_lock: + return self._detailed_debug_logging + + @detailed_debug_logging.setter + def detailed_debug_logging(self, value: bool) -> None: + """Set detailed debug logging flag.""" + with self._pp_attribute_lock: + self._detailed_debug_logging = value + self._pulse_connection.detailed_debug_logging = value + + @property + def connection_failure_reason(self) -> ConnectionFailureReason: + """Get the connection failure reason.""" + return self._pulse_connection.connection_failure_reason + + @property + def sites(self) -> list[ADTPulseSite]: + """Return all sites for this ADT Pulse account.""" + warn( + "multiple sites being removed, use pyADTPulse.site instead", + PendingDeprecationWarning, + stacklevel=2, + ) + with self._pp_attribute_lock: + if self._site is None: + raise RuntimeError( + "No sites have been retrieved, have you logged in yet?" + ) + return [self._site] + + @property + def site(self) -> ADTPulseSite: + """Return the site associated with the Pulse login.""" + with self._pp_attribute_lock: + if self._site is None: + raise RuntimeError( + "No sites have been retrieved, have you logged in yet?" + ) + return self._site + + @property + def is_connected(self) -> bool: + """Check if connected to ADT Pulse. + + Returns: + bool: True if connected + """ + return ( + self._pulse_connection.authenticated_flag.is_set() + and self._pulse_connection.retry_after < time.time() + ) + + def _set_update_status(self, value: bool) -> None: + """Sets update failed, sets updates_exist to notify wait_for_update.""" + with self._pp_attribute_lock: + self._update_succeded = value + if self._updates_exist is not None and not self._updates_exist.is_set(): + self._updates_exist.set() From d52e758b5077276961ae127bb19304f616caecd2 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 10 Nov 2023 04:36:04 -0500 Subject: [PATCH 103/226] add bs4 dependency --- poetry.lock | 15 ++++++++++++++- pyproject.toml | 1 + 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/poetry.lock b/poetry.lock index 3f3886d..94492e3 100644 --- a/poetry.lock +++ b/poetry.lock @@ -220,6 +220,19 @@ d = ["aiohttp (>=3.7.4)"] jupyter = ["ipython (>=7.8.0)", "tokenize-rt (>=3.2.0)"] uvloop = ["uvloop (>=0.15.2)"] +[[package]] +name = "bs4" +version = "0.0.1" +description = "Dummy package for Beautiful Soup" +optional = false +python-versions = "*" +files = [ + {file = "bs4-0.0.1.tar.gz", hash = "sha256:36ecea1fd7cc5c0c6e4a1ff075df26d50da647b75376626cc186e2212886dd3a"}, +] + +[package.dependencies] +beautifulsoup4 = "*" + [[package]] name = "cfgv" version = "3.4.0" @@ -1308,4 +1321,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "4cb38e53cebc017eec0cd04d33d97a029eaced4d8565dbac5239504e886c9e38" +content-hash = "7e42a0574418c6dabd74bb9f7a0c98ab9ea59deac0ce842d7a1c838c516ffa0a" diff --git a/pyproject.toml b/pyproject.toml index c083c23..4a986c4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -24,6 +24,7 @@ python = "^3.11" aiohttp = "3.8.4" beautifulsoup4 = "^4.12.2" uvloop = "^0.19.0" +bs4 = "^0.0.1" [tool.poetry.urls] From 28d17503156c7379e65272a2e16c4f23755f21fb Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 10 Nov 2023 05:11:14 -0500 Subject: [PATCH 104/226] don't use aiohttp 3.8.6 --- poetry.lock | 178 ++++++++++++++++++++++++------------------------- pyproject.toml | 2 +- 2 files changed, 90 insertions(+), 90 deletions(-) diff --git a/poetry.lock b/poetry.lock index 94492e3..0d6a8e3 100644 --- a/poetry.lock +++ b/poetry.lock @@ -2,98 +2,98 @@ [[package]] name = "aiohttp" -version = "3.8.4" +version = "3.8.5" description = "Async http client/server framework (asyncio)" optional = false python-versions = ">=3.6" files = [ - {file = "aiohttp-3.8.4-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:5ce45967538fb747370308d3145aa68a074bdecb4f3a300869590f725ced69c1"}, - {file = "aiohttp-3.8.4-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:b744c33b6f14ca26b7544e8d8aadff6b765a80ad6164fb1a430bbadd593dfb1a"}, - {file = "aiohttp-3.8.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:1a45865451439eb320784918617ba54b7a377e3501fb70402ab84d38c2cd891b"}, - {file = "aiohttp-3.8.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a86d42d7cba1cec432d47ab13b6637bee393a10f664c425ea7b305d1301ca1a3"}, - {file = "aiohttp-3.8.4-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ee3c36df21b5714d49fc4580247947aa64bcbe2939d1b77b4c8dcb8f6c9faecc"}, - {file = "aiohttp-3.8.4-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:176a64b24c0935869d5bbc4c96e82f89f643bcdf08ec947701b9dbb3c956b7dd"}, - {file = "aiohttp-3.8.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c844fd628851c0bc309f3c801b3a3d58ce430b2ce5b359cd918a5a76d0b20cb5"}, - {file = "aiohttp-3.8.4-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:5393fb786a9e23e4799fec788e7e735de18052f83682ce2dfcabaf1c00c2c08e"}, - {file = "aiohttp-3.8.4-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:e4b09863aae0dc965c3ef36500d891a3ff495a2ea9ae9171e4519963c12ceefd"}, - {file = "aiohttp-3.8.4-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:adfbc22e87365a6e564c804c58fc44ff7727deea782d175c33602737b7feadb6"}, - {file = "aiohttp-3.8.4-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:147ae376f14b55f4f3c2b118b95be50a369b89b38a971e80a17c3fd623f280c9"}, - {file = "aiohttp-3.8.4-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:eafb3e874816ebe2a92f5e155f17260034c8c341dad1df25672fb710627c6949"}, - {file = "aiohttp-3.8.4-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:c6cc15d58053c76eacac5fa9152d7d84b8d67b3fde92709195cb984cfb3475ea"}, - {file = "aiohttp-3.8.4-cp310-cp310-win32.whl", hash = "sha256:59f029a5f6e2d679296db7bee982bb3d20c088e52a2977e3175faf31d6fb75d1"}, - {file = "aiohttp-3.8.4-cp310-cp310-win_amd64.whl", hash = "sha256:fe7ba4a51f33ab275515f66b0a236bcde4fb5561498fe8f898d4e549b2e4509f"}, - {file = "aiohttp-3.8.4-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:3d8ef1a630519a26d6760bc695842579cb09e373c5f227a21b67dc3eb16cfea4"}, - {file = "aiohttp-3.8.4-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:5b3f2e06a512e94722886c0827bee9807c86a9f698fac6b3aee841fab49bbfb4"}, - {file = "aiohttp-3.8.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:3a80464982d41b1fbfe3154e440ba4904b71c1a53e9cd584098cd41efdb188ef"}, - {file = "aiohttp-3.8.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8b631e26df63e52f7cce0cce6507b7a7f1bc9b0c501fcde69742130b32e8782f"}, - {file = "aiohttp-3.8.4-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3f43255086fe25e36fd5ed8f2ee47477408a73ef00e804cb2b5cba4bf2ac7f5e"}, - {file = "aiohttp-3.8.4-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4d347a172f866cd1d93126d9b239fcbe682acb39b48ee0873c73c933dd23bd0f"}, - {file = "aiohttp-3.8.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a3fec6a4cb5551721cdd70473eb009d90935b4063acc5f40905d40ecfea23e05"}, - {file = "aiohttp-3.8.4-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:80a37fe8f7c1e6ce8f2d9c411676e4bc633a8462844e38f46156d07a7d401654"}, - {file = "aiohttp-3.8.4-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:d1e6a862b76f34395a985b3cd39a0d949ca80a70b6ebdea37d3ab39ceea6698a"}, - {file = "aiohttp-3.8.4-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:cd468460eefef601ece4428d3cf4562459157c0f6523db89365202c31b6daebb"}, - {file = "aiohttp-3.8.4-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:618c901dd3aad4ace71dfa0f5e82e88b46ef57e3239fc7027773cb6d4ed53531"}, - {file = "aiohttp-3.8.4-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:652b1bff4f15f6287550b4670546a2947f2a4575b6c6dff7760eafb22eacbf0b"}, - {file = "aiohttp-3.8.4-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:80575ba9377c5171407a06d0196b2310b679dc752d02a1fcaa2bc20b235dbf24"}, - {file = "aiohttp-3.8.4-cp311-cp311-win32.whl", hash = "sha256:bbcf1a76cf6f6dacf2c7f4d2ebd411438c275faa1dc0c68e46eb84eebd05dd7d"}, - {file = "aiohttp-3.8.4-cp311-cp311-win_amd64.whl", hash = "sha256:6e74dd54f7239fcffe07913ff8b964e28b712f09846e20de78676ce2a3dc0bfc"}, - {file = "aiohttp-3.8.4-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:880e15bb6dad90549b43f796b391cfffd7af373f4646784795e20d92606b7a51"}, - {file = "aiohttp-3.8.4-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bb96fa6b56bb536c42d6a4a87dfca570ff8e52de2d63cabebfd6fb67049c34b6"}, - {file = "aiohttp-3.8.4-cp36-cp36m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4a6cadebe132e90cefa77e45f2d2f1a4b2ce5c6b1bfc1656c1ddafcfe4ba8131"}, - {file = "aiohttp-3.8.4-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f352b62b45dff37b55ddd7b9c0c8672c4dd2eb9c0f9c11d395075a84e2c40f75"}, - {file = "aiohttp-3.8.4-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7ab43061a0c81198d88f39aaf90dae9a7744620978f7ef3e3708339b8ed2ef01"}, - {file = "aiohttp-3.8.4-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c9cb1565a7ad52e096a6988e2ee0397f72fe056dadf75d17fa6b5aebaea05622"}, - {file = "aiohttp-3.8.4-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:1b3ea7edd2d24538959c1c1abf97c744d879d4e541d38305f9bd7d9b10c9ec41"}, - {file = "aiohttp-3.8.4-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:7c7837fe8037e96b6dd5cfcf47263c1620a9d332a87ec06a6ca4564e56bd0f36"}, - {file = "aiohttp-3.8.4-cp36-cp36m-musllinux_1_1_ppc64le.whl", hash = "sha256:3b90467ebc3d9fa5b0f9b6489dfb2c304a1db7b9946fa92aa76a831b9d587e99"}, - {file = "aiohttp-3.8.4-cp36-cp36m-musllinux_1_1_s390x.whl", hash = "sha256:cab9401de3ea52b4b4c6971db5fb5c999bd4260898af972bf23de1c6b5dd9d71"}, - {file = "aiohttp-3.8.4-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:d1f9282c5f2b5e241034a009779e7b2a1aa045f667ff521e7948ea9b56e0c5ff"}, - {file = "aiohttp-3.8.4-cp36-cp36m-win32.whl", hash = "sha256:5e14f25765a578a0a634d5f0cd1e2c3f53964553a00347998dfdf96b8137f777"}, - {file = "aiohttp-3.8.4-cp36-cp36m-win_amd64.whl", hash = "sha256:4c745b109057e7e5f1848c689ee4fb3a016c8d4d92da52b312f8a509f83aa05e"}, - {file = "aiohttp-3.8.4-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:aede4df4eeb926c8fa70de46c340a1bc2c6079e1c40ccf7b0eae1313ffd33519"}, - {file = "aiohttp-3.8.4-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4ddaae3f3d32fc2cb4c53fab020b69a05c8ab1f02e0e59665c6f7a0d3a5be54f"}, - {file = "aiohttp-3.8.4-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c4eb3b82ca349cf6fadcdc7abcc8b3a50ab74a62e9113ab7a8ebc268aad35bb9"}, - {file = "aiohttp-3.8.4-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9bcb89336efa095ea21b30f9e686763f2be4478f1b0a616969551982c4ee4c3b"}, - {file = "aiohttp-3.8.4-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c08e8ed6fa3d477e501ec9db169bfac8140e830aa372d77e4a43084d8dd91ab"}, - {file = "aiohttp-3.8.4-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c6cd05ea06daca6ad6a4ca3ba7fe7dc5b5de063ff4daec6170ec0f9979f6c332"}, - {file = "aiohttp-3.8.4-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:b7a00a9ed8d6e725b55ef98b1b35c88013245f35f68b1b12c5cd4100dddac333"}, - {file = "aiohttp-3.8.4-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:de04b491d0e5007ee1b63a309956eaed959a49f5bb4e84b26c8f5d49de140fa9"}, - {file = "aiohttp-3.8.4-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:40653609b3bf50611356e6b6554e3a331f6879fa7116f3959b20e3528783e699"}, - {file = "aiohttp-3.8.4-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:dbf3a08a06b3f433013c143ebd72c15cac33d2914b8ea4bea7ac2c23578815d6"}, - {file = "aiohttp-3.8.4-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:854f422ac44af92bfe172d8e73229c270dc09b96535e8a548f99c84f82dde241"}, - {file = "aiohttp-3.8.4-cp37-cp37m-win32.whl", hash = "sha256:aeb29c84bb53a84b1a81c6c09d24cf33bb8432cc5c39979021cc0f98c1292a1a"}, - {file = "aiohttp-3.8.4-cp37-cp37m-win_amd64.whl", hash = "sha256:db3fc6120bce9f446d13b1b834ea5b15341ca9ff3f335e4a951a6ead31105480"}, - {file = "aiohttp-3.8.4-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:fabb87dd8850ef0f7fe2b366d44b77d7e6fa2ea87861ab3844da99291e81e60f"}, - {file = "aiohttp-3.8.4-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:91f6d540163f90bbaef9387e65f18f73ffd7c79f5225ac3d3f61df7b0d01ad15"}, - {file = "aiohttp-3.8.4-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:d265f09a75a79a788237d7f9054f929ced2e69eb0bb79de3798c468d8a90f945"}, - {file = "aiohttp-3.8.4-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3d89efa095ca7d442a6d0cbc755f9e08190ba40069b235c9886a8763b03785da"}, - {file = "aiohttp-3.8.4-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4dac314662f4e2aa5009977b652d9b8db7121b46c38f2073bfeed9f4049732cd"}, - {file = "aiohttp-3.8.4-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:fe11310ae1e4cd560035598c3f29d86cef39a83d244c7466f95c27ae04850f10"}, - {file = "aiohttp-3.8.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6ddb2a2026c3f6a68c3998a6c47ab6795e4127315d2e35a09997da21865757f8"}, - {file = "aiohttp-3.8.4-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e75b89ac3bd27d2d043b234aa7b734c38ba1b0e43f07787130a0ecac1e12228a"}, - {file = "aiohttp-3.8.4-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:6e601588f2b502c93c30cd5a45bfc665faaf37bbe835b7cfd461753068232074"}, - {file = "aiohttp-3.8.4-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:a5d794d1ae64e7753e405ba58e08fcfa73e3fad93ef9b7e31112ef3c9a0efb52"}, - {file = "aiohttp-3.8.4-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:a1f4689c9a1462f3df0a1f7e797791cd6b124ddbee2b570d34e7f38ade0e2c71"}, - {file = "aiohttp-3.8.4-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:3032dcb1c35bc330134a5b8a5d4f68c1a87252dfc6e1262c65a7e30e62298275"}, - {file = "aiohttp-3.8.4-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:8189c56eb0ddbb95bfadb8f60ea1b22fcfa659396ea36f6adcc521213cd7b44d"}, - {file = "aiohttp-3.8.4-cp38-cp38-win32.whl", hash = "sha256:33587f26dcee66efb2fff3c177547bd0449ab7edf1b73a7f5dea1e38609a0c54"}, - {file = "aiohttp-3.8.4-cp38-cp38-win_amd64.whl", hash = "sha256:e595432ac259af2d4630008bf638873d69346372d38255774c0e286951e8b79f"}, - {file = "aiohttp-3.8.4-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:5a7bdf9e57126dc345b683c3632e8ba317c31d2a41acd5800c10640387d193ed"}, - {file = "aiohttp-3.8.4-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:22f6eab15b6db242499a16de87939a342f5a950ad0abaf1532038e2ce7d31567"}, - {file = "aiohttp-3.8.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:7235604476a76ef249bd64cb8274ed24ccf6995c4a8b51a237005ee7a57e8643"}, - {file = "aiohttp-3.8.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ea9eb976ffdd79d0e893869cfe179a8f60f152d42cb64622fca418cd9b18dc2a"}, - {file = "aiohttp-3.8.4-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:92c0cea74a2a81c4c76b62ea1cac163ecb20fb3ba3a75c909b9fa71b4ad493cf"}, - {file = "aiohttp-3.8.4-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:493f5bc2f8307286b7799c6d899d388bbaa7dfa6c4caf4f97ef7521b9cb13719"}, - {file = "aiohttp-3.8.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0a63f03189a6fa7c900226e3ef5ba4d3bd047e18f445e69adbd65af433add5a2"}, - {file = "aiohttp-3.8.4-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:10c8cefcff98fd9168cdd86c4da8b84baaa90bf2da2269c6161984e6737bf23e"}, - {file = "aiohttp-3.8.4-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:bca5f24726e2919de94f047739d0a4fc01372801a3672708260546aa2601bf57"}, - {file = "aiohttp-3.8.4-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:03baa76b730e4e15a45f81dfe29a8d910314143414e528737f8589ec60cf7391"}, - {file = "aiohttp-3.8.4-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:8c29c77cc57e40f84acef9bfb904373a4e89a4e8b74e71aa8075c021ec9078c2"}, - {file = "aiohttp-3.8.4-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:03543dcf98a6619254b409be2d22b51f21ec66272be4ebda7b04e6412e4b2e14"}, - {file = "aiohttp-3.8.4-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:17b79c2963db82086229012cff93ea55196ed31f6493bb1ccd2c62f1724324e4"}, - {file = "aiohttp-3.8.4-cp39-cp39-win32.whl", hash = "sha256:34ce9f93a4a68d1272d26030655dd1b58ff727b3ed2a33d80ec433561b03d67a"}, - {file = "aiohttp-3.8.4-cp39-cp39-win_amd64.whl", hash = "sha256:41a86a69bb63bb2fc3dc9ad5ea9f10f1c9c8e282b471931be0268ddd09430b04"}, - {file = "aiohttp-3.8.4.tar.gz", hash = "sha256:bf2e1a9162c1e441bf805a1fd166e249d574ca04e03b34f97e2928769e91ab5c"}, + {file = "aiohttp-3.8.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a94159871304770da4dd371f4291b20cac04e8c94f11bdea1c3478e557fbe0d8"}, + {file = "aiohttp-3.8.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:13bf85afc99ce6f9ee3567b04501f18f9f8dbbb2ea11ed1a2e079670403a7c84"}, + {file = "aiohttp-3.8.5-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:2ce2ac5708501afc4847221a521f7e4b245abf5178cf5ddae9d5b3856ddb2f3a"}, + {file = "aiohttp-3.8.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:96943e5dcc37a6529d18766597c491798b7eb7a61d48878611298afc1fca946c"}, + {file = "aiohttp-3.8.5-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:2ad5c3c4590bb3cc28b4382f031f3783f25ec223557124c68754a2231d989e2b"}, + {file = "aiohttp-3.8.5-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:0c413c633d0512df4dc7fd2373ec06cc6a815b7b6d6c2f208ada7e9e93a5061d"}, + {file = "aiohttp-3.8.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:df72ac063b97837a80d80dec8d54c241af059cc9bb42c4de68bd5b61ceb37caa"}, + {file = "aiohttp-3.8.5-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c48c5c0271149cfe467c0ff8eb941279fd6e3f65c9a388c984e0e6cf57538e14"}, + {file = "aiohttp-3.8.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:368a42363c4d70ab52c2c6420a57f190ed3dfaca6a1b19afda8165ee16416a82"}, + {file = "aiohttp-3.8.5-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:7607ec3ce4993464368505888af5beb446845a014bc676d349efec0e05085905"}, + {file = "aiohttp-3.8.5-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:0d21c684808288a98914e5aaf2a7c6a3179d4df11d249799c32d1808e79503b5"}, + {file = "aiohttp-3.8.5-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:312fcfbacc7880a8da0ae8b6abc6cc7d752e9caa0051a53d217a650b25e9a691"}, + {file = "aiohttp-3.8.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:ad093e823df03bb3fd37e7dec9d4670c34f9e24aeace76808fc20a507cace825"}, + {file = "aiohttp-3.8.5-cp310-cp310-win32.whl", hash = "sha256:33279701c04351a2914e1100b62b2a7fdb9a25995c4a104259f9a5ead7ed4802"}, + {file = "aiohttp-3.8.5-cp310-cp310-win_amd64.whl", hash = "sha256:6e4a280e4b975a2e7745573e3fc9c9ba0d1194a3738ce1cbaa80626cc9b4f4df"}, + {file = "aiohttp-3.8.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:ae871a964e1987a943d83d6709d20ec6103ca1eaf52f7e0d36ee1b5bebb8b9b9"}, + {file = "aiohttp-3.8.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:461908b2578955045efde733719d62f2b649c404189a09a632d245b445c9c975"}, + {file = "aiohttp-3.8.5-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:72a860c215e26192379f57cae5ab12b168b75db8271f111019509a1196dfc780"}, + {file = "aiohttp-3.8.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cc14be025665dba6202b6a71cfcdb53210cc498e50068bc088076624471f8bb9"}, + {file = "aiohttp-3.8.5-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8af740fc2711ad85f1a5c034a435782fbd5b5f8314c9a3ef071424a8158d7f6b"}, + {file = "aiohttp-3.8.5-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:841cd8233cbd2111a0ef0a522ce016357c5e3aff8a8ce92bcfa14cef890d698f"}, + {file = "aiohttp-3.8.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5ed1c46fb119f1b59304b5ec89f834f07124cd23ae5b74288e364477641060ff"}, + {file = "aiohttp-3.8.5-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:84f8ae3e09a34f35c18fa57f015cc394bd1389bce02503fb30c394d04ee6b938"}, + {file = "aiohttp-3.8.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:62360cb771707cb70a6fd114b9871d20d7dd2163a0feafe43fd115cfe4fe845e"}, + {file = "aiohttp-3.8.5-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:23fb25a9f0a1ca1f24c0a371523546366bb642397c94ab45ad3aedf2941cec6a"}, + {file = "aiohttp-3.8.5-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:b0ba0d15164eae3d878260d4c4df859bbdc6466e9e6689c344a13334f988bb53"}, + {file = "aiohttp-3.8.5-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:5d20003b635fc6ae3f96d7260281dfaf1894fc3aa24d1888a9b2628e97c241e5"}, + {file = "aiohttp-3.8.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:0175d745d9e85c40dcc51c8f88c74bfbaef9e7afeeeb9d03c37977270303064c"}, + {file = "aiohttp-3.8.5-cp311-cp311-win32.whl", hash = "sha256:2e1b1e51b0774408f091d268648e3d57f7260c1682e7d3a63cb00d22d71bb945"}, + {file = "aiohttp-3.8.5-cp311-cp311-win_amd64.whl", hash = "sha256:043d2299f6dfdc92f0ac5e995dfc56668e1587cea7f9aa9d8a78a1b6554e5755"}, + {file = "aiohttp-3.8.5-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:cae533195e8122584ec87531d6df000ad07737eaa3c81209e85c928854d2195c"}, + {file = "aiohttp-3.8.5-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4f21e83f355643c345177a5d1d8079f9f28b5133bcd154193b799d380331d5d3"}, + {file = "aiohttp-3.8.5-cp36-cp36m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a7a75ef35f2df54ad55dbf4b73fe1da96f370e51b10c91f08b19603c64004acc"}, + {file = "aiohttp-3.8.5-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2e2e9839e14dd5308ee773c97115f1e0a1cb1d75cbeeee9f33824fa5144c7634"}, + {file = "aiohttp-3.8.5-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c44e65da1de4403d0576473e2344828ef9c4c6244d65cf4b75549bb46d40b8dd"}, + {file = "aiohttp-3.8.5-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:78d847e4cde6ecc19125ccbc9bfac4a7ab37c234dd88fbb3c5c524e8e14da543"}, + {file = "aiohttp-3.8.5-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:c7a815258e5895d8900aec4454f38dca9aed71085f227537208057853f9d13f2"}, + {file = "aiohttp-3.8.5-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:8b929b9bd7cd7c3939f8bcfffa92fae7480bd1aa425279d51a89327d600c704d"}, + {file = "aiohttp-3.8.5-cp36-cp36m-musllinux_1_1_ppc64le.whl", hash = "sha256:5db3a5b833764280ed7618393832e0853e40f3d3e9aa128ac0ba0f8278d08649"}, + {file = "aiohttp-3.8.5-cp36-cp36m-musllinux_1_1_s390x.whl", hash = "sha256:a0215ce6041d501f3155dc219712bc41252d0ab76474615b9700d63d4d9292af"}, + {file = "aiohttp-3.8.5-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:fd1ed388ea7fbed22c4968dd64bab0198de60750a25fe8c0c9d4bef5abe13824"}, + {file = "aiohttp-3.8.5-cp36-cp36m-win32.whl", hash = "sha256:6e6783bcc45f397fdebc118d772103d751b54cddf5b60fbcc958382d7dd64f3e"}, + {file = "aiohttp-3.8.5-cp36-cp36m-win_amd64.whl", hash = "sha256:b5411d82cddd212644cf9360879eb5080f0d5f7d809d03262c50dad02f01421a"}, + {file = "aiohttp-3.8.5-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:01d4c0c874aa4ddfb8098e85d10b5e875a70adc63db91f1ae65a4b04d3344cda"}, + {file = "aiohttp-3.8.5-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e5980a746d547a6ba173fd5ee85ce9077e72d118758db05d229044b469d9029a"}, + {file = "aiohttp-3.8.5-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:2a482e6da906d5e6e653be079b29bc173a48e381600161c9932d89dfae5942ef"}, + {file = "aiohttp-3.8.5-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:80bd372b8d0715c66c974cf57fe363621a02f359f1ec81cba97366948c7fc873"}, + {file = "aiohttp-3.8.5-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c1161b345c0a444ebcf46bf0a740ba5dcf50612fd3d0528883fdc0eff578006a"}, + {file = "aiohttp-3.8.5-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:cd56db019015b6acfaaf92e1ac40eb8434847d9bf88b4be4efe5bfd260aee692"}, + {file = "aiohttp-3.8.5-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:153c2549f6c004d2754cc60603d4668899c9895b8a89397444a9c4efa282aaf4"}, + {file = "aiohttp-3.8.5-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:4a01951fabc4ce26ab791da5f3f24dca6d9a6f24121746eb19756416ff2d881b"}, + {file = "aiohttp-3.8.5-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:bfb9162dcf01f615462b995a516ba03e769de0789de1cadc0f916265c257e5d8"}, + {file = "aiohttp-3.8.5-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:7dde0009408969a43b04c16cbbe252c4f5ef4574ac226bc8815cd7342d2028b6"}, + {file = "aiohttp-3.8.5-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:4149d34c32f9638f38f544b3977a4c24052042affa895352d3636fa8bffd030a"}, + {file = "aiohttp-3.8.5-cp37-cp37m-win32.whl", hash = "sha256:68c5a82c8779bdfc6367c967a4a1b2aa52cd3595388bf5961a62158ee8a59e22"}, + {file = "aiohttp-3.8.5-cp37-cp37m-win_amd64.whl", hash = "sha256:2cf57fb50be5f52bda004b8893e63b48530ed9f0d6c96c84620dc92fe3cd9b9d"}, + {file = "aiohttp-3.8.5-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:eca4bf3734c541dc4f374ad6010a68ff6c6748f00451707f39857f429ca36ced"}, + {file = "aiohttp-3.8.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1274477e4c71ce8cfe6c1ec2f806d57c015ebf84d83373676036e256bc55d690"}, + {file = "aiohttp-3.8.5-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:28c543e54710d6158fc6f439296c7865b29e0b616629767e685a7185fab4a6b9"}, + {file = "aiohttp-3.8.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:910bec0c49637d213f5d9877105d26e0c4a4de2f8b1b29405ff37e9fc0ad52b8"}, + {file = "aiohttp-3.8.5-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5443910d662db951b2e58eb70b0fbe6b6e2ae613477129a5805d0b66c54b6cb7"}, + {file = "aiohttp-3.8.5-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2e460be6978fc24e3df83193dc0cc4de46c9909ed92dd47d349a452ef49325b7"}, + {file = "aiohttp-3.8.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fb1558def481d84f03b45888473fc5a1f35747b5f334ef4e7a571bc0dfcb11f8"}, + {file = "aiohttp-3.8.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:34dd0c107799dcbbf7d48b53be761a013c0adf5571bf50c4ecad5643fe9cfcd0"}, + {file = "aiohttp-3.8.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:aa1990247f02a54185dc0dff92a6904521172a22664c863a03ff64c42f9b5410"}, + {file = "aiohttp-3.8.5-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:0e584a10f204a617d71d359fe383406305a4b595b333721fa50b867b4a0a1548"}, + {file = "aiohttp-3.8.5-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:a3cf433f127efa43fee6b90ea4c6edf6c4a17109d1d037d1a52abec84d8f2e42"}, + {file = "aiohttp-3.8.5-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:c11f5b099adafb18e65c2c997d57108b5bbeaa9eeee64a84302c0978b1ec948b"}, + {file = "aiohttp-3.8.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:84de26ddf621d7ac4c975dbea4c945860e08cccde492269db4e1538a6a6f3c35"}, + {file = "aiohttp-3.8.5-cp38-cp38-win32.whl", hash = "sha256:ab88bafedc57dd0aab55fa728ea10c1911f7e4d8b43e1d838a1739f33712921c"}, + {file = "aiohttp-3.8.5-cp38-cp38-win_amd64.whl", hash = "sha256:5798a9aad1879f626589f3df0f8b79b3608a92e9beab10e5fda02c8a2c60db2e"}, + {file = "aiohttp-3.8.5-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:a6ce61195c6a19c785df04e71a4537e29eaa2c50fe745b732aa937c0c77169f3"}, + {file = "aiohttp-3.8.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:773dd01706d4db536335fcfae6ea2440a70ceb03dd3e7378f3e815b03c97ab51"}, + {file = "aiohttp-3.8.5-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:f83a552443a526ea38d064588613aca983d0ee0038801bc93c0c916428310c28"}, + {file = "aiohttp-3.8.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1f7372f7341fcc16f57b2caded43e81ddd18df53320b6f9f042acad41f8e049a"}, + {file = "aiohttp-3.8.5-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ea353162f249c8097ea63c2169dd1aa55de1e8fecbe63412a9bc50816e87b761"}, + {file = "aiohttp-3.8.5-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e5d47ae48db0b2dcf70bc8a3bc72b3de86e2a590fc299fdbbb15af320d2659de"}, + {file = "aiohttp-3.8.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d827176898a2b0b09694fbd1088c7a31836d1a505c243811c87ae53a3f6273c1"}, + {file = "aiohttp-3.8.5-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3562b06567c06439d8b447037bb655ef69786c590b1de86c7ab81efe1c9c15d8"}, + {file = "aiohttp-3.8.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:4e874cbf8caf8959d2adf572a78bba17cb0e9d7e51bb83d86a3697b686a0ab4d"}, + {file = "aiohttp-3.8.5-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:6809a00deaf3810e38c628e9a33271892f815b853605a936e2e9e5129762356c"}, + {file = "aiohttp-3.8.5-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:33776e945d89b29251b33a7e7d006ce86447b2cfd66db5e5ded4e5cd0340585c"}, + {file = "aiohttp-3.8.5-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:eaeed7abfb5d64c539e2db173f63631455f1196c37d9d8d873fc316470dfbacd"}, + {file = "aiohttp-3.8.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:e91d635961bec2d8f19dfeb41a539eb94bd073f075ca6dae6c8dc0ee89ad6f91"}, + {file = "aiohttp-3.8.5-cp39-cp39-win32.whl", hash = "sha256:00ad4b6f185ec67f3e6562e8a1d2b69660be43070bd0ef6fcec5211154c7df67"}, + {file = "aiohttp-3.8.5-cp39-cp39-win_amd64.whl", hash = "sha256:c0a9034379a37ae42dea7ac1e048352d96286626251862e448933c0f59cbd79c"}, + {file = "aiohttp-3.8.5.tar.gz", hash = "sha256:b9552ec52cc147dbf1944ac7ac98af7602e51ea2dcd076ed194ca3c0d1c7d0bc"}, ] [package.dependencies] @@ -1321,4 +1321,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "7e42a0574418c6dabd74bb9f7a0c98ab9ea59deac0ce842d7a1c838c516ffa0a" +content-hash = "72ba0b92a2891c33886f8e953a7845e57534859d4ba3551b0e8cd5306b8442cb" diff --git a/pyproject.toml b/pyproject.toml index 4a986c4..f22f94f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -21,7 +21,7 @@ include = [ [tool.poetry.dependencies] python = "^3.11" -aiohttp = "3.8.4" +aiohttp = "<3.8.6" beautifulsoup4 = "^4.12.2" uvloop = "^0.19.0" bs4 = "^0.0.1" From b84cdfd743b7164f685fb21d27f08959d161c736 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Fri, 10 Nov 2023 14:46:31 -0500 Subject: [PATCH 105/226] add typeguard --- poetry.lock | 22 ++++++++++++++++++++-- pyadtpulse/gateway.py | 5 +++++ pyadtpulse/pulse_connection.py | 6 ++++++ pyadtpulse/pulse_connection_info.py | 8 +++++++- pyadtpulse/pulse_query_manager.py | 8 ++++++++ pyadtpulse/pyadtpulse_async.py | 2 ++ pyadtpulse/pyadtpulse_properties.py | 8 ++++++++ pyadtpulse/site.py | 9 ++++++++- pyadtpulse/zones.py | 7 +++++++ pyproject.toml | 1 + 10 files changed, 72 insertions(+), 4 deletions(-) diff --git a/poetry.lock b/poetry.lock index 0d6a8e3..3f5773f 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.7.0 and should not be changed by hand. [[package]] name = "aiohttp" @@ -1095,6 +1095,24 @@ files = [ {file = "tomlkit-0.12.2.tar.gz", hash = "sha256:df32fab589a81f0d7dc525a4267b6d7a64ee99619cbd1eeb0fae32c1dd426977"}, ] +[[package]] +name = "typeguard" +version = "4.1.5" +description = "Run-time type checker for Python" +optional = false +python-versions = ">=3.8" +files = [ + {file = "typeguard-4.1.5-py3-none-any.whl", hash = "sha256:8923e55f8873caec136c892c3bed1f676eae7be57cdb94819281b3d3bc9c0953"}, + {file = "typeguard-4.1.5.tar.gz", hash = "sha256:ea0a113bbc111bcffc90789ebb215625c963411f7096a7e9062d4e4630c155fd"}, +] + +[package.dependencies] +typing-extensions = {version = ">=4.7.0", markers = "python_version < \"3.12\""} + +[package.extras] +doc = ["Sphinx (>=7)", "packaging", "sphinx-autodoc-typehints (>=1.2.0)"] +test = ["coverage[toml] (>=7)", "mypy (>=1.2.0)", "pytest (>=7)"] + [[package]] name = "typer" version = "0.9.0" @@ -1321,4 +1339,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "72ba0b92a2891c33886f8e953a7845e57534859d4ba3551b0e8cd5306b8442cb" +content-hash = "d31ea2aff8db346b6d75be17432c3de96a49c5785c1e032d63b6e64eaa319c1a" diff --git a/pyadtpulse/gateway.py b/pyadtpulse/gateway.py index af28805..5cdd080 100644 --- a/pyadtpulse/gateway.py +++ b/pyadtpulse/gateway.py @@ -6,6 +6,8 @@ from threading import RLock from typing import Any +from typeguard import typechecked + from .const import ADT_DEFAULT_POLL_INTERVAL, ADT_GATEWAY_OFFLINE_POLL_INTERVAL from .util import parse_pulse_datetime @@ -72,6 +74,7 @@ def is_online(self) -> bool: return self._status_text == "ONLINE" @is_online.setter + @typechecked def is_online(self, status: bool) -> None: """Set gateway status. @@ -108,6 +111,7 @@ def poll_interval(self) -> float: return self._current_poll_interval @poll_interval.setter + @typechecked def poll_interval(self, new_interval: float | None) -> None: """Set polling interval. @@ -147,6 +151,7 @@ def adjust_backoff_poll_interval(self) -> None: "Setting current poll interval to %f", self._current_poll_interval ) + @typechecked def set_gateway_attributes(self, gateway_attributes: dict[str, str]) -> None: """Set gateway attributes from dictionary. diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 01a9477..f823278 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -9,6 +9,7 @@ from aiohttp import ClientSession from bs4 import BeautifulSoup +from typeguard import typechecked from yarl import URL from .const import ( @@ -39,6 +40,7 @@ class ADTPulseConnection(PulseQueryManager): ) @staticmethod + @typechecked def check_login_parameters(username: str, password: str, fingerprint: str) -> None: """Check if login parameters are valid. @@ -54,6 +56,7 @@ def check_login_parameters(username: str, password: str, fingerprint: str) -> No if fingerprint is None or fingerprint == "": raise ValueError("Fingerprint is required") + @typechecked def __init__( self, host: str, @@ -86,10 +89,12 @@ def last_login_time(self) -> int: return self._last_login_time @last_login_time.setter + @typechecked def last_login_time(self, login_time: int) -> None: with self._pc_attribute_lock: self._last_login_time = login_time + @typechecked async def async_do_login_query( self, username: str, password: str, fingerprint: str, timeout: int = 30 ) -> BeautifulSoup | None: @@ -204,6 +209,7 @@ def check_response( self.last_login_time = int(time()) return soup + @typechecked async def async_do_logout_query(self, site_id: str | None) -> None: """Performs a logout query to the ADT Pulse site.""" params = {} diff --git a/pyadtpulse/pulse_connection_info.py b/pyadtpulse/pulse_connection_info.py index 05d2e36..57ccab1 100644 --- a/pyadtpulse/pulse_connection_info.py +++ b/pyadtpulse/pulse_connection_info.py @@ -1,8 +1,8 @@ """Pulse connection info.""" from asyncio import AbstractEventLoop - from aiohttp import ClientSession +from typeguard import typechecked from .const import API_HOST_CA, DEFAULT_API_HOST from .util import set_debug_lock @@ -21,6 +21,7 @@ class PulseConnectionInfo: ) @staticmethod + @typechecked def check_service_host(service_host: str) -> None: """Check if service host is valid.""" if service_host is None or service_host == "": @@ -68,6 +69,7 @@ def service_host(self) -> str: return self._api_host @service_host.setter + @typechecked def service_host(self, host: str): """Set the service host.""" self.check_service_host(host) @@ -81,6 +83,7 @@ def detailed_debug_logging(self) -> bool: return self._detailed_debug_logging @detailed_debug_logging.setter + @typechecked def detailed_debug_logging(self, value: bool): """Set the detailed debug logging flag.""" with self._pci_attribute_lock: @@ -93,11 +96,13 @@ def debug_locks(self) -> bool: return self._debug_locks @debug_locks.setter + @typechecked def debug_locks(self, value: bool): """Set the debug locks flag.""" with self._pci_attribute_lock: self._debug_locks = value + @typechecked def check_sync(self, message: str) -> AbstractEventLoop: """Checks if sync login was performed. @@ -115,6 +120,7 @@ def loop(self) -> AbstractEventLoop | None: return self._loop @loop.setter + @typechecked def loop(self, loop: AbstractEventLoop | None): """Set the event loop.""" with self._pci_attribute_lock: diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index f7c3675..e3a31da 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -15,6 +15,7 @@ ClientSession, ) from bs4 import BeautifulSoup +from typeguard import typechecked from yarl import URL from .const import ( @@ -51,11 +52,13 @@ class PulseQueryManager(PulseConnectionInfo): ) @staticmethod + @typechecked def _get_http_status_description(status_code: int) -> str: """Get HTTP status description.""" status = HTTPStatus(status_code) return status.description + @typechecked def __init__( self, host: str, @@ -80,6 +83,7 @@ def retry_after(self) -> int: return self._retry_after @retry_after.setter + @typechecked def retry_after(self, seconds: int) -> None: """Set time after which HTTP requests can be retried. @@ -97,11 +101,13 @@ def connection_failure_reason(self) -> ConnectionFailureReason: return self._connection_failure_reason @connection_failure_reason.setter + @typechecked def connection_failure_reason(self, reason: ConnectionFailureReason) -> None: """Set the connection failure reason.""" with self._pcm_attribute_lock: self._connection_failure_reason = reason + @typechecked def _compute_retry_after(self, code: int, retry_after: str) -> None: """ Check the "Retry-After" header in the response and set retry_after property @@ -136,6 +142,7 @@ def _compute_retry_after(self, code: int, retry_after: str) -> None: fail_reason = ConnectionFailureReason.UNKNOWN self._connection_failure_reason = fail_reason + @typechecked async def async_query( self, uri: str, @@ -289,6 +296,7 @@ async def query_orb(self, level: int, error_message: str) -> BeautifulSoup | Non return make_soup(code, response, url, level, error_message) + @typechecked def make_url(self, uri: str) -> str: """Create a URL to service host from a URI. diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index a1668f5..3fec34c 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -8,6 +8,7 @@ from aiohttp import ClientSession from bs4 import BeautifulSoup +from typeguard import typechecked from yarl import URL from .alarm_panel import ADT_ALARM_UNKNOWN @@ -36,6 +37,7 @@ class PyADTPulseAsync(PyADTPulseProperties): __slots__ = ("_sync_task", "_timeout_task", "_pa_attribute_lock") + @typechecked def __init__( self, username: str, diff --git a/pyadtpulse/pyadtpulse_properties.py b/pyadtpulse/pyadtpulse_properties.py index cc79a51..4bb6195 100644 --- a/pyadtpulse/pyadtpulse_properties.py +++ b/pyadtpulse/pyadtpulse_properties.py @@ -6,6 +6,7 @@ from aiohttp import ClientSession +from typeguard import typechecked from .const import ( ADT_DEFAULT_HTTP_USER_AGENT, ADT_DEFAULT_KEEPALIVE_INTERVAL, @@ -42,6 +43,7 @@ class PyADTPulseProperties: ) @staticmethod + @typechecked def _check_keepalive_interval(keepalive_interval: int) -> None: if keepalive_interval > ADT_MAX_KEEPALIVE_INTERVAL or keepalive_interval <= 0: raise ValueError( @@ -50,6 +52,7 @@ def _check_keepalive_interval(keepalive_interval: int) -> None: ) @staticmethod + @typechecked def _check_relogin_interval(relogin_interval: int) -> None: if relogin_interval < ADT_MIN_RELOGIN_INTERVAL: raise ValueError( @@ -57,6 +60,7 @@ def _check_relogin_interval(relogin_interval: int) -> None: f"greater than {ADT_MIN_RELOGIN_INTERVAL}" ) + @typechecked def __init__( self, username: str, @@ -140,6 +144,7 @@ def service_host(self) -> str: return self._pulse_connection.service_host @service_host.setter + @typechecked def service_host(self, host: str) -> None: """Override the Pulse host (i.e. to use portal-ca.adpulse.com). @@ -185,6 +190,7 @@ def relogin_interval(self) -> int: return self._relogin_interval @relogin_interval.setter + @typechecked def relogin_interval(self, interval: int | None) -> None: """Set re-login interval. @@ -215,6 +221,7 @@ def keepalive_interval(self) -> int: return self._keepalive_interval @keepalive_interval.setter + @typechecked def keepalive_interval(self, interval: int | None) -> None: """Set the keepalive interval in minutes. @@ -235,6 +242,7 @@ def detailed_debug_logging(self) -> bool: return self._detailed_debug_logging @detailed_debug_logging.setter + @typechecked def detailed_debug_logging(self, value: bool) -> None: """Set detailed debug logging flag.""" with self._pp_attribute_lock: diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 883ab22..55f89df 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -7,8 +7,8 @@ from time import time from warnings import warn -# import dateparser from bs4 import BeautifulSoup, ResultSet +from typeguard import typechecked from .alarm_panel import ADTPulseAlarmPanel from .const import ADT_DEVICE_URI, ADT_GATEWAY_STRING, ADT_SYSTEM_URI @@ -43,6 +43,7 @@ class ADTPulseSite: "_gateway", ) + @typechecked def __init__(self, pulse_connection: ADTPulseConnection, site_id: str, name: str): """Initialize. @@ -105,12 +106,14 @@ def site_lock(self) -> "RLock| DebugRLock": """ return self._site_lock + @typechecked def arm_home(self, force_arm: bool = False) -> bool: """Arm system home.""" return self.alarm_control_panel.arm_home( self._pulse_connection, force_arm=force_arm ) + @typechecked def arm_away(self, force_arm: bool = False) -> bool: """Arm system away.""" return self.alarm_control_panel.arm_away( @@ -121,12 +124,14 @@ def disarm(self) -> bool: """Disarm system.""" return self.alarm_control_panel.disarm(self._pulse_connection) + @typechecked async def async_arm_home(self, force_arm: bool = False) -> bool: """Arm system home async.""" return await self.alarm_control_panel.async_arm_home( self._pulse_connection, force_arm=force_arm ) + @typechecked async def async_arm_away(self, force_arm: bool = False) -> bool: """Arm system away async.""" return await self.alarm_control_panel.async_arm_away( @@ -244,6 +249,7 @@ async def _get_device_attributes(self, device_id: str) -> dict[str, str] | None: result.update({identity_text: value}) return result + @typechecked async def set_device(self, device_id: str) -> None: """ Sets the device attributes for the given device ID. @@ -265,6 +271,7 @@ async def set_device(self, device_id: str) -> None: else: LOG.debug("Zone %s is not an integer, skipping", device_id) + @typechecked async def fetch_devices(self, soup: BeautifulSoup | None) -> bool: """ Fetches the devices from the given BeautifulSoup object and updates diff --git a/pyadtpulse/zones.py b/pyadtpulse/zones.py index 077027f..290a1a5 100644 --- a/pyadtpulse/zones.py +++ b/pyadtpulse/zones.py @@ -5,6 +5,8 @@ from datetime import datetime from typing import TypedDict +from typeguard import typechecked + ADT_NAME_TO_DEFAULT_TAGS = { "Door": ("sensor", "doorWindow"), "Window": ("sensor", "doorWindow"), @@ -112,6 +114,7 @@ def __setitem__(self, key: int, value: ADTPulseZoneData) -> None: value.name = "Sensor for Zone " + str(key) super().__setitem__(key, value) + @typechecked def update_status(self, key: int, status: str) -> None: """Update zone status. @@ -123,6 +126,7 @@ def update_status(self, key: int, status: str) -> None: temp.status = status self.__setitem__(key, temp) + @typechecked def update_state(self, key: int, state: str) -> None: """Update zone state. @@ -134,6 +138,7 @@ def update_state(self, key: int, state: str) -> None: temp.state = state self.__setitem__(key, temp) + @typechecked def update_last_activity_timestamp(self, key: int, dt: datetime) -> None: """Update timestamp. @@ -145,6 +150,7 @@ def update_last_activity_timestamp(self, key: int, dt: datetime) -> None: temp.last_activity_timestamp = int(dt.timestamp()) self.__setitem__(key, temp) + @typechecked def update_device_info( self, key: int, @@ -193,6 +199,7 @@ def flatten(self) -> list[ADTPulseFlattendZone]: ) return result + @typechecked def update_zone_attributes(self, dev_attr: dict[str, str]) -> None: """Update zone attributes.""" d_name = dev_attr.get("name", "Unknown") diff --git a/pyproject.toml b/pyproject.toml index f22f94f..7422762 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -25,6 +25,7 @@ aiohttp = "<3.8.6" beautifulsoup4 = "^4.12.2" uvloop = "^0.19.0" bs4 = "^0.0.1" +typeguard = "^4.1.5" [tool.poetry.urls] From a56418cc5291ae51f866f58f04392e565da62f44 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Fri, 10 Nov 2023 15:33:46 -0500 Subject: [PATCH 106/226] pulse_connection_info tests and fixes --- pyadtpulse/pulse_connection_info.py | 4 +- .../tests/test_pulse_connection_info.py | 239 ++++++++++++++++++ 2 files changed, 241 insertions(+), 2 deletions(-) create mode 100644 pyadtpulse/tests/test_pulse_connection_info.py diff --git a/pyadtpulse/pulse_connection_info.py b/pyadtpulse/pulse_connection_info.py index 57ccab1..58a271c 100644 --- a/pyadtpulse/pulse_connection_info.py +++ b/pyadtpulse/pulse_connection_info.py @@ -56,8 +56,8 @@ def __init__( def __del__(self): """Destructor for ADTPulseConnection.""" if ( - self._allocated_session - and self._session is not None + getattr(self, "_allocated_session", False) + and getattr(self, "_session", None) is not None and not self._session.closed ): self._session.detach() diff --git a/pyadtpulse/tests/test_pulse_connection_info.py b/pyadtpulse/tests/test_pulse_connection_info.py new file mode 100644 index 0000000..dcfd879 --- /dev/null +++ b/pyadtpulse/tests/test_pulse_connection_info.py @@ -0,0 +1,239 @@ +# Initially Generated by CodiumAI +from asyncio import AbstractEventLoop +from unittest import mock +import pytest +from typeguard import TypeCheckError +from pyadtpulse.pulse_connection_info import PulseConnectionInfo +from pyadtpulse.const import DEFAULT_API_HOST, API_HOST_CA + + +class TestPulseConnectionInfo: + # Initialize PulseConnectionInfo with valid host and session + def test_initialize_with_valid_host_and_session(self): + # Arrange + from unittest import mock + + host = DEFAULT_API_HOST + session = mock.Mock() + + # Act + pci = PulseConnectionInfo(host, session) + + # Assert + assert pci.service_host == host + assert pci._session == session + assert pci._allocated_session == False + assert pci.detailed_debug_logging == False + assert pci.debug_locks == False + assert pci.loop == None + + # set and get service_host property + def test_set_and_get_service_host_property(self): + # Arrange + host = DEFAULT_API_HOST + pci = PulseConnectionInfo(host) + + # Act + pci.service_host = API_HOST_CA + + # Assert + assert pci.service_host == API_HOST_CA + + # set and get detailed_debug_logging property + def test_set_and_get_detailed_debug_logging_property(self): + # Arrange + host = DEFAULT_API_HOST + pci = PulseConnectionInfo(host) + + # Act + pci.detailed_debug_logging = True + + # Assert + assert pci.detailed_debug_logging == True + + # set and get debug_locks property + def test_set_and_get_debug_locks_property(self): + # Arrange + host = DEFAULT_API_HOST + pci = PulseConnectionInfo(host) + + # Act + pci.debug_locks = True + + # Assert + assert pci.debug_locks == True + + # set and get loop property + def test_set_and_get_loop_property(self): + # Arrange + host = DEFAULT_API_HOST + pci = PulseConnectionInfo(host) + loop = mock.Mock() + + # Act + pci.loop = loop + + # Assert + assert pci.loop == loop + + # Check if sync login was performed successfully + def test_check_sync_login_successful(self): + # Arrange + host = DEFAULT_API_HOST + pci = PulseConnectionInfo(host) + + # Act + loop = None + try: + loop = pci.check_sync("Sync login not performed") + assert False, "Expected RuntimeError to be raised" + except RuntimeError as e: + assert str(e) == "Sync login not performed" + + # Assert + assert loop is None + + # initialize PulseConnectionInfo with invalid host + def test_initialize_with_invalid_host(self): + # Arrange + host = "" + + # Act/Assert + with pytest.raises(ValueError): + pci = PulseConnectionInfo(host) + + # Initialize PulseConnectionInfo with closed session + def test_initialize_with_closed_session(self): + # Arrange + + host = "valid_host" + session = mock.Mock() + session.closed = True + + # Act/Assert + with pytest.raises(ValueError): + pci = PulseConnectionInfo(host, session) + + # Initialize PulseConnectionInfo with None host + def test_initialize_with_none_host(self): + # Arrange + host = None + + # Act/Assert + with pytest.raises(TypeCheckError): + pci = PulseConnectionInfo(host) + + # initialize PulseConnectionInfo with invalid service_host + def test_initialize_with_invalid_service_host(self): + # Arrange + host = "invalid_host" + + # Act/Assert + with pytest.raises(ValueError): + pci = PulseConnectionInfo(host) + + # Initialize PulseConnectionInfo with invalid debug_locks + def test_initialize_with_invalid_debug_locks(self): + # Arrange + host = DEFAULT_API_HOST + + # Act/Assert + with pytest.raises(TypeCheckError): + pci = PulseConnectionInfo(host, debug_locks="invalid_value") + + # Initialize PulseConnectionInfo with invalid detailed_debug_logging + def test_initialize_with_invalid_detailed_debug_logging(self): + # Arrange + host = DEFAULT_API_HOST + + # Act/Assert + with pytest.raises(TypeCheckError): + pci = PulseConnectionInfo(host, detailed_debug_logging="invalid_value") + + # Check if service host is valid + def test_check_service_host_valid(self): + # Arrange + host = DEFAULT_API_HOST + + # Act + PulseConnectionInfo.check_service_host(host) + + # Assert + # No exception should be raised + + # Initialize PulseConnectionInfo with a valid host + def test_initialize_with_valid_host(self): + # Arrange + + host = DEFAULT_API_HOST + session = mock.Mock() + + # Act + pulse_connection_info = PulseConnectionInfo(host, session) + + # Assert + assert pulse_connection_info.service_host == host + + # set service_host to an invalid string + def test_set_service_host_to_invalid_string(self): + # Arrange + host = DEFAULT_API_HOST + pci = PulseConnectionInfo(host) + + # Act and Assert + with pytest.raises(ValueError): + pci.service_host = "" + + # set service_host to valid host + def test_set_valid_service_host(self): + # Arrange + pci = PulseConnectionInfo(DEFAULT_API_HOST) + + # Act + pci.service_host = API_HOST_CA + + # Assert + assert pci.service_host == API_HOST_CA + + # set detailed_debug_logging to invalid value + def test_set_invalid_detailed_debug_logging(self): + # Arrange + pci = PulseConnectionInfo(DEFAULT_API_HOST) + + # Act and Assert + with pytest.raises(TypeCheckError): + pci.detailed_debug_logging = "invalid_value" + + # set debug_locks to invalid value + def test_set_invalid_debug_locks(self): + # Arrange + pci = PulseConnectionInfo(DEFAULT_API_HOST) + + # Act and Assert + with pytest.raises(TypeCheckError): + pci.debug_locks = "invalid_value" + + # Set the loop property to a valid value + def test_set_loop_to_valid_value(self): + # Arrange + pci = PulseConnectionInfo(DEFAULT_API_HOST) + loop = AbstractEventLoop() + + # Act + pci.loop = loop + + # Assert + assert pci.loop == loop + + # Test that check_sync raises a RuntimeError when sync login has not been performed. + def test_check_sync_before_sync_login(self): + """ + Test that check_sync raises a RuntimeError when sync login has not been performed. + """ + # Arrange + pci = PulseConnectionInfo(DEFAULT_API_HOST) + message = "Sync login has not been performed" + + # Act and Assert + with pytest.raises(RuntimeError, match=message): + pci.check_sync(message) From 3c5197b5d5301770357dc804b2ea738a7eb81749 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Sat, 11 Nov 2023 04:17:42 -0500 Subject: [PATCH 107/226] pulse_query_manager tests --- poetry.lock | 16 +- pyadtpulse/pulse_query_manager.py | 33 +- pyadtpulse/tests/conftest.py | 102 +++++ pyadtpulse/tests/test_pulse_query_manager.py | 452 +++++++++++++++++++ pyproject.toml | 1 + 5 files changed, 593 insertions(+), 11 deletions(-) create mode 100644 pyadtpulse/tests/conftest.py create mode 100644 pyadtpulse/tests/test_pulse_query_manager.py diff --git a/poetry.lock b/poetry.lock index 3f5773f..f0e6063 100644 --- a/poetry.lock +++ b/poetry.lock @@ -933,6 +933,20 @@ pytest = ">=5.0" [package.extras] dev = ["pre-commit", "pytest-asyncio", "tox"] +[[package]] +name = "pytest-timeout" +version = "2.2.0" +description = "pytest plugin to abort hanging tests" +optional = false +python-versions = ">=3.7" +files = [ + {file = "pytest-timeout-2.2.0.tar.gz", hash = "sha256:3b0b95dabf3cb50bac9ef5ca912fa0cfc286526af17afc806824df20c2f72c90"}, + {file = "pytest_timeout-2.2.0-py3-none-any.whl", hash = "sha256:bde531e096466f49398a59f2dde76fa78429a09a12411466f88a07213e220de2"}, +] + +[package.dependencies] +pytest = ">=5.0.0" + [[package]] name = "pyupgrade" version = "3.15.0" @@ -1339,4 +1353,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "d31ea2aff8db346b6d75be17432c3de96a49c5785c1e032d63b6e64eaa319c1a" +content-hash = "7a395cd6f3b0d9e93b1622595676109f47a1ce306aa86f62322e027da7e38796" diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index e3a31da..4d02aed 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -58,6 +58,20 @@ def _get_http_status_description(status_code: int) -> str: status = HTTPStatus(status_code) return status.description + @staticmethod + def _get_api_version(response_path: str) -> str | None: + """Regex used to exctract the API version. + + Use for testing. + """ + version: str | None = None + if not response_path: + return None + m = search(f"{API_PREFIX}(.+)/[a-z]*/", response_path) + if m is not None: + version = m.group(1) + return version + @typechecked def __init__( self, @@ -331,16 +345,15 @@ async def async_fetch_version(self) -> None: ADT_DEFAULT_VERSION, ) return - if response_path is not None: - m = search("/myhome/(.+)/[a-z]*/", response_path) - if m is not None: - self._api_version = m.group(1) - LOG.debug( - "Discovered ADT Pulse version %s at %s", - self._api_version, - self.service_host, - ) - return + version = self._get_api_version(response_path) + if version is not None: + self._api_version = version + LOG.debug( + "Discovered ADT Pulse version %s at %s", + self._api_version, + self.service_host, + ) + return LOG.warning( "Couldn't auto-detect ADT Pulse version, defaulting to %s", diff --git a/pyadtpulse/tests/conftest.py b/pyadtpulse/tests/conftest.py new file mode 100644 index 0000000..93543bf --- /dev/null +++ b/pyadtpulse/tests/conftest.py @@ -0,0 +1,102 @@ +"""conftest.py""" +import sys +import os +import asyncio +import aiohttp +from yarl import URL +import pytest +from bs4 import BeautifulSoup +from bs4.element import Comment + + +# Get the absolute path of the directory containing the conftest.py file +current_dir = os.path.dirname(os.path.abspath(__file__)) + +# Add the parent directory (source tree) to sys.path +parent_dir = os.path.dirname(current_dir) +sys.path.insert(0, parent_dir) + +# pylint: disable=wrong-import-position +from pyadtpulse.const import DEFAULT_API_HOST # noqa: E402 +from pyadtpulse.pulse_query_manager import ( # noqa: E402 + PulseQueryManager, +) + + +@pytest.fixture +def remove_comments_and_javascript(): + def _remove_comments_and_javascript(html): + soup = BeautifulSoup(html, 'html.parser') + + # Remove HTML comments + comments = soup.find_all(text=lambda text: isinstance(text, Comment)) + for comment in comments: + comment.extract() + + # Remove + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Security Panel
+ + +
+ + + + + + + + + + + + + + + + + +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name:Security Panel +
Manufacturer/Provider:ADT
Type/Model:Security Panel - Safewatch Pro 3000/3000CN +
Emergency Keys: + + + + + + +
Button: Fire Alarm (Zone 95)
+ +
Button: Audible Panic Alarm (Zone 99)
+ + +
Security Panel Master Code:**** +
Status: + + + +
+ + + + Online
+
+ + + +
+ + + + + +
+ +
+ + + + +
+ +
OK
+ +
+ +
+ + +
+
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/device_10.html b/pyadtpulse/tests/data_files/device_10.html new file mode 100644 index 0000000..c531324 --- /dev/null +++ b/pyadtpulse/tests/data_files/device_10.html @@ -0,0 +1,425 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Basement Smoke
+ + +
+ + + + + + + + + + + + + + + + + +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name:Basement Smoke +
Zone:17
Type/Model:Fire (Smoke/Heat) Detector +
Reporting Type:9:RF
Status: + + + +
+ + + + Online
+
+ + + +
+ + + + + +
+ +
+ + + + +
+ +
OK
+ +
+ +
+ + +
+
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/device_11.html b/pyadtpulse/tests/data_files/device_11.html new file mode 100644 index 0000000..b6bc63e --- /dev/null +++ b/pyadtpulse/tests/data_files/device_11.html @@ -0,0 +1,425 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
2nd Floor Smoke
+ + +
+ + + + + + + + + + + + + + + + + +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name:2nd Floor Smoke +
Zone:18
Type/Model:Fire (Smoke/Heat) Detector +
Reporting Type:9:RF
Status: + + + +
+ + + + Online
+
+ + + +
+ + + + + +
+ +
+ + + + +
+ +
OK
+ +
+ +
+ + +
+
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/device_16.html b/pyadtpulse/tests/data_files/device_16.html new file mode 100644 index 0000000..3c1ec80 --- /dev/null +++ b/pyadtpulse/tests/data_files/device_16.html @@ -0,0 +1,425 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Main Gas
+ + +
+ + + + + + + + + + + + + + + + + +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name:Main Gas +
Zone:23
Type/Model:Carbon Monoxide Detector +
Reporting Type:14:RF
Status: + + + +
+ + + + Online
+
+ + + +
+ + + + + +
+ +
+ + + + +
+ +
OK
+ +
+ +
+ + +
+
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/device_2.html b/pyadtpulse/tests/data_files/device_2.html new file mode 100644 index 0000000..a20964c --- /dev/null +++ b/pyadtpulse/tests/data_files/device_2.html @@ -0,0 +1,425 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Front Door
+ + +
+ + + + + + + + + + + + + + + + + +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name:Front Door +
Zone:9
Type/Model:Door/Window Sensor +
Reporting Type:1:RF
Status: + + + +
+ + + + Online
+
+ + + +
+ + + + + +
+ +
+ + + + +
+ +
OK
+ +
+ +
+ + +
+
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/device_24.html b/pyadtpulse/tests/data_files/device_24.html new file mode 100644 index 0000000..60ce128 --- /dev/null +++ b/pyadtpulse/tests/data_files/device_24.html @@ -0,0 +1,443 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
keyfob
+ + +
+ + + + + + + + + + + + + + + + + +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name:keyfob +
Type/Model:Wireless Remote +
Buttons: + + + + + + +
Button: Arm-Stay (Zone 49)
+ +
Button: Arm-Away (Zone 50)
+ +
Button: Disarm (Zone 51)
+ +
Button: Audible Panic Alarm (Zone 52)
+ + +
Status: + + + +
+ + + + Online
+
+ + + +
+ + + + + +
+ +
+ + + + +
+ +
OK
+ +
+ +
+ + +
+
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/device_25.html b/pyadtpulse/tests/data_files/device_25.html new file mode 100644 index 0000000..e2afccb --- /dev/null +++ b/pyadtpulse/tests/data_files/device_25.html @@ -0,0 +1,425 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Patio Door
+ + +
+ + + + + + + + + + + + + + + + + +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name:Patio Door +
Zone:11
Type/Model:Door/Window Sensor +
Reporting Type:3:RF
Status: + + + +
+ + + + Online
+
+ + + +
+ + + + + +
+ +
+ + + + +
+ +
OK
+ +
+ +
+ + +
+
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/device_26.html b/pyadtpulse/tests/data_files/device_26.html new file mode 100644 index 0000000..534fc21 --- /dev/null +++ b/pyadtpulse/tests/data_files/device_26.html @@ -0,0 +1,425 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Basement Door
+ + +
+ + + + + + + + + + + + + + + + + +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name:Basement Door +
Zone:13
Type/Model:Door/Window Sensor +
Reporting Type:3:RF
Status: + + + +
+ + + + Online
+
+ + + +
+ + + + + +
+ +
+ + + + +
+ +
OK
+ +
+ +
+ + +
+
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/device_27.html b/pyadtpulse/tests/data_files/device_27.html new file mode 100644 index 0000000..a5a44be --- /dev/null +++ b/pyadtpulse/tests/data_files/device_27.html @@ -0,0 +1,425 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Back Door
+ + +
+ + + + + + + + + + + + + + + + + +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name:Back Door +
Zone:14
Type/Model:Door/Window Sensor +
Reporting Type:3:RF
Status: + + + +
+ + + + Online
+
+ + + +
+ + + + + +
+ +
+ + + + +
+ +
OK
+ +
+ +
+ + +
+
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/device_28.html b/pyadtpulse/tests/data_files/device_28.html new file mode 100644 index 0000000..f7dc764 --- /dev/null +++ b/pyadtpulse/tests/data_files/device_28.html @@ -0,0 +1,425 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Foyer Motion
+ + +
+ + + + + + + + + + + + + + + + + +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name:Foyer Motion +
Zone:15
Type/Model:Motion Sensor +
Reporting Type:10:RF
Status: + + + +
+ + + + Online
+
+ + + +
+ + + + + +
+ +
+ + + + +
+ +
OK
+ +
+ +
+ + +
+
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/device_29.html b/pyadtpulse/tests/data_files/device_29.html new file mode 100644 index 0000000..b48b5bf --- /dev/null +++ b/pyadtpulse/tests/data_files/device_29.html @@ -0,0 +1,425 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Living Room Door
+ + +
+ + + + + + + + + + + + + + + + + +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name:Living Room Door +
Zone:12
Type/Model:Door/Window Sensor +
Reporting Type:3:RF
Status: + + + +
+ + + + Online
+
+ + + +
+ + + + + +
+ +
+ + + + +
+ +
OK
+ +
+ +
+ + +
+
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/device_3.html b/pyadtpulse/tests/data_files/device_3.html new file mode 100644 index 0000000..4e29c4d --- /dev/null +++ b/pyadtpulse/tests/data_files/device_3.html @@ -0,0 +1,425 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Garage Door
+ + +
+ + + + + + + + + + + + + + + + + +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name:Garage Door +
Zone:10
Type/Model:Door/Window Sensor +
Reporting Type:1:RF
Status: + + + +
+ + + + Online
+
+ + + +
+ + + + + +
+ +
+ + + + +
+ +
OK
+ +
+ +
+ + +
+
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/device_30.html b/pyadtpulse/tests/data_files/device_30.html new file mode 100644 index 0000000..d264bf3 --- /dev/null +++ b/pyadtpulse/tests/data_files/device_30.html @@ -0,0 +1,425 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Family Glass Break
+ + +
+ + + + + + + + + + + + + + + + + +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name:Family Glass Break +
Zone:16
Type/Model:Glass Break Detector +
Reporting Type:3:RF
Status: + + + +
+ + + + Online
+
+ + + +
+ + + + + +
+ +
+ + + + +
+ +
OK
+ +
+ +
+ + +
+
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/device_34.html b/pyadtpulse/tests/data_files/device_34.html new file mode 100644 index 0000000..90b135b --- /dev/null +++ b/pyadtpulse/tests/data_files/device_34.html @@ -0,0 +1,431 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Camera
+ + +
+ + + + + + + + + + + + + + + + + +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name:Camera +
Manufacturer/Provider:ADT
Type/Model:RC8325-ADT Indoor/Night HD Camera +
Version:3.0.02.30ADT
ID:E06066032138
Status: + + + +
+ + + + Online
+
+ + + +
+ + + + + +
+ +
+ + + + +
+ +
OK
+ +
+ +
+ + +
+
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/device_69.html b/pyadtpulse/tests/data_files/device_69.html new file mode 100644 index 0000000..b907b44 --- /dev/null +++ b/pyadtpulse/tests/data_files/device_69.html @@ -0,0 +1,425 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Radio Station Smoke
+ + +
+ + + + + + + + + + + + + + + + + +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name:Radio Station Smoke +
Zone:22
Type/Model:Fire (Smoke/Heat) Detector +
Reporting Type:9:RF
Status: + + + +
+ + + + Online
+
+ + + +
+ + + + + +
+ +
+ + + + +
+ +
OK
+ +
+ +
+ + +
+
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/device_70.html b/pyadtpulse/tests/data_files/device_70.html new file mode 100644 index 0000000..57822dc --- /dev/null +++ b/pyadtpulse/tests/data_files/device_70.html @@ -0,0 +1,425 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+ + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Radio Station Gas
+ + +
+ + + + + + + + + + + + + + + + + +
+ + +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Name:Radio Station Gas +
Zone:24
Type/Model:Carbon Monoxide Detector +
Reporting Type:14:RF
Status: + + + +
+ + + + Online
+
+ + + +
+ + + + + +
+ +
+ + + + +
+ +
OK
+ +
+ +
+ + +
+
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/gateway.html b/pyadtpulse/tests/data_files/gateway.html new file mode 100644 index 0000000..236b8c1 --- /dev/null +++ b/pyadtpulse/tests/data_files/gateway.html @@ -0,0 +1,390 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + +
+
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + +
+
+
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Gateway
+ + +
+ + + + + + + + + + + + + + + + + +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
Status: + + + +
+ + + + Online
Manufacturer:ADT Pulse Gateway
Model:PGZNG1
Serial Number:5U020CN3007E3
Next Update:Today 10:06 PM
Last Update:Today 4:06 PM
Firmware Version:24.0.0-9
Hardware Version:HW=3, BL=1.1.9b, PL=9.4.0.32.5, SKU=PGZNG1-2ADNAS
 
Communication Link Status
Primary Connection Type:Broadband
Broadband Connection Status:Active
Cellular Connection Status:N/A
Cellular Signal Strength:N/A
 
Network Address Information
Broadband LAN IP Address:192.168.1.31
Broadband LAN MAC:02:1a:3e:4b:6c:8f
Device LAN IP Address:192.168.107.1
Device LAN MAC:0a:bc:2e:5d:7f:9a
Router LAN IP Address:192.168.1.1
Router WAN IP Address:
+
+ +
+ + +
+
OK
+
+ +
+ + +
+ +
+ + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/orb.html b/pyadtpulse/tests/data_files/orb.html new file mode 100644 index 0000000..3347e92 --- /dev/null +++ b/pyadtpulse/tests/data_files/orb.html @@ -0,0 +1,306 @@ +
+ Security +
+
+
+
+ + +
Downstairs
+
+
+
+
+ + + +
+
+
+
+
+ + +
Arm Away
+
+
+ + +
Arm Stay
+
+
+
+ Disarmed. All Quiet. +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + +
+ + + + + + 2nd Floor Smoke +  Zone  18 + Okay  
+
+ + + + + + + +
+ + + + + + Back Door +  Zone  14 + Closed  
+
+ + + + + + + +
+ + + + + + Basement Door +  Zone  13 + Closed  
+ + + + + + + +
+ + + + + + Basement Smoke +  Zone  17 + Okay  
+ + + + + + + +
+ + + + + + Family Glass Break +  Zone  16 + Okay  
+ + + + + + + +
+ + + + + + Foyer Motion +  Zone  15 + No Motion  
+ + + + + + + +
+ + + + + + Front Door +  Zone  9 + Closed  
+ + + + + + + +
+ + + + + + Garage Door +  Zone  10 + Closed  
+ + + + + + + +
+ + + + + + Living Room Door +  Zone  12 + Closed  
+ + + + + + + +
+ + + + + + Main Gas +  Zone  23 + Okay  
+ + + + + + + +
+ + + + + + Patio Door +  Zone  11 + Closed  
+ + + + + + + +
+ + + + + + Radio Station Gas +  Zone  24 + Okay  
+ + + + + + + +
+ + + + + + Radio Station Smoke +  Zone  22 + Okay  
+ diff --git a/pyadtpulse/tests/data_files/orb_garage.html b/pyadtpulse/tests/data_files/orb_garage.html new file mode 100644 index 0000000..8dd8b21 --- /dev/null +++ b/pyadtpulse/tests/data_files/orb_garage.html @@ -0,0 +1,306 @@ +
+ Security +
+
+
+
+ + +
Downstairs
+
+
+
+
+ + + +
+
+
+
+
+ + +
Arm Away
+
+
+ + +
Arm Stay
+
+
+
+ Disarmed. 1 Sensor Open. +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + +
+ + + + + + Garage Door +  Zone  10 + Open  
+
+ + + + + + + +
+ + + + + + 2nd Floor Smoke +  Zone  18 + Okay  
+
+ + + + + + + +
+ + + + + + Back Door +  Zone  14 + Closed  
+ + + + + + + +
+ + + + + + Basement Door +  Zone  13 + Closed  
+ + + + + + + +
+ + + + + + Basement Smoke +  Zone  17 + Okay  
+ + + + + + + +
+ + + + + + Family Glass Break +  Zone  16 + Okay  
+ + + + + + + +
+ + + + + + Foyer Motion +  Zone  15 + No Motion  
+ + + + + + + +
+ + + + + + Front Door +  Zone  9 + Closed  
+ + + + + + + +
+ + + + + + Living Room Door +  Zone  12 + Closed  
+ + + + + + + +
+ + + + + + Main Gas +  Zone  23 + Okay  
+ + + + + + + +
+ + + + + + Patio Door +  Zone  11 + Closed  
+ + + + + + + +
+ + + + + + Radio Station Gas +  Zone  24 + Okay  
+ + + + + + + +
+ + + + + + Radio Station Smoke +  Zone  22 + Okay  
+ diff --git a/pyadtpulse/tests/data_files/orb_patio_garage.html b/pyadtpulse/tests/data_files/orb_patio_garage.html new file mode 100644 index 0000000..5025992 --- /dev/null +++ b/pyadtpulse/tests/data_files/orb_patio_garage.html @@ -0,0 +1,306 @@ +
+ Security +
+
+
+
+ + +
Downstairs
+
+
+
+
+ + + +
+
+
+
+
+ + +
Arm Away
+
+
+ + +
Arm Stay
+
+
+
+ Disarmed. 2 Sensors Open. +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + +
+ + + + + + Garage Door +  Zone  10 + Open  
+
+ + + + + + + +
+ + + + + + Patio Door +  Zone  11 + Open  
+
+ + + + + + + +
+ + + + + + 2nd Floor Smoke +  Zone  18 + Okay  
+ + + + + + + +
+ + + + + + Back Door +  Zone  14 + Closed  
+ + + + + + + +
+ + + + + + Basement Door +  Zone  13 + Closed  
+ + + + + + + +
+ + + + + + Basement Smoke +  Zone  17 + Okay  
+ + + + + + + +
+ + + + + + Family Glass Break +  Zone  16 + Okay  
+ + + + + + + +
+ + + + + + Foyer Motion +  Zone  15 + No Motion  
+ + + + + + + +
+ + + + + + Front Door +  Zone  9 + Closed  
+ + + + + + + +
+ + + + + + Living Room Door +  Zone  12 + Closed  
+ + + + + + + +
+ + + + + + Main Gas +  Zone  23 + Okay  
+ + + + + + + +
+ + + + + + Radio Station Gas +  Zone  24 + Okay  
+ + + + + + + +
+ + + + + + Radio Station Smoke +  Zone  22 + Okay  
+ diff --git a/pyadtpulse/tests/data_files/orb_patio_opened.html b/pyadtpulse/tests/data_files/orb_patio_opened.html new file mode 100644 index 0000000..2487c2b --- /dev/null +++ b/pyadtpulse/tests/data_files/orb_patio_opened.html @@ -0,0 +1,306 @@ +
+ Security +
+
+
+
+ + +
Downstairs
+
+
+
+
+ + + +
+
+
+
+
+ + +
Arm Away
+
+
+ + +
Arm Stay
+
+
+
+ Disarmed. 1 Sensor Open. +
+ + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + +
+ + + + + + Patio Door +  Zone  11 + Open  
+
+ + + + + + + +
+ + + + + + 2nd Floor Smoke +  Zone  18 + Okay  
+
+ + + + + + + +
+ + + + + + Back Door +  Zone  14 + Closed  
+ + + + + + + +
+ + + + + + Basement Door +  Zone  13 + Closed  
+ + + + + + + +
+ + + + + + Basement Smoke +  Zone  17 + Okay  
+ + + + + + + +
+ + + + + + Family Glass Break +  Zone  16 + Okay  
+ + + + + + + +
+ + + + + + Foyer Motion +  Zone  15 + No Motion  
+ + + + + + + +
+ + + + + + Front Door +  Zone  9 + Closed  
+ + + + + + + +
+ + + + + + Garage Door +  Zone  10 + Closed  
+ + + + + + + +
+ + + + + + Living Room Door +  Zone  12 + Closed  
+ + + + + + + +
+ + + + + + Main Gas +  Zone  23 + Okay  
+ + + + + + + +
+ + + + + + Radio Station Gas +  Zone  24 + Okay  
+ + + + + + + +
+ + + + + + Radio Station Smoke +  Zone  22 + Okay  
+ diff --git a/pyadtpulse/tests/data_files/summary.html b/pyadtpulse/tests/data_files/summary.html new file mode 100644 index 0000000..bc5baf6 --- /dev/null +++ b/pyadtpulse/tests/data_files/summary.html @@ -0,0 +1,502 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - Summary - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+ + +
+
+ + + + + + + + +
+ +
+
+
+ + + + + + + +
+ Security +
+
+
+
+
Downstairs
+
+
+
+ +
+
+
+
Arm Away
Arm Stay
+
+
+
+
+ Disarmed. All Quiet. + +
+ + + +
+
+ + + + + + + + + + + + + + + +
2nd Floor Smoke  Zone 18Okay 
Back Door  Zone 14Closed 
Basement Door  Zone 13Closed 
Basement Smoke  Zone 17Okay 
Family Glass Break  Zone 16Okay 
Foyer Motion  Zone 15No Motion 
Front Door  Zone 9Closed 
Garage Door  Zone 10Closed 
Living Room Door  Zone 12Closed 
Main Gas  Zone 23Okay 
Patio Door  Zone 11Closed 
Radio Station Gas  Zone 24Okay 
Radio Station Smoke  Zone 22Okay 
+
+
+ +
+ + + + + +
+
+
+ + +
+
+ Other Devices +
+ + + + + + + + + + + + + + + +
+
+ + + + + +
 No other devices installed.
 
 
+
+
+ + + +
+
+
+ + +
+
+ Notable Events +
+
+

 Loading...  +
+
+
+
+ + + 		+ +
+
+
+ + + + + + + +
+ + + Cameras + + +
+
+ + + + + + +
+ +
+
+
+
Camera
+
+Actions +
+
+
+
No pictures or clips.
+ +
+ + + +
+ +
+
+
+
+ + +
+
+ Today's Schedule +
+ + + + + + + + + + +
+ + +
+ +
+ +
+ + +
+
+
+ + +
+ + + +
+ + + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + + diff --git a/pyadtpulse/tests/data_files/system.html b/pyadtpulse/tests/data_files/system.html new file mode 100644 index 0000000..09b0464 --- /dev/null +++ b/pyadtpulse/tests/data_files/system.html @@ -0,0 +1,513 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + + + + + + + +
+
+
+
+ Welcome, Development + +  |  + + + Sign Out + +
+
+
+ Wednesday, Nov 15 + +  |  + + + Sign Out + + +
+ +
+ +
+ +
+
+
+
+
+ + + + + +
+ +
+ Location: + +Robert Lippmann + + +
+
+
+ +
+ +
+
+ + Summary + + + History + + + Rules + + + System + + + +
+
+ + + View help for this pageHelp + +
+
+ +
+ +
+
+ +
+ +
+
+ + + + System + +
+
+ + +
+
+ + + +
+
+ +
+ + + Devices + + +  |  + + + + + Site Settings + + +  |  + + + Users + + + + +  |  + + + + Access Codes + + + +  |  + + + My Profile + + +  |  + + + My Profile History + + + + + +
+ + + + + + + + + +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
 Name ZoneDevice Type
+ + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
 System
+ + + + + + +
Security Panel +  ADT: Security Panel - Safewatch Pro 3000/3000CN
+ + + + + + +
Gateway +  ADT Pulse Gateway: PGZNG1
 
 Sensors
+ + + + + + +
2nd Floor Smoke +18 Fire (Smoke/Heat) Detector
+ + + + + + +
Back Door +14 Door/Window Sensor
+ + + + + + +
Basement Door +13 Door/Window Sensor
+ + + + + + +
Basement Smoke +17 Fire (Smoke/Heat) Detector
+ + + + + + +
Family Glass Break +16 Glass Break Detector
+ + + + + + +
Foyer Motion +15 Motion Sensor
+ + + + + + +
Front Door +9 Door/Window Sensor
+ + + + + + +
Garage Door +10 Door/Window Sensor
+ + + + + + +
Living Room Door +12 Door/Window Sensor
+ + + + + + +
Main Gas +23 Carbon Monoxide Detector
+ + + + + + +
Patio Door +11 Door/Window Sensor
+ + + + + + +
Radio Station Gas +24 Carbon Monoxide Detector
+ + + + + + +
Radio Station Smoke +22 Fire (Smoke/Heat) Detector
 
 Remotes
+ + + + + + +
keyfob +  Wireless Remote
 
 Cameras
+ + + + + + +
Camera +  ADT: RC8325-ADT Indoor/Night HD Camera
+
+
+ + +
+ + + + +
+
+ + + +
+ + + + +
+ + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+
+ +
+ + + + + + + + + diff --git a/pyproject.toml b/pyproject.toml index 2b4295a..efc5c8a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -38,6 +38,7 @@ pytest-asyncio = "^0.21.1" pytest-mock = "^3.12.0" pytest-aiohttp = "^1.0.5" pytest-timeout = "^2.2.0" +aioresponses = "^0.7.4" [tool.poetry.group.dev.dependencies] From 19bc728535a5c58c45718ef22f4854d299c40a44 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <70883373+rlippmann@users.noreply.github.com> Date: Thu, 16 Nov 2023 01:47:16 -0500 Subject: [PATCH 114/226] more testing infrastructure --- .vscode/settings.json | 7 +- pyadtpulse/tests/conftest.py => conftest.py | 74 +++++++++++-------- poetry.lock | 8 +- pyadtpulse/.vscode/settings.json | 2 +- .../tests => tests}/data_files/device_1.html | 0 .../tests => tests}/data_files/device_10.html | 0 .../tests => tests}/data_files/device_11.html | 0 .../tests => tests}/data_files/device_16.html | 0 .../tests => tests}/data_files/device_2.html | 0 .../tests => tests}/data_files/device_24.html | 0 .../tests => tests}/data_files/device_25.html | 0 .../tests => tests}/data_files/device_26.html | 0 .../tests => tests}/data_files/device_27.html | 0 .../tests => tests}/data_files/device_28.html | 0 .../tests => tests}/data_files/device_29.html | 0 .../tests => tests}/data_files/device_3.html | 0 .../tests => tests}/data_files/device_30.html | 0 .../tests => tests}/data_files/device_34.html | 0 .../tests => tests}/data_files/device_69.html | 0 .../tests => tests}/data_files/device_70.html | 0 .../tests => tests}/data_files/gateway.html | 0 .../tests => tests}/data_files/orb.html | 0 .../data_files/orb_garage.html | 0 .../data_files/orb_patio_garage.html | 0 .../data_files/orb_patio_opened.html | 0 .../tests => tests}/data_files/summary.html | 0 .../tests => tests}/data_files/system.html | 0 tests/test_pqm.py | 30 ++++++++ 28 files changed, 86 insertions(+), 35 deletions(-) rename pyadtpulse/tests/conftest.py => conftest.py (83%) rename {pyadtpulse/tests => tests}/data_files/device_1.html (100%) rename {pyadtpulse/tests => tests}/data_files/device_10.html (100%) rename {pyadtpulse/tests => tests}/data_files/device_11.html (100%) rename {pyadtpulse/tests => tests}/data_files/device_16.html (100%) rename {pyadtpulse/tests => tests}/data_files/device_2.html (100%) rename {pyadtpulse/tests => tests}/data_files/device_24.html (100%) rename {pyadtpulse/tests => tests}/data_files/device_25.html (100%) rename {pyadtpulse/tests => tests}/data_files/device_26.html (100%) rename {pyadtpulse/tests => tests}/data_files/device_27.html (100%) rename {pyadtpulse/tests => tests}/data_files/device_28.html (100%) rename {pyadtpulse/tests => tests}/data_files/device_29.html (100%) rename {pyadtpulse/tests => tests}/data_files/device_3.html (100%) rename {pyadtpulse/tests => tests}/data_files/device_30.html (100%) rename {pyadtpulse/tests => tests}/data_files/device_34.html (100%) rename {pyadtpulse/tests => tests}/data_files/device_69.html (100%) rename {pyadtpulse/tests => tests}/data_files/device_70.html (100%) rename {pyadtpulse/tests => tests}/data_files/gateway.html (100%) rename {pyadtpulse/tests => tests}/data_files/orb.html (100%) rename {pyadtpulse/tests => tests}/data_files/orb_garage.html (100%) rename {pyadtpulse/tests => tests}/data_files/orb_patio_garage.html (100%) rename {pyadtpulse/tests => tests}/data_files/orb_patio_opened.html (100%) rename {pyadtpulse/tests => tests}/data_files/summary.html (100%) rename {pyadtpulse/tests => tests}/data_files/system.html (100%) create mode 100644 tests/test_pqm.py diff --git a/.vscode/settings.json b/.vscode/settings.json index ac7a5e5..6107dc4 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,4 +1,9 @@ { "python.analysis.typeCheckingMode": "basic", - "python.terminal.activateEnvironment": true + "python.terminal.activateEnvironment": true, + "python.testing.pytestArgs": [ + "tests" + ], + "python.testing.unittestEnabled": false, + "python.testing.pytestEnabled": true } diff --git a/pyadtpulse/tests/conftest.py b/conftest.py similarity index 83% rename from pyadtpulse/tests/conftest.py rename to conftest.py index 86eb715..59b809a 100644 --- a/pyadtpulse/tests/conftest.py +++ b/conftest.py @@ -4,12 +4,12 @@ from urllib import parse from datetime import datetime import re -from typing import AsyncGenerator, Any, Generator +from typing import AsyncGenerator, Any, Generator, Callable from unittest.mock import patch, AsyncMock from aiohttp import web import pytest -import aioresponses +from aioresponses import aioresponses # Get the root directory of your project @@ -17,7 +17,7 @@ # Modify sys.path to include the project root sys.path.insert(0, project_root) -test_file_dir = project_root.join("/tests/data_files") +test_file_dir = os.path.join(project_root,"tests", "data_files") # pylint: disable=wrong-import-position # ruff: noqa: E402 # flake8: noqa: E402 @@ -40,16 +40,20 @@ @pytest.fixture -def read_file(file_name: str) -> str: +def read_file() -> Callable[[str], str]: """Fixture to read a file. Args: file_name (str): Name of the file to read """ - file_path = os.path.join(test_file_dir, file_name) - with open(file_path, "r", encoding="utf-8") as file: - content = file.read() - return content + + def _read_file(file_name: str) -> str: + file_path = os.path.join(test_file_dir, file_name) + with open(file_path, "r", encoding="utf-8") as file: + content = file.read() + return content + + return _read_file @pytest.fixture(scope="session") @@ -74,21 +78,21 @@ def patched_async_query_sleep() -> Generator[AsyncMock, Any, Any]: @pytest.fixture -def get_test_api_version() -> str: +def get_mocked_api_version() -> str: """Fixture to get the test API version.""" return "26.0.0-32" @pytest.fixture -def get_test_connection_properties() -> PulseConnectionProperties: +def get_mocked_connection_properties() -> PulseConnectionProperties: """Fixture to get the test connection properties.""" return PulseConnectionProperties(DEFAULT_API_HOST) @pytest.fixture -def test_mapped_static_responses() -> dict[str, str]: +def get_mocked_mapped_static_responses() -> dict[str, str]: """Fixture to get the test mapped responses.""" - cp = get_test_connection_properties() + cp = get_mocked_connection_properties() return { cp.make_url("/"): "index.html", cp.make_url(ADT_LOGIN_URI): "signin.html", @@ -100,7 +104,8 @@ def test_mapped_static_responses() -> dict[str, str]: def extract_ids_from_data_directory() -> list[str]: - id_pattern = re.compile(r"device-(\d{2})\.html") + """Extract the device ids all the device files in the data directory.""" + id_pattern = re.compile(r"device-(\d{1,})\.html") ids = set() for file_name in os.listdir(test_file_dir): match = id_pattern.match(file_name) @@ -110,15 +115,12 @@ def extract_ids_from_data_directory() -> list[str]: @pytest.fixture -def test_mapped_server_responses( - test_mapped_static_responses, read_file -) -> Generator[aioresponses.aioresponses, Any, None]: +def mocked_server_responses(): """Fixture to get the test mapped responses.""" - static_responses = test_mapped_static_responses - responses = aioresponses.aioresponses() - with responses: - for url, response in test_mapped_static_responses.items(): - responses.add(url, "GET", read_file(response)) + static_responses = get_mocked_mapped_static_responses() + with aioresponses() as responses: + for url, file_name in static_responses.items(): + responses.add(url, "GET", body=read_file()(file_name)) # login/logout responses.add( static_responses[ADT_LOGIN_URI], @@ -135,8 +137,14 @@ def test_mapped_server_responses( responses.add( f"{ADT_DEVICE_URI}?id={device_id}", "GET", - read_file(f"device-{device_id}.html"), + body=read_file()(f"device-{device_id}.html"), ) + # default sync check response + responses.add( + get_mocked_connection_properties().make_url(ADT_SYNC_CHECK_URI), + "GET", + body="235632-234545-0", + ) yield responses @@ -150,13 +158,13 @@ def patched_sync_task_sleep() -> Generator[AsyncMock, Any, Any]: yield mock -@pytest.fixture -@pytest.mark.asyncio -class PulseMockedWebServer(web.Application): - """Mocked ADT Pulse Web Server""" + +class PulseMockedWebServer(): + """Mocked Pulse Web Server.""" def __init__(self, pulse_properties: PulseConnectionProperties): - """Initialize the PulseMockedWebServer""" + """Initialize the PulseMockedWebServer.""" + self.app = web.Application() self.logged_in = False self.status_code = 200 self.retry_after_header: str | None = None @@ -173,13 +181,13 @@ def __init__(self, pulse_properties: PulseConnectionProperties): self._make_local_prefix(ADT_SYSTEM_SETTINGS): ["system_settings.html"], } super().__init__() - self.router.add_route("*", "/{path_info:.*}", self.handler) + self.app.router.add_route("*", "/{path_info:.*}", self.handler) def _make_local_prefix(self, uri: str) -> str: return remove_prefix(self.pcp.make_url(uri), "https://") async def handler(self, request: web.Request) -> web.Response | web.FileResponse: - """Handler for the PulseMockedWebServer""" + """Handler for the PulseMockedWebServer.""" path = request.path # Check if there is a query parameter for retry_after @@ -284,3 +292,11 @@ def handle_add_response( if len(files_to_serve) > 1: file_to_serve = self.uri_mapping[path].pop(1) return serve_file(file_to_serve) + +@pytest.fixture +@pytest.mark.asyncio +async def mocked_pulse_server() -> PulseMockedWebServer: + """Fixture to create a mocked Pulse server.""" + pulse_properties = get_mocked_connection_properties() + m = PulseMockedWebServer(pulse_properties) + return m diff --git a/poetry.lock b/poetry.lock index 13e6d6b..708d006 100644 --- a/poetry.lock +++ b/poetry.lock @@ -110,17 +110,17 @@ speedups = ["Brotli", "aiodns", "cchardet"] [[package]] name = "aioresponses" -version = "0.7.4" +version = "0.7.5" description = "Mock out requests made by ClientSession from aiohttp package" optional = false python-versions = "*" files = [ - {file = "aioresponses-0.7.4-py2.py3-none-any.whl", hash = "sha256:1160486b5ea96fcae6170cf2bdef029b9d3a283b7dbeabb3d7f1182769bfb6b7"}, - {file = "aioresponses-0.7.4.tar.gz", hash = "sha256:9b8c108b36354c04633bad0ea752b55d956a7602fe3e3234b939fc44af96f1d8"}, + {file = "aioresponses-0.7.5-py2.py3-none-any.whl", hash = "sha256:0af13b077bde04ae965bc21981a1c6afd7dd17b861150d858de477d1c39c26a6"}, + {file = "aioresponses-0.7.5.tar.gz", hash = "sha256:794b3e04837a683fd2c0c099bdf77f8d7ecdd284bc2c15203003518bf5cb8da8"}, ] [package.dependencies] -aiohttp = ">=2.0.0,<4.0.0" +aiohttp = ">=3.3.0,<4.0.0" [[package]] name = "aiosignal" diff --git a/pyadtpulse/.vscode/settings.json b/pyadtpulse/.vscode/settings.json index 12901f9..bee182e 100644 --- a/pyadtpulse/.vscode/settings.json +++ b/pyadtpulse/.vscode/settings.json @@ -1,3 +1,3 @@ -{ +{ "python.analysis.typeCheckingMode": "basic" } diff --git a/pyadtpulse/tests/data_files/device_1.html b/tests/data_files/device_1.html similarity index 100% rename from pyadtpulse/tests/data_files/device_1.html rename to tests/data_files/device_1.html diff --git a/pyadtpulse/tests/data_files/device_10.html b/tests/data_files/device_10.html similarity index 100% rename from pyadtpulse/tests/data_files/device_10.html rename to tests/data_files/device_10.html diff --git a/pyadtpulse/tests/data_files/device_11.html b/tests/data_files/device_11.html similarity index 100% rename from pyadtpulse/tests/data_files/device_11.html rename to tests/data_files/device_11.html diff --git a/pyadtpulse/tests/data_files/device_16.html b/tests/data_files/device_16.html similarity index 100% rename from pyadtpulse/tests/data_files/device_16.html rename to tests/data_files/device_16.html diff --git a/pyadtpulse/tests/data_files/device_2.html b/tests/data_files/device_2.html similarity index 100% rename from pyadtpulse/tests/data_files/device_2.html rename to tests/data_files/device_2.html diff --git a/pyadtpulse/tests/data_files/device_24.html b/tests/data_files/device_24.html similarity index 100% rename from pyadtpulse/tests/data_files/device_24.html rename to tests/data_files/device_24.html diff --git a/pyadtpulse/tests/data_files/device_25.html b/tests/data_files/device_25.html similarity index 100% rename from pyadtpulse/tests/data_files/device_25.html rename to tests/data_files/device_25.html diff --git a/pyadtpulse/tests/data_files/device_26.html b/tests/data_files/device_26.html similarity index 100% rename from pyadtpulse/tests/data_files/device_26.html rename to tests/data_files/device_26.html diff --git a/pyadtpulse/tests/data_files/device_27.html b/tests/data_files/device_27.html similarity index 100% rename from pyadtpulse/tests/data_files/device_27.html rename to tests/data_files/device_27.html diff --git a/pyadtpulse/tests/data_files/device_28.html b/tests/data_files/device_28.html similarity index 100% rename from pyadtpulse/tests/data_files/device_28.html rename to tests/data_files/device_28.html diff --git a/pyadtpulse/tests/data_files/device_29.html b/tests/data_files/device_29.html similarity index 100% rename from pyadtpulse/tests/data_files/device_29.html rename to tests/data_files/device_29.html diff --git a/pyadtpulse/tests/data_files/device_3.html b/tests/data_files/device_3.html similarity index 100% rename from pyadtpulse/tests/data_files/device_3.html rename to tests/data_files/device_3.html diff --git a/pyadtpulse/tests/data_files/device_30.html b/tests/data_files/device_30.html similarity index 100% rename from pyadtpulse/tests/data_files/device_30.html rename to tests/data_files/device_30.html diff --git a/pyadtpulse/tests/data_files/device_34.html b/tests/data_files/device_34.html similarity index 100% rename from pyadtpulse/tests/data_files/device_34.html rename to tests/data_files/device_34.html diff --git a/pyadtpulse/tests/data_files/device_69.html b/tests/data_files/device_69.html similarity index 100% rename from pyadtpulse/tests/data_files/device_69.html rename to tests/data_files/device_69.html diff --git a/pyadtpulse/tests/data_files/device_70.html b/tests/data_files/device_70.html similarity index 100% rename from pyadtpulse/tests/data_files/device_70.html rename to tests/data_files/device_70.html diff --git a/pyadtpulse/tests/data_files/gateway.html b/tests/data_files/gateway.html similarity index 100% rename from pyadtpulse/tests/data_files/gateway.html rename to tests/data_files/gateway.html diff --git a/pyadtpulse/tests/data_files/orb.html b/tests/data_files/orb.html similarity index 100% rename from pyadtpulse/tests/data_files/orb.html rename to tests/data_files/orb.html diff --git a/pyadtpulse/tests/data_files/orb_garage.html b/tests/data_files/orb_garage.html similarity index 100% rename from pyadtpulse/tests/data_files/orb_garage.html rename to tests/data_files/orb_garage.html diff --git a/pyadtpulse/tests/data_files/orb_patio_garage.html b/tests/data_files/orb_patio_garage.html similarity index 100% rename from pyadtpulse/tests/data_files/orb_patio_garage.html rename to tests/data_files/orb_patio_garage.html diff --git a/pyadtpulse/tests/data_files/orb_patio_opened.html b/tests/data_files/orb_patio_opened.html similarity index 100% rename from pyadtpulse/tests/data_files/orb_patio_opened.html rename to tests/data_files/orb_patio_opened.html diff --git a/pyadtpulse/tests/data_files/summary.html b/tests/data_files/summary.html similarity index 100% rename from pyadtpulse/tests/data_files/summary.html rename to tests/data_files/summary.html diff --git a/pyadtpulse/tests/data_files/system.html b/tests/data_files/system.html similarity index 100% rename from pyadtpulse/tests/data_files/system.html rename to tests/data_files/system.html diff --git a/tests/test_pqm.py b/tests/test_pqm.py new file mode 100644 index 0000000..acabb24 --- /dev/null +++ b/tests/test_pqm.py @@ -0,0 +1,30 @@ +"""Test Pulse Query Manager.""" +from typing import Callable +import aiohttp + + +import pytest + + +@pytest.fixture +@pytest.mark.asyncio +async def test_mocked_responses( + read_file: Callable[[str], str], + mocked_server_responses, + get_mocked_mapped_static_responses: dict[str, str], +): + """Fixture to test mocked responses.""" + static_responses = get_mocked_mapped_static_responses + with mocked_server_responses: + async with aiohttp.ClientSession() as session: + for url, file_name in static_responses.items(): + # Make an HTTP request to the URL + response = await session.get(url) + + # Assert the status code is 200 + assert response.status == 200 + + # Assert the content matches the content of the file + expected_content = read_file(file_name) + actual_content = await response.text() + assert actual_content == expected_content From d1cdfb790de5c339768eb38e286cc96bda17bc98 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 18 Nov 2023 18:03:18 -0500 Subject: [PATCH 115/226] more testing infrastructure --- .vscode/launch.json | 9 + conftest.py | 169 +++++++++++------- pyadtpulse/const.py | 1 + pyadtpulse/pyadtpulse_async.py | 1 + pyadtpulse/site.py | 4 +- pyproject.toml | 11 +- tests/data_files/signin.html | 168 ++++++++++++++++++ tests/test_pqm.py | 30 ---- tests/test_pulse_async.py | 313 +++++++++++++++++++++++++++++++++ 9 files changed, 605 insertions(+), 101 deletions(-) create mode 100644 tests/data_files/signin.html delete mode 100644 tests/test_pqm.py create mode 100644 tests/test_pulse_async.py diff --git a/.vscode/launch.json b/.vscode/launch.json index fbe98a3..68224d6 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -4,6 +4,15 @@ // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 "version": "0.2.0", "configurations": [ + { + "name": "Python: Debug Tests", + "type": "python", + "request": "launch", + "program": "${file}", + "purpose": ["debug-test"], + "console": "integratedTerminal", + "justMyCode": false + }, { "name": "Python: Current File", "type": "python", diff --git a/conftest.py b/conftest.py index 59b809a..71b31de 100644 --- a/conftest.py +++ b/conftest.py @@ -1,37 +1,38 @@ """Pulse Test Configuration.""" -import sys import os -from urllib import parse -from datetime import datetime import re -from typing import AsyncGenerator, Any, Generator, Callable -from unittest.mock import patch, AsyncMock -from aiohttp import web -import pytest +import sys +from collections.abc import AsyncGenerator, Generator +from datetime import datetime +from pathlib import Path +from typing import Any +from unittest.mock import AsyncMock, patch +from urllib import parse +import pytest +from aiohttp import web from aioresponses import aioresponses - # Get the root directory of your project -project_root = os.path.dirname(os.path.abspath(__file__)) +project_root = Path(__file__).resolve().parent # Modify sys.path to include the project root -sys.path.insert(0, project_root) -test_file_dir = os.path.join(project_root,"tests", "data_files") +sys.path.insert(0, str(project_root)) +test_file_dir = project_root / "tests" / "data_files" # pylint: disable=wrong-import-position # ruff: noqa: E402 # flake8: noqa: E402 from pyadtpulse.const import ( - DEFAULT_API_HOST, - ADT_SUMMARY_URI, - ADT_SYNC_CHECK_URI, - ADT_SYSTEM_URI, + ADT_DEVICE_URI, + ADT_GATEWAY_URI, ADT_LOGIN_URI, - ADT_ORB_URI, - ADT_ZONES_URI, ADT_LOGOUT_URI, + ADT_ORB_URI, + ADT_SUMMARY_URI, + ADT_SYNC_CHECK_URI, ADT_SYSTEM_SETTINGS, - ADT_DEVICE_URI, + ADT_SYSTEM_URI, + DEFAULT_API_HOST, ) from pyadtpulse.pulse_connection_properties import PulseConnectionProperties from pyadtpulse.pulse_connection_status import PulseConnectionStatus @@ -40,7 +41,7 @@ @pytest.fixture -def read_file() -> Callable[[str], str]: +def read_file(): """Fixture to read a file. Args: @@ -48,10 +49,8 @@ def read_file() -> Callable[[str], str]: """ def _read_file(file_name: str) -> str: - file_path = os.path.join(test_file_dir, file_name) - with open(file_path, "r", encoding="utf-8") as file: - content = file.read() - return content + file_path = test_file_dir / file_name + return file_path.read_text(encoding="utf-8") return _read_file @@ -77,7 +76,7 @@ def patched_async_query_sleep() -> Generator[AsyncMock, Any, Any]: yield mock -@pytest.fixture +@pytest.fixture(scope="session") def get_mocked_api_version() -> str: """Fixture to get the test API version.""" return "26.0.0-32" @@ -90,22 +89,38 @@ def get_mocked_connection_properties() -> PulseConnectionProperties: @pytest.fixture -def get_mocked_mapped_static_responses() -> dict[str, str]: +def get_mocked_url(get_mocked_connection_properties): + def _get_mocked_url(path: str) -> str: + return get_mocked_connection_properties.make_url(path) + + return _get_mocked_url + + +@pytest.fixture +def get_relative_mocked_url(get_mocked_connection_properties): + def _get_relative_mocked_url(path: str) -> str: + return remove_prefix( + get_mocked_connection_properties.make_url(path), DEFAULT_API_HOST + ) + + return _get_relative_mocked_url + + +@pytest.fixture +def get_mocked_mapped_static_responses(get_mocked_url) -> dict[str, str]: """Fixture to get the test mapped responses.""" - cp = get_mocked_connection_properties() return { - cp.make_url("/"): "index.html", - cp.make_url(ADT_LOGIN_URI): "signin.html", - cp.make_url(ADT_LOGOUT_URI): "signout.html", - cp.make_url(ADT_SUMMARY_URI): "summary.html", - cp.make_url(ADT_SYSTEM_URI): "system.html", - cp.make_url(ADT_DEVICE_URI): "device.html", + get_mocked_url(ADT_LOGIN_URI): "signin.html", + get_mocked_url(ADT_SUMMARY_URI): "summary.html", + get_mocked_url(ADT_SYSTEM_URI): "system.html", + get_mocked_url(ADT_GATEWAY_URI): "gateway.html", } +@pytest.fixture def extract_ids_from_data_directory() -> list[str]: """Extract the device ids all the device files in the data directory.""" - id_pattern = re.compile(r"device-(\d{1,})\.html") + id_pattern = re.compile(r"device_(\d{1,})\.html") ids = set() for file_name in os.listdir(test_file_dir): match = id_pattern.match(file_name) @@ -115,36 +130,67 @@ def extract_ids_from_data_directory() -> list[str]: @pytest.fixture -def mocked_server_responses(): +def get_default_sync_check() -> str: + return "234532-456432-0" + + +@pytest.fixture +def mocked_server_responses( + get_mocked_mapped_static_responses: dict[str, str], + read_file, + get_mocked_url, + extract_ids_from_data_directory: list[str], +) -> Generator[aioresponses, Any, None]: """Fixture to get the test mapped responses.""" - static_responses = get_mocked_mapped_static_responses() + static_responses = get_mocked_mapped_static_responses with aioresponses() as responses: for url, file_name in static_responses.items(): - responses.add(url, "GET", body=read_file()(file_name)) - # login/logout - responses.add( - static_responses[ADT_LOGIN_URI], - status=web.HTTPFound.status_code, - headers={"Location": static_responses[ADT_SUMMARY_URI]}, - ) - responses.add( - static_responses[ADT_LOGIN_URI], - status=web.HTTPFound.status_code, - headers={"Location": static_responses[ADT_LOGOUT_URI]}, + responses.get( + url, body=read_file(file_name), content_type="text/html", repeat=True ) + # device id rewriting - for device_id in extract_ids_from_data_directory(): - responses.add( - f"{ADT_DEVICE_URI}?id={device_id}", - "GET", - body=read_file()(f"device-{device_id}.html"), - ) - # default sync check response - responses.add( - get_mocked_connection_properties().make_url(ADT_SYNC_CHECK_URI), - "GET", - body="235632-234545-0", + for device_id in extract_ids_from_data_directory: + responses.get( + f"{get_mocked_url(ADT_DEVICE_URI)}?id={device_id}", + body=read_file(f"device_{device_id}.html"), + content_type="text/html", ) + # redirects + responses.get( + DEFAULT_API_HOST, + status=302, + headers={"Location": get_mocked_url(ADT_LOGIN_URI)}, + repeat=True, + ) + responses.get( + f"{DEFAULT_API_HOST}/", + status=302, + headers={"Location": get_mocked_url(ADT_LOGIN_URI)}, + repeat=True, + ) + responses.get( + f"{DEFAULT_API_HOST}/{ADT_LOGIN_URI}", + status=307, + headers={"Location": get_mocked_url(ADT_LOGIN_URI)}, + repeat=True, + ) + # login/logout + responses.post( + get_mocked_url(ADT_LOGIN_URI), + status=302, + headers={ + "Location": get_mocked_url(ADT_SUMMARY_URI), + }, + ) + responses.get( + get_mocked_url(ADT_LOGOUT_URI), + status=302, + headers={"Location": get_mocked_url(ADT_LOGIN_URI)}, + repeat=True, + ) + # not doing default sync check response or keepalive + # because we need to set it on each test yield responses @@ -158,8 +204,7 @@ def patched_sync_task_sleep() -> Generator[AsyncMock, Any, Any]: yield mock - -class PulseMockedWebServer(): +class PulseMockedWebServer: """Mocked Pulse Web Server.""" def __init__(self, pulse_properties: PulseConnectionProperties): @@ -177,7 +222,6 @@ def __init__(self, pulse_properties: PulseConnectionProperties): self._make_local_prefix(ADT_SYSTEM_URI): ["system.html"], self._make_local_prefix(ADT_SYNC_CHECK_URI): ["sync_check.html"], self._make_local_prefix(ADT_ORB_URI): ["orb.html"], - self._make_local_prefix(ADT_ZONES_URI): ["zones.html"], self._make_local_prefix(ADT_SYSTEM_SETTINGS): ["system_settings.html"], } super().__init__() @@ -292,10 +336,11 @@ def handle_add_response( if len(files_to_serve) > 1: file_to_serve = self.uri_mapping[path].pop(1) return serve_file(file_to_serve) - + + @pytest.fixture @pytest.mark.asyncio -async def mocked_pulse_server() -> PulseMockedWebServer: +async def mocked_pulse_server() -> PulseMockedWebServer: """Fixture to create a mocked Pulse server.""" pulse_properties = get_mocked_connection_properties() m = PulseMockedWebServer(pulse_properties) diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 49f6704..281c05b 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -18,6 +18,7 @@ ADT_SYSTEM_URI = "/system/system.jsp" ADT_DEVICE_URI = "/system/device.jsp" ADT_STATES_URI = "/ajax/currentStates.jsp" +ADT_GATEWAY_URI = "/system/gateway.jsp" ADT_SYNC_CHECK_URI = "/Ajax/SyncCheckServ" ADT_TIMEOUT_URI = "/KeepAlive" # Intervals are all in minutes diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 2aed5fb..b275972 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -496,6 +496,7 @@ async def wait_for_update(self) -> bool: self._sync_task = asyncio.create_task( coro, name=f"{SYNC_CHECK_TASK_NAME}: Async session" ) + await asyncio.sleep(0) if self._pulse_properties.updates_exist is None: raise RuntimeError("Update event does not exist") diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 86266f3..4d20790 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -11,7 +11,7 @@ from typeguard import typechecked from .alarm_panel import ADTPulseAlarmPanel -from .const import ADT_DEVICE_URI, ADT_GATEWAY_STRING, ADT_SYSTEM_URI +from .const import ADT_DEVICE_URI, ADT_GATEWAY_STRING, ADT_GATEWAY_URI, ADT_SYSTEM_URI from .gateway import ADTPulseGateway from .pulse_connection import PulseConnection from .util import ( @@ -215,7 +215,7 @@ async def _get_device_attributes(self, device_id: str) -> dict[str, str] | None: result: dict[str, str] = {} if device_id == ADT_GATEWAY_STRING: device_response = await self._pulse_connection.async_query( - "/system/gateway.jsp", timeout=10 + ADT_GATEWAY_URI, timeout=10 ) else: device_response = await self._pulse_connection.async_query( diff --git a/pyproject.toml b/pyproject.toml index efc5c8a..57df6ba 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -10,14 +10,9 @@ repository = "https://github.com/rlippmann/pyadtpulse" classifiers = [ "Programming Language :: Python :: 3", "License :: OSI Approved :: Apache Software License", - "Operating System :: OS Independent", + "Operating System :: OS Independent" ] -include = [ - { path = "doc"}, - "example-client.py", - "example-client.json", - "CHANGELOG.md", -] + [tool.poetry.dependencies] python = "^3.11" @@ -70,3 +65,5 @@ all = true [tool.pytest.ini_options] timeout = 30 + +[tool.pyright] diff --git a/tests/data_files/signin.html b/tests/data_files/signin.html new file mode 100644 index 0000000..48f41c3 --- /dev/null +++ b/tests/data_files/signin.html @@ -0,0 +1,168 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - Sign In + + + + + +
+
+
+
+
+ + + + + + + + + + + + + +
+
+ + + +
+
+ ADT Security Services + | Privacy Policy + | ADT Pulse Terms of Use + | Customer Support + +
+ + + + diff --git a/tests/test_pqm.py b/tests/test_pqm.py deleted file mode 100644 index acabb24..0000000 --- a/tests/test_pqm.py +++ /dev/null @@ -1,30 +0,0 @@ -"""Test Pulse Query Manager.""" -from typing import Callable -import aiohttp - - -import pytest - - -@pytest.fixture -@pytest.mark.asyncio -async def test_mocked_responses( - read_file: Callable[[str], str], - mocked_server_responses, - get_mocked_mapped_static_responses: dict[str, str], -): - """Fixture to test mocked responses.""" - static_responses = get_mocked_mapped_static_responses - with mocked_server_responses: - async with aiohttp.ClientSession() as session: - for url, file_name in static_responses.items(): - # Make an HTTP request to the URL - response = await session.get(url) - - # Assert the status code is 200 - assert response.status == 200 - - # Assert the content matches the content of the file - expected_content = read_file(file_name) - actual_content = await response.text() - assert actual_content == expected_content diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py new file mode 100644 index 0000000..108ef28 --- /dev/null +++ b/tests/test_pulse_async.py @@ -0,0 +1,313 @@ +"""Test Pulse Query Manager.""" +import asyncio +import re +from unittest.mock import AsyncMock, patch + +import aiohttp +import pytest + +from pyadtpulse.const import ( + ADT_DEVICE_URI, + ADT_LOGIN_URI, + ADT_LOGOUT_URI, + ADT_ORB_URI, + ADT_SUMMARY_URI, + ADT_SYNC_CHECK_URI, + ADT_TIMEOUT_URI, + DEFAULT_API_HOST, +) +from pyadtpulse.pyadtpulse_async import PyADTPulseAsync + + +def set_sync_check( + get_mocked_url, mocked_server_responses, body: str, repeat: bool = False +): + r = re.compile(r"^" + re.escape(get_mocked_url(ADT_SYNC_CHECK_URI) + r"\?.*")) + mocked_server_responses.get(r, body=body, repeat=repeat, content_type="text/html") + + +def set_keepalive(get_mocked_url, mocked_server_responses, repeat: bool = False): + m = mocked_server_responses + m.post( + get_mocked_url(ADT_TIMEOUT_URI), + body="", + content_type="text/html", + repeat=repeat, + ) + + +@pytest.mark.asyncio +async def test_mocked_responses( + read_file, + mocked_server_responses, + get_mocked_mapped_static_responses, + get_mocked_url, + extract_ids_from_data_directory, + get_default_sync_check, +): + """Fixture to test mocked responses.""" + static_responses = get_mocked_mapped_static_responses + m = mocked_server_responses + async with aiohttp.ClientSession() as session: + for url, file_name in static_responses.items(): + # Make an HTTP request to the URL + response = await session.get(url) + + # Assert the status code is 200 + assert response.status == 200 + + # Assert the content matches the content of the file + expected_content = read_file(file_name) + actual_content = await response.text() + assert actual_content == expected_content + devices = extract_ids_from_data_directory + for device_id in devices: + response = await session.get( + f"{get_mocked_url(ADT_DEVICE_URI)}?id={device_id}" + ) + assert response.status == 200 + expected_content = read_file(f"device_{device_id}.html") + actual_content = await response.text() + assert actual_content == expected_content + + # redirects + + response = await session.get(f"{DEFAULT_API_HOST}/", allow_redirects=True) + assert response.status == 200 + actual_content = await response.text() + expected_content = read_file(static_responses[get_mocked_url(ADT_LOGIN_URI)]) + assert actual_content == expected_content + response = await session.get( + get_mocked_url(ADT_LOGOUT_URI), allow_redirects=True + ) + assert response.status == 200 + expected_content = read_file(static_responses[get_mocked_url(ADT_LOGIN_URI)]) + actual_content = await response.text() + assert actual_content == expected_content + response = await session.post( + get_mocked_url(ADT_LOGIN_URI), allow_redirects=True + ) + assert response.status == 200 + expected_content = read_file(static_responses[get_mocked_url(ADT_SUMMARY_URI)]) + actual_content = await response.text() + assert actual_content == expected_content + set_sync_check(get_mocked_url, m, get_default_sync_check) + set_sync_check(get_mocked_url, m, "1-0-0") + set_sync_check(get_mocked_url, m, get_default_sync_check) + response = await session.get( + get_mocked_url(ADT_SYNC_CHECK_URI), params={"ts": "first call"} + ) + assert response.status == 200 + actual_content = await response.text() + expected_content = get_default_sync_check + assert actual_content == expected_content + response = await session.get( + get_mocked_url(ADT_SYNC_CHECK_URI), params={"ts": "second call"} + ) + assert response.status == 200 + actual_content = await response.text() + assert actual_content == "1-0-0" + response = await session.get( + get_mocked_url(ADT_SYNC_CHECK_URI), params={"ts": "third call"} + ) + assert response.status == 200 + actual_content = await response.text() + assert actual_content == expected_content + set_keepalive(get_mocked_url, m) + response = await session.post(get_mocked_url(ADT_TIMEOUT_URI)) + + +@pytest.fixture +def wrap_wait_for_update(): + with patch.object( + PyADTPulseAsync, + "wait_for_update", + new_callable=AsyncMock, + spec=PyADTPulseAsync, + wraps=PyADTPulseAsync.wait_for_update, + ) as wait_for_update: + yield wait_for_update + + +@pytest.fixture +@pytest.mark.asyncio +async def adt_pulse_instance(mocked_server_responses, extract_ids_from_data_directory): + p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") + await p.async_login() + # Assertions after login + assert p.site.name == "Robert Lippmann" + assert p._timeout_task is not None + assert p._timeout_task.get_name() == p._get_timeout_task_name() + assert p._sync_task is None + assert p.site.zones_as_dict is not None + assert len(p.site.zones_as_dict) == len(extract_ids_from_data_directory) - 3 + return p, mocked_server_responses + + +@pytest.mark.asyncio +async def test_login(adt_pulse_instance, extract_ids_from_data_directory): + """Fixture to test login.""" + p, _ = await adt_pulse_instance + # make sure everything is there on logout + await p.async_logout() + assert p.site.name == "Robert Lippmann" + assert p.site.zones_as_dict is not None + assert len(p.site.zones_as_dict) == len(extract_ids_from_data_directory) - 3 + assert p._timeout_task is None + + +async def do_wait_for_update(p: PyADTPulseAsync, shutdown_event: asyncio.Event): + while not shutdown_event.is_set(): + try: + await p.wait_for_update() + except asyncio.CancelledError: + break + + +@pytest.mark.asyncio +@patch.object( + PyADTPulseAsync, + "wait_for_update", + side_effect=PyADTPulseAsync.wait_for_update, + autospec=True, +) +async def test_wait_for_update(m, adt_pulse_instance): + p, _ = await adt_pulse_instance + shutdown_event = asyncio.Event() + task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) + await asyncio.sleep(1) + while task.get_stack is None: + await asyncio.sleep(1) + await p.async_logout() + assert p._sync_task is None + assert p.site.name == "Robert Lippmann" + # just cancel, otherwise wait for update will wait forever + task.cancel() + await task + assert m.call_count == 1 + + +@pytest.mark.asyncio +# @patch.object( +# PyADTPulseAsync, +# "wait_for_update", +# side_effect=PyADTPulseAsync.wait_for_update, +# autospec=True, +# ) +async def test_orb_update( + mocked_server_responses, get_mocked_url, read_file, get_default_sync_check +): + response = mocked_server_responses + + def setup_sync_check(): + response.get( + get_mocked_url(ADT_ORB_URI), + body=read_file("orb_patio_opened.html"), + content_type="text/html", + ) + response.get( + get_mocked_url(ADT_ORB_URI), + body=read_file("orb.html"), + content_type="text/html", + ) + response.get( + get_mocked_url(ADT_SYNC_CHECK_URI), + body=get_default_sync_check, + content_type="text/html", + ) + response.get( + get_mocked_url(ADT_SYNC_CHECK_URI), body="1-0-0", content_type="text/html" + ) + response.get( + get_mocked_url(ADT_SYNC_CHECK_URI), + body=get_default_sync_check, + content_type="text/html", + ) + response.get( + get_mocked_url(ADT_SYNC_CHECK_URI), + body=get_default_sync_check, + content_type="text/html", + ) + + async def test_sync_check_and_orb(): + code, content, _ = await p._pulse_connection.async_query( + ADT_ORB_URI, requires_authentication=False + ) + assert code == 200 + assert content == read_file("orb_patio_opened.html") + await asyncio.sleep(1) + code, content, _ = await p._pulse_connection.async_query( + ADT_ORB_URI, requires_authentication=False + ) + assert code == 200 + assert content == read_file("orb.html") + await asyncio.sleep(1) + code, content, _ = await p._pulse_connection.async_query( + ADT_SYNC_CHECK_URI, requires_authentication=False + ) + assert code == 200 + assert content == get_default_sync_check + code, content, _ = await p._pulse_connection.async_query( + ADT_SYNC_CHECK_URI, requires_authentication=False + ) + assert code == 200 + assert content == "1-0-0" + code, content, _ = await p._pulse_connection.async_query( + ADT_SYNC_CHECK_URI, requires_authentication=False + ) + assert code == 200 + assert content == get_default_sync_check + + p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") + shutdown_event = asyncio.Event() + shutdown_event.clear() + setup_sync_check() + # do a first run though to make sure aioresponses will work ok + await test_sync_check_and_orb() + setup_sync_check() + response.get( + get_mocked_url(ADT_SYNC_CHECK_URI), + content_type="text/html", + repeat=True, + body=get_default_sync_check, + ) + await p.async_login() + task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) + await asyncio.sleep(5) + assert p._sync_task is not None + shutdown_event.set() + task.cancel() + await task + await p.async_logout() + assert p._sync_task is None + # assert m.call_count == 2 + + +@pytest.mark.asyncio +async def test_keepalive_check(mocked_server_responses): + p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") + await p.async_login() + assert p._timeout_task is not None + await asyncio.sleep() + + +@pytest.mark.asyncio +async def test_infinite_sync_check( + mocked_server_responses, get_mocked_url, get_default_sync_check +): + p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") + mocked_server_responses.get( + get_mocked_url(ADT_SYNC_CHECK_URI), + body=get_default_sync_check, + content_type="text/html", + repeat=True, + ) + shutdown_event = asyncio.Event() + shutdown_event.clear() + await p.async_login() + task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) + await asyncio.sleep(5) + assert mocked_server_responses.call_count > 1 + shutdown_event.set() + task.cancel() + await task From 35374debacf19dcc67b2b9bb50312c082672e264 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 20 Nov 2023 10:27:57 -0500 Subject: [PATCH 116/226] add backoff object --- pyadtpulse/const.py | 4 +- pyadtpulse/gateway.py | 34 +++--- pyadtpulse/pulse_backoff.py | 158 ++++++++++++++++++++++++++ pyadtpulse/pulse_connection.py | 27 ++++- pyadtpulse/pulse_connection_status.py | 19 ++-- pyadtpulse/pulse_query_manager.py | 32 +++--- pyadtpulse/pyadtpulse_async.py | 29 +---- 7 files changed, 235 insertions(+), 68 deletions(-) create mode 100644 pyadtpulse/pulse_backoff.py diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 281c05b..504006d 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -31,8 +31,8 @@ # ADT sets their keepalive to 1 second, so poll a little more often # than that ADT_DEFAULT_POLL_INTERVAL = 2.0 -ADT_GATEWAY_OFFLINE_POLL_INTERVAL = 90.0 -ADT_MAX_RELOGIN_BACKOFF: float = 15.0 * 60.0 +ADT_GATEWAY_MAX_OFFLINE_POLL_INTERVAL = 600.0 +ADT_MAX_BACKOFF: float = 15.0 * 60.0 ADT_DEFAULT_HTTP_USER_AGENT = { "User-Agent": ( "Mozilla/5.0 (Windows NT 10.0; Win64; x64) " diff --git a/pyadtpulse/gateway.py b/pyadtpulse/gateway.py index 5cdd080..e244dc5 100644 --- a/pyadtpulse/gateway.py +++ b/pyadtpulse/gateway.py @@ -8,7 +8,8 @@ from typeguard import typechecked -from .const import ADT_DEFAULT_POLL_INTERVAL, ADT_GATEWAY_OFFLINE_POLL_INTERVAL +from .const import ADT_DEFAULT_POLL_INTERVAL, ADT_GATEWAY_MAX_OFFLINE_POLL_INTERVAL +from .pulse_backoff import PulseBackoff from .util import parse_pulse_datetime LOG = logging.getLogger(__name__) @@ -43,8 +44,9 @@ class ADTPulseGateway: manufacturer: str = "Unknown" _status_text: str = "OFFLINE" - _current_poll_interval: float = ADT_DEFAULT_POLL_INTERVAL - _initial_poll_interval: float = ADT_DEFAULT_POLL_INTERVAL + _backoff = PulseBackoff( + "Gateway", ADT_DEFAULT_POLL_INTERVAL, ADT_GATEWAY_MAX_OFFLINE_POLL_INTERVAL + ) _attribute_lock = RLock() model: str | None = None serial_number: str | None = None @@ -90,14 +92,14 @@ def is_online(self, status: bool) -> None: self._status_text = "ONLINE" if not status: self._status_text = "OFFLINE" - self._current_poll_interval = ADT_GATEWAY_OFFLINE_POLL_INTERVAL + self._backoff.increment_backoff() else: - self._current_poll_interval = self._initial_poll_interval + self._backoff.reset_backoff() LOG.info( "ADT Pulse gateway %s, poll interval=%f", self._status_text, - self._current_poll_interval, + self._backoff.get_current_backoff_interval(), ) @property @@ -108,7 +110,7 @@ def poll_interval(self) -> float: float: number of seconds between polls """ with self._attribute_lock: - return self._current_poll_interval + return self._backoff.get_current_backoff_interval() @poll_interval.setter @typechecked @@ -124,13 +126,9 @@ def poll_interval(self, new_interval: float | None) -> None: """ if new_interval is None: new_interval = ADT_DEFAULT_POLL_INTERVAL - elif new_interval < 0.0: - raise ValueError("ADT Pulse polling interval must be greater than 0") with self._attribute_lock: - self._initial_poll_interval = new_interval - if self._current_poll_interval != ADT_GATEWAY_OFFLINE_POLL_INTERVAL: - self._current_poll_interval = new_interval - LOG.debug("Set poll interval to %f", self._initial_poll_interval) + self._backoff.initial_backoff_interval = new_interval + LOG.debug("Set poll interval to %f", new_interval) def adjust_backoff_poll_interval(self) -> None: """Calculates the backoff poll interval. @@ -141,14 +139,12 @@ def adjust_backoff_poll_interval(self) -> None: with self._attribute_lock: if self.is_online: - self._current_poll_interval = self._initial_poll_interval + self._backoff.reset_backoff() return - # use an exponential backoff - self._current_poll_interval = self._current_poll_interval * 2 - if self._current_poll_interval > ADT_GATEWAY_OFFLINE_POLL_INTERVAL: - self._current_poll_interval = ADT_DEFAULT_POLL_INTERVAL + self._backoff.increment_backoff() LOG.debug( - "Setting current poll interval to %f", self._current_poll_interval + "Setting current poll interval to %f", + self._backoff.get_current_backoff_interval(), ) @typechecked diff --git a/pyadtpulse/pulse_backoff.py b/pyadtpulse/pulse_backoff.py new file mode 100644 index 0000000..79dc311 --- /dev/null +++ b/pyadtpulse/pulse_backoff.py @@ -0,0 +1,158 @@ +"""Pulse backoff object.""" +import datetime +from logging import getLogger +from asyncio import sleep +from time import time + +from typeguard import typechecked + +from .const import ADT_MAX_BACKOFF +from .util import set_debug_lock + +LOG = getLogger(__name__) + + +class PulseBackoff: + """Pulse backoff object.""" + + __slots__ = ( + "_b_lock", + "_initial_backoff_interval", + "_max_backoff_interval", + "_backoff_count", + "_expiration_time", + "_name", + "_detailed_debug_logging", + "_threshold", + ) + + @typechecked + def __init__( + self, + name: str, + initial_backoff_interval: float, + max_backoff_interval: float = ADT_MAX_BACKOFF, + threshold: int = 0, + debug_locks: bool = False, + detailed_debug_logging=False, + ) -> None: + """Initialize backoff.""" + self._b_lock = set_debug_lock(debug_locks, "pyadtpulse._b_lock") + self._initial_backoff_interval = initial_backoff_interval + self._max_backoff_interval = max_backoff_interval + self._backoff_count = 0 + self._expiration_time = 0.0 + self._name = name + self._detailed_debug_logging = detailed_debug_logging + self._threshold = threshold + + def _calculate_backoff_interval(self) -> float: + """Calculate backoff time.""" + if self._backoff_count <= self._threshold: + return self._initial_backoff_interval + return min( + self._initial_backoff_interval + * (2 ** (self._backoff_count - self._threshold)), + self._max_backoff_interval, + ) + + def get_current_backoff_interval(self) -> float: + """Return current backoff time.""" + with self._b_lock: + return self._calculate_backoff_interval() + + def increment_backoff(self) -> None: + """Increment backoff.""" + with self._b_lock: + self._backoff_count += 1 + expiration_time = self._calculate_backoff_interval() + time() + + if expiration_time > self._expiration_time: + LOG.debug( + "Pulse backoff %s: %s expires at %s", + self._name, + self._backoff_count, + datetime.datetime.fromtimestamp(self._expiration_time).strftime( + "%m/%d/%Y %H:%M:%S" + ), + ) + self._expiration_time = expiration_time + else: + if self._detailed_debug_logging: + LOG.debug( + "Pulse backoff %s: not updated " + "because already expires at %s", + self._name, + datetime.datetime.fromtimestamp(self._expiration_time).strftime( + "%m/%d/%Y %H:%M:%S" + ), + ) + + def reset_backoff(self) -> None: + """Reset backoff.""" + with self._b_lock: + if self._expiration_time == 0.0 or time() > self._expiration_time: + self._backoff_count = 0 + self._backoff_count = 0 + self._expiration_time = 0.0 + + @typechecked + def set_absolute_backoff_time(self, backoff_time: float) -> None: + """Set absolute backoff time.""" + if backoff_time != 0 and backoff_time < time(): + raise ValueError("backoff_time cannot be less than current time") + with self._b_lock: + LOG.debug( + "Pulse backoff %s: set to %s", + self._name, + datetime.datetime.fromtimestamp(backoff_time).strftime( + "%m/%d/%Y %H:%M:%S" + ), + ) + self._expiration_time = backoff_time + + async def wait_for_backoff(self) -> None: + """Wait for backoff.""" + with self._b_lock: + diff = self._expiration_time - time() + if diff > 0: + if self._detailed_debug_logging: + LOG.debug("Backoff %s: waiting for %s", self._name, diff) + await sleep(diff) + + def will_backoff(self) -> bool: + """Return if backoff is needed.""" + with self._b_lock: + return self._expiration_time >= time() + + @property + def backoff_count(self) -> int: + """Return backoff count.""" + with self._b_lock: + return self._backoff_count + + @property + def expiration_time(self) -> float: + """Return backoff expiration time.""" + with self._b_lock: + return self._expiration_time + + @property + def initial_backoff_interval(self) -> float: + """Return initial backoff interval.""" + with self._b_lock: + return self._initial_backoff_interval + + @initial_backoff_interval.setter + @typechecked + def initial_backoff_interval(self, new_interval: float) -> None: + """Set initial backoff interval.""" + if new_interval <= 0.0: + raise ValueError("Initial backoff interval must be greater than 0") + with self._b_lock: + self._initial_backoff_interval = new_interval + + @property + def name(self) -> str: + """Return name.""" + return self._name diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index e4ca76d..d65e357 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -19,6 +19,7 @@ ConnectionFailureReason, ) from .pulse_authentication_properties import PulseAuthenticationProperties +from .pulse_backoff import PulseBackoff from .pulse_connection_properties import PulseConnectionProperties from .pulse_connection_status import PulseConnectionStatus from .pulse_query_manager import PulseQueryManager @@ -33,7 +34,12 @@ class PulseConnection(PulseQueryManager): """ADT Pulse connection related attributes.""" - __slots__ = ("_pc_attribute_lock", "_authentication_properties", "_debug_locks") + __slots__ = ( + "_pc_attribute_lock", + "_authentication_properties", + "_login_backoff", + "_debug_locks", + ) @typechecked def __init__( @@ -56,6 +62,9 @@ def __init__( self._connection_properties = pulse_connection_properties self._connection_status = pulse_connection_status self._authentication_properties = pulse_authentication + self._login_backoff = PulseBackoff( + "Login", pulse_connection_status._backoff.initial_backoff_interval + ) super().__init__( pulse_connection_status, pulse_connection_properties, @@ -70,6 +79,8 @@ async def async_do_login_query( """ Performs a login query to the Pulse site. + Will backoff on login failures. + Args: timeout (int, optional): The timeout value for the query in seconds. Defaults to 30. @@ -95,7 +106,9 @@ def extract_seconds_from_string(s: str) -> int: def check_response( response: tuple[int, str | None, URL | None] ) -> BeautifulSoup | None: - """Check response for errors.""" + """Check response for errors. + + Will handle setting backoffs.""" if not handle_response( response[0], response[2], @@ -105,6 +118,7 @@ def check_response( self._connection_status.connection_failure_reason = ( ConnectionFailureReason.UNKNOWN ) + self._login_backoff.increment_backoff() return None soup = make_soup( @@ -122,7 +136,10 @@ def check_response( error_text = error.get_text() LOG.error("Error logging into pulse: %s", error_text) if retry_after := extract_seconds_from_string(error_text) > 0: - self._connection_status.retry_after = int(time()) + retry_after + self._login_backoff.set_absolute_backoff_time(time() + retry_after) + self._connection_status.connection_failure_reason = ( + ConnectionFailureReason.ACCOUNT_LOCKED + ) return None url = self._connection_properties.make_url(ADT_SUMMARY_URI) if url != str(response[2]): @@ -160,6 +177,7 @@ def check_response( "networkid": self._authentication_properties.site_id, "fingerprint": fingerprint, } + await self._login_backoff.wait_for_backoff() try: response = await self.async_query( ADT_LOGIN_URI, @@ -174,18 +192,21 @@ def check_response( logging.ERROR, "Error encountered during ADT login GET", ): + self._login_backoff.increment_backoff() return None except Exception as e: # pylint: disable=broad-except LOG.error("Could not log into Pulse site: %s", e) self._connection_status.connection_failure_reason = ( ConnectionFailureReason.UNKNOWN ) + self._login_backoff.increment_backoff() return None soup = check_response(response) if soup is None: return None self._connection_status.authenticated_flag.set() self._authentication_properties.last_login_time = int(time()) + self._login_backoff.reset_backoff() return soup @typechecked diff --git a/pyadtpulse/pulse_connection_status.py b/pyadtpulse/pulse_connection_status.py index cf6b536..4d4ddab 100644 --- a/pyadtpulse/pulse_connection_status.py +++ b/pyadtpulse/pulse_connection_status.py @@ -1,10 +1,10 @@ """Pulse Connection Status.""" from asyncio import Event -from time import time from typeguard import typechecked from .const import ConnectionFailureReason +from .pulse_backoff import PulseBackoff from .util import set_debug_lock @@ -12,7 +12,7 @@ class PulseConnectionStatus: """Pulse Connection Status.""" __slots__ = ( - "_retry_after", + "_backoff", "_connection_failure_reason", "_authenticated_flag", "_pcs_attribute_lock", @@ -23,7 +23,10 @@ def __init__(self, debug_locks: bool = False): self._pcs_attribute_lock = set_debug_lock( debug_locks, "pyadtpulse.pcs_attribute_lock" ) - self._retry_after = int(time()) + self._backoff = PulseBackoff( + "Connection Status", + initial_backoff_interval=1, + ) self._connection_failure_reason = ConnectionFailureReason.NO_FAILURE self._authenticated_flag = Event() @@ -50,13 +53,15 @@ def connection_failure_reason(self, reason: ConnectionFailureReason) -> None: def retry_after(self) -> int: """Get the number of seconds to wait before retrying HTTP requests.""" with self._pcs_attribute_lock: - return self._retry_after + return int(self._backoff.expiration_time) @retry_after.setter @typechecked def retry_after(self, seconds: int) -> None: """Set time after which HTTP requests can be retried.""" - if seconds < time(): - raise ValueError("retry_after cannot be less than current time") with self._pcs_attribute_lock: - self._retry_after = seconds + self._backoff.set_absolute_backoff_time(seconds) + + def get_backoff(self) -> PulseBackoff: + """Get the backoff object.""" + return self._backoff diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index 4a2f709..ab02c09 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -1,9 +1,8 @@ """Pulse Query Manager.""" from logging import getLogger -from asyncio import current_task, sleep +from asyncio import current_task from datetime import datetime from http import HTTPStatus -from random import uniform from time import time from aiohttp import ( @@ -23,6 +22,7 @@ ADT_OTHER_HTTP_ACCEPT_HEADERS, ConnectionFailureReason, ) +from .pulse_backoff import PulseBackoff from .pulse_connection_properties import PulseConnectionProperties from .pulse_connection_status import PulseConnectionStatus from .util import make_soup, set_debug_lock @@ -41,7 +41,12 @@ class PulseQueryManager: """Pulse Query Manager.""" - __slots__ = ("_pqm_attribute_lock", "_connection_properties", "_connection_status") + __slots__ = ( + "_pqm_attribute_lock", + "_connection_properties", + "_connection_status", + "_query_backoff", + ) @staticmethod @typechecked @@ -63,6 +68,12 @@ def __init__( ) self._connection_status = connection_status self._connection_properties = connection_properties + self._query_backoff = PulseBackoff( + "Query", + connection_status.get_backoff().initial_backoff_interval, + threshold=1, + debug_locks=debug_locks, + ) @typechecked def _compute_retry_after(self, code: int, retry_after: str) -> None: @@ -147,16 +158,7 @@ async def handle_query_response( if method not in ("GET", "POST"): raise ValueError("method must be GET or POST") - current_time = time() - if self._connection_status.retry_after > current_time: - LOG.debug( - "Retry after set, query %s for %s waiting until %s", - method, - uri, - datetime.fromtimestamp(self._connection_status.retry_after), - ) - await sleep(self._connection_status.retry_after - current_time) - + await self._connection_status.get_backoff().wait_for_backoff() if ( requires_authentication and not self._connection_status.authenticated_flag.is_set() @@ -188,6 +190,7 @@ async def handle_query_response( ) while retry < MAX_RETRIES: try: + await self._query_backoff.wait_for_backoff() async with self._connection_properties.session.request( method, url, @@ -197,6 +200,7 @@ async def handle_query_response( timeout=timeout, ) as response: return_value = await handle_query_response(response) + self._query_backoff.increment_backoff() retry += 1 if return_value[0] in RECOVERABLE_ERRORS: @@ -212,7 +216,6 @@ async def handle_query_response( "Exceeded max retries of %d, giving up", MAX_RETRIES ) response.raise_for_status() - await sleep(2**retry + uniform(0.0, 1.0)) continue response.raise_for_status() @@ -237,6 +240,7 @@ async def handle_query_response( exc_info=True, ) break + self._query_backoff.reset_backoff() return (return_value[0], return_value[1], return_value[2]) async def query_orb(self, level: int, error_message: str) -> BeautifulSoup | None: diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index b275972..24e315f 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -18,7 +18,6 @@ ADT_DEFAULT_KEEPALIVE_INTERVAL, ADT_DEFAULT_RELOGIN_INTERVAL, ADT_GATEWAY_STRING, - ADT_MAX_RELOGIN_BACKOFF, ADT_SYNC_CHECK_URI, ADT_TIMEOUT_URI, DEFAULT_API_HOST, @@ -241,7 +240,7 @@ def should_relogin(relogin_interval: int) -> bool: continue elif should_relogin(relogin_interval): await self.async_logout() - await self._do_login_with_backoff(task_name) + await self._login_looped(task_name) continue LOG.debug("Resetting timeout") code, response, url = await reset_pulse_cloud_timeout() @@ -278,9 +277,9 @@ async def _cancel_task(self, task: asyncio.Task | None) -> None: LOG.debug("%s successfully cancelled", task_name) await task - async def _do_login_with_backoff(self, task_name: str) -> None: + async def _login_looped(self, task_name: str) -> None: """ - Performs a logout and re-login process. + Logs in and loops until successful. Args: None. @@ -288,30 +287,14 @@ async def _do_login_with_backoff(self, task_name: str) -> None: None """ log_level = logging.DEBUG - login_backoff = 0.0 login_successful = False - def compute_login_backoff() -> float: - if login_backoff == 0.0: - return self.site.gateway.poll_interval - return min(ADT_MAX_RELOGIN_BACKOFF, login_backoff * 2.0) - while not login_successful: - LOG.log( - log_level, "%s logging in with backoff %f", task_name, login_backoff - ) - await asyncio.sleep(login_backoff) + LOG.log(log_level, "%s performming loop login", task_name) login_successful = await self.async_login() if login_successful: - if login_backoff != 0.0: - self._pulse_properties.set_update_status(True) return - # only set flag on first failure - if login_backoff == 0.0: - self._pulse_properties.set_update_status(False) - login_backoff = compute_login_backoff() - if login_backoff > RELOGIN_BACKOFF_WARNING_THRESHOLD: - log_level = logging.WARNING + self._pulse_properties.set_update_status(False) async def _sync_check_task(self) -> None: """Asynchronous function that performs a synchronization check task.""" @@ -353,7 +336,7 @@ async def validate_sync_check_response() -> bool: ) LOG.debug("Received %s from ADT Pulse site", response_text) await self.async_logout() - await self._do_login_with_backoff(task_name) + await self._login_looped(task_name) return False return True From fcfb37d9f8ef458e630341a9da89da58f2aecafa Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 20 Nov 2023 11:13:24 -0500 Subject: [PATCH 117/226] add login_in_progress flag --- pyadtpulse/pulse_connection.py | 37 ++++++++++++++++++++++++++++++++++ pyadtpulse/pyadtpulse_async.py | 6 ++++++ 2 files changed, 43 insertions(+) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index d65e357..bc49aeb 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -39,8 +39,26 @@ class PulseConnection(PulseQueryManager): "_authentication_properties", "_login_backoff", "_debug_locks", + "_login_in_progress", ) + @typechecked + @staticmethod + def login_flag(func): + """Decorator to set login in progress flag.""" + + def wrapper(self, *args, **kwargs): + # Set the flag to True before calling the function + self.login_in_progress = True + try: + result = func(self, *args, **kwargs) + finally: + # Reset the flag to False when the function returns + self.login_in_progress = False + return result + + return wrapper + @typechecked def __init__( self, @@ -65,6 +83,7 @@ def __init__( self._login_backoff = PulseBackoff( "Login", pulse_connection_status._backoff.initial_backoff_interval ) + self._login_in_progress = False super().__init__( pulse_connection_status, pulse_connection_properties, @@ -73,6 +92,7 @@ def __init__( self._debug_locks = debug_locks @typechecked + @login_flag async def async_do_login_query( self, username: str, password: str, fingerprint: str, timeout: int = 30 ) -> BeautifulSoup | None: @@ -81,6 +101,8 @@ async def async_do_login_query( Will backoff on login failures. + Will set login in progress flag. + Args: timeout (int, optional): The timeout value for the query in seconds. Defaults to 30. @@ -171,6 +193,8 @@ def check_response( return None return soup + with self._pc_attribute_lock: + self._login_in_progress = True data = { "usernameForm": username, "passwordForm": password, @@ -244,3 +268,16 @@ def check_sync(self, message: str) -> AbstractEventLoop: def debug_locks(self): """Return debug locks.""" return self._debug_locks + + @property + def login_in_progress(self) -> bool: + """Return login in progress.""" + with self._pc_attribute_lock: + return self._login_in_progress + + @login_in_progress.setter + @typechecked + def login_in_progress(self, value: bool) -> None: + """Set login in progress.""" + with self._pc_attribute_lock: + self._login_in_progress = value diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 24e315f..b183c63 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -407,6 +407,9 @@ async def async_login(self) -> bool: Returns: True if login successful """ + if self._pulse_connection.login_in_progress: + LOG.debug("Login already in progress, returning") + return True LOG.debug( "Authenticating to ADT Pulse cloud service as %s", self._authentication_properties.username, @@ -439,6 +442,9 @@ async def async_login(self) -> bool: async def async_logout(self) -> None: """Logout of ADT Pulse async.""" + if self._pulse_connection.login_in_progress: + LOG.debug("Login in progress, returning") + return LOG.info( "Logging %s out of ADT Pulse", self._authentication_properties.username ) From 7ef2035646baa7cb1e1183dcacc8d1cdd647bd65 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 20 Nov 2023 11:24:01 -0500 Subject: [PATCH 118/226] fix sync object --- pyadtpulse/__init__.py | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index b1b2886..a57c32d 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -60,7 +60,9 @@ def __init__( def __repr__(self) -> str: """Object representation.""" - return f"<{self.__class__.__name__}: {self._username}>" + return ( + f"<{self.__class__.__name__}: {self._authentication_properties.username}>" + ) # ADTPulse API endpoint is configurable (besides default US ADT Pulse endpoint) to # support testing as well as alternative ADT Pulse endpoints such as @@ -81,11 +83,11 @@ def _pulse_session_thread(self) -> None: LOG.debug("Creating ADT Pulse background thread") asyncio.set_event_loop_policy(uvloop.EventLoopPolicy()) loop = asyncio.new_event_loop() - self._pulse_connection.loop = loop + self._pulse_connection_properties.loop = loop loop.run_until_complete(self._sync_loop()) loop.close() - self._pulse_connection.loop = None + self._pulse_connection_properties.loop = None self._session_thread = None async def _sync_loop(self) -> None: @@ -122,7 +124,7 @@ async def _sync_loop(self) -> None: else: # we should never get here raise RuntimeError("Background pyadtpulse tasks not created") - while self._pulse_connection.authenticated_flag.is_set(): + while self._pulse_connection_status.authenticated_flag.is_set(): # busy wait until logout is done await asyncio.sleep(0.5) @@ -150,7 +152,7 @@ def login(self) -> None: self._p_attribute_lock.acquire() self._p_attribute_lock.release() if not thread.is_alive(): - raise AuthenticationException(self._username) + raise AuthenticationException(self._authentication_properties.username) def logout(self) -> None: """Log out of ADT Pulse.""" @@ -181,7 +183,7 @@ def loop(self) -> asyncio.AbstractEventLoop | None: Optional[asyncio.AbstractEventLoop]: the event loop object or None if no thread is running """ - return self._pulse_connection.loop + return self._pulse_connection_properties.loop @property def updates_exist(self) -> bool: @@ -192,7 +194,7 @@ def updates_exist(self) -> bool: """ with self._p_attribute_lock: if self._sync_task is None: - loop = self._pulse_connection.loop + loop = self._pulse_connection_properties.loop if loop is None: raise RuntimeError( "ADT pulse sync function updates_exist() " From e006457c3e775ea7fccc92fb44a343ce14f00f7a Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 20 Nov 2023 12:59:47 -0500 Subject: [PATCH 119/226] add check_async for __init__ --- pyadtpulse/__init__.py | 20 +++++++++++++++++++- pyadtpulse/pulse_connection_properties.py | 13 ++++++++++++- 2 files changed, 31 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index a57c32d..534bcbf 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -204,7 +204,7 @@ def updates_exist(self) -> bool: self._sync_task = loop.create_task( coro, name=f"{SYNC_CHECK_TASK_NAME}: Sync session" ) - return self._check_update_succeeded() + return self._pulse_properties.check_update_succeeded() def update(self) -> bool: """Update ADT Pulse data. @@ -219,3 +219,21 @@ def update(self) -> bool: "Attempting to run sync update from async login" ), ).result() + + async def async_login(self) -> bool: + self._pulse_connection_properties.check_async( + "Cannot login asynchronously with a synchronous session" + ) + return await super().async_login() + + async def async_logout(self) -> None: + self._pulse_connection_properties.check_async( + "Cannot logout asynchronously with a synchronous session" + ) + await super().async_logout() + + async def async_update(self) -> bool: + self._pulse_connection_properties.check_async( + "Cannot update asynchronously with a synchronous session" + ) + return await super().async_update() diff --git a/pyadtpulse/pulse_connection_properties.py b/pyadtpulse/pulse_connection_properties.py index d4c7c45..1626a68 100644 --- a/pyadtpulse/pulse_connection_properties.py +++ b/pyadtpulse/pulse_connection_properties.py @@ -137,12 +137,23 @@ def check_sync(self, message: str) -> AbstractEventLoop: """Checks if sync login was performed. Returns the loop to use for run_coroutine_threadsafe if so. - Raises RuntimeError with given message if not.""" + Raises RuntimeError with given message if not. + """ with self._pci_attribute_lock: if self._loop is None: raise RuntimeError(message) return self._loop + @typechecked + def check_async(self, message: str) -> None: + """Checks if async login was performed. + + Raises RuntimeError with given message if not. + """ + with self._pci_attribute_lock: + if self._loop is not None: + raise RuntimeError(message) + @property def loop(self) -> AbstractEventLoop | None: """Get the event loop.""" From 82d2951aec009944e2540c0742e403b636b8fe3f Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 20 Nov 2023 13:39:03 -0500 Subject: [PATCH 120/226] add client_error and server_error to ConnectionFailureReason --- pyadtpulse/const.py | 13 ++++++++++++- pyadtpulse/pulse_connection_status.py | 5 +++++ pyadtpulse/pulse_query_manager.py | 23 ++++++++++++++++++++--- 3 files changed, 37 insertions(+), 4 deletions(-) diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 504006d..1ee1032 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -86,7 +86,18 @@ class ConnectionFailureReason(Enum): UNKNOWN = 1, "Unknown Failure" ACCOUNT_LOCKED = 2, "Account Locked" INVALID_CREDENTIALS = 3, "Invalid Credentials" - MFA_REQUIRED = 4, "MFA Required" + MFA_REQUIRED = ( + 4, + "MFA Required", + ) + CLIENT_ERROR = ( + 5, + "Client Error", + ) + SERVER_ERROR = ( + 6, + "Server Error", + ) SERVICE_UNAVAILABLE = ( HTTPStatus.SERVICE_UNAVAILABLE.value, HTTPStatus.SERVICE_UNAVAILABLE.description, diff --git a/pyadtpulse/pulse_connection_status.py b/pyadtpulse/pulse_connection_status.py index 4d4ddab..7d88ef4 100644 --- a/pyadtpulse/pulse_connection_status.py +++ b/pyadtpulse/pulse_connection_status.py @@ -65,3 +65,8 @@ def retry_after(self, seconds: int) -> None: def get_backoff(self) -> PulseBackoff: """Get the backoff object.""" return self._backoff + + def increment_backoff(self) -> None: + """Increment the backoff.""" + with self._pcs_attribute_lock: + self._backoff.increment_backoff() diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index ab02c09..72c02e9 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -10,6 +10,7 @@ ClientConnectorError, ClientResponse, ClientResponseError, + ServerDisconnectedError, ) from bs4 import BeautifulSoup from typeguard import typechecked @@ -76,11 +77,14 @@ def __init__( ) @typechecked - def _compute_retry_after(self, code: int, retry_after: str) -> None: + def _set_retry_after(self, code: int, retry_after: str) -> None: """ Check the "Retry-After" header in the response and set retry_after property based upon it. + Will also set the connection status failure reason and rety after + properties. + Parameters: code (int): The HTTP response code retry_after (str): The value of the "Retry-After" header @@ -225,13 +229,26 @@ async def handle_query_response( ClientConnectionError, ClientConnectorError, ClientResponseError, + ServerDisconnectedError, ) as ex: if return_value[0] is not None and return_value[3] is not None: - self._compute_retry_after( + self._set_retry_after( return_value[0], return_value[3], ) - break + # _set_retry_after will set the status to one of + # SERVICE_UNAVAILABLE or TOO_MANY_REQUESTS + if self._connection_status.connection_failure_reason in ( + ConnectionFailureReason.SERVICE_UNAVAILABLE, + ConnectionFailureReason.TOO_MANY_REQUESTS, + ): + return 0, None, None + if type(ex) in (ServerDisconnectedError, ClientResponseError): + failure_reason = ConnectionFailureReason.SERVER_ERROR + else: + failure_reason = ConnectionFailureReason.CLIENT_ERROR + self._connection_status.connection_failure_reason = failure_reason + self._connection_status.increment_backoff() LOG.debug( "Error %s occurred making %s request to %s", ex.args, From 75e06f62fdec56c04a47700cae89f4af0e62d829 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 21 Nov 2023 14:31:03 -0500 Subject: [PATCH 121/226] backoff tests and fixes --- poetry.lock | 43 +- pyadtpulse/pulse_backoff.py | 42 +- pyproject.toml | 1 + tests/test_backoff.py | 860 ++++++++++++++++++++++++++++++++++++ 4 files changed, 931 insertions(+), 15 deletions(-) create mode 100644 tests/test_backoff.py diff --git a/poetry.lock b/poetry.lock index 708d006..db9d3e0 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.7.0 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand. [[package]] name = "aiohttp" @@ -423,6 +423,20 @@ docs = ["furo (>=2023.9.10)", "sphinx (>=7.2.6)", "sphinx-autodoc-typehints (>=1 testing = ["covdefaults (>=2.3)", "coverage (>=7.3.2)", "diff-cover (>=8)", "pytest (>=7.4.3)", "pytest-cov (>=4.1)", "pytest-mock (>=3.12)", "pytest-timeout (>=2.2)"] typing = ["typing-extensions (>=4.8)"] +[[package]] +name = "freezegun" +version = "1.2.2" +description = "Let your Python tests travel through time" +optional = false +python-versions = ">=3.6" +files = [ + {file = "freezegun-1.2.2-py3-none-any.whl", hash = "sha256:ea1b963b993cb9ea195adbd893a48d573fda951b0da64f60883d7e988b606c9f"}, + {file = "freezegun-1.2.2.tar.gz", hash = "sha256:cd22d1ba06941384410cd967d8a99d5ae2442f57dfafeff2fda5de8dc5c05446"}, +] + +[package.dependencies] +python-dateutil = ">=2.7" + [[package]] name = "frozenlist" version = "1.4.0" @@ -961,6 +975,20 @@ files = [ [package.dependencies] pytest = ">=5.0.0" +[[package]] +name = "python-dateutil" +version = "2.8.2" +description = "Extensions to the standard Python datetime module" +optional = false +python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" +files = [ + {file = "python-dateutil-2.8.2.tar.gz", hash = "sha256:0123cacc1627ae19ddf3c27a5de5bd67ee4586fbdd6440d9748f8abb483d3e86"}, + {file = "python_dateutil-2.8.2-py2.py3-none-any.whl", hash = "sha256:961d03dc3453ebbc59dbdea9e4e11c5651520a876d0f4db161e8674aae935da9"}, +] + +[package.dependencies] +six = ">=1.5" + [[package]] name = "pyupgrade" version = "3.15.0" @@ -1090,6 +1118,17 @@ docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "pygments testing = ["build[virtualenv]", "filelock (>=3.4.0)", "flake8-2020", "ini2toml[lite] (>=0.9)", "jaraco.develop (>=7.21)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "pip (>=19.1)", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-mypy (>=0.9.1)", "pytest-perf", "pytest-ruff", "pytest-timeout", "pytest-xdist", "tomli-w (>=1.0.0)", "virtualenv (>=13.0.0)", "wheel"] testing-integration = ["build[virtualenv] (>=1.0.3)", "filelock (>=3.4.0)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "packaging (>=23.1)", "pytest", "pytest-enabler", "pytest-xdist", "tomli", "virtualenv (>=13.0.0)", "wheel"] +[[package]] +name = "six" +version = "1.16.0" +description = "Python 2 and 3 compatibility utilities" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*" +files = [ + {file = "six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"}, + {file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"}, +] + [[package]] name = "soupsieve" version = "2.5" @@ -1367,4 +1406,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "a5acc9278a3b432c19deb08ae853dae7bbd86d62252701bc0f72ba098eb7b4e2" +content-hash = "609be4c77aa6c41a875b902ae7121255cf8d74b8713cd7b42341697efc9c8487" diff --git a/pyadtpulse/pulse_backoff.py b/pyadtpulse/pulse_backoff.py index 79dc311..9fe9a51 100644 --- a/pyadtpulse/pulse_backoff.py +++ b/pyadtpulse/pulse_backoff.py @@ -1,7 +1,7 @@ """Pulse backoff object.""" +import asyncio import datetime from logging import getLogger -from asyncio import sleep from time import time from typeguard import typechecked @@ -37,25 +37,37 @@ def __init__( detailed_debug_logging=False, ) -> None: """Initialize backoff.""" + self._check_intervals(initial_backoff_interval, max_backoff_interval) self._b_lock = set_debug_lock(debug_locks, "pyadtpulse._b_lock") self._initial_backoff_interval = initial_backoff_interval self._max_backoff_interval = max_backoff_interval self._backoff_count = 0 - self._expiration_time = 0.0 + self._expiration_time = time() self._name = name self._detailed_debug_logging = detailed_debug_logging self._threshold = threshold def _calculate_backoff_interval(self) -> float: """Calculate backoff time.""" - if self._backoff_count <= self._threshold: + if self._backoff_count <= (self._threshold): return self._initial_backoff_interval return min( self._initial_backoff_interval - * (2 ** (self._backoff_count - self._threshold)), + * 2 ** (self._backoff_count - self._threshold), self._max_backoff_interval, ) + @staticmethod + def _check_intervals( + initial_backoff_interval: float, max_backoff_interval: float + ) -> None: + """Check max_backoff_interval is >= initial_backoff_interval + and that both invervals are positive.""" + if initial_backoff_interval <= 0: + raise ValueError("initial_backoff_interval must be greater than 0") + if max_backoff_interval < initial_backoff_interval: + raise ValueError("max_backoff_interval must be >= initial_backoff_interval") + def get_current_backoff_interval(self) -> float: """Return current backoff time.""" with self._b_lock: @@ -67,7 +79,7 @@ def increment_backoff(self) -> None: self._backoff_count += 1 expiration_time = self._calculate_backoff_interval() + time() - if expiration_time > self._expiration_time: + if expiration_time >= self._expiration_time: LOG.debug( "Pulse backoff %s: %s expires at %s", self._name, @@ -91,16 +103,17 @@ def increment_backoff(self) -> None: def reset_backoff(self) -> None: """Reset backoff.""" with self._b_lock: - if self._expiration_time == 0.0 or time() > self._expiration_time: - self._backoff_count = 0 + if self._expiration_time > time(): self._backoff_count = 0 self._expiration_time = 0.0 @typechecked def set_absolute_backoff_time(self, backoff_time: float) -> None: """Set absolute backoff time.""" - if backoff_time != 0 and backoff_time < time(): - raise ValueError("backoff_time cannot be less than current time") + if backoff_time > time(): + backoff_time = time() + else: + raise ValueError("Absolute backoff time must be greater than current time") with self._b_lock: LOG.debug( "Pulse backoff %s: set to %s", @@ -114,16 +127,20 @@ def set_absolute_backoff_time(self, backoff_time: float) -> None: async def wait_for_backoff(self) -> None: """Wait for backoff.""" with self._b_lock: + if self._expiration_time < time(): + self._expiration_time = self._calculate_backoff_interval() + time() diff = self._expiration_time - time() if diff > 0: if self._detailed_debug_logging: LOG.debug("Backoff %s: waiting for %s", self._name, diff) - await sleep(diff) + await asyncio.sleep(diff) def will_backoff(self) -> bool: """Return if backoff is needed.""" with self._b_lock: - return self._expiration_time >= time() + return ( + self._backoff_count > self._threshold or self._expiration_time >= time() + ) @property def backoff_count(self) -> int: @@ -147,9 +164,8 @@ def initial_backoff_interval(self) -> float: @typechecked def initial_backoff_interval(self, new_interval: float) -> None: """Set initial backoff interval.""" - if new_interval <= 0.0: - raise ValueError("Initial backoff interval must be greater than 0") with self._b_lock: + self._check_intervals(new_interval, self._max_backoff_interval) self._initial_backoff_interval = new_interval @property diff --git a/pyproject.toml b/pyproject.toml index 57df6ba..d580271 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -34,6 +34,7 @@ pytest-mock = "^3.12.0" pytest-aiohttp = "^1.0.5" pytest-timeout = "^2.2.0" aioresponses = "^0.7.4" +freezegun = "^1.2.2" [tool.poetry.group.dev.dependencies] diff --git a/tests/test_backoff.py b/tests/test_backoff.py new file mode 100644 index 0000000..14eeca3 --- /dev/null +++ b/tests/test_backoff.py @@ -0,0 +1,860 @@ +# Initially Generated by CodiumAI +import asyncio +import datetime +from time import time + +import pytest +from freezegun import freeze_time + +from pyadtpulse.pulse_backoff import PulseBackoff + + +class TestPulseBackoff: + # Test that the PulseBackoff class can be initialized with valid parameters. + def test_initialize_backoff_valid_parameters(self): + """ + Test that the PulseBackoff class can be initialized with valid parameters. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + # Store the current time + current_time = time() + + # Act + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Assert + assert backoff.name == name + assert backoff.initial_backoff_interval == initial_backoff_interval + assert backoff._max_backoff_interval == max_backoff_interval + assert backoff._backoff_count == 0 + + # Assert that the expiration time is greater than or equal to the stored time + assert backoff._expiration_time >= current_time + + # Get current backoff interval + def test_get_current_backoff_interval(self): + """ + Test that the get_current_backoff_interval method returns the correct current backoff interval. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + current_backoff_interval = backoff.get_current_backoff_interval() + + # Assert + assert current_backoff_interval == initial_backoff_interval + + # Increment backoff + def test_increment_backoff(self): + """ + Test that the increment_backoff method increments the backoff count and updates the expiration time. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + backoff.increment_backoff() + + # Assert + assert backoff._backoff_count == 1 + assert backoff._expiration_time > time() + + # Reset backoff + def test_reset_backoff(self): + """ + Test that the reset_backoff method resets the backoff count and expiration time. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + backoff.increment_backoff() + + # Act + backoff.reset_backoff() + + # Assert + assert backoff._backoff_count == 0 + assert backoff._expiration_time == 0.0 + + # Test that the wait_for_backoff method waits for the correct amount of time. + @pytest.mark.asyncio + async def test_wait_for_backoff2(self, mocker): + """ + Test that the wait_for_backoff method waits for the correct amount of time. + """ + # Arrange + + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + mocker.patch("asyncio.sleep") + + # Act + await backoff.wait_for_backoff() + + # Assert + asyncio.sleep.assert_called_once_with( + pytest.approx(initial_backoff_interval, abs=0.1) + ) + + # Check if backoff is needed + def test_will_backoff(self): + """ + Test that the will_backoff method returns True if backoff is needed, False otherwise. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act and Assert + assert not backoff.will_backoff() + + backoff.increment_backoff() + assert backoff.will_backoff() + + # Initialize backoff with invalid initial_backoff_interval + def test_initialize_backoff_invalid_initial_interval(self): + """ + Test that initializing the PulseBackoff class with an invalid + initial_backoff_interval raises a ValueError. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = -1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + # Act and Assert + with pytest.raises(ValueError): + PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Initialize backoff with invalid max_backoff_interval + def test_initialize_backoff_invalid_max_interval(self): + """ + Test that initializing the PulseBackoff class with an invalid + max_backoff_interval raises a ValueError. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 0.5 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + # Act and Assert + with pytest.raises(ValueError): + PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Test that setting the absolute backoff time with an invalid backoff_time raises a ValueError. + def test_set_absolute_backoff_time_invalid_time(self): + """ + Test that setting the absolute backoff time with an invalid backoff_time raises a ValueError. + """ + # Arrange + backoff = PulseBackoff( + name="test_backoff", + initial_backoff_interval=1.0, + max_backoff_interval=10.0, + threshold=0, + debug_locks=False, + detailed_debug_logging=False, + ) + + # Act and Assert + with pytest.raises( + ValueError, match="Absolute backoff time must be greater than current time" + ): + backoff.set_absolute_backoff_time(time() - 1) + + # Initialize backoff with valid parameters + def test_initialize_backoff_valid_parameters2(self): + """ + Test that the PulseBackoff class can be initialized with valid parameters. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + # Act + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Assert + assert backoff.name == name + assert backoff.initial_backoff_interval == initial_backoff_interval + assert backoff._max_backoff_interval == max_backoff_interval + assert backoff._backoff_count == 0 + assert backoff._expiration_time > 0.0 + + # Increment backoff + def test_increment_backoff2(self): + """ + Test that the backoff count is incremented correctly when calling the + increment_backoff method. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + backoff.increment_backoff() + + # Assert + assert backoff.backoff_count == 1 + + # Get current backoff interval + def test_get_current_backoff_interval2(self): + """ + Test the get_current_backoff_interval method of the PulseBackoff class. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + current_interval = backoff.get_current_backoff_interval() + + # Assert + assert current_interval == initial_backoff_interval + + # Reset backoff + def test_reset_backoff2(self): + """ + Test that the backoff count and expiration time are reset when calling + reset_backoff method. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + backoff._backoff_count = 5 + backoff._expiration_time = time() + 10 + + # Act + backoff.reset_backoff() + + # Assert + assert backoff._backoff_count == 0 + assert backoff._expiration_time == 0.0 + + # Check if backoff is needed + def test_backoff_needed(self): + """ + Test that the 'will_backoff' method returns the correct value when + backoff is needed. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + backoff.increment_backoff() + + # Assert + assert backoff.will_backoff() is True + + # Wait for backoff + @pytest.mark.asyncio + async def test_wait_for_backoff(self, mocker): + """ + Test that the wait_for_backoff method waits for the correct amount of time. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + # Act + await backoff.wait_for_backoff() + + # Assert + assert backoff.expiration_time == pytest.approx(time(), abs=0.1) + + # Set initial backoff interval + def test_set_initial_backoff_interval(self): + """ + Test that the initial backoff interval can be set. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + new_interval = 2.0 + backoff.initial_backoff_interval = new_interval + + # Assert + assert backoff.initial_backoff_interval == new_interval + + # Initialize backoff with invalid max_backoff_interval + def test_initialize_backoff_invalid_max_interval2(self): + """ + Test that the PulseBackoff class raises a ValueError when initialized + with an invalid max_backoff_interval. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 0.5 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + # Act & Assert + with pytest.raises(ValueError): + PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + def test_initialize_backoff_invalid_initial_interval2(self): + """ + Test that the PulseBackoff class raises a ValueError when initialized with an + invalid initial_backoff_interval. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = -1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + # Act & Assert + with pytest.raises(ValueError): + PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Set absolute backoff time with invalid backoff_time + def test_set_absolute_backoff_time_invalid_backoff_time(self, mocker): + """ + Test that set_absolute_backoff_time raises a ValueError when given an invalid backoff_time. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act and Assert + invalid_backoff_time = time() - 1 + with pytest.raises(ValueError): + backoff.set_absolute_backoff_time(invalid_backoff_time) + + # Wait for backoff with negative diff + @pytest.mark.asyncio + async def test_wait_for_backoff_with_negative_diff(self, mocker): + """ + Test that the wait_for_backoff method handles a negative diff correctly. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Set the expiration time to a past time + backoff._expiration_time = time() - 1 + + start_time = time() + + # Act + await backoff.wait_for_backoff() + + # Assert + assert backoff._expiration_time >= initial_backoff_interval + + # Calculate backoff interval with backoff_count <= threshold + def test_calculate_backoff_interval_with_backoff_count_less_than_threshold(self): + """ + Test that the calculate_backoff_interval method returns the initial backoff + interval when the backoff count is less than or equal to the threshold. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 5 + debug_locks = False + detailed_debug_logging = False + + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + result = backoff._calculate_backoff_interval() + + # Assert + assert result == initial_backoff_interval + + # Calculate backoff interval with backoff_count > threshold and exceeds max_backoff_interval + @pytest.mark.asyncio + async def test_calculate_backoff_interval_exceeds_max(self, mocker): + """ + Test that the calculate_backoff_interval method returns the correct backoff interval + when backoff_count is greater than threshold and exceeds max_backoff_interval. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + backoff._backoff_count = 2 + + # Act + result = backoff._calculate_backoff_interval() + + # Assert + assert result == 4.0 + backoff._backoff_count = 3 + result = backoff._calculate_backoff_interval() + assert result == 8.0 + backoff._backoff_count = 4 + result = backoff._calculate_backoff_interval() + assert result == max_backoff_interval + backoff._backoff_count = 5 + result = backoff._calculate_backoff_interval() + assert result == max_backoff_interval + + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 3 + debug_locks = False + detailed_debug_logging = False + + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + backoff._backoff_count = 2 + + # Act + result = backoff._calculate_backoff_interval() + + # Assert + assert result == initial_backoff_interval + backoff._backoff_count = 3 + result = backoff._calculate_backoff_interval() + assert result == initial_backoff_interval + backoff._backoff_count = 4 + result = backoff._calculate_backoff_interval() + assert result == initial_backoff_interval * 2 + backoff._backoff_count = 5 + result = backoff._calculate_backoff_interval() + assert result == initial_backoff_interval * 4 + backoff._backoff_count = 6 + result = backoff._calculate_backoff_interval() + assert result == initial_backoff_interval * 8 + backoff._backoff_count = 7 + result = backoff._calculate_backoff_interval() + assert result == max_backoff_interval + backoff._backoff_count = 8 + result = backoff._calculate_backoff_interval() + assert result == max_backoff_interval + + # Increment backoff and update expiration_time + def test_increment_backoff_and_update_expiration_time(self): + """ + Test that the backoff count is incremented and the expiration time is + updated correctly. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + now = time() + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + # Act + backoff.increment_backoff() + + # Assert + assert backoff.backoff_count == 1 + assert backoff.expiration_time == pytest.approx(now) + + # Calculate backoff interval with backoff_count > threshold + def test_calculate_backoff_interval_with_backoff_count_greater_than_threshold(self): + """ + Test the calculation of backoff interval when backoff_count is greater than threshold. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff_count = 5 + + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + backoff._backoff_count = backoff_count + + # Act + calculated_interval = backoff._calculate_backoff_interval() + + # Assert + expected_interval = initial_backoff_interval * ( + 2 ** (backoff_count - threshold) + ) + assert calculated_interval == min(expected_interval, max_backoff_interval) + + # Test that the backoff count is incremented and the expiration time is not updated when calling increment_backoff() on PulseBackoff. + @pytest.mark.asyncio + async def test_increment_backoff_no_update_expiration_time(self, mocker): + """ + Test that the backoff count is incremented and the expiration time is not updated when calling increment_backoff() on PulseBackoff. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + backoff.increment_backoff() + + # Assert + assert backoff.backoff_count == 1 + assert backoff.expiration_time > 0.0 + assert backoff.expiration_time >= time() + + # Test that calling increment backoff 4 times followed by wait for backoff + # will sleep for 8 seconds with an initial backoff of 1, max backoff of 10. + # And that an additional call to increment backoff followed by a wait for backoff will wait for 10. + + @pytest.mark.asyncio + async def test_increment_backoff_and_wait_for_backoff(self, mocker): + """ + Test that calling increment backoff 4 times followed by wait for backoff will + sleep for 8 seconds with an initial backoff of 1, max backoff of 10. + And that an additional call to increment backoff followed by a wait + for backoff will wait for 10. + """ + # Arrange + with freeze_time("2023-11-01 18:22:11") as frozen_time: + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + # Create a mock sleep function + async def mock_sleep(duration): + pass + + # Replace the asyncio.sleep function with the mock_sleep function + mocker.patch("asyncio.sleep", side_effect=mock_sleep) + + # Create a PulseBackoff object + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + frozen_time.tick(delta=datetime.timedelta(seconds=1)) + await backoff.wait_for_backoff() + assert asyncio.sleep.call_count == 1 + assert asyncio.sleep.call_args_list[0][0][0] == initial_backoff_interval + backoff.increment_backoff() + + await backoff.wait_for_backoff() + assert asyncio.sleep.call_count == 2 + assert asyncio.sleep.call_args_list[1][0][0] == 2.0 + backoff.increment_backoff() + + await backoff.wait_for_backoff() + assert asyncio.sleep.call_count == 3 + assert asyncio.sleep.call_args_list[2][0][0] == 4.0 + backoff.increment_backoff() + + await backoff.wait_for_backoff() + assert asyncio.sleep.call_count == 4 + assert asyncio.sleep.call_args_list[3][0][0] == 8.0 + backoff.increment_backoff() + + # Additional call after 4 iterations + await backoff.wait_for_backoff() + assert asyncio.sleep.call_count == 5 + assert asyncio.sleep.call_args_list[4][0][0] == max_backoff_interval From 93635c38da51be3cc6c3335e129b18315b6ceddd Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 9 Dec 2023 08:51:47 -0500 Subject: [PATCH 122/226] fix login_in_progress flag --- pyadtpulse/pulse_connection.py | 25 +++++-------------------- tests/test_pulse_async.py | 3 ++- 2 files changed, 7 insertions(+), 21 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index bc49aeb..f0b3a6c 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -42,23 +42,6 @@ class PulseConnection(PulseQueryManager): "_login_in_progress", ) - @typechecked - @staticmethod - def login_flag(func): - """Decorator to set login in progress flag.""" - - def wrapper(self, *args, **kwargs): - # Set the flag to True before calling the function - self.login_in_progress = True - try: - result = func(self, *args, **kwargs) - finally: - # Reset the flag to False when the function returns - self.login_in_progress = False - return result - - return wrapper - @typechecked def __init__( self, @@ -92,7 +75,6 @@ def __init__( self._debug_locks = debug_locks @typechecked - @login_flag async def async_do_login_query( self, username: str, password: str, fingerprint: str, timeout: int = 30 ) -> BeautifulSoup | None: @@ -193,8 +175,7 @@ def check_response( return None return soup - with self._pc_attribute_lock: - self._login_in_progress = True + self.login_in_progress = True data = { "usernameForm": username, "passwordForm": password, @@ -217,6 +198,7 @@ def check_response( "Error encountered during ADT login GET", ): self._login_backoff.increment_backoff() + self.login_in_progress = False return None except Exception as e: # pylint: disable=broad-except LOG.error("Could not log into Pulse site: %s", e) @@ -224,13 +206,16 @@ def check_response( ConnectionFailureReason.UNKNOWN ) self._login_backoff.increment_backoff() + self.login_in_progress = False return None soup = check_response(response) if soup is None: + self.login_in_progress = False return None self._connection_status.authenticated_flag.set() self._authentication_properties.last_login_time = int(time()) self._login_backoff.reset_backoff() + self.login_in_progress = False return soup @typechecked diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index 108ef28..92b378e 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -150,6 +150,7 @@ async def test_login(adt_pulse_instance, extract_ids_from_data_directory): p, _ = await adt_pulse_instance # make sure everything is there on logout await p.async_logout() + await asyncio.sleep(1) assert p.site.name == "Robert Lippmann" assert p.site.zones_as_dict is not None assert len(p.site.zones_as_dict) == len(extract_ids_from_data_directory) - 3 @@ -288,7 +289,7 @@ async def test_keepalive_check(mocked_server_responses): p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") await p.async_login() assert p._timeout_task is not None - await asyncio.sleep() + await asyncio.sleep(0) @pytest.mark.asyncio From 12cb2836b3934b68ef9c654e7f1df33fd3f4e998 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 9 Dec 2023 14:36:49 -0500 Subject: [PATCH 123/226] rework backoff --- conftest.py | 9 ++ pyadtpulse/pulse_backoff.py | 47 +++------ pyadtpulse/pulse_query_manager.py | 11 ++- tests/test_backoff.py | 158 +++++++++++------------------- tests/test_pulse_query_manager.py | 73 ++++++++++++++ 5 files changed, 164 insertions(+), 134 deletions(-) create mode 100644 tests/test_pulse_query_manager.py diff --git a/conftest.py b/conftest.py index 71b31de..6c95e83 100644 --- a/conftest.py +++ b/conftest.py @@ -1,4 +1,5 @@ """Pulse Test Configuration.""" +import asyncio import os import re import sys @@ -39,6 +40,8 @@ from pyadtpulse.pulse_query_manager import PulseQueryManager from pyadtpulse.util import remove_prefix +MOCK_SLEEP_TIME = 2.0 + @pytest.fixture def read_file(): @@ -66,10 +69,16 @@ async def get_api_version() -> AsyncGenerator[str, Any]: yield pcp.api_version +async def sleep_side_effect(duration, *args, **kwargs): + """Perform a small sleep to let us check status codes""" + await asyncio.sleep(MOCK_SLEEP_TIME) + + @pytest.fixture def patched_async_query_sleep() -> Generator[AsyncMock, Any, Any]: """Fixture to patch asyncio.sleep in async_query().""" a = AsyncMock() + a.side_effect = sleep_side_effect with patch( "pyadtpulse.pulse_query_manager.async_query.asyncio.sleep", side_effect=a ) as mock: diff --git a/pyadtpulse/pulse_backoff.py b/pyadtpulse/pulse_backoff.py index 9fe9a51..c53880f 100644 --- a/pyadtpulse/pulse_backoff.py +++ b/pyadtpulse/pulse_backoff.py @@ -42,18 +42,20 @@ def __init__( self._initial_backoff_interval = initial_backoff_interval self._max_backoff_interval = max_backoff_interval self._backoff_count = 0 - self._expiration_time = time() + self._expiration_time = 0.0 self._name = name self._detailed_debug_logging = detailed_debug_logging self._threshold = threshold def _calculate_backoff_interval(self) -> float: """Calculate backoff time.""" - if self._backoff_count <= (self._threshold): + if self._backoff_count == 0: + return 0.0 + if self._backoff_count <= (self._threshold + 1): return self._initial_backoff_interval return min( self._initial_backoff_interval - * 2 ** (self._backoff_count - self._threshold), + * 2 ** (self._backoff_count - self._threshold - 1), self._max_backoff_interval, ) @@ -77,41 +79,20 @@ def increment_backoff(self) -> None: """Increment backoff.""" with self._b_lock: self._backoff_count += 1 - expiration_time = self._calculate_backoff_interval() + time() - - if expiration_time >= self._expiration_time: - LOG.debug( - "Pulse backoff %s: %s expires at %s", - self._name, - self._backoff_count, - datetime.datetime.fromtimestamp(self._expiration_time).strftime( - "%m/%d/%Y %H:%M:%S" - ), - ) - self._expiration_time = expiration_time - else: - if self._detailed_debug_logging: - LOG.debug( - "Pulse backoff %s: not updated " - "because already expires at %s", - self._name, - datetime.datetime.fromtimestamp(self._expiration_time).strftime( - "%m/%d/%Y %H:%M:%S" - ), - ) def reset_backoff(self) -> None: """Reset backoff.""" with self._b_lock: - if self._expiration_time > time(): + if self._expiration_time < time(): self._backoff_count = 0 self._expiration_time = 0.0 @typechecked def set_absolute_backoff_time(self, backoff_time: float) -> None: """Set absolute backoff time.""" - if backoff_time > time(): - backoff_time = time() + curr_time = time() + if backoff_time > curr_time: + backoff_time = curr_time else: raise ValueError("Absolute backoff time must be greater than current time") with self._b_lock: @@ -127,9 +108,13 @@ def set_absolute_backoff_time(self, backoff_time: float) -> None: async def wait_for_backoff(self) -> None: """Wait for backoff.""" with self._b_lock: - if self._expiration_time < time(): - self._expiration_time = self._calculate_backoff_interval() + time() - diff = self._expiration_time - time() + curr_time = time() + if self._expiration_time < curr_time: + if self.backoff_count == 0: + return + diff = self._calculate_backoff_interval() + else: + diff = self._expiration_time - curr_time if diff > 0: if self._detailed_debug_logging: LOG.debug("Backoff %s: waiting for %s", self._name, diff) diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index 72c02e9..5aadda5 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -101,16 +101,19 @@ def _set_retry_after(self, code: int, retry_after: str) -> None: ) except ValueError: return + description = self._get_http_status_description(code) LOG.warning( "Task %s received Retry-After %s due to %s", current_task(), retval, - self._get_http_status_description(code), + description, ) self._connection_status.retry_after = int(time()) + retval - try: - fail_reason = ConnectionFailureReason(code) - except ValueError: + if code == HTTPStatus.SERVICE_UNAVAILABLE: + fail_reason = ConnectionFailureReason.SERVICE_UNAVAILABLE + elif code == HTTPStatus.TOO_MANY_REQUESTS: + fail_reason = ConnectionFailureReason.TOO_MANY_REQUESTS + else: fail_reason = ConnectionFailureReason.UNKNOWN self._connection_status.connection_failure_reason = fail_reason diff --git a/tests/test_backoff.py b/tests/test_backoff.py index 14eeca3..e763271 100644 --- a/tests/test_backoff.py +++ b/tests/test_backoff.py @@ -41,9 +41,7 @@ def test_initialize_backoff_valid_parameters(self): assert backoff.initial_backoff_interval == initial_backoff_interval assert backoff._max_backoff_interval == max_backoff_interval assert backoff._backoff_count == 0 - - # Assert that the expiration time is greater than or equal to the stored time - assert backoff._expiration_time >= current_time + assert backoff._expiration_time == 0.0 # Get current backoff interval def test_get_current_backoff_interval(self): @@ -68,14 +66,19 @@ def test_get_current_backoff_interval(self): # Act current_backoff_interval = backoff.get_current_backoff_interval() - + assert current_backoff_interval == 0.0 + backoff.increment_backoff() + current_backoff_interval = backoff.get_current_backoff_interval() # Assert assert current_backoff_interval == initial_backoff_interval + backoff.increment_backoff() + current_backoff_interval = backoff.get_current_backoff_interval() + assert current_backoff_interval == initial_backoff_interval * 2 # Increment backoff def test_increment_backoff(self): """ - Test that the increment_backoff method increments the backoff count and updates the expiration time. + Test that the increment_backoff method increments the backoff count. """ # Arrange name = "test_backoff" @@ -98,7 +101,8 @@ def test_increment_backoff(self): # Assert assert backoff._backoff_count == 1 - assert backoff._expiration_time > time() + backoff.increment_backoff() + assert backoff._backoff_count == 2 # Reset backoff def test_reset_backoff(self): @@ -127,7 +131,6 @@ def test_reset_backoff(self): # Assert assert backoff._backoff_count == 0 - assert backoff._expiration_time == 0.0 # Test that the wait_for_backoff method waits for the correct amount of time. @pytest.mark.asyncio @@ -155,11 +158,10 @@ async def test_wait_for_backoff2(self, mocker): # Act await backoff.wait_for_backoff() - - # Assert - asyncio.sleep.assert_called_once_with( - pytest.approx(initial_backoff_interval, abs=0.1) - ) + assert asyncio.sleep.call_count == 0 + backoff.increment_backoff() + await backoff.wait_for_backoff() + asyncio.sleep.assert_called_once_with(initial_backoff_interval) # Check if backoff is needed def test_will_backoff(self): @@ -287,7 +289,7 @@ def test_initialize_backoff_valid_parameters2(self): assert backoff.initial_backoff_interval == initial_backoff_interval assert backoff._max_backoff_interval == max_backoff_interval assert backoff._backoff_count == 0 - assert backoff._expiration_time > 0.0 + assert backoff._expiration_time == 0.0 # Increment backoff def test_increment_backoff2(self): @@ -317,38 +319,11 @@ def test_increment_backoff2(self): # Assert assert backoff.backoff_count == 1 - # Get current backoff interval - def test_get_current_backoff_interval2(self): - """ - Test the get_current_backoff_interval method of the PulseBackoff class. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - - # Act - current_interval = backoff.get_current_backoff_interval() - - # Assert - assert current_interval == initial_backoff_interval - # Reset backoff def test_reset_backoff2(self): """ - Test that the backoff count and expiration time are reset when calling - reset_backoff method. + Test that the backoff count and expiration time are not reset when calling + the reset_backoff method where expiration time is in the future. """ # Arrange name = "test_backoff" @@ -365,15 +340,17 @@ def test_reset_backoff2(self): debug_locks, detailed_debug_logging, ) - backoff._backoff_count = 5 - backoff._expiration_time = time() + 10 + curr_time = datetime.datetime.now() + with freeze_time(curr_time): + backoff._backoff_count = 5 + backoff._expiration_time = curr_time.timestamp() + 10.0 - # Act - backoff.reset_backoff() + # Act + backoff.reset_backoff() - # Assert - assert backoff._backoff_count == 0 - assert backoff._expiration_time == 0.0 + # Assert + assert backoff._backoff_count == 5 + assert backoff._expiration_time == curr_time.timestamp() + 10.0 # Check if backoff is needed def test_backoff_needed(self): @@ -434,9 +411,10 @@ async def test_wait_for_backoff(self, mocker): ) # Act await backoff.wait_for_backoff() - + assert backoff.expiration_time == 0.0 + backoff.increment_backoff() # Assert - assert backoff.expiration_time == pytest.approx(time(), abs=0.1) + assert backoff.expiration_time == 0.0 # Set initial backoff interval def test_set_initial_backoff_interval(self): @@ -578,8 +556,8 @@ async def test_wait_for_backoff_with_negative_diff(self, mocker): # Calculate backoff interval with backoff_count <= threshold def test_calculate_backoff_interval_with_backoff_count_less_than_threshold(self): """ - Test that the calculate_backoff_interval method returns the initial backoff - interval when the backoff count is less than or equal to the threshold. + Test that the calculate_backoff_interval method returns 0 + when the backoff count is less than or equal to the threshold. """ # Arrange name = "test_backoff" @@ -602,7 +580,7 @@ def test_calculate_backoff_interval_with_backoff_count_less_than_threshold(self) result = backoff._calculate_backoff_interval() # Assert - assert result == initial_backoff_interval + assert result == 0.0 # Calculate backoff interval with backoff_count > threshold and exceeds max_backoff_interval @pytest.mark.asyncio @@ -634,16 +612,19 @@ async def test_calculate_backoff_interval_exceeds_max(self, mocker): result = backoff._calculate_backoff_interval() # Assert - assert result == 4.0 + assert result == 2.0 backoff._backoff_count = 3 result = backoff._calculate_backoff_interval() - assert result == 8.0 + assert result == 4.0 backoff._backoff_count = 4 result = backoff._calculate_backoff_interval() - assert result == max_backoff_interval + assert result == 8.0 backoff._backoff_count = 5 result = backoff._calculate_backoff_interval() assert result == max_backoff_interval + backoff._backoff_count = 6 + result = backoff._calculate_backoff_interval() + assert result == max_backoff_interval name = "test_backoff" initial_backoff_interval = 1.0 @@ -667,25 +648,28 @@ async def test_calculate_backoff_interval_exceeds_max(self, mocker): result = backoff._calculate_backoff_interval() # Assert - assert result == initial_backoff_interval + assert result == 1.0 backoff._backoff_count = 3 result = backoff._calculate_backoff_interval() - assert result == initial_backoff_interval + assert result == 1.0 backoff._backoff_count = 4 result = backoff._calculate_backoff_interval() - assert result == initial_backoff_interval * 2 + assert result == initial_backoff_interval backoff._backoff_count = 5 result = backoff._calculate_backoff_interval() - assert result == initial_backoff_interval * 4 + assert result == initial_backoff_interval * 2 backoff._backoff_count = 6 result = backoff._calculate_backoff_interval() - assert result == initial_backoff_interval * 8 + assert result == initial_backoff_interval * 4 backoff._backoff_count = 7 result = backoff._calculate_backoff_interval() - assert result == max_backoff_interval + assert result == initial_backoff_interval * 8 backoff._backoff_count = 8 result = backoff._calculate_backoff_interval() assert result == max_backoff_interval + backoff._backoff_count = 9 + result = backoff._calculate_backoff_interval() + assert result == max_backoff_interval # Increment backoff and update expiration_time def test_increment_backoff_and_update_expiration_time(self): @@ -728,7 +712,6 @@ def test_increment_backoff_and_update_expiration_time(self): # Assert assert backoff.backoff_count == 1 - assert backoff.expiration_time == pytest.approx(now) # Calculate backoff interval with backoff_count > threshold def test_calculate_backoff_interval_with_backoff_count_greater_than_threshold(self): @@ -763,37 +746,6 @@ def test_calculate_backoff_interval_with_backoff_count_greater_than_threshold(se ) assert calculated_interval == min(expected_interval, max_backoff_interval) - # Test that the backoff count is incremented and the expiration time is not updated when calling increment_backoff() on PulseBackoff. - @pytest.mark.asyncio - async def test_increment_backoff_no_update_expiration_time(self, mocker): - """ - Test that the backoff count is incremented and the expiration time is not updated when calling increment_backoff() on PulseBackoff. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - - # Act - backoff.increment_backoff() - - # Assert - assert backoff.backoff_count == 1 - assert backoff.expiration_time > 0.0 - assert backoff.expiration_time >= time() - # Test that calling increment backoff 4 times followed by wait for backoff # will sleep for 8 seconds with an initial backoff of 1, max backoff of 10. # And that an additional call to increment backoff followed by a wait for backoff will wait for 10. @@ -834,6 +786,10 @@ async def mock_sleep(duration): # Act frozen_time.tick(delta=datetime.timedelta(seconds=1)) + await backoff.wait_for_backoff() + assert asyncio.sleep.call_count == 0 + backoff.increment_backoff() + await backoff.wait_for_backoff() assert asyncio.sleep.call_count == 1 assert asyncio.sleep.call_args_list[0][0][0] == initial_backoff_interval @@ -841,20 +797,24 @@ async def mock_sleep(duration): await backoff.wait_for_backoff() assert asyncio.sleep.call_count == 2 - assert asyncio.sleep.call_args_list[1][0][0] == 2.0 + assert asyncio.sleep.call_args_list[1][0][0] == 2 * initial_backoff_interval backoff.increment_backoff() await backoff.wait_for_backoff() assert asyncio.sleep.call_count == 3 - assert asyncio.sleep.call_args_list[2][0][0] == 4.0 + assert asyncio.sleep.call_args_list[2][0][0] == 4 * initial_backoff_interval backoff.increment_backoff() + # Additional call after 4 iterations await backoff.wait_for_backoff() assert asyncio.sleep.call_count == 4 - assert asyncio.sleep.call_args_list[3][0][0] == 8.0 + assert asyncio.sleep.call_args_list[3][0][0] == 8 * initial_backoff_interval backoff.increment_backoff() - # Additional call after 4 iterations await backoff.wait_for_backoff() assert asyncio.sleep.call_count == 5 assert asyncio.sleep.call_args_list[4][0][0] == max_backoff_interval + backoff.increment_backoff() + await backoff.wait_for_backoff() + assert asyncio.sleep.call_count == 6 + assert asyncio.sleep.call_args_list[4][0][0] == max_backoff_interval diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py new file mode 100644 index 0000000..895fc5e --- /dev/null +++ b/tests/test_pulse_query_manager.py @@ -0,0 +1,73 @@ +"""Test Pulse Query Manager.""" +import inspect +from datetime import datetime, timedelta +from unittest import mock + +import freezegun +import pytest + +from pyadtpulse.const import ADT_ORB_URI, DEFAULT_API_HOST, ConnectionFailureReason +from pyadtpulse.pulse_connection_properties import PulseConnectionProperties +from pyadtpulse.pulse_connection_status import PulseConnectionStatus +from pyadtpulse.pulse_query_manager import PulseQueryManager + + +def get_calling_function() -> str | None: + curr_frame = inspect.currentframe() + if not curr_frame: + return None + if not curr_frame.f_back: + return None + if not curr_frame.f_back.f_back: + return None + if not curr_frame.f_back.f_back.f_back: + return None + if not curr_frame.f_back.f_back.f_back.f_back: + return None + frame = curr_frame.f_back.f_back.f_back.f_back + calling_function = frame.f_globals["__name__"] + "." + frame.f_code.co_name + return calling_function + + +@pytest.mark.asyncio +async def test_retry_after(mocked_server_responses): + """Test retry after.""" + sleep_function_calls: list[str] = [] + + def msleep(*args, **kwargs): + func = get_calling_function() + if func: + sleep_function_calls.append(func) + + retry_after_time = 120 + + now = datetime.now() + retry_date = now + timedelta(seconds=retry_after_time * 2) + retry_date_str = retry_date.strftime("%a, %d %b %Y %H:%M:%S GMT") + s = PulseConnectionStatus() + cp = PulseConnectionProperties(DEFAULT_API_HOST) + p = PulseQueryManager(s, cp) + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + status=429, + headers={"Retry-After": str(retry_after_time)}, + ) + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + status=503, + headers={"Retry-After": retry_date_str}, + ) + with freezegun.freeze_time(now + timedelta(seconds=5)): + with mock.patch("asyncio.sleep", side_effect=msleep) as mock_sleep: + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert ( + s.connection_failure_reason == ConnectionFailureReason.TOO_MANY_REQUESTS + ) + assert mock_sleep.call_count == 1 + assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert ( + s.connection_failure_reason + == ConnectionFailureReason.SERVICE_UNAVAILABLE + ) + assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE From a96e204536e946c6c5d828af61df6a500863770c Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 10 Dec 2023 12:53:01 -0500 Subject: [PATCH 124/226] reset connection failure on success --- pyadtpulse/pulse_query_manager.py | 8 +++++ tests/test_pulse_query_manager.py | 49 ++++++++++++++++++++----------- 2 files changed, 40 insertions(+), 17 deletions(-) diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index 5aadda5..10ef79a 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -261,6 +261,14 @@ async def handle_query_response( ) break self._query_backoff.reset_backoff() + if self._connection_status.connection_failure_reason not in ( + ConnectionFailureReason.ACCOUNT_LOCKED, + ConnectionFailureReason.INVALID_CREDENTIALS, + ConnectionFailureReason.MFA_REQUIRED, + ): + self._connection_status.connection_failure_reason = ( + ConnectionFailureReason.NO_FAILURE + ) return (return_value[0], return_value[1], return_value[2]) async def query_orb(self, level: int, error_message: str) -> BeautifulSoup | None: diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index 895fc5e..f95c444 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -3,7 +3,6 @@ from datetime import datetime, timedelta from unittest import mock -import freezegun import pytest from pyadtpulse.const import ADT_ORB_URI, DEFAULT_API_HOST, ConnectionFailureReason @@ -40,34 +39,50 @@ def msleep(*args, **kwargs): sleep_function_calls.append(func) retry_after_time = 120 - now = datetime.now() - retry_date = now + timedelta(seconds=retry_after_time * 2) + retry_date = now + timedelta(seconds=retry_after_time) retry_date_str = retry_date.strftime("%a, %d %b %Y %H:%M:%S GMT") s = PulseConnectionStatus() cp = PulseConnectionProperties(DEFAULT_API_HOST) p = PulseQueryManager(s, cp) + mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=429, headers={"Retry-After": str(retry_after_time)}, ) + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + status=200, + ) mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=503, headers={"Retry-After": retry_date_str}, ) - with freezegun.freeze_time(now + timedelta(seconds=5)): - with mock.patch("asyncio.sleep", side_effect=msleep) as mock_sleep: - await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert ( - s.connection_failure_reason == ConnectionFailureReason.TOO_MANY_REQUESTS - ) - assert mock_sleep.call_count == 1 - assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE - await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert ( - s.connection_failure_reason - == ConnectionFailureReason.SERVICE_UNAVAILABLE - ) - assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + + # with freezegun.freeze_time(now) as frozen_time: + s = PulseConnectionStatus() + cp = PulseConnectionProperties(DEFAULT_API_HOST) + p = PulseQueryManager(s, cp) + + with mock.patch("asyncio.sleep", side_effect=msleep) as mock_sleep: + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert s.connection_failure_reason == ConnectionFailureReason.TOO_MANY_REQUESTS + assert mock_sleep.call_count == 0 + # make sure we can't override the retry + # s.get_backoff().reset_backoff() + # assert ( + # s.get_backoff().expiration_time + # == (now + timedelta(seconds=retry_after_time + 5)).timestamp() + # ) + # frozen_time.tick(timedelta(seconds=20)) + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + assert mock_sleep.call_count == 1 + mock_sleep.assert_called_once_with(retry_after_time) + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert ( + s.connection_failure_reason == ConnectionFailureReason.SERVICE_UNAVAILABLE + ) + assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE From 5059894ecd51a1241de7c89647f044db3223f298 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 10 Dec 2023 17:42:09 -0500 Subject: [PATCH 125/226] move query backoff to async_query --- conftest.py | 34 +- pyadtpulse/pulse_backoff.py | 4 +- pyadtpulse/pulse_connection_status.py | 6 +- pyadtpulse/pulse_query_manager.py | 104 +- tests/test_backoff.py | 1611 +++++++++++++------------ tests/test_pulse_query_manager.py | 72 +- 6 files changed, 925 insertions(+), 906 deletions(-) diff --git a/conftest.py b/conftest.py index 6c95e83..db1d0c6 100644 --- a/conftest.py +++ b/conftest.py @@ -1,5 +1,4 @@ """Pulse Test Configuration.""" -import asyncio import os import re import sys @@ -10,6 +9,7 @@ from unittest.mock import AsyncMock, patch from urllib import parse +import freezegun import pytest from aiohttp import web from aioresponses import aioresponses @@ -40,8 +40,6 @@ from pyadtpulse.pulse_query_manager import PulseQueryManager from pyadtpulse.util import remove_prefix -MOCK_SLEEP_TIME = 2.0 - @pytest.fixture def read_file(): @@ -58,6 +56,20 @@ def _read_file(file_name: str) -> str: return _read_file +@pytest.fixture +def mock_sleep(): + with patch("asyncio.sleep") as m: + yield m + + +@pytest.fixture +def freeze_time_to_now(): + """Fixture to freeze time to now.""" + current_time = datetime.now() + with freezegun.freeze_time(current_time) as frozen_time: + yield frozen_time + + @pytest.fixture(scope="session") @pytest.mark.asyncio async def get_api_version() -> AsyncGenerator[str, Any]: @@ -69,22 +81,6 @@ async def get_api_version() -> AsyncGenerator[str, Any]: yield pcp.api_version -async def sleep_side_effect(duration, *args, **kwargs): - """Perform a small sleep to let us check status codes""" - await asyncio.sleep(MOCK_SLEEP_TIME) - - -@pytest.fixture -def patched_async_query_sleep() -> Generator[AsyncMock, Any, Any]: - """Fixture to patch asyncio.sleep in async_query().""" - a = AsyncMock() - a.side_effect = sleep_side_effect - with patch( - "pyadtpulse.pulse_query_manager.async_query.asyncio.sleep", side_effect=a - ) as mock: - yield mock - - @pytest.fixture(scope="session") def get_mocked_api_version() -> str: """Fixture to get the test API version.""" diff --git a/pyadtpulse/pulse_backoff.py b/pyadtpulse/pulse_backoff.py index c53880f..32841a8 100644 --- a/pyadtpulse/pulse_backoff.py +++ b/pyadtpulse/pulse_backoff.py @@ -91,9 +91,7 @@ def reset_backoff(self) -> None: def set_absolute_backoff_time(self, backoff_time: float) -> None: """Set absolute backoff time.""" curr_time = time() - if backoff_time > curr_time: - backoff_time = curr_time - else: + if backoff_time < curr_time: raise ValueError("Absolute backoff time must be greater than current time") with self._b_lock: LOG.debug( diff --git a/pyadtpulse/pulse_connection_status.py b/pyadtpulse/pulse_connection_status.py index 7d88ef4..42b3e0b 100644 --- a/pyadtpulse/pulse_connection_status.py +++ b/pyadtpulse/pulse_connection_status.py @@ -50,14 +50,14 @@ def connection_failure_reason(self, reason: ConnectionFailureReason) -> None: self._connection_failure_reason = reason @property - def retry_after(self) -> int: + def retry_after(self) -> float: """Get the number of seconds to wait before retrying HTTP requests.""" with self._pcs_attribute_lock: - return int(self._backoff.expiration_time) + return self._backoff.expiration_time @retry_after.setter @typechecked - def retry_after(self, seconds: int) -> None: + def retry_after(self, seconds: float) -> None: """Set time after which HTTP requests can be retried.""" with self._pcs_attribute_lock: self._backoff.set_absolute_backoff_time(seconds) diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index 10ef79a..6827393 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -46,7 +46,7 @@ class PulseQueryManager: "_pqm_attribute_lock", "_connection_properties", "_connection_status", - "_query_backoff", + "_debug_locks", ) @staticmethod @@ -69,53 +69,7 @@ def __init__( ) self._connection_status = connection_status self._connection_properties = connection_properties - self._query_backoff = PulseBackoff( - "Query", - connection_status.get_backoff().initial_backoff_interval, - threshold=1, - debug_locks=debug_locks, - ) - - @typechecked - def _set_retry_after(self, code: int, retry_after: str) -> None: - """ - Check the "Retry-After" header in the response and set retry_after property - based upon it. - - Will also set the connection status failure reason and rety after - properties. - - Parameters: - code (int): The HTTP response code - retry_after (str): The value of the "Retry-After" header - - Returns: - None. - """ - if retry_after.isnumeric(): - retval = int(retry_after) - else: - try: - retval = int( - datetime.strptime(retry_after, "%a, %d %b %G %T %Z").timestamp() - ) - except ValueError: - return - description = self._get_http_status_description(code) - LOG.warning( - "Task %s received Retry-After %s due to %s", - current_task(), - retval, - description, - ) - self._connection_status.retry_after = int(time()) + retval - if code == HTTPStatus.SERVICE_UNAVAILABLE: - fail_reason = ConnectionFailureReason.SERVICE_UNAVAILABLE - elif code == HTTPStatus.TOO_MANY_REQUESTS: - fail_reason = ConnectionFailureReason.TOO_MANY_REQUESTS - else: - fail_reason = ConnectionFailureReason.UNKNOWN - self._connection_status.connection_failure_reason = fail_reason + self._debug_locks = debug_locks @typechecked async def async_query( @@ -149,6 +103,46 @@ async def async_query( response """ + def set_retry_after(code: int, retry_after: str) -> None: + """ + Check the "Retry-After" header in the response and set retry_after property + based upon it. + + Will also set the connection status failure reason and rety after + properties. + + Parameters: + code (int): The HTTP response code + retry_after (str): The value of the "Retry-After" header + + Returns: + None. + """ + if retry_after.isnumeric(): + retval = float(retry_after) + else: + try: + retval = datetime.strptime( + retry_after, "%a, %d %b %G %T %Z" + ).timestamp() + except ValueError: + return + description = self._get_http_status_description(code) + LOG.warning( + "Task %s received Retry-After %s due to %s", + current_task(), + retval, + description, + ) + self._connection_status.retry_after = time() + retval + if code == HTTPStatus.SERVICE_UNAVAILABLE: + fail_reason = ConnectionFailureReason.SERVICE_UNAVAILABLE + elif code == HTTPStatus.TOO_MANY_REQUESTS: + fail_reason = ConnectionFailureReason.TOO_MANY_REQUESTS + else: + fail_reason = ConnectionFailureReason.UNKNOWN + self._connection_status.connection_failure_reason = fail_reason + async def handle_query_response( response: ClientResponse | None, ) -> tuple[int, str | None, URL | None, str | None]: @@ -195,9 +189,15 @@ async def handle_query_response( None, None, ) + query_backoff = PulseBackoff( + f"Query:{method} {uri}", + self._connection_status.get_backoff().initial_backoff_interval, + threshold=1, + debug_locks=self._debug_locks, + ) while retry < MAX_RETRIES: try: - await self._query_backoff.wait_for_backoff() + await query_backoff.wait_for_backoff() async with self._connection_properties.session.request( method, url, @@ -207,7 +207,7 @@ async def handle_query_response( timeout=timeout, ) as response: return_value = await handle_query_response(response) - self._query_backoff.increment_backoff() + query_backoff.increment_backoff() retry += 1 if return_value[0] in RECOVERABLE_ERRORS: @@ -235,7 +235,7 @@ async def handle_query_response( ServerDisconnectedError, ) as ex: if return_value[0] is not None and return_value[3] is not None: - self._set_retry_after( + set_retry_after( return_value[0], return_value[3], ) @@ -260,7 +260,7 @@ async def handle_query_response( exc_info=True, ) break - self._query_backoff.reset_backoff() + # success, reset statuses if self._connection_status.connection_failure_reason not in ( ConnectionFailureReason.ACCOUNT_LOCKED, ConnectionFailureReason.INVALID_CREDENTIALS, diff --git a/tests/test_backoff.py b/tests/test_backoff.py index e763271..08fb2aa 100644 --- a/tests/test_backoff.py +++ b/tests/test_backoff.py @@ -1,33 +1,213 @@ -# Initially Generated by CodiumAI -import asyncio -import datetime +"""Test for pulse_backoff.""" from time import time import pytest -from freezegun import freeze_time from pyadtpulse.pulse_backoff import PulseBackoff -class TestPulseBackoff: - # Test that the PulseBackoff class can be initialized with valid parameters. - def test_initialize_backoff_valid_parameters(self): - """ - Test that the PulseBackoff class can be initialized with valid parameters. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - - # Store the current time - current_time = time() - - # Act - backoff = PulseBackoff( +# Test that the PulseBackoff class can be initialized with valid parameters. +def test_initialize_backoff_valid_parameters(): + """ + Test that the PulseBackoff class can be initialized with valid parameters. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + # Store the current time + current_time = time() + + # Act + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Assert + assert backoff.name == name + assert backoff.initial_backoff_interval == initial_backoff_interval + assert backoff._max_backoff_interval == max_backoff_interval + assert backoff._backoff_count == 0 + assert backoff._expiration_time == 0.0 + + +# Get current backoff interval +def test_get_current_backoff_interval(): + """ + Test that the get_current_backoff_interval method returns the correct current backoff interval. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + current_backoff_interval = backoff.get_current_backoff_interval() + assert current_backoff_interval == 0.0 + backoff.increment_backoff() + current_backoff_interval = backoff.get_current_backoff_interval() + # Assert + assert current_backoff_interval == initial_backoff_interval + backoff.increment_backoff() + current_backoff_interval = backoff.get_current_backoff_interval() + assert current_backoff_interval == initial_backoff_interval * 2 + + +# Increment backoff +def test_increment_backoff(): + """ + Test that the increment_backoff method increments the backoff count. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + backoff.increment_backoff() + + # Assert + assert backoff._backoff_count == 1 + backoff.increment_backoff() + assert backoff._backoff_count == 2 + + +# Reset backoff +def test_reset_backoff(): + """ + Test that the reset_backoff method resets the backoff count and expiration time. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + backoff.increment_backoff() + + # Act + backoff.reset_backoff() + + # Assert + assert backoff._backoff_count == 0 + + +# Test that the wait_for_backoff method waits for the correct amount of time. +@pytest.mark.asyncio +async def test_wait_for_backoff2(mock_sleep): + """ + Test that the wait_for_backoff method waits for the correct amount of time. + """ + # Arrange + + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + await backoff.wait_for_backoff() + assert mock_sleep.call_count == 0 + backoff.increment_backoff() + await backoff.wait_for_backoff() + assert mock_sleep.await_args[0][0] == pytest.approx(initial_backoff_interval) + + +# Check if backoff is needed +def test_will_backoff(): + """ + Test that the will_backoff method returns True if backoff is needed, False otherwise. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act and Assert + assert not backoff.will_backoff() + + backoff.increment_backoff() + assert backoff.will_backoff() + + +# Initialize backoff with invalid initial_backoff_interval +def test_initialize_backoff_invalid_initial_interval(): + """ + Test that initializing the PulseBackoff class with an invalid + initial_backoff_interval raises a ValueError. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = -1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + # Act and Assert + with pytest.raises(ValueError): + PulseBackoff( name, initial_backoff_interval, max_backoff_interval, @@ -36,146 +216,24 @@ def test_initialize_backoff_valid_parameters(self): detailed_debug_logging, ) - # Assert - assert backoff.name == name - assert backoff.initial_backoff_interval == initial_backoff_interval - assert backoff._max_backoff_interval == max_backoff_interval - assert backoff._backoff_count == 0 - assert backoff._expiration_time == 0.0 - - # Get current backoff interval - def test_get_current_backoff_interval(self): - """ - Test that the get_current_backoff_interval method returns the correct current backoff interval. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - - # Act - current_backoff_interval = backoff.get_current_backoff_interval() - assert current_backoff_interval == 0.0 - backoff.increment_backoff() - current_backoff_interval = backoff.get_current_backoff_interval() - # Assert - assert current_backoff_interval == initial_backoff_interval - backoff.increment_backoff() - current_backoff_interval = backoff.get_current_backoff_interval() - assert current_backoff_interval == initial_backoff_interval * 2 - - # Increment backoff - def test_increment_backoff(self): - """ - Test that the increment_backoff method increments the backoff count. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - # Act - backoff.increment_backoff() - - # Assert - assert backoff._backoff_count == 1 - backoff.increment_backoff() - assert backoff._backoff_count == 2 - - # Reset backoff - def test_reset_backoff(self): - """ - Test that the reset_backoff method resets the backoff count and expiration time. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - backoff.increment_backoff() - - # Act - backoff.reset_backoff() - - # Assert - assert backoff._backoff_count == 0 - - # Test that the wait_for_backoff method waits for the correct amount of time. - @pytest.mark.asyncio - async def test_wait_for_backoff2(self, mocker): - """ - Test that the wait_for_backoff method waits for the correct amount of time. - """ - # Arrange - - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - mocker.patch("asyncio.sleep") - - # Act - await backoff.wait_for_backoff() - assert asyncio.sleep.call_count == 0 - backoff.increment_backoff() - await backoff.wait_for_backoff() - asyncio.sleep.assert_called_once_with(initial_backoff_interval) - - # Check if backoff is needed - def test_will_backoff(self): - """ - Test that the will_backoff method returns True if backoff is needed, False otherwise. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - backoff = PulseBackoff( +# Initialize backoff with invalid max_backoff_interval +def test_initialize_backoff_invalid_max_interval(): + """ + Test that initializing the PulseBackoff class with an invalid + max_backoff_interval raises a ValueError. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 0.5 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + # Act and Assert + with pytest.raises(ValueError): + PulseBackoff( name, initial_backoff_interval, max_backoff_interval, @@ -184,98 +242,255 @@ def test_will_backoff(self): detailed_debug_logging, ) - # Act and Assert - assert not backoff.will_backoff() - - backoff.increment_backoff() - assert backoff.will_backoff() - - # Initialize backoff with invalid initial_backoff_interval - def test_initialize_backoff_invalid_initial_interval(self): - """ - Test that initializing the PulseBackoff class with an invalid - initial_backoff_interval raises a ValueError. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = -1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - - # Act and Assert - with pytest.raises(ValueError): - PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - - # Initialize backoff with invalid max_backoff_interval - def test_initialize_backoff_invalid_max_interval(self): - """ - Test that initializing the PulseBackoff class with an invalid - max_backoff_interval raises a ValueError. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 0.5 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - - # Act and Assert - with pytest.raises(ValueError): - PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - - # Test that setting the absolute backoff time with an invalid backoff_time raises a ValueError. - def test_set_absolute_backoff_time_invalid_time(self): - """ - Test that setting the absolute backoff time with an invalid backoff_time raises a ValueError. - """ - # Arrange - backoff = PulseBackoff( - name="test_backoff", - initial_backoff_interval=1.0, - max_backoff_interval=10.0, - threshold=0, - debug_locks=False, - detailed_debug_logging=False, - ) - # Act and Assert - with pytest.raises( - ValueError, match="Absolute backoff time must be greater than current time" - ): - backoff.set_absolute_backoff_time(time() - 1) - - # Initialize backoff with valid parameters - def test_initialize_backoff_valid_parameters2(self): - """ - Test that the PulseBackoff class can be initialized with valid parameters. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - - # Act - backoff = PulseBackoff( +# Test that setting the absolute backoff time with an invalid backoff_time raises a ValueError. +def test_set_absolute_backoff_time_invalid_time(): + """ + Test that setting the absolute backoff time with an invalid backoff_time raises a ValueError. + """ + # Arrange + backoff = PulseBackoff( + name="test_backoff", + initial_backoff_interval=1.0, + max_backoff_interval=10.0, + threshold=0, + debug_locks=False, + detailed_debug_logging=False, + ) + + # Act and Assert + with pytest.raises( + ValueError, match="Absolute backoff time must be greater than current time" + ): + backoff.set_absolute_backoff_time(time() - 1) + + +def test_set_absolute_backoff_time_valid_time(): + """ + Test that setting the absolute backoff time with a valid backoff_time works. + """ + # Arrange + backoff = PulseBackoff( + name="test_backoff", + initial_backoff_interval=1.0, + max_backoff_interval=10.0, + threshold=0, + debug_locks=False, + detailed_debug_logging=False, + ) + + # Act and Assert + backoff_time = time() + 10 + backoff.set_absolute_backoff_time(backoff_time) + assert backoff._expiration_time == backoff_time + + +# Initialize backoff with valid parameters +def test_initialize_backoff_valid_parameters2(): + """ + Test that the PulseBackoff class can be initialized with valid parameters. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + # Act + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Assert + assert backoff.name == name + assert backoff.initial_backoff_interval == initial_backoff_interval + assert backoff._max_backoff_interval == max_backoff_interval + assert backoff._backoff_count == 0 + assert backoff._expiration_time == 0.0 + + +# Increment backoff +def test_increment_backoff2(): + """ + Test that the backoff count is incremented correctly when calling the + increment_backoff method. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + backoff.increment_backoff() + + # Assert + assert backoff.backoff_count == 1 + + +# Reset backoff +def test_reset_backoff2(): + """ + Test that the backoff count and expiration time are not reset when calling + the reset_backoff method where expiration time is in the future. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + now = time() + backoff._backoff_count = 5 + backoff._expiration_time = now + 10.0 + + # Act + backoff.reset_backoff() + + # Assert + assert backoff._backoff_count == 5 + assert backoff._expiration_time == now + 10.0 + assert backoff.expiration_time == now + 10.0 + + +# Check if backoff is needed +def test_backoff_needed(): + """ + Test that the 'will_backoff' method returns the correct value when + backoff is needed. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + backoff.increment_backoff() + + # Assert + assert backoff.will_backoff() is True + + +# Wait for backoff +@pytest.mark.asyncio +async def test_wait_for_backoff(mocker): + """ + Test that the wait_for_backoff method waits for the correct amount of time. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + # Act + await backoff.wait_for_backoff() + assert backoff.expiration_time == 0.0 + backoff.increment_backoff() + # Assert + assert backoff.expiration_time == 0.0 + + +# Set initial backoff interval +def test_set_initial_backoff_interval(): + """ + Test that the initial backoff interval can be set. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + new_interval = 2.0 + backoff.initial_backoff_interval = new_interval + + # Assert + assert backoff.initial_backoff_interval == new_interval + + +# Initialize backoff with invalid max_backoff_interval +def test_initialize_backoff_invalid_max_interval2(): + """ + Test that the PulseBackoff class raises a ValueError when initialized + with an invalid max_backoff_interval. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 0.5 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + # Act & Assert + with pytest.raises(ValueError): + PulseBackoff( name, initial_backoff_interval, max_backoff_interval, @@ -284,89 +499,23 @@ def test_initialize_backoff_valid_parameters2(self): detailed_debug_logging, ) - # Assert - assert backoff.name == name - assert backoff.initial_backoff_interval == initial_backoff_interval - assert backoff._max_backoff_interval == max_backoff_interval - assert backoff._backoff_count == 0 - assert backoff._expiration_time == 0.0 - - # Increment backoff - def test_increment_backoff2(self): - """ - Test that the backoff count is incremented correctly when calling the - increment_backoff method. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - # Act - backoff.increment_backoff() - - # Assert - assert backoff.backoff_count == 1 - - # Reset backoff - def test_reset_backoff2(self): - """ - Test that the backoff count and expiration time are not reset when calling - the reset_backoff method where expiration time is in the future. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - curr_time = datetime.datetime.now() - with freeze_time(curr_time): - backoff._backoff_count = 5 - backoff._expiration_time = curr_time.timestamp() + 10.0 - - # Act - backoff.reset_backoff() - - # Assert - assert backoff._backoff_count == 5 - assert backoff._expiration_time == curr_time.timestamp() + 10.0 - - # Check if backoff is needed - def test_backoff_needed(self): - """ - Test that the 'will_backoff' method returns the correct value when - backoff is needed. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - - backoff = PulseBackoff( +def test_initialize_backoff_invalid_initial_interval2(): + """ + Test that the PulseBackoff class raises a ValueError when initialized with an + invalid initial_backoff_interval. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = -1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + # Act & Assert + with pytest.raises(ValueError): + PulseBackoff( name, initial_backoff_interval, max_backoff_interval, @@ -375,446 +524,354 @@ def test_backoff_needed(self): detailed_debug_logging, ) - # Act - backoff.increment_backoff() - - # Assert - assert backoff.will_backoff() is True - - # Wait for backoff - @pytest.mark.asyncio - async def test_wait_for_backoff(self, mocker): - """ - Test that the wait_for_backoff method waits for the correct amount of time. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - # Act - await backoff.wait_for_backoff() - assert backoff.expiration_time == 0.0 - backoff.increment_backoff() - # Assert - assert backoff.expiration_time == 0.0 - - # Set initial backoff interval - def test_set_initial_backoff_interval(self): - """ - Test that the initial backoff interval can be set. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - # Act - new_interval = 2.0 - backoff.initial_backoff_interval = new_interval - - # Assert - assert backoff.initial_backoff_interval == new_interval - - # Initialize backoff with invalid max_backoff_interval - def test_initialize_backoff_invalid_max_interval2(self): - """ - Test that the PulseBackoff class raises a ValueError when initialized - with an invalid max_backoff_interval. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 0.5 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - - # Act & Assert - with pytest.raises(ValueError): - PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - - def test_initialize_backoff_invalid_initial_interval2(self): - """ - Test that the PulseBackoff class raises a ValueError when initialized with an - invalid initial_backoff_interval. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = -1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - - # Act & Assert - with pytest.raises(ValueError): - PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - - # Set absolute backoff time with invalid backoff_time - def test_set_absolute_backoff_time_invalid_backoff_time(self, mocker): - """ - Test that set_absolute_backoff_time raises a ValueError when given an invalid backoff_time. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - - # Act and Assert - invalid_backoff_time = time() - 1 - with pytest.raises(ValueError): - backoff.set_absolute_backoff_time(invalid_backoff_time) - - # Wait for backoff with negative diff - @pytest.mark.asyncio - async def test_wait_for_backoff_with_negative_diff(self, mocker): - """ - Test that the wait_for_backoff method handles a negative diff correctly. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - - # Set the expiration time to a past time - backoff._expiration_time = time() - 1 - - start_time = time() - - # Act - await backoff.wait_for_backoff() - - # Assert - assert backoff._expiration_time >= initial_backoff_interval - - # Calculate backoff interval with backoff_count <= threshold - def test_calculate_backoff_interval_with_backoff_count_less_than_threshold(self): - """ - Test that the calculate_backoff_interval method returns 0 - when the backoff count is less than or equal to the threshold. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 5 - debug_locks = False - detailed_debug_logging = False - - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - - # Act - result = backoff._calculate_backoff_interval() - - # Assert - assert result == 0.0 - - # Calculate backoff interval with backoff_count > threshold and exceeds max_backoff_interval - @pytest.mark.asyncio - async def test_calculate_backoff_interval_exceeds_max(self, mocker): - """ - Test that the calculate_backoff_interval method returns the correct backoff interval - when backoff_count is greater than threshold and exceeds max_backoff_interval. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - - backoff._backoff_count = 2 - - # Act - result = backoff._calculate_backoff_interval() - - # Assert - assert result == 2.0 - backoff._backoff_count = 3 - result = backoff._calculate_backoff_interval() - assert result == 4.0 - backoff._backoff_count = 4 - result = backoff._calculate_backoff_interval() - assert result == 8.0 - backoff._backoff_count = 5 - result = backoff._calculate_backoff_interval() - assert result == max_backoff_interval - backoff._backoff_count = 6 - result = backoff._calculate_backoff_interval() - assert result == max_backoff_interval - - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 3 - debug_locks = False - detailed_debug_logging = False - - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - - backoff._backoff_count = 2 - - # Act - result = backoff._calculate_backoff_interval() - - # Assert - assert result == 1.0 - backoff._backoff_count = 3 - result = backoff._calculate_backoff_interval() - assert result == 1.0 - backoff._backoff_count = 4 - result = backoff._calculate_backoff_interval() - assert result == initial_backoff_interval - backoff._backoff_count = 5 - result = backoff._calculate_backoff_interval() - assert result == initial_backoff_interval * 2 - backoff._backoff_count = 6 - result = backoff._calculate_backoff_interval() - assert result == initial_backoff_interval * 4 - backoff._backoff_count = 7 - result = backoff._calculate_backoff_interval() - assert result == initial_backoff_interval * 8 - backoff._backoff_count = 8 - result = backoff._calculate_backoff_interval() - assert result == max_backoff_interval - backoff._backoff_count = 9 - result = backoff._calculate_backoff_interval() - assert result == max_backoff_interval - - # Increment backoff and update expiration_time - def test_increment_backoff_and_update_expiration_time(self): - """ - Test that the backoff count is incremented and the expiration time is - updated correctly. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - now = time() - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - # Act - backoff.increment_backoff() - - # Assert - assert backoff.backoff_count == 1 - - # Calculate backoff interval with backoff_count > threshold - def test_calculate_backoff_interval_with_backoff_count_greater_than_threshold(self): - """ - Test the calculation of backoff interval when backoff_count is greater than threshold. - """ - # Arrange - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - backoff_count = 5 - - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - backoff._backoff_count = backoff_count - - # Act - calculated_interval = backoff._calculate_backoff_interval() - - # Assert - expected_interval = initial_backoff_interval * ( - 2 ** (backoff_count - threshold) - ) - assert calculated_interval == min(expected_interval, max_backoff_interval) - - # Test that calling increment backoff 4 times followed by wait for backoff - # will sleep for 8 seconds with an initial backoff of 1, max backoff of 10. - # And that an additional call to increment backoff followed by a wait for backoff will wait for 10. - - @pytest.mark.asyncio - async def test_increment_backoff_and_wait_for_backoff(self, mocker): - """ - Test that calling increment backoff 4 times followed by wait for backoff will - sleep for 8 seconds with an initial backoff of 1, max backoff of 10. - And that an additional call to increment backoff followed by a wait - for backoff will wait for 10. - """ - # Arrange - with freeze_time("2023-11-01 18:22:11") as frozen_time: - name = "test_backoff" - initial_backoff_interval = 1.0 - max_backoff_interval = 10.0 - threshold = 0 - debug_locks = False - detailed_debug_logging = False - - # Create a mock sleep function - async def mock_sleep(duration): - pass - - # Replace the asyncio.sleep function with the mock_sleep function - mocker.patch("asyncio.sleep", side_effect=mock_sleep) - - # Create a PulseBackoff object - backoff = PulseBackoff( - name, - initial_backoff_interval, - max_backoff_interval, - threshold, - debug_locks, - detailed_debug_logging, - ) - - # Act - frozen_time.tick(delta=datetime.timedelta(seconds=1)) - await backoff.wait_for_backoff() - assert asyncio.sleep.call_count == 0 - backoff.increment_backoff() - - await backoff.wait_for_backoff() - assert asyncio.sleep.call_count == 1 - assert asyncio.sleep.call_args_list[0][0][0] == initial_backoff_interval - backoff.increment_backoff() - - await backoff.wait_for_backoff() - assert asyncio.sleep.call_count == 2 - assert asyncio.sleep.call_args_list[1][0][0] == 2 * initial_backoff_interval - backoff.increment_backoff() - - await backoff.wait_for_backoff() - assert asyncio.sleep.call_count == 3 - assert asyncio.sleep.call_args_list[2][0][0] == 4 * initial_backoff_interval - backoff.increment_backoff() - - # Additional call after 4 iterations - await backoff.wait_for_backoff() - assert asyncio.sleep.call_count == 4 - assert asyncio.sleep.call_args_list[3][0][0] == 8 * initial_backoff_interval - backoff.increment_backoff() - - await backoff.wait_for_backoff() - assert asyncio.sleep.call_count == 5 - assert asyncio.sleep.call_args_list[4][0][0] == max_backoff_interval - backoff.increment_backoff() - await backoff.wait_for_backoff() - assert asyncio.sleep.call_count == 6 - assert asyncio.sleep.call_args_list[4][0][0] == max_backoff_interval +# Set absolute backoff time with invalid backoff_time +def test_set_absolute_backoff_time_invalid_backoff_time(): + """ + Test that set_absolute_backoff_time raises a ValueError when given an invalid backoff_time. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act and Assert + invalid_backoff_time = time() - 1 + with pytest.raises(ValueError): + backoff.set_absolute_backoff_time(invalid_backoff_time) + + +# Wait for backoff with negative diff +@pytest.mark.asyncio +async def test_wait_for_backoff_with_negative_diff(mocker): + """ + Test that the wait_for_backoff method handles a negative diff correctly. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Set the expiration time to a past time + backoff._expiration_time = time() - 1 + + start_time = time() + + # Act + await backoff.wait_for_backoff() + + # Assert + assert backoff._expiration_time >= initial_backoff_interval + + +# Calculate backoff interval with backoff_count <= threshold +def test_calculate_backoff_interval_with_backoff_count_less_than_threshold(): + """ + Test that the calculate_backoff_interval method returns 0 + when the backoff count is less than or equal to the threshold. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 5 + debug_locks = False + detailed_debug_logging = False + + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + result = backoff._calculate_backoff_interval() + + # Assert + assert result == 0.0 + + +# Calculate backoff interval with backoff_count > threshold and exceeds max_backoff_interval +@pytest.mark.asyncio +async def test_calculate_backoff_interval_exceeds_max(mocker): + """ + Test that the calculate_backoff_interval method returns the correct backoff interval + when backoff_count is greater than threshold and exceeds max_backoff_interval. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + backoff._backoff_count = 2 + + # Act + result = backoff._calculate_backoff_interval() + + # Assert + assert result == 2.0 + backoff._backoff_count = 3 + result = backoff._calculate_backoff_interval() + assert result == 4.0 + backoff._backoff_count = 4 + result = backoff._calculate_backoff_interval() + assert result == 8.0 + backoff._backoff_count = 5 + result = backoff._calculate_backoff_interval() + assert result == max_backoff_interval + backoff._backoff_count = 6 + result = backoff._calculate_backoff_interval() + assert result == max_backoff_interval + + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 3 + debug_locks = False + detailed_debug_logging = False + + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + backoff._backoff_count = 2 + + # Act + result = backoff._calculate_backoff_interval() + + # Assert + assert result == 1.0 + backoff._backoff_count = 3 + result = backoff._calculate_backoff_interval() + assert result == 1.0 + backoff._backoff_count = 4 + result = backoff._calculate_backoff_interval() + assert result == initial_backoff_interval + backoff._backoff_count = 5 + result = backoff._calculate_backoff_interval() + assert result == initial_backoff_interval * 2 + backoff._backoff_count = 6 + result = backoff._calculate_backoff_interval() + assert result == initial_backoff_interval * 4 + backoff._backoff_count = 7 + result = backoff._calculate_backoff_interval() + assert result == initial_backoff_interval * 8 + backoff._backoff_count = 8 + result = backoff._calculate_backoff_interval() + assert result == max_backoff_interval + backoff._backoff_count = 9 + result = backoff._calculate_backoff_interval() + assert result == max_backoff_interval + + +# Increment backoff and update expiration_time +def test_increment_backoff_and_update_expiration_time(): + """ + Test that the backoff count is incremented + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + # Act + backoff.increment_backoff() + + # Assert + assert backoff.backoff_count == 1 + + +# Calculate backoff interval with backoff_count > threshold +def test_calculate_backoff_interval_with_backoff_count_greater_than_threshold(): + """ + Test the calculation of backoff interval when backoff_count is greater than threshold. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff_count = 5 + + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + backoff._backoff_count = backoff_count + + # Act + calculated_interval = backoff._calculate_backoff_interval() + + # Assert + expected_interval = initial_backoff_interval * (2 ** (backoff_count - threshold)) + assert calculated_interval == min(expected_interval, max_backoff_interval) + + +# Test that calling increment backoff 4 times followed by wait for backoff +# will sleep for 8 seconds with an initial backoff of 1, max backoff of 10. +# And that an additional call to increment backoff followed by a wait for backoff will wait for 10. + + +@pytest.mark.asyncio +async def test_increment_backoff_and_wait_for_backoff(mock_sleep): + """ + Test that calling increment backoff 4 times followed by wait for backoff will + sleep for 8 seconds with an initial backoff of 1, max backoff of 10. + And that an additional call to increment backoff followed by a wait + for backoff will wait for 10. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + + # Create a PulseBackoff object + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + await backoff.wait_for_backoff() + assert mock_sleep.call_count == 0 + backoff.increment_backoff() + + await backoff.wait_for_backoff() + assert mock_sleep.call_count == 1 + assert mock_sleep.call_args_list[0][0][0] == initial_backoff_interval + backoff.increment_backoff() + + await backoff.wait_for_backoff() + assert mock_sleep.call_count == 2 + assert mock_sleep.call_args_list[1][0][0] == 2 * initial_backoff_interval + backoff.increment_backoff() + + await backoff.wait_for_backoff() + assert mock_sleep.call_count == 3 + assert mock_sleep.call_args_list[2][0][0] == 4 * initial_backoff_interval + backoff.increment_backoff() + + # Additional call after 4 iterations + await backoff.wait_for_backoff() + assert mock_sleep.call_count == 4 + assert mock_sleep.call_args_list[3][0][0] == 8 * initial_backoff_interval + backoff.increment_backoff() + + await backoff.wait_for_backoff() + assert mock_sleep.call_count == 5 + assert mock_sleep.call_args_list[4][0][0] == max_backoff_interval + backoff.increment_backoff() + await backoff.wait_for_backoff() + assert mock_sleep.call_count == 6 + assert mock_sleep.call_args_list[4][0][0] == max_backoff_interval + + +@pytest.mark.asyncio +async def test_absolute_backoff_time(mock_sleep, freeze_time_to_now): + """ + Test that the absolute backoff time is calculated correctly. + """ + # Arrange + name = "test_backoff" + initial_backoff_interval = 1.0 + max_backoff_interval = 10.0 + threshold = 0 + debug_locks = False + detailed_debug_logging = False + backoff = PulseBackoff( + name, + initial_backoff_interval, + max_backoff_interval, + threshold, + debug_locks, + detailed_debug_logging, + ) + + # Act + backoff.set_absolute_backoff_time(time() + 100) + backoff.reset_backoff() + # make sure backoff can't be reset + assert backoff.expiration_time == time() + 100 + await backoff.wait_for_backoff() + assert mock_sleep.call_count == 1 + assert mock_sleep.call_args_list[0][0][0] == 100 diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index f95c444..d0c7144 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -1,7 +1,6 @@ """Test Pulse Query Manager.""" -import inspect -from datetime import datetime, timedelta -from unittest import mock +import time +from datetime import datetime import pytest @@ -11,37 +10,16 @@ from pyadtpulse.pulse_query_manager import PulseQueryManager -def get_calling_function() -> str | None: - curr_frame = inspect.currentframe() - if not curr_frame: - return None - if not curr_frame.f_back: - return None - if not curr_frame.f_back.f_back: - return None - if not curr_frame.f_back.f_back.f_back: - return None - if not curr_frame.f_back.f_back.f_back.f_back: - return None - frame = curr_frame.f_back.f_back.f_back.f_back - calling_function = frame.f_globals["__name__"] + "." + frame.f_code.co_name - return calling_function - - @pytest.mark.asyncio -async def test_retry_after(mocked_server_responses): +async def test_retry_after(mocked_server_responses, mock_sleep, freeze_time_to_now): """Test retry after.""" - sleep_function_calls: list[str] = [] - - def msleep(*args, **kwargs): - func = get_calling_function() - if func: - sleep_function_calls.append(func) retry_after_time = 120 - now = datetime.now() - retry_date = now + timedelta(seconds=retry_after_time) - retry_date_str = retry_date.strftime("%a, %d %b %Y %H:%M:%S GMT") + now = time.time() + retry_date = now + float(retry_after_time) + retry_date_str = datetime.fromtimestamp(retry_date).strftime( + "%a, %d %b %Y %H:%M:%S GMT" + ) s = PulseConnectionStatus() cp = PulseConnectionProperties(DEFAULT_API_HOST) p = PulseQueryManager(s, cp) @@ -61,28 +39,18 @@ def msleep(*args, **kwargs): headers={"Retry-After": retry_date_str}, ) - # with freezegun.freeze_time(now) as frozen_time: s = PulseConnectionStatus() cp = PulseConnectionProperties(DEFAULT_API_HOST) p = PulseQueryManager(s, cp) - - with mock.patch("asyncio.sleep", side_effect=msleep) as mock_sleep: - await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert s.connection_failure_reason == ConnectionFailureReason.TOO_MANY_REQUESTS - assert mock_sleep.call_count == 0 - # make sure we can't override the retry - # s.get_backoff().reset_backoff() - # assert ( - # s.get_backoff().expiration_time - # == (now + timedelta(seconds=retry_after_time + 5)).timestamp() - # ) - # frozen_time.tick(timedelta(seconds=20)) - await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE - assert mock_sleep.call_count == 1 - mock_sleep.assert_called_once_with(retry_after_time) - await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert ( - s.connection_failure_reason == ConnectionFailureReason.SERVICE_UNAVAILABLE - ) - assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert s.connection_failure_reason == ConnectionFailureReason.TOO_MANY_REQUESTS + assert mock_sleep.call_count == 0 + # make sure we can't override the retry + s.get_backoff().reset_backoff() + assert s.get_backoff().expiration_time == (now + float(retry_after_time)) + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + assert mock_sleep.call_count == 1 + mock_sleep.assert_called_once_with(float(retry_after_time)) + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert s.connection_failure_reason == ConnectionFailureReason.SERVICE_UNAVAILABLE From e47f80240b510b4d6734cc2032a12a015121db5d Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 10 Dec 2023 17:43:33 -0500 Subject: [PATCH 126/226] pre-commit hook fixes --- pyadtpulse/.vscode/settings.json | 2 +- tests/data_files/device_1.html | 155 +++++++++++++++---------------- tests/data_files/device_10.html | 135 +++++++++++++-------------- tests/data_files/device_11.html | 135 +++++++++++++-------------- tests/data_files/device_16.html | 135 +++++++++++++-------------- tests/data_files/device_2.html | 135 +++++++++++++-------------- tests/data_files/device_24.html | 153 +++++++++++++++--------------- tests/data_files/device_25.html | 135 +++++++++++++-------------- tests/data_files/device_26.html | 135 +++++++++++++-------------- tests/data_files/device_27.html | 135 +++++++++++++-------------- tests/data_files/device_28.html | 135 +++++++++++++-------------- tests/data_files/device_29.html | 135 +++++++++++++-------------- tests/data_files/device_3.html | 135 +++++++++++++-------------- tests/data_files/device_30.html | 135 +++++++++++++-------------- tests/data_files/device_34.html | 143 ++++++++++++++-------------- tests/data_files/device_69.html | 135 +++++++++++++-------------- tests/data_files/device_70.html | 135 +++++++++++++-------------- tests/data_files/gateway.html | 101 ++++++++++---------- tests/data_files/summary.html | 70 +++++++------- tests/data_files/system.html | 100 ++++++++++---------- 20 files changed, 1195 insertions(+), 1284 deletions(-) diff --git a/pyadtpulse/.vscode/settings.json b/pyadtpulse/.vscode/settings.json index bee182e..12901f9 100644 --- a/pyadtpulse/.vscode/settings.json +++ b/pyadtpulse/.vscode/settings.json @@ -1,3 +1,3 @@ -{ +{ "python.analysis.typeCheckingMode": "basic" } diff --git a/tests/data_files/device_1.html b/tests/data_files/device_1.html index 001e745..ea104a3 100644 --- a/tests/data_files/device_1.html +++ b/tests/data_files/device_1.html @@ -12,12 +12,12 @@ - - - - - - + + + + + + @@ -35,7 +35,7 @@ - + @@ -86,7 +86,7 @@
- +
@@ -95,9 +95,9 @@
- + - +
@@ -117,22 +117,22 @@
Summary History Rules System @@ -155,11 +155,11 @@
- + - + System - +
@@ -172,48 +172,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -268,63 +268,63 @@ Security Panel - - + + Manufacturer/Provider: ADT - + Type/Model:Security Panel - Safewatch Pro 3000/3000CN - - - - + + + + Emergency Keys: - - - + + +
Button: Fire Alarm (Zone 95)
- +
Button: Audible Panic Alarm (Zone 99)
- + - + - + - + Security Panel Master Code: **** - - - - - - - - - + + + + + + + + + - + Status: @@ -338,22 +338,22 @@ - - + + - + - +
@@ -370,9 +370,9 @@
- +
OK
- +
@@ -382,7 +382,7 @@ - + @@ -396,14 +396,14 @@
- + - + - + @@ -418,22 +418,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -441,8 +441,3 @@ - - - - - diff --git a/tests/data_files/device_10.html b/tests/data_files/device_10.html index c531324..2c9e74e 100644 --- a/tests/data_files/device_10.html +++ b/tests/data_files/device_10.html @@ -12,12 +12,12 @@ - - - - - - + + + + + + @@ -35,7 +35,7 @@ - + @@ -86,7 +86,7 @@
- +
@@ -95,9 +95,9 @@
- + - +
@@ -117,22 +117,22 @@
Summary History Rules System @@ -155,11 +155,11 @@
- + - + System - +
@@ -172,48 +172,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -268,40 +268,40 @@ Basement Smoke - + Zone:17 - - + + Type/Model:Fire (Smoke/Heat) Detector - + Reporting Type:9:RF - - + + - + - - - - - - - - + + + + + + + + Status: @@ -315,22 +315,22 @@ - - + + - + - +
@@ -347,9 +347,9 @@
- +
OK
- +
@@ -359,7 +359,7 @@ - + @@ -373,14 +373,14 @@
- + - + - + @@ -395,22 +395,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -418,8 +418,3 @@ - - - - - diff --git a/tests/data_files/device_11.html b/tests/data_files/device_11.html index b6bc63e..db41a0e 100644 --- a/tests/data_files/device_11.html +++ b/tests/data_files/device_11.html @@ -12,12 +12,12 @@ - - - - - - + + + + + + @@ -35,7 +35,7 @@ - + @@ -86,7 +86,7 @@
- +
@@ -95,9 +95,9 @@
- + - +
@@ -117,22 +117,22 @@
Summary History Rules System @@ -155,11 +155,11 @@
- + - + System - +
@@ -172,48 +172,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -268,40 +268,40 @@ 2nd Floor Smoke - + Zone:18 - - + + Type/Model:Fire (Smoke/Heat) Detector - + Reporting Type:9:RF - - + + - + - - - - - - - - + + + + + + + + Status: @@ -315,22 +315,22 @@ - - + + - + - +
@@ -347,9 +347,9 @@
- +
OK
- +
@@ -359,7 +359,7 @@ - + @@ -373,14 +373,14 @@
- + - + - + @@ -395,22 +395,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -418,8 +418,3 @@ - - - - - diff --git a/tests/data_files/device_16.html b/tests/data_files/device_16.html index 3c1ec80..9c295ae 100644 --- a/tests/data_files/device_16.html +++ b/tests/data_files/device_16.html @@ -12,12 +12,12 @@ - - - - - - + + + + + + @@ -35,7 +35,7 @@ - + @@ -86,7 +86,7 @@
- +
@@ -95,9 +95,9 @@
- + - +
@@ -117,22 +117,22 @@
Summary History Rules System @@ -155,11 +155,11 @@
- + - + System - +
@@ -172,48 +172,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -268,40 +268,40 @@ Main Gas - + Zone:23 - - + + Type/Model:Carbon Monoxide Detector - + Reporting Type:14:RF - - + + - + - - - - - - - - + + + + + + + + Status: @@ -315,22 +315,22 @@ - - + + - + - +
@@ -347,9 +347,9 @@
- +
OK
- +
@@ -359,7 +359,7 @@ - + @@ -373,14 +373,14 @@
- + - + - + @@ -395,22 +395,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -418,8 +418,3 @@ - - - - - diff --git a/tests/data_files/device_2.html b/tests/data_files/device_2.html index a20964c..79bc6a5 100644 --- a/tests/data_files/device_2.html +++ b/tests/data_files/device_2.html @@ -12,12 +12,12 @@ - - - - - - + + + + + + @@ -35,7 +35,7 @@ - + @@ -86,7 +86,7 @@
- +
@@ -95,9 +95,9 @@
- + - +
@@ -117,22 +117,22 @@
Summary History Rules System @@ -155,11 +155,11 @@
- + - + System - +
@@ -172,48 +172,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -268,40 +268,40 @@ Front Door - + Zone:9 - - + + Type/Model:Door/Window Sensor - + Reporting Type:1:RF - - + + - + - - - - - - - - + + + + + + + + Status: @@ -315,22 +315,22 @@ - - + + - + - +
@@ -347,9 +347,9 @@
- +
OK
- +
@@ -359,7 +359,7 @@ - + @@ -373,14 +373,14 @@
- + - + - + @@ -395,22 +395,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -418,8 +418,3 @@ - - - - - diff --git a/tests/data_files/device_24.html b/tests/data_files/device_24.html index 60ce128..fdca079 100644 --- a/tests/data_files/device_24.html +++ b/tests/data_files/device_24.html @@ -12,12 +12,12 @@ - - - - - - + + + + + + @@ -35,7 +35,7 @@ - + @@ -86,7 +86,7 @@
- +
@@ -95,9 +95,9 @@
- + - +
@@ -117,22 +117,22 @@
Summary History Rules System @@ -155,11 +155,11 @@
- + - + System - +
@@ -172,48 +172,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -268,58 +268,58 @@ keyfob - - + + Type/Model:Wireless Remote - - - - + + + + Buttons: - - - + + +
Button: Arm-Stay (Zone 49)
- +
Button: Arm-Away (Zone 50)
- +
Button: Disarm (Zone 51)
- +
Button: Audible Panic Alarm (Zone 52)
- + - + - + - - - - - - - - - + + + + + + + + + Status: @@ -333,22 +333,22 @@ - - + + - + - +
@@ -365,9 +365,9 @@
- +
OK
- +
@@ -377,7 +377,7 @@ - + @@ -391,14 +391,14 @@
- + - + - + @@ -413,22 +413,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -436,8 +436,3 @@ - - - - - diff --git a/tests/data_files/device_25.html b/tests/data_files/device_25.html index e2afccb..a038607 100644 --- a/tests/data_files/device_25.html +++ b/tests/data_files/device_25.html @@ -12,12 +12,12 @@ - - - - - - + + + + + + @@ -35,7 +35,7 @@ - + @@ -86,7 +86,7 @@
- +
@@ -95,9 +95,9 @@
- + - +
@@ -117,22 +117,22 @@
Summary History Rules System @@ -155,11 +155,11 @@
- + - + System - +
@@ -172,48 +172,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -268,40 +268,40 @@ Patio Door - + Zone:11 - - + + Type/Model:Door/Window Sensor - + Reporting Type:3:RF - - + + - + - - - - - - - - + + + + + + + + Status: @@ -315,22 +315,22 @@ - - + + - + - +
@@ -347,9 +347,9 @@
- +
OK
- +
@@ -359,7 +359,7 @@ - + @@ -373,14 +373,14 @@
- + - + - + @@ -395,22 +395,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -418,8 +418,3 @@ - - - - - diff --git a/tests/data_files/device_26.html b/tests/data_files/device_26.html index 534fc21..c6b21a5 100644 --- a/tests/data_files/device_26.html +++ b/tests/data_files/device_26.html @@ -12,12 +12,12 @@ - - - - - - + + + + + + @@ -35,7 +35,7 @@ - + @@ -86,7 +86,7 @@
- +
@@ -95,9 +95,9 @@
- + - +
@@ -117,22 +117,22 @@
Summary History Rules System @@ -155,11 +155,11 @@
- + - + System - +
@@ -172,48 +172,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -268,40 +268,40 @@ Basement Door - + Zone:13 - - + + Type/Model:Door/Window Sensor - + Reporting Type:3:RF - - + + - + - - - - - - - - + + + + + + + + Status: @@ -315,22 +315,22 @@ - - + + - + - +
@@ -347,9 +347,9 @@
- +
OK
- +
@@ -359,7 +359,7 @@ - + @@ -373,14 +373,14 @@
- + - + - + @@ -395,22 +395,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -418,8 +418,3 @@ - - - - - diff --git a/tests/data_files/device_27.html b/tests/data_files/device_27.html index a5a44be..d3148f1 100644 --- a/tests/data_files/device_27.html +++ b/tests/data_files/device_27.html @@ -12,12 +12,12 @@ - - - - - - + + + + + + @@ -35,7 +35,7 @@ - + @@ -86,7 +86,7 @@
- +
@@ -95,9 +95,9 @@
- + - +
@@ -117,22 +117,22 @@
Summary History Rules System @@ -155,11 +155,11 @@
- + - + System - +
@@ -172,48 +172,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -268,40 +268,40 @@ Back Door - + Zone:14 - - + + Type/Model:Door/Window Sensor - + Reporting Type:3:RF - - + + - + - - - - - - - - + + + + + + + + Status: @@ -315,22 +315,22 @@ - - + + - + - +
@@ -347,9 +347,9 @@
- +
OK
- +
@@ -359,7 +359,7 @@ - + @@ -373,14 +373,14 @@
- + - + - + @@ -395,22 +395,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -418,8 +418,3 @@ - - - - - diff --git a/tests/data_files/device_28.html b/tests/data_files/device_28.html index f7dc764..4816a4f 100644 --- a/tests/data_files/device_28.html +++ b/tests/data_files/device_28.html @@ -12,12 +12,12 @@ - - - - - - + + + + + + @@ -35,7 +35,7 @@ - + @@ -86,7 +86,7 @@
- +
@@ -95,9 +95,9 @@
- + - +
@@ -117,22 +117,22 @@
Summary History Rules System @@ -155,11 +155,11 @@
- + - + System - +
@@ -172,48 +172,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -268,40 +268,40 @@ Foyer Motion - + Zone:15 - - + + Type/Model:Motion Sensor - + Reporting Type:10:RF - - + + - + - - - - - - - - + + + + + + + + Status: @@ -315,22 +315,22 @@ - - + + - + - +
@@ -347,9 +347,9 @@
- +
OK
- +
@@ -359,7 +359,7 @@ - + @@ -373,14 +373,14 @@
- + - + - + @@ -395,22 +395,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -418,8 +418,3 @@ - - - - - diff --git a/tests/data_files/device_29.html b/tests/data_files/device_29.html index b48b5bf..f8f0fb2 100644 --- a/tests/data_files/device_29.html +++ b/tests/data_files/device_29.html @@ -12,12 +12,12 @@ - - - - - - + + + + + + @@ -35,7 +35,7 @@ - + @@ -86,7 +86,7 @@
- +
@@ -95,9 +95,9 @@
- + - +
@@ -117,22 +117,22 @@
Summary History Rules System @@ -155,11 +155,11 @@
- + - + System - +
@@ -172,48 +172,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -268,40 +268,40 @@ Living Room Door - + Zone:12 - - + + Type/Model:Door/Window Sensor - + Reporting Type:3:RF - - + + - + - - - - - - - - + + + + + + + + Status: @@ -315,22 +315,22 @@ - - + + - + - +
@@ -347,9 +347,9 @@
- +
OK
- +
@@ -359,7 +359,7 @@ - + @@ -373,14 +373,14 @@
- + - + - + @@ -395,22 +395,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -418,8 +418,3 @@ - - - - - diff --git a/tests/data_files/device_3.html b/tests/data_files/device_3.html index 4e29c4d..5592028 100644 --- a/tests/data_files/device_3.html +++ b/tests/data_files/device_3.html @@ -12,12 +12,12 @@ - - - - - - + + + + + + @@ -35,7 +35,7 @@ - + @@ -86,7 +86,7 @@
- +
@@ -95,9 +95,9 @@
- + - +
@@ -117,22 +117,22 @@
Summary History Rules System @@ -155,11 +155,11 @@
- + - + System - +
@@ -172,48 +172,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -268,40 +268,40 @@ Garage Door - + Zone:10 - - + + Type/Model:Door/Window Sensor - + Reporting Type:1:RF - - + + - + - - - - - - - - + + + + + + + + Status: @@ -315,22 +315,22 @@ - - + + - + - +
@@ -347,9 +347,9 @@
- +
OK
- +
@@ -359,7 +359,7 @@ - + @@ -373,14 +373,14 @@
- + - + - + @@ -395,22 +395,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -418,8 +418,3 @@ - - - - - diff --git a/tests/data_files/device_30.html b/tests/data_files/device_30.html index d264bf3..2a782f9 100644 --- a/tests/data_files/device_30.html +++ b/tests/data_files/device_30.html @@ -12,12 +12,12 @@ - - - - - - + + + + + + @@ -35,7 +35,7 @@ - + @@ -86,7 +86,7 @@
- +
@@ -95,9 +95,9 @@
- + - +
@@ -117,22 +117,22 @@
Summary History Rules System @@ -155,11 +155,11 @@
- + - + System - +
@@ -172,48 +172,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -268,40 +268,40 @@ Family Glass Break - + Zone:16 - - + + Type/Model:Glass Break Detector - + Reporting Type:3:RF - - + + - + - - - - - - - - + + + + + + + + Status: @@ -315,22 +315,22 @@ - - + + - + - +
@@ -347,9 +347,9 @@
- +
OK
- +
@@ -359,7 +359,7 @@ - + @@ -373,14 +373,14 @@
- + - + - + @@ -395,22 +395,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -418,8 +418,3 @@ - - - - - diff --git a/tests/data_files/device_34.html b/tests/data_files/device_34.html index 90b135b..216fb8a 100644 --- a/tests/data_files/device_34.html +++ b/tests/data_files/device_34.html @@ -12,12 +12,12 @@ - - - - - - + + + + + + @@ -35,7 +35,7 @@ - + @@ -86,7 +86,7 @@
- +
@@ -95,9 +95,9 @@
- + - +
@@ -117,22 +117,22 @@
Summary History Rules System @@ -155,11 +155,11 @@
- + - + System - +
@@ -172,48 +172,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -268,46 +268,46 @@ Camera - - + + Manufacturer/Provider: ADT - + Type/Model:RC8325-ADT Indoor/Night HD Camera - - + + - + Version: 3.0.02.30ADT - + - - - ID:E06066032138 - - - - - + ID:E06066032138 + + + + + + + + + + - - - - + Status: @@ -321,22 +321,22 @@ - - + + - + - +
@@ -353,9 +353,9 @@
- +
OK
- +
@@ -365,7 +365,7 @@ - + @@ -379,14 +379,14 @@
- + - + - + @@ -401,22 +401,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -424,8 +424,3 @@ - - - - - diff --git a/tests/data_files/device_69.html b/tests/data_files/device_69.html index b907b44..3f3474f 100644 --- a/tests/data_files/device_69.html +++ b/tests/data_files/device_69.html @@ -12,12 +12,12 @@ - - - - - - + + + + + + @@ -35,7 +35,7 @@ - + @@ -86,7 +86,7 @@
- +
@@ -95,9 +95,9 @@
- + - +
@@ -117,22 +117,22 @@
Summary History Rules System @@ -155,11 +155,11 @@
- + - + System - +
@@ -172,48 +172,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -268,40 +268,40 @@ Radio Station Smoke - + Zone:22 - - + + Type/Model:Fire (Smoke/Heat) Detector - + Reporting Type:9:RF - - + + - + - - - - - - - - + + + + + + + + Status: @@ -315,22 +315,22 @@ - - + + - + - +
@@ -347,9 +347,9 @@
- +
OK
- +
@@ -359,7 +359,7 @@ - + @@ -373,14 +373,14 @@
- + - + - + @@ -395,22 +395,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -418,8 +418,3 @@ - - - - - diff --git a/tests/data_files/device_70.html b/tests/data_files/device_70.html index 57822dc..c288b68 100644 --- a/tests/data_files/device_70.html +++ b/tests/data_files/device_70.html @@ -12,12 +12,12 @@ - - - - - - + + + + + + @@ -35,7 +35,7 @@ - + @@ -86,7 +86,7 @@
- +
@@ -95,9 +95,9 @@
- + - +
@@ -117,22 +117,22 @@
Summary History Rules System @@ -155,11 +155,11 @@
- + - + System - +
@@ -172,48 +172,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -268,40 +268,40 @@ Radio Station Gas - + Zone:24 - - + + Type/Model:Carbon Monoxide Detector - + Reporting Type:14:RF - - + + - + - - - - - - - - + + + + + + + + Status: @@ -315,22 +315,22 @@ - - + + - + - +
@@ -347,9 +347,9 @@
- +
OK
- +
@@ -359,7 +359,7 @@ - + @@ -373,14 +373,14 @@
- + - + - + @@ -395,22 +395,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -418,8 +418,3 @@ - - - - - diff --git a/tests/data_files/gateway.html b/tests/data_files/gateway.html index 236b8c1..af4f425 100644 --- a/tests/data_files/gateway.html +++ b/tests/data_files/gateway.html @@ -11,12 +11,12 @@ - - - - - - + + + + + + @@ -32,7 +32,7 @@ - + @@ -83,7 +83,7 @@
- +
@@ -92,9 +92,9 @@
- + - +
@@ -114,22 +114,22 @@
Summary History Rules System @@ -152,11 +152,11 @@
- + - + System - +
@@ -168,48 +168,48 @@
- - + + Devices - +  |  - - + + Site Settings - +  |  - + Users - - + +  |  - + Access Codes - +  |  - + My Profile - +  |  - + My Profile History - - + +
@@ -235,7 +235,7 @@ - +
@@ -264,16 +264,16 @@
Online
- + Manufacturer:ADT Pulse Gateway - + Model:PGZNG1 Serial Number:5U020CN3007E3 Next Update:Today 10:06 PM Last Update:Today 4:06 PM Firmware Version:24.0.0-9 Hardware Version:HW=3, BL=1.1.9b, PL=9.4.0.32.5, SKU=PGZNG1-2ADNAS - +   Communication Link Status Primary Connection Type:Broadband @@ -288,7 +288,7 @@ Device LAN MAC:0a:bc:2e:5d:7f:9a Router LAN IP Address:192.168.1.1 Router WAN IP Address: - + @@ -317,7 +317,7 @@ - + @@ -331,14 +331,14 @@
- +
- + - + @@ -353,22 +353,22 @@ - + - - + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
- - + +
© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
- +
- +
@@ -385,6 +385,3 @@ goToUrl('system.jsp'); } - - - diff --git a/tests/data_files/summary.html b/tests/data_files/summary.html index bc5baf6..645993c 100644 --- a/tests/data_files/summary.html +++ b/tests/data_files/summary.html @@ -15,12 +15,12 @@ - - - - - - + + + + + + @@ -36,7 +36,7 @@ - + @@ -55,7 +55,7 @@ ajaxpage('/myhome/26.0.0-32/ajax/currentPictures.jsp','divCurrentPicturesContent'); ajaxpage('/myhome/26.0.0-32/ajax/todaysSchedule.jsp','divScheduleContent','todaysScheduleList'); errorParser(); - + } @@ -94,7 +94,7 @@ </div> <div class="p_headerMsgStyle"> - + </div> </div> @@ -103,9 +103,9 @@ <div class="p_headerStyle"> <div class="p_logoStyle"> <a href="/myhome/26.0.0-32/summary/summary.jsp" id="logoimage"> - + <div class="p_customLogo"></div> - + </a> </div> @@ -125,22 +125,22 @@ <div class="p_tabFill"> <a class="p_leftTab" - id="p_currentTab" + id="p_currentTab" href="/myhome/26.0.0-32/summary/summary.jsp" title="View current system status">Summary </a> <a class="p_midTab" - + href="/myhome/26.0.0-32/history/history.jsp" title="View past system activity">History </a> <a class="p_midTab" - + href="/myhome/26.0.0-32/qaas/rules.jsp" title="View current system rules">Rules </a> <a class="p_midTab" - + href="/myhome/26.0.0-32/system/system.jsp" title="View devices, users, and settings">System </a> @@ -174,7 +174,7 @@ <div id="orbtop" class="p_sumgrowboxtop"></div> <div id="orbmid" class="p_sumgrowboxmid"> <div id="divOrbContent" class="p_summaryorbboxcontent"> - + @@ -216,9 +216,9 @@ <div class="floatstop"></div> <div id="divOrbTextSummary"> <span class="p_boldNormalTextLarge">Disarmed. All Quiet.</span> - + </div> - + <table class="p_rowl" border=0 cellpadding=0 cellspacing=0 width=325> <tr><td width=100% class="listBoxData"> <div id="orbSensorsList" style="height:114px;position:relative;overflow:auto;overflow-y:auto;overflow-x:auto;text-align:left;"> @@ -259,7 +259,7 @@ <div id="devstatemid" class="p_sumgrowboxmid"> <span class="p_summaryboxtitle"><a href="../history/history.jsp" title="Other Devices">Other Devices</a></span> <div id="divCurrentStatusContent" class="p_summaryboxcontent"> - + @@ -315,16 +315,16 @@ <tr> <td colspan="2"> <span class="p_summaryboxtitle"> - + <a href="javascript:trackClickOnCameraDashboard('Cameras');openWindowSavingRef('../portalCamera/portalCamera.jsp#!/main/fourup', 'imageWindow', 100, 50, 750, 620, true);" title="Cameras">Cameras</a> - + </span> </td> </tr> <tr> <td height="80" colspan="2" align="center" valign="top"> <div id="divCurrentPicturesContent" name="divCurrentPicturesContent"> - + @@ -382,7 +382,7 @@ <div id="schedmid" class="p_sumgrowboxmid"> <span class="p_summaryboxtitle"><a href="/myhome/26.0.0-32/schedule/schedule.jsp" title="Today's Schedule">Today's Schedule</a></span> <div id="divScheduleContent" class="p_summaryboxcontent"> - + @@ -423,17 +423,17 @@ </table> - + <div style="height:8px;"></div> <div id="customize"><a class="p_normalText" href="/myhome/26.0.0-32/myaccount/myaccount.jsp">Customize this page</a></div> - + </div> - + <div id="footer_extension" class="p_footerExtension"></div> - </div> + </div> @@ -448,22 +448,22 @@ </div> <span class="p_footerWrapper" style="display:inline;visibility:visible"> <a href="#" onclick="javascript:window.setTimeout(function(){openModalDialog('/myhome/26.0.0-32/help/versionInfo.jsp', 662, 380, {autoCloseable: 'yes', closeBox: 'no'} );},100)" style="position:relative; top:-16px;"> - + <!-- todo localization - poweredby_logo contains text "powered by" in the image --> <img src="../images/powered.png" id="poweredby_logo" style="visibility:visible;width:90px;height:20px;cursor:pointer;"/> </a> </span> - - + + <div class="p_footerLegal1">Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.</div> - - + + <div class="p_footerLegal2">© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.</div> - + <div class="floatstop"></div> </div> -</div> +</div> <div class="p_footerShim2"></div> @@ -498,5 +498,3 @@ document.addEventListener("load", checkAndCreateInstallerCookie()); </script> - - diff --git a/tests/data_files/system.html b/tests/data_files/system.html index 09b0464..92c5626 100644 --- a/tests/data_files/system.html +++ b/tests/data_files/system.html @@ -12,13 +12,13 @@ - - - - - - - + + + + + + + <html id="CHROME" class="v119"> <head> @@ -35,7 +35,7 @@ <script type="text/javascript" src="../icjs/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../icjs/ajaxRest.js"></script> <script type="text/javascript" src="../icjs/system.js"></script> - + <script type="text/javascript" src="/myhome/26.0.0-32/appcmn/ic_helper/ic_helper.js"></script> <script type="text/javascript" src="/myhome/26.0.0-32/icjs/icRRA.js"></script> <script type="text/javascript" src="/myhome/26.0.0-32/icjs/icDialog.js"></script> @@ -88,7 +88,7 @@ </div> <div class="p_headerMsgStyle"> - + </div> </div> @@ -97,9 +97,9 @@ <div class="p_headerStyle"> <div class="p_logoStyle"> <a href="/myhome/26.0.0-32/summary/summary.jsp" id="logoimage"> - + <div class="p_customLogo"></div> - + </a> </div> @@ -119,22 +119,22 @@ <div class="p_tabFill"> <a class="p_leftTab" - + href="/myhome/26.0.0-32/summary/summary.jsp" title="View current system status">Summary </a> <a class="p_midTab" - + href="/myhome/26.0.0-32/history/history.jsp" title="View past system activity">History </a> <a class="p_midTab" - + href="/myhome/26.0.0-32/qaas/rules.jsp" title="View current system rules">Rules </a> <a class="p_midTab" - id="p_currentTab" + id="p_currentTab" href="/myhome/26.0.0-32/system/system.jsp" title="View devices, users, and settings">System </a> @@ -157,11 +157,11 @@ <div id="header_div" class="p_bgDiv33"> <div id="contentsTop"> - + <img style="float:left;margin-top:8px;margin-left:15px;" src="/z/branding/adt/26.0.0/images//pageIcons/system.gif"> - + <span class="PageTitleText" style="float:left;margin-top:13px;">System</span> - + </div> </div> @@ -174,53 +174,53 @@ <div class="transparent-panel"> <div class="p_topDiv" align="left"> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="p_subNavDiv"><tr><td align="left" valign="top"> - - + + <span title="View devices installed at this site" class="redlink" onclick="javascript:goToUrl('../system/system.jsp');">Devices</span> - + <span class="p_pipeDivider"> | </span> - - + + <a title="View this site's settings" href="../system/settings.jsp">Site Settings</a> - + <span class="p_pipeDivider"> | </span> - + <a title="Manage users with web access to this site" href="../system/admin.jsp">Users</a> - - + + <span class="p_pipeDivider"> | </span> - + <a title="Manage security panel access codes" href="#" onclick="javascript:goToUrlWithConfirmation('../system/accesscodes.jsp', '');"> Access Codes </a> - + <span class="p_pipeDivider"> | </span> - + <a title="Change my personal profile settings" href="../system/myprofile.jsp">My Profile</a> - + <span class="p_pipeDivider"> | </span> - + <a title="View history of my sign-ins and profile changes" href="../history/userAccountHistory.jsp">My Profile History</a> - - + + </td> <td align="right"> <div id="divsubnavbutton" class="p_topSubNavDivButton"> - + @@ -234,7 +234,7 @@ </div> <div class="floatstop"></div> <div id="p_display_controller"> - + @@ -265,7 +265,7 @@ <td width="193" align="left">Name <img src="../images/iconSortAsc.png" class="sortIconImg" alt="" /></td> <td width="57" align="left"><a href="system.jsp?sort=zone" title="Click to order sensors by zone number">Zone</a></td> <td align="left">Device Type</td> - + </tr> </table> @@ -448,7 +448,7 @@ <td class='p_raisedBoxFooterLeft'></td> <td class='p_raisedBoxFooterCenter' width="100%"></td> <td class='p_raisedBoxFooterRight'></td> - </tr> + </tr> <tr> <td class='p_raisedBoxBottomLeft'></td> <td class='p_raisedBoxBottomCenter'></td> @@ -462,14 +462,14 @@ </div> </div> - + </div> - + <div id="footer_extension" class="p_footerExtension"></div> - </div> + </div> @@ -484,22 +484,22 @@ </div> <span class="p_footerWrapper" style="display:inline;visibility:visible"> <a href="#" onclick="javascript:window.setTimeout(function(){openModalDialog('/myhome/26.0.0-32/help/versionInfo.jsp', 662, 380, {autoCloseable: 'yes', closeBox: 'no'} );},100)" style="position:relative; top:-16px;"> - + <!-- todo localization - poweredby_logo contains text "powered by" in the image --> <img src="../images/powered.png" id="poweredby_logo" style="visibility:visible;width:90px;height:20px;cursor:pointer;"/> </a> </span> - - + + <div class="p_footerLegal1">Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.</div> - - + + <div class="p_footerLegal2">© 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.</div> - + <div class="floatstop"></div> </div> -</div> +</div> <div class="p_footerShim2"></div> @@ -507,7 +507,3 @@ </body> </html> - - - - From a477ebe59b5cb240e3e2852b3fce3f4fd41e4452 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <rlippmann@hotmail.com> Date: Mon, 11 Dec 2023 20:51:10 -0500 Subject: [PATCH 127/226] rework async_query again --- pyadtpulse/pulse_connection_status.py | 5 + pyadtpulse/pulse_query_manager.py | 134 +++++++++++++++----------- tests/test_pulse_query_manager.py | 86 ++++++++++++++--- 3 files changed, 155 insertions(+), 70 deletions(-) diff --git a/pyadtpulse/pulse_connection_status.py b/pyadtpulse/pulse_connection_status.py index 42b3e0b..529d144 100644 --- a/pyadtpulse/pulse_connection_status.py +++ b/pyadtpulse/pulse_connection_status.py @@ -70,3 +70,8 @@ def increment_backoff(self) -> None: """Increment the backoff.""" with self._pcs_attribute_lock: self._backoff.increment_backoff() + + def reset_backoff(self) -> None: + """Reset the backoff.""" + with self._pcs_attribute_lock: + self._backoff.reset_backoff() diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index 6827393..1283108 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -35,7 +35,24 @@ HTTPStatus.BAD_GATEWAY, HTTPStatus.GATEWAY_TIMEOUT, } -RETRY_LATER_ERRORS = {HTTPStatus.SERVICE_UNAVAILABLE, HTTPStatus.TOO_MANY_REQUESTS} +RETRY_LATER_ERRORS = frozenset( + {HTTPStatus.SERVICE_UNAVAILABLE, HTTPStatus.TOO_MANY_REQUESTS} +) +RETRY_LATER_CONNECTION_STATUSES = frozenset( + { + reason + for reason in ConnectionFailureReason + if reason.value[0] in RETRY_LATER_ERRORS + } +) +CHANGEABLE_CONNECTION_STATUSES = frozenset( + RETRY_LATER_CONNECTION_STATUSES + | { + ConnectionFailureReason.NO_FAILURE, + ConnectionFailureReason.CLIENT_ERROR, + ConnectionFailureReason.SERVER_ERROR, + } +) MAX_RETRIES = 3 @@ -118,13 +135,15 @@ def set_retry_after(code: int, retry_after: str) -> None: Returns: None. """ + now = time() if retry_after.isnumeric(): retval = float(retry_after) else: try: retval = datetime.strptime( - retry_after, "%a, %d %b %G %T %Z" + retry_after, "%a, %d %b %Y %H:%M:%S %Z" ).timestamp() + retval -= now except ValueError: return description = self._get_http_status_description(code) @@ -134,14 +153,9 @@ def set_retry_after(code: int, retry_after: str) -> None: retval, description, ) - self._connection_status.retry_after = time() + retval - if code == HTTPStatus.SERVICE_UNAVAILABLE: - fail_reason = ConnectionFailureReason.SERVICE_UNAVAILABLE - elif code == HTTPStatus.TOO_MANY_REQUESTS: - fail_reason = ConnectionFailureReason.TOO_MANY_REQUESTS - else: - fail_reason = ConnectionFailureReason.UNKNOWN - self._connection_status.connection_failure_reason = fail_reason + # don't set the retry_after if it is in the past + if retval > 0: + self._connection_status.retry_after = now + retval async def handle_query_response( response: ClientResponse | None, @@ -157,19 +171,52 @@ async def handle_query_response( response.headers.get("Retry-After"), ) - if method not in ("GET", "POST"): - raise ValueError("method must be GET or POST") - await self._connection_status.get_backoff().wait_for_backoff() - if ( - requires_authentication - and not self._connection_status.authenticated_flag.is_set() - ): - LOG.info("%s for %s waiting for authenticated flag to be set", method, uri) - await self._connection_status.authenticated_flag.wait() - else: - if self._connection_properties.api_version == ADT_DEFAULT_VERSION: - await self.async_fetch_version() + def handle_http_errors() -> ConnectionFailureReason: + if return_value[0] is not None and return_value[3] is not None: + set_retry_after( + return_value[0], + return_value[3], + ) + if return_value[0] == HTTPStatus.TOO_MANY_REQUESTS: + return ConnectionFailureReason.TOO_MANY_REQUESTS + if return_value[0] == HTTPStatus.SERVICE_UNAVAILABLE: + return ConnectionFailureReason.SERVICE_UNAVAILABLE + return ConnectionFailureReason.SERVER_ERROR + + async def handle_network_errors(e: Exception) -> ConnectionFailureReason: + failure_reason = ConnectionFailureReason.CLIENT_ERROR + if isinstance(e, ServerDisconnectedError): + failure_reason = ConnectionFailureReason.SERVER_ERROR + query_backoff.increment_backoff() + await query_backoff.wait_for_backoff() + return failure_reason + async def setup_query(): + if method not in ("GET", "POST"): + raise ValueError("method must be GET or POST") + await self._connection_status.get_backoff().wait_for_backoff() + if ( + requires_authentication + and not self._connection_status.authenticated_flag.is_set() + ): + LOG.info( + "%s for %s waiting for authenticated flag to be set", method, uri + ) + await self._connection_status.authenticated_flag.wait() + else: + if self._connection_properties.api_version == ADT_DEFAULT_VERSION: + await self.async_fetch_version() + + def update_connection_status(): + if failure_reason not in CHANGEABLE_CONNECTION_STATUSES: + return + if failure_reason == ConnectionFailureReason.NO_FAILURE: + self._connection_status.reset_backoff() + elif failure_reason not in RETRY_LATER_CONNECTION_STATUSES: + self._connection_status.increment_backoff() + self._connection_status.connection_failure_reason = failure_reason + + await setup_query() url = self._connection_properties.make_url(uri) headers = extra_headers if extra_headers is not None else {} if uri in ADT_HTTP_BACKGROUND_URIS: @@ -189,15 +236,15 @@ async def handle_query_response( None, None, ) + failure_reason = ConnectionFailureReason.NO_FAILURE query_backoff = PulseBackoff( f"Query:{method} {uri}", - self._connection_status.get_backoff().initial_backoff_interval, + timeout, threshold=1, debug_locks=self._debug_locks, ) while retry < MAX_RETRIES: try: - await query_backoff.wait_for_backoff() async with self._connection_properties.session.request( method, url, @@ -207,8 +254,6 @@ async def handle_query_response( timeout=timeout, ) as response: return_value = await handle_query_response(response) - query_backoff.increment_backoff() - retry += 1 if return_value[0] in RECOVERABLE_ERRORS: LOG.info( @@ -226,6 +271,7 @@ async def handle_query_response( continue response.raise_for_status() + failure_reason = ConnectionFailureReason.NO_FAILURE break except ( TimeoutError, @@ -234,24 +280,6 @@ async def handle_query_response( ClientResponseError, ServerDisconnectedError, ) as ex: - if return_value[0] is not None and return_value[3] is not None: - set_retry_after( - return_value[0], - return_value[3], - ) - # _set_retry_after will set the status to one of - # SERVICE_UNAVAILABLE or TOO_MANY_REQUESTS - if self._connection_status.connection_failure_reason in ( - ConnectionFailureReason.SERVICE_UNAVAILABLE, - ConnectionFailureReason.TOO_MANY_REQUESTS, - ): - return 0, None, None - if type(ex) in (ServerDisconnectedError, ClientResponseError): - failure_reason = ConnectionFailureReason.SERVER_ERROR - else: - failure_reason = ConnectionFailureReason.CLIENT_ERROR - self._connection_status.connection_failure_reason = failure_reason - self._connection_status.increment_backoff() LOG.debug( "Error %s occurred making %s request to %s", ex.args, @@ -259,16 +287,14 @@ async def handle_query_response( url, exc_info=True, ) - break - # success, reset statuses - if self._connection_status.connection_failure_reason not in ( - ConnectionFailureReason.ACCOUNT_LOCKED, - ConnectionFailureReason.INVALID_CREDENTIALS, - ConnectionFailureReason.MFA_REQUIRED, - ): - self._connection_status.connection_failure_reason = ( - ConnectionFailureReason.NO_FAILURE - ) + if isinstance(ex, ClientResponseError): + failure_reason = handle_http_errors() + break + failure_reason = await handle_network_errors(ex) + retry += 1 + continue + + update_connection_status() return (return_value[0], return_value[1], return_value[2]) async def query_orb(self, level: int, error_message: str) -> BeautifulSoup | None: diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index d0c7144..e562b69 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -1,6 +1,6 @@ """Test Pulse Query Manager.""" import time -from datetime import datetime +from datetime import datetime, timedelta import pytest @@ -15,42 +15,96 @@ async def test_retry_after(mocked_server_responses, mock_sleep, freeze_time_to_n """Test retry after.""" retry_after_time = 120 + frozen_time = freeze_time_to_now now = time.time() - retry_date = now + float(retry_after_time) - retry_date_str = datetime.fromtimestamp(retry_date).strftime( - "%a, %d %b %Y %H:%M:%S GMT" - ) + s = PulseConnectionStatus() cp = PulseConnectionProperties(DEFAULT_API_HOST) p = PulseQueryManager(s, cp) + s = PulseConnectionStatus() + cp = PulseConnectionProperties(DEFAULT_API_HOST) + p = PulseQueryManager(s, cp) mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=429, headers={"Retry-After": str(retry_after_time)}, ) + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert s.connection_failure_reason == ConnectionFailureReason.TOO_MANY_REQUESTS + assert mock_sleep.call_count == 0 + # make sure we can't override the retry + s.get_backoff().reset_backoff() + assert s.get_backoff().expiration_time == (now + float(retry_after_time)) mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=200, ) + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + assert mock_sleep.call_count == 1 + mock_sleep.assert_called_once_with(float(retry_after_time)) + frozen_time.tick(timedelta(seconds=retry_after_time + 1)) + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + status=200, + ) + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + # shouldn't sleep since past expiration time + assert mock_sleep.call_count == 1 + frozen_time.tick(timedelta(seconds=1)) + now = time.time() + retry_date = now + float(retry_after_time) + retry_date_str = datetime.fromtimestamp(retry_date).strftime( + "%a, %d %b %Y %H:%M:%S GMT" + ) + # need to get the new retry after time since it doesn't have fractions of seconds + new_retry_after = ( + datetime.strptime(retry_date_str, "%a, %d %b %Y %H:%M:%S GMT").timestamp() - now + ) mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=503, headers={"Retry-After": retry_date_str}, ) - - s = PulseConnectionStatus() - cp = PulseConnectionProperties(DEFAULT_API_HOST) - p = PulseQueryManager(s, cp) await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert s.connection_failure_reason == ConnectionFailureReason.TOO_MANY_REQUESTS - assert mock_sleep.call_count == 0 - # make sure we can't override the retry - s.get_backoff().reset_backoff() - assert s.get_backoff().expiration_time == (now + float(retry_after_time)) + assert s.connection_failure_reason == ConnectionFailureReason.SERVICE_UNAVAILABLE + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + status=200, + ) await p.async_query(ADT_ORB_URI, requires_authentication=False) assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE - assert mock_sleep.call_count == 1 - mock_sleep.assert_called_once_with(float(retry_after_time)) + assert mock_sleep.call_count == 2 + assert mock_sleep.call_args_list[1][0][0] == new_retry_after + frozen_time.tick(timedelta(seconds=retry_after_time + 1)) + # unavailable with no retry after + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + status=503, + ) await p.async_query(ADT_ORB_URI, requires_authentication=False) assert s.connection_failure_reason == ConnectionFailureReason.SERVICE_UNAVAILABLE + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + status=200, + ) + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + assert mock_sleep.call_count == 2 + # retry after in the past + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + status=503, + headers={"Retry-After": retry_date_str}, + ) + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert s.connection_failure_reason == ConnectionFailureReason.SERVICE_UNAVAILABLE + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + status=200, + ) + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + assert mock_sleep.call_count == 2 From 915194072e02a4e6b84fc6948c63c6a822e5ad0b Mon Sep 17 00:00:00 2001 From: Robert Lippmann <rlippmann@hotmail.com> Date: Thu, 14 Dec 2023 14:23:58 -0500 Subject: [PATCH 128/226] add html change for zones introduced in pulse v27 --- pyadtpulse/site.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 4d20790..933b06d 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -420,7 +420,8 @@ def update_zone_from_soup(self, soup: BeautifulSoup) -> ADTPulseZones | None: except ValueError: last_update = datetime(1970, 1, 1) # name = row.find("a", {"class": "p_deviceNameText"}).get_text() - temp = row.find("span", {"class": "p_grayNormalText"}) + temp = row.find("div", {"class": "p_grayNormalText"}) + # v26 and lower: temp = row.find("span", {"class": "p_grayNormalText"}) if temp is None: break zone = int( From 99f0be0cd8b7e9b2f4fa78fd3dc8867322a4e3e0 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <rlippmann@hotmail.com> Date: Thu, 14 Dec 2023 16:27:39 -0500 Subject: [PATCH 129/226] pqm exception tests --- tests/test_pulse_query_manager.py | 57 ++++++++++++++++++++++++++++++- 1 file changed, 56 insertions(+), 1 deletion(-) diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index e562b69..1b650d1 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -3,11 +3,12 @@ from datetime import datetime, timedelta import pytest +from aiohttp import client_exceptions from pyadtpulse.const import ADT_ORB_URI, DEFAULT_API_HOST, ConnectionFailureReason from pyadtpulse.pulse_connection_properties import PulseConnectionProperties from pyadtpulse.pulse_connection_status import PulseConnectionStatus -from pyadtpulse.pulse_query_manager import PulseQueryManager +from pyadtpulse.pulse_query_manager import MAX_RETRIES, PulseQueryManager @pytest.mark.asyncio @@ -108,3 +109,57 @@ async def test_retry_after(mocked_server_responses, mock_sleep, freeze_time_to_n await p.async_query(ADT_ORB_URI, requires_authentication=False) assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE assert mock_sleep.call_count == 2 + + +@pytest.mark.asyncio +async def test_async_query_exceptions(mocked_server_responses, mock_sleep): + s = PulseConnectionStatus() + cp = PulseConnectionProperties(DEFAULT_API_HOST) + p = PulseQueryManager(s, cp) + timeout = 2 + curr_sleep_count = 0 + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + exception=client_exceptions.ClientConnectionError(), + ) + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + status=200, + ) + await p.async_query(ADT_ORB_URI, requires_authentication=False, timeout=timeout) + assert mock_sleep.call_count == 1 + assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + assert mock_sleep.call_args_list[0][0][0] == 2.0 + curr_sleep_count += 1 + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + status=200, + ) + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert mock_sleep.call_count == curr_sleep_count + assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + for _ in range(MAX_RETRIES + 1): + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + exception=client_exceptions.ClientConnectionError(), + ) + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + status=200, + ) + await p.async_query(ADT_ORB_URI, requires_authentication=False, timeout=timeout) + for i in range(MAX_RETRIES + 1, curr_sleep_count): + assert mock_sleep.call_count == curr_sleep_count + MAX_RETRIES + assert mock_sleep.call_args_list[i][0][0] == timeout ** (i - curr_sleep_count) + + assert s.connection_failure_reason == ConnectionFailureReason.CLIENT_ERROR + + assert s.get_backoff().backoff_count == 1 + backoff_sleep = s.get_backoff().get_current_backoff_interval() + await p.async_query(ADT_ORB_URI, requires_authentication=False, timeout=timeout) + # pqm backoff should trigger here + curr_sleep_count += MAX_RETRIES + 2 # 1 backoff for query, 1 for connection backoff + assert mock_sleep.call_count == curr_sleep_count + assert mock_sleep.call_args_list[curr_sleep_count - 2][0][0] == backoff_sleep + assert mock_sleep.call_args_list[curr_sleep_count - 1][0][0] == timeout + assert s.get_backoff().backoff_count == 0 From 48bbc54d2db56343d9dffb2ec4a246f78cc77764 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <rlippmann@hotmail.com> Date: Thu, 14 Dec 2023 16:33:26 -0500 Subject: [PATCH 130/226] update pre-commit hooks and refurb fixes --- .pre-commit-config.yaml | 8 ++++---- example-client.py | 2 +- pyadtpulse/pulse_query_manager.py | 2 +- pyadtpulse/pyadtpulse_async.py | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 6f44382..70a7fca 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -10,22 +10,22 @@ repos: - id: pyupgrade args: [--py39-plus] - repo: https://github.com/psf/black - rev: 23.10.0 + rev: 23.12.0 hooks: - id: black args: [--config=pyproject.toml] - repo: https://github.com/hadialqattan/pycln - rev: v2.3.0 + rev: v2.4.0 hooks: - id: pycln args: [--config=pyproject.toml] - repo: https://github.com/pycqa/isort - rev: 5.12.0 + rev: 5.13.2 hooks: - id: isort files: "\\.(py)$" args: [--settings-path=pyproject.toml] - repo: https://github.com/dosisod/refurb - rev: v1.22.1 + rev: v1.25.0 hooks: - id: refurb diff --git a/example-client.py b/example-client.py index d82a5c1..711221c 100755 --- a/example-client.py +++ b/example-client.py @@ -401,7 +401,7 @@ def sync_example( sys.exit() except BaseException as e: print("Received exception logging into ADT Pulse site") - print(f"{e}") + print(str(e)) sys.exit() if not adt.is_connected: diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index 1283108..bee45f4 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -321,7 +321,7 @@ async def async_fetch_version(self) -> None: if self._connection_properties.api_version != ADT_DEFAULT_VERSION: return - signin_url = f"{self._connection_properties.service_host}" + signin_url = self._connection_properties.service_host try: async with self._connection_properties.session.get( signin_url, diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index b183c63..3b835f1 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -435,7 +435,7 @@ async def async_login(self) -> bool: # since we received fresh data on the status of the alarm, go ahead # and update the sites with the alarm status. self._timeout_task = asyncio.create_task( - self._keepalive_task(), name=f"{KEEPALIVE_TASK_NAME}" + self._keepalive_task(), name=KEEPALIVE_TASK_NAME ) await asyncio.sleep(0) return True From 561a8d29be4f1626c01133603d9b2054bcc2d92e Mon Sep 17 00:00:00 2001 From: Robert Lippmann <rlippmann@hotmail.com> Date: Fri, 15 Dec 2023 03:26:15 -0500 Subject: [PATCH 131/226] exception testing and fixes to pqm --- pyadtpulse/pulse_query_manager.py | 19 ++++---- tests/test_pulse_query_manager.py | 80 ++++++++++++++++++++++--------- 2 files changed, 67 insertions(+), 32 deletions(-) diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index bee45f4..1eff8cb 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -8,9 +8,11 @@ from aiohttp import ( ClientConnectionError, ClientConnectorError, + ClientError, ClientResponse, ClientResponseError, - ServerDisconnectedError, + ServerConnectionError, + ServerTimeoutError, ) from bs4 import BeautifulSoup from typeguard import typechecked @@ -185,7 +187,7 @@ def handle_http_errors() -> ConnectionFailureReason: async def handle_network_errors(e: Exception) -> ConnectionFailureReason: failure_reason = ConnectionFailureReason.CLIENT_ERROR - if isinstance(e, ServerDisconnectedError): + if isinstance(e, (ServerConnectionError, ServerTimeoutError)): failure_reason = ConnectionFailureReason.SERVER_ERROR query_backoff.increment_backoff() await query_backoff.wait_for_backoff() @@ -273,12 +275,14 @@ def update_connection_status(): response.raise_for_status() failure_reason = ConnectionFailureReason.NO_FAILURE break + except ClientResponseError: + failure_reason = handle_http_errors() + break except ( - TimeoutError, - ClientConnectionError, ClientConnectorError, - ClientResponseError, - ServerDisconnectedError, + ServerTimeoutError, + ClientError, + ServerConnectionError, ) as ex: LOG.debug( "Error %s occurred making %s request to %s", @@ -287,9 +291,6 @@ def update_connection_status(): url, exc_info=True, ) - if isinstance(ex, ClientResponseError): - failure_reason = handle_http_errors() - break failure_reason = await handle_network_errors(ex) retry += 1 continue diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index 1b650d1..9bcd907 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -116,8 +116,9 @@ async def test_async_query_exceptions(mocked_server_responses, mock_sleep): s = PulseConnectionStatus() cp = PulseConnectionProperties(DEFAULT_API_HOST) p = PulseQueryManager(s, cp) - timeout = 2 + timeout = 3 curr_sleep_count = 0 + # test one exception mocked_server_responses.get( cp.make_url(ADT_ORB_URI), exception=client_exceptions.ClientConnectionError(), @@ -128,9 +129,9 @@ async def test_async_query_exceptions(mocked_server_responses, mock_sleep): ) await p.async_query(ADT_ORB_URI, requires_authentication=False, timeout=timeout) assert mock_sleep.call_count == 1 + curr_sleep_count = mock_sleep.call_count assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE - assert mock_sleep.call_args_list[0][0][0] == 2.0 - curr_sleep_count += 1 + assert mock_sleep.call_args_list[0][0][0] == timeout mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=200, @@ -138,28 +139,61 @@ async def test_async_query_exceptions(mocked_server_responses, mock_sleep): await p.async_query(ADT_ORB_URI, requires_authentication=False) assert mock_sleep.call_count == curr_sleep_count assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE - for _ in range(MAX_RETRIES + 1): + # need to do ClientConnectorError, but it requires initialization + for ex in ( + client_exceptions.ClientConnectionError(), + client_exceptions.ClientError(), + client_exceptions.ClientOSError(), + client_exceptions.ServerDisconnectedError(), + client_exceptions.ServerTimeoutError(), + client_exceptions.ServerConnectionError(), + ): + if type(ex) in ( + client_exceptions.ClientConnectionError, + client_exceptions.ClientError, + client_exceptions.ClientOSError, + ): + error_type = ConnectionFailureReason.CLIENT_ERROR + else: + error_type = ConnectionFailureReason.SERVER_ERROR + for _ in range(MAX_RETRIES + 1): + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + exception=ex, + ) mocked_server_responses.get( cp.make_url(ADT_ORB_URI), - exception=client_exceptions.ClientConnectionError(), + status=200, ) - mocked_server_responses.get( - cp.make_url(ADT_ORB_URI), - status=200, - ) - await p.async_query(ADT_ORB_URI, requires_authentication=False, timeout=timeout) - for i in range(MAX_RETRIES + 1, curr_sleep_count): - assert mock_sleep.call_count == curr_sleep_count + MAX_RETRIES - assert mock_sleep.call_args_list[i][0][0] == timeout ** (i - curr_sleep_count) + await p.async_query(ADT_ORB_URI, requires_authentication=False, timeout=timeout) + assert ( + mock_sleep.call_count == curr_sleep_count + MAX_RETRIES + ), f"Failure on exception {type(ex).__name__}" + for i in range(curr_sleep_count + 1, curr_sleep_count + MAX_RETRIES): + assert mock_sleep.call_args_list[i][0][0] == timeout * ( + 2 ** (i - curr_sleep_count - 1) + ), f"Failure on query {i}, exception {ex}" - assert s.connection_failure_reason == ConnectionFailureReason.CLIENT_ERROR + assert ( + s.connection_failure_reason == error_type + ), f"Error type failure on exception {type(ex).__name__}" - assert s.get_backoff().backoff_count == 1 - backoff_sleep = s.get_backoff().get_current_backoff_interval() - await p.async_query(ADT_ORB_URI, requires_authentication=False, timeout=timeout) - # pqm backoff should trigger here - curr_sleep_count += MAX_RETRIES + 2 # 1 backoff for query, 1 for connection backoff - assert mock_sleep.call_count == curr_sleep_count - assert mock_sleep.call_args_list[curr_sleep_count - 2][0][0] == backoff_sleep - assert mock_sleep.call_args_list[curr_sleep_count - 1][0][0] == timeout - assert s.get_backoff().backoff_count == 0 + assert s.get_backoff().backoff_count == 1 + backoff_sleep = s.get_backoff().get_current_backoff_interval() + await p.async_query(ADT_ORB_URI, requires_authentication=False, timeout=timeout) + # pqm backoff should trigger here + curr_sleep_count += ( + MAX_RETRIES + 2 + ) # 1 backoff for query, 1 for connection backoff + assert mock_sleep.call_count == curr_sleep_count + assert mock_sleep.call_args_list[curr_sleep_count - 2][0][0] == backoff_sleep + assert mock_sleep.call_args_list[curr_sleep_count - 1][0][0] == timeout + assert s.get_backoff().backoff_count == 0 + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + status=200, + ) + assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + # this shouldn't trigger a sleep + await p.async_query(ADT_ORB_URI, requires_authentication=False, timeout=timeout) + assert mock_sleep.call_count == curr_sleep_count From fde65989afee68189e944f48a63c1d32ecab9cb7 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <rlippmann@hotmail.com> Date: Fri, 15 Dec 2023 20:31:44 -0500 Subject: [PATCH 132/226] more pqm tests and fixes --- pyadtpulse/pulse_query_manager.py | 4 +-- tests/test_pulse_query_manager.py | 42 +++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index 1eff8cb..aa15880 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -214,7 +214,7 @@ def update_connection_status(): return if failure_reason == ConnectionFailureReason.NO_FAILURE: self._connection_status.reset_backoff() - elif failure_reason not in RETRY_LATER_CONNECTION_STATUSES: + elif retry == MAX_RETRIES or return_value[0] in RECOVERABLE_ERRORS: self._connection_status.increment_backoff() self._connection_status.connection_failure_reason = failure_reason @@ -263,7 +263,7 @@ def update_connection_status(): "retrying (count = %d)", return_value[0], self._get_http_status_description(return_value[0]), - retry, + retry + 1, ) if retry == MAX_RETRIES: LOG.warning( diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index 9bcd907..b64a789 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -1,9 +1,12 @@ """Test Pulse Query Manager.""" +import logging +import asyncio import time from datetime import datetime, timedelta import pytest from aiohttp import client_exceptions +from bs4 import BeautifulSoup from pyadtpulse.const import ADT_ORB_URI, DEFAULT_API_HOST, ConnectionFailureReason from pyadtpulse.pulse_connection_properties import PulseConnectionProperties @@ -11,6 +14,45 @@ from pyadtpulse.pulse_query_manager import MAX_RETRIES, PulseQueryManager +@pytest.mark.asyncio +async def test_query_orb(mocked_server_responses, read_file, mock_sleep): + """Test query orb. + + We also check that it waits for authenticated flag. + """ + + async def query_orb_task(): + return await p.query_orb(logging.DEBUG, "Failed to query orb") + + s = PulseConnectionStatus() + cp = PulseConnectionProperties(DEFAULT_API_HOST) + p = PulseQueryManager(s, cp) + orb_file = read_file("orb.html") + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), status=200, content_type="text/html", body=orb_file + ) + task = asyncio.create_task(query_orb_task()) + await asyncio.sleep(2) + assert not task.done() + s.authenticated_flag.set() + await task + assert task.done() + assert task.result() == BeautifulSoup(orb_file, "html.parser") + assert mock_sleep.call_count == 1 # from the asyncio.sleep call above + mocked_server_responses.get(cp.make_url(ADT_ORB_URI), status=404) + result = await query_orb_task() + assert result is None + assert mock_sleep.call_count == 1 + assert s.connection_failure_reason == ConnectionFailureReason.SERVER_ERROR + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), status=200, content_type="text/html", body=orb_file + ) + result = await query_orb_task() + assert result == BeautifulSoup(orb_file, "html.parser") + assert mock_sleep.call_count == 1 + assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + + @pytest.mark.asyncio async def test_retry_after(mocked_server_responses, mock_sleep, freeze_time_to_now): """Test retry after.""" From e3e46c005b9ff91411645816880284316ab4052b Mon Sep 17 00:00:00 2001 From: Robert Lippmann <rlippmann@hotmail.com> Date: Fri, 15 Dec 2023 21:35:17 -0500 Subject: [PATCH 133/226] break site properties out from site --- pyadtpulse/site.py | 170 +--------------------------------- pyadtpulse/site_properties.py | 163 ++++++++++++++++++++++++++++++++ 2 files changed, 168 insertions(+), 165 deletions(-) create mode 100644 pyadtpulse/site_properties.py diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 933b06d..70066ce 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -3,24 +3,15 @@ import re from asyncio import Task, create_task, gather, get_event_loop, run_coroutine_threadsafe from datetime import datetime -from threading import RLock from time import time -from warnings import warn from bs4 import BeautifulSoup, ResultSet from typeguard import typechecked -from .alarm_panel import ADTPulseAlarmPanel from .const import ADT_DEVICE_URI, ADT_GATEWAY_STRING, ADT_GATEWAY_URI, ADT_SYSTEM_URI -from .gateway import ADTPulseGateway from .pulse_connection import PulseConnection -from .util import ( - DebugRLock, - make_soup, - parse_pulse_datetime, - remove_prefix, - set_debug_lock, -) +from .site_properties import ADTPulseSiteProperties +from .util import make_soup, parse_pulse_datetime, remove_prefix from .zones import ADTPulseFlattendZone, ADTPulseZones LOG = logging.getLogger(__name__) @@ -29,19 +20,10 @@ SECURITY_PANEL_NAME = "Security Panel" -class ADTPulseSite: +class ADTPulseSite(ADTPulseSiteProperties): """Represents an individual ADT Pulse site.""" - __slots__ = ( - "_pulse_connection", - "_id", - "_name", - "_last_updated", - "_alarm_panel", - "_zones", - "_site_lock", - "_gateway", - ) + __slots__ = ("_pulse_connection",) @typechecked def __init__(self, pulse_connection: PulseConnection, site_id: str, name: str): @@ -53,58 +35,7 @@ def __init__(self, pulse_connection: PulseConnection, site_id: str, name: str): name (str): site name """ self._pulse_connection = pulse_connection - self._id = site_id - self._name = name - self._last_updated: int = 0 - self._zones = ADTPulseZones() - self._site_lock: RLock | DebugRLock - self._site_lock = set_debug_lock( - self._pulse_connection.debug_locks, "pyadtpulse.site_lock" - ) - self._alarm_panel = ADTPulseAlarmPanel() - self._gateway = ADTPulseGateway() - - @property - def id(self) -> str: - """Get site id. - - Returns: - str: the site id - """ - return self._id - - @property - def name(self) -> str: - """Get site name. - - Returns: - str: the site name - """ - return self._name - - # FIXME: should this actually return if the alarm is going off!? How do we - # return state that shows the site is compromised?? - - @property - def last_updated(self) -> int: - """Return time site last updated. - - Returns: - int: the time site last updated as datetime - """ - with self._site_lock: - return self._last_updated - - @property - def site_lock(self) -> "RLock| DebugRLock": - """Get thread lock for site data. - - Not needed for async - - Returns: - RLock: thread RLock - """ - return self._site_lock + super().__init__(site_id, name, pulse_connection.debug_locks) @typechecked def arm_home(self, force_arm: bool = False) -> bool: @@ -142,53 +73,6 @@ async def async_disarm(self) -> bool: """Disarm system async.""" return await self.alarm_control_panel.async_disarm(self._pulse_connection) - @property - def zones(self) -> list[ADTPulseFlattendZone] | None: - """Return all zones registered with the ADT Pulse account. - - (cached copy of last fetch) - See Also fetch_zones() - """ - with self._site_lock: - if not self._zones: - raise RuntimeError("No zones exist") - return self._zones.flatten() - - @property - def zones_as_dict(self) -> ADTPulseZones | None: - """Return zone information in dictionary form. - - Returns: - ADTPulseZones: all zone information - """ - with self._site_lock: - if not self._zones: - raise RuntimeError("No zones exist") - return self._zones - - @property - def alarm_control_panel(self) -> ADTPulseAlarmPanel: - """Return the alarm panel object for the site. - - Returns: - Optional[ADTPulseAlarmPanel]: the alarm panel object - """ - return self._alarm_panel - - @property - def gateway(self) -> ADTPulseGateway: - """Get gateway device object. - - Returns: - ADTPulseGateway: Gateway device - """ - return self._gateway - - @property - def history(self): - """Return log of history for this zone (NOT IMPLEMENTED).""" - raise NotImplementedError - # status_orb = summary_html_soup.find('canvas', {'id': 'ic_orb'}) # if status_orb: # self._status = status_orb['orb'] @@ -508,47 +392,3 @@ def update_zones(self) -> list[ADTPulseFlattendZone] | None: """ coro = self._async_update_zones() return run_coroutine_threadsafe(coro, get_event_loop()).result() - - @property - def updates_may_exist(self) -> bool: - """Query whether updated sensor data exists. - - Deprecated, use method on pyADTPulse object instead - """ - # FIXME: this should actually capture the latest version - # and compare if different!!! - # ...this doesn't actually work if other components are also checking - # if updates exist - warn( - "updates_may_exist on site object is deprecated, " - "use method on pyADTPulse object instead", - DeprecationWarning, - stacklevel=2, - ) - return False - - async def async_update(self) -> bool: - """Force update site/zone data async with current data. - - Deprecated, use method on pyADTPulse object instead - """ - warn( - "updating zones from site object is deprecated, " - "use method on pyADTPulse object instead", - DeprecationWarning, - stacklevel=2, - ) - return False - - def update(self) -> bool: - """Force update site/zones with current data. - - Deprecated, use method on pyADTPulse object instead - """ - warn( - "updating zones from site object is deprecated, " - "use method on pyADTPulse object instead", - DeprecationWarning, - stacklevel=2, - ) - return False diff --git a/pyadtpulse/site_properties.py b/pyadtpulse/site_properties.py new file mode 100644 index 0000000..e747038 --- /dev/null +++ b/pyadtpulse/site_properties.py @@ -0,0 +1,163 @@ +"""Pulse Site Properties.""" +from threading import RLock +from warnings import warn + +from typeguard import typechecked + +from .alarm_panel import ADTPulseAlarmPanel +from .gateway import ADTPulseGateway +from .util import DebugRLock, set_debug_lock +from .zones import ADTPulseFlattendZone, ADTPulseZones + + +class ADTPulseSiteProperties: + """Pulse Site Properties.""" + + __slots__ = ( + "_id", + "_name", + "_last_updated", + "_alarm_panel", + "_zones", + "_site_lock", + "_gateway", + ) + + @typechecked + def __init__(self, site_id: str, name: str, debug_locks: bool = False): + self._id = site_id + self._name = name + self._last_updated: int = 0 + self._zones = ADTPulseZones() + self._site_lock: RLock | DebugRLock + self._site_lock = set_debug_lock(debug_locks, "pyadtpulse.site_property_lock") + self._alarm_panel = ADTPulseAlarmPanel() + self._gateway = ADTPulseGateway() + + @property + def id(self) -> str: + """Get site id. + + Returns: + str: the site id + """ + return self._id + + @property + def name(self) -> str: + """Get site name. + + Returns: + str: the site name + """ + return self._name + + # FIXME: should this actually return if the alarm is going off!? How do we + # return state that shows the site is compromised?? + + @property + def last_updated(self) -> int: + """Return time site last updated. + + Returns: + int: the time site last updated as datetime + """ + with self._site_lock: + return self._last_updated + + @property + def site_lock(self) -> "RLock| DebugRLock": + """Get thread lock for site data. + + Not needed for async + + Returns: + RLock: thread RLock + """ + return self._site_lock + + @property + def zones(self) -> list[ADTPulseFlattendZone] | None: + """Return all zones registered with the ADT Pulse account. + + (cached copy of last fetch) + See Also fetch_zones() + """ + with self._site_lock: + if not self._zones: + raise RuntimeError("No zones exist") + return self._zones.flatten() + + @property + def zones_as_dict(self) -> ADTPulseZones | None: + """Return zone information in dictionary form. + + Returns: + ADTPulseZones: all zone information + """ + with self._site_lock: + if not self._zones: + raise RuntimeError("No zones exist") + return self._zones + + @property + def alarm_control_panel(self) -> ADTPulseAlarmPanel: + """Return the alarm panel object for the site. + + Returns: + Optional[ADTPulseAlarmPanel]: the alarm panel object + """ + return self._alarm_panel + + @property + def gateway(self) -> ADTPulseGateway: + """Get gateway device object. + + Returns: + ADTPulseGateway: Gateway device + """ + return self._gateway + + @property + def updates_may_exist(self) -> bool: + """Query whether updated sensor data exists. + + Deprecated, use method on pyADTPulse object instead + """ + # FIXME: this should actually capture the latest version + # and compare if different!!! + # ...this doesn't actually work if other components are also checking + # if updates exist + warn( + "updates_may_exist on site object is deprecated, " + "use method on pyADTPulse object instead", + DeprecationWarning, + stacklevel=2, + ) + return False + + async def async_update(self) -> bool: + """Force update site/zone data async with current data. + + Deprecated, use method on pyADTPulse object instead + """ + warn( + "updating zones from site object is deprecated, " + "use method on pyADTPulse object instead", + DeprecationWarning, + stacklevel=2, + ) + return False + + def update(self) -> bool: + """Force update site/zones with current data. + + Deprecated, use method on pyADTPulse object instead + """ + warn( + "updating zones from site object is deprecated, " + "use method on pyADTPulse object instead", + DeprecationWarning, + stacklevel=2, + ) + return False From 744b63b2df78af4e2efab2ac309e9e657e4f2b2e Mon Sep 17 00:00:00 2001 From: Robert Lippmann <rlippmann@hotmail.com> Date: Sat, 16 Dec 2023 07:04:00 -0500 Subject: [PATCH 134/226] initial pc tests --- pyadtpulse/pulse_authentication_properties.py | 2 +- pyadtpulse/pulse_connection.py | 20 ++++-------- tests/test_pulse_connection.py | 31 +++++++++++++++++++ 3 files changed, 38 insertions(+), 15 deletions(-) create mode 100644 tests/test_pulse_connection.py diff --git a/pyadtpulse/pulse_authentication_properties.py b/pyadtpulse/pulse_authentication_properties.py index 2cd5b9f..f3eacf2 100644 --- a/pyadtpulse/pulse_authentication_properties.py +++ b/pyadtpulse/pulse_authentication_properties.py @@ -55,7 +55,7 @@ def __init__( username: str, password: str, fingerprint: str, - debug_locks: bool, + debug_locks: bool = False, ) -> None: """Initialize Pulse Authentication Properties.""" self.check_username(username) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index f0b3a6c..29a7a09 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -38,7 +38,6 @@ class PulseConnection(PulseQueryManager): "_pc_attribute_lock", "_authentication_properties", "_login_backoff", - "_debug_locks", "_login_in_progress", ) @@ -67,17 +66,10 @@ def __init__( "Login", pulse_connection_status._backoff.initial_backoff_interval ) self._login_in_progress = False - super().__init__( - pulse_connection_status, - pulse_connection_properties, - debug_locks, - ) self._debug_locks = debug_locks @typechecked - async def async_do_login_query( - self, username: str, password: str, fingerprint: str, timeout: int = 30 - ) -> BeautifulSoup | None: + async def async_do_login_query(self, timeout: int = 30) -> BeautifulSoup | None: """ Performs a login query to the Pulse site. @@ -166,7 +158,7 @@ def check_response( if error: LOG.error( "2FA authentiation required for ADT pulse username %s: %s", - username, + self._authentication_properties.username, error, ) self._connection_status.connection_failure_reason = ( @@ -177,10 +169,10 @@ def check_response( self.login_in_progress = True data = { - "usernameForm": username, - "passwordForm": password, + "usernameForm": self._authentication_properties.username, + "passwordForm": self._authentication_properties.password, "networkid": self._authentication_properties.site_id, - "fingerprint": fingerprint, + "fingerprint": self._authentication_properties.fingerprint, } await self._login_backoff.wait_for_backoff() try: @@ -219,7 +211,7 @@ def check_response( return soup @typechecked - async def async_do_logout_query(self, site_id: str | None) -> None: + async def async_do_logout_query(self, site_id: str | None = None) -> None: """Performs a logout query to the ADT Pulse site.""" params = {} si = "" diff --git a/tests/test_pulse_connection.py b/tests/test_pulse_connection.py new file mode 100644 index 0000000..b7a49b1 --- /dev/null +++ b/tests/test_pulse_connection.py @@ -0,0 +1,31 @@ +"""Test Pulse Connection.""" +import pytest +from bs4 import BeautifulSoup + +from pyadtpulse.const import DEFAULT_API_HOST, ConnectionFailureReason +from pyadtpulse.pulse_authentication_properties import PulseAuthenticationProperties +from pyadtpulse.pulse_connection import PulseConnection +from pyadtpulse.pulse_connection_properties import PulseConnectionProperties +from pyadtpulse.pulse_connection_status import PulseConnectionStatus + + +@pytest.mark.asyncio +async def test_login(mocked_server_responses, get_mocked_url, read_file, mock_sleep): + """Test Pulse Connection.""" + s = PulseConnectionStatus() + pcp = PulseConnectionProperties(DEFAULT_API_HOST) + pa = PulseAuthenticationProperties( + "test@example.com", "testpassword", "testfingerprint" + ) + pc = PulseConnection(s, pcp, pa) + # first call to signin post is successful in conftest.py + result = await pc.async_do_login_query() + assert result == BeautifulSoup(read_file("summary.html"), "html.parser") + assert mock_sleep.call_count == 0 + assert s.authenticated_flag.is_set() + assert pc._login_backoff.backoff_count == 0 + assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + await pc.async_do_logout_query() + assert not s.authenticated_flag.is_set() + assert mock_sleep.call_count == 0 + assert pc._login_backoff.backoff_count == 0 From f0dcb55c6565649c2033564c9ea09904b45151d0 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <rlippmann@hotmail.com> Date: Sat, 16 Dec 2023 07:58:02 -0500 Subject: [PATCH 135/226] remove DEFAULT_API_VERSION --- conftest.py | 37 +++++++-------------- pyadtpulse/const.py | 2 -- pyadtpulse/pulse_connection_properties.py | 3 +- pyadtpulse/pulse_query_manager.py | 39 ++++++++--------------- pyadtpulse/pyadtpulse_async.py | 6 +--- tests/test_pulse_query_manager.py | 35 ++++++++++++++------ 6 files changed, 52 insertions(+), 70 deletions(-) diff --git a/conftest.py b/conftest.py index db1d0c6..10a420b 100644 --- a/conftest.py +++ b/conftest.py @@ -2,7 +2,7 @@ import os import re import sys -from collections.abc import AsyncGenerator, Generator +from collections.abc import Generator from datetime import datetime from pathlib import Path from typing import Any @@ -36,10 +36,11 @@ DEFAULT_API_HOST, ) from pyadtpulse.pulse_connection_properties import PulseConnectionProperties -from pyadtpulse.pulse_connection_status import PulseConnectionStatus -from pyadtpulse.pulse_query_manager import PulseQueryManager from pyadtpulse.util import remove_prefix +MOCKED_API_VERSION = "26.0.0-32" +DEFAULT_SYNC_CHECK = "234532-456432-0" + @pytest.fixture def read_file(): @@ -58,6 +59,7 @@ def _read_file(file_name: str) -> str: @pytest.fixture def mock_sleep(): + """Fixture to mock asyncio.sleep.""" with patch("asyncio.sleep") as m: yield m @@ -70,31 +72,18 @@ def freeze_time_to_now(): yield frozen_time -@pytest.fixture(scope="session") -@pytest.mark.asyncio -async def get_api_version() -> AsyncGenerator[str, Any]: - """Fixture to get the API version.""" - pcp = PulseConnectionProperties(DEFAULT_API_HOST) - pcs = PulseConnectionStatus() - pqm = PulseQueryManager(pcs, pcp) - await pqm.async_fetch_version() - yield pcp.api_version - - -@pytest.fixture(scope="session") -def get_mocked_api_version() -> str: - """Fixture to get the test API version.""" - return "26.0.0-32" - - @pytest.fixture def get_mocked_connection_properties() -> PulseConnectionProperties: """Fixture to get the test connection properties.""" - return PulseConnectionProperties(DEFAULT_API_HOST) + p = PulseConnectionProperties(DEFAULT_API_HOST) + p.api_version = MOCKED_API_VERSION + return p @pytest.fixture def get_mocked_url(get_mocked_connection_properties): + """Fixture to get the test url.""" + def _get_mocked_url(path: str) -> str: return get_mocked_connection_properties.make_url(path) @@ -134,11 +123,6 @@ def extract_ids_from_data_directory() -> list[str]: return list(ids) -@pytest.fixture -def get_default_sync_check() -> str: - return "234532-456432-0" - - @pytest.fixture def mocked_server_responses( get_mocked_mapped_static_responses: dict[str, str], @@ -209,6 +193,7 @@ def patched_sync_task_sleep() -> Generator[AsyncMock, Any, Any]: yield mock +# not using this currently class PulseMockedWebServer: """Mocked Pulse Web Server.""" diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 1ee1032..21a6273 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -60,8 +60,6 @@ ADT_SYSTEM_SETTINGS = "/system/settings.jsp" -ADT_DEFAULT_VERSION = "24.0.0-117" - ADT_HTTP_BACKGROUND_URIS = (ADT_ORB_URI, ADT_SYNC_CHECK_URI) STATE_OK = "OK" STATE_OPEN = "Open" diff --git a/pyadtpulse/pulse_connection_properties.py b/pyadtpulse/pulse_connection_properties.py index 1626a68..54cad01 100644 --- a/pyadtpulse/pulse_connection_properties.py +++ b/pyadtpulse/pulse_connection_properties.py @@ -9,7 +9,6 @@ ADT_DEFAULT_HTTP_ACCEPT_HEADERS, ADT_DEFAULT_HTTP_USER_AGENT, ADT_DEFAULT_SEC_FETCH_HEADERS, - ADT_DEFAULT_VERSION, API_HOST_CA, API_PREFIX, DEFAULT_API_HOST, @@ -78,7 +77,7 @@ def __init__( else: self._session = session self.service_host = host - self._api_version = ADT_DEFAULT_VERSION + self._api_version = "" self._session.headers.update(ADT_DEFAULT_HTTP_ACCEPT_HEADERS) self._session.headers.update(ADT_DEFAULT_SEC_FETCH_HEADERS) self._session.headers.update({"User-Agent": user_agent}) diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index aa15880..65d9f81 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -6,7 +6,6 @@ from time import time from aiohttp import ( - ClientConnectionError, ClientConnectorError, ClientError, ClientResponse, @@ -19,7 +18,6 @@ from yarl import URL from .const import ( - ADT_DEFAULT_VERSION, ADT_HTTP_BACKGROUND_URIS, ADT_ORB_URI, ADT_OTHER_HTTP_ACCEPT_HEADERS, @@ -206,7 +204,7 @@ async def setup_query(): ) await self._connection_status.authenticated_flag.wait() else: - if self._connection_properties.api_version == ADT_DEFAULT_VERSION: + if not self._connection_properties.api_version: await self.async_fetch_version() def update_connection_status(): @@ -316,28 +314,22 @@ async def query_orb(self, level: int, error_message: str) -> BeautifulSoup | Non return make_soup(code, response, url, level, error_message) async def async_fetch_version(self) -> None: - """Fetch ADT Pulse version.""" + """Fetch ADT Pulse version. + + Exceptions are passed through to the caller since if this fails, there is + probably some underlying connection issue. + """ response_path: str | None = None - response_code = HTTPStatus.OK.value - if self._connection_properties.api_version != ADT_DEFAULT_VERSION: + if self._connection_properties.api_version: return signin_url = self._connection_properties.service_host - try: - async with self._connection_properties.session.get( - signin_url, - ) as response: - response_code = response.status - # we only need the headers here, don't parse response - response.raise_for_status() - response_path = response.url.path - except (ClientResponseError, ClientConnectionError): - LOG.warning( - "Error %i: occurred during API version fetch, defaulting to %s", - response_code, - ADT_DEFAULT_VERSION, - ) - return + async with self._connection_properties.session.get( + signin_url, + ) as response: + # we only need the headers here, don't parse response + response.raise_for_status() + response_path = response.url.path version = self._connection_properties.get_api_version(response_path) if version is not None: self._connection_properties.api_version = version @@ -347,8 +339,3 @@ async def async_fetch_version(self) -> None: self._connection_properties.service_host, ) return - - LOG.warning( - "Couldn't auto-detect ADT Pulse version, defaulting to %s", - ADT_DEFAULT_VERSION, - ) diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 3b835f1..cf88cb7 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -416,11 +416,7 @@ async def async_login(self) -> bool: ) await self._pulse_connection.async_fetch_version() - soup = await self._pulse_connection.async_do_login_query( - self._authentication_properties.username, - self._authentication_properties.password, - self._authentication_properties.fingerprint, - ) + soup = await self._pulse_connection.async_do_login_query() if soup is None: return False # if tasks are started, we've already logged in before diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index b64a789..c2b4f89 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -8,6 +8,7 @@ from aiohttp import client_exceptions from bs4 import BeautifulSoup +from conftest import MOCKED_API_VERSION from pyadtpulse.const import ADT_ORB_URI, DEFAULT_API_HOST, ConnectionFailureReason from pyadtpulse.pulse_connection_properties import PulseConnectionProperties from pyadtpulse.pulse_connection_status import PulseConnectionStatus @@ -15,7 +16,19 @@ @pytest.mark.asyncio -async def test_query_orb(mocked_server_responses, read_file, mock_sleep): +async def test_fetch_version(mocked_server_responses): + """Test fetch version.""" + s = PulseConnectionStatus() + cp = PulseConnectionProperties(DEFAULT_API_HOST) + p = PulseQueryManager(s, cp) + await p.async_fetch_version() + assert cp.api_version == MOCKED_API_VERSION + + +@pytest.mark.asyncio +async def test_query_orb( + mocked_server_responses, read_file, mock_sleep, get_mocked_connection_properties +): """Test query orb. We also check that it waits for authenticated flag. @@ -25,7 +38,7 @@ async def query_orb_task(): return await p.query_orb(logging.DEBUG, "Failed to query orb") s = PulseConnectionStatus() - cp = PulseConnectionProperties(DEFAULT_API_HOST) + cp = get_mocked_connection_properties p = PulseQueryManager(s, cp) orb_file = read_file("orb.html") mocked_server_responses.get( @@ -54,7 +67,12 @@ async def query_orb_task(): @pytest.mark.asyncio -async def test_retry_after(mocked_server_responses, mock_sleep, freeze_time_to_now): +async def test_retry_after( + mocked_server_responses, + mock_sleep, + freeze_time_to_now, + get_mocked_connection_properties, +): """Test retry after.""" retry_after_time = 120 @@ -62,12 +80,9 @@ async def test_retry_after(mocked_server_responses, mock_sleep, freeze_time_to_n now = time.time() s = PulseConnectionStatus() - cp = PulseConnectionProperties(DEFAULT_API_HOST) + cp = get_mocked_connection_properties p = PulseQueryManager(s, cp) - s = PulseConnectionStatus() - cp = PulseConnectionProperties(DEFAULT_API_HOST) - p = PulseQueryManager(s, cp) mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=429, @@ -154,9 +169,11 @@ async def test_retry_after(mocked_server_responses, mock_sleep, freeze_time_to_n @pytest.mark.asyncio -async def test_async_query_exceptions(mocked_server_responses, mock_sleep): +async def test_async_query_exceptions( + mocked_server_responses, mock_sleep, get_mocked_connection_properties +): s = PulseConnectionStatus() - cp = PulseConnectionProperties(DEFAULT_API_HOST) + cp = get_mocked_connection_properties p = PulseQueryManager(s, cp) timeout = 3 curr_sleep_count = 0 From 378222db63e1ba32c6babd5199e75049b7126ade Mon Sep 17 00:00:00 2001 From: Robert Lippmann <rlippmann@hotmail.com> Date: Sat, 16 Dec 2023 08:50:13 -0500 Subject: [PATCH 136/226] add pqm test version fail --- conftest.py | 15 ++++++++++++++- pyadtpulse/pulse_query_manager.py | 4 ++++ tests/test_pulse_query_manager.py | 12 ++++++++++++ 3 files changed, 30 insertions(+), 1 deletion(-) diff --git a/conftest.py b/conftest.py index 10a420b..7f0f234 100644 --- a/conftest.py +++ b/conftest.py @@ -11,7 +11,7 @@ import freezegun import pytest -from aiohttp import web +from aiohttp import client_exceptions, web from aioresponses import aioresponses # Get the root directory of your project @@ -80,6 +80,19 @@ def get_mocked_connection_properties() -> PulseConnectionProperties: return p +@pytest.fixture +def mock_server_down(): + """Fixture to mock server down.""" + with aioresponses() as m: + m.get( + DEFAULT_API_HOST, + status=500, + exception=client_exceptions.ServerConnectionError(), + repeat=True, + ) + yield m + + @pytest.fixture def get_mocked_url(get_mocked_connection_properties): """Fixture to get the test url.""" diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index 65d9f81..938bf15 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -206,6 +206,10 @@ async def setup_query(): else: if not self._connection_properties.api_version: await self.async_fetch_version() + if not self._connection_properties.api_version: + raise ValueError( + "Could not determine API version for connection" + ) def update_connection_status(): if failure_reason not in CHANGEABLE_CONNECTION_STATUSES: diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index c2b4f89..f9dca01 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -25,6 +25,18 @@ async def test_fetch_version(mocked_server_responses): assert cp.api_version == MOCKED_API_VERSION +@pytest.mark.asyncio +async def test_fetch_version_fail(mock_server_down): + """Test fetch version.""" + s = PulseConnectionStatus() + cp = PulseConnectionProperties(DEFAULT_API_HOST) + p = PulseQueryManager(s, cp) + with pytest.raises(client_exceptions.ServerConnectionError): + await p.async_fetch_version() + with pytest.raises(client_exceptions.ServerConnectionError): + await p.async_query(ADT_ORB_URI, requires_authentication=False) + + @pytest.mark.asyncio async def test_query_orb( mocked_server_responses, read_file, mock_sleep, get_mocked_connection_properties From f1d895a08a1a8eb373b0f665beab48e507962e8b Mon Sep 17 00:00:00 2001 From: Robert Lippmann <rlippmann@hotmail.com> Date: Sat, 16 Dec 2023 08:59:02 -0500 Subject: [PATCH 137/226] add check of api version string --- pyadtpulse/pulse_connection_properties.py | 27 ++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/pyadtpulse/pulse_connection_properties.py b/pyadtpulse/pulse_connection_properties.py index 54cad01..d0976a9 100644 --- a/pyadtpulse/pulse_connection_properties.py +++ b/pyadtpulse/pulse_connection_properties.py @@ -100,7 +100,11 @@ def service_host(self) -> str: @service_host.setter @typechecked def service_host(self, host: str): - """Set the service host.""" + """Set the service host. + + Raises: + ValueError if host is not valid. + """ self.check_service_host(host) with self._pci_attribute_lock: self._api_host = host @@ -181,7 +185,28 @@ def api_version(self) -> str: @api_version.setter @typechecked def api_version(self, version: str): + """Set the API version. + + Raises: + ValueError: if version is not in the form major.minor.patch-subpatch + """ + + def check_version_string(value: str): + parts = value.split("-") + if len(parts) == 2: + version_parts = parts[0].split(".") + if len(version_parts) == 3 and version_parts[0].isdigit(): + major_version = int(version_parts[0]) + if major_version >= 26: + return + else: + raise ValueError("API version is numeric but less than 26") + raise ValueError( + "API version must be in the form major.minor.patch-subpatch" + ) + with self._pci_attribute_lock: + check_version_string(version) self._api_version = version @typechecked From 238223214c7dfba86811853ae69bbb810ac79ff2 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <rlippmann@hotmail.com> Date: Sat, 16 Dec 2023 19:18:50 -0500 Subject: [PATCH 138/226] more pc tests and fixes --- conftest.py | 39 ++++- pyadtpulse/pulse_connection.py | 10 +- pyadtpulse/pulse_query_manager.py | 250 ++++++++++++++++++------------ tests/test_pulse_async.py | 7 - tests/test_pulse_connection.py | 103 +++++++++++- tests/test_pulse_query_manager.py | 80 +++++++--- 6 files changed, 347 insertions(+), 142 deletions(-) diff --git a/conftest.py b/conftest.py index 7f0f234..18ca9e9 100644 --- a/conftest.py +++ b/conftest.py @@ -93,6 +93,40 @@ def mock_server_down(): yield m +@pytest.fixture +def mock_server_temporarily_down(get_mocked_url, read_file): + """Fixture to mock server temporarily down.""" + with aioresponses() as responses: + responses.get( + DEFAULT_API_HOST, + status=500, + exception=client_exceptions.ServerConnectionError(), + ) + responses.get( + DEFAULT_API_HOST, + status=500, + exception=client_exceptions.ServerConnectionError(), + ) + responses.get( + DEFAULT_API_HOST, + status=302, + headers={"Location": get_mocked_url(ADT_LOGIN_URI)}, + ) + responses.get( + f"{DEFAULT_API_HOST}/{ADT_LOGIN_URI}", + status=307, + headers={"Location": get_mocked_url(ADT_LOGIN_URI)}, + repeat=True, + ) + responses.get( + get_mocked_url(ADT_LOGIN_URI), + body=read_file("signin.html"), + content_type="text/html", + ) + + yield responses + + @pytest.fixture def get_mocked_url(get_mocked_connection_properties): """Fixture to get the test url.""" @@ -185,8 +219,11 @@ def mocked_server_responses( "Location": get_mocked_url(ADT_SUMMARY_URI), }, ) + logout_pattern = re.compile( + rf"{re.escape(get_mocked_url(ADT_LOGOUT_URI))}/?.*$" + ) responses.get( - get_mocked_url(ADT_LOGOUT_URI), + logout_pattern, status=302, headers={"Location": get_mocked_url(ADT_LOGIN_URI)}, repeat=True, diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 29a7a09..f2208a3 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -152,6 +152,7 @@ def check_response( self._connection_status.connection_failure_reason = ( ConnectionFailureReason.INVALID_CREDENTIALS ) + self._login_backoff.increment_backoff() return None error = soup.find("div", "responsiveContainer") @@ -164,6 +165,7 @@ def check_response( self._connection_status.connection_failure_reason = ( ConnectionFailureReason.MFA_REQUIRED ) + self._login_backoff.increment_backoff() return None return soup @@ -187,17 +189,15 @@ def check_response( response[0], response[2], logging.ERROR, - "Error encountered during ADT login GET", + "Error encountered during ADT login POST", ): + # FIXME: should we let the query manager handle the backoff? self._login_backoff.increment_backoff() self.login_in_progress = False return None except Exception as e: # pylint: disable=broad-except LOG.error("Could not log into Pulse site: %s", e) - self._connection_status.connection_failure_reason = ( - ConnectionFailureReason.UNKNOWN - ) - self._login_backoff.increment_backoff() + # the query manager will handle the backoff self.login_in_progress = False return None soup = check_response(response) diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index 938bf15..847f69c 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -6,6 +6,7 @@ from time import time from aiohttp import ( + ClientConnectionError, ClientConnectorError, ClientError, ClientResponse, @@ -88,6 +89,103 @@ def __init__( self._connection_properties = connection_properties self._debug_locks = debug_locks + @staticmethod + @typechecked + async def _handle_query_response( + response: ClientResponse | None, + ) -> tuple[int, str | None, URL | None, str | None]: + if response is None: + return 0, None, None, None + response_text = await response.text() + + return ( + response.status, + response_text, + response.url, + response.headers.get("Retry-After"), + ) + + @typechecked + def _set_retry_after(self, code: int, retry_after: str) -> None: + """ + Check the "Retry-After" header in the response and set retry_after property + based upon it. + + Will also set the connection status failure reason and rety after + properties. + + Parameters: + code (int): The HTTP response code + retry_after (str): The value of the "Retry-After" header + + Returns: + None. + """ + now = time() + if retry_after.isnumeric(): + retval = float(retry_after) + else: + try: + retval = datetime.strptime( + retry_after, "%a, %d %b %Y %H:%M:%S %Z" + ).timestamp() + retval -= now + except ValueError: + return + description = self._get_http_status_description(code) + LOG.warning( + "Task %s received Retry-After %s due to %s", + current_task(), + retval, + description, + ) + # don't set the retry_after if it is in the past + if retval > 0: + self._connection_status.retry_after = now + retval + + @typechecked + def _handle_http_errors( + self, return_value: tuple[int, str | None, URL | None, str | None] + ) -> None: + failure_reason = ConnectionFailureReason.SERVER_ERROR + if return_value[0] is not None and return_value[3] is not None: + self._set_retry_after( + return_value[0], + return_value[3], + ) + if return_value[0] == HTTPStatus.TOO_MANY_REQUESTS: + failure_reason = ConnectionFailureReason.TOO_MANY_REQUESTS + if return_value[0] == HTTPStatus.SERVICE_UNAVAILABLE: + failure_reason = ConnectionFailureReason.SERVICE_UNAVAILABLE + self._update_connection_status(failure_reason) + + @typechecked + def _handle_network_errors(self, e: Exception) -> ConnectionFailureReason: + if isinstance(e, (ServerConnectionError, ServerTimeoutError)): + return ConnectionFailureReason.SERVER_ERROR + if ( + isinstance(e, (ClientConnectionError)) + and "Connection refused" in str(e) + or ("timed out") in str(e) + ): + return ConnectionFailureReason.SERVER_ERROR + return ConnectionFailureReason.CLIENT_ERROR + + def _update_connection_status( + self, failure_reason: ConnectionFailureReason + ) -> None: + """Update connection status. + + Will also increment or reset the backoff. + """ + if failure_reason not in CHANGEABLE_CONNECTION_STATUSES: + return + if failure_reason == ConnectionFailureReason.NO_FAILURE: + self._connection_status.reset_backoff() + elif failure_reason not in (RETRY_LATER_CONNECTION_STATUSES): + self._connection_status.increment_backoff() + self._connection_status.connection_failure_reason = failure_reason + @typechecked async def async_query( self, @@ -120,77 +218,6 @@ async def async_query( response """ - def set_retry_after(code: int, retry_after: str) -> None: - """ - Check the "Retry-After" header in the response and set retry_after property - based upon it. - - Will also set the connection status failure reason and rety after - properties. - - Parameters: - code (int): The HTTP response code - retry_after (str): The value of the "Retry-After" header - - Returns: - None. - """ - now = time() - if retry_after.isnumeric(): - retval = float(retry_after) - else: - try: - retval = datetime.strptime( - retry_after, "%a, %d %b %Y %H:%M:%S %Z" - ).timestamp() - retval -= now - except ValueError: - return - description = self._get_http_status_description(code) - LOG.warning( - "Task %s received Retry-After %s due to %s", - current_task(), - retval, - description, - ) - # don't set the retry_after if it is in the past - if retval > 0: - self._connection_status.retry_after = now + retval - - async def handle_query_response( - response: ClientResponse | None, - ) -> tuple[int, str | None, URL | None, str | None]: - if response is None: - return 0, None, None, None - response_text = await response.text() - - return ( - response.status, - response_text, - response.url, - response.headers.get("Retry-After"), - ) - - def handle_http_errors() -> ConnectionFailureReason: - if return_value[0] is not None and return_value[3] is not None: - set_retry_after( - return_value[0], - return_value[3], - ) - if return_value[0] == HTTPStatus.TOO_MANY_REQUESTS: - return ConnectionFailureReason.TOO_MANY_REQUESTS - if return_value[0] == HTTPStatus.SERVICE_UNAVAILABLE: - return ConnectionFailureReason.SERVICE_UNAVAILABLE - return ConnectionFailureReason.SERVER_ERROR - - async def handle_network_errors(e: Exception) -> ConnectionFailureReason: - failure_reason = ConnectionFailureReason.CLIENT_ERROR - if isinstance(e, (ServerConnectionError, ServerTimeoutError)): - failure_reason = ConnectionFailureReason.SERVER_ERROR - query_backoff.increment_backoff() - await query_backoff.wait_for_backoff() - return failure_reason - async def setup_query(): if method not in ("GET", "POST"): raise ValueError("method must be GET or POST") @@ -211,15 +238,6 @@ async def setup_query(): "Could not determine API version for connection" ) - def update_connection_status(): - if failure_reason not in CHANGEABLE_CONNECTION_STATUSES: - return - if failure_reason == ConnectionFailureReason.NO_FAILURE: - self._connection_status.reset_backoff() - elif retry == MAX_RETRIES or return_value[0] in RECOVERABLE_ERRORS: - self._connection_status.increment_backoff() - self._connection_status.connection_failure_reason = failure_reason - await setup_query() url = self._connection_properties.make_url(uri) headers = extra_headers if extra_headers is not None else {} @@ -240,15 +258,18 @@ def update_connection_status(): None, None, ) - failure_reason = ConnectionFailureReason.NO_FAILURE query_backoff = PulseBackoff( f"Query:{method} {uri}", - timeout, + self._connection_status.get_backoff().initial_backoff_interval, threshold=1, debug_locks=self._debug_locks, ) + failure_reason = ConnectionFailureReason.NO_FAILURE while retry < MAX_RETRIES: try: + await query_backoff.wait_for_backoff() + retry += 1 + query_backoff.increment_backoff() async with self._connection_properties.session.request( method, url, @@ -257,15 +278,14 @@ def update_connection_status(): data=extra_params if method == "POST" else None, timeout=timeout, ) as response: - return_value = await handle_query_response(response) - + return_value = await self._handle_query_response(response) if return_value[0] in RECOVERABLE_ERRORS: LOG.info( "query returned recoverable error code %s: %s," "retrying (count = %d)", return_value[0], self._get_http_status_description(return_value[0]), - retry + 1, + retry, ) if retry == MAX_RETRIES: LOG.warning( @@ -273,13 +293,12 @@ def update_connection_status(): ) response.raise_for_status() continue - response.raise_for_status() failure_reason = ConnectionFailureReason.NO_FAILURE break except ClientResponseError: - failure_reason = handle_http_errors() - break + self._handle_http_errors(return_value) + return (return_value[0], return_value[1], return_value[2]) except ( ClientConnectorError, ServerTimeoutError, @@ -293,11 +312,12 @@ def update_connection_status(): url, exc_info=True, ) - failure_reason = await handle_network_errors(ex) - retry += 1 + failure_reason = self._handle_network_errors(ex) continue - update_connection_status() + if failure_reason != ConnectionFailureReason.NO_FAILURE: + LOG.debug("Exceeded max retries of %d, giving up", MAX_RETRIES) + self._update_connection_status(failure_reason) return (return_value[0], return_value[1], return_value[2]) async def query_orb(self, level: int, error_message: str) -> BeautifulSoup | None: @@ -323,18 +343,45 @@ async def async_fetch_version(self) -> None: Exceptions are passed through to the caller since if this fails, there is probably some underlying connection issue. """ - response_path: str | None = None + response_values: tuple[int, str | None, URL | None, str | None] = ( + HTTPStatus.OK.value, + None, + None, + None, + ) if self._connection_properties.api_version: return signin_url = self._connection_properties.service_host - async with self._connection_properties.session.get( - signin_url, - ) as response: - # we only need the headers here, don't parse response - response.raise_for_status() - response_path = response.url.path - version = self._connection_properties.get_api_version(response_path) + try: + async with self._connection_properties.session.get( + signin_url, + ) as response: + response_values = await self._handle_query_response(response) + response.raise_for_status() + + except ClientResponseError as ex: + LOG.debug( + "Error %s occurred determining Pulse API version", + ex.args, + exc_info=True, + ) + self._handle_http_errors(response_values) + return + except ( + ClientConnectorError, + ServerTimeoutError, + ClientError, + ServerConnectionError, + ) as ex: + LOG.debug( + "Error %s occurred determining Pulse API version", + ex.args, + exc_info=True, + ) + self._update_connection_status(self._handle_network_errors(ex)) + return + version = self._connection_properties.get_api_version(str(response_values[2])) if version is not None: self._connection_properties.api_version = version LOG.debug( @@ -342,4 +389,9 @@ async def async_fetch_version(self) -> None: self._connection_properties.api_version, self._connection_properties.service_host, ) + if ( + self._connection_status.connection_failure_reason + != ConnectionFailureReason.NO_FAILURE + ): + self._update_connection_status(ConnectionFailureReason.NO_FAILURE) return diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index 92b378e..4bc2a7b 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -188,13 +188,6 @@ async def test_wait_for_update(m, adt_pulse_instance): assert m.call_count == 1 -@pytest.mark.asyncio -# @patch.object( -# PyADTPulseAsync, -# "wait_for_update", -# side_effect=PyADTPulseAsync.wait_for_update, -# autospec=True, -# ) async def test_orb_update( mocked_server_responses, get_mocked_url, read_file, get_default_sync_check ): diff --git a/tests/test_pulse_connection.py b/tests/test_pulse_connection.py index b7a49b1..d018500 100644 --- a/tests/test_pulse_connection.py +++ b/tests/test_pulse_connection.py @@ -2,30 +2,119 @@ import pytest from bs4 import BeautifulSoup -from pyadtpulse.const import DEFAULT_API_HOST, ConnectionFailureReason +from pyadtpulse.const import ( + ADT_LOGIN_URI, + ADT_SUMMARY_URI, + DEFAULT_API_HOST, + ConnectionFailureReason, +) from pyadtpulse.pulse_authentication_properties import PulseAuthenticationProperties from pyadtpulse.pulse_connection import PulseConnection from pyadtpulse.pulse_connection_properties import PulseConnectionProperties from pyadtpulse.pulse_connection_status import PulseConnectionStatus +from pyadtpulse.pulse_query_manager import MAX_RETRIES -@pytest.mark.asyncio -async def test_login(mocked_server_responses, get_mocked_url, read_file, mock_sleep): - """Test Pulse Connection.""" +def setup_pulse_connection() -> PulseConnection: s = PulseConnectionStatus() pcp = PulseConnectionProperties(DEFAULT_API_HOST) pa = PulseAuthenticationProperties( "test@example.com", "testpassword", "testfingerprint" ) pc = PulseConnection(s, pcp, pa) + return pc + + +@pytest.mark.asyncio +async def test_login(mocked_server_responses, get_mocked_url, read_file, mock_sleep): + """Test Pulse Connection.""" + pc = setup_pulse_connection() # first call to signin post is successful in conftest.py result = await pc.async_do_login_query() assert result == BeautifulSoup(read_file("summary.html"), "html.parser") assert mock_sleep.call_count == 0 - assert s.authenticated_flag.is_set() + assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 - assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + assert pc._connection_status.authenticated_flag.is_set() + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.NO_FAILURE + ) await pc.async_do_logout_query() - assert not s.authenticated_flag.is_set() + assert not pc._connection_status.authenticated_flag.is_set() assert mock_sleep.call_count == 0 assert pc._login_backoff.backoff_count == 0 + + +@pytest.mark.asyncio +async def test_login_failure_server_down(mock_server_down): + pc = setup_pulse_connection() + result = await pc.async_do_login_query() + assert result is None + assert pc.login_in_progress is False + assert pc._login_backoff.backoff_count == 0 + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.SERVER_ERROR + ) + + +@pytest.mark.asyncio +async def test_multiple_login( + mocked_server_responses, get_mocked_url, read_file, mock_sleep +): + """Test Pulse Connection.""" + pc = setup_pulse_connection() + # first call to signin post is successful in conftest.py + result = await pc.async_do_login_query() + assert result == BeautifulSoup(read_file("summary.html"), "html.parser") + assert mock_sleep.call_count == 0 + assert pc.login_in_progress is False + assert pc._login_backoff.backoff_count == 0 + assert pc._connection_status.authenticated_flag.is_set() + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.NO_FAILURE + ) + mocked_server_responses.post( + get_mocked_url(ADT_LOGIN_URI), + status=302, + headers={ + "Location": get_mocked_url(ADT_SUMMARY_URI), + }, + ) + await pc.async_do_login_query() + assert mock_sleep.call_count == 0 + assert pc.login_in_progress is False + assert pc._login_backoff.backoff_count == 0 + assert pc._connection_status.authenticated_flag.is_set() + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.NO_FAILURE + ) + # this should fail + await pc.async_do_login_query() + assert mock_sleep.call_count == MAX_RETRIES - 1 + assert pc.login_in_progress is False + assert pc._login_backoff.backoff_count == 0 + assert pc._connection_status.get_backoff().backoff_count == 1 + assert pc._connection_status.authenticated_flag.is_set() + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.SERVER_ERROR + ) + + +@pytest.mark.asyncio +async def test_account_lockout( + mocked_server_responses, mock_sleep, get_mocked_url, freeze_time_to_now, read_file +): + pc = setup_pulse_connection() + # do initial login + await pc.async_do_login_query() + assert mock_sleep.call_count == 0 + assert pc.login_in_progress is False + assert pc._login_backoff.backoff_count == 0 + mocked_server_responses.post( + get_mocked_url(ADT_LOGIN_URI), 200, read_file("summary.html") + ) diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index f9dca01..3fd4a77 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -31,10 +31,33 @@ async def test_fetch_version_fail(mock_server_down): s = PulseConnectionStatus() cp = PulseConnectionProperties(DEFAULT_API_HOST) p = PulseQueryManager(s, cp) - with pytest.raises(client_exceptions.ServerConnectionError): - await p.async_fetch_version() - with pytest.raises(client_exceptions.ServerConnectionError): + await p.async_fetch_version() + assert s.connection_failure_reason == ConnectionFailureReason.SERVER_ERROR + assert s.get_backoff().backoff_count == 1 + with pytest.raises(ValueError): await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert s.connection_failure_reason == ConnectionFailureReason.SERVER_ERROR + assert s.get_backoff().backoff_count == 2 + assert s.get_backoff().get_current_backoff_interval() == 2.0 + + +@pytest.mark.asyncio +async def test_fetch_version_eventually_succeeds(mock_server_temporarily_down): + """Test fetch version.""" + s = PulseConnectionStatus() + cp = PulseConnectionProperties(DEFAULT_API_HOST) + p = PulseQueryManager(s, cp) + await p.async_fetch_version() + assert s.connection_failure_reason == ConnectionFailureReason.SERVER_ERROR + assert s.get_backoff().backoff_count == 1 + with pytest.raises(ValueError): + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert s.connection_failure_reason == ConnectionFailureReason.SERVER_ERROR + assert s.get_backoff().backoff_count == 2 + assert s.get_backoff().get_current_backoff_interval() == 2.0 + await p.async_fetch_version() + assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + assert s.get_backoff().backoff_count == 0 @pytest.mark.asyncio @@ -69,12 +92,13 @@ async def query_orb_task(): assert result is None assert mock_sleep.call_count == 1 assert s.connection_failure_reason == ConnectionFailureReason.SERVER_ERROR + assert s.get_backoff().backoff_count == 1 mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=200, content_type="text/html", body=orb_file ) result = await query_orb_task() assert result == BeautifulSoup(orb_file, "html.parser") - assert mock_sleep.call_count == 1 + assert mock_sleep.call_count == 2 assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE @@ -187,8 +211,6 @@ async def test_async_query_exceptions( s = PulseConnectionStatus() cp = get_mocked_connection_properties p = PulseQueryManager(s, cp) - timeout = 3 - curr_sleep_count = 0 # test one exception mocked_server_responses.get( cp.make_url(ADT_ORB_URI), @@ -198,18 +220,23 @@ async def test_async_query_exceptions( cp.make_url(ADT_ORB_URI), status=200, ) - await p.async_query(ADT_ORB_URI, requires_authentication=False, timeout=timeout) + await p.async_query(ADT_ORB_URI, requires_authentication=False) assert mock_sleep.call_count == 1 curr_sleep_count = mock_sleep.call_count + assert ( + mock_sleep.call_args_list[0][0][0] == s.get_backoff().initial_backoff_interval + ) assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE - assert mock_sleep.call_args_list[0][0][0] == timeout + assert s.get_backoff().backoff_count == 0 mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=200, ) await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert mock_sleep.call_count == curr_sleep_count + assert mock_sleep.call_count == 1 assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE + assert s.get_backoff().backoff_count == 0 + query_backoff = s.get_backoff().initial_backoff_interval # need to do ClientConnectorError, but it requires initialization for ex in ( client_exceptions.ClientConnectionError(), @@ -236,29 +263,36 @@ async def test_async_query_exceptions( cp.make_url(ADT_ORB_URI), status=200, ) - await p.async_query(ADT_ORB_URI, requires_authentication=False, timeout=timeout) + result = await p.async_query( + ADT_ORB_URI, + requires_authentication=False, + ) + assert not result[1] + # only MAX_RETRIES - 1 sleeps since first call won't sleep assert ( - mock_sleep.call_count == curr_sleep_count + MAX_RETRIES + mock_sleep.call_count == curr_sleep_count + MAX_RETRIES - 1 ), f"Failure on exception {type(ex).__name__}" - for i in range(curr_sleep_count + 1, curr_sleep_count + MAX_RETRIES): - assert mock_sleep.call_args_list[i][0][0] == timeout * ( - 2 ** (i - curr_sleep_count - 1) - ), f"Failure on query {i}, exception {ex}" - + assert mock_sleep.call_args_list[curr_sleep_count][0][0] == query_backoff + for i in range(curr_sleep_count + 2, curr_sleep_count + MAX_RETRIES - 1): + assert mock_sleep.call_args_list[i][0][0] == query_backoff * 2 ** ( + i - curr_sleep_count + ), f"Failure on exception sleep count {i} on exception {type(ex).__name__}" + curr_sleep_count += MAX_RETRIES - 1 assert ( s.connection_failure_reason == error_type ), f"Error type failure on exception {type(ex).__name__}" - assert s.get_backoff().backoff_count == 1 + assert ( + s.get_backoff().backoff_count == 1 + ), f"Failure on exception {type(ex).__name__}" backoff_sleep = s.get_backoff().get_current_backoff_interval() - await p.async_query(ADT_ORB_URI, requires_authentication=False, timeout=timeout) + await p.async_query(ADT_ORB_URI, requires_authentication=False) # pqm backoff should trigger here - curr_sleep_count += ( - MAX_RETRIES + 2 - ) # 1 backoff for query, 1 for connection backoff + curr_sleep_count += 2 + # 1 backoff for query, 1 for connection backoff assert mock_sleep.call_count == curr_sleep_count assert mock_sleep.call_args_list[curr_sleep_count - 2][0][0] == backoff_sleep - assert mock_sleep.call_args_list[curr_sleep_count - 1][0][0] == timeout + assert mock_sleep.call_args_list[curr_sleep_count - 1][0][0] == backoff_sleep assert s.get_backoff().backoff_count == 0 mocked_server_responses.get( cp.make_url(ADT_ORB_URI), @@ -266,5 +300,5 @@ async def test_async_query_exceptions( ) assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE # this shouldn't trigger a sleep - await p.async_query(ADT_ORB_URI, requires_authentication=False, timeout=timeout) + await p.async_query(ADT_ORB_URI, requires_authentication=False) assert mock_sleep.call_count == curr_sleep_count From af642d90e8e13a56f029035547d42430159cb068 Mon Sep 17 00:00:00 2001 From: Robert Lippmann <rlippmann@hotmail.com> Date: Sat, 16 Dec 2023 19:48:25 -0500 Subject: [PATCH 139/226] updates for pulse v27 --- conftest.py | 2 +- tests/data_files/device_1.html | 217 ++++++++-------- tests/data_files/device_10.html | 217 ++++++++-------- tests/data_files/device_11.html | 217 ++++++++-------- tests/data_files/device_16.html | 217 ++++++++-------- tests/data_files/device_2.html | 217 ++++++++-------- tests/data_files/device_24.html | 217 ++++++++-------- tests/data_files/device_25.html | 217 ++++++++-------- tests/data_files/device_26.html | 217 ++++++++-------- tests/data_files/device_27.html | 217 ++++++++-------- tests/data_files/device_28.html | 217 ++++++++-------- tests/data_files/device_29.html | 219 ++++++++-------- tests/data_files/device_3.html | 217 ++++++++-------- tests/data_files/device_30.html | 217 ++++++++-------- tests/data_files/device_34.html | 217 ++++++++-------- tests/data_files/device_69.html | 217 ++++++++-------- tests/data_files/device_70.html | 217 ++++++++-------- tests/data_files/gateway.html | 212 +++++++-------- tests/data_files/mfa.html | 150 +++++++++++ tests/data_files/orb.html | 311 +++++++++++----------- tests/data_files/orb_garage.html | 311 +++++++++++----------- tests/data_files/orb_patio_garage.html | 311 +++++++++++----------- tests/data_files/orb_patio_opened.html | 311 +++++++++++----------- tests/data_files/signin.html | 83 +++--- tests/data_files/signin_fail.html | 176 +++++++++++++ tests/data_files/signin_locked.html | 176 +++++++++++++ tests/data_files/summary.html | 342 +++++++++++++----------- tests/data_files/system.html | 345 +++++++++++++------------ 28 files changed, 3543 insertions(+), 2661 deletions(-) create mode 100644 tests/data_files/mfa.html create mode 100644 tests/data_files/signin_fail.html create mode 100644 tests/data_files/signin_locked.html diff --git a/conftest.py b/conftest.py index 18ca9e9..0e5b487 100644 --- a/conftest.py +++ b/conftest.py @@ -38,7 +38,7 @@ from pyadtpulse.pulse_connection_properties import PulseConnectionProperties from pyadtpulse.util import remove_prefix -MOCKED_API_VERSION = "26.0.0-32" +MOCKED_API_VERSION = "27.0.0-140" DEFAULT_SYNC_CHECK = "234532-456432-0" diff --git a/tests/data_files/device_1.html b/tests/data_files/device_1.html index ea104a3..f248389 100644 --- a/tests/data_files/device_1.html +++ b/tests/data_files/device_1.html @@ -6,10 +6,16 @@ +<script type="text/javascript"> + function handleOnLoad() { + setSkipMainContentTarget('#mainSystem'); + } -<script type="text/javascript" src="/myhome/26.0.0-32/icjs/js-general_en_US.js"></script> -<script type="text/javascript" src="/myhome/26.0.0-32/icjs/js-system_en_US.js"></script> + window.addEventListener("load", handleOnLoad); +</script> +<script type="text/javascript" src="/myhome/27.0.0-140/icjs/js-general_en_US.js"></script> +<script type="text/javascript" src="/myhome/27.0.0-140/icjs/js-system_en_US.js"></script> @@ -19,34 +25,35 @@ -<html id="CHROME" class="v119"> + +<html id="CHROME" class="v121" lang="en-US"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <meta name="viewport" content="width=device-width, maximum-scale=1.0, user-scalable=no"/> - <script type="text/javascript" src="/myhome/ruxitagentjs_ICA27NVfhjqrux_10277231024135831.js" data-dtconfig="app=2e9fa82c268e1763|featureHash=ICA27NVfhjqrux|vcv=2|rdnt=1|uxrgce=1|bp=3|cuc=9nbkmfqd|mel=100000|dpvc=1|md=mdcc1=ahead ^rb script:nth-child(4),mdcc2=a#header-container ^rb div.p_headerShim ^rb div ^rb div.p_headerWelcomeStyle ^rb span:nth-child(1) ^rb a,mdcc3=cX-token,mdcc4=a#fp,mdcc5=a#signin,mdcc6=cX-login|ssv=4|lastModification=1698925510705|mdp=mdcc3|tp=500,50,0,1|agentUri=/myhome/ruxitagentjs_ICA27NVfhjqrux_10277231024135831.js|reportUrl=/myhome/rb_bf89193cya|rid=RID_-1173568415|rpid=-701430166|domain=adtpulse.com"></script><link rel="stylesheet" type="text/css" href="/myhome/26.0.0-32/styles/portal.css" /> - <link rel="stylesheet" type="text/css" href="/z/branding/adt/26.0.0/styles/portalCustomizable.css" /> - <script type="text/javascript" src="/myhome/26.0.0-32/icjs/general.js"></script> + <script type="text/javascript" src="/myhome/ruxitagentjs_ICA27NVfhjqrux_10279231130031246.js" data-dtconfig="app=2e9fa82c268e1763|featureHash=ICA27NVfhjqrux|vcv=2|rdnt=1|uxrgce=1|bp=3|cuc=9nbkmfqd|mel=100000|dpvc=1|md=mdcc1=ahead ^rb script:nth-child(4),mdcc2=a#header-container ^rb div.p_headerShim ^rb div ^rb div.p_headerWelcomeStyle ^rb span:nth-child(1) ^rb a,mdcc3=cX-token,mdcc4=a#fp,mdcc5=a#signin,mdcc6=cX-login|ssv=4|lastModification=1701906297633|mdp=mdcc3|tp=500,50,0,1|agentUri=/myhome/ruxitagentjs_ICA27NVfhjqrux_10279231130031246.js|reportUrl=/myhome/rb_bf89193cya|rid=RID_-1498070126|rpid=-1822114540|domain=adtpulse.com"></script><link rel="stylesheet" type="text/css" href="/myhome/27.0.0-140/styles/portal.css" /> + <link rel="stylesheet" type="text/css" href="/z/branding/adt/27.0.0/styles/portalCustomizable.css" /> + <script type="text/javascript" src="/myhome/27.0.0-140/icjs/general.js"></script> <script type="text/javascript">g.domain="portal.adtpulse.com";</script> - <script type="text/javascript">g.contextPath="/myhome/26.0.0-32";</script> + <script type="text/javascript">g.contextPath="/myhome/27.0.0-140";</script> <script type="text/javascript">if (typeof mfaSigninInProgress !== 'undefined') { g.isSessionTimeoutAllowed = false; } else { g.isSessionTimeoutAllowed = true }</script> - <script type="text/javascript">g.webApplicationContext="/myhome/26.0.0-32";</script> - <script type="text/javascript">var globalSAToken='e5201512-cda3-4e3e-bf5c-7eaaaa669fe1';</script> - <script type="text/javascript" src="/myhome/26.0.0-32/icjs/device.js"></script> - <script type="text/javascript" src="/myhome/26.0.0-32/icjs/ajaxRest.js"></script> - <script type="text/javascript" src="/myhome/26.0.0-32/icjs/system.js"></script> - <script type="text/javascript" src="/myhome/26.0.0-32/icjs/wholeHome.js"></script> - - <script type="text/javascript" src="/myhome/26.0.0-32/appcmn/ic_helper/ic_helper.js"></script> - <script type="text/javascript" src="/myhome/26.0.0-32/icjs/icRRA.js"></script> - <script type="text/javascript" src="/myhome/26.0.0-32/icjs/icDialog.js"></script> - <script type="text/javascript" src="/myhome/26.0.0-32/icjs/base64.js"></script> - <script type="text/javascript" src="/myhome/26.0.0-32/icjs/ajaxUpdate.js"></script> - <script type="text/javascript" src="/myhome/26.0.0-32/appcmn/ic_icon_devices/ic_icon_devices.js"></script> - <script type="text/javascript" src="/z/branding/adt/26.0.0/appcmn/ic_icon_devices/ic_draw_icon_devices.js"></script> - <script type="text/javascript" src="/myhome/26.0.0-32/appcmn/ic_icon_symbols/ic_icon_symbols.js"></script> - <script type="text/javascript" src="/z/branding/adt/26.0.0/appcmn/ic_icon_symbols/ic_draw_icon_symbols.js"></script> - <script type="text/javascript" src="/myhome/26.0.0-32/appcmn/ic_orb/ic_orb.js"></script> - <script type="text/javascript" src="/z/branding/adt/26.0.0/appcmn/ic_orb/ic_draw_orb.js"></script> + <script type="text/javascript">g.webApplicationContext="/myhome/27.0.0-140";</script> + <script type="text/javascript">var globalSAToken='73eafe76-85c8-419f-bbb9-05d0155837eb';</script> + <script type="text/javascript" src="/myhome/27.0.0-140/icjs/device.js"></script> + <script type="text/javascript" src="/myhome/27.0.0-140/icjs/ajaxRest.js"></script> + <script type="text/javascript" src="/myhome/27.0.0-140/icjs/system.js"></script> + <script type="text/javascript" src="/myhome/27.0.0-140/icjs/wholeHome.js"></script> + + <script type="text/javascript" src="/myhome/27.0.0-140/appcmn/ic_helper/ic_helper.js"></script> + <script type="text/javascript" src="/myhome/27.0.0-140/icjs/icRRA.js"></script> + <script type="text/javascript" src="/myhome/27.0.0-140/icjs/icDialog.js"></script> + <script type="text/javascript" src="/myhome/27.0.0-140/icjs/base64.js"></script> + <script type="text/javascript" src="/myhome/27.0.0-140/icjs/ajaxUpdate.js"></script> + <script type="text/javascript" src="/myhome/27.0.0-140/appcmn/ic_icon_devices/ic_icon_devices.js"></script> + <script type="text/javascript" src="/z/branding/adt/27.0.0/appcmn/ic_icon_devices/ic_draw_icon_devices.js"></script> + <script type="text/javascript" src="/myhome/27.0.0-140/appcmn/ic_icon_symbols/ic_icon_symbols.js"></script> + <script type="text/javascript" src="/z/branding/adt/27.0.0/appcmn/ic_icon_symbols/ic_draw_icon_symbols.js"></script> + <script type="text/javascript" src="/myhome/27.0.0-140/appcmn/ic_orb/ic_orb.js"></script> + <script type="text/javascript" src="/z/branding/adt/27.0.0/appcmn/ic_orb/ic_draw_orb.js"></script> <script type="text/javascript">function updateContent(){ } </script> @@ -54,94 +61,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -156,7 +169,7 @@
- + System @@ -170,11 +183,12 @@ -
+
-
+ +
- +
- - - - + + + + - + -
Security Panel

Security Panel
+
- +
@@ -250,7 +264,7 @@ -
+
@@ -371,7 +385,7 @@
-
OK
+
OK
@@ -395,32 +409,34 @@
- + + + + - + diff --git a/tests/data_files/device_10.html b/tests/data_files/device_10.html index 2c9e74e..a1ad892 100644 --- a/tests/data_files/device_10.html +++ b/tests/data_files/device_10.html @@ -6,10 +6,16 @@ + - + window.addEventListener("load", handleOnLoad); + + + @@ -19,34 +25,35 @@ - + + - - - + + + - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + @@ -54,94 +61,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -156,7 +169,7 @@
- + System @@ -170,11 +183,12 @@ -
+
-
+ +
- +
- - - - + + + + - + -
Basement Smoke

Basement Smoke
+
- +
@@ -250,7 +264,7 @@ -
+
@@ -348,7 +362,7 @@
-
OK
+
OK
@@ -372,32 +386,34 @@
- + + + + - + diff --git a/tests/data_files/device_11.html b/tests/data_files/device_11.html index db41a0e..ba700c6 100644 --- a/tests/data_files/device_11.html +++ b/tests/data_files/device_11.html @@ -6,10 +6,16 @@ + - + window.addEventListener("load", handleOnLoad); + + + @@ -19,34 +25,35 @@ - + + - - - + + + - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + @@ -54,94 +61,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -156,7 +169,7 @@
- + System @@ -170,11 +183,12 @@ -
+
-
+ +
- +
- - - - + + + + - + -
2nd Floor Smoke

2nd Floor Smoke
+
- +
@@ -250,7 +264,7 @@ -
+
@@ -348,7 +362,7 @@
-
OK
+
OK
@@ -372,32 +386,34 @@
- + + + + - + diff --git a/tests/data_files/device_16.html b/tests/data_files/device_16.html index 9c295ae..2d9be60 100644 --- a/tests/data_files/device_16.html +++ b/tests/data_files/device_16.html @@ -6,10 +6,16 @@ + - + window.addEventListener("load", handleOnLoad); + + + @@ -19,34 +25,35 @@ - + + - - - + + + - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + @@ -54,94 +61,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -156,7 +169,7 @@
- + System @@ -170,11 +183,12 @@ -
+
-
+ +
- +
- - - - + + + + - + -
Main Gas

Main Gas
+
- +
@@ -250,7 +264,7 @@ -
+
@@ -348,7 +362,7 @@
-
OK
+
OK
@@ -372,32 +386,34 @@
- + + + + - + diff --git a/tests/data_files/device_2.html b/tests/data_files/device_2.html index 79bc6a5..ca7507d 100644 --- a/tests/data_files/device_2.html +++ b/tests/data_files/device_2.html @@ -6,10 +6,16 @@ + - + window.addEventListener("load", handleOnLoad); + + + @@ -19,34 +25,35 @@ - + + - - - + + + - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + @@ -54,94 +61,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -156,7 +169,7 @@
- + System @@ -170,11 +183,12 @@ -
+
-
+ +
- +
- - - - + + + + - + -
Front Door

Front Door
+
- +
@@ -250,7 +264,7 @@ -
+
@@ -348,7 +362,7 @@
-
OK
+
OK
@@ -372,32 +386,34 @@
- + + + + - + diff --git a/tests/data_files/device_24.html b/tests/data_files/device_24.html index fdca079..52085d6 100644 --- a/tests/data_files/device_24.html +++ b/tests/data_files/device_24.html @@ -6,10 +6,16 @@ + - + window.addEventListener("load", handleOnLoad); + + + @@ -19,34 +25,35 @@ - + + - - - + + + - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + @@ -54,94 +61,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -156,7 +169,7 @@
- + System @@ -170,11 +183,12 @@ -
+
-
+ +
- +
- - - - + + + + - + -
keyfob

keyfob
+
- +
@@ -250,7 +264,7 @@ -
+
@@ -366,7 +380,7 @@
-
OK
+
OK
@@ -390,32 +404,34 @@
- + + + + - + diff --git a/tests/data_files/device_25.html b/tests/data_files/device_25.html index a038607..deb9552 100644 --- a/tests/data_files/device_25.html +++ b/tests/data_files/device_25.html @@ -6,10 +6,16 @@ + - + window.addEventListener("load", handleOnLoad); + + + @@ -19,34 +25,35 @@ - + + - - - + + + - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + @@ -54,94 +61,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -156,7 +169,7 @@
- + System @@ -170,11 +183,12 @@ -
+
-
+ +
- +
- - - - + + + + - + -
Patio Door

Patio Door
+
- +
@@ -250,7 +264,7 @@ -
+
@@ -348,7 +362,7 @@
-
OK
+
OK
@@ -372,32 +386,34 @@
- + + + + - + diff --git a/tests/data_files/device_26.html b/tests/data_files/device_26.html index c6b21a5..3b4393a 100644 --- a/tests/data_files/device_26.html +++ b/tests/data_files/device_26.html @@ -6,10 +6,16 @@ + - + window.addEventListener("load", handleOnLoad); + + + @@ -19,34 +25,35 @@ - + + - - - + + + - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + @@ -54,94 +61,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -156,7 +169,7 @@
- + System @@ -170,11 +183,12 @@ -
+
-
+ +
- +
- - - - + + + + - + -
Basement Door

Basement Door
+
- +
@@ -250,7 +264,7 @@ -
+
@@ -348,7 +362,7 @@
-
OK
+
OK
@@ -372,32 +386,34 @@
- + + + + - + diff --git a/tests/data_files/device_27.html b/tests/data_files/device_27.html index d3148f1..cac9597 100644 --- a/tests/data_files/device_27.html +++ b/tests/data_files/device_27.html @@ -6,10 +6,16 @@ + - + window.addEventListener("load", handleOnLoad); + + + @@ -19,34 +25,35 @@ - + + - - - + + + - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + @@ -54,94 +61,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -156,7 +169,7 @@
- + System @@ -170,11 +183,12 @@ -
+
-
+ +
- +
- - - - + + + + - + -
Back Door

Back Door
+
- +
@@ -250,7 +264,7 @@ -
+
@@ -348,7 +362,7 @@
-
OK
+
OK
@@ -372,32 +386,34 @@
- + + + + - + diff --git a/tests/data_files/device_28.html b/tests/data_files/device_28.html index 4816a4f..8a02013 100644 --- a/tests/data_files/device_28.html +++ b/tests/data_files/device_28.html @@ -6,10 +6,16 @@ + - + window.addEventListener("load", handleOnLoad); + + + @@ -19,34 +25,35 @@ - + + - - - + + + - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + @@ -54,94 +61,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -156,7 +169,7 @@
- + System @@ -170,11 +183,12 @@ -
+
-
+ +
- +
- - - - + + + + - + -
Foyer Motion

Foyer Motion
+
- +
@@ -250,7 +264,7 @@ -
+
@@ -348,7 +362,7 @@
-
OK
+
OK
@@ -372,32 +386,34 @@
- + + + + - + diff --git a/tests/data_files/device_29.html b/tests/data_files/device_29.html index f8f0fb2..2ba6fd7 100644 --- a/tests/data_files/device_29.html +++ b/tests/data_files/device_29.html @@ -6,10 +6,16 @@ + - + window.addEventListener("load", handleOnLoad); + + + @@ -19,34 +25,35 @@ - + + - - - + + + - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + @@ -54,94 +61,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -156,7 +169,7 @@
- + System @@ -170,11 +183,12 @@ -
+
-
+ +
- +
- - - - + + + + - + - @@ -348,7 +362,7 @@
-
OK
+
OK
@@ -372,32 +386,34 @@
Living Room Door

Living Room Door
+
- +
@@ -250,7 +264,7 @@ -
+
@@ -332,7 +346,7 @@
- +
- + + + + - + diff --git a/tests/data_files/device_3.html b/tests/data_files/device_3.html index 5592028..f4da4b7 100644 --- a/tests/data_files/device_3.html +++ b/tests/data_files/device_3.html @@ -6,10 +6,16 @@ + - + window.addEventListener("load", handleOnLoad); + + + @@ -19,34 +25,35 @@ - + + - - - + + + - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + @@ -54,94 +61,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -156,7 +169,7 @@
- + System @@ -170,11 +183,12 @@ -
+
-
+ +
- +
- - - - + + + + - + -
Garage Door

Garage Door
+
- +
@@ -250,7 +264,7 @@ -
+
@@ -348,7 +362,7 @@
-
OK
+
OK
@@ -372,32 +386,34 @@
- + + + + - + diff --git a/tests/data_files/device_30.html b/tests/data_files/device_30.html index 2a782f9..c178404 100644 --- a/tests/data_files/device_30.html +++ b/tests/data_files/device_30.html @@ -6,10 +6,16 @@ + - + window.addEventListener("load", handleOnLoad); + + + @@ -19,34 +25,35 @@ - + + - - - + + + - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + @@ -54,94 +61,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -156,7 +169,7 @@
- + System @@ -170,11 +183,12 @@ -
+
-
+ +
- +
- - - - + + + + - + -
Family Glass Break

Family Glass Break
+
- +
@@ -250,7 +264,7 @@ -
+
@@ -348,7 +362,7 @@
-
OK
+
OK
@@ -372,32 +386,34 @@
- + + + + - + diff --git a/tests/data_files/device_34.html b/tests/data_files/device_34.html index 216fb8a..d5ffb17 100644 --- a/tests/data_files/device_34.html +++ b/tests/data_files/device_34.html @@ -6,10 +6,16 @@ + - + window.addEventListener("load", handleOnLoad); + + + @@ -19,34 +25,35 @@ - + + - - - + + + - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + @@ -54,94 +61,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -156,7 +169,7 @@
- + System @@ -170,11 +183,12 @@ -
+
-
+ +
- +
- - - - + + + + - + -
Camera

Camera
+
- +
@@ -250,7 +264,7 @@ -
+
@@ -354,7 +368,7 @@
-
OK
+
OK
@@ -378,32 +392,34 @@
- + + + + - + diff --git a/tests/data_files/device_69.html b/tests/data_files/device_69.html index 3f3474f..95f2122 100644 --- a/tests/data_files/device_69.html +++ b/tests/data_files/device_69.html @@ -6,10 +6,16 @@ + - + window.addEventListener("load", handleOnLoad); + + + @@ -19,34 +25,35 @@ - + + - - - + + + - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + @@ -54,94 +61,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -156,7 +169,7 @@
- + System @@ -170,11 +183,12 @@ -
+
-
+ +
- +
- - - - + + + + - + -
Radio Station Smoke

Radio Station Smoke
+
- +
@@ -250,7 +264,7 @@ -
+
@@ -348,7 +362,7 @@
-
OK
+
OK
@@ -372,32 +386,34 @@
- + + + + - + diff --git a/tests/data_files/device_70.html b/tests/data_files/device_70.html index c288b68..68f5766 100644 --- a/tests/data_files/device_70.html +++ b/tests/data_files/device_70.html @@ -6,10 +6,16 @@ + - + window.addEventListener("load", handleOnLoad); + + + @@ -19,34 +25,35 @@ - + + - - - + + + - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + @@ -54,94 +61,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -156,7 +169,7 @@
- + System @@ -170,11 +183,12 @@ -
+
-
+ +
- +
- - - - + + + + - + -
Radio Station Gas

Radio Station Gas
+
- +
@@ -250,7 +264,7 @@ -
+
@@ -348,7 +362,7 @@
-
OK
+
OK
@@ -372,32 +386,34 @@
- + + + + - + diff --git a/tests/data_files/gateway.html b/tests/data_files/gateway.html index af4f425..a85f6d8 100644 --- a/tests/data_files/gateway.html +++ b/tests/data_files/gateway.html @@ -7,8 +7,8 @@ - - + + @@ -18,32 +18,32 @@ - + - - - + + + - + - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + @@ -51,94 +51,100 @@ ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -153,7 +159,7 @@
- + System @@ -166,11 +172,12 @@ -
+
+
-
+
- - - - + + + + - + - - +
Gateway

Gateway
+
- +
@@ -246,7 +253,7 @@ - - - + + @@ -283,9 +290,9 @@ - + - + @@ -307,7 +314,7 @@
-
OK
+
OK
@@ -330,32 +337,34 @@
+ @@ -269,8 +276,8 @@
Model:PGZNG1
Serial Number:5U020CN3007E3
Next Update:Today 10:06 PM
Last Update:Today 4:06 PM
Next Update:Today 1:21 AM
Last Update:Today 7:21 PM
Firmware Version:24.0.0-9
Hardware Version:HW=3, BL=1.1.9b, PL=9.4.0.32.5, SKU=PGZNG1-2ADNAS
 
Network Address Information
Broadband LAN IP Address:192.168.1.31
Broadband LAN MAC:02:1a:3e:4b:6c:8f
Broadband LAN MAC:a4:11:62:35:07:96
Device LAN IP Address:192.168.107.1
Device LAN MAC:0a:bc:2e:5d:7f:9a
Device LAN MAC:a4:11:62:35:07:97
Router LAN IP Address:192.168.1.1
Router WAN IP Address:
- + + + + - + diff --git a/tests/data_files/mfa.html b/tests/data_files/mfa.html new file mode 100644 index 0000000..5087001 --- /dev/null +++ b/tests/data_files/mfa.html @@ -0,0 +1,150 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - Multi-factor Authentication + + + + + +
+
+
+
+
+ + + + + + + + + + + + +
+
+ + + + + +
+ + + +
+
+
+ + + diff --git a/tests/data_files/orb.html b/tests/data_files/orb.html index 3347e92..57c808d 100644 --- a/tests/data_files/orb.html +++ b/tests/data_files/orb.html @@ -1,10 +1,11 @@ -
- Security -
+

+ Security + +

-
- +
+
Sign In
+
+
Sign In

Forgot your username or password?

Forgot your username or password?
@@ -130,20 +131,22 @@ - + - ADT Security Services - | Privacy Policy - | ADT Pulse Terms of Use - | Customer Support + + - diff --git a/tests/data_files/signin_fail.html b/tests/data_files/signin_fail.html new file mode 100644 index 0000000..d7b52a4 --- /dev/null +++ b/tests/data_files/signin_fail.html @@ -0,0 +1,176 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - Sign In + + + + + +
+
+
+
+
+ + + + + + + + + + + + +
+
+ +
+
+
+ +
+

Please Sign In

+ +

+ + + + + + + + + + + + + + + + +
+ +

+
+ + + + + + + + + + + + + + + + + +

Password:
 
+
+
Sign In
+

Forgot your username or password?

+ + +
+ +
+


+ Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement. © 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution. +
+ + +
+
+ +
+
+
+ + + + + diff --git a/tests/data_files/signin_locked.html b/tests/data_files/signin_locked.html new file mode 100644 index 0000000..027079f --- /dev/null +++ b/tests/data_files/signin_locked.html @@ -0,0 +1,176 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - Sign In + + + + + +
+
+
+
+
+ + + + + + + + + + + + +
+
+ +
+
+
+ +
+

Please Sign In

+ +

+ + + + + + + + + + + + + + + + +
+ +

+
+ + + + + + + + + + + + + + + + + +

Password:
 
+
+
Sign In
+

Forgot your username or password?

+ + +
+ +
+


+ Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement. © 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution. +
+ + +
+
+ +
+
+
+ + + + + diff --git a/tests/data_files/summary.html b/tests/data_files/summary.html index 645993c..e61e087 100644 --- a/tests/data_files/summary.html +++ b/tests/data_files/summary.html @@ -10,10 +10,10 @@ - + - + @@ -22,38 +22,38 @@ - + - - - + + + - + - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -167,9 +173,11 @@
- - -
+
+

ADT Pulse Home

+ + +
@@ -181,18 +189,23 @@ -
- Security -
+ + +

+ + Security + +

-
-
Downstairs
+
+
Downstairs
- + @@ -210,32 +223,32 @@
-
Arm Away
Arm Stay
+
Arm Away
Arm Stay
- Disarmed. All Quiet. + Disarmed. All Quiet.
- -
-
- - - - - - - - - - - - - - +
2nd Floor Smoke  Zone 18Okay 
Back Door  Zone 14Closed 
Basement Door  Zone 13Closed 
Basement Smoke  Zone 17Okay 
Family Glass Break  Zone 16Okay 
Foyer Motion  Zone 15No Motion 
Front Door  Zone 9Closed 
Garage Door  Zone 10Closed 
Living Room Door  Zone 12Closed 
Main Gas  Zone 23Okay 
Patio Door  Zone 11Closed 
Radio Station Gas  Zone 24Okay 
Radio Station Smoke  Zone 22Okay 
+
+
+ + + + + + + + + + + + + +
2nd Floor Smoke 
Zone 18
Okay 
Back Door 
Zone 14
Closed 
Basement Door 
Zone 13
Closed 
Basement Smoke 
Zone 17
Okay 
Family Glass Break 
Zone 16
Okay 
Foyer Motion 
Zone 15
No Motion 
Front Door 
Zone 9
Closed 
Garage Door 
Zone 10
Closed 
Living Room Door 
Zone 12
Closed 
Main Gas 
Zone 23
Okay 
Patio Door 
Zone 11
Closed 
Radio Station Gas 
Zone 24
Okay 
Radio Station Smoke 
Zone 22
Okay 
@@ -253,11 +266,11 @@
- +
- Other Devices +

Other Devices

@@ -272,13 +285,13 @@ - -
+ + - - +
- - - - +
 No other devices installed.
 
 
+ + +
 No other devices installed.
@@ -290,11 +303,11 @@
- +
- Notable Events +

Notable Events



 Loading...  @@ -302,27 +315,27 @@
- +
+
- +
- -
- + - Cameras +

+ Cameras - +

+
@@ -335,9 +348,9 @@
-
Camera
+
Camera
-Actions +Live Video & camera actions
@@ -346,7 +359,7 @@
diff --git a/tests/data_files/system.html b/tests/data_files/system.html index 92c5626..736f9e5 100644 --- a/tests/data_files/system.html +++ b/tests/data_files/system.html @@ -20,130 +20,136 @@ - + - - - + + + - + - - + + - - - - - - - - - - - + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - System - Robert Lippmann + - + + +  +
-
-
-
- Welcome, Development - -  |  - - - Sign Out - -
-
-
- Wednesday, Nov 15 - -  |  - - - Sign Out - -
+
+
+
+ -
+ -
+ +
-
-
-
-
- +
-
+ +
-
+
@@ -158,7 +164,7 @@
- + System @@ -171,12 +177,13 @@ -
-
- + +
+
+ +

Devices

+ + +
+
@@ -229,9 +241,10 @@ -
-
- + +
@@ -243,196 +256,196 @@ - - - - + + + + - + -
+ - - + +
  Name ZoneName Zone Device Type
- -
-
- - -
 System
+
+
+
+ + + -

 System

- + - +
Security PanelSecurity Panel    ADT: Security Panel - Safewatch Pro 3000/3000CNADT: Security Panel - Safewatch Pro 3000/3000CN
+ - - -
- + - +
GatewayGateway    ADT Pulse Gateway: PGZNG1ADT Pulse Gateway: PGZNG1
 
 Sensors
+ + + -
 

 Sensors

- + - +
2nd Floor Smoke2nd Floor Smoke 18  Fire (Smoke/Heat) DetectorFire (Smoke/Heat) Detector
+ -
- + - +
Back DoorBack Door 14  Door/Window SensorDoor/Window Sensor
+ -
- + - +
Basement DoorBasement Door 13  Door/Window SensorDoor/Window Sensor
+ -
- + - +
Basement SmokeBasement Smoke 17  Fire (Smoke/Heat) DetectorFire (Smoke/Heat) Detector
+ -
- + - +
Family Glass BreakFamily Glass Break 16  Glass Break DetectorGlass Break Detector
+ -
- + - +
Foyer MotionFoyer Motion 15  Motion SensorMotion Sensor
+ -
- + - +
Front DoorFront Door 9  Door/Window SensorDoor/Window Sensor
+ -
- + - +
Garage DoorGarage Door 10  Door/Window SensorDoor/Window Sensor
+ -
- + - +
Living Room DoorLiving Room Door 12  Door/Window SensorDoor/Window Sensor
+ -
- + - +
Main GasMain Gas 23  Carbon Monoxide DetectorCarbon Monoxide Detector
+ -
- + - +
Patio DoorPatio Door 11  Door/Window SensorDoor/Window Sensor
+ -
- + - +
Radio Station GasRadio Station Gas 24  Carbon Monoxide DetectorCarbon Monoxide Detector
+ - - -
- + - +
Radio Station SmokeRadio Station Smoke 22  Fire (Smoke/Heat) DetectorFire (Smoke/Heat) Detector
 
 Remotes
+ + + - - -
 

 Remotes

- + - +
keyfobkeyfob    Wireless RemoteWireless Remote
 
 Cameras
+ + +
 

 Cameras

- + - +
CameraCamera    ADT: RC8325-ADT Indoor/Night HD CameraADT: RC8325-ADT Indoor/Night HD Camera
@@ -460,33 +473,42 @@ - - + + + + + + + From 7c546e6c57043b695fe748803236bc602326d481 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 17 Dec 2023 00:48:30 -0500 Subject: [PATCH 140/226] pc tests and fixes --- pyadtpulse/pulse_connection.py | 36 +++++--- tests/test_pulse_connection.py | 149 ++++++++++++++++++++++++++++++++- 2 files changed, 171 insertions(+), 14 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index f2208a3..eddfa2f 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -92,9 +92,9 @@ async def async_do_login_query(self, timeout: int = 30) -> BeautifulSoup | None: def extract_seconds_from_string(s: str) -> int: seconds = 0 - match = re.search(r"Try again in (\d+)", s) + match = re.search(r"\d+", s) if match: - seconds = int(match.group(1)) + seconds = int(match.group()) if "minutes" in s: seconds *= 60 return seconds @@ -131,12 +131,22 @@ def check_response( if error: error_text = error.get_text() LOG.error("Error logging into pulse: %s", error_text) - if retry_after := extract_seconds_from_string(error_text) > 0: - self._login_backoff.set_absolute_backoff_time(time() + retry_after) - self._connection_status.connection_failure_reason = ( - ConnectionFailureReason.ACCOUNT_LOCKED - ) - return None + if "Try again in" in error_text: + if (retry_after := extract_seconds_from_string(error_text)) > 0: + self._login_backoff.set_absolute_backoff_time( + time() + retry_after + ) + self._connection_status.connection_failure_reason = ( + ConnectionFailureReason.ACCOUNT_LOCKED + ) + return None + else: + # FIXME: not sure if this is true + self._connection_status.connection_failure_reason = ( + ConnectionFailureReason.INVALID_CREDENTIALS + ) + self._login_backoff.increment_backoff() + return None url = self._connection_properties.make_url(ADT_SUMMARY_URI) if url != str(response[2]): # more specifically: @@ -144,6 +154,7 @@ def check_response( # redirect to mfaSignin.jsp = fingerprint error # locked out = error == "Sign In unsuccessful. Your account has been # locked after multiple sign in attempts.Try again in 30 minutes." + LOG.error( "Authentication error encountered logging into ADT Pulse" " at location %s", @@ -154,7 +165,6 @@ def check_response( ) self._login_backoff.increment_backoff() return None - error = soup.find("div", "responsiveContainer") if error: LOG.error( @@ -169,6 +179,9 @@ def check_response( return None return soup + if self.login_in_progress: + return None + self._connection_status.authenticated_flag.clear() self.login_in_progress = True data = { "usernameForm": self._authentication_properties.username, @@ -232,10 +245,7 @@ async def async_do_logout_query(self, site_id: str | None = None) -> None: @property def is_connected(self) -> bool: """Check if ADT Pulse is connected.""" - return ( - self._connection_status.authenticated_flag.is_set() - and self._connection_status.retry_after < int(time()) - ) + return self._connection_status.authenticated_flag.is_set() def check_sync(self, message: str) -> AbstractEventLoop: """Convenience method to check if running from sync context.""" diff --git a/tests/test_pulse_connection.py b/tests/test_pulse_connection.py index d018500..7a9eaf6 100644 --- a/tests/test_pulse_connection.py +++ b/tests/test_pulse_connection.py @@ -1,4 +1,7 @@ """Test Pulse Connection.""" +import asyncio +import datetime + import pytest from bs4 import BeautifulSoup @@ -116,5 +119,149 @@ async def test_account_lockout( assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 mocked_server_responses.post( - get_mocked_url(ADT_LOGIN_URI), 200, read_file("summary.html") + get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("signin_locked.html") + ) + await pc.async_do_login_query() + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.ACCOUNT_LOCKED + ) + assert pc._login_backoff.backoff_count == 0 + assert mock_sleep.call_count == 0 + mocked_server_responses.post( + get_mocked_url(ADT_LOGIN_URI), + status=302, + headers={ + "Location": get_mocked_url(ADT_SUMMARY_URI), + }, + ) + await pc.async_do_login_query() + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.NO_FAILURE + ) + assert mock_sleep.call_count == 1 + assert mock_sleep.call_args_list[0][0][0] == 60 * 30 + freeze_time_to_now.tick(delta=datetime.timedelta(seconds=60 * 30 + 1)) + mocked_server_responses.post( + get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("signin_locked.html") + ) + await pc.async_do_login_query() + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.ACCOUNT_LOCKED + ) + assert pc._login_backoff.backoff_count == 0 + assert mock_sleep.call_count == 1 + + +@pytest.mark.asyncio +async def test_invalid_credentials( + mocked_server_responses, mock_sleep, get_mocked_url, read_file +): + pc = setup_pulse_connection() + # do initial login + await pc.async_do_login_query() + assert mock_sleep.call_count == 0 + assert pc.login_in_progress is False + assert pc._login_backoff.backoff_count == 0 + mocked_server_responses.post( + get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("signin_fail.html") + ) + await pc.async_do_login_query() + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.INVALID_CREDENTIALS + ) + assert pc._login_backoff.backoff_count == 1 + assert mock_sleep.call_count == 0 + mocked_server_responses.post( + get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("signin_fail.html") ) + await pc.async_do_login_query() + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.INVALID_CREDENTIALS + ) + assert pc._login_backoff.backoff_count == 2 + assert mock_sleep.call_count == 1 + mocked_server_responses.post( + get_mocked_url(ADT_LOGIN_URI), + status=302, + headers={ + "Location": get_mocked_url(ADT_SUMMARY_URI), + }, + ) + await pc.async_do_login_query() + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.NO_FAILURE + ) + assert pc._login_backoff.backoff_count == 0 + assert mock_sleep.call_count == 2 + + +@pytest.mark.asyncio +async def test_mfa_failure( + mocked_server_responses, mock_sleep, get_mocked_url, read_file +): + pc = setup_pulse_connection() + # do initial login + await pc.async_do_login_query() + assert mock_sleep.call_count == 0 + assert pc.login_in_progress is False + assert pc._login_backoff.backoff_count == 0 + mocked_server_responses.post( + get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("mfa.html") + ) + await pc.async_do_login_query() + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.MFA_REQUIRED + ) + assert pc._login_backoff.backoff_count == 1 + assert mock_sleep.call_count == 0 + mocked_server_responses.post( + get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("mfa.html") + ) + await pc.async_do_login_query() + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.INVALID_CREDENTIALS + ) + assert pc._login_backoff.backoff_count == 2 + assert mock_sleep.call_count == 1 + mocked_server_responses.post( + get_mocked_url(ADT_LOGIN_URI), + status=302, + headers={ + "Location": get_mocked_url(ADT_SUMMARY_URI), + }, + ) + await pc.async_do_login_query() + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.NO_FAILURE + ) + assert pc._login_backoff.backoff_count == 0 + assert mock_sleep.call_count == 2 + + +@pytest.mark.asyncio +async def test_only_single_login(mocked_server_responses): + async def login_task(): + await pc.async_do_login_query() + + pc = setup_pulse_connection() + # delay one task for a little bit + for i in range(4): + pc._login_backoff.increment_backoff() + task1 = asyncio.create_task(login_task()) + task2 = asyncio.create_task(login_task()) + await task2 + assert pc.login_in_progress + assert not pc.is_connected + assert not task1.done() + await task1 + assert not pc.login_in_progress + assert pc.is_connected From f0954e28b59a8d8031cf933e05effb515bc99c41 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 17 Dec 2023 01:28:57 -0500 Subject: [PATCH 141/226] fix various auth failures in pc --- pyadtpulse/const.py | 1 + pyadtpulse/pulse_connection.py | 69 +++++++++++++--------------------- 2 files changed, 28 insertions(+), 42 deletions(-) diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 21a6273..a71f1ef 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -11,6 +11,7 @@ ADT_LOGIN_URI = "/access/signin.jsp" ADT_LOGOUT_URI = "/access/signout.jsp" +ADT_MFA_FAIL_URI = "/mfa/mfaSignIn.jsp?workflow=challenge" ADT_SUMMARY_URI = "/summary/summary.jsp" ADT_ZONES_URI = "/ajax/homeViewDevAjax.jsp" diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index eddfa2f..7913b2d 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -15,6 +15,7 @@ from .const import ( ADT_LOGIN_URI, ADT_LOGOUT_URI, + ADT_MFA_FAIL_URI, ADT_SUMMARY_URI, ConnectionFailureReason, ) @@ -127,54 +128,38 @@ def check_response( # FIXME: should probably raise exceptions here if soup is None: return None - error = soup.find("div", {"id": "warnMsgContents"}) - if error: - error_text = error.get_text() - LOG.error("Error logging into pulse: %s", error_text) - if "Try again in" in error_text: - if (retry_after := extract_seconds_from_string(error_text)) > 0: - self._login_backoff.set_absolute_backoff_time( - time() + retry_after - ) - self._connection_status.connection_failure_reason = ( - ConnectionFailureReason.ACCOUNT_LOCKED - ) - return None - else: - # FIXME: not sure if this is true - self._connection_status.connection_failure_reason = ( - ConnectionFailureReason.INVALID_CREDENTIALS - ) - self._login_backoff.increment_backoff() - return None url = self._connection_properties.make_url(ADT_SUMMARY_URI) - if url != str(response[2]): + response_url_string = str(response[2]) + if url != response_url_string: # more specifically: # redirect to signin.jsp = username/password error # redirect to mfaSignin.jsp = fingerprint error # locked out = error == "Sign In unsuccessful. Your account has been # locked after multiple sign in attempts.Try again in 30 minutes." - - LOG.error( - "Authentication error encountered logging into ADT Pulse" - " at location %s", - url, - ) - self._connection_status.connection_failure_reason = ( - ConnectionFailureReason.INVALID_CREDENTIALS - ) - self._login_backoff.increment_backoff() - return None - error = soup.find("div", "responsiveContainer") - if error: - LOG.error( - "2FA authentiation required for ADT pulse username %s: %s", - self._authentication_properties.username, - error, - ) - self._connection_status.connection_failure_reason = ( - ConnectionFailureReason.MFA_REQUIRED - ) + fail_reason = ConnectionFailureReason.UNKNOWN + url = self._connection_properties.make_url(ADT_LOGIN_URI) + if url == response_url_string: + error = soup.find("div", {"id": "warnMsgContents"}) + if error: + error_text = error.get_text() + LOG.error("Error logging into pulse: %s", error_text) + if "Try again in" in error_text: + if ( + retry_after := extract_seconds_from_string(error_text) + ) > 0: + self._login_backoff.set_absolute_backoff_time( + time() + retry_after + ) + fail_reason = ConnectionFailureReason.ACCOUNT_LOCKED + else: + # FIXME: not sure if this is true + fail_reason = ConnectionFailureReason.INVALID_CREDENTIALS + else: + url = self._connection_properties.make_url(ADT_MFA_FAIL_URI) + if url == response_url_string: + fail_reason = ConnectionFailureReason.MFA_REQUIRED + LOG.error("Error logging into pulse: %s", fail_reason.value[1]) + self._connection_status.connection_failure_reason = fail_reason self._login_backoff.increment_backoff() return None return soup From 0738051f8e4acefb1354f0cfb1039621df02fbb1 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 19 Dec 2023 00:56:33 -0500 Subject: [PATCH 142/226] restrict update_zones_from soup to orb div in html --- pyadtpulse/site.py | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 70066ce..79bcb5e 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -292,7 +292,25 @@ def update_zone_from_soup(self, soup: BeautifulSoup) -> ADTPulseZones | None: # parse ADT's convulated html to get sensor status with self._site_lock: gateway_online = False - for row in soup.find_all("tr", {"class": "p_listRow"}): + orbsensors = soup.find("div", id="orbSensorsList") + if not orbsensors: + return None + for row in orbsensors.find_all("tr", {"class": "p_listRow"}): + temp = row.find("div", {"class": "p_grayNormalText"}) + # v26 and lower: temp = row.find("span", {"class": "p_grayNormalText"}) + if temp is None: + break + try: + zone = int( + remove_prefix( + temp.get_text(), + "Zone\xa0", + ) + ) + except ValueError: + LOG.debug("skipping row due to zone not being an integer") + continue + # parse out last activity (required dealing with "Yesterday 1:52 PM") temp = row.find("span", {"class": "devStatIcon"}) if temp is None: break @@ -304,16 +322,7 @@ def update_zone_from_soup(self, soup: BeautifulSoup) -> ADTPulseZones | None: except ValueError: last_update = datetime(1970, 1, 1) # name = row.find("a", {"class": "p_deviceNameText"}).get_text() - temp = row.find("div", {"class": "p_grayNormalText"}) - # v26 and lower: temp = row.find("span", {"class": "p_grayNormalText"}) - if temp is None: - break - zone = int( - remove_prefix( - temp.get_text(), - "Zone\xa0", - ) - ) + state = remove_prefix( row.find("canvas", {"class": "p_ic_icon_device"}).get("icon"), "devStat", @@ -336,9 +345,6 @@ def update_zone_from_soup(self, soup: BeautifulSoup) -> ADTPulseZones | None: else: status = "Online" - # parse out last activity (required dealing with "Yesterday 1:52 PM") - # last_activity = time.time() - # id: [integer] # name: device name # tags: sensor,[doorWindow,motion,glass,co,fire] From 8ca927999d8dff668f8baa904754d008d0d77259 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 19 Dec 2023 02:04:02 -0500 Subject: [PATCH 143/226] pc tests and fixes --- conftest.py | 2 + pyadtpulse/pulse_connection.py | 25 +++--------- tests/test_pulse_connection.py | 71 ++++++++++++++++++++++++++++++++-- 3 files changed, 74 insertions(+), 24 deletions(-) diff --git a/conftest.py b/conftest.py index 0e5b487..503b006 100644 --- a/conftest.py +++ b/conftest.py @@ -28,6 +28,7 @@ ADT_GATEWAY_URI, ADT_LOGIN_URI, ADT_LOGOUT_URI, + ADT_MFA_FAIL_URI, ADT_ORB_URI, ADT_SUMMARY_URI, ADT_SYNC_CHECK_URI, @@ -155,6 +156,7 @@ def get_mocked_mapped_static_responses(get_mocked_url) -> dict[str, str]: get_mocked_url(ADT_SUMMARY_URI): "summary.html", get_mocked_url(ADT_SYSTEM_URI): "system.html", get_mocked_url(ADT_GATEWAY_URI): "gateway.html", + get_mocked_url(ADT_MFA_FAIL_URI): "mfa.html", } diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 7913b2d..51fee72 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -24,7 +24,7 @@ from .pulse_connection_properties import PulseConnectionProperties from .pulse_connection_status import PulseConnectionStatus from .pulse_query_manager import PulseQueryManager -from .util import handle_response, make_soup, set_debug_lock +from .util import make_soup, set_debug_lock LOG = logging.getLogger(__name__) @@ -106,17 +106,6 @@ def check_response( """Check response for errors. Will handle setting backoffs.""" - if not handle_response( - response[0], - response[2], - logging.ERROR, - "Error encountered communicating with Pulse site on login", - ): - self._connection_status.connection_failure_reason = ( - ConnectionFailureReason.UNKNOWN - ) - self._login_backoff.increment_backoff() - return None soup = make_soup( response[0], @@ -160,7 +149,8 @@ def check_response( fail_reason = ConnectionFailureReason.MFA_REQUIRED LOG.error("Error logging into pulse: %s", fail_reason.value[1]) self._connection_status.connection_failure_reason = fail_reason - self._login_backoff.increment_backoff() + if fail_reason != ConnectionFailureReason.ACCOUNT_LOCKED: + self._login_backoff.increment_backoff() return None return soup @@ -183,14 +173,9 @@ def check_response( timeout=timeout, requires_authentication=False, ) - if not handle_response( - response[0], - response[2], - logging.ERROR, - "Error encountered during ADT login POST", + if self._connection_status.connection_failure_reason != ( + ConnectionFailureReason.NO_FAILURE ): - # FIXME: should we let the query manager handle the backoff? - self._login_backoff.increment_backoff() self.login_in_progress = False return None except Exception as e: # pylint: disable=broad-except diff --git a/tests/test_pulse_connection.py b/tests/test_pulse_connection.py index 7a9eaf6..c794305 100644 --- a/tests/test_pulse_connection.py +++ b/tests/test_pulse_connection.py @@ -7,6 +7,7 @@ from pyadtpulse.const import ( ADT_LOGIN_URI, + ADT_MFA_FAIL_URI, ADT_SUMMARY_URI, DEFAULT_API_HOST, ConnectionFailureReason, @@ -90,6 +91,7 @@ async def test_multiple_login( assert mock_sleep.call_count == 0 assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 + assert pc._connection_status.get_backoff().backoff_count == 0 assert pc._connection_status.authenticated_flag.is_set() assert ( pc._connection_status.connection_failure_reason @@ -101,11 +103,60 @@ async def test_multiple_login( assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 assert pc._connection_status.get_backoff().backoff_count == 1 - assert pc._connection_status.authenticated_flag.is_set() + assert not pc._connection_status.authenticated_flag.is_set() + assert not pc.is_connected + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.SERVER_ERROR + ) + await pc.async_do_login_query() + assert pc._login_backoff.backoff_count == 0 + # 2 retries first time, 3 the second + assert mock_sleep.call_count == MAX_RETRIES - 1 + MAX_RETRIES + assert pc.login_in_progress is False + + assert pc._connection_status.get_backoff().backoff_count == 2 + assert not pc._connection_status.authenticated_flag.is_set() + assert not pc.is_connected assert ( pc._connection_status.connection_failure_reason == ConnectionFailureReason.SERVER_ERROR ) + mocked_server_responses.post( + get_mocked_url(ADT_LOGIN_URI), + status=302, + headers={ + "Location": get_mocked_url(ADT_SUMMARY_URI), + }, + ) + await pc.async_do_login_query() + # will do a backoff, then query + assert mock_sleep.call_count == MAX_RETRIES - 1 + MAX_RETRIES + 1 + assert pc.login_in_progress is False + assert pc._login_backoff.backoff_count == 0 + assert pc._connection_status.authenticated_flag.is_set() + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.NO_FAILURE + ) + + mocked_server_responses.post( + get_mocked_url(ADT_LOGIN_URI), + status=302, + headers={ + "Location": get_mocked_url(ADT_SUMMARY_URI), + }, + ) + await pc.async_do_login_query() + # shouldn't sleep at all + assert mock_sleep.call_count == MAX_RETRIES - 1 + MAX_RETRIES + 1 + assert pc.login_in_progress is False + assert pc._login_backoff.backoff_count == 0 + assert pc._connection_status.authenticated_flag.is_set() + assert ( + pc._connection_status.connection_failure_reason + == ConnectionFailureReason.NO_FAILURE + ) @pytest.mark.asyncio @@ -118,6 +169,8 @@ async def test_account_lockout( assert mock_sleep.call_count == 0 assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 + assert pc.is_connected + assert pc._connection_status.authenticated_flag.is_set() mocked_server_responses.post( get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("signin_locked.html") ) @@ -126,6 +179,10 @@ async def test_account_lockout( pc._connection_status.connection_failure_reason == ConnectionFailureReason.ACCOUNT_LOCKED ) + # won't sleep yet + assert not pc.is_connected + assert not pc._connection_status.authenticated_flag.is_set() + # don't set backoff on locked account, just set expiration time on backoff assert pc._login_backoff.backoff_count == 0 assert mock_sleep.call_count == 0 mocked_server_responses.post( @@ -142,6 +199,8 @@ async def test_account_lockout( ) assert mock_sleep.call_count == 1 assert mock_sleep.call_args_list[0][0][0] == 60 * 30 + assert pc.is_connected + assert pc._connection_status.authenticated_flag.is_set() freeze_time_to_now.tick(delta=datetime.timedelta(seconds=60 * 30 + 1)) mocked_server_responses.post( get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("signin_locked.html") @@ -212,7 +271,9 @@ async def test_mfa_failure( assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 mocked_server_responses.post( - get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("mfa.html") + get_mocked_url(ADT_LOGIN_URI), + status=307, + headers={"Location": get_mocked_url(ADT_MFA_FAIL_URI)}, ) await pc.async_do_login_query() assert ( @@ -222,12 +283,14 @@ async def test_mfa_failure( assert pc._login_backoff.backoff_count == 1 assert mock_sleep.call_count == 0 mocked_server_responses.post( - get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("mfa.html") + get_mocked_url(ADT_LOGIN_URI), + status=307, + headers={"Location": get_mocked_url(ADT_MFA_FAIL_URI)}, ) await pc.async_do_login_query() assert ( pc._connection_status.connection_failure_reason - == ConnectionFailureReason.INVALID_CREDENTIALS + == ConnectionFailureReason.MFA_REQUIRED ) assert pc._login_backoff.backoff_count == 2 assert mock_sleep.call_count == 1 From c243b91b94f22118b9a7a3f8f619da7ee441fded Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 19 Dec 2023 02:34:25 -0500 Subject: [PATCH 144/226] pa test fixes --- conftest.py | 1 - tests/test_pulse_async.py | 58 +++++++++++++-------------------------- 2 files changed, 19 insertions(+), 40 deletions(-) diff --git a/conftest.py b/conftest.py index 503b006..a1c394a 100644 --- a/conftest.py +++ b/conftest.py @@ -40,7 +40,6 @@ from pyadtpulse.util import remove_prefix MOCKED_API_VERSION = "27.0.0-140" -DEFAULT_SYNC_CHECK = "234532-456432-0" @pytest.fixture diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index 4bc2a7b..17f0d67 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -18,12 +18,7 @@ ) from pyadtpulse.pyadtpulse_async import PyADTPulseAsync - -def set_sync_check( - get_mocked_url, mocked_server_responses, body: str, repeat: bool = False -): - r = re.compile(r"^" + re.escape(get_mocked_url(ADT_SYNC_CHECK_URI) + r"\?.*")) - mocked_server_responses.get(r, body=body, repeat=repeat, content_type="text/html") +DEFAULT_SYNC_CHECK = "234532-456432-0" def set_keepalive(get_mocked_url, mocked_server_responses, repeat: bool = False): @@ -43,7 +38,6 @@ async def test_mocked_responses( get_mocked_mapped_static_responses, get_mocked_url, extract_ids_from_data_directory, - get_default_sync_check, ): """Fixture to test mocked responses.""" static_responses = get_mocked_mapped_static_responses @@ -91,27 +85,14 @@ async def test_mocked_responses( expected_content = read_file(static_responses[get_mocked_url(ADT_SUMMARY_URI)]) actual_content = await response.text() assert actual_content == expected_content - set_sync_check(get_mocked_url, m, get_default_sync_check) - set_sync_check(get_mocked_url, m, "1-0-0") - set_sync_check(get_mocked_url, m, get_default_sync_check) + pattern = re.compile(rf"{re.escape(get_mocked_url(ADT_SYNC_CHECK_URI))}/?.*$") + m.get(pattern, status=200, body="1-0-0", content_type="text/html") response = await session.get( get_mocked_url(ADT_SYNC_CHECK_URI), params={"ts": "first call"} ) assert response.status == 200 actual_content = await response.text() - expected_content = get_default_sync_check - assert actual_content == expected_content - response = await session.get( - get_mocked_url(ADT_SYNC_CHECK_URI), params={"ts": "second call"} - ) - assert response.status == 200 - actual_content = await response.text() - assert actual_content == "1-0-0" - response = await session.get( - get_mocked_url(ADT_SYNC_CHECK_URI), params={"ts": "third call"} - ) - assert response.status == 200 - actual_content = await response.text() + expected_content = "1-0-0" assert actual_content == expected_content set_keepalive(get_mocked_url, m) response = await session.post(get_mocked_url(ADT_TIMEOUT_URI)) @@ -188,9 +169,8 @@ async def test_wait_for_update(m, adt_pulse_instance): assert m.call_count == 1 -async def test_orb_update( - mocked_server_responses, get_mocked_url, read_file, get_default_sync_check -): +@pytest.mark.asyncio +async def test_orb_update(mocked_server_responses, get_mocked_url, read_file): response = mocked_server_responses def setup_sync_check(): @@ -204,9 +184,10 @@ def setup_sync_check(): body=read_file("orb.html"), content_type="text/html", ) + pattern = re.compile(rf"{re.escape(get_mocked_url(ADT_SYNC_CHECK_URI))}/?.*$") response.get( - get_mocked_url(ADT_SYNC_CHECK_URI), - body=get_default_sync_check, + pattern, + body=DEFAULT_SYNC_CHECK, content_type="text/html", ) response.get( @@ -214,12 +195,12 @@ def setup_sync_check(): ) response.get( get_mocked_url(ADT_SYNC_CHECK_URI), - body=get_default_sync_check, + body=DEFAULT_SYNC_CHECK, content_type="text/html", ) response.get( get_mocked_url(ADT_SYNC_CHECK_URI), - body=get_default_sync_check, + body=DEFAULT_SYNC_CHECK, content_type="text/html", ) @@ -240,7 +221,7 @@ async def test_sync_check_and_orb(): ADT_SYNC_CHECK_URI, requires_authentication=False ) assert code == 200 - assert content == get_default_sync_check + assert content == DEFAULT_SYNC_CHECK code, content, _ = await p._pulse_connection.async_query( ADT_SYNC_CHECK_URI, requires_authentication=False ) @@ -250,7 +231,7 @@ async def test_sync_check_and_orb(): ADT_SYNC_CHECK_URI, requires_authentication=False ) assert code == 200 - assert content == get_default_sync_check + assert content == DEFAULT_SYNC_CHECK p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") shutdown_event = asyncio.Event() @@ -263,7 +244,7 @@ async def test_sync_check_and_orb(): get_mocked_url(ADT_SYNC_CHECK_URI), content_type="text/html", repeat=True, - body=get_default_sync_check, + body=DEFAULT_SYNC_CHECK, ) await p.async_login() task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) @@ -273,6 +254,7 @@ async def test_sync_check_and_orb(): task.cancel() await task await p.async_logout() + assert len(p._site.zones) == 19 assert p._sync_task is None # assert m.call_count == 2 @@ -286,13 +268,12 @@ async def test_keepalive_check(mocked_server_responses): @pytest.mark.asyncio -async def test_infinite_sync_check( - mocked_server_responses, get_mocked_url, get_default_sync_check -): +async def test_infinite_sync_check(mocked_server_responses, get_mocked_url): p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") + pattern = re.compile(rf"{re.escape(get_mocked_url(ADT_SYNC_CHECK_URI))}/?.*$") mocked_server_responses.get( - get_mocked_url(ADT_SYNC_CHECK_URI), - body=get_default_sync_check, + pattern, + body=DEFAULT_SYNC_CHECK, content_type="text/html", repeat=True, ) @@ -301,7 +282,6 @@ async def test_infinite_sync_check( await p.async_login() task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) await asyncio.sleep(5) - assert mocked_server_responses.call_count > 1 shutdown_event.set() task.cancel() await task From cf2b55b95edd399c8cbba4a041ac75479d0c789b Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 19 Dec 2023 03:06:38 -0500 Subject: [PATCH 145/226] rollback div html check --- pyadtpulse/site.py | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 79bcb5e..03a2ba0 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -292,10 +292,7 @@ def update_zone_from_soup(self, soup: BeautifulSoup) -> ADTPulseZones | None: # parse ADT's convulated html to get sensor status with self._site_lock: gateway_online = False - orbsensors = soup.find("div", id="orbSensorsList") - if not orbsensors: - return None - for row in orbsensors.find_all("tr", {"class": "p_listRow"}): + for row in soup.find_all("tr", {"class": "p_listRow"}): temp = row.find("div", {"class": "p_grayNormalText"}) # v26 and lower: temp = row.find("span", {"class": "p_grayNormalText"}) if temp is None: From d18cfb62e26e418d8eff792a9439bb2c2eee0716 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 19 Dec 2023 23:43:46 -0500 Subject: [PATCH 146/226] fix zone parsing in site --- pyadtpulse/site.py | 2 +- tests/test_pulse_async.py | 104 +++++++++++++++++++++++++------------- 2 files changed, 69 insertions(+), 37 deletions(-) diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 03a2ba0..75febbf 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -301,7 +301,7 @@ def update_zone_from_soup(self, soup: BeautifulSoup) -> ADTPulseZones | None: zone = int( remove_prefix( temp.get_text(), - "Zone\xa0", + "Zone", ) ) except ValueError: diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index 17f0d67..2657591 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -19,6 +19,7 @@ from pyadtpulse.pyadtpulse_async import PyADTPulseAsync DEFAULT_SYNC_CHECK = "234532-456432-0" +NEXT_SYNC_CHECK = "234533-456432-0" def set_keepalive(get_mocked_url, mocked_server_responses, repeat: bool = False): @@ -172,37 +173,62 @@ async def test_wait_for_update(m, adt_pulse_instance): @pytest.mark.asyncio async def test_orb_update(mocked_server_responses, get_mocked_url, read_file): response = mocked_server_responses + pattern = re.compile(rf"{re.escape(get_mocked_url(ADT_SYNC_CHECK_URI))}/?.*$") - def setup_sync_check(): + def signal_status_change(): response.get( - get_mocked_url(ADT_ORB_URI), - body=read_file("orb_patio_opened.html"), + pattern, + body=DEFAULT_SYNC_CHECK, content_type="text/html", ) + response.get(pattern, body="1-0-0", content_type="text/html") + response.get(pattern, body="2-0-0", content_type="text/html") response.get( - get_mocked_url(ADT_ORB_URI), - body=read_file("orb.html"), + pattern, + body=NEXT_SYNC_CHECK, content_type="text/html", ) - pattern = re.compile(rf"{re.escape(get_mocked_url(ADT_SYNC_CHECK_URI))}/?.*$") response.get( pattern, - body=DEFAULT_SYNC_CHECK, + body=NEXT_SYNC_CHECK, content_type="text/html", ) + + def open_patio(): response.get( - get_mocked_url(ADT_SYNC_CHECK_URI), body="1-0-0", content_type="text/html" + get_mocked_url(ADT_ORB_URI), + body=read_file("orb_patio_opened.html"), + content_type="text/html", ) + signal_status_change() + + def close_patio(): response.get( - get_mocked_url(ADT_SYNC_CHECK_URI), - body=DEFAULT_SYNC_CHECK, + get_mocked_url(ADT_ORB_URI), + body=read_file("orb.html"), content_type="text/html", ) + signal_status_change() + + def open_garage(): response.get( - get_mocked_url(ADT_SYNC_CHECK_URI), - body=DEFAULT_SYNC_CHECK, + get_mocked_url(ADT_ORB_URI), + body=read_file("orb_garage.html"), content_type="text/html", ) + signal_status_change() + + def open_both_garage_and_patio(): + response.get( + get_mocked_url(ADT_ORB_URI), + body=read_file("orb_patio_garage.html"), + content_type="text/html", + ) + signal_status_change() + + def setup_sync_check(): + open_patio() + close_patio() async def test_sync_check_and_orb(): code, content, _ = await p._pulse_connection.async_query( @@ -217,21 +243,32 @@ async def test_sync_check_and_orb(): assert code == 200 assert content == read_file("orb.html") await asyncio.sleep(1) - code, content, _ = await p._pulse_connection.async_query( - ADT_SYNC_CHECK_URI, requires_authentication=False - ) - assert code == 200 - assert content == DEFAULT_SYNC_CHECK - code, content, _ = await p._pulse_connection.async_query( - ADT_SYNC_CHECK_URI, requires_authentication=False - ) - assert code == 200 - assert content == "1-0-0" - code, content, _ = await p._pulse_connection.async_query( - ADT_SYNC_CHECK_URI, requires_authentication=False - ) - assert code == 200 - assert content == DEFAULT_SYNC_CHECK + for _ in range(1): + code, content, _ = await p._pulse_connection.async_query( + ADT_SYNC_CHECK_URI, requires_authentication=False + ) + assert code == 200 + assert content == DEFAULT_SYNC_CHECK + code, content, _ = await p._pulse_connection.async_query( + ADT_SYNC_CHECK_URI, requires_authentication=False + ) + assert code == 200 + assert content == "1-0-0" + code, content, _ = await p._pulse_connection.async_query( + ADT_SYNC_CHECK_URI, requires_authentication=False + ) + assert code == 200 + assert content == "2-0-0" + code, content, _ = await p._pulse_connection.async_query( + ADT_SYNC_CHECK_URI, requires_authentication=False + ) + assert code == 200 + assert content == NEXT_SYNC_CHECK + code, content, _ = await p._pulse_connection.async_query( + ADT_SYNC_CHECK_URI, requires_authentication=False + ) + assert code == 200 + assert content == NEXT_SYNC_CHECK p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") shutdown_event = asyncio.Event() @@ -239,22 +276,17 @@ async def test_sync_check_and_orb(): setup_sync_check() # do a first run though to make sure aioresponses will work ok await test_sync_check_and_orb() - setup_sync_check() - response.get( - get_mocked_url(ADT_SYNC_CHECK_URI), - content_type="text/html", - repeat=True, - body=DEFAULT_SYNC_CHECK, - ) + open_patio() await p.async_login() task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) - await asyncio.sleep(5) + await asyncio.sleep(3) assert p._sync_task is not None shutdown_event.set() task.cancel() await task await p.async_logout() - assert len(p._site.zones) == 19 + assert len(p.site.zones) == 13 + assert p.site.zones_as_dict[11].state == "Open" assert p._sync_task is None # assert m.call_count == 2 From e40a4bf05e4f2e0f54839b03380b7f3f6ff95c0e Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Wed, 20 Dec 2023 03:20:04 -0500 Subject: [PATCH 147/226] change connectionfailurereason to exceptions --- pyadtpulse/const.py | 31 ------ pyadtpulse/exceptions.py | 57 ++++++++++ pyadtpulse/gateway.py | 52 ++-------- pyadtpulse/pulse_connection.py | 101 ++++++++++-------- pyadtpulse/pulse_connection_status.py | 16 --- pyadtpulse/pulse_query_manager.py | 126 ++++++++++------------ pyadtpulse/pyadtpulse_async.py | 144 +++++++++++++++++++++----- pyadtpulse/pyadtpulse_properties.py | 18 +--- pyadtpulse/site.py | 44 ++++++-- 9 files changed, 333 insertions(+), 256 deletions(-) create mode 100644 pyadtpulse/exceptions.py diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index a71f1ef..42910e8 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -1,8 +1,6 @@ """Constants for pyadtpulse.""" __version__ = "1.1.4b4" -from enum import Enum -from http import HTTPStatus DEFAULT_API_HOST = "https://portal.adtpulse.com" API_HOST_CA = "https://portal-ca.adtpulse.com" # Canada @@ -76,32 +74,3 @@ ADT_SENSOR_SMOKE = "smoke" ADT_SENSOR_CO = "co" ADT_SENSOR_ALARM = "alarm" - - -class ConnectionFailureReason(Enum): - """Reason for connection failure.""" - - NO_FAILURE = 0, "No Failure" - UNKNOWN = 1, "Unknown Failure" - ACCOUNT_LOCKED = 2, "Account Locked" - INVALID_CREDENTIALS = 3, "Invalid Credentials" - MFA_REQUIRED = ( - 4, - "MFA Required", - ) - CLIENT_ERROR = ( - 5, - "Client Error", - ) - SERVER_ERROR = ( - 6, - "Server Error", - ) - SERVICE_UNAVAILABLE = ( - HTTPStatus.SERVICE_UNAVAILABLE.value, - HTTPStatus.SERVICE_UNAVAILABLE.description, - ) - TOO_MANY_REQUESTS = ( - HTTPStatus.TOO_MANY_REQUESTS.value, - HTTPStatus.TOO_MANY_REQUESTS.description, - ) diff --git a/pyadtpulse/exceptions.py b/pyadtpulse/exceptions.py new file mode 100644 index 0000000..87d5455 --- /dev/null +++ b/pyadtpulse/exceptions.py @@ -0,0 +1,57 @@ +"""Pulse exceptions.""" +from time import time + +from .pulse_backoff import PulseBackoff + + +class ExceptionWithBackoff(RuntimeError): + """Exception with backoff.""" + + def __init__(self, message: str, backoff: PulseBackoff): + """Initialize exception.""" + super().__init__(message) + self.backoff = backoff + self.backoff.increment_backoff() + + +class ExceptionWithRetry(ExceptionWithBackoff): + """Exception with backoff.""" + + def __init__(self, message: str, backoff: PulseBackoff, retry_time: float | None): + """Initialize exception.""" + super().__init__(message, backoff) + if retry_time and retry_time > time(): + # don't need a backoff count for absolute backoff + self.backoff.reset_backoff() + self.backoff.set_absolute_backoff_time(retry_time) + + +class PulseServerConnectionError(ExceptionWithBackoff): + """Server error.""" + + +class PulseClientConnectionError(ExceptionWithBackoff): + """Client error.""" + + +class PulseServiceTemporarilyUnavailableError(ExceptionWithRetry): + """Service temporarily unavailable error. + + For HTTP 503 and 429 errors. + """ + + +class PulseAuthenticationError(ExceptionWithBackoff): + """Authentication error.""" + + +class PulseAccountLockedError(ExceptionWithRetry): + """Account locked error.""" + + +class PulseGatewayOfflineError(ExceptionWithBackoff): + """Gateway offline error.""" + + +class PulseMFARequiredError(ExceptionWithBackoff): + """MFA required error.""" diff --git a/pyadtpulse/gateway.py b/pyadtpulse/gateway.py index e244dc5..3ac78d1 100644 --- a/pyadtpulse/gateway.py +++ b/pyadtpulse/gateway.py @@ -44,7 +44,7 @@ class ADTPulseGateway: manufacturer: str = "Unknown" _status_text: str = "OFFLINE" - _backoff = PulseBackoff( + backoff = PulseBackoff( "Gateway", ADT_DEFAULT_POLL_INTERVAL, ADT_GATEWAY_MAX_OFFLINE_POLL_INTERVAL ) _attribute_lock = RLock() @@ -82,8 +82,6 @@ def is_online(self, status: bool) -> None: Args: status (bool): True if gateway is online - - Also changes the polling intervals """ with self._attribute_lock: if status == self.is_online: @@ -92,60 +90,24 @@ def is_online(self, status: bool) -> None: self._status_text = "ONLINE" if not status: self._status_text = "OFFLINE" - self._backoff.increment_backoff() - else: - self._backoff.reset_backoff() LOG.info( "ADT Pulse gateway %s, poll interval=%f", self._status_text, - self._backoff.get_current_backoff_interval(), + self.backoff.get_current_backoff_interval(), ) @property def poll_interval(self) -> float: - """Set polling interval. - - Returns: - float: number of seconds between polls - """ + """Get current poll interval.""" with self._attribute_lock: - return self._backoff.get_current_backoff_interval() + return self.backoff.initial_backoff_interval @poll_interval.setter @typechecked - def poll_interval(self, new_interval: float | None) -> None: - """Set polling interval. - - Args: - new_interval (float): polling interval if gateway is online, - if set to None, resets to ADT_DEFAULT_POLL_INTERVAL - - Raises: - ValueError: if new_interval is less than 0 - """ - if new_interval is None: - new_interval = ADT_DEFAULT_POLL_INTERVAL + def poll_interval(self, new_interval: float) -> None: with self._attribute_lock: - self._backoff.initial_backoff_interval = new_interval - LOG.debug("Set poll interval to %f", new_interval) - - def adjust_backoff_poll_interval(self) -> None: - """Calculates the backoff poll interval. - - Each call will adjust current_poll interval with exponential backoff, - unless gateway is online, in which case, poll interval will be reset to - initial_poll interval.""" - - with self._attribute_lock: - if self.is_online: - self._backoff.reset_backoff() - return - self._backoff.increment_backoff() - LOG.debug( - "Setting current poll interval to %f", - self._backoff.get_current_backoff_interval(), - ) + self.backoff.initial_backoff_interval = new_interval @typechecked def set_gateway_attributes(self, gateway_attributes: dict[str, str]) -> None: @@ -153,7 +115,7 @@ def set_gateway_attributes(self, gateway_attributes: dict[str, str]) -> None: Args: gateway_attributes (dict[str,str]): dictionary of gateway attributes - """ """""" + """ for i in ( STRING_UPDATEABLE_FIELDS + IPADDR_UPDATEABLE_FIELDS diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 51fee72..617d2bc 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -12,12 +12,14 @@ from typeguard import typechecked from yarl import URL -from .const import ( - ADT_LOGIN_URI, - ADT_LOGOUT_URI, - ADT_MFA_FAIL_URI, - ADT_SUMMARY_URI, - ConnectionFailureReason, +from .const import ADT_LOGIN_URI, ADT_LOGOUT_URI, ADT_MFA_FAIL_URI, ADT_SUMMARY_URI +from .exceptions import ( + PulseAccountLockedError, + PulseAuthenticationError, + PulseClientConnectionError, + PulseMFARequiredError, + PulseServerConnectionError, + PulseServiceTemporarilyUnavailableError, ) from .pulse_authentication_properties import PulseAuthenticationProperties from .pulse_backoff import PulseBackoff @@ -85,10 +87,12 @@ async def async_do_login_query(self, timeout: int = 30) -> BeautifulSoup | None: Returns: soup: Optional[BeautifulSoup]: A BeautifulSoup object containing summary.jsp, or None if failure - soup: Optional[BeautifulSoup]: A BeautifulSoup object containing - summary.jsp, or None if failure Raises: ValueError: if login parameters are not correct + PulseAuthenticationError: if login fails due to incorrect username/password + PulseServerConnectionError: if login fails due to server error + PulseAccountLockedError: if login fails due to account locked + PulseMFARequiredError: if login fails due to MFA required """ def extract_seconds_from_string(s: str) -> int: @@ -102,10 +106,10 @@ def extract_seconds_from_string(s: str) -> int: def check_response( response: tuple[int, str | None, URL | None] - ) -> BeautifulSoup | None: + ) -> BeautifulSoup: """Check response for errors. - Will handle setting backoffs.""" + Will handle setting backoffs and raising exceptions.""" soup = make_soup( response[0], @@ -114,9 +118,12 @@ def check_response( logging.ERROR, "Could not log into ADT Pulse site", ) - # FIXME: should probably raise exceptions here + # this probably should have been handled by async_query() if soup is None: - return None + raise PulseServerConnectionError( + f"Could not log into ADT Pulse site: code {response[0]}: URL: {response[2]}, response: {response[1]}", + self._login_backoff, + ) url = self._connection_properties.make_url(ADT_SUMMARY_URI) response_url_string = str(response[2]) if url != response_url_string: @@ -125,7 +132,10 @@ def check_response( # redirect to mfaSignin.jsp = fingerprint error # locked out = error == "Sign In unsuccessful. Your account has been # locked after multiple sign in attempts.Try again in 30 minutes." - fail_reason = ConnectionFailureReason.UNKNOWN + + # these are all failure cases, so just set login_in_progress to False now + # before exceptions are raised + self._login_in_progress = False url = self._connection_properties.make_url(ADT_LOGIN_URI) if url == response_url_string: error = soup.find("div", {"id": "warnMsgContents"}) @@ -136,22 +146,25 @@ def check_response( if ( retry_after := extract_seconds_from_string(error_text) ) > 0: - self._login_backoff.set_absolute_backoff_time( - time() + retry_after + raise PulseAccountLockedError( + f"Pulse account locked {retry_after/60} minutes for too many failed login attempts", + self._login_backoff, + retry_after + time(), ) - fail_reason = ConnectionFailureReason.ACCOUNT_LOCKED else: # FIXME: not sure if this is true - fail_reason = ConnectionFailureReason.INVALID_CREDENTIALS + raise PulseAuthenticationError( + error_text, self._login_backoff + ) else: url = self._connection_properties.make_url(ADT_MFA_FAIL_URI) if url == response_url_string: - fail_reason = ConnectionFailureReason.MFA_REQUIRED - LOG.error("Error logging into pulse: %s", fail_reason.value[1]) - self._connection_status.connection_failure_reason = fail_reason - if fail_reason != ConnectionFailureReason.ACCOUNT_LOCKED: - self._login_backoff.increment_backoff() - return None + raise PulseMFARequiredError( + "MFA required to log into Pulse site", self._login_backoff + ) + # don't know what exactly the error is if we get here + self._login_in_progress = False + raise PulseAuthenticationError("Unknown error", self._login_backoff) return soup if self.login_in_progress: @@ -173,20 +186,15 @@ def check_response( timeout=timeout, requires_authentication=False, ) - if self._connection_status.connection_failure_reason != ( - ConnectionFailureReason.NO_FAILURE - ): - self.login_in_progress = False - return None - except Exception as e: # pylint: disable=broad-except + except ( + PulseClientConnectionError, + PulseServerConnectionError, + PulseServiceTemporarilyUnavailableError, + ) as e: LOG.error("Could not log into Pulse site: %s", e) - # the query manager will handle the backoff self.login_in_progress = False - return None + raise soup = check_response(response) - if soup is None: - self.login_in_progress = False - return None self._connection_status.authenticated_flag.set() self._authentication_properties.last_login_time = int(time()) self._login_backoff.reset_backoff() @@ -204,18 +212,29 @@ async def async_do_logout_query(self, site_id: str | None = None) -> None: params.update({"networkid": si}) params.update({"partner": "adt"}) - await self.async_query( - ADT_LOGOUT_URI, - extra_params=params, - timeout=10, - requires_authentication=False, - ) + try: + await self.async_query( + ADT_LOGOUT_URI, + extra_params=params, + timeout=10, + requires_authentication=False, + ) + # FIXME: do we care if this raises exceptions? + except ( + PulseClientConnectionError, + PulseServiceTemporarilyUnavailableError, + PulseServerConnectionError, + ) as e: + LOG.debug("Could not logout from Pulse site: %s", e) self._connection_status.authenticated_flag.clear() @property def is_connected(self) -> bool: """Check if ADT Pulse is connected.""" - return self._connection_status.authenticated_flag.is_set() + return ( + self._connection_status.authenticated_flag.is_set() + and not self._login_in_progress + ) def check_sync(self, message: str) -> AbstractEventLoop: """Convenience method to check if running from sync context.""" diff --git a/pyadtpulse/pulse_connection_status.py b/pyadtpulse/pulse_connection_status.py index 529d144..b0c9d66 100644 --- a/pyadtpulse/pulse_connection_status.py +++ b/pyadtpulse/pulse_connection_status.py @@ -3,7 +3,6 @@ from typeguard import typechecked -from .const import ConnectionFailureReason from .pulse_backoff import PulseBackoff from .util import set_debug_lock @@ -13,7 +12,6 @@ class PulseConnectionStatus: __slots__ = ( "_backoff", - "_connection_failure_reason", "_authenticated_flag", "_pcs_attribute_lock", ) @@ -27,7 +25,6 @@ def __init__(self, debug_locks: bool = False): "Connection Status", initial_backoff_interval=1, ) - self._connection_failure_reason = ConnectionFailureReason.NO_FAILURE self._authenticated_flag = Event() @property @@ -36,19 +33,6 @@ def authenticated_flag(self) -> Event: with self._pcs_attribute_lock: return self._authenticated_flag - @property - def connection_failure_reason(self) -> ConnectionFailureReason: - """Get the connection failure reason.""" - with self._pcs_attribute_lock: - return self._connection_failure_reason - - @connection_failure_reason.setter - @typechecked - def connection_failure_reason(self, reason: ConnectionFailureReason) -> None: - """Set the connection failure reason.""" - with self._pcs_attribute_lock: - self._connection_failure_reason = reason - @property def retry_after(self) -> float: """Get the number of seconds to wait before retrying HTTP requests.""" diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index 847f69c..c2b1eba 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -18,11 +18,11 @@ from typeguard import typechecked from yarl import URL -from .const import ( - ADT_HTTP_BACKGROUND_URIS, - ADT_ORB_URI, - ADT_OTHER_HTTP_ACCEPT_HEADERS, - ConnectionFailureReason, +from .const import ADT_HTTP_BACKGROUND_URIS, ADT_ORB_URI, ADT_OTHER_HTTP_ACCEPT_HEADERS +from .exceptions import ( + PulseClientConnectionError, + PulseServerConnectionError, + PulseServiceTemporarilyUnavailableError, ) from .pulse_backoff import PulseBackoff from .pulse_connection_properties import PulseConnectionProperties @@ -36,24 +36,7 @@ HTTPStatus.BAD_GATEWAY, HTTPStatus.GATEWAY_TIMEOUT, } -RETRY_LATER_ERRORS = frozenset( - {HTTPStatus.SERVICE_UNAVAILABLE, HTTPStatus.TOO_MANY_REQUESTS} -) -RETRY_LATER_CONNECTION_STATUSES = frozenset( - { - reason - for reason in ConnectionFailureReason - if reason.value[0] in RETRY_LATER_ERRORS - } -) -CHANGEABLE_CONNECTION_STATUSES = frozenset( - RETRY_LATER_CONNECTION_STATUSES - | { - ConnectionFailureReason.NO_FAILURE, - ConnectionFailureReason.CLIENT_ERROR, - ConnectionFailureReason.SERVER_ERROR, - } -) + MAX_RETRIES = 3 @@ -120,6 +103,9 @@ def _set_retry_after(self, code: int, retry_after: str) -> None: Returns: None. + + Raises: + PulseServiceTemporarilyUnavailableError: If the server returns a "Retry-After" header. """ now = time() if retry_after.isnumeric(): @@ -133,58 +119,56 @@ def _set_retry_after(self, code: int, retry_after: str) -> None: except ValueError: return description = self._get_http_status_description(code) - LOG.warning( - "Task %s received Retry-After %s due to %s", - current_task(), - retval, - description, + message = ( + f"Task {current_task()} received Retry-After {retval} due to {description}" + ) + + raise PulseServiceTemporarilyUnavailableError( + message, self._connection_status.get_backoff(), retval ) - # don't set the retry_after if it is in the past - if retval > 0: - self._connection_status.retry_after = now + retval @typechecked def _handle_http_errors( self, return_value: tuple[int, str | None, URL | None, str | None] ) -> None: - failure_reason = ConnectionFailureReason.SERVER_ERROR + """Handle HTTP errors. + + Parameters: + return_value (tuple[int, str | None, URL | None, str | None]): + The return value from _handle_query_response. + + Raises: + PulseServerConnectionError: If the server returns an error code. + PulseServiceTemporarilyUnavailableError: If the server returns a + Retry-After header.""" if return_value[0] is not None and return_value[3] is not None: self._set_retry_after( return_value[0], return_value[3], ) - if return_value[0] == HTTPStatus.TOO_MANY_REQUESTS: - failure_reason = ConnectionFailureReason.TOO_MANY_REQUESTS - if return_value[0] == HTTPStatus.SERVICE_UNAVAILABLE: - failure_reason = ConnectionFailureReason.SERVICE_UNAVAILABLE - self._update_connection_status(failure_reason) + raise PulseServerConnectionError( + f"HTTP error {return_value[0]}: {return_value[1]} connecting to {return_value[2]}", + self._connection_status.get_backoff(), + ) @typechecked - def _handle_network_errors(self, e: Exception) -> ConnectionFailureReason: + def _handle_network_errors(self, e: Exception) -> None: + new_exception: PulseClientConnectionError | PulseServerConnectionError = ( + PulseClientConnectionError(str(e), self._connection_status.get_backoff()) + ) if isinstance(e, (ServerConnectionError, ServerTimeoutError)): - return ConnectionFailureReason.SERVER_ERROR + new_exception = PulseServerConnectionError( + str(e), self._connection_status.get_backoff() + ) if ( isinstance(e, (ClientConnectionError)) and "Connection refused" in str(e) or ("timed out") in str(e) ): - return ConnectionFailureReason.SERVER_ERROR - return ConnectionFailureReason.CLIENT_ERROR - - def _update_connection_status( - self, failure_reason: ConnectionFailureReason - ) -> None: - """Update connection status. - - Will also increment or reset the backoff. - """ - if failure_reason not in CHANGEABLE_CONNECTION_STATUSES: - return - if failure_reason == ConnectionFailureReason.NO_FAILURE: - self._connection_status.reset_backoff() - elif failure_reason not in (RETRY_LATER_CONNECTION_STATUSES): - self._connection_status.increment_backoff() - self._connection_status.connection_failure_reason = failure_reason + new_exception = PulseServerConnectionError( + str(e), self._connection_status.get_backoff() + ) + raise new_exception @typechecked async def async_query( @@ -216,6 +200,11 @@ async def async_query( Returns: tuple with integer return code, optional response text, and optional URL of response + + Raises: + PulseClientConnectionError: If the client cannot connect + PulseServerConnectionError: If there is a server error + PulseServiceTemporarilyUnavailableError: If the server returns a Retry-After header """ async def setup_query(): @@ -264,7 +253,6 @@ async def setup_query(): threshold=1, debug_locks=self._debug_locks, ) - failure_reason = ConnectionFailureReason.NO_FAILURE while retry < MAX_RETRIES: try: await query_backoff.wait_for_backoff() @@ -294,11 +282,9 @@ async def setup_query(): response.raise_for_status() continue response.raise_for_status() - failure_reason = ConnectionFailureReason.NO_FAILURE break except ClientResponseError: self._handle_http_errors(return_value) - return (return_value[0], return_value[1], return_value[2]) except ( ClientConnectorError, ServerTimeoutError, @@ -312,12 +298,12 @@ async def setup_query(): url, exc_info=True, ) - failure_reason = self._handle_network_errors(ex) + if retry == MAX_RETRIES: + self._handle_network_errors(ex) continue - if failure_reason != ConnectionFailureReason.NO_FAILURE: - LOG.debug("Exceeded max retries of %d, giving up", MAX_RETRIES) - self._update_connection_status(failure_reason) + # success + self._connection_status.get_backoff().reset_backoff() return (return_value[0], return_value[1], return_value[2]) async def query_orb(self, level: int, error_message: str) -> BeautifulSoup | None: @@ -329,6 +315,11 @@ async def query_orb(self, level: int, error_message: str) -> BeautifulSoup | Non Returns: Optional[BeautifulSoup]: A Beautiful Soup object, or None if failure + + Raises: + PulseClientConnectionError: If the client cannot connect + PulseServerConnectionError: If there is a server error + PulseServiceTemporarilyUnavailableError: If the server returns a Retry-After header """ code, response, url = await self.async_query( ADT_ORB_URI, @@ -379,8 +370,7 @@ async def async_fetch_version(self) -> None: ex.args, exc_info=True, ) - self._update_connection_status(self._handle_network_errors(ex)) - return + self._handle_network_errors(ex) version = self._connection_properties.get_api_version(str(response_values[2])) if version is not None: self._connection_properties.api_version = version @@ -389,9 +379,3 @@ async def async_fetch_version(self) -> None: self._connection_properties.api_version, self._connection_properties.service_host, ) - if ( - self._connection_status.connection_failure_reason - != ConnectionFailureReason.NO_FAILURE - ): - self._update_connection_status(ConnectionFailureReason.NO_FAILURE) - return diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index cf88cb7..a6472f8 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -3,7 +3,6 @@ import asyncio import re import time -from datetime import datetime from random import randint from warnings import warn @@ -22,6 +21,15 @@ ADT_TIMEOUT_URI, DEFAULT_API_HOST, ) +from .exceptions import ( + PulseAccountLockedError, + PulseAuthenticationError, + PulseClientConnectionError, + PulseGatewayOfflineError, + PulseMFARequiredError, + PulseServerConnectionError, + PulseServiceTemporarilyUnavailableError, +) from .pulse_authentication_properties import PulseAuthenticationProperties from .pulse_connection import PulseConnection from .pulse_connection_properties import PulseConnectionProperties @@ -50,6 +58,7 @@ class PyADTPulseAsync: "_pulse_connection_status", "_site", "_detailed_debug_logging", + "_sync_check_exception", ) @typechecked @@ -117,6 +126,7 @@ def __init__( self._timeout_task: asyncio.Task | None = None self._site: ADTPulseSite | None = None self._detailed_debug_logging = detailed_debug_logging + self._sync_check_exception: Exception | None = None def __repr__(self) -> str: """Object representation.""" @@ -139,6 +149,9 @@ async def _initialize_sites(self, soup: BeautifulSoup) -> None: Args: soup (BeautifulSoup): The parsed HTML soup object. + + Raises: + PulseGatewayOfflineError: if the gateway is offline """ # typically, ADT Pulse accounts have only a single site (premise/location) single_premise = soup.find("span", {"id": "p_singlePremise"}) @@ -202,6 +215,10 @@ def _get_sync_task_name(self) -> str: def _get_timeout_task_name(self) -> str: return self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) + def _set_sync_check_exception(self, e: Exception) -> None: + self._sync_check_exception = e + self._pulse_properties.updates_exist.set() + async def _keepalive_task(self) -> None: """ Asynchronous function that runs a keepalive task to maintain the connection @@ -240,10 +257,25 @@ def should_relogin(relogin_interval: int) -> bool: continue elif should_relogin(relogin_interval): await self.async_logout() - await self._login_looped(task_name) + try: + await self._login_looped(task_name) + except (PulseAuthenticationError, PulseMFARequiredError) as ex: + LOG.error("%s task exiting due to %s", task_name, ex.args[0]) + return continue LOG.debug("Resetting timeout") - code, response, url = await reset_pulse_cloud_timeout() + try: + code, response, url = await reset_pulse_cloud_timeout() + except ( + PulseServiceTemporarilyUnavailableError, + PulseClientConnectionError, + PulseServerConnectionError, + ) as ex: + LOG.debug( + "Could not reset ADT Pulse cloud timeout due to %s, skipping", + ex.args[0], + ) + continue if ( not handle_response( code, @@ -286,15 +318,39 @@ async def _login_looped(self, task_name: str) -> None: Returns: None """ + count = 0 log_level = logging.DEBUG login_successful = False while not login_successful: + count += 1 + if count > 5: + log_level = logging.WARNING LOG.log(log_level, "%s performming loop login", task_name) - login_successful = await self.async_login() + try: + login_successful = await self.async_login() + except ( + PulseClientConnectionError, + PulseServerConnectionError, + PulseServiceTemporarilyUnavailableError, + PulseAccountLockedError, + ) as ex: + LOG.log( + log_level, + "loop login in task %s received exception %s, retrying", + task_name, + ex.args[0], + ) + if ( + log_level == logging.WARNING + and self._sync_check_exception is None + or self._sync_check_exception != ex + ): + self._set_sync_check_exception(ex) + login_successful = False + continue if login_successful: return - self._pulse_properties.set_update_status(False) async def _sync_check_task(self) -> None: """Asynchronous function that performs a synchronization check task.""" @@ -322,7 +378,6 @@ async def validate_sync_check_response() -> bool: bool: True if the sync check response is valid, False otherwise. """ if not handle_response(code, url, logging.ERROR, "Error querying ADT sync"): - self._pulse_properties.set_update_status(False) return False # this should have already been handled if response_text is None: @@ -342,9 +397,20 @@ async def validate_sync_check_response() -> bool: async def handle_no_updates_exist() -> bool: if last_sync_check_was_different: - if await self.async_update() is False: - LOG.debug("Pulse data update from %s failed", task_name) + try: + success = await self.async_update() + except PulseGatewayOfflineError as e: + if self._sync_check_exception != e: + LOG.debug( + "Pulse gateway offline, update failed in task %s", task_name + ) + self._set_sync_check_exception(e) + return False + if not success: + LOG.debug("Pulse data update failed in task %s", task_name) return False + + self._sync_check_exception = None self._pulse_properties.updates_exist.set() return True else: @@ -361,27 +427,32 @@ def handle_updates_exist() -> bool: return True return False + def reset_sync_check_exception() -> None: + self._sync_check_exception = None + while True: try: - self.site.gateway.adjust_backoff_poll_interval() + await self.site.gateway.backoff.wait_for_backoff() pi = ( self.site.gateway.poll_interval if not last_sync_check_was_different else 0.0 ) - retry_after = self._pulse_connection_status.retry_after - if retry_after > time.time(): - LOG.debug( - "%s: Waiting for retry after %s", - task_name, - datetime.fromtimestamp(retry_after), - ) - self._pulse_properties.set_update_status(False) - await asyncio.sleep(retry_after - time.time()) + if self._pulse_connection_status.get_backoff().will_backoff(): + await self._pulse_connection_status.get_backoff().wait_for_backoff() + elif pi > 0.0: + await asyncio.sleep(pi) + + try: + code, response_text, url = await perform_sync_check_query() + except ( + PulseClientConnectionError, + PulseServerConnectionError, + PulseServiceTemporarilyUnavailableError, + ) as e: + self._set_sync_check_exception(e) continue - await asyncio.sleep(pi) - - code, response_text, url = await perform_sync_check_query() + reset_sync_check_exception() if not handle_response( code, url, logging.WARNING, "Error querying ADT sync" ): @@ -389,8 +460,16 @@ def handle_updates_exist() -> bool: if response_text is None: LOG.warning("Sync check received no response from ADT Pulse site") continue - if not await validate_sync_check_response(): - continue + try: + await validate_sync_check_response() + except (PulseAuthenticationError, PulseMFARequiredError) as ex: + self._set_sync_check_exception(ex) + LOG.error( + "Task %s exiting due to error reloging into Pulse: %s", + task_name, + ex.args[0], + ) + return if handle_updates_exist(): last_sync_check_was_different = True last_sync_text = response_text @@ -406,6 +485,14 @@ async def async_login(self) -> bool: """Login asynchronously to ADT. Returns: True if login successful + + Raises: + PulseClientConnectionError: if client connection fails + PulseServerConnectionError: if server connection fails + PulseServiceTemporarilyUnavailableError: if server returns a Retry-After header + PulseAuthenticationError: if authentication fails + PulseAccountLockedError: if account is locked + PulseMFARequiredError: if MFA is required """ if self._pulse_connection.login_in_progress: LOG.debug("Login already in progress, returning") @@ -415,7 +502,6 @@ async def async_login(self) -> bool: self._authentication_properties.username, ) await self._pulse_connection.async_fetch_version() - soup = await self._pulse_connection.async_do_login_query() if soup is None: return False @@ -455,6 +541,9 @@ async def async_update(self) -> bool: Returns: bool: True if update succeeded. + + Raises: + PulseGatewayOfflineError: if the gateway is offline """ LOG.debug("Checking ADT Pulse cloud service for updates") @@ -468,7 +557,7 @@ async def async_update(self) -> bool: return False - async def wait_for_update(self) -> bool: + async def wait_for_update(self) -> None: """Wait for update. Blocks current async task until Pulse system @@ -482,11 +571,10 @@ async def wait_for_update(self) -> bool: coro, name=f"{SYNC_CHECK_TASK_NAME}: Async session" ) await asyncio.sleep(0) - if self._pulse_properties.updates_exist is None: - raise RuntimeError("Update event does not exist") await self._pulse_properties.updates_exist.wait() - return self._pulse_properties.check_update_succeeded() + if self._sync_check_exception: + raise self._sync_check_exception @property def sites(self) -> list[ADTPulseSite]: diff --git a/pyadtpulse/pyadtpulse_properties.py b/pyadtpulse/pyadtpulse_properties.py index 99d9d97..4a82119 100644 --- a/pyadtpulse/pyadtpulse_properties.py +++ b/pyadtpulse/pyadtpulse_properties.py @@ -26,7 +26,6 @@ class PyADTPulseProperties: "_login_exception", "_relogin_interval", "_keepalive_interval", - "_update_succeded", "_detailed_debug_logging", "_site", ) @@ -77,7 +76,6 @@ def __init__( self.keepalive_interval = keepalive_interval self.relogin_interval = relogin_interval self._detailed_debug_logging = detailed_debug_logging - self._update_succeded = True @property def relogin_interval(self) -> int: @@ -161,10 +159,9 @@ def site(self) -> ADTPulseSite: ) return self._site - def set_update_status(self, value: bool) -> None: - """Sets update failed, sets updates_exist to notify wait_for_update.""" + def set_update_status(self) -> None: + """Sets updates_exist to notify wait_for_update.""" with self._pp_attribute_lock: - self._update_succeded = value self.updates_exist.set() @property @@ -172,14 +169,3 @@ def updates_exist(self) -> asyncio.locks.Event: """Check if updates exist.""" with self._pp_attribute_lock: return self._updates_exist - - def check_update_succeeded(self) -> bool: - """Check if update succeeded, clears the update event and - resets _update_succeeded. - """ - with self._pp_attribute_lock: - old_update_succeded = self._update_succeded - self._update_succeded = True - if self.updates_exist.is_set(): - self.updates_exist.clear() - return old_update_succeded diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 75febbf..7bdc7b6 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -9,6 +9,12 @@ from typeguard import typechecked from .const import ADT_DEVICE_URI, ADT_GATEWAY_STRING, ADT_GATEWAY_URI, ADT_SYSTEM_URI +from .exceptions import ( + PulseClientConnectionError, + PulseGatewayOfflineError, + PulseServerConnectionError, + PulseServiceTemporarilyUnavailableError, +) from .pulse_connection import PulseConnection from .site_properties import ADTPulseSiteProperties from .util import make_soup, parse_pulse_datetime, remove_prefix @@ -263,6 +269,9 @@ async def _async_update_zones_as_dict( Returns: ADTPulseZones: a dictionary of zones with status None if an error occurred + + Raises: + PulseGatewayOffline: If the gateway is offline. """ with self._site_lock: if self._zones is None: @@ -271,14 +280,25 @@ async def _async_update_zones_as_dict( LOG.debug("fetching zones for site %s", self._id) if not soup: # call ADT orb uri - soup = await self._pulse_connection.query_orb( - logging.WARNING, "Could not fetch zone status updates" - ) + try: + soup = await self._pulse_connection.query_orb( + logging.WARNING, "Could not fetch zone status updates" + ) + except ( + PulseServiceTemporarilyUnavailableError, + PulseServerConnectionError, + PulseClientConnectionError, + ) as ex: + LOG.warning( + "Could not fetch zone status updates from orb: %s", ex.args[0] + ) + return None if soup is None: return None - return self.update_zone_from_soup(soup) + self.update_zone_from_soup(soup) + return self._zones - def update_zone_from_soup(self, soup: BeautifulSoup) -> ADTPulseZones | None: + def update_zone_from_soup(self, soup: BeautifulSoup) -> None: """ Updates the zone information based on the provided BeautifulSoup object. @@ -286,8 +306,10 @@ def update_zone_from_soup(self, soup: BeautifulSoup) -> ADTPulseZones | None: soup (BeautifulSoup): The BeautifulSoup object containing the parsed HTML. Returns: - Optional[ADTPulseZones]: The updated ADTPulseZones object, or None if - no zones exist. + None + + Raises: + PulseGatewayOffline: If the gateway is offline. """ # parse ADT's convulated html to get sensor status with self._site_lock: @@ -369,7 +391,13 @@ def update_zone_from_soup(self, soup: BeautifulSoup) -> ADTPulseZones | None: ) self._gateway.is_online = gateway_online self._last_updated = int(time()) - return self._zones + if not gateway_online: + LOG.warning("Gateway is offline") + raise PulseGatewayOfflineError( + "Gateway is offline", self._gateway.backoff + ) + else: + self._gateway.backoff.reset_backoff() async def _async_update_zones(self) -> list[ADTPulseFlattendZone] | None: """Update zones asynchronously. From 98452b6f59e46ebd1008996a91d650e6b7b6c566 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Wed, 20 Dec 2023 04:25:56 -0500 Subject: [PATCH 148/226] fixes for new exception handling --- example-client.py | 103 ++++++++++++++------------------- pyadtpulse/__init__.py | 18 ++++-- pyadtpulse/pyadtpulse_async.py | 8 +-- pyadtpulse/util.py | 12 ---- 4 files changed, 58 insertions(+), 83 deletions(-) diff --git a/example-client.py b/example-client.py index 711221c..3a4095c 100755 --- a/example-client.py +++ b/example-client.py @@ -17,8 +17,8 @@ API_HOST_CA, DEFAULT_API_HOST, ) +from pyadtpulse.exceptions import PulseAuthenticationError from pyadtpulse.site import ADTPulseSite -from pyadtpulse.util import AuthenticationException USER = "adtpulse_user" PASSWD = "adtpulse_password" @@ -396,7 +396,7 @@ def sync_example( relogin_interval=relogin_interval, detailed_debug_logging=detailed_debug_logging, ) - except AuthenticationException: + except PulseAuthenticationError: print("Invalid credentials for ADT Pulse site") sys.exit() except BaseException as e: @@ -474,20 +474,13 @@ async def async_test_alarm(adt: PyADTPulse) -> None: "FAIL: Arming home pending check failed " f"{adt.site.alarm_control_panel} " ) - if await adt.wait_for_update(): - if adt.site.alarm_control_panel.is_home: - print("Arm stay no longer pending") - else: - while not adt.site.alarm_control_panel.is_home: - pprint( - f"FAIL: Arm stay value incorrect {adt.site.alarm_control_panel}" - ) - if not await adt.wait_for_update(): - print("ERROR: Alarm update failed") - break + await adt.wait_for_update() + if adt.site.alarm_control_panel.is_home: + print("Arm stay no longer pending") else: - print("ERROR: Alarm update failed") - + while not adt.site.alarm_control_panel.is_home: + pprint(f"FAIL: Arm stay value incorrect {adt.site.alarm_control_panel}") + await adt.wait_for_update() print("Testing invalid alarm state change from armed home to armed away") if await adt.site.async_arm_away(): print( @@ -516,19 +509,17 @@ async def async_test_alarm(adt: PyADTPulse) -> None: print("Disarm pending success") else: pprint(f"FAIL: Disarm pending fail {adt.site.alarm_control_panel}") - if await adt.wait_for_update(): - if adt.site.alarm_control_panel.is_disarmed: - print("Success update to disarm") - else: - while not adt.site.alarm_control_panel.is_disarmed: - pprint( - "FAIL: did not set to disarm after update " - f"{adt.site.alarm_control_panel}" - ) - if not await adt.wait_for_update(): - print("ERROR: Alarm update failed") - break - print("Test finally succeeded") + await adt.wait_for_update() + if adt.site.alarm_control_panel.is_disarmed: + print("Success update to disarm") + else: + while not adt.site.alarm_control_panel.is_disarmed: + pprint( + "FAIL: did not set to disarm after update " + f"{adt.site.alarm_control_panel}" + ) + await adt.wait_for_update() + print("Test finally succeeded") print("Testing disarming twice") if await adt.site.async_disarm(): print("Double disarm call succeeded") @@ -541,21 +532,17 @@ async def async_test_alarm(adt: PyADTPulse) -> None: "FAIL: Double disarm state is not disarming " f"{adt.site.alarm_control_panel}" ) - if await adt.wait_for_update(): - if adt.site.alarm_control_panel.is_disarmed: - print("Double disarm success") - else: - while not adt.site.alarm_control_panel.is_disarmed: - pprint( - "FAIL: Double disarm state is not disarmed " - f"{adt.site.alarm_control_panel}" - ) - if not await adt.wait_for_update(): - print("ERROR: Alarm update failed") - break - print("Test finally succeeded") + await adt.wait_for_update() + if adt.site.alarm_control_panel.is_disarmed: + print("Double disarm success") else: - print("ERROR: Alarm update failed") + while not adt.site.alarm_control_panel.is_disarmed: + pprint( + "FAIL: Double disarm state is not disarmed " + f"{adt.site.alarm_control_panel}" + ) + await adt.wait_for_update() + print("Test finally succeeded") else: print("Disarming failed") print("Arming alarm away") @@ -565,21 +552,17 @@ async def async_test_alarm(adt: PyADTPulse) -> None: print("Arm away arm pending") else: pprint(f"FAIL: arm away call not pending {adt.site.alarm_control_panel}") - if await adt.wait_for_update(): - if adt.site.alarm_control_panel.is_away: - print("Arm away call after update succeed") - else: - while not adt.site.alarm_control_panel.is_away: - pprint( - "FAIL: arm away call after update failed " - "f{adt.site.alarm_control_panel}" - ) - if not await adt.wait_for_update(): - print("ERROR: Alarm update failed") - break - print("Test finally succeeded") + await adt.wait_for_update() + if adt.site.alarm_control_panel.is_away: + print("Arm away call after update succeed") else: - print("ERROR: Alarm update failed") + while not adt.site.alarm_control_panel.is_away: + pprint( + "FAIL: arm away call after update failed " + "f{adt.site.alarm_control_panel}" + ) + await adt.wait_for_update() + print("Test finally succeeded") else: print("Arm away failed") await adt.site.async_disarm() @@ -656,11 +639,9 @@ async def async_example( break print("\nZones:") pprint(adt.site.zones, compact=True) - if await adt.wait_for_update(): - print("Updates exist, refreshing") - # no need to call an update method - else: - print("Warning, update failed, retrying") + await adt.wait_for_update() + print("Updates exist, refreshing") + # no need to call an update method except KeyboardInterrupt: print("exiting...") done = True diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 534bcbf..f40647e 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -15,7 +15,7 @@ DEFAULT_API_HOST, ) from .pyadtpulse_async import SYNC_CHECK_TASK_NAME, PyADTPulseAsync -from .util import AuthenticationException, DebugRLock, set_debug_lock +from .util import DebugRLock, set_debug_lock LOG = logging.getLogger(__name__) @@ -23,7 +23,7 @@ class PyADTPulse(PyADTPulseAsync): """Base object for ADT Pulse service.""" - __slots__ = ("_session_thread", "_p_attribute_lock") + __slots__ = ("_session_thread", "_p_attribute_lock", "_login_exception") def __init__( self, @@ -55,6 +55,7 @@ def __init__( detailed_debug_logging, ) self._session_thread: Thread | None = None + self._login_exception: Exception | None = None if do_login and websession is None: self.login() @@ -108,8 +109,14 @@ async def _sync_loop(self) -> None: the `asyncio.sleep` function. This wait allows the logout process to complete before continuing with the synchronization logic. """ - result = await self.async_login() + result = False + try: + result = await self.async_login() + except Exception as e: + self._login_exception = e self._p_attribute_lock.release() + if self._login_exception is not None: + return if result: if self._timeout_task is not None: task_list = (self._timeout_task,) @@ -132,7 +139,7 @@ def login(self) -> None: """Login to ADT Pulse and generate access token. Raises: - AuthenticationException if could not login + Exception from async_login """ self._p_attribute_lock.acquire() # probably shouldn't be a daemon thread @@ -152,7 +159,8 @@ def login(self) -> None: self._p_attribute_lock.acquire() self._p_attribute_lock.release() if not thread.is_alive(): - raise AuthenticationException(self._authentication_properties.username) + if self._login_exception is not None: + raise self._login_exception def logout(self) -> None: """Log out of ADT Pulse.""" diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index a6472f8..cdd0792 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -427,9 +427,6 @@ def handle_updates_exist() -> bool: return True return False - def reset_sync_check_exception() -> None: - self._sync_check_exception = None - while True: try: await self.site.gateway.backoff.wait_for_backoff() @@ -452,7 +449,6 @@ def reset_sync_check_exception() -> None: ) as e: self._set_sync_check_exception(e) continue - reset_sync_check_exception() if not handle_response( code, url, logging.WARNING, "Error querying ADT sync" ): @@ -461,7 +457,8 @@ def reset_sync_check_exception() -> None: LOG.warning("Sync check received no response from ADT Pulse site") continue try: - await validate_sync_check_response() + if not await validate_sync_check_response(): + continue except (PulseAuthenticationError, PulseMFARequiredError) as ex: self._set_sync_check_exception(ex) LOG.error( @@ -573,6 +570,7 @@ async def wait_for_update(self) -> None: await asyncio.sleep(0) await self._pulse_properties.updates_exist.wait() + self._pulse_properties.updates_exist.clear() if self._sync_check_exception: raise self._sync_check_exception diff --git a/pyadtpulse/util.py b/pyadtpulse/util.py index 63c2799..e478870 100644 --- a/pyadtpulse/util.py +++ b/pyadtpulse/util.py @@ -245,15 +245,3 @@ def set_debug_lock(debug_lock: bool, name: str) -> "RLock | DebugRLock": if debug_lock: return DebugRLock(name) return RLock() - - -class AuthenticationException(RuntimeError): - """Raised when a login failed.""" - - def __init__(self, username: str): - """Create the exception. - - Args: - username (str): Username used to login - """ - super().__init__(f"Could not log into ADT site with username {username}") From 4b5dad3454383125275e32444459f56a13f25957 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Wed, 20 Dec 2023 04:59:03 -0500 Subject: [PATCH 149/226] update tests for exceptions --- tests/test_pulse_connection.py | 103 +++++++----------------------- tests/test_pulse_query_manager.py | 66 ++++++++----------- 2 files changed, 51 insertions(+), 118 deletions(-) diff --git a/tests/test_pulse_connection.py b/tests/test_pulse_connection.py index c794305..3b84dd6 100644 --- a/tests/test_pulse_connection.py +++ b/tests/test_pulse_connection.py @@ -10,7 +10,12 @@ ADT_MFA_FAIL_URI, ADT_SUMMARY_URI, DEFAULT_API_HOST, - ConnectionFailureReason, +) +from pyadtpulse.exceptions import ( + PulseAccountLockedError, + PulseAuthenticationError, + PulseMFARequiredError, + PulseServerConnectionError, ) from pyadtpulse.pulse_authentication_properties import PulseAuthenticationProperties from pyadtpulse.pulse_connection import PulseConnection @@ -40,10 +45,6 @@ async def test_login(mocked_server_responses, get_mocked_url, read_file, mock_sl assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 assert pc._connection_status.authenticated_flag.is_set() - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.NO_FAILURE - ) await pc.async_do_logout_query() assert not pc._connection_status.authenticated_flag.is_set() assert mock_sleep.call_count == 0 @@ -53,14 +54,10 @@ async def test_login(mocked_server_responses, get_mocked_url, read_file, mock_sl @pytest.mark.asyncio async def test_login_failure_server_down(mock_server_down): pc = setup_pulse_connection() - result = await pc.async_do_login_query() - assert result is None + with pytest.raises(PulseServerConnectionError): + await pc.async_do_login_query() assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.SERVER_ERROR - ) @pytest.mark.asyncio @@ -76,10 +73,6 @@ async def test_multiple_login( assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 assert pc._connection_status.authenticated_flag.is_set() - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.NO_FAILURE - ) mocked_server_responses.post( get_mocked_url(ADT_LOGIN_URI), status=302, @@ -93,23 +86,17 @@ async def test_multiple_login( assert pc._login_backoff.backoff_count == 0 assert pc._connection_status.get_backoff().backoff_count == 0 assert pc._connection_status.authenticated_flag.is_set() - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.NO_FAILURE - ) # this should fail - await pc.async_do_login_query() + with pytest.raises(PulseServerConnectionError): + await pc.async_do_login_query() assert mock_sleep.call_count == MAX_RETRIES - 1 assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 assert pc._connection_status.get_backoff().backoff_count == 1 assert not pc._connection_status.authenticated_flag.is_set() assert not pc.is_connected - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.SERVER_ERROR - ) - await pc.async_do_login_query() + with pytest.raises(PulseServerConnectionError): + await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 0 # 2 retries first time, 3 the second assert mock_sleep.call_count == MAX_RETRIES - 1 + MAX_RETRIES @@ -118,10 +105,6 @@ async def test_multiple_login( assert pc._connection_status.get_backoff().backoff_count == 2 assert not pc._connection_status.authenticated_flag.is_set() assert not pc.is_connected - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.SERVER_ERROR - ) mocked_server_responses.post( get_mocked_url(ADT_LOGIN_URI), status=302, @@ -135,10 +118,6 @@ async def test_multiple_login( assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 assert pc._connection_status.authenticated_flag.is_set() - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.NO_FAILURE - ) mocked_server_responses.post( get_mocked_url(ADT_LOGIN_URI), @@ -153,10 +132,6 @@ async def test_multiple_login( assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 assert pc._connection_status.authenticated_flag.is_set() - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.NO_FAILURE - ) @pytest.mark.asyncio @@ -174,11 +149,8 @@ async def test_account_lockout( mocked_server_responses.post( get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("signin_locked.html") ) - await pc.async_do_login_query() - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.ACCOUNT_LOCKED - ) + with pytest.raises(PulseAccountLockedError): + await pc.async_do_login_query() # won't sleep yet assert not pc.is_connected assert not pc._connection_status.authenticated_flag.is_set() @@ -193,10 +165,6 @@ async def test_account_lockout( }, ) await pc.async_do_login_query() - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.NO_FAILURE - ) assert mock_sleep.call_count == 1 assert mock_sleep.call_args_list[0][0][0] == 60 * 30 assert pc.is_connected @@ -205,11 +173,8 @@ async def test_account_lockout( mocked_server_responses.post( get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("signin_locked.html") ) - await pc.async_do_login_query() - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.ACCOUNT_LOCKED - ) + with pytest.raises(PulseAccountLockedError): + await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 0 assert mock_sleep.call_count == 1 @@ -227,21 +192,15 @@ async def test_invalid_credentials( mocked_server_responses.post( get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("signin_fail.html") ) - await pc.async_do_login_query() - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.INVALID_CREDENTIALS - ) + with pytest.raises(PulseAuthenticationError): + await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 1 assert mock_sleep.call_count == 0 mocked_server_responses.post( get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("signin_fail.html") ) - await pc.async_do_login_query() - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.INVALID_CREDENTIALS - ) + with pytest.raises(PulseAuthenticationError): + await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 2 assert mock_sleep.call_count == 1 mocked_server_responses.post( @@ -252,10 +211,6 @@ async def test_invalid_credentials( }, ) await pc.async_do_login_query() - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.NO_FAILURE - ) assert pc._login_backoff.backoff_count == 0 assert mock_sleep.call_count == 2 @@ -275,11 +230,8 @@ async def test_mfa_failure( status=307, headers={"Location": get_mocked_url(ADT_MFA_FAIL_URI)}, ) - await pc.async_do_login_query() - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.MFA_REQUIRED - ) + with pytest.raises(PulseMFARequiredError): + await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 1 assert mock_sleep.call_count == 0 mocked_server_responses.post( @@ -287,11 +239,8 @@ async def test_mfa_failure( status=307, headers={"Location": get_mocked_url(ADT_MFA_FAIL_URI)}, ) - await pc.async_do_login_query() - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.MFA_REQUIRED - ) + with pytest.raises(PulseMFARequiredError): + await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 2 assert mock_sleep.call_count == 1 mocked_server_responses.post( @@ -302,10 +251,6 @@ async def test_mfa_failure( }, ) await pc.async_do_login_query() - assert ( - pc._connection_status.connection_failure_reason - == ConnectionFailureReason.NO_FAILURE - ) assert pc._login_backoff.backoff_count == 0 assert mock_sleep.call_count == 2 diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index 3fd4a77..78dfd0b 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -9,7 +9,12 @@ from bs4 import BeautifulSoup from conftest import MOCKED_API_VERSION -from pyadtpulse.const import ADT_ORB_URI, DEFAULT_API_HOST, ConnectionFailureReason +from pyadtpulse.const import ADT_ORB_URI, DEFAULT_API_HOST +from pyadtpulse.exceptions import ( + PulseClientConnectionError, + PulseServerConnectionError, + PulseServiceTemporarilyUnavailableError, +) from pyadtpulse.pulse_connection_properties import PulseConnectionProperties from pyadtpulse.pulse_connection_status import PulseConnectionStatus from pyadtpulse.pulse_query_manager import MAX_RETRIES, PulseQueryManager @@ -31,12 +36,11 @@ async def test_fetch_version_fail(mock_server_down): s = PulseConnectionStatus() cp = PulseConnectionProperties(DEFAULT_API_HOST) p = PulseQueryManager(s, cp) - await p.async_fetch_version() - assert s.connection_failure_reason == ConnectionFailureReason.SERVER_ERROR + with pytest.raises(PulseServerConnectionError): + await p.async_fetch_version() assert s.get_backoff().backoff_count == 1 with pytest.raises(ValueError): await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert s.connection_failure_reason == ConnectionFailureReason.SERVER_ERROR assert s.get_backoff().backoff_count == 2 assert s.get_backoff().get_current_backoff_interval() == 2.0 @@ -47,16 +51,14 @@ async def test_fetch_version_eventually_succeeds(mock_server_temporarily_down): s = PulseConnectionStatus() cp = PulseConnectionProperties(DEFAULT_API_HOST) p = PulseQueryManager(s, cp) - await p.async_fetch_version() - assert s.connection_failure_reason == ConnectionFailureReason.SERVER_ERROR + with pytest.raises(PulseServerConnectionError): + await p.async_fetch_version() assert s.get_backoff().backoff_count == 1 with pytest.raises(ValueError): await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert s.connection_failure_reason == ConnectionFailureReason.SERVER_ERROR assert s.get_backoff().backoff_count == 2 assert s.get_backoff().get_current_backoff_interval() == 2.0 await p.async_fetch_version() - assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE assert s.get_backoff().backoff_count == 0 @@ -88,10 +90,9 @@ async def query_orb_task(): assert task.result() == BeautifulSoup(orb_file, "html.parser") assert mock_sleep.call_count == 1 # from the asyncio.sleep call above mocked_server_responses.get(cp.make_url(ADT_ORB_URI), status=404) - result = await query_orb_task() - assert result is None + with pytest.raises(PulseServerConnectionError): + result = await query_orb_task() assert mock_sleep.call_count == 1 - assert s.connection_failure_reason == ConnectionFailureReason.SERVER_ERROR assert s.get_backoff().backoff_count == 1 mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=200, content_type="text/html", body=orb_file @@ -99,7 +100,6 @@ async def query_orb_task(): result = await query_orb_task() assert result == BeautifulSoup(orb_file, "html.parser") assert mock_sleep.call_count == 2 - assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE @pytest.mark.asyncio @@ -124,8 +124,8 @@ async def test_retry_after( status=429, headers={"Retry-After": str(retry_after_time)}, ) - await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert s.connection_failure_reason == ConnectionFailureReason.TOO_MANY_REQUESTS + with pytest.raises(PulseServiceTemporarilyUnavailableError): + await p.async_query(ADT_ORB_URI, requires_authentication=False) assert mock_sleep.call_count == 0 # make sure we can't override the retry s.get_backoff().reset_backoff() @@ -135,7 +135,6 @@ async def test_retry_after( status=200, ) await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE assert mock_sleep.call_count == 1 mock_sleep.assert_called_once_with(float(retry_after_time)) frozen_time.tick(timedelta(seconds=retry_after_time + 1)) @@ -144,7 +143,6 @@ async def test_retry_after( status=200, ) await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE # shouldn't sleep since past expiration time assert mock_sleep.call_count == 1 frozen_time.tick(timedelta(seconds=1)) @@ -162,14 +160,13 @@ async def test_retry_after( status=503, headers={"Retry-After": retry_date_str}, ) - await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert s.connection_failure_reason == ConnectionFailureReason.SERVICE_UNAVAILABLE + with pytest.raises(PulseServiceTemporarilyUnavailableError): + await p.async_query(ADT_ORB_URI, requires_authentication=False) mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=200, ) await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE assert mock_sleep.call_count == 2 assert mock_sleep.call_args_list[1][0][0] == new_retry_after frozen_time.tick(timedelta(seconds=retry_after_time + 1)) @@ -178,14 +175,13 @@ async def test_retry_after( cp.make_url(ADT_ORB_URI), status=503, ) - await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert s.connection_failure_reason == ConnectionFailureReason.SERVICE_UNAVAILABLE + with pytest.raises(PulseServiceTemporarilyUnavailableError): + await p.async_query(ADT_ORB_URI, requires_authentication=False) mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=200, ) await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE assert mock_sleep.call_count == 2 # retry after in the past mocked_server_responses.get( @@ -193,14 +189,13 @@ async def test_retry_after( status=503, headers={"Retry-After": retry_date_str}, ) - await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert s.connection_failure_reason == ConnectionFailureReason.SERVICE_UNAVAILABLE + with pytest.raises(PulseServiceTemporarilyUnavailableError): + await p.async_query(ADT_ORB_URI, requires_authentication=False) mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=200, ) await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE assert mock_sleep.call_count == 2 @@ -226,7 +221,6 @@ async def test_async_query_exceptions( assert ( mock_sleep.call_args_list[0][0][0] == s.get_backoff().initial_backoff_interval ) - assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE assert s.get_backoff().backoff_count == 0 mocked_server_responses.get( cp.make_url(ADT_ORB_URI), @@ -234,7 +228,6 @@ async def test_async_query_exceptions( ) await p.async_query(ADT_ORB_URI, requires_authentication=False) assert mock_sleep.call_count == 1 - assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE assert s.get_backoff().backoff_count == 0 query_backoff = s.get_backoff().initial_backoff_interval # need to do ClientConnectorError, but it requires initialization @@ -251,9 +244,9 @@ async def test_async_query_exceptions( client_exceptions.ClientError, client_exceptions.ClientOSError, ): - error_type = ConnectionFailureReason.CLIENT_ERROR + error_type = PulseClientConnectionError else: - error_type = ConnectionFailureReason.SERVER_ERROR + error_type = PulseServerConnectionError for _ in range(MAX_RETRIES + 1): mocked_server_responses.get( cp.make_url(ADT_ORB_URI), @@ -263,11 +256,11 @@ async def test_async_query_exceptions( cp.make_url(ADT_ORB_URI), status=200, ) - result = await p.async_query( - ADT_ORB_URI, - requires_authentication=False, - ) - assert not result[1] + with pytest.raises(error_type): + await p.async_query( + ADT_ORB_URI, + requires_authentication=False, + ) # only MAX_RETRIES - 1 sleeps since first call won't sleep assert ( mock_sleep.call_count == curr_sleep_count + MAX_RETRIES - 1 @@ -278,10 +271,6 @@ async def test_async_query_exceptions( i - curr_sleep_count ), f"Failure on exception sleep count {i} on exception {type(ex).__name__}" curr_sleep_count += MAX_RETRIES - 1 - assert ( - s.connection_failure_reason == error_type - ), f"Error type failure on exception {type(ex).__name__}" - assert ( s.get_backoff().backoff_count == 1 ), f"Failure on exception {type(ex).__name__}" @@ -298,7 +287,6 @@ async def test_async_query_exceptions( cp.make_url(ADT_ORB_URI), status=200, ) - assert s.connection_failure_reason == ConnectionFailureReason.NO_FAILURE # this shouldn't trigger a sleep await p.async_query(ADT_ORB_URI, requires_authentication=False) assert mock_sleep.call_count == curr_sleep_count From 7c841a06eac77b04500f18a4857e6f2c4c21fcb0 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Wed, 20 Dec 2023 05:16:02 -0500 Subject: [PATCH 150/226] fix sync updates_exist --- pyadtpulse/__init__.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index f40647e..ca837e9 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -212,7 +212,10 @@ def updates_exist(self) -> bool: self._sync_task = loop.create_task( coro, name=f"{SYNC_CHECK_TASK_NAME}: Sync session" ) - return self._pulse_properties.check_update_succeeded() + if self._pulse_properties.updates_exist.is_set(): + self._pulse_properties.updates_exist.clear() + return True + return False def update(self) -> bool: """Update ADT Pulse data. From c77e79a279bc31ad24801b51acd56c7be5018696 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Wed, 20 Dec 2023 05:48:09 -0500 Subject: [PATCH 151/226] remove websession parameter, add clear_session to pcp and call it on login --- pyadtpulse/__init__.py | 4 +--- pyadtpulse/pulse_connection.py | 1 + pyadtpulse/pulse_connection_properties.py | 16 ++++++++-------- pyadtpulse/pyadtpulse_async.py | 6 +----- 4 files changed, 11 insertions(+), 16 deletions(-) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index ca837e9..c8f3bbc 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -32,7 +32,6 @@ def __init__( fingerprint: str, service_host: str = DEFAULT_API_HOST, user_agent=ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"], - websession: ClientSession | None = None, do_login: bool = True, debug_locks: bool = False, keepalive_interval: int = ADT_DEFAULT_KEEPALIVE_INTERVAL, @@ -48,7 +47,6 @@ def __init__( fingerprint, service_host, user_agent, - websession, debug_locks, keepalive_interval, relogin_interval, @@ -56,7 +54,7 @@ def __init__( ) self._session_thread: Thread | None = None self._login_exception: Exception | None = None - if do_login and websession is None: + if do_login: self.login() def __repr__(self) -> str: diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 617d2bc..87a5fb3 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -178,6 +178,7 @@ def check_response( "fingerprint": self._authentication_properties.fingerprint, } await self._login_backoff.wait_for_backoff() + await self._connection_properties.clear_session() try: response = await self.async_query( ADT_LOGIN_URI, diff --git a/pyadtpulse/pulse_connection_properties.py b/pyadtpulse/pulse_connection_properties.py index d0976a9..305aa14 100644 --- a/pyadtpulse/pulse_connection_properties.py +++ b/pyadtpulse/pulse_connection_properties.py @@ -21,7 +21,6 @@ class PulseConnectionProperties: __slots__ = ( "_api_host", - "_allocated_session", "_session", "_loop", "_api_version", @@ -58,7 +57,6 @@ def get_api_version(response_path: str) -> str | None: def __init__( self, host: str, - session: ClientSession | None = None, user_agent=ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"], detailed_debug_logging=False, debug_locks=False, @@ -69,13 +67,8 @@ def __init__( ) self.debug_locks = debug_locks self.detailed_debug_logging = detailed_debug_logging - self._allocated_session = False self._loop: AbstractEventLoop | None = None - if session is None: - self._allocated_session = True - self._session = ClientSession() - else: - self._session = session + self._session = ClientSession() self.service_host = host self._api_version = "" self._session.headers.update(ADT_DEFAULT_HTTP_ACCEPT_HEADERS) @@ -221,3 +214,10 @@ def make_url(self, uri: str) -> str: """ with self._pci_attribute_lock: return f"{self._api_host}{API_PREFIX}{self._api_version}{uri}" + + async def clear_session(self): + """Clear the session.""" + with self._pci_attribute_lock: + if self._session is not None and not self._session.closed: + await self._session.close() + self._session = ClientSession() diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index cdd0792..ebd989b 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -6,7 +6,6 @@ from random import randint from warnings import warn -from aiohttp import ClientSession from bs4 import BeautifulSoup from typeguard import typechecked from yarl import URL @@ -69,7 +68,6 @@ def __init__( fingerprint: str, service_host: str = DEFAULT_API_HOST, user_agent=ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"], - websession: ClientSession | None = None, debug_locks: bool = False, keepalive_interval: int = ADT_DEFAULT_KEEPALIVE_INTERVAL, relogin_interval: int = ADT_DEFAULT_RELOGIN_INTERVAL, @@ -85,8 +83,6 @@ def __init__( https://portal-ca.adtpulse.com user_agent (str, optional): User Agent. Defaults to ADT_DEFAULT_HTTP_HEADERS["User-Agent"]. - websession (ClientSession, optional): an initialized - aiohttp.ClientSession to use, defaults to None debug_locks: (bool, optional): use debugging locks Defaults to False keepalive_interval (int, optional): number of minutes between @@ -101,7 +97,7 @@ def __init__( debug_locks, "pyadtpulse.pa_attribute_lock" ) self._pulse_connection_properties = PulseConnectionProperties( - service_host, websession, user_agent, detailed_debug_logging, debug_locks + service_host, user_agent, detailed_debug_logging, debug_locks ) self._authentication_properties = PulseAuthenticationProperties( username=username, From ad8b06a2d8f07b367a083c6dfca32d9b67c8e040 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Wed, 20 Dec 2023 06:00:21 -0500 Subject: [PATCH 152/226] allocate clientsession on demand --- pyadtpulse/pulse_connection_properties.py | 24 +++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/pyadtpulse/pulse_connection_properties.py b/pyadtpulse/pulse_connection_properties.py index 305aa14..482cd3e 100644 --- a/pyadtpulse/pulse_connection_properties.py +++ b/pyadtpulse/pulse_connection_properties.py @@ -22,6 +22,7 @@ class PulseConnectionProperties: __slots__ = ( "_api_host", "_session", + "_user_agent", "_loop", "_api_version", "_pci_attribute_lock", @@ -68,22 +69,22 @@ def __init__( self.debug_locks = debug_locks self.detailed_debug_logging = detailed_debug_logging self._loop: AbstractEventLoop | None = None - self._session = ClientSession() + self._session: ClientSession | None = None self.service_host = host self._api_version = "" - self._session.headers.update(ADT_DEFAULT_HTTP_ACCEPT_HEADERS) - self._session.headers.update(ADT_DEFAULT_SEC_FETCH_HEADERS) - self._session.headers.update({"User-Agent": user_agent}) + self._user_agent = user_agent def __del__(self): """Destructor for ADTPulseConnection.""" - if ( - getattr(self, "_allocated_session", False) - and getattr(self, "_session", None) is not None - and not self._session.closed - ): + if self._session is not None and not self._session.closed: self._session.detach() + def _set_headers(self) -> None: + if self._session is not None: + self._session.headers.update(ADT_DEFAULT_HTTP_ACCEPT_HEADERS) + self._session.headers.update(ADT_DEFAULT_SEC_FETCH_HEADERS) + self._session.headers.update({"User-Agent": self._user_agent}) + @property def service_host(self) -> str: """Get the service host.""" @@ -167,6 +168,9 @@ def loop(self, loop: AbstractEventLoop | None): def session(self) -> ClientSession: """Get the session.""" with self._pci_attribute_lock: + if self._session is None: + self._session = ClientSession() + self._set_headers() return self._session @property @@ -220,4 +224,4 @@ async def clear_session(self): with self._pci_attribute_lock: if self._session is not None and not self._session.closed: await self._session.close() - self._session = ClientSession() + self._session = None From 040600273287cae7048e2693b987f5e3376a0cef Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Thu, 21 Dec 2023 02:34:17 -0500 Subject: [PATCH 153/226] _handle_network_errors fix --- conftest.py | 5 ++--- pyadtpulse/pulse_query_manager.py | 10 +++++++--- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/conftest.py b/conftest.py index a1c394a..a90a133 100644 --- a/conftest.py +++ b/conftest.py @@ -58,10 +58,9 @@ def _read_file(file_name: str) -> str: @pytest.fixture -def mock_sleep(): +def mock_sleep(mocker): """Fixture to mock asyncio.sleep.""" - with patch("asyncio.sleep") as m: - yield m + return mocker.patch("asyncio.sleep", new_callable=AsyncMock) @pytest.fixture diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index c2b1eba..f40fabd 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -153,8 +153,8 @@ def _handle_http_errors( @typechecked def _handle_network_errors(self, e: Exception) -> None: - new_exception: PulseClientConnectionError | PulseServerConnectionError = ( - PulseClientConnectionError(str(e), self._connection_status.get_backoff()) + new_exception: PulseClientConnectionError | PulseServerConnectionError | None = ( + None ) if isinstance(e, (ServerConnectionError, ServerTimeoutError)): new_exception = PulseServerConnectionError( @@ -168,6 +168,10 @@ def _handle_network_errors(self, e: Exception) -> None: new_exception = PulseServerConnectionError( str(e), self._connection_status.get_backoff() ) + if not new_exception: + new_exception = PulseClientConnectionError( + str(e), self._connection_status.get_backoff() + ) raise new_exception @typechecked @@ -250,7 +254,7 @@ async def setup_query(): query_backoff = PulseBackoff( f"Query:{method} {uri}", self._connection_status.get_backoff().initial_backoff_interval, - threshold=1, + threshold=0, debug_locks=self._debug_locks, ) while retry < MAX_RETRIES: From fe5626d64e73ef717071284628518a533aec2435 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Thu, 21 Dec 2023 19:17:57 -0500 Subject: [PATCH 154/226] add PulseNotLoggedInError exception --- pyadtpulse/exceptions.py | 7 +++++++ pyadtpulse/pyadtpulse_async.py | 17 +++++++++++------ tests/test_pulse_async.py | 23 +++++++++++------------ 3 files changed, 29 insertions(+), 18 deletions(-) diff --git a/pyadtpulse/exceptions.py b/pyadtpulse/exceptions.py index 87d5455..d3deeac 100644 --- a/pyadtpulse/exceptions.py +++ b/pyadtpulse/exceptions.py @@ -55,3 +55,10 @@ class PulseGatewayOfflineError(ExceptionWithBackoff): class PulseMFARequiredError(ExceptionWithBackoff): """MFA required error.""" + + +class PulseNotLoggedInError(Exception): + """Exception to indicate that the application code is not logged in. + + Used for signalling waiters. + """ diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index ebd989b..71e1110 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -26,6 +26,7 @@ PulseClientConnectionError, PulseGatewayOfflineError, PulseMFARequiredError, + PulseNotLoggedInError, PulseServerConnectionError, PulseServiceTemporarilyUnavailableError, ) @@ -299,11 +300,15 @@ async def _cancel_task(self, task: asyncio.Task | None) -> None: return task_name = task.get_name() LOG.debug("cancelling %s", task_name) + task.cancel() try: - task.cancel() - except asyncio.CancelledError: - LOG.debug("%s successfully cancelled", task_name) await task + except asyncio.CancelledError: + pass + if task == self._sync_task: + e = PulseNotLoggedInError("Pulse logout has been called") + self._set_sync_check_exception(e) + LOG.debug("%s successfully cancelled", task_name) async def _login_looped(self, task_name: str) -> None: """ @@ -506,9 +511,7 @@ async def async_login(self) -> bool: LOG.error("Could not retrieve any sites, login failed") await self.async_logout() return False - - # since we received fresh data on the status of the alarm, go ahead - # and update the sites with the alarm status. + self._sync_check_exception = None self._timeout_task = asyncio.create_task( self._keepalive_task(), name=KEEPALIVE_TASK_NAME ) @@ -557,6 +560,8 @@ async def wait_for_update(self) -> None: signals an update FIXME?: This code probably won't work with multiple waiters. """ + if not self.is_connected: + raise PulseNotLoggedInError("Not connected to Pulse") with self._pa_attribute_lock: if self._sync_task is None: coro = self._sync_check_task() diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index 2657591..7a6845c 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -16,6 +16,7 @@ ADT_TIMEOUT_URI, DEFAULT_API_HOST, ) +from pyadtpulse.exceptions import PulseNotLoggedInError from pyadtpulse.pyadtpulse_async import PyADTPulseAsync DEFAULT_SYNC_CHECK = "234532-456432-0" @@ -99,6 +100,7 @@ async def test_mocked_responses( response = await session.post(get_mocked_url(ADT_TIMEOUT_URI)) +# not sure we need this @pytest.fixture def wrap_wait_for_update(): with patch.object( @@ -148,14 +150,8 @@ async def do_wait_for_update(p: PyADTPulseAsync, shutdown_event: asyncio.Event): @pytest.mark.asyncio -@patch.object( - PyADTPulseAsync, - "wait_for_update", - side_effect=PyADTPulseAsync.wait_for_update, - autospec=True, -) -async def test_wait_for_update(m, adt_pulse_instance): - p, _ = await adt_pulse_instance +async def test_wait_for_update(adt_pulse_instance): + p, resposnes = await adt_pulse_instance shutdown_event = asyncio.Event() task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) await asyncio.sleep(1) @@ -164,10 +160,13 @@ async def test_wait_for_update(m, adt_pulse_instance): await p.async_logout() assert p._sync_task is None assert p.site.name == "Robert Lippmann" - # just cancel, otherwise wait for update will wait forever - task.cancel() - await task - assert m.call_count == 1 + with pytest.raises(PulseNotLoggedInError): + await task + + # test exceptions + # check we can't wait for update if not logged in + with pytest.raises(PulseNotLoggedInError): + await p.wait_for_update() @pytest.mark.asyncio From adb09c63cef4c9059104b26c2c4955cd803e0830 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Thu, 21 Dec 2023 21:42:12 -0500 Subject: [PATCH 155/226] add check_login_errors and have sync check call it --- pyadtpulse/exceptions.py | 1 + pyadtpulse/pulse_connection.py | 156 +++++++++++++----------- pyadtpulse/pyadtpulse_async.py | 44 +++++-- tests/data_files/not_signed_in.html | 177 ++++++++++++++++++++++++++++ tests/test_pulse_async.py | 11 +- 5 files changed, 305 insertions(+), 84 deletions(-) create mode 100644 tests/data_files/not_signed_in.html diff --git a/pyadtpulse/exceptions.py b/pyadtpulse/exceptions.py index d3deeac..2c992be 100644 --- a/pyadtpulse/exceptions.py +++ b/pyadtpulse/exceptions.py @@ -20,6 +20,7 @@ class ExceptionWithRetry(ExceptionWithBackoff): def __init__(self, message: str, backoff: PulseBackoff, retry_time: float | None): """Initialize exception.""" super().__init__(message, backoff) + self.retry_time = retry_time if retry_time and retry_time > time(): # don't need a backoff count for absolute backoff self.backoff.reset_backoff() diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 87a5fb3..2ea7498 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -18,6 +18,7 @@ PulseAuthenticationError, PulseClientConnectionError, PulseMFARequiredError, + PulseNotLoggedInError, PulseServerConnectionError, PulseServiceTemporarilyUnavailableError, ) @@ -72,27 +73,25 @@ def __init__( self._debug_locks = debug_locks @typechecked - async def async_do_login_query(self, timeout: int = 30) -> BeautifulSoup | None: - """ - Performs a login query to the Pulse site. + def check_login_errors( + self, response: tuple[int, str | None, URL | None] + ) -> BeautifulSoup: + """Check response for login errors. - Will backoff on login failures. - - Will set login in progress flag. + Will handle setting backoffs and raising exceptions. Args: - timeout (int, optional): The timeout value for the query in seconds. - Defaults to 30. + response (tuple[int, str | None, URL | None]): The response Returns: - soup: Optional[BeautifulSoup]: A BeautifulSoup object containing - summary.jsp, or None if failure + BeautifulSoup: The parsed response + Raises: - ValueError: if login parameters are not correct PulseAuthenticationError: if login fails due to incorrect username/password PulseServerConnectionError: if login fails due to server error PulseAccountLockedError: if login fails due to account locked PulseMFARequiredError: if login fails due to MFA required + PulseNotLoggedInError: if login fails due to not logged in """ def extract_seconds_from_string(s: str) -> int: @@ -104,68 +103,83 @@ def extract_seconds_from_string(s: str) -> int: seconds *= 60 return seconds - def check_response( - response: tuple[int, str | None, URL | None] - ) -> BeautifulSoup: - """Check response for errors. + def determine_error_type(): + """Determine what type of error we have from the url and the parsed page. - Will handle setting backoffs and raising exceptions.""" + Will raise the appropriate exception. + """ + self._login_in_progress = False + url = self._connection_properties.make_url(ADT_LOGIN_URI) + if url == response_url_string: + error = soup.find("div", {"id": "warnMsgContents"}) + if error: + error_text = error.get_text() + LOG.error("Error logging into pulse: %s", error_text) + if "Try again in" in error_text: + if (retry_after := extract_seconds_from_string(error_text)) > 0: + raise PulseAccountLockedError( + f"Pulse account locked {retry_after/60} minutes for too many failed login attempts", + self._login_backoff, + retry_after + time(), + ) + elif "You have not yet signed in" in error_text: + raise PulseNotLoggedInError("Pulse not logged in") + else: + # FIXME: not sure if this is true + raise PulseAuthenticationError(error_text, self._login_backoff) + else: + url = self._connection_properties.make_url(ADT_MFA_FAIL_URI) + if url == response_url_string: + raise PulseMFARequiredError( + "MFA required to log into Pulse site", self._login_backoff + ) - soup = make_soup( - response[0], - response[1], - response[2], - logging.ERROR, - "Could not log into ADT Pulse site", + soup = make_soup( + response[0], + response[1], + response[2], + logging.ERROR, + "Could not log into ADT Pulse site", + ) + # this probably should have been handled by async_query() + if soup is None: + raise PulseServerConnectionError( + f"Could not log into ADT Pulse site: code {response[0]}: URL: {response[2]}, response: {response[1]}", + self._login_backoff, ) - # this probably should have been handled by async_query() - if soup is None: - raise PulseServerConnectionError( - f"Could not log into ADT Pulse site: code {response[0]}: URL: {response[2]}, response: {response[1]}", - self._login_backoff, - ) - url = self._connection_properties.make_url(ADT_SUMMARY_URI) - response_url_string = str(response[2]) - if url != response_url_string: - # more specifically: - # redirect to signin.jsp = username/password error - # redirect to mfaSignin.jsp = fingerprint error - # locked out = error == "Sign In unsuccessful. Your account has been - # locked after multiple sign in attempts.Try again in 30 minutes." - - # these are all failure cases, so just set login_in_progress to False now - # before exceptions are raised - self._login_in_progress = False - url = self._connection_properties.make_url(ADT_LOGIN_URI) - if url == response_url_string: - error = soup.find("div", {"id": "warnMsgContents"}) - if error: - error_text = error.get_text() - LOG.error("Error logging into pulse: %s", error_text) - if "Try again in" in error_text: - if ( - retry_after := extract_seconds_from_string(error_text) - ) > 0: - raise PulseAccountLockedError( - f"Pulse account locked {retry_after/60} minutes for too many failed login attempts", - self._login_backoff, - retry_after + time(), - ) - else: - # FIXME: not sure if this is true - raise PulseAuthenticationError( - error_text, self._login_backoff - ) - else: - url = self._connection_properties.make_url(ADT_MFA_FAIL_URI) - if url == response_url_string: - raise PulseMFARequiredError( - "MFA required to log into Pulse site", self._login_backoff - ) - # don't know what exactly the error is if we get here - self._login_in_progress = False - raise PulseAuthenticationError("Unknown error", self._login_backoff) - return soup + url = self._connection_properties.make_url(ADT_SUMMARY_URI) + response_url_string = str(response[2]) + if url != response_url_string: + determine_error_type() + raise PulseAuthenticationError("Unknown error", self._login_backoff) + return soup + + @typechecked + async def async_do_login_query(self, timeout: int = 30) -> BeautifulSoup | None: + """ + Performs a login query to the Pulse site. + + Will backoff on login failures. + + Will set login in progress flag. + + Args: + timeout (int, optional): The timeout value for the query in seconds. + Defaults to 30. + + Returns: + soup: Optional[BeautifulSoup]: A BeautifulSoup object containing + summary.jsp, or None if failure + Raises: + ValueError: if login parameters are not correct + PulseAuthenticationError: if login fails due to incorrect username/password + PulseServerConnectionError: if login fails due to server error + PulseServiceTemporarilyUnavailableError: if login fails due to too many requests or + server is temporarily unavailable + PulseAccountLockedError: if login fails due to account locked + PulseMFARequiredError: if login fails due to MFA required + PulseNotLoggedInError: if login fails due to not logged in (which is probably an internal error) + """ if self.login_in_progress: return None @@ -195,7 +209,7 @@ def check_response( LOG.error("Could not log into Pulse site: %s", e) self.login_in_progress = False raise - soup = check_response(response) + soup = self.check_login_errors(response) self._connection_status.authenticated_flag.set() self._authentication_properties.last_login_time = int(time()) self._login_backoff.reset_backoff() diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 71e1110..725e1e5 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -212,7 +212,7 @@ def _get_sync_task_name(self) -> str: def _get_timeout_task_name(self) -> str: return self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) - def _set_sync_check_exception(self, e: Exception) -> None: + def _set_sync_check_exception(self, e: Exception | None) -> None: self._sync_check_exception = e self._pulse_properties.updates_exist.set() @@ -387,13 +387,32 @@ async def validate_sync_check_response() -> bool: pattern = r"\d+[-]\d+[-]\d+" if not re.match(pattern, response_text): LOG.warning( - "Unexpected sync check format (%s), forcing re-auth", - response_text, + "Unexpected sync check format (%s)", ) - LOG.debug("Received %s from ADT Pulse site", response_text) - await self.async_logout() - await self._login_looped(task_name) - return False + try: + self._pulse_connection.check_login_errors( + (code, response_text, url) + ) + except PulseNotLoggedInError: + LOG.info("Re-login required to continue ADT Pulse sync check") + await self.async_logout() + await self._login_looped(task_name) + return False + except PulseAccountLockedError as ex: + self._set_sync_check_exception(ex) + if ex.retry_time is not None: + LOG.info( + "Pulse account locked, sleeping for %s seconds and relogging in.", + time.time() - ex.retry_time, + ) + await asyncio.sleep(time.time() - ex.retry_time) + await self._login_looped(task_name) + return False + else: + raise + except PulseServerConnectionError: + LOG.info("Server connection issue, continuing") + return False return True async def handle_no_updates_exist() -> bool: @@ -411,8 +430,7 @@ async def handle_no_updates_exist() -> bool: LOG.debug("Pulse data update failed in task %s", task_name) return False - self._sync_check_exception = None - self._pulse_properties.updates_exist.set() + self._set_sync_check_exception(None) return True else: if self._detailed_debug_logging: @@ -460,10 +478,14 @@ def handle_updates_exist() -> bool: try: if not await validate_sync_check_response(): continue - except (PulseAuthenticationError, PulseMFARequiredError) as ex: + except ( + PulseAuthenticationError, + PulseMFARequiredError, + PulseAccountLockedError, + ) as ex: self._set_sync_check_exception(ex) LOG.error( - "Task %s exiting due to error reloging into Pulse: %s", + "Task %s exiting due to error relogging into Pulse: %s", task_name, ex.args[0], ) diff --git a/tests/data_files/not_signed_in.html b/tests/data_files/not_signed_in.html new file mode 100644 index 0000000..9608e41 --- /dev/null +++ b/tests/data_files/not_signed_in.html @@ -0,0 +1,177 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - Sign In + + + + + +
+
+
+
+
+ + + + + + + + + + + + +
+
+ +
+
+
+ +
+

Please Sign In

+ +

+ + + + + + + + + + + + + + + + +
+ +

+
+ + + + + + + + + + + + + + + + + +

Password:
 
+
+
Sign In
+

Forgot your username or password?

+ + +
+ +
+


+ Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement. © 2023 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution. +
+ + +
+
+ +
+
+
+ + + + + diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index 7a6845c..7863ddf 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -150,8 +150,8 @@ async def do_wait_for_update(p: PyADTPulseAsync, shutdown_event: asyncio.Event): @pytest.mark.asyncio -async def test_wait_for_update(adt_pulse_instance): - p, resposnes = await adt_pulse_instance +async def test_wait_for_update(adt_pulse_instance, get_mocked_url): + p, responses = await adt_pulse_instance shutdown_event = asyncio.Event() task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) await asyncio.sleep(1) @@ -168,6 +168,13 @@ async def test_wait_for_update(adt_pulse_instance): with pytest.raises(PulseNotLoggedInError): await p.wait_for_update() + responses.post( + get_mocked_url(ADT_LOGIN_URI), + status=307, + headers={"Location": get_mocked_url(ADT_SUMMARY_URI)}, + ) + await p.async_login() + @pytest.mark.asyncio async def test_orb_update(mocked_server_responses, get_mocked_url, read_file): From d41a7ff2559c6e4cb2f2d403ef05d45d4ba33861 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 22 Dec 2023 04:58:29 -0500 Subject: [PATCH 156/226] fix last event parsing to strip leading and trailing spaces before date parse --- pyadtpulse/site.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 7bdc7b6..ff2104c 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -337,6 +337,8 @@ def update_zone_from_soup(self, soup: BeautifulSoup) -> None: try: last_update = parse_pulse_datetime( remove_prefix(temp.get("title"), "Last Event:") + .lstrip() + .rstrip() ) except ValueError: last_update = datetime(1970, 1, 1) From 05285a56c325110ebbbab9d4f010e3f02558e710 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 23 Dec 2023 07:40:11 -0500 Subject: [PATCH 157/226] more test fixes and regular fixes --- conftest.py | 76 +++++++++++++++++++--- pyadtpulse/pulse_query_manager.py | 13 +++- tests/test_pulse_async.py | 23 ++++++- tests/test_pulse_connection.py | 103 ++++++++---------------------- tests/test_pulse_query_manager.py | 8 +-- 5 files changed, 129 insertions(+), 94 deletions(-) diff --git a/conftest.py b/conftest.py index a90a133..0c5a734 100644 --- a/conftest.py +++ b/conftest.py @@ -4,6 +4,7 @@ import sys from collections.abc import Generator from datetime import datetime +from enum import Enum from pathlib import Path from typing import Any from unittest.mock import AsyncMock, patch @@ -42,6 +43,16 @@ MOCKED_API_VERSION = "27.0.0-140" +class LoginType(Enum): + """Login Types.""" + + SUCCESS = "signin.html" + MFA = "mfa.html" + FAIL = "signin_fail.html" + LOCKED = "signin_locked.html" + NOT_SIGNED_IN = "not_signed_in.html" + + @pytest.fixture def read_file(): """Fixture to read a file. @@ -150,7 +161,6 @@ def _get_relative_mocked_url(path: str) -> str: def get_mocked_mapped_static_responses(get_mocked_url) -> dict[str, str]: """Fixture to get the test mapped responses.""" return { - get_mocked_url(ADT_LOGIN_URI): "signin.html", get_mocked_url(ADT_SUMMARY_URI): "summary.html", get_mocked_url(ADT_SYSTEM_URI): "system.html", get_mocked_url(ADT_GATEWAY_URI): "gateway.html", @@ -193,6 +203,11 @@ def mocked_server_responses( content_type="text/html", ) # redirects + responses.get( + get_mocked_url(ADT_LOGIN_URI), + body=read_file("signin.html"), + content_type="text/html", + ) responses.get( DEFAULT_API_HOST, status=302, @@ -212,13 +227,7 @@ def mocked_server_responses( repeat=True, ) # login/logout - responses.post( - get_mocked_url(ADT_LOGIN_URI), - status=302, - headers={ - "Location": get_mocked_url(ADT_SUMMARY_URI), - }, - ) + logout_pattern = re.compile( rf"{re.escape(get_mocked_url(ADT_LOGOUT_URI))}/?.*$" ) @@ -228,11 +237,62 @@ def mocked_server_responses( headers={"Location": get_mocked_url(ADT_LOGIN_URI)}, repeat=True, ) + # not doing default sync check response or keepalive # because we need to set it on each test yield responses +def add_custom_response( + mocked_server_responses, + get_mocked_url, + read_file, + url: str, + method: str = "GET", + status: int = 200, + file_name: str | None = None, + headers: dict[str, Any] | None = None, +): + if method.upper() not in ("GET", "POST"): + raise ValueError("Unsupported HTTP method. Only GET and POST are supported.") + + mocked_server_responses.add( + get_mocked_url(url), + method, + status=status, + body=read_file(file_name) if file_name else "", + content_type="text/html", + headers=headers, + ) + + +def add_signin( + signin_type: LoginType, mocked_server_responses, get_mocked_url, read_file +): + if signin_type != LoginType.SUCCESS: + add_custom_response( + mocked_server_responses, + get_mocked_url, + read_file, + ADT_LOGIN_URI, + file_name=signin_type.value, + ) + redirect = get_mocked_url(ADT_LOGIN_URI) + if signin_type == LoginType.MFA: + redirect = get_mocked_url(ADT_MFA_FAIL_URI) + if signin_type == LoginType.SUCCESS: + redirect = get_mocked_url(ADT_SUMMARY_URI) + add_custom_response( + mocked_server_responses, + get_mocked_url, + read_file, + ADT_LOGIN_URI, + status=307, + method="POST", + headers={"Location": redirect}, + ) + + @pytest.fixture def patched_sync_task_sleep() -> Generator[AsyncMock, Any, Any]: """Fixture to patch asyncio.sleep in async_query().""" diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index f40fabd..d345fb8 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -107,15 +107,13 @@ def _set_retry_after(self, code: int, retry_after: str) -> None: Raises: PulseServiceTemporarilyUnavailableError: If the server returns a "Retry-After" header. """ - now = time() if retry_after.isnumeric(): - retval = float(retry_after) + retval = float(retry_after) + time() else: try: retval = datetime.strptime( retry_after, "%a, %d %b %Y %H:%M:%S %Z" ).timestamp() - retval -= now except ValueError: return description = self._get_http_status_description(code) @@ -146,6 +144,15 @@ def _handle_http_errors( return_value[0], return_value[3], ) + if return_value[0] in ( + HTTPStatus.TOO_MANY_REQUESTS, + HTTPStatus.SERVICE_UNAVAILABLE, + ): + raise PulseServiceTemporarilyUnavailableError( + f"HTTP error {return_value[0]}: {return_value[1]}", + self._connection_status.get_backoff(), + None, + ) raise PulseServerConnectionError( f"HTTP error {return_value[0]}: {return_value[1]} connecting to {return_value[2]}", self._connection_status.get_backoff(), diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index 7863ddf..c957237 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -6,6 +6,7 @@ import aiohttp import pytest +from conftest import LoginType, add_custom_response, add_signin from pyadtpulse.const import ( ADT_DEVICE_URI, ADT_LOGIN_URI, @@ -67,19 +68,35 @@ async def test_mocked_responses( assert actual_content == expected_content # redirects - + add_custom_response( + mocked_server_responses, + get_mocked_url, + read_file, + ADT_LOGIN_URI, + file_name="signin.html", + ) response = await session.get(f"{DEFAULT_API_HOST}/", allow_redirects=True) assert response.status == 200 actual_content = await response.text() - expected_content = read_file(static_responses[get_mocked_url(ADT_LOGIN_URI)]) + expected_content = read_file("signin.html") assert actual_content == expected_content + add_custom_response( + mocked_server_responses, + get_mocked_url, + read_file, + ADT_LOGIN_URI, + file_name="signin.html", + ) response = await session.get( get_mocked_url(ADT_LOGOUT_URI), allow_redirects=True ) assert response.status == 200 - expected_content = read_file(static_responses[get_mocked_url(ADT_LOGIN_URI)]) + expected_content = read_file("signin.html") actual_content = await response.text() assert actual_content == expected_content + add_signin( + LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file + ) response = await session.post( get_mocked_url(ADT_LOGIN_URI), allow_redirects=True ) diff --git a/tests/test_pulse_connection.py b/tests/test_pulse_connection.py index 3b84dd6..a226c32 100644 --- a/tests/test_pulse_connection.py +++ b/tests/test_pulse_connection.py @@ -5,12 +5,8 @@ import pytest from bs4 import BeautifulSoup -from pyadtpulse.const import ( - ADT_LOGIN_URI, - ADT_MFA_FAIL_URI, - ADT_SUMMARY_URI, - DEFAULT_API_HOST, -) +from conftest import LoginType, add_custom_response, add_signin +from pyadtpulse.const import ADT_LOGIN_URI, DEFAULT_API_HOST from pyadtpulse.exceptions import ( PulseAccountLockedError, PulseAuthenticationError, @@ -35,9 +31,10 @@ def setup_pulse_connection() -> PulseConnection: @pytest.mark.asyncio -async def test_login(mocked_server_responses, get_mocked_url, read_file, mock_sleep): +async def test_login(mocked_server_responses, read_file, mock_sleep, get_mocked_url): """Test Pulse Connection.""" pc = setup_pulse_connection() + add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) # first call to signin post is successful in conftest.py result = await pc.async_do_login_query() assert result == BeautifulSoup(read_file("summary.html"), "html.parser") @@ -45,6 +42,10 @@ async def test_login(mocked_server_responses, get_mocked_url, read_file, mock_sl assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 assert pc._connection_status.authenticated_flag.is_set() + # so logout won't fail + add_custom_response( + mocked_server_responses, get_mocked_url, read_file, ADT_LOGIN_URI + ) await pc.async_do_logout_query() assert not pc._connection_status.authenticated_flag.is_set() assert mock_sleep.call_count == 0 @@ -66,20 +67,14 @@ async def test_multiple_login( ): """Test Pulse Connection.""" pc = setup_pulse_connection() - # first call to signin post is successful in conftest.py + add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) result = await pc.async_do_login_query() assert result == BeautifulSoup(read_file("summary.html"), "html.parser") assert mock_sleep.call_count == 0 assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 assert pc._connection_status.authenticated_flag.is_set() - mocked_server_responses.post( - get_mocked_url(ADT_LOGIN_URI), - status=302, - headers={ - "Location": get_mocked_url(ADT_SUMMARY_URI), - }, - ) + add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await pc.async_do_login_query() assert mock_sleep.call_count == 0 assert pc.login_in_progress is False @@ -105,13 +100,7 @@ async def test_multiple_login( assert pc._connection_status.get_backoff().backoff_count == 2 assert not pc._connection_status.authenticated_flag.is_set() assert not pc.is_connected - mocked_server_responses.post( - get_mocked_url(ADT_LOGIN_URI), - status=302, - headers={ - "Location": get_mocked_url(ADT_SUMMARY_URI), - }, - ) + add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await pc.async_do_login_query() # will do a backoff, then query assert mock_sleep.call_count == MAX_RETRIES - 1 + MAX_RETRIES + 1 @@ -119,13 +108,7 @@ async def test_multiple_login( assert pc._login_backoff.backoff_count == 0 assert pc._connection_status.authenticated_flag.is_set() - mocked_server_responses.post( - get_mocked_url(ADT_LOGIN_URI), - status=302, - headers={ - "Location": get_mocked_url(ADT_SUMMARY_URI), - }, - ) + add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await pc.async_do_login_query() # shouldn't sleep at all assert mock_sleep.call_count == MAX_RETRIES - 1 + MAX_RETRIES + 1 @@ -139,16 +122,14 @@ async def test_account_lockout( mocked_server_responses, mock_sleep, get_mocked_url, freeze_time_to_now, read_file ): pc = setup_pulse_connection() - # do initial login + add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await pc.async_do_login_query() assert mock_sleep.call_count == 0 assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 assert pc.is_connected assert pc._connection_status.authenticated_flag.is_set() - mocked_server_responses.post( - get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("signin_locked.html") - ) + add_signin(LoginType.LOCKED, mocked_server_responses, get_mocked_url, read_file) with pytest.raises(PulseAccountLockedError): await pc.async_do_login_query() # won't sleep yet @@ -157,22 +138,14 @@ async def test_account_lockout( # don't set backoff on locked account, just set expiration time on backoff assert pc._login_backoff.backoff_count == 0 assert mock_sleep.call_count == 0 - mocked_server_responses.post( - get_mocked_url(ADT_LOGIN_URI), - status=302, - headers={ - "Location": get_mocked_url(ADT_SUMMARY_URI), - }, - ) + add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await pc.async_do_login_query() assert mock_sleep.call_count == 1 assert mock_sleep.call_args_list[0][0][0] == 60 * 30 assert pc.is_connected assert pc._connection_status.authenticated_flag.is_set() freeze_time_to_now.tick(delta=datetime.timedelta(seconds=60 * 30 + 1)) - mocked_server_responses.post( - get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("signin_locked.html") - ) + add_signin(LoginType.LOCKED, mocked_server_responses, get_mocked_url, read_file) with pytest.raises(PulseAccountLockedError): await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 0 @@ -184,32 +157,23 @@ async def test_invalid_credentials( mocked_server_responses, mock_sleep, get_mocked_url, read_file ): pc = setup_pulse_connection() - # do initial login + add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await pc.async_do_login_query() assert mock_sleep.call_count == 0 assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 - mocked_server_responses.post( - get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("signin_fail.html") - ) + add_signin(LoginType.FAIL, mocked_server_responses, get_mocked_url, read_file) with pytest.raises(PulseAuthenticationError): await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 1 assert mock_sleep.call_count == 0 - mocked_server_responses.post( - get_mocked_url(ADT_LOGIN_URI), status=200, body=read_file("signin_fail.html") - ) + add_signin(LoginType.FAIL, mocked_server_responses, get_mocked_url, read_file) + with pytest.raises(PulseAuthenticationError): await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 2 assert mock_sleep.call_count == 1 - mocked_server_responses.post( - get_mocked_url(ADT_LOGIN_URI), - status=302, - headers={ - "Location": get_mocked_url(ADT_SUMMARY_URI), - }, - ) + add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 0 assert mock_sleep.call_count == 2 @@ -220,47 +184,34 @@ async def test_mfa_failure( mocked_server_responses, mock_sleep, get_mocked_url, read_file ): pc = setup_pulse_connection() - # do initial login + add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await pc.async_do_login_query() assert mock_sleep.call_count == 0 assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 - mocked_server_responses.post( - get_mocked_url(ADT_LOGIN_URI), - status=307, - headers={"Location": get_mocked_url(ADT_MFA_FAIL_URI)}, - ) + add_signin(LoginType.MFA, mocked_server_responses, get_mocked_url, read_file) with pytest.raises(PulseMFARequiredError): await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 1 assert mock_sleep.call_count == 0 - mocked_server_responses.post( - get_mocked_url(ADT_LOGIN_URI), - status=307, - headers={"Location": get_mocked_url(ADT_MFA_FAIL_URI)}, - ) + add_signin(LoginType.MFA, mocked_server_responses, get_mocked_url, read_file) with pytest.raises(PulseMFARequiredError): await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 2 assert mock_sleep.call_count == 1 - mocked_server_responses.post( - get_mocked_url(ADT_LOGIN_URI), - status=302, - headers={ - "Location": get_mocked_url(ADT_SUMMARY_URI), - }, - ) + add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 0 assert mock_sleep.call_count == 2 @pytest.mark.asyncio -async def test_only_single_login(mocked_server_responses): +async def test_only_single_login(mocked_server_responses, get_mocked_url, read_file): async def login_task(): await pc.async_do_login_query() pc = setup_pulse_connection() + add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) # delay one task for a little bit for i in range(4): pc._login_backoff.increment_backoff() diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index 78dfd0b..5c43f9a 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -39,7 +39,7 @@ async def test_fetch_version_fail(mock_server_down): with pytest.raises(PulseServerConnectionError): await p.async_fetch_version() assert s.get_backoff().backoff_count == 1 - with pytest.raises(ValueError): + with pytest.raises(PulseServerConnectionError): await p.async_query(ADT_ORB_URI, requires_authentication=False) assert s.get_backoff().backoff_count == 2 assert s.get_backoff().get_current_backoff_interval() == 2.0 @@ -54,7 +54,7 @@ async def test_fetch_version_eventually_succeeds(mock_server_temporarily_down): with pytest.raises(PulseServerConnectionError): await p.async_fetch_version() assert s.get_backoff().backoff_count == 1 - with pytest.raises(ValueError): + with pytest.raises(PulseServerConnectionError): await p.async_query(ADT_ORB_URI, requires_authentication=False) assert s.get_backoff().backoff_count == 2 assert s.get_backoff().get_current_backoff_interval() == 2.0 @@ -182,7 +182,7 @@ async def test_retry_after( status=200, ) await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert mock_sleep.call_count == 2 + assert mock_sleep.call_count == 3 # retry after in the past mocked_server_responses.get( cp.make_url(ADT_ORB_URI), @@ -196,7 +196,7 @@ async def test_retry_after( status=200, ) await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert mock_sleep.call_count == 2 + assert mock_sleep.call_count == 4 @pytest.mark.asyncio From 277021f45f6812ed757f52a1cfc066efac7c1958 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 23 Dec 2023 19:57:15 -0500 Subject: [PATCH 158/226] add superclasses for exceptions --- example-client.py | 39 +++++++++++++++++++++++++++++----- pyadtpulse/exceptions.py | 32 +++++++++++++++++++--------- pyadtpulse/pulse_connection.py | 10 ++++++++- pyadtpulse/pyadtpulse_async.py | 13 +++++++++--- 4 files changed, 75 insertions(+), 19 deletions(-) diff --git a/example-client.py b/example-client.py index 3a4095c..cbbeac7 100755 --- a/example-client.py +++ b/example-client.py @@ -17,7 +17,12 @@ API_HOST_CA, DEFAULT_API_HOST, ) -from pyadtpulse.exceptions import PulseAuthenticationError +from pyadtpulse.exceptions import ( + PulseAuthenticationError, + PulseConnectionError, + PulseGatewayOfflineError, + PulseLoginException, +) from pyadtpulse.site import ADTPulseSite USER = "adtpulse_user" @@ -396,8 +401,8 @@ def sync_example( relogin_interval=relogin_interval, detailed_debug_logging=detailed_debug_logging, ) - except PulseAuthenticationError: - print("Invalid credentials for ADT Pulse site") + except PulseLoginException as ex: + print("Error connecting to ADT Pulse site: %s", ex.args[0]) sys.exit() except BaseException as e: print("Received exception logging into ADT Pulse site") @@ -435,7 +440,20 @@ def sync_example( print("Error, no zones exist, exiting...") done = True break - if adt.updates_exist: + have_updates = False + try: + have_updates = adt.updates_exist + except PulseGatewayOfflineError: + print("ADT Pulse gateway is offline, re-polling") + continue + except PulseConnectionError as ex: + print("ADT Pulse connection error: %s, re-polling", ex.args[0]) + continue + except PulseAuthenticationError as ex: + print("ADT Pulse authentication error: %s, exiting...", ex.args[0]) + done = True + break + if have_updates: print("Updates exist, refreshing") # Don't need to explicitly call update() anymore # Background thread will already have updated @@ -639,7 +657,18 @@ async def async_example( break print("\nZones:") pprint(adt.site.zones, compact=True) - await adt.wait_for_update() + try: + await adt.wait_for_update() + except PulseGatewayOfflineError: + print("ADT Pulse gateway is offline, re-polling") + continue + except PulseConnectionError as ex: + print("ADT Pulse connection error: %s, re-polling", ex.args[0]) + continue + except PulseAuthenticationError as ex: + print("ADT Pulse authentication error: %s, exiting...", ex.args[0]) + done = True + break print("Updates exist, refreshing") # no need to call an update method except KeyboardInterrupt: diff --git a/pyadtpulse/exceptions.py b/pyadtpulse/exceptions.py index 2c992be..ff9fcae 100644 --- a/pyadtpulse/exceptions.py +++ b/pyadtpulse/exceptions.py @@ -4,7 +4,7 @@ from .pulse_backoff import PulseBackoff -class ExceptionWithBackoff(RuntimeError): +class PulseExceptionWithBackoff(RuntimeError): """Exception with backoff.""" def __init__(self, message: str, backoff: PulseBackoff): @@ -14,7 +14,7 @@ def __init__(self, message: str, backoff: PulseBackoff): self.backoff.increment_backoff() -class ExceptionWithRetry(ExceptionWithBackoff): +class PulseExceptionWithRetry(PulseExceptionWithBackoff): """Exception with backoff.""" def __init__(self, message: str, backoff: PulseBackoff, retry_time: float | None): @@ -27,38 +27,50 @@ def __init__(self, message: str, backoff: PulseBackoff, retry_time: float | None self.backoff.set_absolute_backoff_time(retry_time) -class PulseServerConnectionError(ExceptionWithBackoff): +class PulseConnectionError(Exception): + """Base class for connection errors""" + + +class PulseServerConnectionError(PulseExceptionWithBackoff, PulseConnectionError): """Server error.""" -class PulseClientConnectionError(ExceptionWithBackoff): +class PulseClientConnectionError(PulseExceptionWithBackoff, PulseConnectionError): """Client error.""" -class PulseServiceTemporarilyUnavailableError(ExceptionWithRetry): +class PulseServiceTemporarilyUnavailableError( + PulseExceptionWithRetry, PulseConnectionError +): """Service temporarily unavailable error. For HTTP 503 and 429 errors. """ -class PulseAuthenticationError(ExceptionWithBackoff): +class PulseLoginException(Exception): + """Login exceptions. + + Base class for catching all login exceptions.""" + + +class PulseAuthenticationError(PulseExceptionWithBackoff, PulseLoginException): """Authentication error.""" -class PulseAccountLockedError(ExceptionWithRetry): +class PulseAccountLockedError(PulseExceptionWithRetry, PulseLoginException): """Account locked error.""" -class PulseGatewayOfflineError(ExceptionWithBackoff): +class PulseGatewayOfflineError(PulseExceptionWithBackoff): """Gateway offline error.""" -class PulseMFARequiredError(ExceptionWithBackoff): +class PulseMFARequiredError(PulseExceptionWithBackoff, PulseLoginException): """MFA required error.""" -class PulseNotLoggedInError(Exception): +class PulseNotLoggedInError(PulseExceptionWithBackoff, PulseLoginException): """Exception to indicate that the application code is not logged in. Used for signalling waiters. diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 2ea7498..3f663a2 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -123,7 +123,9 @@ def determine_error_type(): retry_after + time(), ) elif "You have not yet signed in" in error_text: - raise PulseNotLoggedInError("Pulse not logged in") + raise PulseNotLoggedInError( + "Pulse not logged in", self._login_backoff + ) else: # FIXME: not sure if this is true raise PulseAuthenticationError(error_text, self._login_backoff) @@ -251,6 +253,12 @@ def is_connected(self) -> bool: and not self._login_in_progress ) + @property + def login_backoff(self) -> PulseBackoff: + """Return backoff object.""" + with self._pc_attribute_lock: + return self._login_backoff + def check_sync(self, message: str) -> AbstractEventLoop: """Convenience method to check if running from sync context.""" return self._connection_properties.check_sync(message) diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 725e1e5..82df3f0 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -306,7 +306,9 @@ async def _cancel_task(self, task: asyncio.Task | None) -> None: except asyncio.CancelledError: pass if task == self._sync_task: - e = PulseNotLoggedInError("Pulse logout has been called") + e = PulseNotLoggedInError( + "Pulse logout has been called", self._pulse_connection.login_backoff + ) self._set_sync_check_exception(e) LOG.debug("%s successfully cancelled", task_name) @@ -580,10 +582,15 @@ async def wait_for_update(self) -> None: Blocks current async task until Pulse system signals an update - FIXME?: This code probably won't work with multiple waiters. + + Raises: + Every exception from exceptions.py are possible """ + # FIXME?: This code probably won't work with multiple waiters. if not self.is_connected: - raise PulseNotLoggedInError("Not connected to Pulse") + raise PulseNotLoggedInError( + "Not connected to Pulse", self._pulse_connection.login_backoff + ) with self._pa_attribute_lock: if self._sync_task is None: coro = self._sync_check_task() From 46cb3a199a2064202889b04d060be1639975fe81 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 23 Dec 2023 19:59:31 -0500 Subject: [PATCH 159/226] fix relogin interval in keepalive task --- pyadtpulse/pyadtpulse_async.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 82df3f0..49de3cb 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -241,7 +241,7 @@ def should_relogin(relogin_interval: int) -> bool: LOG.debug("creating %s", task_name) while True: - relogin_interval = self._pulse_properties.relogin_interval + relogin_interval = self._pulse_properties.relogin_interval * 60 try: await asyncio.sleep(self._pulse_properties.keepalive_interval * 60) if self._pulse_connection_status.retry_after > time.time(): From c3498a86adbf482aaf5ab84cb11fa5b30dc9a057 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 23 Dec 2023 22:36:29 -0500 Subject: [PATCH 160/226] move authentication wait to just before the session.request in async_query --- pyadtpulse/const.py | 2 ++ pyadtpulse/pulse_connection.py | 14 ++++++-- pyadtpulse/pulse_query_manager.py | 56 ++++++++++++++++++++++--------- tests/test_pulse_async.py | 25 ++++++++------ tests/test_pulse_query_manager.py | 56 +++++++++++++++++++++++++++++++ 5 files changed, 123 insertions(+), 30 deletions(-) diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 42910e8..26c7471 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -74,3 +74,5 @@ ADT_SENSOR_SMOKE = "smoke" ADT_SENSOR_CO = "co" ADT_SENSOR_ALARM = "alarm" + +ADT_DEFAULT_LOGIN_TIMEOUT = 30 diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 3f663a2..894889c 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -12,7 +12,13 @@ from typeguard import typechecked from yarl import URL -from .const import ADT_LOGIN_URI, ADT_LOGOUT_URI, ADT_MFA_FAIL_URI, ADT_SUMMARY_URI +from .const import ( + ADT_DEFAULT_LOGIN_TIMEOUT, + ADT_LOGIN_URI, + ADT_LOGOUT_URI, + ADT_MFA_FAIL_URI, + ADT_SUMMARY_URI, +) from .exceptions import ( PulseAccountLockedError, PulseAuthenticationError, @@ -157,7 +163,9 @@ def determine_error_type(): return soup @typechecked - async def async_do_login_query(self, timeout: int = 30) -> BeautifulSoup | None: + async def async_do_login_query( + self, timeout: int = ADT_DEFAULT_LOGIN_TIMEOUT + ) -> BeautifulSoup | None: """ Performs a login query to the Pulse site. @@ -167,7 +175,7 @@ async def async_do_login_query(self, timeout: int = 30) -> BeautifulSoup | None: Args: timeout (int, optional): The timeout value for the query in seconds. - Defaults to 30. + Defaults to ADT_DEFAULT_LOGIN_TIMEOUT. Returns: soup: Optional[BeautifulSoup]: A BeautifulSoup object containing diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index d345fb8..78398f8 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -1,6 +1,6 @@ """Pulse Query Manager.""" from logging import getLogger -from asyncio import current_task +from asyncio import current_task, wait_for from datetime import datetime from http import HTTPStatus from time import time @@ -18,9 +18,15 @@ from typeguard import typechecked from yarl import URL -from .const import ADT_HTTP_BACKGROUND_URIS, ADT_ORB_URI, ADT_OTHER_HTTP_ACCEPT_HEADERS +from .const import ( + ADT_DEFAULT_LOGIN_TIMEOUT, + ADT_HTTP_BACKGROUND_URIS, + ADT_ORB_URI, + ADT_OTHER_HTTP_ACCEPT_HEADERS, +) from .exceptions import ( PulseClientConnectionError, + PulseNotLoggedInError, PulseServerConnectionError, PulseServiceTemporarilyUnavailableError, ) @@ -216,27 +222,18 @@ async def async_query( PulseClientConnectionError: If the client cannot connect PulseServerConnectionError: If there is a server error PulseServiceTemporarilyUnavailableError: If the server returns a Retry-After header + PulseNotLoggedInError: if not logged in and task is waiting for longer than + ADT_DEFAULT_LOGIN_TIMEOUT seconds """ async def setup_query(): if method not in ("GET", "POST"): raise ValueError("method must be GET or POST") await self._connection_status.get_backoff().wait_for_backoff() - if ( - requires_authentication - and not self._connection_status.authenticated_flag.is_set() - ): - LOG.info( - "%s for %s waiting for authenticated flag to be set", method, uri - ) - await self._connection_status.authenticated_flag.wait() - else: + if not self._connection_properties.api_version: + await self.async_fetch_version() if not self._connection_properties.api_version: - await self.async_fetch_version() - if not self._connection_properties.api_version: - raise ValueError( - "Could not determine API version for connection" - ) + raise ValueError("Could not determine API version for connection") await setup_query() url = self._connection_properties.make_url(uri) @@ -269,6 +266,32 @@ async def setup_query(): await query_backoff.wait_for_backoff() retry += 1 query_backoff.increment_backoff() + if ( + requires_authentication + and not self._connection_status.authenticated_flag.is_set() + ): + LOG.info( + "%s for %s waiting for authenticated flag to be set", + method, + uri, + ) + # wait for authenticated flag to be set + # use a timeout to prevent waiting forever + try: + await wait_for( + self._connection_status.authenticated_flag.wait(), + ADT_DEFAULT_LOGIN_TIMEOUT, + ) + except TimeoutError as ex: + LOG.warning( + "%s for %s timed out waiting for authenticated flag to be set", + method, + uri, + ) + raise PulseNotLoggedInError( + f"{method} for {uri} timed out waiting for authenticated flag to be set", + self._connection_status.get_backoff(), + ) from ex async with self._connection_properties.session.request( method, url, @@ -390,3 +413,4 @@ async def async_fetch_version(self) -> None: self._connection_properties.api_version, self._connection_properties.service_host, ) + self._connection_status.get_backoff().reset_backoff() diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index c957237..b4b89f7 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -132,8 +132,12 @@ def wrap_wait_for_update(): @pytest.fixture @pytest.mark.asyncio -async def adt_pulse_instance(mocked_server_responses, extract_ids_from_data_directory): +async def adt_pulse_instance( + mocked_server_responses, extract_ids_from_data_directory, get_mocked_url, read_file +): + """Create an instance of PyADTPulseAsync and login.""" p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") + add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await p.async_login() # Assertions after login assert p.site.name == "Robert Lippmann" @@ -194,8 +198,8 @@ async def test_wait_for_update(adt_pulse_instance, get_mocked_url): @pytest.mark.asyncio -async def test_orb_update(mocked_server_responses, get_mocked_url, read_file): - response = mocked_server_responses +async def test_orb_update(adt_pulse_instance, get_mocked_url, read_file): + p, response = await adt_pulse_instance pattern = re.compile(rf"{re.escape(get_mocked_url(ADT_SYNC_CHECK_URI))}/?.*$") def signal_status_change(): @@ -293,13 +297,14 @@ async def test_sync_check_and_orb(): assert code == 200 assert content == NEXT_SYNC_CHECK - p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") shutdown_event = asyncio.Event() shutdown_event.clear() setup_sync_check() # do a first run though to make sure aioresponses will work ok await test_sync_check_and_orb() + await p.async_logout() open_patio() + add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) await p.async_login() task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) await asyncio.sleep(3) @@ -315,18 +320,17 @@ async def test_sync_check_and_orb(): @pytest.mark.asyncio -async def test_keepalive_check(mocked_server_responses): - p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") - await p.async_login() +async def test_keepalive_check(adt_pulse_instance, get_mocked_url, read_file): + p, response = await adt_pulse_instance assert p._timeout_task is not None await asyncio.sleep(0) @pytest.mark.asyncio -async def test_infinite_sync_check(mocked_server_responses, get_mocked_url): - p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") +async def test_infinite_sync_check(adt_pulse_instance, get_mocked_url, read_file): + p, response = await adt_pulse_instance pattern = re.compile(rf"{re.escape(get_mocked_url(ADT_SYNC_CHECK_URI))}/?.*$") - mocked_server_responses.get( + response.get( pattern, body=DEFAULT_SYNC_CHECK, content_type="text/html", @@ -334,7 +338,6 @@ async def test_infinite_sync_check(mocked_server_responses, get_mocked_url): ) shutdown_event = asyncio.Event() shutdown_event.clear() - await p.async_login() task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) await asyncio.sleep(5) shutdown_event.set() diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index 5c43f9a..eaa5c43 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -290,3 +290,59 @@ async def test_async_query_exceptions( # this shouldn't trigger a sleep await p.async_query(ADT_ORB_URI, requires_authentication=False) assert mock_sleep.call_count == curr_sleep_count + + +@pytest.mark.asyncio +async def test_wait_for_authentication_flag( + mocked_server_responses, get_mocked_connection_properties, read_file +): + async def query_orb_task(lock: asyncio.Lock): + async with lock: + try: + result = await p.query_orb(logging.DEBUG, "Failed to query orb") + except asyncio.CancelledError: + result = None + return result + + s = PulseConnectionStatus() + cp = get_mocked_connection_properties + p = PulseQueryManager(s, cp) + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + status=200, + body=read_file("orb.html"), + ) + lock = asyncio.Lock() + task = asyncio.create_task(query_orb_task(lock)) + try: + await asyncio.wait_for(query_orb_task(lock), 10) + except asyncio.TimeoutError: + task.cancel() + await task + # if we time out, the test has passed + else: + pytest.fail("Query should have timed out") + await lock.acquire() + task = asyncio.create_task(query_orb_task(lock)) + lock.release() + await asyncio.sleep(1) + assert not task.done() + await asyncio.sleep(3) + assert not task.done() + s.authenticated_flag.set() + result = await task + assert result == BeautifulSoup(read_file("orb.html"), "html.parser") + + # test query with retry will wait for authentication + # don't set an orb response so that we will backoff on the query + await lock.acquire() + task = asyncio.create_task(query_orb_task(lock)) + lock.release() + await asyncio.sleep(0.5) + assert not task.done() + s.authenticated_flag.clear() + await asyncio.sleep(5) + assert not task.done() + s.authenticated_flag.set() + with pytest.raises(PulseServerConnectionError): + await task From 2e2b4e003e38894ed3a7facc5581daf8e5132273 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 24 Dec 2023 00:33:47 -0500 Subject: [PATCH 161/226] add detailed debug logging to backoffs --- pyadtpulse/pulse_backoff.py | 23 ++++++++++++++++------- pyadtpulse/pulse_connection.py | 8 ++++++-- pyadtpulse/pulse_connection_status.py | 3 ++- pyadtpulse/pyadtpulse_async.py | 4 +++- 4 files changed, 27 insertions(+), 11 deletions(-) diff --git a/pyadtpulse/pulse_backoff.py b/pyadtpulse/pulse_backoff.py index 32841a8..5a9982d 100644 --- a/pyadtpulse/pulse_backoff.py +++ b/pyadtpulse/pulse_backoff.py @@ -79,6 +79,12 @@ def increment_backoff(self) -> None: """Increment backoff.""" with self._b_lock: self._backoff_count += 1 + if self._detailed_debug_logging: + LOG.debug( + "Pulse backoff %s: incremented to %s", + self._name, + self._backoff_count, + ) def reset_backoff(self) -> None: """Reset backoff.""" @@ -86,6 +92,8 @@ def reset_backoff(self) -> None: if self._expiration_time < time(): self._backoff_count = 0 self._expiration_time = 0.0 + if self._detailed_debug_logging: + LOG.debug("Pulse backoff %s reset", self._name) @typechecked def set_absolute_backoff_time(self, backoff_time: float) -> None: @@ -94,13 +102,14 @@ def set_absolute_backoff_time(self, backoff_time: float) -> None: if backoff_time < curr_time: raise ValueError("Absolute backoff time must be greater than current time") with self._b_lock: - LOG.debug( - "Pulse backoff %s: set to %s", - self._name, - datetime.datetime.fromtimestamp(backoff_time).strftime( - "%m/%d/%Y %H:%M:%S" - ), - ) + if self._detailed_debug_logging: + LOG.debug( + "Pulse backoff %s: set to %s", + self._name, + datetime.datetime.fromtimestamp(backoff_time).strftime( + "%m/%d/%Y %H:%M:%S" + ), + ) self._expiration_time = backoff_time async def wait_for_backoff(self) -> None: diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 894889c..13cbc0d 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -64,7 +64,9 @@ def __init__( # need to initialize this after the session since we set cookies # based on it super().__init__( - pulse_connection_status, pulse_connection_properties, debug_locks + pulse_connection_status, + pulse_connection_properties, + debug_locks, ) self._pc_attribute_lock = set_debug_lock( debug_locks, "pyadtpulse.pc_attribute_lock" @@ -73,7 +75,9 @@ def __init__( self._connection_status = pulse_connection_status self._authentication_properties = pulse_authentication self._login_backoff = PulseBackoff( - "Login", pulse_connection_status._backoff.initial_backoff_interval + "Login", + pulse_connection_status._backoff.initial_backoff_interval, + detailed_debug_logging=self._connection_properties.detailed_debug_logging, ) self._login_in_progress = False self._debug_locks = debug_locks diff --git a/pyadtpulse/pulse_connection_status.py b/pyadtpulse/pulse_connection_status.py index b0c9d66..a71577d 100644 --- a/pyadtpulse/pulse_connection_status.py +++ b/pyadtpulse/pulse_connection_status.py @@ -17,13 +17,14 @@ class PulseConnectionStatus: ) @typechecked - def __init__(self, debug_locks: bool = False): + def __init__(self, debug_locks: bool = False, detailed_debug_logging=False): self._pcs_attribute_lock = set_debug_lock( debug_locks, "pyadtpulse.pcs_attribute_lock" ) self._backoff = PulseBackoff( "Connection Status", initial_backoff_interval=1, + detailed_debug_logging=detailed_debug_logging, ) self._authenticated_flag = Event() diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 49de3cb..7fc2b71 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -106,7 +106,9 @@ def __init__( fingerprint=fingerprint, debug_locks=debug_locks, ) - self._pulse_connection_status = PulseConnectionStatus(debug_locks=debug_locks) + self._pulse_connection_status = PulseConnectionStatus( + debug_locks=debug_locks, detailed_debug_logging=detailed_debug_logging + ) self._pulse_properties = PyADTPulseProperties( keepalive_interval=keepalive_interval, relogin_interval=relogin_interval, From ae2273411a1ed535438d5826241b1d610f44d38b Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 24 Dec 2023 00:37:33 -0500 Subject: [PATCH 162/226] changed some pqm warnings to debug, and fetch_version debugs to warnings --- pyadtpulse/pulse_query_manager.py | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index 78398f8..2a97dc8 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -270,11 +270,12 @@ async def setup_query(): requires_authentication and not self._connection_status.authenticated_flag.is_set() ): - LOG.info( - "%s for %s waiting for authenticated flag to be set", - method, - uri, - ) + if self._connection_properties.detailed_debug_logging: + LOG.debug( + "%s for %s waiting for authenticated flag to be set", + method, + uri, + ) # wait for authenticated flag to be set # use a timeout to prevent waiting forever try: @@ -302,7 +303,7 @@ async def setup_query(): ) as response: return_value = await self._handle_query_response(response) if return_value[0] in RECOVERABLE_ERRORS: - LOG.info( + LOG.debug( "query returned recoverable error code %s: %s," "retrying (count = %d)", return_value[0], @@ -310,7 +311,7 @@ async def setup_query(): retry, ) if retry == MAX_RETRIES: - LOG.warning( + LOG.debug( "Exceeded max retries of %d, giving up", MAX_RETRIES ) response.raise_for_status() @@ -386,7 +387,7 @@ async def async_fetch_version(self) -> None: response.raise_for_status() except ClientResponseError as ex: - LOG.debug( + LOG.warning( "Error %s occurred determining Pulse API version", ex.args, exc_info=True, @@ -399,7 +400,7 @@ async def async_fetch_version(self) -> None: ClientError, ServerConnectionError, ) as ex: - LOG.debug( + LOG.warning( "Error %s occurred determining Pulse API version", ex.args, exc_info=True, From cca5035bcb8a31e2878bbdf85acd4f9e581e854f Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 24 Dec 2023 00:40:00 -0500 Subject: [PATCH 163/226] don't log backoff reset if backoff count was 0 --- pyadtpulse/pulse_backoff.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/pulse_backoff.py b/pyadtpulse/pulse_backoff.py index 5a9982d..42da833 100644 --- a/pyadtpulse/pulse_backoff.py +++ b/pyadtpulse/pulse_backoff.py @@ -90,10 +90,10 @@ def reset_backoff(self) -> None: """Reset backoff.""" with self._b_lock: if self._expiration_time < time(): + if self._detailed_debug_logging and self._backoff_count != 0: + LOG.debug("Pulse backoff %s reset", self._name) self._backoff_count = 0 self._expiration_time = 0.0 - if self._detailed_debug_logging: - LOG.debug("Pulse backoff %s reset", self._name) @typechecked def set_absolute_backoff_time(self, backoff_time: float) -> None: From 917a2977df6eb17fcece64faf143ca54e6462bca Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 24 Dec 2023 01:24:16 -0500 Subject: [PATCH 164/226] add asyncio.Timeout exception handling to pqm --- pyadtpulse/pulse_query_manager.py | 34 +++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index 2a97dc8..386b4c7 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -1,6 +1,6 @@ """Pulse Query Manager.""" from logging import getLogger -from asyncio import current_task, wait_for +from asyncio import TimeoutError, current_task, wait_for from datetime import datetime from http import HTTPStatus from time import time @@ -260,12 +260,12 @@ async def setup_query(): self._connection_status.get_backoff().initial_backoff_interval, threshold=0, debug_locks=self._debug_locks, + detailed_debug_logging=self._connection_properties.detailed_debug_logging, ) while retry < MAX_RETRIES: try: await query_backoff.wait_for_backoff() retry += 1 - query_backoff.increment_backoff() if ( requires_authentication and not self._connection_status.authenticated_flag.is_set() @@ -314,10 +314,13 @@ async def setup_query(): LOG.debug( "Exceeded max retries of %d, giving up", MAX_RETRIES ) + else: + query_backoff.increment_backoff() response.raise_for_status() continue response.raise_for_status() break + except ClientResponseError: self._handle_http_errors(return_value) except ( @@ -335,8 +338,17 @@ async def setup_query(): ) if retry == MAX_RETRIES: self._handle_network_errors(ex) + query_backoff.increment_backoff() + continue + except TimeoutError as ex: + if retry == MAX_RETRIES: + LOG.debug("Exceeded max retries of %d, giving up", MAX_RETRIES) + raise PulseServerConnectionError( + f"Exceeded max retries of {MAX_RETRIES}, giving up", + self._connection_status.get_backoff(), + ) from ex + query_backoff.increment_backoff() continue - # success self._connection_status.get_backoff().reset_backoff() return (return_value[0], return_value[1], return_value[2]) @@ -381,13 +393,13 @@ async def async_fetch_version(self) -> None: signin_url = self._connection_properties.service_host try: async with self._connection_properties.session.get( - signin_url, + signin_url, timeout=10 ) as response: response_values = await self._handle_query_response(response) response.raise_for_status() except ClientResponseError as ex: - LOG.warning( + LOG.error( "Error %s occurred determining Pulse API version", ex.args, exc_info=True, @@ -400,12 +412,22 @@ async def async_fetch_version(self) -> None: ClientError, ServerConnectionError, ) as ex: - LOG.warning( + LOG.error( "Error %s occurred determining Pulse API version", ex.args, exc_info=True, ) self._handle_network_errors(ex) + except TimeoutError as ex: + LOG.error( + "Timeout occurred determining Pulse API version %s", + ex.args, + exc_info=True, + ) + raise PulseServerConnectionError( + "Timeout occurred determining Pulse API version", + self._connection_status.get_backoff(), + ) from ex version = self._connection_properties.get_api_version(str(response_values[2])) if version is not None: self._connection_properties.api_version = version From 2665e68afa612e1ec1158ba30cf326d378060f09 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 24 Dec 2023 09:13:31 -0500 Subject: [PATCH 165/226] pqm exception type tests and fixes --- pyadtpulse/pulse_query_manager.py | 26 ++++++++++------ tests/test_pulse_query_manager.py | 52 +++++++++++++++++++++++++++---- 2 files changed, 62 insertions(+), 16 deletions(-) diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index 386b4c7..30470f0 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -12,6 +12,7 @@ ClientResponse, ClientResponseError, ServerConnectionError, + ServerDisconnectedError, ServerTimeoutError, ) from bs4 import BeautifulSoup @@ -166,26 +167,30 @@ def _handle_http_errors( @typechecked def _handle_network_errors(self, e: Exception) -> None: - new_exception: PulseClientConnectionError | PulseServerConnectionError | None = ( - None - ) - if isinstance(e, (ServerConnectionError, ServerTimeoutError)): - new_exception = PulseServerConnectionError( + if type(e) in ( + ServerConnectionError, + ServerTimeoutError, + ServerDisconnectedError, + ): + raise PulseServerConnectionError( str(e), self._connection_status.get_backoff() ) if ( - isinstance(e, (ClientConnectionError)) + isinstance(e, ClientConnectionError) and "Connection refused" in str(e) or ("timed out") in str(e) ): - new_exception = PulseServerConnectionError( + raise PulseServerConnectionError( str(e), self._connection_status.get_backoff() ) - if not new_exception: - new_exception = PulseClientConnectionError( + if isinstance(e, ClientConnectorError) and e.os_error not in ( + TimeoutError, + BrokenPipeError, + ): + raise PulseServerConnectionError( str(e), self._connection_status.get_backoff() ) - raise new_exception + raise PulseClientConnectionError(str(e), self._connection_status.get_backoff()) @typechecked async def async_query( @@ -328,6 +333,7 @@ async def setup_query(): ServerTimeoutError, ClientError, ServerConnectionError, + ServerDisconnectedError, ) as ex: LOG.debug( "Error %s occurred making %s request to %s", diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index eaa5c43..06b1ccb 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -5,7 +5,7 @@ from datetime import datetime, timedelta import pytest -from aiohttp import client_exceptions +from aiohttp import client_exceptions, client_reqrep from bs4 import BeautifulSoup from conftest import MOCKED_API_VERSION @@ -230,6 +230,27 @@ async def test_async_query_exceptions( assert mock_sleep.call_count == 1 assert s.get_backoff().backoff_count == 0 query_backoff = s.get_backoff().initial_backoff_interval + connector_errors = ( + client_exceptions.ClientConnectorError( + client_reqrep.ConnectionKey( + DEFAULT_API_HOST, + 443, + is_ssl=True, + ssl=True, + proxy=None, + proxy_auth=None, + proxy_headers_hash=None, + ), + os_error=error_type, + ) + for error_type in ( + ConnectionRefusedError, + ConnectionResetError, + TimeoutError, + BrokenPipeError, + ) + ) + # need to do ClientConnectorError, but it requires initialization for ex in ( client_exceptions.ClientConnectionError(), @@ -238,13 +259,25 @@ async def test_async_query_exceptions( client_exceptions.ServerDisconnectedError(), client_exceptions.ServerTimeoutError(), client_exceptions.ServerConnectionError(), + asyncio.TimeoutError(), + *connector_errors, ): + print( + type( + ex, + ) + ) if type(ex) in ( client_exceptions.ClientConnectionError, client_exceptions.ClientError, client_exceptions.ClientOSError, ): error_type = PulseClientConnectionError + elif type(ex) == client_exceptions.ClientConnectorError and ex.os_error in ( + TimeoutError, + BrokenPipeError, + ): + error_type = PulseClientConnectionError else: error_type = PulseServerConnectionError for _ in range(MAX_RETRIES + 1): @@ -256,11 +289,18 @@ async def test_async_query_exceptions( cp.make_url(ADT_ORB_URI), status=200, ) - with pytest.raises(error_type): - await p.async_query( - ADT_ORB_URI, - requires_authentication=False, - ) + exc_info = None + try: + with pytest.raises(error_type) as exc_info: + await p.async_query( + ADT_ORB_URI, + requires_authentication=False, + ) + except AssertionError: + actual_error_type = exc_info.type if exc_info else None + message = f"Expected {error_type}, got {actual_error_type}" + pytest.fail(message) + # only MAX_RETRIES - 1 sleeps since first call won't sleep assert ( mock_sleep.call_count == curr_sleep_count + MAX_RETRIES - 1 From ea279cf9bee807d09a5a20f950309f8c686af0ad Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 24 Dec 2023 09:31:30 -0500 Subject: [PATCH 166/226] add __str__ and __repr__ to exceptions --- pyadtpulse/exceptions.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/pyadtpulse/exceptions.py b/pyadtpulse/exceptions.py index ff9fcae..5688f5d 100644 --- a/pyadtpulse/exceptions.py +++ b/pyadtpulse/exceptions.py @@ -13,6 +13,14 @@ def __init__(self, message: str, backoff: PulseBackoff): self.backoff = backoff self.backoff.increment_backoff() + def __str__(self): + """Return a string representation of the exception.""" + return f"{self.__class__.__name__}: {super().__str__()}" + + def __repr__(self): + """Return a string representation of the exception.""" + return f"{self.__class__.__name__}(message='{self.args[0]}', backoff={self.backoff})" + class PulseExceptionWithRetry(PulseExceptionWithBackoff): """Exception with backoff.""" @@ -26,6 +34,14 @@ def __init__(self, message: str, backoff: PulseBackoff, retry_time: float | None self.backoff.reset_backoff() self.backoff.set_absolute_backoff_time(retry_time) + def __str__(self): + """Return a string representation of the exception.""" + return f"{self.__class__.__name__}: {super().__str__()}" + + def __repr__(self): + """Return a string representation of the exception.""" + return f"{self.__class__.__name__}(message='{self.args[0]}', backoff={self.backoff}, retry_time={self.retry_time})" + class PulseConnectionError(Exception): """Base class for connection errors""" From 8d9d019c6fc869f23828e44490007471adf194b5 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 24 Dec 2023 10:17:32 -0500 Subject: [PATCH 167/226] exception tests and fixes --- pyadtpulse/exceptions.py | 11 ++- tests/test_exceptions.py | 159 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 168 insertions(+), 2 deletions(-) create mode 100644 tests/test_exceptions.py diff --git a/pyadtpulse/exceptions.py b/pyadtpulse/exceptions.py index 5688f5d..d64c98d 100644 --- a/pyadtpulse/exceptions.py +++ b/pyadtpulse/exceptions.py @@ -15,7 +15,7 @@ def __init__(self, message: str, backoff: PulseBackoff): def __str__(self): """Return a string representation of the exception.""" - return f"{self.__class__.__name__}: {super().__str__()}" + return f"{self.__class__.__name__}: {self.args[0]}" def __repr__(self): """Return a string representation of the exception.""" @@ -33,10 +33,17 @@ def __init__(self, message: str, backoff: PulseBackoff, retry_time: float | None # don't need a backoff count for absolute backoff self.backoff.reset_backoff() self.backoff.set_absolute_backoff_time(retry_time) + else: + # hack to reset backoff again + current_backoff = backoff.backoff_count - 1 + self.backoff.reset_backoff() + for _ in range(current_backoff): + self.backoff.increment_backoff() + raise ValueError("retry_time must be in the future") def __str__(self): """Return a string representation of the exception.""" - return f"{self.__class__.__name__}: {super().__str__()}" + return f"{self.__class__.__name__}: {self.args[0]}" def __repr__(self): """Return a string representation of the exception.""" diff --git a/tests/test_exceptions.py b/tests/test_exceptions.py new file mode 100644 index 0000000..48c1655 --- /dev/null +++ b/tests/test_exceptions.py @@ -0,0 +1,159 @@ +# Generated by CodiumAI +from time import time + +import pytest + +from pyadtpulse.exceptions import ( + PulseAccountLockedError, + PulseAuthenticationError, + PulseClientConnectionError, + PulseConnectionError, + PulseExceptionWithBackoff, + PulseExceptionWithRetry, + PulseLoginException, + PulseNotLoggedInError, + PulseServerConnectionError, + PulseServiceTemporarilyUnavailableError, +) +from pyadtpulse.pulse_backoff import PulseBackoff + + +class TestCodeUnderTest: + # PulseExceptionWithBackoff can be initialized with a message and a PulseBackoff object + def test_pulse_exception_with_backoff_initialization(self): + backoff = PulseBackoff("test", 1.0) + exception = PulseExceptionWithBackoff("error", backoff) + assert str(exception) == "PulseExceptionWithBackoff: error" + assert exception.backoff == backoff + assert backoff.backoff_count == 1 + + # PulseExceptionWithBackoff increments the backoff count when initialized + def test_pulse_exception_with_backoff_increment(self): + backoff = PulseBackoff("test", 1.0) + exception = PulseExceptionWithBackoff("error", backoff) + assert backoff.backoff_count == 1 + + # PulseExceptionWithRetry can be initialized with a message, a PulseBackoff object, and a retry time + def test_pulse_exception_with_retry_initialization(self): + backoff = PulseBackoff("test", 1.0) + retry_time = time() + 10 + exception = PulseExceptionWithRetry("error", backoff, retry_time) + assert str(exception) == "PulseExceptionWithRetry: error" + assert exception.backoff == backoff + assert exception.retry_time == retry_time + + # PulseExceptionWithRetry resets the backoff count and sets an absolute backoff time if retry time is in the future + def test_pulse_exception_with_retry_reset_and_set_absolute_backoff_time(self): + backoff = PulseBackoff("test", 1.0) + backoff.increment_backoff() + retry_time = time() + 10 + exception = PulseExceptionWithRetry("error", backoff, retry_time) + assert backoff.backoff_count == 0 + assert backoff.expiration_time == retry_time + + # PulseServerConnectionError is a subclass of PulseExceptionWithBackoff and PulseConnectionError + def test_pulse_server_connection_error_inheritance_fixed(self): + assert issubclass(PulseServerConnectionError, PulseExceptionWithBackoff) + assert issubclass(PulseServerConnectionError, PulseConnectionError) + + # PulseClientConnectionError is a subclass of PulseExceptionWithBackoff and PulseConnectionError + def test_pulse_client_connection_error_inheritance_fixed(self): + assert issubclass(PulseClientConnectionError, PulseExceptionWithBackoff) + assert issubclass(PulseClientConnectionError, PulseConnectionError) + + # PulseExceptionWithBackoff raises an exception if initialized with an invalid message or non-PulseBackoff object + def test_pulse_exception_with_backoff_invalid_initialization(self): + with pytest.raises(Exception): + PulseExceptionWithBackoff(123, "backoff") + + # PulseExceptionWithRetry raises an exception if initialized with an invalid message, non-PulseBackoff object, or invalid retry time + def test_pulse_exception_with_retry_invalid_initialization(self): + backoff = PulseBackoff("test", 1.0) + with pytest.raises(Exception): + PulseExceptionWithRetry(123, backoff, "retry") + with pytest.raises(Exception): + PulseExceptionWithRetry("error", "backoff", time() + 10) + with pytest.raises(Exception): + PulseExceptionWithRetry("error", backoff, "retry") + + # PulseExceptionWithRetry does not reset the backoff count or set an absolute backoff time if retry time is in the past + def test_pulse_exception_with_retry_past_retry_time(self): + backoff = PulseBackoff("test", 1.0) + backoff.increment_backoff() + retry_time = time() - 10 + with pytest.raises(ValueError): + PulseExceptionWithRetry("retry must be in the future", backoff, retry_time) + # 1 backoff for increment + assert backoff.backoff_count == 1 + assert backoff.expiration_time == 0.0 + + # PulseServiceTemporarilyUnavailableError does not reset the backoff count or set an absolute backoff time if retry time is in the past + def test_pulse_service_temporarily_unavailable_error_past_retry_time_fixed(self): + backoff = PulseBackoff("test", 1.0) + backoff.increment_backoff() + retry_time = time() - 10 + with pytest.raises(ValueError): + PulseServiceTemporarilyUnavailableError( + "retry must be in the future", backoff, retry_time + ) + assert backoff.backoff_count == 1 + assert backoff.expiration_time == 0.0 + + # PulseAuthenticationError is a subclass of PulseExceptionWithBackoff and PulseLoginException + def test_pulse_authentication_error_inheritance(self): + backoff = PulseBackoff("test", 1.0) + exception = PulseAuthenticationError("error", backoff) + assert isinstance(exception, PulseExceptionWithBackoff) + assert isinstance(exception, PulseLoginException) + + # PulseServiceTemporarilyUnavailableError is a subclass of PulseExceptionWithRetry and PulseConnectionError + def test_pulse_service_temporarily_unavailable_error(self): + backoff = PulseBackoff("test", 1.0) + exception = PulseServiceTemporarilyUnavailableError( + "error", backoff, retry_time=5.0 + ) + assert isinstance(exception, PulseExceptionWithRetry) + assert isinstance(exception, PulseConnectionError) + + # PulseAccountLockedError is a subclass of PulseExceptionWithRetry and PulseLoginException + def test_pulse_account_locked_error_inheritance(self): + backoff = PulseBackoff("test", 1.0) + exception = PulseAccountLockedError("error", backoff, 10.0) + assert isinstance(exception, PulseExceptionWithRetry) + assert isinstance(exception, PulseLoginException) + + # PulseExceptionWithBackoff string representation includes the class name and message + def test_pulse_exception_with_backoff_string_representation(self): + backoff = PulseBackoff("test", 1.0) + exception = PulseExceptionWithBackoff("error", backoff) + assert str(exception) == "PulseExceptionWithBackoff: error" + + # PulseExceptionWithBackoff string representation includes the backoff object + def test_pulse_exception_with_backoff_string_representation(self): + backoff = PulseBackoff("test", 1.0) + exception = PulseExceptionWithBackoff("error", backoff) + assert str(exception) == "PulseExceptionWithBackoff: error" + assert exception.backoff == backoff + assert backoff.backoff_count == 1 + + # PulseExceptionWithRetry string representation includes the class name, message, backoff object, and retry time + def test_pulse_exception_with_retry_string_representation_fixed(self): + backoff = PulseBackoff("test", 1.0) + exception = PulseExceptionWithRetry("error", backoff, 1234567890.0) + expected_string = "PulseExceptionWithRetry: error" + assert str(exception) == expected_string + + # PulseNotLoggedInError is a subclass of PulseExceptionWithBackoff and PulseLoginException + def test_pulse_not_logged_in_error_inheritance(self): + backoff = PulseBackoff("test", 1.0) + exception = PulseNotLoggedInError("error", backoff) + assert isinstance(exception, PulseExceptionWithBackoff) + assert isinstance(exception, PulseLoginException) + + # PulseExceptionWithRetry string representation does not include the backoff count if retry time is set + def test_pulse_exception_with_retry_string_representation(self): + backoff = PulseBackoff("test", 1.0) + exception = PulseExceptionWithRetry("error", backoff, time() + 10) + assert str(exception) == "PulseExceptionWithRetry: error" + assert exception.backoff == backoff + assert backoff.backoff_count == 0 From 28b4ed6641c94ddfa1c933fd511ea7038094970b Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 24 Dec 2023 10:59:23 -0500 Subject: [PATCH 168/226] add test_site_properties --- tests/test_site_properties.py | 293 ++++++++++++++++++++++++++++++++++ 1 file changed, 293 insertions(+) create mode 100644 tests/test_site_properties.py diff --git a/tests/test_site_properties.py b/tests/test_site_properties.py new file mode 100644 index 0000000..d070bc0 --- /dev/null +++ b/tests/test_site_properties.py @@ -0,0 +1,293 @@ +# Generated by CodiumAI +from multiprocessing import RLock +from time import time + +# Dependencies: +# pip install pytest-mock +import pytest + +from pyadtpulse.alarm_panel import ADTPulseAlarmPanel +from pyadtpulse.gateway import ADTPulseGateway +from pyadtpulse.site_properties import ADTPulseSiteProperties +from pyadtpulse.zones import ADTPulseFlattendZone, ADTPulseZoneData, ADTPulseZones + + +class TestADTPulseSiteProperties: + # Retrieve site id and name + def test_retrieve_site_id_and_name(self): + # Arrange + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + + # Act + retrieved_id = site_properties.id + retrieved_name = site_properties.name + + # Assert + assert retrieved_id == site_id + assert retrieved_name == site_name + + # Retrieve last update time + def test_retrieve_last_update_time(self): + # Arrange + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + + # Act + last_updated = site_properties.last_updated + + # Assert + assert isinstance(last_updated, int) + + # Retrieve all zones registered with ADT Pulse account when zones exist + def test_retrieve_all_zones_with_zones_fixed(self): + # Arrange + + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + + # Add some zones to the site_properties instance + zone1 = ADTPulseZoneData(id_=1, name="Front Door") + zone2 = ADTPulseZoneData(id_=2, name="Back Door") + + site_properties._zones[1] = zone1 + site_properties._zones[2] = zone2 + + # Act + zones = site_properties.zones + + # Assert + assert isinstance(zones, list) + assert len(zones) == 2 + + # Retrieve zone information in dictionary form + def test_retrieve_zone_information_as_dict(self): + # Arrange + + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + site_properties._zones = ADTPulseZones() + zone = ADTPulseZoneData(id_=1, name="Zone1") # Provide the 'id_' argument + site_properties._zones[1] = zone + + # Act + zones_dict = site_properties.zones_as_dict + + # Assert + assert isinstance(zones_dict, ADTPulseZones) + + # Retrieve alarm panel object for the site + def test_retrieve_alarm_panel_object(self): + # Arrange + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + + # Act + alarm_panel = site_properties.alarm_control_panel + + # Assert + assert isinstance(alarm_panel, ADTPulseAlarmPanel) + + # Retrieve gateway device object + def test_retrieve_gateway_device_object(self): + # Arrange + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + + # Act + gateway = site_properties.gateway + + # Assert + assert isinstance(gateway, ADTPulseGateway) + + # No zones exist + def test_no_zones_exist(self): + # Arrange + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + + # Act & Assert + with pytest.raises(RuntimeError): + site_properties.zones + + # Attempting to retrieve site data while another thread is modifying it + def test_retrieve_site_data_while_modifying(self, mocker): + # Arrange + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + + def modify_site_data(): + with site_properties.site_lock: + time.sleep(2) + site_properties._last_updated = int(time()) + + mocker.patch.object(site_properties, "_last_updated", 0) + mocker.patch.object(site_properties, "_site_lock", RLock()) + + # Act + with site_properties.site_lock: + retrieved_last_updated = site_properties.last_updated + + # Assert + assert retrieved_last_updated == 0 + + # Attempting to set alarm status to existing status + def test_set_alarm_status_to_existing_status(self, mocker): + # Arrange + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + + mocker.patch.object(site_properties._alarm_panel, "_status", "Armed Away") + + # Check if updates exist + def test_check_updates_exist(self, mocker): + # Arrange + from time import time + + site_properties = ADTPulseSiteProperties("12345", "My ADT Pulse Site") + mocker.patch.object(site_properties, "_last_updated", return_value=time()) + + # Act + result = site_properties.updates_may_exist + + # Assert + assert result is False + + # Update site/zone data async with current data + @pytest.mark.asyncio + async def test_update_site_zone_data_async(self, mocker): + # Arrange + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + mock_zones = mocker.Mock() + mock_zones.flatten.return_value = [ADTPulseFlattendZone()] + site_properties._zones = mock_zones + + # Act + result = await site_properties.async_update() + + # Assert + assert result == False + + # Cannot set alarm status from one state to another + def test_cannot_set_alarm_status(self, mocker): + import asyncio + + # Arrange + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + mocker.patch.object(site_properties._alarm_panel, "_status", "Armed Away") + + # Act + result = asyncio.run( + site_properties._alarm_panel._arm(None, "Armed Home", False) + ) + + # Assert + assert result == False + + # Failed updating ADT Pulse alarm to new mode + @pytest.mark.asyncio + async def test_failed_updating_alarm_mode(self, mocker): + # Arrange + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + + # Mock the _arm method to return False + async def mock_arm(*args, **kwargs): + return False + + mocker.patch.object(ADTPulseAlarmPanel, "_arm", side_effect=mock_arm) + + # Act + result = await site_properties.alarm_control_panel._arm(None, "new_mode", False) + + # Assert + assert result == False + + # Retrieve last update time with invalid input + def test_retrieve_last_update_invalid_input(self): + # Arrange + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + + # Act + last_updated = site_properties.last_updated + + # Assert + assert last_updated == 0 + + # Retrieve site id and name with invalid input + def test_retrieve_site_id_and_name_with_invalid_input(self): + # Arrange + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + + # Act + retrieved_id = site_properties.id + retrieved_name = site_properties.name + + # Assert + assert retrieved_id == site_id + assert retrieved_name == site_name + + # Retrieve zone information in dictionary form with invalid input + def test_retrieve_zone_info_invalid_input(self, mocker): + # Arrange + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + mocker.patch.object(site_properties, "_zones", None) + + # Act and Assert + with pytest.raises(RuntimeError): + site_properties.zones + + with pytest.raises(RuntimeError): + site_properties.zones_as_dict + + # Retrieve all zones registered with ADT Pulse account with invalid input + def test_retrieve_zones_with_invalid_input(self, mocker): + # Arrange + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + mocker.patch.object(site_properties, "_zones", None) + + # Act and Assert + with pytest.raises(RuntimeError): + _ = site_properties.zones + + with pytest.raises(RuntimeError): + _ = site_properties.zones_as_dict + + # Retrieve alarm panel object for the site with invalid input + def test_retrieve_alarm_panel_invalid_input(self, mocker): + # Arrange + site_id = "12345" + site_name = "My ADT Pulse Site" + site_properties = ADTPulseSiteProperties(site_id, site_name) + + # Mock the ADTPulseAlarmPanel object + mock_alarm_panel = mocker.Mock() + site_properties._alarm_panel = mock_alarm_panel + + # Act + retrieved_alarm_panel = site_properties.alarm_control_panel + + # Assert + assert retrieved_alarm_panel == mock_alarm_panel From 299b8bb82a5ca834963229081924e46bd002133a Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 24 Dec 2023 11:57:52 -0500 Subject: [PATCH 169/226] zones tests and fixes --- pyadtpulse/zones.py | 34 +- tests/test_zones.py | 1223 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 1254 insertions(+), 3 deletions(-) create mode 100644 tests/test_zones.py diff --git a/pyadtpulse/zones.py b/pyadtpulse/zones.py index 290a1a5..f875891 100644 --- a/pyadtpulse/zones.py +++ b/pyadtpulse/zones.py @@ -7,7 +7,7 @@ from typeguard import typechecked -ADT_NAME_TO_DEFAULT_TAGS = { +ADT_NAME_TO_DEFAULT_TAGS: dict[str, tuple[str, str]] = { "Door": ("sensor", "doorWindow"), "Window": ("sensor", "doorWindow"), "Motion": ("sensor", "motion"), @@ -40,10 +40,38 @@ class ADTPulseZoneData: name: str id_: str - tags: tuple = ADT_NAME_TO_DEFAULT_TAGS["Window"] + _tags: tuple[str, str] = ADT_NAME_TO_DEFAULT_TAGS["Window"] status: str = "Unknown" state: str = "Unknown" - last_activity_timestamp: int = 0 + _last_activity_timestamp: int = 0 + + @property + def last_activity_timestamp(self) -> int: + """Return the last activity timestamp.""" + return self._last_activity_timestamp + + @last_activity_timestamp.setter + @typechecked + def last_activity_timestamp(self, value: int) -> None: + """Set the last activity timestamp.""" + if value < 1420070400: + raise ValueError( + "last_activity_timestamp must be greater than that of 01-Jan-2015" + ) + self._last_activity_timestamp = value + + @property + def tags(self) -> tuple[str, str]: + """Return the tags.""" + return self._tags + + @tags.setter + @typechecked + def tags(self, value: tuple[str, str]) -> None: + """Set the tags.""" + if value not in ADT_NAME_TO_DEFAULT_TAGS.values(): + raise ValueError("tags must be one of: " + str(ADT_NAME_TO_DEFAULT_TAGS)) + self._tags = value class ADTPulseFlattendZone(TypedDict): diff --git a/tests/test_zones.py b/tests/test_zones.py new file mode 100644 index 0000000..a6a14c8 --- /dev/null +++ b/tests/test_zones.py @@ -0,0 +1,1223 @@ +# Generated by CodiumAI +from datetime import datetime + +import pytest +from typeguard import TypeCheckError + +from pyadtpulse.zones import ( + ADT_NAME_TO_DEFAULT_TAGS, + ADTPulseFlattendZone, + ADTPulseZoneData, + ADTPulseZones, +) + + +class TestADTPulseZoneData: + # Creating an instance of ADTPulseZoneData with required parameters should succeed. + def test_create_instance_with_required_parameters(self): + """ + Test that creating an instance of ADTPulseZoneData with required parameters succeeds. + """ + # Arrange + name = "Zone 1" + id_ = "zone1" + + # Act + zone_data = ADTPulseZoneData(name, id_) + + # Assert + assert zone_data.name == name + assert zone_data.id_ == id_ + assert zone_data.tags == ADT_NAME_TO_DEFAULT_TAGS["Window"] + assert zone_data.status == "Unknown" + assert zone_data.state == "Unknown" + assert zone_data.last_activity_timestamp == 0 + + # Setting the last_activity_timestamp with a value greater than or equal to 1420070400 should succeed. + def test_set_last_activity_timestamp_greater_than_or_equal_to_1420070400(self): + """ + Test that setting the last_activity_timestamp with a value greater than or equal to 1420070400 succeeds. + """ + # Arrange + zone_data = ADTPulseZoneData("Zone 1", "zone1") + timestamp = 1420070400 + + # Act + zone_data.last_activity_timestamp = timestamp + + # Assert + assert zone_data.last_activity_timestamp == timestamp + + # Setting the tags with a valid value should succeed. + def test_set_tags_with_valid_value(self): + """ + Test that setting the tags with a valid value succeeds. + """ + # Arrange + zone_data = ADTPulseZoneData("Zone 1", "zone1") + tags = ("sensor", "doorWindow") + + # Act + zone_data.tags = tags + + # Assert + assert zone_data.tags == tags + + # Getting the last_activity_timestamp should return the correct value. + def test_get_last_activity_timestamp(self): + """ + Test that getting the last_activity_timestamp returns the correct value. + """ + # Arrange + timestamp = 1420070400 + zone_data = ADTPulseZoneData("Zone 1", "zone1") + zone_data.last_activity_timestamp = timestamp + + # Act + result = zone_data.last_activity_timestamp + + # Assert + assert result == timestamp + + # Getting the tags should return the correct value. + def test_get_tags_fixed(self): + """ + Test that getting the tags returns the correct value. + """ + # Arrange + tags = ("sensor", "doorWindow") + zone_data = ADTPulseZoneData("Zone 1", "zone1") + zone_data.tags = tags + + # Act + result = zone_data.tags + + # Assert + assert result == tags + + # ADT_NAME_TO_DEFAULT_TAGS should be a valid dictionary. + def test_ADT_NAME_TO_DEFAULT_TAGS_is_valid_dictionary(self): + """ + Test that ADT_NAME_TO_DEFAULT_TAGS is a valid dictionary. + """ + # Arrange + + # Act + + # Assert + assert isinstance(ADT_NAME_TO_DEFAULT_TAGS, dict) + + # Creating an instance of ADTPulseZoneData without required parameters should fail. + def test_create_instance_without_required_parameters(self): + """ + Test that creating an instance of ADTPulseZoneData without required parameters fails. + """ + # Arrange + + # Act and Assert + with pytest.raises(TypeError): + ADTPulseZoneData() + + # Setting the last_activity_timestamp with a value less than 1420070400 should raise a ValueError. + def test_set_last_activity_timestamp_less_than_1420070400(self): + """ + Test that setting the last_activity_timestamp with a value less than 1420070400 raises a ValueError. + """ + # Arrange + zone_data = ADTPulseZoneData("Zone 1", "zone1") + timestamp = 1419999999 + + # Act and Assert + with pytest.raises(ValueError): + zone_data.last_activity_timestamp = timestamp + + # Setting the tags with an invalid value should raise a ValueError. + def test_set_tags_with_invalid_value(self): + """ + Test that setting the tags with an invalid value raises a ValueError. + """ + # Arrange + zone_data = ADTPulseZoneData("Zone 1", "zone1") + tags = ("InvalidSensor", "InvalidType") + + # Act and Assert + with pytest.raises(ValueError): + zone_data.tags = tags + + # Getting the name should return the correct value. + def test_get_name(self): + """ + Test that getting the name returns the correct value. + """ + # Arrange + name = "Zone 1" + zone_data = ADTPulseZoneData(name, "zone1") + + # Act + result = zone_data.name + + # Assert + assert result == name + + # Getting the id_ should return the correct value. + def test_get_id(self): + """ + Test that getting the id_ returns the correct value. + """ + # Arrange + id_ = "zone1" + zone_data = ADTPulseZoneData("Zone 1", id_) + + # Act + result = zone_data.id_ + + # Assert + assert result == id_ + + # Setting the status with a valid value should succeed. + def test_set_status_with_valid_value(self): + """ + Test that setting the status with a valid value succeeds. + """ + # Arrange + zone_data = ADTPulseZoneData("Zone 1", "zone1") + status = "Online" + + # Act + zone_data.status = status + + # Assert + assert zone_data.status == status + + # Setting the state with a valid value should succeed. + def test_setting_state_with_valid_value(self): + """ + Test that setting the state with a valid value succeeds. + """ + # Arrange + name = "Zone 1" + id_ = "zone1" + state = "Opened" + + # Act + zone_data = ADTPulseZoneData(name, id_) + zone_data.state = state + + # Assert + assert zone_data.state == state + + # Getting the status should return the correct value. + def test_getting_status(self): + """ + Test that getting the status returns the correct value. + """ + # Arrange + name = "Zone 1" + id_ = "zone1" + status = "Online" + + # Act + zone_data = ADTPulseZoneData(name, id_) + zone_data.status = status + + # Assert + assert zone_data.status == status + + # Getting the state should return the correct value. + def test_getting_state_returns_correct_value(self): + """ + Test that getting the state returns the correct value. + """ + # Arrange + name = "Zone 1" + id_ = "zone1" + state = "Opened" + + zone_data = ADTPulseZoneData(name, id_) + zone_data.state = state + + # Act + result = zone_data.state + + # Assert + assert result == state + + +class TestADTPulseFlattendZone: + # Creating a new instance of ADTPulseFlattendZone with valid parameters should successfully create an object with the correct attributes. + def test_valid_parameters(self): + """ + Test that creating a new instance of ADTPulseFlattendZone with valid parameters successfully creates an object with the correct attributes. + """ + # Arrange + zone = 1 + name = "Zone 1" + id_ = "zone1" + tags = ("sensor1", "type1") + status = "Online" + state = "Opened" + last_activity_timestamp = 1234567890 + + # Act + zone_obj = ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Assert + assert zone_obj["zone"] == zone + assert zone_obj["name"] == name + assert zone_obj["id_"] == id_ + assert zone_obj["tags"] == tags + assert zone_obj["status"] == status + assert zone_obj["state"] == state + assert zone_obj["last_activity_timestamp"] == last_activity_timestamp + + # Accessing any attribute of an instance of ADTPulseFlattendZone should return the expected value. + def test_access_attributes(self): + """ + Test that accessing any attribute of an instance of ADTPulseFlattendZone returns the expected value. + """ + # Arrange + zone = 1 + name = "Zone 1" + id_ = "zone1" + tags = ("sensor1", "type1") + status = "Online" + state = "Opened" + last_activity_timestamp = 1234567890 + zone_obj = ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Act & Assert + assert zone_obj["zone"] == zone + assert zone_obj["name"] == name + assert zone_obj["id_"] == id_ + assert zone_obj["tags"] == tags + assert zone_obj["status"] == status + assert zone_obj["state"] == state + assert zone_obj["last_activity_timestamp"] == last_activity_timestamp + + # Modifying any attribute of an instance of ADTPulseFlattendZone should successfully update the attribute with the new value. + def test_modify_attributes_fixed(self): + """ + Test that modifying any attribute of an instance of ADTPulseFlattendZone successfully updates the attribute with the new value. + """ + # Arrange + zone = 1 + name = "Zone 1" + id_ = "zone1" + tags = ("sensor1", "type1") + status = "Online" + state = "Opened" + last_activity_timestamp = 1234567890 + zone_obj = ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Act + new_zone = 2 + new_name = "Zone 2" + new_id = "zone2" + new_tags = ("sensor2", "type2") + new_status = "Offline" + new_state = "Closed" + new_last_activity_timestamp = 9876543210 + + zone_obj["zone"] = new_zone + zone_obj["name"] = new_name + zone_obj["id_"] = new_id + zone_obj["tags"] = new_tags + zone_obj["status"] = new_status + zone_obj["state"] = new_state + zone_obj["last_activity_timestamp"] = new_last_activity_timestamp + + # Assert + assert zone_obj["zone"] == new_zone + assert zone_obj["name"] == new_name + assert zone_obj["id_"] == new_id + assert zone_obj["tags"] == new_tags + assert zone_obj["status"] == new_status + assert zone_obj["state"] == new_state + assert zone_obj["last_activity_timestamp"] == new_last_activity_timestamp + + # Creating a new instance of ADTPulseFlattendZone with a non-integer value for 'zone' should not raise a TypeError. + def test_non_integer_zone(self): + """ + Test that creating a new instance of ADTPulseFlattendZone with a non-integer value for 'zone' does not raise a TypeError. + """ + # Arrange + zone = "1" + name = "Zone 1" + id_ = "zone1" + tags = ("sensor1", "type1") + status = "Online" + state = "Opened" + last_activity_timestamp = 1234567890 + + # Act & Assert + ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Creating a new instance of ADTPulseFlattendZone with an empty string for 'name' should not raise a ValueError. + def test_empty_name(self): + """ + Test that creating a new instance of ADTPulseFlattendZone with an empty string for 'name' does not raise a ValueError. + """ + # Arrange + zone = 1 + name = "" + id_ = "zone1" + tags = ("sensor1", "type1") + status = "Online" + state = "Opened" + last_activity_timestamp = 1234567890 + + # Act & Assert + ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Creating a new instance of ADTPulseFlattendZone with an empty string for 'id_' should not raise a ValueError. + def test_empty_id_fixed(self): + """ + Test that creating a new instance of ADTPulseFlattendZone with an empty string for 'id_' does not raise a ValueError. + """ + # Arrange + zone = 1 + name = "Zone 1" + id_ = "" + tags = ("sensor1", "type1") + status = "Online" + state = "Opened" + last_activity_timestamp = 1234567890 + + # Act + ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Assert + assert True + + # Creating a new instance of ADTPulseFlattendZone with a tuple that contains non-string values for 'tags' should not raise a TypeError. + def test_non_string_tags(self): + """ + Test that creating a new instance of ADTPulseFlattendZone with a tuple that contains non-string values for 'tags' does not raise a TypeError. + """ + # Arrange + zone = 1 + name = "Zone 1" + id_ = "zone1" + tags = ("sensor1", 2) + status = "Online" + state = "Opened" + last_activity_timestamp = 1234567890 + + # Act & Assert + ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Creating a new instance of ADTPulseFlattendZone with a non-string value for 'status' should not raise a TypeError. + def test_non_string_status(self): + """ + Test that creating a new instance of ADTPulseFlattendZone with a non-string value for 'status' does not raise a TypeError. + """ + # Arrange + zone = 1 + name = "Zone 1" + id_ = "zone1" + tags = ("sensor1", "type1") + status = 1 + state = "Opened" + last_activity_timestamp = 1234567890 + + # Act & Assert + ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Creating a new instance of ADTPulseFlattendZone with a non-string value for 'state' should not raise a TypeError. + def test_non_string_state(self): + """ + Test that creating a new instance of ADTPulseFlattendZone with a non-string value for 'state' does not raise a TypeError. + """ + # Arrange + zone = 1 + name = "Zone 1" + id_ = "zone1" + tags = ("sensor1", "type1") + status = "Online" + state = 1 + last_activity_timestamp = 1234567890 + + # Act & Assert + ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Creating a new instance of ADTPulseFlattendZone with a non-integer value for 'last_activity_timestamp' should not raise a TypeError. + def test_non_integer_last_activity_timestamp(self): + """ + Test that creating a new instance of ADTPulseFlattendZone with a non-integer value for 'last_activity_timestamp' does not raise a TypeError. + """ + # Arrange + zone = 1 + name = "Zone 1" + id_ = "zone1" + tags = ("sensor1", "type1") + status = "Online" + state = "Opened" + last_activity_timestamp = "1234567890" + + # Act & Assert + ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Creating a new instance of ADTPulseFlattendZone with a very large integer value for 'zone' should successfully create an object with the correct attributes. + def test_large_zone_fixed(self): + """ + Test that creating a new instance of ADTPulseFlattendZone with a very large integer value for 'zone' successfully creates an object with the correct attributes. + """ + # Arrange + zone = 9999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999 + name = "Zone 1" + id_ = "zone1" + tags = ("sensor1", "type1") + status = "Online" + state = "Opened" + last_activity_timestamp = 1234567890 + + # Act + zone_obj = ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Assert + assert zone_obj["zone"] == zone + assert zone_obj["name"] == name + assert zone_obj["id_"] == id_ + assert zone_obj["tags"] == tags + assert zone_obj["status"] == status + assert zone_obj["state"] == state + assert zone_obj["last_activity_timestamp"] == last_activity_timestamp + + # Creating a new instance of ADTPulseFlattendZone with a very long string for 'name' should successfully create an object with the correct attributes. + def test_long_name_fixed(self): + """ + Test that creating a new instance of ADTPulseFlattendZone with a very long string for 'name' successfully creates an object with the correct attributes. + """ + # Arrange + zone = 1 + name = "This is a very long name that exceeds the maximum length allowed for the 'name' attribute in ADTPulseFlattendZone" + id_ = "zone1" + tags = ("sensor1", "type1") + status = "Online" + state = "Opened" + last_activity_timestamp = 1234567890 + + # Act + zone_obj = ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Assert + assert zone_obj["zone"] == zone + assert zone_obj["name"] == name + assert zone_obj["id_"] == id_ + assert zone_obj["tags"] == tags + assert zone_obj["status"] == status + assert zone_obj["state"] == state + assert zone_obj["last_activity_timestamp"] == last_activity_timestamp + + # Creating a new instance of ADTPulseFlattendZone with a very long string for 'id_' should successfully create an object with the correct attributes. + def test_long_id_fixed(self): + """ + Test that creating a new instance of ADTPulseFlattendZone with a very long string for 'id_' successfully creates an object with the correct attributes. + """ + # Arrange + zone = 1 + name = "Zone 1" + id_ = "a" * 1000 # Very long string for 'id_' + tags = ("sensor1", "type1") + status = "Online" + state = "Opened" + last_activity_timestamp = 1234567890 + + # Act + zone_obj = ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Assert + assert zone_obj["zone"] == zone + assert zone_obj["name"] == name + assert zone_obj["id_"] == id_ + assert zone_obj["tags"] == tags + assert zone_obj["status"] == status + assert zone_obj["state"] == state + assert zone_obj["last_activity_timestamp"] == last_activity_timestamp + + # Creating a new instance of ADTPulseFlattendZone with a tuple that contains multiple strings for 'tags' should successfully create an object with the correct attributes. + def test_create_instance_with_multiple_tags_fixed(self): + """ + Test that creating a new instance of ADTPulseFlattendZone with a tuple that contains multiple strings for 'tags' successfully creates an object with the correct attributes. + """ + # Arrange + zone = 1 + name = "Zone 1" + id_ = "zone1" + tags = ("sensor1", "type1", "sensor2", "type2") + status = "Online" + state = "Opened" + last_activity_timestamp = 1234567890 + + # Act + zone_obj = ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Assert + assert zone_obj["zone"] == zone + assert zone_obj["name"] == name + assert zone_obj["id_"] == id_ + assert zone_obj["tags"] == tags + assert zone_obj["status"] == status + assert zone_obj["state"] == state + assert zone_obj["last_activity_timestamp"] == last_activity_timestamp + + # Creating a new instance of ADTPulseFlattendZone with a very long string for 'status' should successfully create an object with the correct attributes. + def test_long_status_string_fixed(self): + """ + Test that creating a new instance of ADTPulseFlattendZone with a very long string for 'status' successfully creates an object with the correct attributes. + """ + # Arrange + zone = 1 + name = "Zone 1" + id_ = "zone1" + tags = ("sensor1", "type1") + status = "Very long status string" * 1000 + state = "Opened" + last_activity_timestamp = 1234567890 + + # Act + zone_obj = ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Assert + assert zone_obj["zone"] == zone + assert zone_obj["name"] == name + assert zone_obj["id_"] == id_ + assert zone_obj["tags"] == tags + assert zone_obj["status"] == status + assert zone_obj["state"] == state + assert zone_obj["last_activity_timestamp"] == last_activity_timestamp + + # Creating a new instance of ADTPulseFlattendZone with a very long string for 'state' should successfully create an object with the correct attributes. + def test_long_state_string_fixed(self): + """ + Test that creating a new instance of ADTPulseFlattendZone with a very long string for 'state' successfully creates an object with the correct attributes. + """ + # Arrange + zone = 1 + name = "Zone 1" + id_ = "zone1" + tags = ("sensor1", "type1") + status = "Online" + state = "a" * 1000 # Very long string for 'state' + last_activity_timestamp = 1234567890 + + # Act + zone_obj = ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Assert + assert zone_obj["zone"] == zone + assert zone_obj["name"] == name + assert zone_obj["id_"] == id_ + assert zone_obj["tags"] == tags + assert zone_obj["status"] == status + assert zone_obj["state"] == state + assert zone_obj["last_activity_timestamp"] == last_activity_timestamp + + # Creating a new instance of ADTPulseFlattendZone with a very large integer value for 'last_activity_timestamp' should successfully create an object with the correct attributes. + def test_large_last_activity_timestamp_fixed(self): + """ + Test that creating a new instance of ADTPulseFlattendZone with a very large integer value for 'last_activity_timestamp' successfully creates an object with the correct attributes. + """ + # Arrange + zone = 1 + name = "Zone 1" + id_ = "zone1" + tags = ("sensor1", "type1") + status = "Online" + state = "Opened" + last_activity_timestamp = 999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999 + + # Act + zone_obj = ADTPulseFlattendZone( + zone=zone, + name=name, + id_=id_, + tags=tags, + status=status, + state=state, + last_activity_timestamp=last_activity_timestamp, + ) + + # Assert + assert zone_obj["zone"] == zone + assert zone_obj["name"] == name + assert zone_obj["id_"] == id_ + assert zone_obj["tags"] == tags + assert zone_obj["status"] == status + assert zone_obj["state"] == state + assert zone_obj["last_activity_timestamp"] == last_activity_timestamp + + +class TestADTPulseZones: + # ADTPulseZones can be initialized with a dictionary containing ADTPulseZoneData with zone as the key + def test_initialized_with_dictionary(self): + """ + Test that ADTPulseZones can be initialized with a dictionary containing ADTPulseZoneData with zone as the key + """ + # Arrange + data = { + 1: ADTPulseZoneData("Zone 1", "sensor-1"), + 2: ADTPulseZoneData("Zone 2", "sensor-2"), + 3: ADTPulseZoneData("Zone 3", "sensor-3"), + } + + # Act + zones = ADTPulseZones(data) + + # Assert + assert len(zones) == 3 + assert zones[1].name == "Zone 1" + assert zones[2].name == "Zone 2" + assert zones[3].name == "Zone 3" + + # ADTPulseZones can get a Zone by its id + def test_get_zone_by_id(self): + """ + Test that ADTPulseZones can get a Zone by its id + """ + # Arrange + zones = ADTPulseZones( + { + 1: ADTPulseZoneData("Zone 1", "sensor-1"), + 2: ADTPulseZoneData("Zone 2", "sensor-2"), + 3: ADTPulseZoneData("Zone 3", "sensor-3"), + } + ) + + # Act + zone_1 = zones[1] + zone_2 = zones[2] + zone_3 = zones[3] + + # Assert + assert zone_1.name == "Zone 1" + assert zone_2.name == "Zone 2" + assert zone_3.name == "Zone 3" + + # ADTPulseZones can set a Zone by its id + def test_set_zone_by_id(self): + """ + Test that ADTPulseZones can set a Zone by its id + """ + # Arrange + zones = ADTPulseZones() + + # Act + zones[1] = ADTPulseZoneData("Zone 1", "sensor-1") + zones[2] = ADTPulseZoneData("Zone 2", "sensor-2") + zones[3] = ADTPulseZoneData("Zone 3", "sensor-3") + + # Assert + assert len(zones) == 3 + assert zones[1].name == "Zone 1" + assert zones[2].name == "Zone 2" + assert zones[3].name == "Zone 3" + + # ADTPulseZones can update zone status by its id + def test_update_zone_status(self): + """ + Test that ADTPulseZones can update zone status by its id + """ + # Arrange + zones = ADTPulseZones( + { + 1: ADTPulseZoneData("Zone 1", "sensor-1"), + 2: ADTPulseZoneData("Zone 2", "sensor-2"), + 3: ADTPulseZoneData("Zone 3", "sensor-3"), + } + ) + + # Act + zones.update_status(1, "Online") + zones.update_status(2, "Low Battery") + zones.update_status(3, "Offline") + + # Assert + assert zones[1].status == "Online" + assert zones[2].status == "Low Battery" + assert zones[3].status == "Offline" + + # ADTPulseZones can update zone state by its id + def test_update_zone_state(self): + """ + Test that ADTPulseZones can update zone state by its id + """ + # Arrange + zones = ADTPulseZones( + { + 1: ADTPulseZoneData("Zone 1", "sensor-1"), + 2: ADTPulseZoneData("Zone 2", "sensor-2"), + 3: ADTPulseZoneData("Zone 3", "sensor-3"), + } + ) + + # Act + zones.update_state(1, "Opened") + zones.update_state(2, "Closed") + zones.update_state(3, "Unknown") + + # Assert + assert zones[1].state == "Opened" + assert zones[2].state == "Closed" + assert zones[3].state == "Unknown" + + # ADTPulseZones can update last activity timestamp by its id + def test_update_last_activity_timestamp(self): + """ + Test that ADTPulseZones can update last activity timestamp by its id + """ + # Arrange + zones = ADTPulseZones( + { + 1: ADTPulseZoneData("Zone 1", "sensor-1"), + 2: ADTPulseZoneData("Zone 2", "sensor-2"), + 3: ADTPulseZoneData("Zone 3", "sensor-3"), + } + ) + + # Act + dt_1 = datetime(2022, 1, 1, 12, 0, 0) + dt_2 = datetime(2022, 1, 2, 12, 0, 0) + dt_3 = datetime(2022, 1, 3, 12, 0, 0) + + zones.update_last_activity_timestamp(1, dt_1) + zones.update_last_activity_timestamp(2, dt_2) + zones.update_last_activity_timestamp(3, dt_3) + + # Assert + assert zones[1].last_activity_timestamp == int(dt_1.timestamp()) + assert zones[2].last_activity_timestamp == int(dt_2.timestamp()) + assert zones[3].last_activity_timestamp == int(dt_3.timestamp()) + + # ADTPulseZones can update device info by its id + def test_update_device_info_by_id(self): + """ + Test that ADTPulseZones can update device info by its id + """ + # Arrange + zones = ADTPulseZones() + zones[1] = ADTPulseZoneData("Zone 1", "sensor-1") + + # Act + zones.update_device_info(1, "Opened", "Low Battery") + + # Assert + assert zones[1].state == "Opened" + assert zones[1].status == "Low Battery" + + # ADTPulseZones can update zone attributes with a dictionary containing zone attributes + def test_update_zone_attributes_with_dictionary(self): + """ + Test that ADTPulseZones can update zone attributes with a dictionary containing zone attributes + """ + # Arrange + zones = ADTPulseZones() + dev_attr = { + "name": "Zone 1", + "type_model": "Window Sensor", + "zone": "1", + "status": "Online", + } + + # Act + zones.update_zone_attributes(dev_attr) + + # Assert + assert len(zones) == 1 + assert zones[1].name == "Zone 1" + assert zones[1].id_ == "sensor-1" + assert zones[1].tags == ADT_NAME_TO_DEFAULT_TAGS["Window"] + assert zones[1].status == "Online" + assert zones[1].state == "Unknown" + assert zones[1].last_activity_timestamp == 0 + + # ADTPulseZones raises a KeyError if the key is not an int when getting or setting a Zone + def test_key_not_int(self): + """ + Test that ADTPulseZones raises a KeyError if the key is not an int when getting or setting a Zone + """ + # Arrange + zones = ADTPulseZones() + valid_key = 1 + invalid_key = "1" + value = ADTPulseZoneData("Zone 1", "sensor-1") + + # Act + zones[valid_key] = value + + # Assert + with pytest.raises(KeyError): + zones[invalid_key] + + # ADTPulseZones can flatten its data into a list of ADTPulseFlattendZone + def test_flatten_method(self): + """ + Test that ADTPulseZones can flatten its data into a list of ADTPulseFlattendZone + """ + # Arrange + zones = ADTPulseZones() + zones[1] = ADTPulseZoneData("Zone 1", "sensor-1") + zones[2] = ADTPulseZoneData("Zone 2", "sensor-2") + zones[3] = ADTPulseZoneData("Zone 3", "sensor-3") + + # Act + flattened_zones = zones.flatten() + + # Assert + assert len(flattened_zones) == 3 + assert flattened_zones[0]["zone"] == 1 + assert flattened_zones[0]["name"] == "Zone 1" + assert flattened_zones[0]["id_"] == "sensor-1" + assert flattened_zones[1]["zone"] == 2 + assert flattened_zones[1]["name"] == "Zone 2" + assert flattened_zones[1]["id_"] == "sensor-2" + assert flattened_zones[2]["zone"] == 3 + assert flattened_zones[2]["name"] == "Zone 3" + assert flattened_zones[2]["id_"] == "sensor-3" + + # ADTPulseZones raises a ValueError if the value is not ADTPulseZoneData when setting a Zone + def test_raises_value_error_if_value_not_adtpulsezonedata(self): + """ + Test that ADTPulseZones raises a ValueError if the value is not ADTPulseZoneData when setting a Zone + """ + # Arrange + zones = ADTPulseZones() + + # Act and Assert + with pytest.raises(ValueError): + zones[1] = "Invalid Zone Data" + + # ADTPulseZones raises a ValueError when setting a Zone with a non-ADTPulseZoneData value + def test_raises_value_error_when_setting_zone_with_non_adtpulsezonedata_value(self): + """ + Test that ADTPulseZones raises a ValueError when setting a Zone with a non-ADTPulseZoneData value + """ + # Arrange + zones = ADTPulseZones() + key = 1 + value = "Not ADTPulseZoneData" + + # Act & Assert + with pytest.raises(ValueError): + zones[key] = value + + # ADTPulseZones raises a ValueError when setting a Zone with a string value + def test_raises_value_error_when_setting_zone_with_string_value(self): + """ + Test that ADTPulseZones raises a ValueError when setting a Zone with a string value + """ + # Arrange + zones = ADTPulseZones() + + # Act and Assert + with pytest.raises(ValueError): + zones[1] = "Zone 1" + + # ADTPulseZones raises a ValueError when setting a Zone with a list value + def test_raises_value_error_when_setting_zone_with_list_value(self): + """ + Test that ADTPulseZones raises a ValueError when setting a Zone with a list value + """ + # Arrange + zones = ADTPulseZones() + key = 1 + value = [1, 2, 3] + + # Act & Assert + with pytest.raises(ValueError): + zones[key] = value + + # ADTPulseZones sets default values for ADTPulseZoneData.id_ and name if not set when setting a Zone + def test_default_values_for_id_and_name(self): + """ + Test that ADTPulseZones sets default values for ADTPulseZoneData.id_ and name if not set when setting a Zone + """ + # Arrange + zones = ADTPulseZones() + + # Act + zones[1] = ADTPulseZoneData("", "") + + # Assert + assert zones[1].id_ == "sensor-1" + assert zones[1].name == "Sensor for Zone 1" + + # ADTPulseZones raises a ValueError if there is invalid Zone data in ADTPulseZones when flattening + def test_invalid_zone_data_in_flattening(self): + """ + Test that ADTPulseZones raises a ValueError if there is invalid Zone data in ADTPulseZones when flattening + """ + # Arrange + zones = ADTPulseZones() + zones[1] = ADTPulseZoneData("Zone 1", "sensor-1") + zones[2] = ADTPulseZoneData("Zone 2", "sensor-2") + zones[3] = ADTPulseZoneData("Zone 3", "sensor-3") + with pytest.raises(TypeCheckError): + zones[ + 3 + ].tags = "Invalid Tags" # Modify one of the zone data to an invalid type + + # ADTPulseZones skips incomplete zone data when updating zone attributes + def test_skips_incomplete_zone_data(self): + """ + Test that ADTPulseZones skips incomplete zone data when updating zone attributes + """ + # Arrange + zones = ADTPulseZones() + dev_attr = { + "name": "Zone 1", + "type_model": "Window Sensor", + "zone": "1", + "status": "Online", + } + + # Act + zones.update_zone_attributes(dev_attr) + + # Assert + assert len(zones) == 1 + assert zones[1].name == "Zone 1" + assert zones[1].id_ == "sensor-1" + assert zones[1].tags == ADT_NAME_TO_DEFAULT_TAGS["Window"] + assert zones[1].status == "Online" + assert zones[1].state == "Unknown" + assert zones[1].last_activity_timestamp == 0 + + # ADTPulseZones can handle unknown sensor types when updating zone attributes + def test_handle_unknown_sensor_types(self): + """ + Test that ADTPulseZones can handle unknown sensor types when updating zone attributes + """ + # Arrange + zones = ADTPulseZones() + dev_attr = { + "name": "Sensor 1", + "type_model": "Unknown Sensor Type", + "zone": "1", + "status": "Online", + } + + # Act + zones.update_zone_attributes(dev_attr) + + # Assert + assert len(zones) == 1 + assert zones[1].name == "Sensor 1" + assert zones[1].id_ == "sensor-1" + assert zones[1].tags == ("sensor", "doorWindow") + assert zones[1].status == "Online" + assert zones[1].state == "Unknown" + assert zones[1].last_activity_timestamp == 0 + + # ADTPulseZones can handle missing status when updating zone attributes + def test_missing_status_handling_fixed(self): + """ + Test that ADTPulseZones can handle missing status when updating zone attributes + """ + # Arrange + zones = ADTPulseZones() + dev_attr = { + "name": "Zone 1", + "type_model": "Window Sensor", + "zone": "1", + "status": "Unknown", # Added status key with value "Unknown" + } + + # Act + zones.update_zone_attributes(dev_attr) + + # Assert + assert len(zones) == 0 + + # ADTPulseZones can handle invalid datetime when updating last activity timestamp + def test_handle_invalid_datetime(self): + """ + Test that ADTPulseZones can handle invalid datetime when updating last activity timestamp + """ + # Arrange + zones = ADTPulseZones() + zones[1] = ADTPulseZoneData("name", "id") + key = 1 + invalid_dt = "2022-13-01 12:00:00" # Invalid datetime format + + # Act + with pytest.raises(ValueError): + dt = datetime.strptime(invalid_dt, "%Y-%m-%d %H:%M:%S") + zones.update_last_activity_timestamp(key, dt) + + # Assert + assert zones[key].last_activity_timestamp == 0 + + # ADTPulseZones can handle missing name when updating zone attributes + def test_handle_missing_name_when_updating_zone_attributes(self): + """ + Test that ADTPulseZones can handle missing name when updating zone attributes + """ + # Arrange + zones = ADTPulseZones() + dev_attr = { + "name": "Unknown", + "type_model": "Window Sensor", + "zone": "1", + "status": "Online", + } + + # Act + zones.update_zone_attributes(dev_attr) + + # Assert + assert len(zones) == 0 + + # ADTPulseZones can handle missing zone when updating zone attributes + def test_handle_missing_zone(self): + """ + Test that ADTPulseZones can handle missing zone when updating zone attributes + """ + # Arrange + zones = ADTPulseZones() + dev_attr = { + "name": "Sensor 1", + "type_model": "Window Sensor", + "zone": "1", + "status": "Online", + } + + # Act + zones.update_zone_attributes(dev_attr) + + # Assert + assert len(zones) == 1 + assert zones[1].name == "Sensor 1" + assert zones[1].id_ == "sensor-1" + assert zones[1].tags == ADT_NAME_TO_DEFAULT_TAGS["Window"] + assert zones[1].status == "Online" + assert zones[1].state == "Unknown" + assert zones[1].last_activity_timestamp == 0 From 589b2fd216b5d6bc23698dd9025c9537df74f6c6 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 24 Dec 2023 12:19:06 -0500 Subject: [PATCH 170/226] pcp tests and fixes --- pyadtpulse/pulse_connection_properties.py | 9 + tests/test_pulse_connection_properties.py | 374 ++++++++++++++++++++++ 2 files changed, 383 insertions(+) create mode 100644 tests/test_pulse_connection_properties.py diff --git a/pyadtpulse/pulse_connection_properties.py b/pyadtpulse/pulse_connection_properties.py index 482cd3e..0e7dfb7 100644 --- a/pyadtpulse/pulse_connection_properties.py +++ b/pyadtpulse/pulse_connection_properties.py @@ -192,6 +192,15 @@ def check_version_string(value: str): parts = value.split("-") if len(parts) == 2: version_parts = parts[0].split(".") + if not ( + version_parts[0].isdigit() + and version_parts[1].isdigit() + and version_parts[2].isdigit() + and parts[1].isdigit() + ): + raise ValueError( + "API version must be in the form major.minor.patch-subpatch" + ) if len(version_parts) == 3 and version_parts[0].isdigit(): major_version = int(version_parts[0]) if major_version >= 26: diff --git a/tests/test_pulse_connection_properties.py b/tests/test_pulse_connection_properties.py new file mode 100644 index 0000000..0051325 --- /dev/null +++ b/tests/test_pulse_connection_properties.py @@ -0,0 +1,374 @@ +# Generated by CodiumAI +from asyncio import AbstractEventLoop + +import pytest +from aiohttp import ClientSession + +from pyadtpulse.const import ADT_DEFAULT_HTTP_USER_AGENT, API_HOST_CA, DEFAULT_API_HOST +from pyadtpulse.pulse_connection_properties import PulseConnectionProperties + + +class TestPulseConnectionProperties: + # Initialize PulseConnectionProperties with valid host + @pytest.mark.asyncio + async def test_initialize_with_valid_host(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = False + + # Act + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Assert + assert connection_properties.service_host == host + assert connection_properties._user_agent == user_agent + assert connection_properties._detailed_debug_logging == detailed_debug_logging + assert connection_properties._debug_locks == debug_locks + + # Set service host to default API host + @pytest.mark.asyncio + async def test_set_service_host_to_default_api_host(self): + # Arrange + host = DEFAULT_API_HOST + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = False + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Act + connection_properties.service_host = DEFAULT_API_HOST + + # Assert + assert connection_properties.service_host == DEFAULT_API_HOST + + # Set service host to API host CA + @pytest.mark.asyncio + async def test_set_service_host_to_api_host_ca(self): + # Arrange + host = DEFAULT_API_HOST + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = False + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Act + connection_properties.service_host = API_HOST_CA + + # Assert + assert connection_properties.service_host == API_HOST_CA + + # Get the service host + @pytest.mark.asyncio + async def test_get_service_host(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = False + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Act & Assert + assert connection_properties.service_host == host + + # Set detailed debug logging to True + @pytest.mark.asyncio + async def test_set_detailed_debug_logging_to_true(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = False + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Act + connection_properties.detailed_debug_logging = True + + # Assert + assert connection_properties.detailed_debug_logging is True + + # Set detailed debug logging to False + @pytest.mark.asyncio + async def test_set_detailed_debug_logging_to_false(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = True + debug_locks = False + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Act + connection_properties.detailed_debug_logging = False + + # Assert + assert connection_properties.detailed_debug_logging is False + + # Initialize PulseConnectionProperties with invalid host raises ValueError + @pytest.mark.asyncio + async def test_initialize_with_invalid_host_raises_value_error(self): + # Arrange + host = "" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = False + + # Act & Assert + with pytest.raises(ValueError): + PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Set service host to valid host does not raise ValueError + @pytest.mark.asyncio + async def test_set_service_host_to_valid_host_does_not_raise_value_error(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = False + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Act & Assert + connection_properties.service_host = host + + # Set API version to invalid version raises ValueError + @pytest.mark.asyncio + async def test_set_api_version_to_invalid_version_raises_value_error(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = False + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Act & Assert + with pytest.raises(ValueError): + connection_properties.api_version = "1.0" + + # Check sync without setting the event loop raises RuntimeError + @pytest.mark.asyncio + async def test_check_sync_without_setting_event_loop_raises_runtime_error(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = False + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Act & Assert + with pytest.raises(RuntimeError): + connection_properties.check_sync("Sync login was not performed") + + # Get the detailed debug logging flag + @pytest.mark.asyncio + async def test_get_detailed_debug_logging_flag(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = True + debug_locks = False + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Act + result = connection_properties.detailed_debug_logging + + # Assert + assert result == detailed_debug_logging + + # Set debug locks to True with a valid service host + @pytest.mark.asyncio + async def test_set_debug_locks_to_true_with_valid_service_host(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = True + + # Act + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Assert + assert connection_properties.service_host == host + assert connection_properties._user_agent == user_agent + assert connection_properties._detailed_debug_logging == detailed_debug_logging + assert connection_properties._debug_locks == debug_locks + + # Get the debug locks flag + @pytest.mark.asyncio + async def test_get_debug_locks_flag(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = True + + # Act + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Assert + assert connection_properties.debug_locks == debug_locks + + # Set debug locks to False with a valid service host + @pytest.mark.asyncio + async def test_set_debug_locks_to_false_with_valid_service_host(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = False + + # Act + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Assert + assert connection_properties.debug_locks == debug_locks + + # Set the event loop + @pytest.mark.asyncio + async def test_set_event_loop(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = False + loop = AbstractEventLoop() + + # Act + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + connection_properties.loop = loop + + # Assert + assert connection_properties.loop == loop + + # Get the event loop + @pytest.mark.asyncio + async def test_get_event_loop(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = False + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Act + event_loop = connection_properties.loop + + # Assert + assert event_loop is None + + # Set the API version + @pytest.mark.asyncio + async def test_set_api_version(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = False + version = "26.0.0-subpatch" + + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Act + with pytest.raises(ValueError): + connection_properties.api_version = version + version = "26.0.0" + with pytest.raises(ValueError): + connection_properties.api_version = version + version = "25.0.0-22" + with pytest.raises(ValueError): + connection_properties.api_version = version + version = "26.0.0-22" + connection_properties.api_version = version + # Assert + assert connection_properties.api_version == version + + # Get the API version + @pytest.mark.asyncio + async def test_get_api_version(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = False + response_path = "example.com/api/v1" + + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Act + api_version = connection_properties.get_api_version(response_path) + + # Assert + assert api_version is None + + # Get the session with a valid host + @pytest.mark.asyncio + async def test_get_session_with_valid_host(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = False + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Act + session = connection_properties.session + + # Assert + assert isinstance(session, ClientSession) + assert connection_properties._session == session + + # Check async after setting the event loop raises RuntimeError + @pytest.mark.asyncio + async def test_check_async_after_setting_event_loop_raises_runtime_error(self): + # Arrange + host = "https://portal.adtpulse.com" + user_agent = ADT_DEFAULT_HTTP_USER_AGENT["User-Agent"] + detailed_debug_logging = False + debug_locks = False + connection_properties = PulseConnectionProperties( + host, user_agent, detailed_debug_logging, debug_locks + ) + + # Act + connection_properties.loop = AbstractEventLoop() + + # Assert + with pytest.raises(RuntimeError): + connection_properties.check_async("Async login not performed") From 4374650cbe89490669fdc4bcefa1040672ad8ddf Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 24 Dec 2023 12:33:34 -0500 Subject: [PATCH 171/226] add test_pulse_connection_status --- tests/test_pulse_connection_status.py | 184 ++++++++++++++++++++++++++ 1 file changed, 184 insertions(+) create mode 100644 tests/test_pulse_connection_status.py diff --git a/tests/test_pulse_connection_status.py b/tests/test_pulse_connection_status.py new file mode 100644 index 0000000..99d4ff8 --- /dev/null +++ b/tests/test_pulse_connection_status.py @@ -0,0 +1,184 @@ +# Generated by CodiumAI +import pytest + +from pyadtpulse.pulse_backoff import PulseBackoff +from pyadtpulse.pulse_connection_status import PulseConnectionStatus + + +class TestPulseConnectionStatus: + # PulseConnectionStatus can be initialized without errors + def test_initialized_without_errors(self): + """ + Test that PulseConnectionStatus can be initialized without errors. + """ + pcs = PulseConnectionStatus() + assert pcs is not None + + # authenticated_flag can be accessed without errors + def test_access_authenticated_flag(self): + """ + Test that authenticated_flag can be accessed without errors. + """ + pcs = PulseConnectionStatus() + authenticated_flag = pcs.authenticated_flag + assert authenticated_flag is not None + + # retry_after can be accessed without errors + def test_access_retry_after(self): + """ + Test that retry_after can be accessed without errors. + """ + pcs = PulseConnectionStatus() + retry_after = pcs.retry_after + assert retry_after is not None + + # retry_after can be set without errors + def test_set_retry_after(self): + """ + Test that retry_after can be set without errors. + """ + import time + + pcs = PulseConnectionStatus() + current_time = time.time() + retry_time = current_time + 1000 + pcs.retry_after = retry_time + assert pcs.retry_after == retry_time + + # get_backoff returns a PulseBackoff object + def test_get_backoff(self): + """ + Test that get_backoff returns a PulseBackoff object. + """ + pcs = PulseConnectionStatus() + backoff = pcs.get_backoff() + assert isinstance(backoff, PulseBackoff) + + # increment_backoff can be called without errors + def test_increment_backoff(self): + """ + Test that increment_backoff can be called without errors. + """ + pcs = PulseConnectionStatus() + pcs.increment_backoff() + + # retry_after can be set to a time in the future + def test_set_retry_after_past_time_fixed(self): + """ + Test that retry_after can be set to a time in the future. + """ + import time + + pcs = PulseConnectionStatus() + current_time = time.time() + past_time = current_time - 10.0 + with pytest.raises(ValueError): + pcs.retry_after = past_time + + # retry_after can be set to a time in the future + def test_set_retry_after_future_time_fixed(self): + """ + Test that retry_after can be set to a time in the future. + """ + import time + + pcs = PulseConnectionStatus() + pcs.retry_after = time.time() + 10.0 + assert pcs.retry_after > time.time() + + # retry_after can be set to a positive value greater than the current time + def test_set_retry_after_negative_value_fixed(self): + """ + Test that retry_after can be set to a positive value greater than the current time. + """ + from time import time + + pcs = PulseConnectionStatus() + retry_after_time = time() + 10.0 + pcs.retry_after = retry_after_time + assert pcs.retry_after == retry_after_time + + # retry_after can be set to a very large value + def test_set_retry_after_large_value(self): + """ + Test that retry_after can be set to a very large value. + """ + pcs = PulseConnectionStatus() + pcs.retry_after = float("inf") + assert pcs.retry_after == float("inf") + + # retry_after can be set to a non-numeric value + def test_set_retry_after_non_numeric_value_fixed(self): + """ + Test that retry_after can be set to a non-numeric value. + """ + import time + + pcs = PulseConnectionStatus() + retry_after_time = time.time() + 5.0 + pcs.retry_after = retry_after_time + assert pcs.retry_after == retry_after_time + + # reset_backoff can be called without errors + def test_reset_backoff(self): + """ + Test that reset_backoff can be called without errors. + """ + pcs = PulseConnectionStatus() + pcs.reset_backoff() + + # authenticated_flag can be set to True + def test_authenticated_flag_set_to_true(self): + """ + Test that authenticated_flag can be set to True. + """ + pcs = PulseConnectionStatus() + pcs.authenticated_flag.set() + assert pcs.authenticated_flag.is_set() + + # authenticated_flag can be set to False + def test_authenticated_flag_false(self): + """ + Test that authenticated_flag can be set to False. + """ + pcs = PulseConnectionStatus() + pcs.authenticated_flag.clear() + assert not pcs.authenticated_flag.is_set() + + # Test that get_backoff returns the same PulseBackoff object every time it is called. + def test_get_backoff_returns_same_object(self): + """ + Test that get_backoff returns the same PulseBackoff object every time it is called. + Arrange: + - Create an instance of PulseConnectionStatus + Act: + - Call get_backoff method twice + Assert: + - The returned PulseBackoff objects are the same + """ + pcs = PulseConnectionStatus() + backoff1 = pcs.get_backoff() + backoff2 = pcs.get_backoff() + assert backoff1 is backoff2 + + # increment_backoff increases the backoff count by 1 + def test_increment_backoff(self): + """ + Test that increment_backoff increases the backoff count by 1. + """ + pcs = PulseConnectionStatus() + initial_backoff_count = pcs.get_backoff().backoff_count + pcs.increment_backoff() + new_backoff_count = pcs.get_backoff().backoff_count + assert new_backoff_count == initial_backoff_count + 1 + + # reset_backoff sets the backoff count to 0 and the expiration time to 0.0 + def test_reset_backoff_sets_backoff_count_and_expiration_time(self): + """ + Test that reset_backoff sets the backoff count to 0 and the expiration time to 0.0. + """ + pcs = PulseConnectionStatus() + pcs.increment_backoff() + pcs.reset_backoff() + assert pcs.get_backoff().backoff_count == 0 + assert pcs.get_backoff().expiration_time == 0.0 From 9ec46b22582f33de4470a94341d77064b0d61650 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 24 Dec 2023 14:24:22 -0500 Subject: [PATCH 172/226] add test_gateway and fixes --- pyadtpulse/alarm_panel.py | 11 ++ pyadtpulse/gateway.py | 55 +++++- tests/test_gateway.py | 378 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 440 insertions(+), 4 deletions(-) create mode 100644 tests/test_gateway.py diff --git a/pyadtpulse/alarm_panel.py b/pyadtpulse/alarm_panel.py index 057d512..994f6f3 100644 --- a/pyadtpulse/alarm_panel.py +++ b/pyadtpulse/alarm_panel.py @@ -8,6 +8,7 @@ from time import time from bs4 import BeautifulSoup +from typeguard import typechecked from .const import ADT_ARM_DISARM_URI from .pulse_connection import PulseConnection @@ -117,6 +118,7 @@ def last_update(self) -> float: with self._state_lock: return self._last_arm_disarm + @typechecked async def _arm( self, connection: PulseConnection, mode: str, force_arm: bool ) -> bool: @@ -190,6 +192,7 @@ async def _arm( self._last_arm_disarm = int(time()) return True + @typechecked def _sync_set_alarm_mode( self, connection: PulseConnection, @@ -204,6 +207,7 @@ def _sync_set_alarm_mode( ), ).result() + @typechecked def arm_away(self, connection: PulseConnection, force_arm: bool = False) -> bool: """Arm the alarm in Away mode. @@ -215,6 +219,7 @@ def arm_away(self, connection: PulseConnection, force_arm: bool = False) -> bool """ return self._sync_set_alarm_mode(connection, ADT_ALARM_AWAY, force_arm) + @typechecked def arm_home(self, connection: PulseConnection, force_arm: bool = False) -> bool: """Arm the alarm in Home mode. @@ -226,6 +231,7 @@ def arm_home(self, connection: PulseConnection, force_arm: bool = False) -> bool """ return self._sync_set_alarm_mode(connection, ADT_ALARM_HOME, force_arm) + @typechecked def disarm(self, connection: PulseConnection) -> bool: """Disarm the alarm. @@ -234,6 +240,7 @@ def disarm(self, connection: PulseConnection) -> bool: """ return self._sync_set_alarm_mode(connection, ADT_ALARM_OFF, False) + @typechecked async def async_arm_away( self, connection: PulseConnection, force_arm: bool = False ) -> bool: @@ -247,6 +254,7 @@ async def async_arm_away( """ return await self._arm(connection, ADT_ALARM_AWAY, force_arm) + @typechecked async def async_arm_home( self, connection: PulseConnection, force_arm: bool = False ) -> bool: @@ -259,6 +267,7 @@ async def async_arm_home( """ return await self._arm(connection, ADT_ALARM_HOME, force_arm) + @typechecked async def async_disarm(self, connection: PulseConnection) -> bool: """Disarm alarm async. @@ -267,6 +276,7 @@ async def async_disarm(self, connection: PulseConnection) -> bool: """ return await self._arm(connection, ADT_ALARM_OFF, False) + @typechecked def update_alarm_from_soup(self, summary_html_soup: BeautifulSoup) -> None: """ Updates the alarm status based on the information extracted from the provided @@ -332,6 +342,7 @@ def update_alarm_from_soup(self, summary_html_soup: BeautifulSoup) -> None: else: LOG.warning("Unable to extract sat") + @typechecked def set_alarm_attributes(self, alarm_attributes: dict[str, str]) -> None: """ Set alarm attributes including model, manufacturer, and online status. diff --git a/pyadtpulse/gateway.py b/pyadtpulse/gateway.py index 3ac78d1..226f266 100644 --- a/pyadtpulse/gateway.py +++ b/pyadtpulse/gateway.py @@ -1,6 +1,7 @@ """ADT Pulse Gateway Dataclass.""" import logging +import re from dataclasses import dataclass from ipaddress import IPv4Address, IPv6Address, ip_address from threading import RLock @@ -57,11 +58,11 @@ class ADTPulseGateway: primary_connection_type: str | None = None broadband_connection_status: str | None = None cellular_connection_status: str | None = None - cellular_connection_signal_strength: float = 0.0 + _cellular_connection_signal_strength: float = 0.0 broadband_lan_ip_address: IPv4Address | IPv6Address | None = None - broadband_lan_mac: str | None = None + _broadband_lan_mac: str | None = None device_lan_ip_address: IPv4Address | IPv6Address | None = None - device_lan_mac: str | None = None + _device_lan_mac: str | None = None router_lan_ip_address: IPv4Address | IPv6Address | None = None router_wan_ip_address: IPv4Address | IPv6Address | None = None @@ -109,7 +110,52 @@ def poll_interval(self, new_interval: float) -> None: with self._attribute_lock: self.backoff.initial_backoff_interval = new_interval + @staticmethod + def _check_mac_address(mac_address: str) -> bool: + pattern = r"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$" + return re.match(pattern, mac_address) is not None + + @property + def broadband_lan_mac(self) -> str | None: + """Get current gateway MAC address.""" + return self._broadband_lan_mac + + @broadband_lan_mac.setter + @typechecked + def broadband_lan_mac(self, new_mac: str | None) -> None: + """Set gateway MAC address.""" + if new_mac is not None and not self._check_mac_address(new_mac): + raise ValueError("Invalid MAC address") + self._broadband_lan_mac = new_mac + + @property + def device_lan_mac(self) -> str | None: + """Get current gateway MAC address.""" + return self._device_lan_mac + + @device_lan_mac.setter + @typechecked + def device_lan_mac(self, new_mac: str | None) -> None: + """Set gateway MAC address.""" + if new_mac is not None and not self._check_mac_address(new_mac): + raise ValueError("Invalid MAC address") + self._device_lan_mac = new_mac + + @property + def cellular_connection_signal_strength(self) -> float: + """Get current gateway MAC address.""" + return self._cellular_connection_signal_strength + + @cellular_connection_signal_strength.setter @typechecked + def cellular_connection_signal_strength( + self, new_signal_strength: float | None + ) -> None: + """Set gateway MAC address.""" + if not new_signal_strength: + new_signal_strength = 0.0 + self._cellular_connection_signal_strength = new_signal_strength + def set_gateway_attributes(self, gateway_attributes: dict[str, str]) -> None: """Set gateway attributes from dictionary. @@ -137,4 +183,5 @@ def set_gateway_attributes(self, gateway_attributes: dict[str, str]) -> None: temp = int(parse_pulse_datetime(temp).timestamp()) except ValueError: temp = None - setattr(self, i, temp) + if hasattr(self, i): + setattr(self, i, temp) diff --git a/tests/test_gateway.py b/tests/test_gateway.py new file mode 100644 index 0000000..842c2ea --- /dev/null +++ b/tests/test_gateway.py @@ -0,0 +1,378 @@ +# Generated by CodiumAI +from ipaddress import IPv4Address + +import pytest + +from pyadtpulse.const import ( + ADT_DEFAULT_POLL_INTERVAL, + ADT_GATEWAY_MAX_OFFLINE_POLL_INTERVAL, +) +from pyadtpulse.gateway import ADTPulseGateway + + +# ADTPulseGateway object can be created with default values +def test_default_values(): + """ + Test that ADTPulseGateway object can be created with default values + """ + gateway = ADTPulseGateway() + assert gateway.manufacturer == "Unknown" + assert gateway._status_text == "OFFLINE" + assert gateway.backoff._name == "Gateway" + assert gateway.backoff._initial_backoff_interval == ADT_DEFAULT_POLL_INTERVAL + assert ( + gateway.backoff._max_backoff_interval == ADT_GATEWAY_MAX_OFFLINE_POLL_INTERVAL + ) + assert gateway.backoff._backoff_count == 0 + assert gateway.backoff._expiration_time == 0.0 + assert gateway.backoff._detailed_debug_logging == False + assert gateway.backoff._threshold == 0 + assert gateway.model == None + assert gateway.serial_number == None + assert gateway.next_update == 0 + assert gateway.last_update == 0 + assert gateway.firmware_version == None + assert gateway.hardware_version == None + assert gateway.primary_connection_type == None + assert gateway.broadband_connection_status == None + assert gateway.cellular_connection_status == None + assert gateway._cellular_connection_signal_strength == 0.0 + assert gateway.broadband_lan_ip_address == None + assert gateway._broadband_lan_mac == None + assert gateway.device_lan_ip_address == None + assert gateway._device_lan_mac == None + assert gateway.router_lan_ip_address == None + assert gateway.router_wan_ip_address == None + + +# is_online property returns correct online status +def test_is_online_property(): + """ + Test that is_online property returns correct online status + """ + gateway = ADTPulseGateway() + assert gateway.is_online == False + gateway.is_online = True + assert gateway.is_online == True + gateway.is_online = False + assert gateway.is_online == False + + +# poll_interval property can be set and returns correct value +def test_poll_interval_property(): + """ + Test that poll_interval property can be set and returns correct value + """ + gateway = ADTPulseGateway() + assert gateway.poll_interval == ADT_DEFAULT_POLL_INTERVAL + gateway.poll_interval = 60.0 + assert gateway.poll_interval == 60.0 + + +# gateway MAC addresses can be set and retrieved +def test_gateway_mac_addresses(): + """ + Test that gateway MAC addresses can be set and retrieved + """ + gateway = ADTPulseGateway() + gateway.broadband_lan_mac = "00:11:22:33:44:55" + assert gateway.broadband_lan_mac == "00:11:22:33:44:55" + gateway.device_lan_mac = "AA:BB:CC:DD:EE:FF" + assert gateway.device_lan_mac == "AA:BB:CC:DD:EE:FF" + + +# cellular connection signal strength can be set and retrieved +def test_cellular_connection_signal_strength(): + """ + Test that cellular connection signal strength can be set and retrieved + """ + gateway = ADTPulseGateway() + gateway.cellular_connection_signal_strength = -70.5 + assert gateway.cellular_connection_signal_strength == -70.5 + + +# set_gateway_attributes method sets attributes correctly +def test_set_gateway_attributes_sets_attributes_correctly(): + """ + Test that set_gateway_attributes method sets attributes correctly + """ + gateway = ADTPulseGateway() + attributes = { + "manufacturer": "ADT", + "model": "1234", + "serial_number": "5678", + "firmware_version": "1.0", + "hardware_version": "2.0", + "primary_connection_type": "Ethernet", + "broadband_connection_status": "Connected", + "cellular_connection_status": "Connected", + "broadband_lan_mac": "00:11:22:33:44:55", + "device_lan_mac": "AA:BB:CC:DD:EE:FF", + "cellular_connection_signal_strength": 4.5, + } + + gateway.set_gateway_attributes(attributes) + + assert gateway.manufacturer == "ADT" + assert gateway.model == "1234" + assert gateway.serial_number == "5678" + assert gateway.firmware_version == "1.0" + assert gateway.hardware_version == "2.0" + assert gateway.primary_connection_type == "Ethernet" + assert gateway.broadband_connection_status == "Connected" + assert gateway.cellular_connection_status == "Connected" + assert gateway.broadband_lan_mac == "00:11:22:33:44:55" + assert gateway.device_lan_mac == "AA:BB:CC:DD:EE:FF" + assert gateway.cellular_connection_signal_strength == 4.5 + + +# backoff object can be created with default values and current backoff interval can be retrieved +def test_default_values2(): + """ + Test that ADTPulseGateway object can be created with default values + """ + gateway = ADTPulseGateway() + assert gateway.manufacturer == "Unknown" + assert gateway._status_text == "OFFLINE" + assert gateway.backoff._name == "Gateway" + assert gateway.backoff._initial_backoff_interval == ADT_DEFAULT_POLL_INTERVAL + assert ( + gateway.backoff._max_backoff_interval == ADT_GATEWAY_MAX_OFFLINE_POLL_INTERVAL + ) + assert gateway.backoff._backoff_count == 0 + assert gateway.backoff._expiration_time == 0.0 + assert gateway.backoff._detailed_debug_logging == False + assert gateway.backoff._threshold == 0 + assert gateway.model == None + assert gateway.serial_number == None + assert gateway.next_update == 0 + assert gateway.last_update == 0 + assert gateway.firmware_version == None + assert gateway.hardware_version == None + assert gateway.primary_connection_type == None + assert gateway.broadband_connection_status == None + assert gateway.cellular_connection_status == None + assert gateway._cellular_connection_signal_strength == 0.0 + assert gateway.broadband_lan_ip_address == None + assert gateway._broadband_lan_mac == None + assert gateway.device_lan_ip_address == None + assert gateway._device_lan_mac == None + assert gateway.router_lan_ip_address == None + assert gateway.router_wan_ip_address == None + + +# backoff object can be incremented and reset correctly +def test_backoff_increment_and_reset(): + """ + Test that backoff object can be incremented and reset correctly + """ + gateway = ADTPulseGateway() + + # Increment backoff count + gateway.backoff.increment_backoff() + assert gateway.backoff._backoff_count == 1 + + # Reset backoff count + gateway.backoff.reset_backoff() + assert gateway.backoff._backoff_count == 0 + + +# is_online property returns correct offline status when set to False +def test_is_online_returns_correct_offline_status_when_set_to_false(): + """ + Test that is_online property returns correct offline status when set to False + """ + gateway = ADTPulseGateway() + gateway.is_online = False + assert gateway.is_online == False + + +# poll_interval property raises ValueError when set to 0 +def test_poll_interval_raises_value_error_when_set_to_0(): + """ + Test that poll_interval property raises ValueError when set to 0 + """ + gateway = ADTPulseGateway() + with pytest.raises(ValueError): + gateway.poll_interval = 0 + + +# backoff object can wait for correct amount of time before returning +@pytest.mark.asyncio +async def test_backoff_wait_time(): + """ + Test that backoff object can wait for correct amount of time before returning + """ + import time # Import the 'time' module + + # Arrange + gateway = ADTPulseGateway() + gateway.backoff._backoff_count = 1 + gateway.backoff._threshold = 0 + gateway.backoff._initial_backoff_interval = 1.0 + gateway.backoff._max_backoff_interval = 10.0 + gateway.backoff._expiration_time = time.time() + 5.0 + + # Act + start_time = time.time() + await gateway.backoff.wait_for_backoff() + + # Assert + end_time = time.time() + assert end_time - start_time >= 5.0 + + +# Test that set_gateway_attributes method sets attributes to None when given an empty string +def test_set_gateway_attributes_empty_string_fixed(): + """ + Test that set_gateway_attributes method sets attributes to None when given an empty string + """ + gateway = ADTPulseGateway() + gateway.set_gateway_attributes( + {"model": "", "serial_number": "", "firmware_version": ""} + ) + assert gateway.model is None + assert gateway.serial_number is None + assert gateway.firmware_version is None + + +# cellular connection signal strength can be set to 0.0 +def test_cellular_connection_signal_strength_to_zero(): + """ + Test that cellular connection signal strength can be set to 0.0 + """ + gateway = ADTPulseGateway() + gateway.cellular_connection_signal_strength = 0.0 + assert gateway.cellular_connection_signal_strength == 0.0 + + +# poll_interval property raises ValueError when set to a value greater than ADT_GATEWAY_MAX_OFFLINE_POLL_INTERVAL +def test_poll_interval_raises_value_error(): + """ + Test that poll_interval property raises ValueError when set to a value greater than ADT_GATEWAY_MAX_OFFLINE_POLL_INTERVAL + """ + gateway = ADTPulseGateway() + with pytest.raises(ValueError): + gateway.poll_interval = ADT_GATEWAY_MAX_OFFLINE_POLL_INTERVAL + 1 + + +# Test that set_gateway_attributes method sets attributes to a valid value when given a valid value +def test_set_gateway_attributes_valid_value(): + """ + Test that set_gateway_attributes method sets attributes to a valid value when given a valid value + """ + gateway = ADTPulseGateway() + gateway.set_gateway_attributes({"broadband_lan_mac": "00:0a:95:9d:68:16"}) + assert gateway.broadband_lan_mac == "00:0a:95:9d:68:16" + + +# Test that set_gateway_attributes method sets IP address attributes to None when given an invalid IP address +def test_set_gateway_attributes_invalid_ip(): + """ + Test that set_gateway_attributes method sets IP address attributes to None when given an invalid IP address + """ + gateway = ADTPulseGateway() + gateway.set_gateway_attributes({"broadband_lan_ip_address": "invalid_ip"}) + assert gateway.broadband_lan_ip_address is None + gateway.set_gateway_attributes({"device_lan_ip_address": "invalid_ip"}) + assert gateway.device_lan_ip_address is None + gateway.set_gateway_attributes({"router_lan_ip_address": "invalid_ip"}) + assert gateway.router_lan_ip_address is None + gateway.set_gateway_attributes({"router_wan_ip_address": "invalid_ip"}) + assert gateway.router_wan_ip_address is None + + +# gateway MAC addresses raise ValueError when set to an invalid MAC address +def test_gateway_mac_address_invalid(): + """ + Test that setting an invalid MAC address raises a ValueError + """ + gateway = ADTPulseGateway() + with pytest.raises(ValueError): + gateway.broadband_lan_mac = "00:00:00:00:00:00:00" + with pytest.raises(ValueError): + gateway.device_lan_mac = "00:00:00:00:00:00:00" + + +# is_online property can be set to True and False +def test_is_online_property_true_and_false(): + """ + Test that is_online property can be set to True and False + """ + gateway = ADTPulseGateway() + + # Test setting is_online to True + gateway.is_online = True + assert gateway.is_online == True + assert gateway._status_text == "ONLINE" + + # Test setting is_online to False + gateway.is_online = False + assert gateway.is_online == False + assert gateway._status_text == "OFFLINE" + + +# poll_interval property can be set to a custom value +def test_poll_interval_custom_value(): + """ + Test that poll_interval property can be set to a custom value + """ + gateway = ADTPulseGateway() + custom_interval = 10.0 + gateway.poll_interval = custom_interval + assert gateway.poll_interval == custom_interval + + +# ADTPulseGateway object can be created with custom values +def test_custom_values(): + """ + Test that ADTPulseGateway object can be created with custom values + """ + gateway = ADTPulseGateway( + manufacturer="Custom Manufacturer", + _status_text="CUSTOM_STATUS", + model="Custom Model", + serial_number="Custom Serial Number", + next_update=1234567890, + last_update=9876543210, + firmware_version="Custom Firmware Version", + hardware_version="Custom Hardware Version", + primary_connection_type="Custom Connection Type", + broadband_connection_status="Custom Broadband Status", + cellular_connection_status="Custom Cellular Status", + _cellular_connection_signal_strength=0.5, + broadband_lan_ip_address=IPv4Address("192.168.0.1"), + _broadband_lan_mac="00:11:22:33:44:55", + device_lan_ip_address=IPv4Address("192.168.0.2"), + _device_lan_mac="AA:BB:CC:DD:EE:FF", + router_lan_ip_address=IPv4Address("192.168.1.1"), + router_wan_ip_address=IPv4Address("10.0.0.1"), + ) + + assert gateway.manufacturer == "Custom Manufacturer" + assert gateway._status_text == "CUSTOM_STATUS" + assert gateway.backoff._name == "Gateway" + assert gateway.backoff._initial_backoff_interval == ADT_DEFAULT_POLL_INTERVAL + assert ( + gateway.backoff._max_backoff_interval == ADT_GATEWAY_MAX_OFFLINE_POLL_INTERVAL + ) + assert gateway.backoff._backoff_count == 0 + assert gateway.backoff._expiration_time == 0.0 + assert gateway.backoff._detailed_debug_logging == False + assert gateway.backoff._threshold == 0 + assert gateway.model == "Custom Model" + assert gateway.serial_number == "Custom Serial Number" + assert gateway.next_update == 1234567890 + assert gateway.last_update == 9876543210 + assert gateway.firmware_version == "Custom Firmware Version" + assert gateway.hardware_version == "Custom Hardware Version" + assert gateway.primary_connection_type == "Custom Connection Type" + assert gateway.broadband_connection_status == "Custom Broadband Status" + assert gateway.cellular_connection_status == "Custom Cellular Status" + assert gateway._cellular_connection_signal_strength == 0.5 + assert gateway.broadband_lan_ip_address == IPv4Address("192.168.0.1") + assert gateway._broadband_lan_mac == "00:11:22:33:44:55" + assert gateway.device_lan_ip_address == IPv4Address("192.168.0.2") + assert gateway._device_lan_mac == "AA:BB:CC:DD:EE:FF" + assert gateway.router_lan_ip_address == IPv4Address("192.168.1.1") + assert gateway.router_wan_ip_address == IPv4Address("10.0.0.1") From 69ff9f71053bdc76bba1bc5d4fff4ff4b958c02f Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 24 Dec 2023 15:30:26 -0500 Subject: [PATCH 173/226] add codium pqm tests --- pyadtpulse/exceptions.py | 2 +- tests/test_pqm_codium.py | 740 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 741 insertions(+), 1 deletion(-) create mode 100644 tests/test_pqm_codium.py diff --git a/pyadtpulse/exceptions.py b/pyadtpulse/exceptions.py index d64c98d..400838f 100644 --- a/pyadtpulse/exceptions.py +++ b/pyadtpulse/exceptions.py @@ -4,7 +4,7 @@ from .pulse_backoff import PulseBackoff -class PulseExceptionWithBackoff(RuntimeError): +class PulseExceptionWithBackoff(Exception): """Exception with backoff.""" def __init__(self, message: str, backoff: PulseBackoff): diff --git a/tests/test_pqm_codium.py b/tests/test_pqm_codium.py new file mode 100644 index 0000000..e824c5d --- /dev/null +++ b/tests/test_pqm_codium.py @@ -0,0 +1,740 @@ +# Generated by CodiumAI + +# Dependencies: +# pip install pytest-mock +from time import time +from unittest.mock import AsyncMock + +import pytest +from aiohttp.client_exceptions import ( + ClientConnectionError, + ClientConnectorError, + ServerConnectionError, + ServerDisconnectedError, +) +from yarl import URL + +from pyadtpulse.exceptions import ( + PulseClientConnectionError, + PulseNotLoggedInError, + PulseServerConnectionError, + PulseServiceTemporarilyUnavailableError, +) +from pyadtpulse.pulse_backoff import PulseBackoff +from pyadtpulse.pulse_connection_properties import PulseConnectionProperties +from pyadtpulse.pulse_connection_status import PulseConnectionStatus +from pyadtpulse.pulse_query_manager import PulseQueryManager + + +class TestPulseQueryManager: + # can successfully make a GET request to a given URI with a valid service host + @pytest.mark.asyncio + async def test_get_request_success_with_valid_service_host(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_response = (200, "Response", URL("http://example.com")) + + async def mock_async_query( + uri, + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ): + return expected_response + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + + # When + response = await query_manager.async_query("/api/data") + + # Then + assert response == expected_response + + # can successfully make a POST request to a given URI + @pytest.mark.asyncio + async def test_post_request_success(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_response = (200, "Response", URL("http://example.com")) + + async def mock_async_query( + uri, + method, + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ): + return expected_response + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + + # When + response = await query_manager.async_query("/api/data", method="POST") + + # Then + assert response == expected_response + + # can handle HTTP 200 OK response with a valid service host + @pytest.mark.asyncio + async def test_handle_http_200_ok_with_valid_service_host(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_response = (200, "Response", URL("http://example.com")) + + async def mock_async_query( + uri, + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ): + return expected_response + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + + # When + response = await query_manager.async_query("/api/data") + + # Then + assert response == expected_response + + # can handle HTTP 503 Service Unavailable response with fixed mock function + @pytest.mark.asyncio + async def test_handle_http_503_service_unavailable_fixed_fixed(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + + async def mock_async_query( + uri, + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ): + backoff = PulseBackoff( + "Query:GET /api/data", + connection_status.get_backoff().initial_backoff_interval, + threshold=0, + debug_locks=query_manager._debug_locks, + detailed_debug_logging=connection_properties.detailed_debug_logging, + ) + retry_time = await backoff.wait_for_backoff() + if retry_time is None: + retry_time = time() + 1 # Set a future time for retry_time + else: + retry_time += time() + 1 + raise PulseServiceTemporarilyUnavailableError( + "Service Unavailable", backoff, retry_time + ) + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + + # When + with pytest.raises(PulseServiceTemporarilyUnavailableError): + await query_manager.async_query("/api/data") + + # Then + # PulseServiceTemporarilyUnavailableError should be raised + + # can handle HTTP 429 Too Many Requests response with the recommended fix + @pytest.mark.asyncio + async def test_handle_http_429_with_fix(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_response = (429, "Too Many Requests", URL("http://example.com")) + MAX_RETRIES = 3 + + async def mock_async_query( + uri, + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ): + retry_time = time() + 10 # Set a future timestamp for retry_time + raise PulseServiceTemporarilyUnavailableError( + f"Task received Retry-After {expected_response[1]} due to Too Many Requests", + connection_status.get_backoff(), + retry_time, + ) + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + + # When + with pytest.raises(PulseServiceTemporarilyUnavailableError) as exc_info: + await query_manager.async_query("/api/data") + + # Then + assert ( + f"Task received Retry-After {expected_response[1]} due to Too Many Requests" + in str(exc_info.value) + ) + assert exc_info.value.backoff == connection_status.get_backoff() + + # can handle ClientConnectionError with 'Connection refused' message using default parameter values + @pytest.mark.asyncio + async def test_handle_client_connection_error_with_default_values_fixed_fixed( + self, mocker + ): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_error_message = "Connection refused" + expected_backoff = mocker.Mock() + expected_response = (None, None, None, None) + + async def mock_async_query( + uri, + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ): + raise PulseClientConnectionError( + expected_error_message, backoff=PulseBackoff("Query:GET /api/data", 1) + ) + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + mocker.patch.object(PulseQueryManager, "_set_retry_after") + + # When + with pytest.raises(PulseClientConnectionError) as exc_info: + await query_manager.async_query("/api/data") + + # Then + assert ( + str(exc_info.value) + == f"PulseClientConnectionError: {expected_error_message}" + ) + PulseQueryManager._set_retry_after.assert_not_called() + + # can handle ClientConnectorError with non-TimeoutError or BrokenPipeError os_error + @pytest.mark.asyncio + async def test_handle_client_connector_error_with_fix(self, mocker): + # Given + from aiohttp import ClientSession + + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_error = PulseServerConnectionError( + "Error occurred", connection_status.get_backoff() + ) + + async def mock_request(*args, **kwargs): + raise ClientConnectorError( + connection_key=None, os_error=FileNotFoundError("File not found") + ) + + mocker.patch.object(ClientSession, "request", side_effect=mock_request) + + # When, Then + with pytest.raises(PulseServerConnectionError) as ex: + await query_manager.async_query("/api/data") + assert str(ex.value) == str(expected_error) + + # can handle Retry-After header in HTTP response + @pytest.mark.asyncio + async def test_handle_retry_after_header(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_response = (429, "Too Many Requests", URL("http://example.com")) + expected_retry_after = "60" + + async def mock_async_query( + uri, + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ): + raise PulseServiceTemporarilyUnavailableError( + "Task received Retry-After due to ", + connection_status.get_backoff(), + float(expected_retry_after) + time(), + ) + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + + # When + with pytest.raises(PulseServiceTemporarilyUnavailableError) as exc_info: + await query_manager.async_query("/api/data") + + # Then + assert exc_info.value.backoff == connection_status.get_backoff() + + assert connection_status.get_backoff().wait_for_backoff.call_count == 1 + assert connection_status.authenticated_flag.wait.call_count == 0 + assert connection_properties.session.request.call_count == 1 + assert connection_properties.session.request.call_args[0][0] == "GET" + assert connection_properties.session.request.call_args[0][ + 1 + ] == connection_properties.make_url("/api/data") + assert connection_properties.session.request.call_args[1]["headers"] == {} + assert connection_properties.session.request.call_args[1]["params"] is None + assert connection_properties.session.request.call_args[1]["data"] is None + assert connection_properties.session.request.call_args[1]["timeout"] == 1 + + assert connection_status.get_backoff().reset_backoff.call_count == 1 + + # can handle ServerConnectionError with default values + @pytest.mark.asyncio + async def test_handle_server_connection_error_with_default_values(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_error = PulseServerConnectionError( + "Server connection error", query_manager._connection_status.get_backoff() + ) + + async def mock_async_query( + uri, + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ): + raise ServerConnectionError("Server connection error") + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + + # When, Then + with pytest.raises(PulseServerConnectionError) as e: + await query_manager.async_query("/api/data") + assert str(e.value) == str(expected_error) + + # can handle ServerTimeoutError + @pytest.mark.asyncio + async def test_handle_server_timeout_error(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + + async def mock_async_query( + uri, + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ): + raise PulseServerConnectionError("message", connection_status.get_backoff()) + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + + # When + with pytest.raises(PulseServerConnectionError): + await query_manager.async_query( + "/api/data", + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ) + + # can handle ClientConnectionError with 'timed out' message + @pytest.mark.asyncio + async def test_handle_client_connection_error_with_timed_out_message(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_error_message = "Connection refused" + expected_backoff = PulseBackoff( + "Query:GET /api/data", + 1, + threshold=0, + debug_locks=False, + detailed_debug_logging=False, + ) + + async def mock_async_query( + uri, method, extra_params, extra_headers, timeout, requires_authentication + ): + raise ClientConnectionError(expected_error_message) + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + mocker.patch.object(PulseQueryManager, "_handle_network_errors") + + # When + await query_manager.async_query( + "/api/data", + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ) + + # Then + assert query_manager._handle_network_errors.call_count == 1 + assert query_manager._handle_network_errors.call_args == mocker.call( + ClientConnectionError(expected_error_message), + ) + + assert ( + query_manager._connection_status.get_backoff().wait_for_backoff.call_count + == 1 + ) + assert ( + query_manager._connection_status.get_backoff().wait_for_backoff.call_args + == mocker.call() + ) + + assert ( + query_manager._connection_status.get_backoff().increment_backoff.call_count + == 1 + ) + assert ( + query_manager._connection_status.get_backoff().increment_backoff.call_args + == mocker.call() + ) + + assert ( + query_manager._connection_status.get_backoff().reset_backoff.call_count == 0 + ) + + # can handle missing API version + @pytest.mark.asyncio + async def test_handle_missing_api_version(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_response = (200, "Response", URL("http://example.com")) + + async def mock_async_query( + uri, method, extra_params, extra_headers, timeout, requires_authentication + ): + return expected_response + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + + # When + await query_manager.async_fetch_version() + + # Then + assert connection_properties.api_version is not None + + # can handle valid method parameter + @pytest.mark.asyncio + async def test_valid_method_parameter(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_response = (200, "Response", URL("http://example.com")) + + async def mock_async_query( + uri, + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ): + return expected_response + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + mocker.patch.object( + query_manager._connection_status.get_backoff(), + "wait_for_backoff", + new_callable=AsyncMock, + ) + + # When + result = await query_manager.async_query("/api/data") + + # Then + assert result == expected_response + assert ( + query_manager._connection_status.get_backoff().wait_for_backoff.call_count + == 0 + ) + assert query_manager._connection_properties.api_version is None + assert query_manager._connection_status.authenticated_flag.wait.call_count == 0 + assert query_manager._connection_properties.session.request.call_count == 0 + assert query_manager._handle_http_errors.call_count == 0 + assert query_manager._handle_network_errors.call_count == 0 + assert ( + query_manager._connection_status.get_backoff().reset_backoff.call_count == 0 + ) + + # can handle ClientResponseError and include backoff in the raised exception + @pytest.mark.asyncio + async def test_handle_client_response_error_with_backoff(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_response = (429, "Too Many Requests", URL("http://example.com")) + + async def mock_async_query( + uri, + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ): + raise PulseServerConnectionError( + f"HTTP error {expected_response[0]}: {expected_response[1]} connecting to {expected_response[2]}", + connection_status.get_backoff(), + ) + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + + # When + with pytest.raises(PulseServerConnectionError) as exc_info: + await query_manager.async_query("/api/data") + + # Then + assert ( + str(exc_info.value) + == f"PulseServerConnectionError: HTTP error {expected_response[0]}: {expected_response[1]} connecting to {expected_response[2]}" + ) + assert exc_info.value.backoff == connection_status.get_backoff() + + # can handle invalid Retry-After header value format + @pytest.mark.asyncio + async def test_handle_invalid_retry_after_header_format(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_response = (503, "Service Unavailable", URL("http://example.com")) + retry_after_header = "invalid_format" + + async def mock_async_query( + uri, method, extra_params, extra_headers, timeout, requires_authentication + ): + return expected_response + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + + # When + response = await query_manager.async_query( + "/api/data", + method="GET", + extra_params=None, + extra_headers={"Retry-After": retry_after_header}, + timeout=1, + requires_authentication=True, + ) + + # Then + assert response == expected_response + + # can handle non-numeric Retry-After header value + @pytest.mark.asyncio + async def test_handle_non_numeric_retry_after_header_value(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_response = (503, "Service Unavailable", URL("http://example.com")) + retry_after_header = "Thu, 01 Jan 1970 00:00:00 GMT" + + async def mock_async_query( + uri, + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ): + return expected_response + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + + # When + response = await query_manager.async_query( + "/api/data", extra_headers={"Retry-After": retry_after_header} + ) + + # Then + assert response == expected_response + + # can handle TimeoutError + @pytest.mark.asyncio + async def test_handle_timeout_error_fixed(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_response = (0, None, None, None) + + async def mock_async_query( + uri, + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ): + raise TimeoutError() + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + + # When + with pytest.raises(TimeoutError): + await query_manager.async_query( + "/api/data", + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ) + + # Then + assert True + + # can handle PulseClientConnectionError + @pytest.mark.asyncio + async def test_handle_pulse_client_connection_error(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_response = (0, None, None, None) + + async def mock_async_query( + uri, + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ): + raise PulseClientConnectionError( + "Client connection error", connection_status.get_backoff() + ) + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + + # When + with pytest.raises(PulseClientConnectionError): + await query_manager.async_query("/api/data") + + # Then + assert query_manager._handle_pulse_client_connection_error.call_count == 0 + + # can handle ServerDisconnectedError + @pytest.mark.asyncio + async def test_handle_server_disconnected_error(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + + async def mock_async_query( + uri, + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ): + raise ServerDisconnectedError() + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + + # When + with pytest.raises(PulseServerConnectionError): + await query_manager.async_query("/api/data") + + # can handle PulseNotLoggedInError + @pytest.mark.asyncio + async def test_handle_pulse_not_logged_in_error(self, mocker): + # Given + connection_status = PulseConnectionStatus() + connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + query_manager = PulseQueryManager(connection_status, connection_properties) + expected_response = (200, "Response", URL("http://example.com")) + + async def mock_async_query( + uri, + method="GET", + extra_params=None, + extra_headers=None, + timeout=1, + requires_authentication=True, + ): + backoff = PulseBackoff( + "Query:GET /api/data", + connection_status.get_backoff().initial_backoff_interval, + threshold=0, + debug_locks=query_manager._debug_locks, + detailed_debug_logging=connection_properties.detailed_debug_logging, + ) + raise PulseNotLoggedInError("Not logged in", backoff) + + mocker.patch.object( + PulseQueryManager, "async_query", side_effect=mock_async_query + ) + + # When, Then + with pytest.raises(PulseNotLoggedInError): + await query_manager.async_query("/api/data") From 508b7816960daca60bf100e7fe786b7ca12c1486 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 24 Dec 2023 15:35:16 -0500 Subject: [PATCH 174/226] add coverage to poetry test group --- poetry.lock | 66 +++++++++++++++++++++++++++++++++++++++++++++++++- pyproject.toml | 1 + 2 files changed, 66 insertions(+), 1 deletion(-) diff --git a/poetry.lock b/poetry.lock index db9d3e0..a38c9f6 100644 --- a/poetry.lock +++ b/poetry.lock @@ -382,6 +382,70 @@ files = [ {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, ] +[[package]] +name = "coverage" +version = "7.3.4" +description = "Code coverage measurement for Python" +optional = false +python-versions = ">=3.8" +files = [ + {file = "coverage-7.3.4-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:aff2bd3d585969cc4486bfc69655e862028b689404563e6b549e6a8244f226df"}, + {file = "coverage-7.3.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:e4353923f38d752ecfbd3f1f20bf7a3546993ae5ecd7c07fd2f25d40b4e54571"}, + {file = "coverage-7.3.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ea473c37872f0159294f7073f3fa72f68b03a129799f3533b2bb44d5e9fa4f82"}, + {file = "coverage-7.3.4-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:5214362abf26e254d749fc0c18af4c57b532a4bfde1a057565616dd3b8d7cc94"}, + {file = "coverage-7.3.4-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f99b7d3f7a7adfa3d11e3a48d1a91bb65739555dd6a0d3fa68aa5852d962e5b1"}, + {file = "coverage-7.3.4-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:74397a1263275bea9d736572d4cf338efaade2de9ff759f9c26bcdceb383bb49"}, + {file = "coverage-7.3.4-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:f154bd866318185ef5865ace5be3ac047b6d1cc0aeecf53bf83fe846f4384d5d"}, + {file = "coverage-7.3.4-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:e0d84099ea7cba9ff467f9c6f747e3fc3906e2aadac1ce7b41add72e8d0a3712"}, + {file = "coverage-7.3.4-cp310-cp310-win32.whl", hash = "sha256:3f477fb8a56e0c603587b8278d9dbd32e54bcc2922d62405f65574bd76eba78a"}, + {file = "coverage-7.3.4-cp310-cp310-win_amd64.whl", hash = "sha256:c75738ce13d257efbb6633a049fb2ed8e87e2e6c2e906c52d1093a4d08d67c6b"}, + {file = "coverage-7.3.4-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:997aa14b3e014339d8101b9886063c5d06238848905d9ad6c6eabe533440a9a7"}, + {file = "coverage-7.3.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:8a9c5bc5db3eb4cd55ecb8397d8e9b70247904f8eca718cc53c12dcc98e59fc8"}, + {file = "coverage-7.3.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:27ee94f088397d1feea3cb524e4313ff0410ead7d968029ecc4bc5a7e1d34fbf"}, + {file = "coverage-7.3.4-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:8ce03e25e18dd9bf44723e83bc202114817f3367789052dc9e5b5c79f40cf59d"}, + {file = "coverage-7.3.4-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:85072e99474d894e5df582faec04abe137b28972d5e466999bc64fc37f564a03"}, + {file = "coverage-7.3.4-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:a877810ef918d0d345b783fc569608804f3ed2507bf32f14f652e4eaf5d8f8d0"}, + {file = "coverage-7.3.4-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:9ac17b94ab4ca66cf803f2b22d47e392f0977f9da838bf71d1f0db6c32893cb9"}, + {file = "coverage-7.3.4-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:36d75ef2acab74dc948d0b537ef021306796da551e8ac8b467810911000af66a"}, + {file = "coverage-7.3.4-cp311-cp311-win32.whl", hash = "sha256:47ee56c2cd445ea35a8cc3ad5c8134cb9bece3a5cb50bb8265514208d0a65928"}, + {file = "coverage-7.3.4-cp311-cp311-win_amd64.whl", hash = "sha256:11ab62d0ce5d9324915726f611f511a761efcca970bd49d876cf831b4de65be5"}, + {file = "coverage-7.3.4-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:33e63c578f4acce1b6cd292a66bc30164495010f1091d4b7529d014845cd9bee"}, + {file = "coverage-7.3.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:782693b817218169bfeb9b9ba7f4a9f242764e180ac9589b45112571f32a0ba6"}, + {file = "coverage-7.3.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7c4277ddaad9293454da19121c59f2d850f16bcb27f71f89a5c4836906eb35ef"}, + {file = "coverage-7.3.4-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3d892a19ae24b9801771a5a989fb3e850bd1ad2e2b6e83e949c65e8f37bc67a1"}, + {file = "coverage-7.3.4-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3024ec1b3a221bd10b5d87337d0373c2bcaf7afd86d42081afe39b3e1820323b"}, + {file = "coverage-7.3.4-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:a1c3e9d2bbd6f3f79cfecd6f20854f4dc0c6e0ec317df2b265266d0dc06535f1"}, + {file = "coverage-7.3.4-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:e91029d7f151d8bf5ab7d8bfe2c3dbefd239759d642b211a677bc0709c9fdb96"}, + {file = "coverage-7.3.4-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:6879fe41c60080aa4bb59703a526c54e0412b77e649a0d06a61782ecf0853ee1"}, + {file = "coverage-7.3.4-cp312-cp312-win32.whl", hash = "sha256:fd2f8a641f8f193968afdc8fd1697e602e199931012b574194052d132a79be13"}, + {file = "coverage-7.3.4-cp312-cp312-win_amd64.whl", hash = "sha256:d1d0ce6c6947a3a4aa5479bebceff2c807b9f3b529b637e2b33dea4468d75fc7"}, + {file = "coverage-7.3.4-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:36797b3625d1da885b369bdaaa3b0d9fb8865caed3c2b8230afaa6005434aa2f"}, + {file = "coverage-7.3.4-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:bfed0ec4b419fbc807dec417c401499ea869436910e1ca524cfb4f81cf3f60e7"}, + {file = "coverage-7.3.4-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f97ff5a9fc2ca47f3383482858dd2cb8ddbf7514427eecf5aa5f7992d0571429"}, + {file = "coverage-7.3.4-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:607b6c6b35aa49defaebf4526729bd5238bc36fe3ef1a417d9839e1d96ee1e4c"}, + {file = "coverage-7.3.4-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a8e258dcc335055ab59fe79f1dec217d9fb0cdace103d6b5c6df6b75915e7959"}, + {file = "coverage-7.3.4-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:a02ac7c51819702b384fea5ee033a7c202f732a2a2f1fe6c41e3d4019828c8d3"}, + {file = "coverage-7.3.4-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:b710869a15b8caf02e31d16487a931dbe78335462a122c8603bb9bd401ff6fb2"}, + {file = "coverage-7.3.4-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:c6a23ae9348a7a92e7f750f9b7e828448e428e99c24616dec93a0720342f241d"}, + {file = "coverage-7.3.4-cp38-cp38-win32.whl", hash = "sha256:758ebaf74578b73f727acc4e8ab4b16ab6f22a5ffd7dd254e5946aba42a4ce76"}, + {file = "coverage-7.3.4-cp38-cp38-win_amd64.whl", hash = "sha256:309ed6a559bc942b7cc721f2976326efbfe81fc2b8f601c722bff927328507dc"}, + {file = "coverage-7.3.4-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:aefbb29dc56317a4fcb2f3857d5bce9b881038ed7e5aa5d3bcab25bd23f57328"}, + {file = "coverage-7.3.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:183c16173a70caf92e2dfcfe7c7a576de6fa9edc4119b8e13f91db7ca33a7923"}, + {file = "coverage-7.3.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4a4184dcbe4f98d86470273e758f1d24191ca095412e4335ff27b417291f5964"}, + {file = "coverage-7.3.4-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:93698ac0995516ccdca55342599a1463ed2e2d8942316da31686d4d614597ef9"}, + {file = "coverage-7.3.4-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fb220b3596358a86361139edce40d97da7458412d412e1e10c8e1970ee8c09ab"}, + {file = "coverage-7.3.4-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d5b14abde6f8d969e6b9dd8c7a013d9a2b52af1235fe7bebef25ad5c8f47fa18"}, + {file = "coverage-7.3.4-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:610afaf929dc0e09a5eef6981edb6a57a46b7eceff151947b836d869d6d567c1"}, + {file = "coverage-7.3.4-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:d6ed790728fb71e6b8247bd28e77e99d0c276dff952389b5388169b8ca7b1c28"}, + {file = "coverage-7.3.4-cp39-cp39-win32.whl", hash = "sha256:c15fdfb141fcf6a900e68bfa35689e1256a670db32b96e7a931cab4a0e1600e5"}, + {file = "coverage-7.3.4-cp39-cp39-win_amd64.whl", hash = "sha256:38d0b307c4d99a7aca4e00cad4311b7c51b7ac38fb7dea2abe0d182dd4008e05"}, + {file = "coverage-7.3.4-pp38.pp39.pp310-none-any.whl", hash = "sha256:b1e0f25ae99cf247abfb3f0fac7ae25739e4cd96bf1afa3537827c576b4847e5"}, + {file = "coverage-7.3.4.tar.gz", hash = "sha256:020d56d2da5bc22a0e00a5b0d54597ee91ad72446fa4cf1b97c35022f6b6dbf0"}, +] + +[package.extras] +toml = ["tomli"] + [[package]] name = "dill" version = "0.3.7" @@ -1406,4 +1470,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "609be4c77aa6c41a875b902ae7121255cf8d74b8713cd7b42341697efc9c8487" +content-hash = "6766e2d52ef61a8c75ba5f39a66009d361acc0e8a6e30835d15d0ff0c4bfc37f" diff --git a/pyproject.toml b/pyproject.toml index d580271..fe65327 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -35,6 +35,7 @@ pytest-aiohttp = "^1.0.5" pytest-timeout = "^2.2.0" aioresponses = "^0.7.4" freezegun = "^1.2.2" +coverage = "^7.3.4" [tool.poetry.group.dev.dependencies] From a906b3f3fced7eea077d4c6696ca8876e76f88a9 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 24 Dec 2023 15:41:10 -0500 Subject: [PATCH 175/226] add pytest-coverage --- poetry.lock | 48 +++++++++++++++++++++++++++++++++++++++++++++++- pyproject.toml | 2 +- 2 files changed, 48 insertions(+), 2 deletions(-) diff --git a/poetry.lock b/poetry.lock index a38c9f6..6f5dce1 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1008,6 +1008,52 @@ pytest = ">=7.0.0" docs = ["sphinx (>=5.3)", "sphinx-rtd-theme (>=1.0)"] testing = ["coverage (>=6.2)", "flaky (>=3.5.0)", "hypothesis (>=5.7.1)", "mypy (>=0.931)", "pytest-trio (>=0.7.0)"] +[[package]] +name = "pytest-cov" +version = "4.1.0" +description = "Pytest plugin for measuring coverage." +optional = false +python-versions = ">=3.7" +files = [ + {file = "pytest-cov-4.1.0.tar.gz", hash = "sha256:3904b13dfbfec47f003b8e77fd5b589cd11904a21ddf1ab38a64f204d6a10ef6"}, + {file = "pytest_cov-4.1.0-py3-none-any.whl", hash = "sha256:6ba70b9e97e69fcc3fb45bfeab2d0a138fb65c4d0d6a41ef33983ad114be8c3a"}, +] + +[package.dependencies] +coverage = {version = ">=5.2.1", extras = ["toml"]} +pytest = ">=4.6" + +[package.extras] +testing = ["fields", "hunter", "process-tests", "pytest-xdist", "six", "virtualenv"] + +[[package]] +name = "pytest-cover" +version = "3.0.0" +description = "Pytest plugin for measuring coverage. Forked from `pytest-cov`." +optional = false +python-versions = "*" +files = [ + {file = "pytest-cover-3.0.0.tar.gz", hash = "sha256:5bdb6c1cc3dd75583bb7bc2c57f5e1034a1bfcb79d27c71aceb0b16af981dbf4"}, + {file = "pytest_cover-3.0.0-py2.py3-none-any.whl", hash = "sha256:578249955eb3b5f3991209df6e532bb770b647743b7392d3d97698dc02f39ebb"}, +] + +[package.dependencies] +pytest-cov = ">=2.0" + +[[package]] +name = "pytest-coverage" +version = "0.0" +description = "Pytest plugin for measuring coverage. Forked from `pytest-cov`." +optional = false +python-versions = "*" +files = [ + {file = "pytest-coverage-0.0.tar.gz", hash = "sha256:db6af2cbd7e458c7c9fd2b4207cee75258243c8a81cad31a7ee8cfad5be93c05"}, + {file = "pytest_coverage-0.0-py2.py3-none-any.whl", hash = "sha256:dedd084c5e74d8e669355325916dc011539b190355021b037242514dee546368"}, +] + +[package.dependencies] +pytest-cover = "*" + [[package]] name = "pytest-mock" version = "3.12.0" @@ -1470,4 +1516,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "6766e2d52ef61a8c75ba5f39a66009d361acc0e8a6e30835d15d0ff0c4bfc37f" +content-hash = "1cfde95d8b8a4ca560ef86dcba101afdfb750c815a9a25ebff89b3405b63ec65" diff --git a/pyproject.toml b/pyproject.toml index fe65327..8318ab2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -35,7 +35,7 @@ pytest-aiohttp = "^1.0.5" pytest-timeout = "^2.2.0" aioresponses = "^0.7.4" freezegun = "^1.2.2" -coverage = "^7.3.4" +pytest-coverage = "^0.0" [tool.poetry.group.dev.dependencies] From 3eea5e29a5762e0e47a11b4c8a41f88347ff5cca Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 24 Dec 2023 15:52:57 -0500 Subject: [PATCH 176/226] add coverage --- .gitignore | 1 + pyproject.toml | 1 + 2 files changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index 1c513bc..77b4864 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,4 @@ __pycache__ .mypy_cache *.swp .vscode/settings.json +.coverage diff --git a/pyproject.toml b/pyproject.toml index 8318ab2..cdd8454 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -67,5 +67,6 @@ all = true [tool.pytest.ini_options] timeout = 30 +addopts = "--cov=pyadtpulse --cov-report=html" [tool.pyright] From e52eb136ad3edc739a442a56759c832c675218bf Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 25 Dec 2023 00:42:23 -0500 Subject: [PATCH 177/226] add more coverage --- .vscode/tasks.json | 35 +++++++++++++++++++++++++++++++++++ pyproject.toml | 2 +- tests/test_pqm_codium.py | 10 ++++++---- 3 files changed, 42 insertions(+), 5 deletions(-) create mode 100644 .vscode/tasks.json diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..a5b6880 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,35 @@ +{ + // See https://go.microsoft.com/fwlink/?LinkId=733558 + // for the documentation about the tasks.json format + // .vscode/tasks.json + { + "version": "2.0.0", + "tasks": [ + { + "label": "Run pytest with coverage", + "type": "shell", + "command": "pytest", + "args": [ + "--cov=your_module_or_package", + "--cov-report=html", + "${workspaceFolder}/tests" + ], + "group": { + "kind": "test", + "isDefault": false + } + }, + { + "label": "Run pytest without coverage", + "type": "shell", + "command": "pytest", + "args": [ + "${workspaceFolder}/tests" + ], + "group": { + "kind": "test", + "isDefault": true + } + } + ] + } diff --git a/pyproject.toml b/pyproject.toml index cdd8454..9c1152d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -67,6 +67,6 @@ all = true [tool.pytest.ini_options] timeout = 30 -addopts = "--cov=pyadtpulse --cov-report=html" +# addopts = "--cov=pyadtpulse --cov-report=html" [tool.pyright] diff --git a/tests/test_pqm_codium.py b/tests/test_pqm_codium.py index e824c5d..a14cddc 100644 --- a/tests/test_pqm_codium.py +++ b/tests/test_pqm_codium.py @@ -12,6 +12,7 @@ ServerConnectionError, ServerDisconnectedError, ) +from aiohttp.client_reqrep import ConnectionKey from yarl import URL from pyadtpulse.exceptions import ( @@ -250,20 +251,22 @@ async def test_handle_client_connector_error_with_fix(self, mocker): expected_error = PulseServerConnectionError( "Error occurred", connection_status.get_backoff() ) + ck = ConnectionKey("portal.adtpulse.com", 443, True, None, None, None, None) async def mock_request(*args, **kwargs): raise ClientConnectorError( - connection_key=None, os_error=FileNotFoundError("File not found") + connection_key=ck, os_error=FileNotFoundError("File not found") ) mocker.patch.object(ClientSession, "request", side_effect=mock_request) # When, Then with pytest.raises(PulseServerConnectionError) as ex: - await query_manager.async_query("/api/data") + await query_manager.async_query("/api/data", requires_authentication=False) assert str(ex.value) == str(expected_error) # can handle Retry-After header in HTTP response + @pytest.mark.timeout(70) @pytest.mark.asyncio async def test_handle_retry_after_header(self, mocker): # Given @@ -298,7 +301,7 @@ async def mock_async_query( # Then assert exc_info.value.backoff == connection_status.get_backoff() - assert connection_status.get_backoff().wait_for_backoff.call_count == 1 + assert connection_status._backoff.wait_for_backoff.call_count == 1 assert connection_status.authenticated_flag.wait.call_count == 0 assert connection_properties.session.request.call_count == 1 assert connection_properties.session.request.call_args[0][0] == "GET" @@ -671,7 +674,6 @@ async def mock_async_query( mocker.patch.object( PulseQueryManager, "async_query", side_effect=mock_async_query ) - # When with pytest.raises(PulseClientConnectionError): await query_manager.async_query("/api/data") From 55ca6507c2f4223d74b63c5bd6e0b9f061cb1976 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 25 Dec 2023 01:02:48 -0500 Subject: [PATCH 178/226] add pytest-xdist, make coverage not default --- .vscode/tasks.json | 2 +- poetry.lock | 36 +++++++++++++++++++++++++++++++++++- pyproject.toml | 1 + 3 files changed, 37 insertions(+), 2 deletions(-) diff --git a/.vscode/tasks.json b/.vscode/tasks.json index a5b6880..4c070f7 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -10,7 +10,7 @@ "type": "shell", "command": "pytest", "args": [ - "--cov=your_module_or_package", + "--cov=pyadtpulse", "--cov-report=html", "${workspaceFolder}/tests" ], diff --git a/poetry.lock b/poetry.lock index 6f5dce1..09352c5 100644 --- a/poetry.lock +++ b/poetry.lock @@ -471,6 +471,20 @@ files = [ {file = "distlib-0.3.7.tar.gz", hash = "sha256:9dafe54b34a028eafd95039d5e5d4851a13734540f1331060d31c9916e7147a8"}, ] +[[package]] +name = "execnet" +version = "2.0.2" +description = "execnet: rapid multi-Python deployment" +optional = false +python-versions = ">=3.7" +files = [ + {file = "execnet-2.0.2-py3-none-any.whl", hash = "sha256:88256416ae766bc9e8895c76a87928c0012183da3cc4fc18016e6f050e025f41"}, + {file = "execnet-2.0.2.tar.gz", hash = "sha256:cc59bc4423742fd71ad227122eb0dd44db51efb3dc4095b45ac9a08c770096af"}, +] + +[package.extras] +testing = ["hatch", "pre-commit", "pytest", "tox"] + [[package]] name = "filelock" version = "3.13.1" @@ -1085,6 +1099,26 @@ files = [ [package.dependencies] pytest = ">=5.0.0" +[[package]] +name = "pytest-xdist" +version = "3.5.0" +description = "pytest xdist plugin for distributed testing, most importantly across multiple CPUs" +optional = false +python-versions = ">=3.7" +files = [ + {file = "pytest-xdist-3.5.0.tar.gz", hash = "sha256:cbb36f3d67e0c478baa57fa4edc8843887e0f6cfc42d677530a36d7472b32d8a"}, + {file = "pytest_xdist-3.5.0-py3-none-any.whl", hash = "sha256:d075629c7e00b611df89f490a5063944bee7a4362a5ff11c7cc7824a03dfce24"}, +] + +[package.dependencies] +execnet = ">=1.1" +pytest = ">=6.2.0" + +[package.extras] +psutil = ["psutil (>=3.0)"] +setproctitle = ["setproctitle"] +testing = ["filelock"] + [[package]] name = "python-dateutil" version = "2.8.2" @@ -1516,4 +1550,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "1cfde95d8b8a4ca560ef86dcba101afdfb750c815a9a25ebff89b3405b63ec65" +content-hash = "9a6b01b3ba80dd1c7bfb1d84b490518c48f0efec47d1575276dacc433b14f666" diff --git a/pyproject.toml b/pyproject.toml index 9c1152d..06fd586 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -36,6 +36,7 @@ pytest-timeout = "^2.2.0" aioresponses = "^0.7.4" freezegun = "^1.2.2" pytest-coverage = "^0.0" +pytest-xdist = "^3.5.0" [tool.poetry.group.dev.dependencies] From b23a55261e70f73fa8d56ab0f7ddde71e5f305e3 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 25 Dec 2023 01:24:40 -0500 Subject: [PATCH 179/226] add test_pap --- tests/test_pap.py | 345 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 345 insertions(+) create mode 100644 tests/test_pap.py diff --git a/tests/test_pap.py b/tests/test_pap.py new file mode 100644 index 0000000..9174269 --- /dev/null +++ b/tests/test_pap.py @@ -0,0 +1,345 @@ +# Generated by CodiumAI +from unittest.mock import patch + +import pytest +from typeguard import TypeCheckError + +from pyadtpulse.pulse_authentication_properties import PulseAuthenticationProperties + + +class TestPulseAuthenticationProperties: + # Initialize object with valid username, password, and fingerprint + def test_initialize_with_valid_credentials(self): + """ + Test initializing PulseAuthenticationProperties with valid username, password, and fingerprint + """ + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + + # Act + properties = PulseAuthenticationProperties(username, password, fingerprint) + + # Assert + assert properties.username == username + assert properties.password == password + assert properties.fingerprint == fingerprint + + # Get and set username, password, fingerprint, site_id, and last_login_time properties + def test_get_and_set_properties(self): + """ + Test getting and setting username, password, fingerprint, site_id, and last_login_time properties + """ + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + site_id = "site123" + last_login_time = 123456789 + + properties = PulseAuthenticationProperties(username, password, fingerprint) + + # Act + properties.username = "new_username@example.com" + properties.password = "new_password" + properties.fingerprint = "new_fingerprint" + properties.site_id = site_id + properties.last_login_time = last_login_time + + # Assert + assert properties.username == "new_username@example.com" + assert properties.password == "new_password" + assert properties.fingerprint == "new_fingerprint" + assert properties.site_id == site_id + assert properties.last_login_time == last_login_time + + # Get last_login_time property after setting it + def test_get_last_login_time_after_setting(self): + """ + Test getting last_login_time property after setting it + """ + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + last_login_time = 123456789 + + properties = PulseAuthenticationProperties(username, password, fingerprint) + + # Act + properties.last_login_time = last_login_time + + # Assert + assert properties.last_login_time == last_login_time + + # Set username, password, fingerprint, site_id properties with valid values + def test_set_properties_with_valid_values(self): + """ + Test setting username, password, fingerprint, site_id properties with valid values + """ + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + site_id = "site123" + + properties = PulseAuthenticationProperties(username, password, fingerprint) + + # Act + properties.site_id = site_id + + # Assert + assert properties.username == username + assert properties.password == password + assert properties.fingerprint == fingerprint + assert properties.site_id == site_id + + # Set username, password, fingerprint properties with non-empty fingerprint + def test_set_properties_with_non_empty_fingerprint(self): + """ + Test setting username, password, fingerprint properties with non-empty fingerprint + """ + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + + properties = PulseAuthenticationProperties(username, password, fingerprint) + + # Act + properties.username = username + properties.password = password + properties.fingerprint = fingerprint + + # Assert + assert properties.username == username + assert properties.password == password + assert properties.fingerprint == fingerprint + + # Set site_id property with empty string + def test_set_site_id_with_empty_string(self): + """ + Test setting site_id property with empty string + """ + # Arrange + site_id = "" + + properties = PulseAuthenticationProperties( + "test@example.com", "password123", "fingerprint123" + ) + + # Act + properties.site_id = site_id + + # Assert + assert properties.site_id == site_id + + # Initialize object with empty username, password, or fingerprint + def test_initialize_with_empty_credentials(self): + """ + Test initializing PulseAuthenticationProperties with empty username, password, or fingerprint + """ + # Arrange + username = "" + password = "" + fingerprint = "" + + # Act and Assert + with pytest.raises(ValueError): + PulseAuthenticationProperties(username, password, fingerprint) + + # Initialize object with invalid username or password + def test_initialize_with_invalid_credentials1(self): + """ + Test initializing PulseAuthenticationProperties with invalid username or password + """ + # Arrange + username = "invalid_username" + password = "invalid_password" + fingerprint = "fingerprint123" + + # Act and Assert + with pytest.raises(ValueError): + PulseAuthenticationProperties(username, password, fingerprint) + + # Set username, password, fingerprint properties with invalid values + def test_set_properties_with_invalid_values(self): + """ + Test setting username, password, fingerprint properties with invalid values + """ + # Arrange + username = "invalid_username" + password = "" + fingerprint = "" + + properties = PulseAuthenticationProperties( + "test@example.com", "password123", "fingerprint123" + ) + + # Act and Assert + with pytest.raises(ValueError): + properties.username = username + + with pytest.raises(ValueError): + properties.password = password + + with pytest.raises(ValueError): + properties.fingerprint = fingerprint + + # Set last_login_time property with non-integer value + def test_set_last_login_time_with_non_integer_value(self): + """ + Test setting last_login_time property with non-integer value + """ + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + last_login_time = "invalid_time" + + properties = PulseAuthenticationProperties(username, password, fingerprint) + + # Act and Assert + with pytest.raises(TypeCheckError) as exc_info: + properties.last_login_time = last_login_time + + # Assert + assert ( + str(exc_info.value) + == 'argument "login_time" (str) is not an instance of int' + ) + + # Set site_id property with non-string value + def test_set_site_id_with_non_string_value(self): + """ + Test setting site_id property with non-string value + """ + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + site_id = 12345 # Fix: Set a non-string value + + properties = PulseAuthenticationProperties(username, password, fingerprint) + + # Act + with pytest.raises(TypeCheckError): + properties.site_id = site_id + + # Assert + assert not properties.site_id + + # Set last_login_time property with integer value + def test_set_last_login_time_with_integer_value(self): + """ + Test setting last_login_time property with integer value + """ + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + last_login_time = 123456789 + + properties = PulseAuthenticationProperties(username, password, fingerprint) + + # Act + properties.last_login_time = last_login_time + + # Assert + assert properties.last_login_time == last_login_time + + # Raise ValueError when initializing object with invalid username or password + def test_initialize_with_invalid_credentials(self): + """ + Test initializing PulseAuthenticationProperties with invalid username or password + """ + # Arrange + username = "invalid_username" + password = "" + fingerprint = "valid_fingerprint" + + # Act and Assert + with pytest.raises(ValueError): + properties = PulseAuthenticationProperties(username, password, fingerprint) + + # Raise TypeError when setting site_id property with non-string value + def test_raise_type_error_when_setting_site_id_with_non_string_value(self): + """ + Test that a TypeError is raised when setting the site_id property with a non-string value + """ + # Arrange + properties = PulseAuthenticationProperties( + "test@example.com", "password123", "fingerprint123" + ) + + # Act and Assert + with pytest.raises(TypeCheckError): + properties.site_id = 123 + + # Raise ValueError when setting username, password, fingerprint properties with invalid values + def test_invalid_properties(self): + """ + Test that ValueError is raised when setting invalid username, password, and fingerprint properties + """ + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + properties = PulseAuthenticationProperties(username, password, fingerprint) + + # Act and Assert + with pytest.raises(ValueError): + properties.username = "" + with pytest.raises(ValueError): + properties.password = "" + with pytest.raises(ValueError): + properties.fingerprint = "" + + # Raise TypeCheckError when setting last_login_time property with non-integer value + def test_raise_type_check_error_when_setting_last_login_time_with_non_integer_value( + self, + ): + """ + Test that a TypeCheckError is raised when setting the last_login_time property with a non-integer value + """ + import typeguard + + # Arrange + properties = PulseAuthenticationProperties( + "test@example.com", "password123", "fingerprint123" + ) + + # Act and Assert + with pytest.raises(typeguard.TypeCheckError): + properties.last_login_time = "invalid_time" + + # Lock and unlock paa_attribute_lock when getting and setting properties + def test_lock_and_unlock_paa_attribute_lock(self): + """ + Test that paa_attribute_lock is locked and unlocked when getting and setting properties + """ + # Arrange + username = "test@example.com" + password = "password123" + fingerprint = "fingerprint123" + properties = PulseAuthenticationProperties(username, password, fingerprint) + + # Act + with patch.object(properties._paa_attribute_lock, "acquire") as mock_acquire: + with patch.object( + properties._paa_attribute_lock, "release" + ) as mock_release: + _ = properties.username + _ = properties.password + _ = properties.fingerprint + _ = properties.site_id + properties.username = "new_username@example.com" + properties.password = "new_password" + properties.fingerprint = "new_fingerprint" + properties.site_id = "new_site_id" + + # Assert + + self.assertEqual(mock_acquire.call_count, 4) + self.assertEqual(mock_release.call_count, 4) From 104ce38eca3a9bd9f25ecd32851bbb7206f20e7a Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 25 Dec 2023 02:16:43 -0500 Subject: [PATCH 180/226] add codium paa tests --- tests/test_paa_codium.py | 326 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 326 insertions(+) create mode 100644 tests/test_paa_codium.py diff --git a/tests/test_paa_codium.py b/tests/test_paa_codium.py new file mode 100644 index 0000000..b25c6ee --- /dev/null +++ b/tests/test_paa_codium.py @@ -0,0 +1,326 @@ +# Generated by CodiumAI +import asyncio +from unittest.mock import PropertyMock + +import pytest +from bs4 import BeautifulSoup +from requests import patch + +from conftest import LoginType, add_signin +from pyadtpulse.exceptions import PulseAuthenticationError, PulseNotLoggedInError +from pyadtpulse.pyadtpulse_async import PyADTPulseAsync +from pyadtpulse.site import ADTPulseSite + + +class TestPyADTPulseAsync: + # The class can be instantiated with the required parameters (username, password, fingerprint) and optional parameters (service_host, user_agent, debug_locks, keepalive_interval, relogin_interval, detailed_debug_logging). + @pytest.mark.asyncio + async def test_instantiation_with_parameters(self): + pulse = PyADTPulseAsync( + username="valid_email@example.com", + password="your_password", + fingerprint="your_fingerprint", + service_host="https://portal.adtpulse.com", + user_agent="Your User Agent", + debug_locks=False, + keepalive_interval=5, + relogin_interval=60, + detailed_debug_logging=True, + ) + assert isinstance(pulse, PyADTPulseAsync) + + # The __repr__ method returns a string representation of the class. + @pytest.mark.asyncio + async def test_repr_method_with_valid_email(self): + pulse = PyADTPulseAsync( + username="your_username@example.com", + password="your_password", + fingerprint="your_fingerprint", + ) + assert repr(pulse) == "" + + # The async_login method successfully authenticates the user to the ADT Pulse cloud service using a valid email address as the username. + @pytest.mark.asyncio + async def test_async_login_success_with_valid_email( + self, mocked_server_responses, get_mocked_url, read_file + ): + pulse = PyADTPulseAsync( + username="valid_email@example.com", + password="your_password", + fingerprint="your_fingerprint", + ) + add_signin( + LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file + ) + assert await pulse.async_login() is True + + # The class is instantiated without the required parameters (username, password, fingerprint) and raises an exception. + @pytest.mark.asyncio + async def test_instantiation_without_parameters(self): + with pytest.raises(TypeError): + pulse = PyADTPulseAsync() + + # The async_login method fails to authenticate the user to the ADT Pulse cloud service and raises a PulseAuthenticationError. + @pytest.mark.asyncio + async def test_async_login_failure_with_valid_username(self): + pulse = PyADTPulseAsync( + username="valid_email@example.com", + password="invalid_password", + fingerprint="invalid_fingerprint", + ) + with pytest.raises(PulseAuthenticationError): + await pulse.async_login() + + # The async_logout method is called without being logged in and returns without any action. + @pytest.mark.asyncio + async def test_async_logout_without_login_with_valid_email_fixed(self): + pulse = PyADTPulseAsync( + username="valid_username@example.com", + password="valid_password", + fingerprint="valid_fingerprint", + ) + with pytest.raises(RuntimeError): + await pulse.async_logout() + + # The async_logout method successfully logs the user out of the ADT Pulse cloud service. + @pytest.mark.asyncio + async def test_async_logout_successfully_logs_out(self, mocker): + # Arrange + pulse = PyADTPulseAsync( + username="test_user@example.com", + password="test_password", + fingerprint="test_fingerprint", + ) + mocker.patch.object(pulse._pulse_connection, "async_query") + + # Act + await pulse.async_login() + await pulse.async_logout() + + # Assert + assert not pulse.is_connected + pulse._pulse_connection.async_query.assert_called_once_with( + pulse.site.id, "POST" + ) + + # The async_update method checks the ADT Pulse cloud service for updates and returns True if updates are available. + @pytest.mark.asyncio + async def test_async_update_returns_true_if_updates_available_with_valid_email( + self, + ): + # Arrange + from unittest.mock import MagicMock + + pulse = PyADTPulseAsync("test@example.com", "password", "fingerprint") + pulse._update_sites = MagicMock(return_value=None) + + # Act + result = await pulse.async_update() + + # Assert + assert result is True + + # The site property returns an ADTPulseSite object after logging in. + @pytest.mark.asyncio + async def test_site_property_returns_ADTPulseSite_object_with_login( + self, mocked_server_responses, get_mocked_url, read_file + ): + # Arrange + pulse = PyADTPulseAsync("test@example.com", "valid_password", "fingerprint") + add_signin( + LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file + ) + # Act + await pulse.async_login() + site = pulse.site + + # Assert + assert isinstance(site, ADTPulseSite) + + # The is_connected property returns True if the class is connected to the ADT Pulse cloud service. + @pytest.mark.asyncio + async def test_is_connected_property_returns_true( + self, mocked_server_responses, get_mocked_url, read_file + ): + pulse = PyADTPulseAsync( + username="valid_username@example.com", + password="valid_password", + fingerprint="valid_fingerprint", + ) + add_signin( + LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file + ) + await pulse.async_login() + assert pulse.is_connected == True + + # The site property is accessed without being logged in and raises an exception. + @pytest.mark.asyncio + async def test_site_property_without_login_raises_exception(self): + pulse = PyADTPulseAsync( + username="test@example.com", + password="your_password", + fingerprint="your_fingerprint", + service_host="https://portal.adtpulse.com", + user_agent="Your User Agent", + debug_locks=False, + keepalive_interval=5, + relogin_interval=60, + detailed_debug_logging=True, + ) + with pytest.raises(RuntimeError): + pulse.site + + # The wait_for_update method waits for updates from the ADT Pulse cloud service and raises an exception if there is an error. + @pytest.mark.asyncio + async def test_wait_for_update_method_with_valid_username(self): + # Arrange + from unittest.mock import MagicMock + + pulse = PyADTPulseAsync( + username="your_username@example.com", + password="your_password", + fingerprint="your_fingerprint", + ) + + # Mock the necessary methods and attributes + pulse._pa_attribute_lock = asyncio.Lock() + pulse._site = MagicMock() + pulse._site.gateway.backoff.wait_for_backoff.return_value = asyncio.sleep(0) + pulse._pulse_connection_status.get_backoff().will_backoff.return_value = False + pulse._pulse_properties.updates_exist.wait.return_value = asyncio.sleep(0) + + # Mock the is_connected property of _pulse_connection + with patch.object( + pulse._pulse_connection, "is_connected", new_callable=PropertyMock + ) as mock_is_connected: + mock_is_connected.return_value = True + + # Act + with patch.object(pulse, "_update_sites") as mock_update_sites: + with patch.object( + pulse, "_pulse_connection", autospec=True + ) as mock_pulse_connection: + with patch.object(pulse, "_sync_check_exception", None): + await pulse.wait_for_update() + + # Assert + mock_update_sites.assert_called_once() + pulse._pulse_properties.updates_exist.wait.assert_called_once() + assert pulse._sync_check_exception is None + + # The sites property returns a list of ADTPulseSite objects. + @pytest.mark.asyncio + async def test_sites_property_returns_list_of_objects( + self, mocked_server_responses, get_mocked_url, read_file + ): + # Arrange + pulse = PyADTPulseAsync( + "test@example.com", "valid_password", "valid_fingerprint" + ) + add_signin( + LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file + ) + # Act + await pulse.async_login() + sites = pulse.sites + + # Assert + assert isinstance(sites, list) + for site in sites: + assert isinstance(site, ADTPulseSite) + + # The is_connected property returns False if the class is not connected to the ADT Pulse cloud service. + @pytest.mark.asyncio + async def test_is_connected_property_returns_false_when_not_connected(self): + pulse = PyADTPulseAsync( + username="your_username@example.com", + password="your_password", + fingerprint="your_fingerprint", + ) + assert pulse.is_connected == False + + # The async_update method fails to check the ADT Pulse cloud service for updates and returns False. + @pytest.mark.asyncio + async def test_async_update_fails(self, mock_query_orb): + pulse = PyADTPulseAsync("username@example.com", "password", "fingerprint") + mock_query_orb.return_value = None + + result = await pulse.async_update() + + assert result == False + + # The sites property is accessed without being logged in and raises an exception. + @pytest.mark.asyncio + async def test_sites_property_without_login_raises_exception(self): + pulse = PyADTPulseAsync( + username="your_username@example.com", + password="your_password", + fingerprint="your_fingerprint", + service_host="https://portal.adtpulse.com", + user_agent="Your User Agent", + debug_locks=False, + keepalive_interval=5, + relogin_interval=60, + detailed_debug_logging=True, + ) + with pytest.raises(RuntimeError): + pulse.sites + + # The wait_for_update method is called without being logged in and raises an exception. + @pytest.mark.asyncio + async def test_wait_for_update_without_login_raises_exception(self): + pulse = PyADTPulseAsync( + username="your_username@example.com", + password="your_password", + fingerprint="your_fingerprint", + service_host="https://portal.adtpulse.com", + user_agent="Your User Agent", + debug_locks=False, + keepalive_interval=5, + relogin_interval=60, + detailed_debug_logging=True, + ) + + with pytest.raises(PulseNotLoggedInError): + await pulse.wait_for_update() + + # The _initialize_sites method retrieves the site id and name from the soup object and creates a new ADTPulseSite object. + @pytest.mark.asyncio + async def test_initialize_sites_method_with_valid_service_host( + self, mocker, read_file + ): + # Arrange + username = "test@example.com" + password = "test_password" + fingerprint = "test_fingerprint" + service_host = "https://portal.adtpulse.com" + user_agent = "Test User Agent" + debug_locks = False + keepalive_interval = 10 + relogin_interval = 30 + detailed_debug_logging = True + + pulse = PyADTPulseAsync( + username=username, + password=password, + fingerprint=fingerprint, + service_host=service_host, + user_agent=user_agent, + debug_locks=debug_locks, + keepalive_interval=keepalive_interval, + relogin_interval=relogin_interval, + detailed_debug_logging=detailed_debug_logging, + ) + + soup = BeautifulSoup(read_file("summary.html")) + + # Mock the fetch_devices method to always return True + mocker.patch.object(ADTPulseSite, "fetch_devices", return_value=True) + + # Act + await pulse._initialize_sites(soup) + + # Assert + assert pulse._site is not None + assert pulse._site.id == "160301za524548" + assert pulse._site.name == "Robert Lippmann" From 0f4e06bab035e367bae8b6cb7aa2a81bccbb2001 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 25 Dec 2023 20:04:38 -0500 Subject: [PATCH 181/226] move authenticated flag clear before query in asyc_do_login_query --- pyadtpulse/pulse_connection.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 13cbc0d..0e1ed53 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -235,6 +235,7 @@ async def async_do_logout_query(self, site_id: str | None = None) -> None: """Performs a logout query to the ADT Pulse site.""" params = {} si = "" + self._connection_status.authenticated_flag.clear() if site_id is not None and site_id != "": self._authentication_properties.site_id = site_id si = site_id @@ -255,7 +256,6 @@ async def async_do_logout_query(self, site_id: str | None = None) -> None: PulseServerConnectionError, ) as e: LOG.debug("Could not logout from Pulse site: %s", e) - self._connection_status.authenticated_flag.clear() @property def is_connected(self) -> bool: From a4f7ac3fa45621227d01d4f1227947f76d8e9714 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 25 Dec 2023 21:23:50 -0500 Subject: [PATCH 182/226] clean up detailed debug logging --- pyadtpulse/pulse_backoff.py | 26 +++++++++++++++++++++++++- pyadtpulse/pulse_connection_status.py | 17 +++++++---------- pyadtpulse/pyadtpulse_async.py | 18 +++++++++++++++++- pyadtpulse/pyadtpulse_properties.py | 3 --- pyadtpulse/site.py | 6 +++--- tests/test_pulse_connection_status.py | 22 ++++++++++++---------- 6 files changed, 64 insertions(+), 28 deletions(-) diff --git a/pyadtpulse/pulse_backoff.py b/pyadtpulse/pulse_backoff.py index 42da833..02e247c 100644 --- a/pyadtpulse/pulse_backoff.py +++ b/pyadtpulse/pulse_backoff.py @@ -36,7 +36,18 @@ def __init__( debug_locks: bool = False, detailed_debug_logging=False, ) -> None: - """Initialize backoff.""" + """Initialize backoff. + + Args: + name (str): Name of the backoff. + initial_backoff_interval (float): Initial backoff interval in seconds. + max_backoff_interval (float, optional): Maximum backoff interval in seconds. + Defaults to ADT_MAX_BACKOFF. + threshold (int, optional): Threshold for backoff. Defaults to 0. + debug_locks (bool, optional): Enable debug locks. Defaults to False. + detailed_debug_logging (bool, optional): Enable detailed debug logging. + Defaults to False. + """ self._check_intervals(initial_backoff_interval, max_backoff_interval) self._b_lock = set_debug_lock(debug_locks, "pyadtpulse._b_lock") self._initial_backoff_interval = initial_backoff_interval @@ -164,3 +175,16 @@ def initial_backoff_interval(self, new_interval: float) -> None: def name(self) -> str: """Return name.""" return self._name + + @property + def detailed_debug_logging(self) -> bool: + """Return detailed debug logging.""" + with self._b_lock: + return self._detailed_debug_logging + + @detailed_debug_logging.setter + @typechecked + def detailed_debug_logging(self, new_value: bool) -> None: + """Set detailed debug logging.""" + with self._b_lock: + self._detailed_debug_logging = new_value diff --git a/pyadtpulse/pulse_connection_status.py b/pyadtpulse/pulse_connection_status.py index a71577d..ebdb5e2 100644 --- a/pyadtpulse/pulse_connection_status.py +++ b/pyadtpulse/pulse_connection_status.py @@ -21,6 +21,13 @@ def __init__(self, debug_locks: bool = False, detailed_debug_logging=False): self._pcs_attribute_lock = set_debug_lock( debug_locks, "pyadtpulse.pcs_attribute_lock" ) + """Initialize the connection status object. + + Args: + debug_locks (bool, optional): Enable debug locks. Defaults to False. + detailed_debug_logging (bool, optional): Enable detailed debug logging for the backoff. + Defaults to False. + """ self._backoff = PulseBackoff( "Connection Status", initial_backoff_interval=1, @@ -50,13 +57,3 @@ def retry_after(self, seconds: float) -> None: def get_backoff(self) -> PulseBackoff: """Get the backoff object.""" return self._backoff - - def increment_backoff(self) -> None: - """Increment the backoff.""" - with self._pcs_attribute_lock: - self._backoff.increment_backoff() - - def reset_backoff(self) -> None: - """Reset the backoff.""" - with self._pcs_attribute_lock: - self._backoff.reset_backoff() diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 7fc2b71..dccf371 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -112,7 +112,6 @@ def __init__( self._pulse_properties = PyADTPulseProperties( keepalive_interval=keepalive_interval, relogin_interval=relogin_interval, - detailed_debug_logging=detailed_debug_logging, debug_locks=debug_locks, ) self._pulse_connection = PulseConnection( @@ -635,3 +634,20 @@ def site(self) -> ADTPulseSite: def is_connected(self) -> bool: """Convenience method to return whether ADT Pulse is connected.""" return self._pulse_connection.is_connected + + @property + def detailed_debug_logging(self) -> bool: + """Return detailed debug logging.""" + return ( + self._pulse_connection_properties.detailed_debug_logging + and self._pulse_connection_status.get_backoff().detailed_debug_logging + and self._detailed_debug_logging + ) + + @detailed_debug_logging.setter + def detailed_debug_logging(self, value: bool) -> None: + """Set detailed debug logging.""" + self._pulse_connection_properties.detailed_debug_logging = value + self._pulse_connection_status.get_backoff().detailed_debug_logging = value + with self._pa_attribute_lock: + self._detailed_debug_logging = value diff --git a/pyadtpulse/pyadtpulse_properties.py b/pyadtpulse/pyadtpulse_properties.py index 4a82119..a69e7be 100644 --- a/pyadtpulse/pyadtpulse_properties.py +++ b/pyadtpulse/pyadtpulse_properties.py @@ -26,7 +26,6 @@ class PyADTPulseProperties: "_login_exception", "_relogin_interval", "_keepalive_interval", - "_detailed_debug_logging", "_site", ) @@ -53,7 +52,6 @@ def __init__( self, keepalive_interval: int = ADT_DEFAULT_KEEPALIVE_INTERVAL, relogin_interval: int = ADT_DEFAULT_RELOGIN_INTERVAL, - detailed_debug_logging: bool = False, debug_locks: bool = False, ) -> None: """Create a PyADTPulse properties object. @@ -75,7 +73,6 @@ def __init__( self._site: ADTPulseSite | None = None self.keepalive_interval = keepalive_interval self.relogin_interval = relogin_interval - self._detailed_debug_logging = detailed_debug_logging @property def relogin_interval(self) -> int: diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index ff2104c..30e448b 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -36,9 +36,9 @@ def __init__(self, pulse_connection: PulseConnection, site_id: str, name: str): """Initialize. Args: - adt_service (PyADTPulse): a PyADTPulse object - site_id (str): site ID - name (str): site name + pulse_connection (PulseConnection): Pulse connection. + site_id (str): Site ID. + name (str): Site name. """ self._pulse_connection = pulse_connection super().__init__(site_id, name, pulse_connection.debug_locks) diff --git a/tests/test_pulse_connection_status.py b/tests/test_pulse_connection_status.py index 99d4ff8..7a0260d 100644 --- a/tests/test_pulse_connection_status.py +++ b/tests/test_pulse_connection_status.py @@ -60,7 +60,7 @@ def test_increment_backoff(self): Test that increment_backoff can be called without errors. """ pcs = PulseConnectionStatus() - pcs.increment_backoff() + pcs.get_backoff().increment_backoff() # retry_after can be set to a time in the future def test_set_retry_after_past_time_fixed(self): @@ -125,7 +125,7 @@ def test_reset_backoff(self): Test that reset_backoff can be called without errors. """ pcs = PulseConnectionStatus() - pcs.reset_backoff() + pcs.get_backoff().reset_backoff() # authenticated_flag can be set to True def test_authenticated_flag_set_to_true(self): @@ -162,14 +162,15 @@ def test_get_backoff_returns_same_object(self): assert backoff1 is backoff2 # increment_backoff increases the backoff count by 1 - def test_increment_backoff(self): + def test_increment_backoff2(self): """ Test that increment_backoff increases the backoff count by 1. """ pcs = PulseConnectionStatus() - initial_backoff_count = pcs.get_backoff().backoff_count - pcs.increment_backoff() - new_backoff_count = pcs.get_backoff().backoff_count + backoff = pcs.get_backoff() + initial_backoff_count = backoff.backoff_count + backoff.increment_backoff() + new_backoff_count = backoff.backoff_count assert new_backoff_count == initial_backoff_count + 1 # reset_backoff sets the backoff count to 0 and the expiration time to 0.0 @@ -178,7 +179,8 @@ def test_reset_backoff_sets_backoff_count_and_expiration_time(self): Test that reset_backoff sets the backoff count to 0 and the expiration time to 0.0. """ pcs = PulseConnectionStatus() - pcs.increment_backoff() - pcs.reset_backoff() - assert pcs.get_backoff().backoff_count == 0 - assert pcs.get_backoff().expiration_time == 0.0 + backoff = pcs.get_backoff() + backoff.increment_backoff() + backoff.reset_backoff() + assert backoff.backoff_count == 0 + assert backoff.expiration_time == 0.0 From 2e6db6d8bc8f7589a41263b480838bd1a47d00eb Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 26 Dec 2023 05:02:12 -0500 Subject: [PATCH 183/226] pulse async tests and fixes --- pyadtpulse/pyadtpulse_async.py | 11 +++++++ tests/test_pulse_async.py | 55 ++++++++++++++++++++++++---------- 2 files changed, 51 insertions(+), 15 deletions(-) diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index dccf371..3e3a355 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -42,6 +42,8 @@ SYNC_CHECK_TASK_NAME = "ADT Pulse Sync Check Task" KEEPALIVE_TASK_NAME = "ADT Pulse Keepalive Task" RELOGIN_BACKOFF_WARNING_THRESHOLD = 5.0 * 60.0 +# how many transient failures to allow before warninging wait_for_update() +WARN_UPDATE_TASK_THRESHOLD = 4 class PyADTPulseAsync: @@ -214,6 +216,12 @@ def _get_timeout_task_name(self) -> str: return self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) def _set_sync_check_exception(self, e: Exception | None) -> None: + if ( + e in (PulseClientConnectionError, PulseServerConnectionError) + and self._pulse_connection_status.get_backoff().backoff_count + < WARN_UPDATE_TASK_THRESHOLD + ): + return self._sync_check_exception = e self._pulse_properties.updates_exist.set() @@ -380,6 +388,9 @@ async def validate_sync_check_response() -> bool: Validates the sync check response received from the ADT Pulse site. Returns: bool: True if the sync check response is valid, False otherwise. + + Raises: + PulseAccountLockedError if the account is locked and no retry time is available. """ if not handle_response(code, url, logging.ERROR, "Error querying ADT sync"): return False diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index b4b89f7..55ef50d 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -197,10 +197,15 @@ async def test_wait_for_update(adt_pulse_instance, get_mocked_url): await p.async_login() +def make_sync_check_pattern(get_mocked_url): + return re.compile(rf"{re.escape(get_mocked_url(ADT_SYNC_CHECK_URI))}/?.*$") + + @pytest.mark.asyncio +@pytest.mark.timeout(60) async def test_orb_update(adt_pulse_instance, get_mocked_url, read_file): p, response = await adt_pulse_instance - pattern = re.compile(rf"{re.escape(get_mocked_url(ADT_SYNC_CHECK_URI))}/?.*$") + pattern = make_sync_check_pattern(get_mocked_url) def signal_status_change(): response.get( @@ -229,7 +234,7 @@ def open_patio(): ) signal_status_change() - def close_patio(): + def close_all(): response.get( get_mocked_url(ADT_ORB_URI), body=read_file("orb.html"), @@ -255,7 +260,7 @@ def open_both_garage_and_patio(): def setup_sync_check(): open_patio() - close_patio() + close_all() async def test_sync_check_and_orb(): code, content, _ = await p._pulse_connection.async_query( @@ -303,19 +308,39 @@ async def test_sync_check_and_orb(): # do a first run though to make sure aioresponses will work ok await test_sync_check_and_orb() await p.async_logout() - open_patio() - add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) - await p.async_login() - task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) - await asyncio.sleep(3) - assert p._sync_task is not None - shutdown_event.set() - task.cancel() - await task - await p.async_logout() - assert len(p.site.zones) == 13 - assert p.site.zones_as_dict[11].state == "Open" assert p._sync_task is None + assert p._timeout_task is None + for j in range(2): + if j == 0: + zone = 11 + else: + zone = 10 + for i in range(2): + if i == 0: + if j == 0: + open_patio() + else: + open_garage() + state = "Open" + else: + close_all() + state = "OK" + add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) + await p.async_login() + task = asyncio.create_task( + do_wait_for_update(p, shutdown_event), name=f"wait_for_update-{j}-{i}" + ) + await asyncio.sleep(3) + assert p._sync_task is not None + await p.async_logout() + await asyncio.sleep(0) + with pytest.raises(PulseNotLoggedInError): + await task + await asyncio.sleep(0) + assert len(p.site.zones) == 13 + assert p.site.zones_as_dict[zone].state == state + assert p._sync_task is None + assert p._timeout_task is None # assert m.call_count == 2 From e848ba516b63ab6f18f663efa7d8861e97b2110e Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 26 Dec 2023 05:13:37 -0500 Subject: [PATCH 184/226] add quick_logout to pc --- pyadtpulse/pulse_connection.py | 9 +++++++++ pyadtpulse/pulse_connection_properties.py | 8 ++++++-- pyadtpulse/pyadtpulse_async.py | 6 +++--- 3 files changed, 18 insertions(+), 5 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 0e1ed53..2fc31cf 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -292,3 +292,12 @@ def login_in_progress(self, value: bool) -> None: """Set login in progress.""" with self._pc_attribute_lock: self._login_in_progress = value + + async def quick_logout(self) -> None: + """Quickly logout. + + This just resets the authenticated flag and clears the ClientSession. + """ + LOG.debug("Resetting session") + self._connection_status.authenticated_flag.clear() + await self._connection_properties.clear_session() diff --git a/pyadtpulse/pulse_connection_properties.py b/pyadtpulse/pulse_connection_properties.py index 0e7dfb7..f51f3f2 100644 --- a/pyadtpulse/pulse_connection_properties.py +++ b/pyadtpulse/pulse_connection_properties.py @@ -231,6 +231,10 @@ def make_url(self, uri: str) -> str: async def clear_session(self): """Clear the session.""" with self._pci_attribute_lock: - if self._session is not None and not self._session.closed: - await self._session.close() + # remove the old session first to prevent an edge case + # where another coroutine might jump in during the await close() + # and get the old session. + old_session = self._session self._session = None + if old_session is not None and not old_session.closed: + await old_session.close() diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 3e3a355..aa1c6bc 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -262,7 +262,7 @@ def should_relogin(relogin_interval: int) -> bool: LOG.debug("%s: Skipping relogin because not connected", task_name) continue elif should_relogin(relogin_interval): - await self.async_logout() + await self._pulse_connection.quick_logout() try: await self._login_looped(task_name) except (PulseAuthenticationError, PulseMFARequiredError) as ex: @@ -409,7 +409,7 @@ async def validate_sync_check_response() -> bool: ) except PulseNotLoggedInError: LOG.info("Re-login required to continue ADT Pulse sync check") - await self.async_logout() + await self._pulse_connection.quick_logout() await self._login_looped(task_name) return False except PulseAccountLockedError as ex: @@ -545,7 +545,7 @@ async def async_login(self) -> bool: await self._update_sites(soup) if self._site is None: LOG.error("Could not retrieve any sites, login failed") - await self.async_logout() + await self._pulse_connection.quick_logout() return False self._sync_check_exception = None self._timeout_task = asyncio.create_task( From afe302ef12fd6dabc0024cc1cdc268815cd4914d Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 26 Dec 2023 05:21:39 -0500 Subject: [PATCH 185/226] reword detailed_debug_logging again --- pyadtpulse/pulse_connection.py | 17 +++++++++++++++++ pyadtpulse/pulse_connection_status.py | 13 +++++++++++++ pyadtpulse/pyadtpulse_async.py | 11 ++--------- 3 files changed, 32 insertions(+), 9 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 2fc31cf..545749f 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -301,3 +301,20 @@ async def quick_logout(self) -> None: LOG.debug("Resetting session") self._connection_status.authenticated_flag.clear() await self._connection_properties.clear_session() + + @property + def detailed_debug_logging(self) -> bool: + """Return detailed debug logging.""" + return ( + self._login_backoff.detailed_debug_logging + and self._connection_properties.detailed_debug_logging + and self._connection_status.detailed_debug_logging + ) + + @detailed_debug_logging.setter + @typechecked + def detailed_debug_logging(self, value: bool): + with self._pc_attribute_lock: + self._login_backoff.detailed_debug_logging = value + self._connection_properties.detailed_debug_logging = value + self._connection_status.detailed_debug_logging = value diff --git a/pyadtpulse/pulse_connection_status.py b/pyadtpulse/pulse_connection_status.py index ebdb5e2..de57c31 100644 --- a/pyadtpulse/pulse_connection_status.py +++ b/pyadtpulse/pulse_connection_status.py @@ -57,3 +57,16 @@ def retry_after(self, seconds: float) -> None: def get_backoff(self) -> PulseBackoff: """Get the backoff object.""" return self._backoff + + @property + def detailed_debug_logging(self) -> bool: + """Get the detailed debug logging flag.""" + with self._pcs_attribute_lock: + return self._backoff.detailed_debug_logging + + @detailed_debug_logging.setter + @typechecked + def detailed_debug_logging(self, value: bool): + """Set the detailed debug logging flag.""" + with self._pcs_attribute_lock: + self._backoff.detailed_debug_logging = value diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index aa1c6bc..42b2bb6 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -649,16 +649,9 @@ def is_connected(self) -> bool: @property def detailed_debug_logging(self) -> bool: """Return detailed debug logging.""" - return ( - self._pulse_connection_properties.detailed_debug_logging - and self._pulse_connection_status.get_backoff().detailed_debug_logging - and self._detailed_debug_logging - ) + return self._pulse_connection.detailed_debug_logging @detailed_debug_logging.setter def detailed_debug_logging(self, value: bool) -> None: """Set detailed debug logging.""" - self._pulse_connection_properties.detailed_debug_logging = value - self._pulse_connection_status.get_backoff().detailed_debug_logging = value - with self._pa_attribute_lock: - self._detailed_debug_logging = value + self._pulse_connection.detailed_debug_logging = value From a8d95a04340d0046a2cd3358b46a2d278ed19f0b Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Wed, 10 Jan 2024 09:18:28 -0500 Subject: [PATCH 186/226] more tests and fixes --- conftest.py | 2 +- pyadtpulse/exceptions.py | 63 +++++- pyadtpulse/pulse_backoff.py | 1 + pyadtpulse/pulse_connection.py | 25 +- pyadtpulse/pulse_query_manager.py | 81 +++---- pyadtpulse/pyadtpulse_async.py | 120 ++++++---- tests/test_backoff.py | 1 + tests/test_exceptions.py | 28 +-- tests/test_paa_codium.py | 12 +- tests/test_pqm_codium.py | 364 ++++++------------------------ tests/test_pulse_async.py | 43 +++- tests/test_pulse_connection.py | 8 +- tests/test_pulse_query_manager.py | 36 +-- 13 files changed, 333 insertions(+), 451 deletions(-) diff --git a/conftest.py b/conftest.py index 0c5a734..11e5deb 100644 --- a/conftest.py +++ b/conftest.py @@ -269,7 +269,7 @@ def add_custom_response( def add_signin( signin_type: LoginType, mocked_server_responses, get_mocked_url, read_file ): - if signin_type != LoginType.SUCCESS: + if signin_type != LoginType.SUCCESS and signin_type != LoginType.MFA: add_custom_response( mocked_server_responses, get_mocked_url, diff --git a/pyadtpulse/exceptions.py b/pyadtpulse/exceptions.py index 400838f..72b3bf5 100644 --- a/pyadtpulse/exceptions.py +++ b/pyadtpulse/exceptions.py @@ -1,9 +1,17 @@ """Pulse exceptions.""" +import datetime from time import time from .pulse_backoff import PulseBackoff +def compute_retry_time(retry_time: float | None) -> str: + """Compute the retry time.""" + if not retry_time: + return "indefinitely" + return str(datetime.datetime.fromtimestamp(retry_time)) + + class PulseExceptionWithBackoff(Exception): """Exception with backoff.""" @@ -23,23 +31,20 @@ def __repr__(self): class PulseExceptionWithRetry(PulseExceptionWithBackoff): - """Exception with backoff.""" + """Exception with backoff + + If retry_time is None, or is in the past, then just the backoff count will be incremented. + """ def __init__(self, message: str, backoff: PulseBackoff, retry_time: float | None): """Initialize exception.""" + # super.__init__ will increment the backoff count super().__init__(message, backoff) self.retry_time = retry_time if retry_time and retry_time > time(): - # don't need a backoff count for absolute backoff - self.backoff.reset_backoff() + # set the absolute backoff time will remove the backoff count self.backoff.set_absolute_backoff_time(retry_time) - else: - # hack to reset backoff again - current_backoff = backoff.backoff_count - 1 - self.backoff.reset_backoff() - for _ in range(current_backoff): - self.backoff.increment_backoff() - raise ValueError("retry_time must be in the future") + return def __str__(self): """Return a string representation of the exception.""" @@ -57,10 +62,18 @@ class PulseConnectionError(Exception): class PulseServerConnectionError(PulseExceptionWithBackoff, PulseConnectionError): """Server error.""" + def __init__(self, message: str, backoff: PulseBackoff): + """Initialize Pulse server error exception.""" + super().__init__(f"Pulse server error: {message}", backoff) + class PulseClientConnectionError(PulseExceptionWithBackoff, PulseConnectionError): """Client error.""" + def __init__(self, message: str, backoff: PulseBackoff): + """Initialize Pulse client error exception.""" + super().__init__(f"Client error connecting to Pulse: {message}", backoff) + class PulseServiceTemporarilyUnavailableError( PulseExceptionWithRetry, PulseConnectionError @@ -70,6 +83,14 @@ class PulseServiceTemporarilyUnavailableError( For HTTP 503 and 429 errors. """ + def __init__(self, backoff: PulseBackoff, retry_time: float | None = None): + """Initialize Pusle service temporarily unavailable error exception.""" + super().__init__( + f"Pulse service temporarily unavailable until {compute_retry_time(retry_time)}", + backoff, + retry_time, + ) + class PulseLoginException(Exception): """Login exceptions. @@ -80,21 +101,43 @@ class PulseLoginException(Exception): class PulseAuthenticationError(PulseExceptionWithBackoff, PulseLoginException): """Authentication error.""" + def __init__(self, backoff: PulseBackoff): + """Initialize Pulse Authentication error exception.""" + super().__init__("Error authenticating to Pulse", backoff) + class PulseAccountLockedError(PulseExceptionWithRetry, PulseLoginException): """Account locked error.""" + def __init__(self, backoff: PulseBackoff, retry: float): + """Initialize Pulse Account locked error exception.""" + super().__init__( + f"Pulse Account is locked until {compute_retry_time(retry)}", backoff, retry + ) + class PulseGatewayOfflineError(PulseExceptionWithBackoff): """Gateway offline error.""" + def __init__(self, backoff: PulseBackoff): + """Initialize Pulse Gateway offline error exception.""" + super().__init__("Gateway is offline", backoff) + class PulseMFARequiredError(PulseExceptionWithBackoff, PulseLoginException): """MFA required error.""" + def __init__(self, backoff: PulseBackoff): + """Initialize Pulse MFA required error exception.""" + super().__init__("Authentication failed because MFA is required", backoff) + class PulseNotLoggedInError(PulseExceptionWithBackoff, PulseLoginException): """Exception to indicate that the application code is not logged in. Used for signalling waiters. """ + + def __init__(self, backoff: PulseBackoff): + """Initialize Pulse Not logged in error exception.""" + super().__init__("Not logged into Pulse", backoff) diff --git a/pyadtpulse/pulse_backoff.py b/pyadtpulse/pulse_backoff.py index 02e247c..606565a 100644 --- a/pyadtpulse/pulse_backoff.py +++ b/pyadtpulse/pulse_backoff.py @@ -122,6 +122,7 @@ def set_absolute_backoff_time(self, backoff_time: float) -> None: ), ) self._expiration_time = backoff_time + self._backoff_count = 0 async def wait_for_backoff(self) -> None: """Wait for backoff.""" diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 545749f..dd9ad63 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -128,23 +128,18 @@ def determine_error_type(): if "Try again in" in error_text: if (retry_after := extract_seconds_from_string(error_text)) > 0: raise PulseAccountLockedError( - f"Pulse account locked {retry_after/60} minutes for too many failed login attempts", self._login_backoff, retry_after + time(), ) elif "You have not yet signed in" in error_text: - raise PulseNotLoggedInError( - "Pulse not logged in", self._login_backoff - ) + raise PulseNotLoggedInError(self._login_backoff) else: # FIXME: not sure if this is true - raise PulseAuthenticationError(error_text, self._login_backoff) + raise PulseAuthenticationError(self._login_backoff) else: url = self._connection_properties.make_url(ADT_MFA_FAIL_URI) if url == response_url_string: - raise PulseMFARequiredError( - "MFA required to log into Pulse site", self._login_backoff - ) + raise PulseMFARequiredError(self._login_backoff) soup = make_soup( response[0], @@ -163,7 +158,7 @@ def determine_error_type(): response_url_string = str(response[2]) if url != response_url_string: determine_error_type() - raise PulseAuthenticationError("Unknown error", self._login_backoff) + raise PulseAuthenticationError(self._login_backoff) return soup @typechecked @@ -198,6 +193,14 @@ async def async_do_login_query( if self.login_in_progress: return None self._connection_status.authenticated_flag.clear() + # just raise exceptions if we're not going to be able to log in + lockout_time = self._login_backoff.expiration_time + if lockout_time > time(): + raise PulseAccountLockedError(self._login_backoff, lockout_time) + cs_backoff = self._connection_status.get_backoff() + lockout_time = cs_backoff.expiration_time + if lockout_time > time(): + raise PulseServiceTemporarilyUnavailableError(cs_backoff, lockout_time) self.login_in_progress = True data = { "usernameForm": self._authentication_properties.username, @@ -318,3 +321,7 @@ def detailed_debug_logging(self, value: bool): self._login_backoff.detailed_debug_logging = value self._connection_properties.detailed_debug_logging = value self._connection_status.detailed_debug_logging = value + + def get_login_backoff(self) -> PulseBackoff: + """Return login backoff.""" + return self._login_backoff diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index 30470f0..7f78264 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -1,6 +1,6 @@ """Pulse Query Manager.""" from logging import getLogger -from asyncio import TimeoutError, current_task, wait_for +from asyncio import TimeoutError, wait_for from datetime import datetime from http import HTTPStatus from time import time @@ -95,43 +95,6 @@ async def _handle_query_response( response.headers.get("Retry-After"), ) - @typechecked - def _set_retry_after(self, code: int, retry_after: str) -> None: - """ - Check the "Retry-After" header in the response and set retry_after property - based upon it. - - Will also set the connection status failure reason and rety after - properties. - - Parameters: - code (int): The HTTP response code - retry_after (str): The value of the "Retry-After" header - - Returns: - None. - - Raises: - PulseServiceTemporarilyUnavailableError: If the server returns a "Retry-After" header. - """ - if retry_after.isnumeric(): - retval = float(retry_after) + time() - else: - try: - retval = datetime.strptime( - retry_after, "%a, %d %b %Y %H:%M:%S %Z" - ).timestamp() - except ValueError: - return - description = self._get_http_status_description(code) - message = ( - f"Task {current_task()} received Retry-After {retval} due to {description}" - ) - - raise PulseServiceTemporarilyUnavailableError( - message, self._connection_status.get_backoff(), retval - ) - @typechecked def _handle_http_errors( self, return_value: tuple[int, str | None, URL | None, str | None] @@ -146,19 +109,40 @@ def _handle_http_errors( PulseServerConnectionError: If the server returns an error code. PulseServiceTemporarilyUnavailableError: If the server returns a Retry-After header.""" - if return_value[0] is not None and return_value[3] is not None: - self._set_retry_after( - return_value[0], - return_value[3], - ) + + def get_retry_after(retry_after: str) -> int | None: + """ + Parse the value of the "Retry-After" header. + + Parameters: + retry_after (str): The value of the "Retry-After" header + + Returns: + int | None: The timestamp in seconds to wait before retrying, or None if the header is invalid. + """ + if retry_after.isnumeric(): + retval = int(retry_after) + int(time()) + else: + try: + retval = int( + datetime.strptime( + retry_after, "%a, %d %b %Y %H:%M:%S %Z" + ).timestamp() + ) + except ValueError: + return None + return retval + if return_value[0] in ( HTTPStatus.TOO_MANY_REQUESTS, HTTPStatus.SERVICE_UNAVAILABLE, ): + retry = None + if return_value[3]: + retry = get_retry_after(return_value[3]) raise PulseServiceTemporarilyUnavailableError( - f"HTTP error {return_value[0]}: {return_value[1]}", self._connection_status.get_backoff(), - None, + retry, ) raise PulseServerConnectionError( f"HTTP error {return_value[0]}: {return_value[1]} connecting to {return_value[2]}", @@ -240,6 +224,12 @@ async def setup_query(): if not self._connection_properties.api_version: raise ValueError("Could not determine API version for connection") + retry_after = self._connection_status.retry_after + now = time() + if retry_after > now: + raise PulseServiceTemporarilyUnavailableError( + self._connection_status.get_backoff(), retry_after + ) await setup_query() url = self._connection_properties.make_url(uri) headers = extra_headers if extra_headers is not None else {} @@ -295,7 +285,6 @@ async def setup_query(): uri, ) raise PulseNotLoggedInError( - f"{method} for {uri} timed out waiting for authenticated flag to be set", self._connection_status.get_backoff(), ) from ex async with self._connection_properties.session.request( diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 42b2bb6..253a4a8 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -126,7 +126,9 @@ def __init__( self._timeout_task: asyncio.Task | None = None self._site: ADTPulseSite | None = None self._detailed_debug_logging = detailed_debug_logging - self._sync_check_exception: Exception | None = None + pc_backoff = self._pulse_connection.get_login_backoff() + self._sync_check_exception: Exception | None = PulseNotLoggedInError(pc_backoff) + pc_backoff.reset_backoff() def __repr__(self) -> str: """Object representation.""" @@ -222,7 +224,7 @@ def _set_sync_check_exception(self, e: Exception | None) -> None: < WARN_UPDATE_TASK_THRESHOLD ): return - self._sync_check_exception = e + self.sync_check_exception = e self._pulse_properties.updates_exist.set() async def _keepalive_task(self) -> None: @@ -298,6 +300,15 @@ def should_relogin(relogin_interval: int) -> bool: LOG.debug("%s cancelled", task_name) return + async def _clean_done_tasks(self) -> None: + with self._pa_attribute_lock: + if self._sync_task is not None and self._sync_task.done(): + await self._sync_task + self._sync_task = None + if self._timeout_task is not None and self._timeout_task.done(): + await self._timeout_task + self._timeout_task = None + async def _cancel_task(self, task: asyncio.Task | None) -> None: """ Cancel a given asyncio task. @@ -305,6 +316,7 @@ async def _cancel_task(self, task: asyncio.Task | None) -> None: Args: task (asyncio.Task | None): The task to be cancelled. """ + await self._clean_done_tasks() if task is None: return task_name = task.get_name() @@ -315,10 +327,11 @@ async def _cancel_task(self, task: asyncio.Task | None) -> None: except asyncio.CancelledError: pass if task == self._sync_task: - e = PulseNotLoggedInError( - "Pulse logout has been called", self._pulse_connection.login_backoff - ) - self._set_sync_check_exception(e) + with self._pa_attribute_lock: + self._sync_task = None + else: + with self._pa_attribute_lock: + self._timeout_task = None LOG.debug("%s successfully cancelled", task_name) async def _login_looped(self, task_name: str) -> None: @@ -344,8 +357,6 @@ async def _login_looped(self, task_name: str) -> None: except ( PulseClientConnectionError, PulseServerConnectionError, - PulseServiceTemporarilyUnavailableError, - PulseAccountLockedError, ) as ex: LOG.log( log_level, @@ -391,41 +402,24 @@ async def validate_sync_check_response() -> bool: Raises: PulseAccountLockedError if the account is locked and no retry time is available. + PulseAuthenticationError if the ADT Pulse site returns an authentication error. + PulseMFAError if the ADT Pulse site returns an MFA error. + PulseNotLoggedInError if the ADT Pulse site returns a not logged in error. """ - if not handle_response(code, url, logging.ERROR, "Error querying ADT sync"): - return False - # this should have already been handled if response_text is None: LOG.warning("Internal Error: response_text is None") return False pattern = r"\d+[-]\d+[-]\d+" if not re.match(pattern, response_text): LOG.warning( - "Unexpected sync check format (%s)", + "Unexpected sync check format", ) try: self._pulse_connection.check_login_errors( (code, response_text, url) ) - except PulseNotLoggedInError: - LOG.info("Re-login required to continue ADT Pulse sync check") - await self._pulse_connection.quick_logout() - await self._login_looped(task_name) - return False - except PulseAccountLockedError as ex: - self._set_sync_check_exception(ex) - if ex.retry_time is not None: - LOG.info( - "Pulse account locked, sleeping for %s seconds and relogging in.", - time.time() - ex.retry_time, - ) - await asyncio.sleep(time.time() - ex.retry_time) - await self._login_looped(task_name) - return False - else: - raise except PulseServerConnectionError: - LOG.info("Server connection issue, continuing") + LOG.debug("Server connection issue, continuing") return False return True @@ -434,7 +428,7 @@ async def handle_no_updates_exist() -> bool: try: success = await self.async_update() except PulseGatewayOfflineError as e: - if self._sync_check_exception != e: + if self.sync_check_exception != e: LOG.debug( "Pulse gateway offline, update failed in task %s", task_name ) @@ -460,6 +454,12 @@ def handle_updates_exist() -> bool: return True return False + async def shutdown_task(ex: Exception): + await self._pulse_connection.quick_logout() + await self._cancel_task(self._timeout_task) + self._set_sync_check_exception(ex) + + transient_exception_count = 0 while True: try: await self.site.gateway.backoff.wait_for_backoff() @@ -478,10 +478,25 @@ def handle_updates_exist() -> bool: except ( PulseClientConnectionError, PulseServerConnectionError, - PulseServiceTemporarilyUnavailableError, ) as e: - self._set_sync_check_exception(e) + # temporarily unavailble errors should be reported immediately + # since the next query will sleep until the retry-after is over + transient_exception_count += 1 + if transient_exception_count > WARN_UPDATE_TASK_THRESHOLD: + self._set_sync_check_exception(e) continue + except ( + PulseServiceTemporarilyUnavailableError, + PulseNotLoggedInError, + ) as e: + if isinstance(e, PulseServiceTemporarilyUnavailableError): + status = "temporarily unavailable" + else: + status = "not logged in" + LOG.warning("Pulse service %s, ending %s task", status, task_name) + await shutdown_task(e) + return + self._set_sync_check_exception(None) if not handle_response( code, url, logging.WARNING, "Error querying ADT sync" ): @@ -496,13 +511,14 @@ def handle_updates_exist() -> bool: PulseAuthenticationError, PulseMFARequiredError, PulseAccountLockedError, + PulseNotLoggedInError, ) as ex: - self._set_sync_check_exception(ex) LOG.error( - "Task %s exiting due to error relogging into Pulse: %s", + "Task %s exiting due to error: %s", task_name, ex.args[0], ) + await shutdown_task(ex) return if handle_updates_exist(): last_sync_check_was_different = True @@ -539,15 +555,18 @@ async def async_login(self) -> bool: soup = await self._pulse_connection.async_do_login_query() if soup is None: return False + self._set_sync_check_exception(None) # if tasks are started, we've already logged in before - if self._sync_task is not None or self._timeout_task is not None: + # clean up completed tasks first + await self._clean_done_tasks() + if self._timeout_task is not None: return True await self._update_sites(soup) if self._site is None: LOG.error("Could not retrieve any sites, login failed") await self._pulse_connection.quick_logout() return False - self._sync_check_exception = None + self.sync_check_exception = None self._timeout_task = asyncio.create_task( self._keepalive_task(), name=KEEPALIVE_TASK_NAME ) @@ -562,10 +581,12 @@ async def async_logout(self) -> None: LOG.info( "Logging %s out of ADT Pulse", self._authentication_properties.username ) + self._set_sync_check_exception( + PulseNotLoggedInError(self._pulse_connection.get_login_backoff()) + ) if asyncio.current_task() not in (self._sync_task, self._timeout_task): await self._cancel_task(self._timeout_task) await self._cancel_task(self._sync_task) - self._timeout_task = self._sync_task = None await self._pulse_connection.async_do_logout_query(self.site.id) async def async_update(self) -> bool: @@ -599,10 +620,9 @@ async def wait_for_update(self) -> None: Every exception from exceptions.py are possible """ # FIXME?: This code probably won't work with multiple waiters. - if not self.is_connected: - raise PulseNotLoggedInError( - "Not connected to Pulse", self._pulse_connection.login_backoff - ) + await self._clean_done_tasks() + if self.sync_check_exception: + raise self.sync_check_exception with self._pa_attribute_lock: if self._sync_task is None: coro = self._sync_check_task() @@ -613,8 +633,8 @@ async def wait_for_update(self) -> None: await self._pulse_properties.updates_exist.wait() self._pulse_properties.updates_exist.clear() - if self._sync_check_exception: - raise self._sync_check_exception + if self.sync_check_exception: + raise self.sync_check_exception @property def sites(self) -> list[ADTPulseSite]: @@ -655,3 +675,15 @@ def detailed_debug_logging(self) -> bool: def detailed_debug_logging(self, value: bool) -> None: """Set detailed debug logging.""" self._pulse_connection.detailed_debug_logging = value + + @property + def sync_check_exception(self) -> Exception | None: + """Return sync check exception.""" + with self._pa_attribute_lock: + return self._sync_check_exception + + @sync_check_exception.setter + def sync_check_exception(self, value: Exception | None) -> None: + """Set sync check exception.""" + with self._pa_attribute_lock: + self._sync_check_exception = value diff --git a/tests/test_backoff.py b/tests/test_backoff.py index 08fb2aa..e0e048f 100644 --- a/tests/test_backoff.py +++ b/tests/test_backoff.py @@ -869,6 +869,7 @@ async def test_absolute_backoff_time(mock_sleep, freeze_time_to_now): # Act backoff.set_absolute_backoff_time(time() + 100) + assert backoff._backoff_count == 0 backoff.reset_backoff() # make sure backoff can't be reset assert backoff.expiration_time == time() + 100 diff --git a/tests/test_exceptions.py b/tests/test_exceptions.py index 48c1655..94e0ce4 100644 --- a/tests/test_exceptions.py +++ b/tests/test_exceptions.py @@ -81,10 +81,12 @@ def test_pulse_exception_with_retry_past_retry_time(self): backoff = PulseBackoff("test", 1.0) backoff.increment_backoff() retry_time = time() - 10 - with pytest.raises(ValueError): - PulseExceptionWithRetry("retry must be in the future", backoff, retry_time) + with pytest.raises(PulseExceptionWithRetry): + raise PulseExceptionWithRetry( + "retry must be in the future", backoff, retry_time + ) # 1 backoff for increment - assert backoff.backoff_count == 1 + assert backoff.backoff_count == 2 assert backoff.expiration_time == 0.0 # PulseServiceTemporarilyUnavailableError does not reset the backoff count or set an absolute backoff time if retry time is in the past @@ -92,17 +94,15 @@ def test_pulse_service_temporarily_unavailable_error_past_retry_time_fixed(self) backoff = PulseBackoff("test", 1.0) backoff.increment_backoff() retry_time = time() - 10 - with pytest.raises(ValueError): - PulseServiceTemporarilyUnavailableError( - "retry must be in the future", backoff, retry_time - ) - assert backoff.backoff_count == 1 + with pytest.raises(PulseServiceTemporarilyUnavailableError): + raise PulseServiceTemporarilyUnavailableError(backoff, retry_time) + assert backoff.backoff_count == 2 assert backoff.expiration_time == 0.0 # PulseAuthenticationError is a subclass of PulseExceptionWithBackoff and PulseLoginException def test_pulse_authentication_error_inheritance(self): backoff = PulseBackoff("test", 1.0) - exception = PulseAuthenticationError("error", backoff) + exception = PulseAuthenticationError(backoff) assert isinstance(exception, PulseExceptionWithBackoff) assert isinstance(exception, PulseLoginException) @@ -110,15 +110,17 @@ def test_pulse_authentication_error_inheritance(self): def test_pulse_service_temporarily_unavailable_error(self): backoff = PulseBackoff("test", 1.0) exception = PulseServiceTemporarilyUnavailableError( - "error", backoff, retry_time=5.0 + backoff, retry_time=time() + 10.0 ) + assert backoff.backoff_count == 0 assert isinstance(exception, PulseExceptionWithRetry) assert isinstance(exception, PulseConnectionError) # PulseAccountLockedError is a subclass of PulseExceptionWithRetry and PulseLoginException def test_pulse_account_locked_error_inheritance(self): backoff = PulseBackoff("test", 1.0) - exception = PulseAccountLockedError("error", backoff, 10.0) + exception = PulseAccountLockedError(backoff, time() + 10.0) + assert backoff.backoff_count == 0 assert isinstance(exception, PulseExceptionWithRetry) assert isinstance(exception, PulseLoginException) @@ -139,14 +141,14 @@ def test_pulse_exception_with_backoff_string_representation(self): # PulseExceptionWithRetry string representation includes the class name, message, backoff object, and retry time def test_pulse_exception_with_retry_string_representation_fixed(self): backoff = PulseBackoff("test", 1.0) - exception = PulseExceptionWithRetry("error", backoff, 1234567890.0) + exception = PulseExceptionWithRetry("error", backoff, time() + 10) expected_string = "PulseExceptionWithRetry: error" assert str(exception) == expected_string # PulseNotLoggedInError is a subclass of PulseExceptionWithBackoff and PulseLoginException def test_pulse_not_logged_in_error_inheritance(self): backoff = PulseBackoff("test", 1.0) - exception = PulseNotLoggedInError("error", backoff) + exception = PulseNotLoggedInError(backoff) assert isinstance(exception, PulseExceptionWithBackoff) assert isinstance(exception, PulseLoginException) diff --git a/tests/test_paa_codium.py b/tests/test_paa_codium.py index b25c6ee..24bbd81 100644 --- a/tests/test_paa_codium.py +++ b/tests/test_paa_codium.py @@ -84,24 +84,24 @@ async def test_async_logout_without_login_with_valid_email_fixed(self): # The async_logout method successfully logs the user out of the ADT Pulse cloud service. @pytest.mark.asyncio - async def test_async_logout_successfully_logs_out(self, mocker): + async def test_async_logout_successfully_logs_out( + self, mocked_server_responses, get_mocked_url, read_file + ): # Arrange pulse = PyADTPulseAsync( username="test_user@example.com", password="test_password", fingerprint="test_fingerprint", ) - mocker.patch.object(pulse._pulse_connection, "async_query") - + add_signin( + LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file + ) # Act await pulse.async_login() await pulse.async_logout() # Assert assert not pulse.is_connected - pulse._pulse_connection.async_query.assert_called_once_with( - pulse.site.id, "POST" - ) # The async_update method checks the ADT Pulse cloud service for updates and returns True if updates are available. @pytest.mark.asyncio diff --git a/tests/test_pqm_codium.py b/tests/test_pqm_codium.py index a14cddc..b9f0062 100644 --- a/tests/test_pqm_codium.py +++ b/tests/test_pqm_codium.py @@ -3,18 +3,13 @@ # Dependencies: # pip install pytest-mock from time import time -from unittest.mock import AsyncMock import pytest -from aiohttp.client_exceptions import ( - ClientConnectionError, - ClientConnectorError, - ServerConnectionError, - ServerDisconnectedError, -) +from aiohttp.client_exceptions import ClientConnectionError, ServerDisconnectedError from aiohttp.client_reqrep import ConnectionKey from yarl import URL +from conftest import MOCKED_API_VERSION from pyadtpulse.exceptions import ( PulseClientConnectionError, PulseNotLoggedInError, @@ -143,9 +138,7 @@ async def mock_async_query( retry_time = time() + 1 # Set a future time for retry_time else: retry_time += time() + 1 - raise PulseServiceTemporarilyUnavailableError( - "Service Unavailable", backoff, retry_time - ) + raise PulseServiceTemporarilyUnavailableError(backoff, retry_time) mocker.patch.object( PulseQueryManager, "async_query", side_effect=mock_async_query @@ -160,91 +153,54 @@ async def mock_async_query( # can handle HTTP 429 Too Many Requests response with the recommended fix @pytest.mark.asyncio - async def test_handle_http_429_with_fix(self, mocker): + async def test_handle_http_429_with_fix( + self, mocker, mocked_server_responses, get_mocked_url + ): # Given connection_status = PulseConnectionStatus() connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") + url = get_mocked_url("/api/data") query_manager = PulseQueryManager(connection_status, connection_properties) - expected_response = (429, "Too Many Requests", URL("http://example.com")) - MAX_RETRIES = 3 - - async def mock_async_query( - uri, - method="GET", - extra_params=None, - extra_headers=None, - timeout=1, - requires_authentication=True, - ): - retry_time = time() + 10 # Set a future timestamp for retry_time - raise PulseServiceTemporarilyUnavailableError( - f"Task received Retry-After {expected_response[1]} due to Too Many Requests", - connection_status.get_backoff(), - retry_time, - ) - - mocker.patch.object( - PulseQueryManager, "async_query", side_effect=mock_async_query - ) - + expected_response = (429, "Too Many Requests", URL(url)) + mocked_server_responses.get(url, status=expected_response[0]) # When with pytest.raises(PulseServiceTemporarilyUnavailableError) as exc_info: - await query_manager.async_query("/api/data") + await query_manager.async_query("/api/data", requires_authentication=False) # Then - assert ( - f"Task received Retry-After {expected_response[1]} due to Too Many Requests" - in str(exc_info.value) + assert "Pulse service temporarily unavailable until indefinitely" in str( + exc_info.value ) assert exc_info.value.backoff == connection_status.get_backoff() # can handle ClientConnectionError with 'Connection refused' message using default parameter values @pytest.mark.asyncio async def test_handle_client_connection_error_with_default_values_fixed_fixed( - self, mocker + self, mocked_server_responses, get_mocked_url ): # Given connection_status = PulseConnectionStatus() connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") query_manager = PulseQueryManager(connection_status, connection_properties) expected_error_message = "Connection refused" - expected_backoff = mocker.Mock() - expected_response = (None, None, None, None) - - async def mock_async_query( - uri, - method="GET", - extra_params=None, - extra_headers=None, - timeout=1, - requires_authentication=True, - ): - raise PulseClientConnectionError( - expected_error_message, backoff=PulseBackoff("Query:GET /api/data", 1) - ) - mocker.patch.object( - PulseQueryManager, "async_query", side_effect=mock_async_query - ) - mocker.patch.object(PulseQueryManager, "_set_retry_after") + expected_response = (None, None, None, None) # When - with pytest.raises(PulseClientConnectionError) as exc_info: - await query_manager.async_query("/api/data") + with pytest.raises(PulseServerConnectionError) as exc_info: + await query_manager.async_query("/api/data", requires_authentication=False) # Then assert ( str(exc_info.value) - == f"PulseClientConnectionError: {expected_error_message}" + == f"PulseServerConnectionError: Pulse server error: {expected_error_message}: GET {get_mocked_url('/api/data')}" ) - PulseQueryManager._set_retry_after.assert_not_called() # can handle ClientConnectorError with non-TimeoutError or BrokenPipeError os_error @pytest.mark.asyncio - async def test_handle_client_connector_error_with_fix(self, mocker): - # Given - from aiohttp import ClientSession - + async def test_handle_client_connector_error_with_fix( + self, mocked_server_responses, get_mocked_url + ): connection_status = PulseConnectionStatus() connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") query_manager = PulseQueryManager(connection_status, connection_properties) @@ -252,14 +208,8 @@ async def test_handle_client_connector_error_with_fix(self, mocker): "Error occurred", connection_status.get_backoff() ) ck = ConnectionKey("portal.adtpulse.com", 443, True, None, None, None, None) - - async def mock_request(*args, **kwargs): - raise ClientConnectorError( - connection_key=ck, os_error=FileNotFoundError("File not found") - ) - - mocker.patch.object(ClientSession, "request", side_effect=mock_request) - + url = get_mocked_url("/api/data") + mocked_server_responses.get(url, exception=expected_error) # When, Then with pytest.raises(PulseServerConnectionError) as ex: await query_manager.async_query("/api/data", requires_authentication=False) @@ -268,82 +218,29 @@ async def mock_request(*args, **kwargs): # can handle Retry-After header in HTTP response @pytest.mark.timeout(70) @pytest.mark.asyncio - async def test_handle_retry_after_header(self, mocker): + async def test_handle_retry_after_header( + self, mocked_server_responses, get_mocked_url, freeze_time_to_now + ): # Given connection_status = PulseConnectionStatus() connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") query_manager = PulseQueryManager(connection_status, connection_properties) - expected_response = (429, "Too Many Requests", URL("http://example.com")) + url = get_mocked_url("/api/data") + expected_response = (429, "Too Many Requests", URL(url)) expected_retry_after = "60" - - async def mock_async_query( - uri, - method="GET", - extra_params=None, - extra_headers=None, - timeout=1, - requires_authentication=True, - ): - raise PulseServiceTemporarilyUnavailableError( - "Task received Retry-After due to ", - connection_status.get_backoff(), - float(expected_retry_after) + time(), - ) - - mocker.patch.object( - PulseQueryManager, "async_query", side_effect=mock_async_query + mocked_server_responses.get( + url, + status=expected_response[0], + headers={"Retry-After": expected_retry_after}, ) # When with pytest.raises(PulseServiceTemporarilyUnavailableError) as exc_info: - await query_manager.async_query("/api/data") + await query_manager.async_query("/api/data", requires_authentication=False) # Then assert exc_info.value.backoff == connection_status.get_backoff() - - assert connection_status._backoff.wait_for_backoff.call_count == 1 - assert connection_status.authenticated_flag.wait.call_count == 0 - assert connection_properties.session.request.call_count == 1 - assert connection_properties.session.request.call_args[0][0] == "GET" - assert connection_properties.session.request.call_args[0][ - 1 - ] == connection_properties.make_url("/api/data") - assert connection_properties.session.request.call_args[1]["headers"] == {} - assert connection_properties.session.request.call_args[1]["params"] is None - assert connection_properties.session.request.call_args[1]["data"] is None - assert connection_properties.session.request.call_args[1]["timeout"] == 1 - - assert connection_status.get_backoff().reset_backoff.call_count == 1 - - # can handle ServerConnectionError with default values - @pytest.mark.asyncio - async def test_handle_server_connection_error_with_default_values(self, mocker): - # Given - connection_status = PulseConnectionStatus() - connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") - query_manager = PulseQueryManager(connection_status, connection_properties) - expected_error = PulseServerConnectionError( - "Server connection error", query_manager._connection_status.get_backoff() - ) - - async def mock_async_query( - uri, - method="GET", - extra_params=None, - extra_headers=None, - timeout=1, - requires_authentication=True, - ): - raise ServerConnectionError("Server connection error") - - mocker.patch.object( - PulseQueryManager, "async_query", side_effect=mock_async_query - ) - - # When, Then - with pytest.raises(PulseServerConnectionError) as e: - await query_manager.async_query("/api/data") - assert str(e.value) == str(expected_error) + assert exc_info.value.retry_time == int(expected_retry_after) + int(time()) # can handle ServerTimeoutError @pytest.mark.asyncio @@ -378,70 +275,6 @@ async def mock_async_query( requires_authentication=True, ) - # can handle ClientConnectionError with 'timed out' message - @pytest.mark.asyncio - async def test_handle_client_connection_error_with_timed_out_message(self, mocker): - # Given - connection_status = PulseConnectionStatus() - connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") - query_manager = PulseQueryManager(connection_status, connection_properties) - expected_error_message = "Connection refused" - expected_backoff = PulseBackoff( - "Query:GET /api/data", - 1, - threshold=0, - debug_locks=False, - detailed_debug_logging=False, - ) - - async def mock_async_query( - uri, method, extra_params, extra_headers, timeout, requires_authentication - ): - raise ClientConnectionError(expected_error_message) - - mocker.patch.object( - PulseQueryManager, "async_query", side_effect=mock_async_query - ) - mocker.patch.object(PulseQueryManager, "_handle_network_errors") - - # When - await query_manager.async_query( - "/api/data", - method="GET", - extra_params=None, - extra_headers=None, - timeout=1, - requires_authentication=True, - ) - - # Then - assert query_manager._handle_network_errors.call_count == 1 - assert query_manager._handle_network_errors.call_args == mocker.call( - ClientConnectionError(expected_error_message), - ) - - assert ( - query_manager._connection_status.get_backoff().wait_for_backoff.call_count - == 1 - ) - assert ( - query_manager._connection_status.get_backoff().wait_for_backoff.call_args - == mocker.call() - ) - - assert ( - query_manager._connection_status.get_backoff().increment_backoff.call_count - == 1 - ) - assert ( - query_manager._connection_status.get_backoff().increment_backoff.call_args - == mocker.call() - ) - - assert ( - query_manager._connection_status.get_backoff().reset_backoff.call_count == 0 - ) - # can handle missing API version @pytest.mark.asyncio async def test_handle_missing_api_version(self, mocker): @@ -468,86 +301,42 @@ async def mock_async_query( # can handle valid method parameter @pytest.mark.asyncio - async def test_valid_method_parameter(self, mocker): + async def test_valid_method_parameter( + self, mocked_server_responses, get_mocked_url, mocker + ): # Given connection_status = PulseConnectionStatus() connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") query_manager = PulseQueryManager(connection_status, connection_properties) - expected_response = (200, "Response", URL("http://example.com")) + expected_response = (200, "Response", URL(get_mocked_url("/api/data"))) - async def mock_async_query( - uri, - method="GET", - extra_params=None, - extra_headers=None, - timeout=1, - requires_authentication=True, - ): - return expected_response - - mocker.patch.object( - PulseQueryManager, "async_query", side_effect=mock_async_query - ) - mocker.patch.object( - query_manager._connection_status.get_backoff(), - "wait_for_backoff", - new_callable=AsyncMock, + mocked_server_responses.get( + get_mocked_url("/api/data"), status=200, body="Response" ) - # When - result = await query_manager.async_query("/api/data") + result = await query_manager.async_query( + "/api/data", requires_authentication=False + ) # Then assert result == expected_response - assert ( - query_manager._connection_status.get_backoff().wait_for_backoff.call_count - == 0 - ) - assert query_manager._connection_properties.api_version is None - assert query_manager._connection_status.authenticated_flag.wait.call_count == 0 - assert query_manager._connection_properties.session.request.call_count == 0 - assert query_manager._handle_http_errors.call_count == 0 - assert query_manager._handle_network_errors.call_count == 0 - assert ( - query_manager._connection_status.get_backoff().reset_backoff.call_count == 0 - ) + + assert query_manager._connection_properties.api_version == MOCKED_API_VERSION # can handle ClientResponseError and include backoff in the raised exception @pytest.mark.asyncio - async def test_handle_client_response_error_with_backoff(self, mocker): + async def test_handle_client_response_error_with_backoff( + self, mocked_server_responses, get_mocked_url + ): # Given connection_status = PulseConnectionStatus() connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") query_manager = PulseQueryManager(connection_status, connection_properties) expected_response = (429, "Too Many Requests", URL("http://example.com")) - - async def mock_async_query( - uri, - method="GET", - extra_params=None, - extra_headers=None, - timeout=1, - requires_authentication=True, - ): - raise PulseServerConnectionError( - f"HTTP error {expected_response[0]}: {expected_response[1]} connecting to {expected_response[2]}", - connection_status.get_backoff(), - ) - - mocker.patch.object( - PulseQueryManager, "async_query", side_effect=mock_async_query - ) - + mocked_server_responses.get(get_mocked_url("/api/data"), status=429) # When - with pytest.raises(PulseServerConnectionError) as exc_info: - await query_manager.async_query("/api/data") - - # Then - assert ( - str(exc_info.value) - == f"PulseServerConnectionError: HTTP error {expected_response[0]}: {expected_response[1]} connecting to {expected_response[2]}" - ) - assert exc_info.value.backoff == connection_status.get_backoff() + with pytest.raises(PulseServiceTemporarilyUnavailableError) as exc_info: + await query_manager.async_query("/api/data", requires_authentication=False) # can handle invalid Retry-After header value format @pytest.mark.asyncio @@ -652,60 +441,37 @@ async def mock_async_query( # can handle PulseClientConnectionError @pytest.mark.asyncio - async def test_handle_pulse_client_connection_error(self, mocker): + async def test_handle_pulse_client_connection_error( + self, mocked_server_responses, get_mocked_url + ): # Given connection_status = PulseConnectionStatus() connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") query_manager = PulseQueryManager(connection_status, connection_properties) - expected_response = (0, None, None, None) - - async def mock_async_query( - uri, - method="GET", - extra_params=None, - extra_headers=None, - timeout=1, - requires_authentication=True, - ): - raise PulseClientConnectionError( - "Client connection error", connection_status.get_backoff() - ) - - mocker.patch.object( - PulseQueryManager, "async_query", side_effect=mock_async_query + mocked_server_responses.get( + get_mocked_url("/api/data"), + exception=ClientConnectionError("Network error"), + repeat=True, ) # When with pytest.raises(PulseClientConnectionError): - await query_manager.async_query("/api/data") - - # Then - assert query_manager._handle_pulse_client_connection_error.call_count == 0 + await query_manager.async_query("/api/data", requires_authentication=False) # can handle ServerDisconnectedError @pytest.mark.asyncio - async def test_handle_server_disconnected_error(self, mocker): + async def test_handle_server_disconnected_error( + self, mocked_server_responses, get_mocked_url + ): # Given connection_status = PulseConnectionStatus() connection_properties = PulseConnectionProperties("https://portal.adtpulse.com") query_manager = PulseQueryManager(connection_status, connection_properties) - - async def mock_async_query( - uri, - method="GET", - extra_params=None, - extra_headers=None, - timeout=1, - requires_authentication=True, - ): - raise ServerDisconnectedError() - - mocker.patch.object( - PulseQueryManager, "async_query", side_effect=mock_async_query + mocked_server_responses.get( + get_mocked_url("/api/data"), exception=ServerDisconnectedError ) - # When with pytest.raises(PulseServerConnectionError): - await query_manager.async_query("/api/data") + await query_manager.async_query("/api/data", requires_authentication=False) # can handle PulseNotLoggedInError @pytest.mark.asyncio @@ -731,7 +497,7 @@ async def mock_async_query( debug_locks=query_manager._debug_locks, detailed_debug_logging=connection_properties.detailed_debug_logging, ) - raise PulseNotLoggedInError("Not logged in", backoff) + raise PulseNotLoggedInError(backoff) mocker.patch.object( PulseQueryManager, "async_query", side_effect=mock_async_query diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index 55ef50d..5f8394c 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -11,13 +11,19 @@ ADT_DEVICE_URI, ADT_LOGIN_URI, ADT_LOGOUT_URI, + ADT_MFA_FAIL_URI, ADT_ORB_URI, ADT_SUMMARY_URI, ADT_SYNC_CHECK_URI, ADT_TIMEOUT_URI, DEFAULT_API_HOST, ) -from pyadtpulse.exceptions import PulseNotLoggedInError +from pyadtpulse.exceptions import ( + PulseAccountLockedError, + PulseAuthenticationError, + PulseMFARequiredError, + PulseNotLoggedInError, +) from pyadtpulse.pyadtpulse_async import PyADTPulseAsync DEFAULT_SYNC_CHECK = "234532-456432-0" @@ -368,3 +374,38 @@ async def test_infinite_sync_check(adt_pulse_instance, get_mocked_url, read_file shutdown_event.set() task.cancel() await task + + +@pytest.mark.asyncio +async def test_sync_check_errors(adt_pulse_instance, get_mocked_url, read_file, mocker): + p, response = await adt_pulse_instance + pattern = re.compile(rf"{re.escape(get_mocked_url(ADT_SYNC_CHECK_URI))}/?.*$") + + shutdown_event = asyncio.Event() + shutdown_event.clear() + for test_type in ( + (LoginType.FAIL, PulseAuthenticationError), + (LoginType.NOT_SIGNED_IN, PulseNotLoggedInError), + (LoginType.MFA, PulseMFARequiredError), + (LoginType.LOCKED, PulseAccountLockedError), + ): + redirect = ADT_LOGIN_URI + if test_type[0] == LoginType.MFA: + redirect = ADT_MFA_FAIL_URI + response.get( + pattern, status=302, headers={"Location": get_mocked_url(redirect)} + ) + add_signin(test_type[0], response, get_mocked_url, read_file) + task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) + with pytest.raises(test_type[1]): + await task + await asyncio.sleep(0.5) + # assert p._sync_task is None or p._sync_task.done() + # assert p._timeout_task is None or p._timeout_task.done() + if test_type[0] == LoginType.MFA: + # pop the post MFA redirect from the responses + with pytest.raises(PulseMFARequiredError): + await p.async_login() + add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) + if test_type[0] != LoginType.LOCKED: + await p.async_login() diff --git a/tests/test_pulse_connection.py b/tests/test_pulse_connection.py index a226c32..71070fc 100644 --- a/tests/test_pulse_connection.py +++ b/tests/test_pulse_connection.py @@ -119,7 +119,7 @@ async def test_multiple_login( @pytest.mark.asyncio async def test_account_lockout( - mocked_server_responses, mock_sleep, get_mocked_url, freeze_time_to_now, read_file + mocked_server_responses, mock_sleep, get_mocked_url, read_file, freeze_time_to_now ): pc = setup_pulse_connection() add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) @@ -138,10 +138,10 @@ async def test_account_lockout( # don't set backoff on locked account, just set expiration time on backoff assert pc._login_backoff.backoff_count == 0 assert mock_sleep.call_count == 0 + freeze_time_to_now.tick(delta=datetime.timedelta(seconds=(60 * 30) + 1)) add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await pc.async_do_login_query() - assert mock_sleep.call_count == 1 - assert mock_sleep.call_args_list[0][0][0] == 60 * 30 + assert mock_sleep.call_count == 0 assert pc.is_connected assert pc._connection_status.authenticated_flag.is_set() freeze_time_to_now.tick(delta=datetime.timedelta(seconds=60 * 30 + 1)) @@ -149,7 +149,7 @@ async def test_account_lockout( with pytest.raises(PulseAccountLockedError): await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 0 - assert mock_sleep.call_count == 1 + assert mock_sleep.call_count == 0 @pytest.mark.asyncio diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index 06b1ccb..1202376 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -105,9 +105,9 @@ async def query_orb_task(): @pytest.mark.asyncio async def test_retry_after( mocked_server_responses, - mock_sleep, freeze_time_to_now, get_mocked_connection_properties, + mock_sleep, ): """Test retry after.""" @@ -126,26 +126,19 @@ async def test_retry_after( ) with pytest.raises(PulseServiceTemporarilyUnavailableError): await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert mock_sleep.call_count == 0 # make sure we can't override the retry s.get_backoff().reset_backoff() - assert s.get_backoff().expiration_time == (now + float(retry_after_time)) - mocked_server_responses.get( - cp.make_url(ADT_ORB_URI), - status=200, - ) - await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert mock_sleep.call_count == 1 - mock_sleep.assert_called_once_with(float(retry_after_time)) + assert s.get_backoff().expiration_time == int(now + float(retry_after_time)) + with pytest.raises(PulseServiceTemporarilyUnavailableError): + await p.async_query(ADT_ORB_URI, requires_authentication=False) frozen_time.tick(timedelta(seconds=retry_after_time + 1)) mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=200, ) + # this should succeed await p.async_query(ADT_ORB_URI, requires_authentication=False) - # shouldn't sleep since past expiration time - assert mock_sleep.call_count == 1 - frozen_time.tick(timedelta(seconds=1)) + now = time.time() retry_date = now + float(retry_after_time) retry_date_str = datetime.fromtimestamp(retry_date).strftime( @@ -162,27 +155,33 @@ async def test_retry_after( ) with pytest.raises(PulseServiceTemporarilyUnavailableError): await p.async_query(ADT_ORB_URI, requires_authentication=False) + + frozen_time.tick(timedelta(seconds=new_retry_after - 1)) + with pytest.raises(PulseServiceTemporarilyUnavailableError): + await p.async_query(ADT_ORB_URI, requires_authentication=False) + frozen_time.tick(timedelta(seconds=2)) mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=200, ) + # should succeed await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert mock_sleep.call_count == 2 - assert mock_sleep.call_args_list[1][0][0] == new_retry_after - frozen_time.tick(timedelta(seconds=retry_after_time + 1)) # unavailable with no retry after mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=503, ) + frozen_time.tick(timedelta(seconds=retry_after_time + 1)) with pytest.raises(PulseServiceTemporarilyUnavailableError): await p.async_query(ADT_ORB_URI, requires_authentication=False) mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=200, ) + # should succeed + frozen_time.tick(timedelta(seconds=1)) await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert mock_sleep.call_count == 3 + # retry after in the past mocked_server_responses.get( cp.make_url(ADT_ORB_URI), @@ -195,8 +194,9 @@ async def test_retry_after( cp.make_url(ADT_ORB_URI), status=200, ) + frozen_time.tick(timedelta(seconds=1)) + # should succeed await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert mock_sleep.call_count == 4 @pytest.mark.asyncio From 8cc74baade080aaa1059b54341be12db4d30e0b2 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Wed, 10 Jan 2024 21:03:25 -0500 Subject: [PATCH 187/226] remove backoffs from login exceptions --- conftest.py | 20 +++---- pyadtpulse/exceptions.py | 18 +++---- pyadtpulse/pulse_connection.py | 8 +-- pyadtpulse/pulse_query_manager.py | 4 +- pyadtpulse/pyadtpulse_async.py | 6 +-- tests/test_exceptions.py | 10 ++-- tests/test_pqm_codium.py | 2 +- tests/test_pulse_async.py | 90 ++++++++++++++++++++++++------- 8 files changed, 99 insertions(+), 59 deletions(-) diff --git a/conftest.py b/conftest.py index 11e5deb..8626def 100644 --- a/conftest.py +++ b/conftest.py @@ -245,7 +245,6 @@ def mocked_server_responses( def add_custom_response( mocked_server_responses, - get_mocked_url, read_file, url: str, method: str = "GET", @@ -257,7 +256,7 @@ def add_custom_response( raise ValueError("Unsupported HTTP method. Only GET and POST are supported.") mocked_server_responses.add( - get_mocked_url(url), + url, method, status=status, body=read_file(file_name) if file_name else "", @@ -269,14 +268,12 @@ def add_custom_response( def add_signin( signin_type: LoginType, mocked_server_responses, get_mocked_url, read_file ): - if signin_type != LoginType.SUCCESS and signin_type != LoginType.MFA: - add_custom_response( - mocked_server_responses, - get_mocked_url, - read_file, - ADT_LOGIN_URI, - file_name=signin_type.value, - ) + add_custom_response( + mocked_server_responses, + read_file, + get_mocked_url(ADT_LOGIN_URI), + file_name=signin_type.value, + ) redirect = get_mocked_url(ADT_LOGIN_URI) if signin_type == LoginType.MFA: redirect = get_mocked_url(ADT_MFA_FAIL_URI) @@ -284,9 +281,8 @@ def add_signin( redirect = get_mocked_url(ADT_SUMMARY_URI) add_custom_response( mocked_server_responses, - get_mocked_url, read_file, - ADT_LOGIN_URI, + get_mocked_url(ADT_LOGIN_URI), status=307, method="POST", headers={"Location": redirect}, diff --git a/pyadtpulse/exceptions.py b/pyadtpulse/exceptions.py index 72b3bf5..1c9a958 100644 --- a/pyadtpulse/exceptions.py +++ b/pyadtpulse/exceptions.py @@ -98,12 +98,12 @@ class PulseLoginException(Exception): Base class for catching all login exceptions.""" -class PulseAuthenticationError(PulseExceptionWithBackoff, PulseLoginException): +class PulseAuthenticationError(PulseLoginException): """Authentication error.""" - def __init__(self, backoff: PulseBackoff): + def __init__(self): """Initialize Pulse Authentication error exception.""" - super().__init__("Error authenticating to Pulse", backoff) + super().__init__("Error authenticating to Pulse") class PulseAccountLockedError(PulseExceptionWithRetry, PulseLoginException): @@ -124,20 +124,20 @@ def __init__(self, backoff: PulseBackoff): super().__init__("Gateway is offline", backoff) -class PulseMFARequiredError(PulseExceptionWithBackoff, PulseLoginException): +class PulseMFARequiredError(PulseLoginException): """MFA required error.""" - def __init__(self, backoff: PulseBackoff): + def __init__(self): """Initialize Pulse MFA required error exception.""" - super().__init__("Authentication failed because MFA is required", backoff) + super().__init__("Authentication failed because MFA is required") -class PulseNotLoggedInError(PulseExceptionWithBackoff, PulseLoginException): +class PulseNotLoggedInError(PulseLoginException): """Exception to indicate that the application code is not logged in. Used for signalling waiters. """ - def __init__(self, backoff: PulseBackoff): + def __init__(self): """Initialize Pulse Not logged in error exception.""" - super().__init__("Not logged into Pulse", backoff) + super().__init__("Not logged into Pulse") diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index dd9ad63..2c49624 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -132,14 +132,14 @@ def determine_error_type(): retry_after + time(), ) elif "You have not yet signed in" in error_text: - raise PulseNotLoggedInError(self._login_backoff) + raise PulseNotLoggedInError() else: # FIXME: not sure if this is true - raise PulseAuthenticationError(self._login_backoff) + raise PulseAuthenticationError() else: url = self._connection_properties.make_url(ADT_MFA_FAIL_URI) if url == response_url_string: - raise PulseMFARequiredError(self._login_backoff) + raise PulseMFARequiredError() soup = make_soup( response[0], @@ -158,7 +158,7 @@ def determine_error_type(): response_url_string = str(response[2]) if url != response_url_string: determine_error_type() - raise PulseAuthenticationError(self._login_backoff) + raise PulseAuthenticationError() return soup @typechecked diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index 7f78264..ccdadfc 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -284,9 +284,7 @@ async def setup_query(): method, uri, ) - raise PulseNotLoggedInError( - self._connection_status.get_backoff(), - ) from ex + raise PulseNotLoggedInError() from ex async with self._connection_properties.session.request( method, url, diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 253a4a8..2595257 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -127,7 +127,7 @@ def __init__( self._site: ADTPulseSite | None = None self._detailed_debug_logging = detailed_debug_logging pc_backoff = self._pulse_connection.get_login_backoff() - self._sync_check_exception: Exception | None = PulseNotLoggedInError(pc_backoff) + self._sync_check_exception: Exception | None = PulseNotLoggedInError() pc_backoff.reset_backoff() def __repr__(self) -> str: @@ -581,9 +581,7 @@ async def async_logout(self) -> None: LOG.info( "Logging %s out of ADT Pulse", self._authentication_properties.username ) - self._set_sync_check_exception( - PulseNotLoggedInError(self._pulse_connection.get_login_backoff()) - ) + self._set_sync_check_exception(PulseNotLoggedInError()) if asyncio.current_task() not in (self._sync_task, self._timeout_task): await self._cancel_task(self._timeout_task) await self._cancel_task(self._sync_task) diff --git a/tests/test_exceptions.py b/tests/test_exceptions.py index 94e0ce4..3c4fc81 100644 --- a/tests/test_exceptions.py +++ b/tests/test_exceptions.py @@ -99,11 +99,10 @@ def test_pulse_service_temporarily_unavailable_error_past_retry_time_fixed(self) assert backoff.backoff_count == 2 assert backoff.expiration_time == 0.0 - # PulseAuthenticationError is a subclass of PulseExceptionWithBackoff and PulseLoginException + # PulseAuthenticationError is a subclass of PulseLoginException def test_pulse_authentication_error_inheritance(self): backoff = PulseBackoff("test", 1.0) - exception = PulseAuthenticationError(backoff) - assert isinstance(exception, PulseExceptionWithBackoff) + exception = PulseAuthenticationError() assert isinstance(exception, PulseLoginException) # PulseServiceTemporarilyUnavailableError is a subclass of PulseExceptionWithRetry and PulseConnectionError @@ -145,11 +144,10 @@ def test_pulse_exception_with_retry_string_representation_fixed(self): expected_string = "PulseExceptionWithRetry: error" assert str(exception) == expected_string - # PulseNotLoggedInError is a subclass of PulseExceptionWithBackoff and PulseLoginException + # PulseNotLoggedInError is a subclass of PulseLoginException def test_pulse_not_logged_in_error_inheritance(self): backoff = PulseBackoff("test", 1.0) - exception = PulseNotLoggedInError(backoff) - assert isinstance(exception, PulseExceptionWithBackoff) + exception = PulseNotLoggedInError() assert isinstance(exception, PulseLoginException) # PulseExceptionWithRetry string representation does not include the backoff count if retry time is set diff --git a/tests/test_pqm_codium.py b/tests/test_pqm_codium.py index b9f0062..435d01e 100644 --- a/tests/test_pqm_codium.py +++ b/tests/test_pqm_codium.py @@ -497,7 +497,7 @@ async def mock_async_query( debug_locks=query_manager._debug_locks, detailed_debug_logging=connection_properties.detailed_debug_logging, ) - raise PulseNotLoggedInError(backoff) + raise PulseNotLoggedInError() mocker.patch.object( PulseQueryManager, "async_query", side_effect=mock_async_query diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index 5f8394c..6934703 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -5,6 +5,7 @@ import aiohttp import pytest +from freezegun import freeze_time from conftest import LoginType, add_custom_response, add_signin from pyadtpulse.const import ( @@ -76,9 +77,8 @@ async def test_mocked_responses( # redirects add_custom_response( mocked_server_responses, - get_mocked_url, read_file, - ADT_LOGIN_URI, + get_mocked_url(ADT_LOGIN_URI), file_name="signin.html", ) response = await session.get(f"{DEFAULT_API_HOST}/", allow_redirects=True) @@ -88,14 +88,11 @@ async def test_mocked_responses( assert actual_content == expected_content add_custom_response( mocked_server_responses, - get_mocked_url, read_file, - ADT_LOGIN_URI, + get_mocked_url(ADT_LOGIN_URI), file_name="signin.html", ) - response = await session.get( - get_mocked_url(ADT_LOGOUT_URI), allow_redirects=True - ) + response = await session.get(get_mocked_url(ADT_LOGOUT_URI)) assert response.status == 200 expected_content = read_file("signin.html") actual_content = await response.text() @@ -103,9 +100,7 @@ async def test_mocked_responses( add_signin( LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file ) - response = await session.post( - get_mocked_url(ADT_LOGIN_URI), allow_redirects=True - ) + response = await session.post(get_mocked_url(ADT_LOGIN_URI)) assert response.status == 200 expected_content = read_file(static_responses[get_mocked_url(ADT_SUMMARY_URI)]) actual_content = await response.text() @@ -146,6 +141,10 @@ async def adt_pulse_instance( add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await p.async_login() # Assertions after login + assert p._pulse_connection_status.authenticated_flag.is_set() + assert p._pulse_connection_status.get_backoff().backoff_count == 0 + assert p._pulse_connection.login_in_progress is False + assert p._pulse_connection.login_backoff.backoff_count == 0 assert p.site.name == "Robert Lippmann" assert p._timeout_task is not None assert p._timeout_task.get_name() == p._get_timeout_task_name() @@ -156,18 +155,72 @@ async def adt_pulse_instance( @pytest.mark.asyncio -async def test_login(adt_pulse_instance, extract_ids_from_data_directory): +async def test_login( + adt_pulse_instance, extract_ids_from_data_directory, get_mocked_url, read_file +): """Fixture to test login.""" - p, _ = await adt_pulse_instance + p, response = await adt_pulse_instance # make sure everything is there on logout + + assert p._pulse_connection_status.get_backoff().backoff_count == 0 + assert p._pulse_connection.login_in_progress is False + assert p._pulse_connection.login_backoff.backoff_count == 0 + add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) await p.async_logout() await asyncio.sleep(1) + assert not p._pulse_connection_status.authenticated_flag.is_set() + assert p._pulse_connection_status.get_backoff().backoff_count == 0 + assert p._pulse_connection.login_in_progress is False + assert p._pulse_connection.login_backoff.backoff_count == 0 assert p.site.name == "Robert Lippmann" assert p.site.zones_as_dict is not None assert len(p.site.zones_as_dict) == len(extract_ids_from_data_directory) - 3 assert p._timeout_task is None +@pytest.mark.asyncio +@pytest.mark.timeout(60) +async def test_login_failures(adt_pulse_instance, get_mocked_url, read_file): + p, response = await adt_pulse_instance + assert p._pulse_connection.login_backoff.backoff_count == 0, "initial" + add_custom_response(response, read_file, get_mocked_url(ADT_LOGIN_URI)) + await p.async_logout() + assert p._pulse_connection.login_backoff.backoff_count == 0, "post logout" + for test_type in ( + (LoginType.FAIL, PulseAuthenticationError), + (LoginType.NOT_SIGNED_IN, PulseNotLoggedInError), + (LoginType.MFA, PulseMFARequiredError), + ): + assert p._pulse_connection.login_backoff.backoff_count == 0, str(test_type) + redirect = ADT_LOGIN_URI + if test_type[0] == LoginType.MFA: + redirect = ADT_MFA_FAIL_URI + response.post( + get_mocked_url(ADT_LOGIN_URI), + status=302, + headers={"Location": get_mocked_url(redirect)}, + ) + add_signin(test_type[0], response, get_mocked_url, read_file) + with pytest.raises(test_type[1]): + await p.async_login() + await asyncio.sleep(1) + assert p._timeout_task is None or p._timeout_task.done() + assert p._pulse_connection.login_backoff.backoff_count == 1, str(test_type) + if test_type[0] == LoginType.MFA: + # pop the post MFA redirect from the responses + with pytest.raises(PulseMFARequiredError): + await p.async_login() + add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) + await p.async_login() + await p.async_logout() + assert p._pulse_connection.login_backoff.backoff_count == 0 + + with freeze_time() as frozen_time: + add_signin(LoginType.LOCKED, response, get_mocked_url, read_file) + with pytest.raises(PulseAccountLockedError): + await p.async_login() + + async def do_wait_for_update(p: PyADTPulseAsync, shutdown_event: asyncio.Event): while not shutdown_event.is_set(): try: @@ -177,7 +230,7 @@ async def do_wait_for_update(p: PyADTPulseAsync, shutdown_event: asyncio.Event): @pytest.mark.asyncio -async def test_wait_for_update(adt_pulse_instance, get_mocked_url): +async def test_wait_for_update(adt_pulse_instance, get_mocked_url, read_file): p, responses = await adt_pulse_instance shutdown_event = asyncio.Event() task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) @@ -195,12 +248,9 @@ async def test_wait_for_update(adt_pulse_instance, get_mocked_url): with pytest.raises(PulseNotLoggedInError): await p.wait_for_update() - responses.post( - get_mocked_url(ADT_LOGIN_URI), - status=307, - headers={"Location": get_mocked_url(ADT_SUMMARY_URI)}, - ) + add_signin(LoginType.SUCCESS, responses, get_mocked_url, read_file) await p.async_login() + await p.async_logout() def make_sync_check_pattern(get_mocked_url): @@ -400,8 +450,8 @@ async def test_sync_check_errors(adt_pulse_instance, get_mocked_url, read_file, with pytest.raises(test_type[1]): await task await asyncio.sleep(0.5) - # assert p._sync_task is None or p._sync_task.done() - # assert p._timeout_task is None or p._timeout_task.done() + assert p._sync_task is None or p._sync_task.done() + assert p._timeout_task is None or p._timeout_task.done() if test_type[0] == LoginType.MFA: # pop the post MFA redirect from the responses with pytest.raises(PulseMFARequiredError): From 14fb881cc3c46a7d3fec30a00ba998f94f884d77 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 15 Jan 2024 04:42:18 -0500 Subject: [PATCH 188/226] more tests and fixes --- conftest.py | 22 ++++++++--- pyadtpulse/pulse_connection.py | 5 ++- tests/test_gateway.py | 8 ++-- tests/test_paa_codium.py | 70 +--------------------------------- tests/test_pap.py | 31 --------------- tests/test_pulse_async.py | 24 +++++------- tests/test_pulse_connection.py | 23 ++++------- tests/test_site_properties.py | 22 ++++++++--- 8 files changed, 58 insertions(+), 147 deletions(-) diff --git a/conftest.py b/conftest.py index 8626def..06f8daa 100644 --- a/conftest.py +++ b/conftest.py @@ -268,12 +268,13 @@ def add_custom_response( def add_signin( signin_type: LoginType, mocked_server_responses, get_mocked_url, read_file ): - add_custom_response( - mocked_server_responses, - read_file, - get_mocked_url(ADT_LOGIN_URI), - file_name=signin_type.value, - ) + if signin_type != LoginType.SUCCESS: + add_custom_response( + mocked_server_responses, + read_file, + get_mocked_url(ADT_LOGIN_URI), + file_name=signin_type.value, + ) redirect = get_mocked_url(ADT_LOGIN_URI) if signin_type == LoginType.MFA: redirect = get_mocked_url(ADT_MFA_FAIL_URI) @@ -289,6 +290,15 @@ def add_signin( ) +def add_logout(mocked_server_responses, get_mocked_url, read_file): + add_custom_response( + mocked_server_responses, + read_file, + get_mocked_url(ADT_LOGOUT_URI), + file_name=LoginType.SUCCESS.value, + ) + + @pytest.fixture def patched_sync_task_sleep() -> Generator[AsyncMock, Any, Any]: """Fixture to patch asyncio.sleep in async_query().""" diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 2c49624..5a6b375 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -133,9 +133,10 @@ def determine_error_type(): ) elif "You have not yet signed in" in error_text: raise PulseNotLoggedInError() - else: - # FIXME: not sure if this is true + elif "Sign In Unsuccessful" in error_text: raise PulseAuthenticationError() + else: + raise PulseNotLoggedInError() else: url = self._connection_properties.make_url(ADT_MFA_FAIL_URI) if url == response_url_string: diff --git a/tests/test_gateway.py b/tests/test_gateway.py index 842c2ea..d608128 100644 --- a/tests/test_gateway.py +++ b/tests/test_gateway.py @@ -134,13 +134,13 @@ def test_default_values2(): gateway = ADTPulseGateway() assert gateway.manufacturer == "Unknown" assert gateway._status_text == "OFFLINE" - assert gateway.backoff._name == "Gateway" - assert gateway.backoff._initial_backoff_interval == ADT_DEFAULT_POLL_INTERVAL + assert gateway.backoff.name == "Gateway" + assert gateway.backoff.initial_backoff_interval == ADT_DEFAULT_POLL_INTERVAL assert ( gateway.backoff._max_backoff_interval == ADT_GATEWAY_MAX_OFFLINE_POLL_INTERVAL ) - assert gateway.backoff._backoff_count == 0 - assert gateway.backoff._expiration_time == 0.0 + assert gateway.backoff.backoff_count == 0 + assert gateway.backoff.expiration_time == 0.0 assert gateway.backoff._detailed_debug_logging == False assert gateway.backoff._threshold == 0 assert gateway.model == None diff --git a/tests/test_paa_codium.py b/tests/test_paa_codium.py index 24bbd81..ef42980 100644 --- a/tests/test_paa_codium.py +++ b/tests/test_paa_codium.py @@ -1,10 +1,7 @@ # Generated by CodiumAI -import asyncio -from unittest.mock import PropertyMock import pytest from bs4 import BeautifulSoup -from requests import patch from conftest import LoginType, add_signin from pyadtpulse.exceptions import PulseAuthenticationError, PulseNotLoggedInError @@ -103,23 +100,6 @@ async def test_async_logout_successfully_logs_out( # Assert assert not pulse.is_connected - # The async_update method checks the ADT Pulse cloud service for updates and returns True if updates are available. - @pytest.mark.asyncio - async def test_async_update_returns_true_if_updates_available_with_valid_email( - self, - ): - # Arrange - from unittest.mock import MagicMock - - pulse = PyADTPulseAsync("test@example.com", "password", "fingerprint") - pulse._update_sites = MagicMock(return_value=None) - - # Act - result = await pulse.async_update() - - # Assert - assert result is True - # The site property returns an ADTPulseSite object after logging in. @pytest.mark.asyncio async def test_site_property_returns_ADTPulseSite_object_with_login( @@ -170,44 +150,6 @@ async def test_site_property_without_login_raises_exception(self): with pytest.raises(RuntimeError): pulse.site - # The wait_for_update method waits for updates from the ADT Pulse cloud service and raises an exception if there is an error. - @pytest.mark.asyncio - async def test_wait_for_update_method_with_valid_username(self): - # Arrange - from unittest.mock import MagicMock - - pulse = PyADTPulseAsync( - username="your_username@example.com", - password="your_password", - fingerprint="your_fingerprint", - ) - - # Mock the necessary methods and attributes - pulse._pa_attribute_lock = asyncio.Lock() - pulse._site = MagicMock() - pulse._site.gateway.backoff.wait_for_backoff.return_value = asyncio.sleep(0) - pulse._pulse_connection_status.get_backoff().will_backoff.return_value = False - pulse._pulse_properties.updates_exist.wait.return_value = asyncio.sleep(0) - - # Mock the is_connected property of _pulse_connection - with patch.object( - pulse._pulse_connection, "is_connected", new_callable=PropertyMock - ) as mock_is_connected: - mock_is_connected.return_value = True - - # Act - with patch.object(pulse, "_update_sites") as mock_update_sites: - with patch.object( - pulse, "_pulse_connection", autospec=True - ) as mock_pulse_connection: - with patch.object(pulse, "_sync_check_exception", None): - await pulse.wait_for_update() - - # Assert - mock_update_sites.assert_called_once() - pulse._pulse_properties.updates_exist.wait.assert_called_once() - assert pulse._sync_check_exception is None - # The sites property returns a list of ADTPulseSite objects. @pytest.mark.asyncio async def test_sites_property_returns_list_of_objects( @@ -239,16 +181,6 @@ async def test_is_connected_property_returns_false_when_not_connected(self): ) assert pulse.is_connected == False - # The async_update method fails to check the ADT Pulse cloud service for updates and returns False. - @pytest.mark.asyncio - async def test_async_update_fails(self, mock_query_orb): - pulse = PyADTPulseAsync("username@example.com", "password", "fingerprint") - mock_query_orb.return_value = None - - result = await pulse.async_update() - - assert result == False - # The sites property is accessed without being logged in and raises an exception. @pytest.mark.asyncio async def test_sites_property_without_login_raises_exception(self): @@ -315,7 +247,7 @@ async def test_initialize_sites_method_with_valid_service_host( soup = BeautifulSoup(read_file("summary.html")) # Mock the fetch_devices method to always return True - mocker.patch.object(ADTPulseSite, "fetch_devices", return_value=True) + # mocker.patch.object(ADTPulseSite, "fetch_devices", return_value=True) # Act await pulse._initialize_sites(soup) diff --git a/tests/test_pap.py b/tests/test_pap.py index 9174269..010fec2 100644 --- a/tests/test_pap.py +++ b/tests/test_pap.py @@ -1,5 +1,4 @@ # Generated by CodiumAI -from unittest.mock import patch import pytest from typeguard import TypeCheckError @@ -313,33 +312,3 @@ def test_raise_type_check_error_when_setting_last_login_time_with_non_integer_va # Act and Assert with pytest.raises(typeguard.TypeCheckError): properties.last_login_time = "invalid_time" - - # Lock and unlock paa_attribute_lock when getting and setting properties - def test_lock_and_unlock_paa_attribute_lock(self): - """ - Test that paa_attribute_lock is locked and unlocked when getting and setting properties - """ - # Arrange - username = "test@example.com" - password = "password123" - fingerprint = "fingerprint123" - properties = PulseAuthenticationProperties(username, password, fingerprint) - - # Act - with patch.object(properties._paa_attribute_lock, "acquire") as mock_acquire: - with patch.object( - properties._paa_attribute_lock, "release" - ) as mock_release: - _ = properties.username - _ = properties.password - _ = properties.fingerprint - _ = properties.site_id - properties.username = "new_username@example.com" - properties.password = "new_password" - properties.fingerprint = "new_fingerprint" - properties.site_id = "new_site_id" - - # Assert - - self.assertEqual(mock_acquire.call_count, 4) - self.assertEqual(mock_release.call_count, 4) diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index 6934703..7f68116 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -7,7 +7,7 @@ import pytest from freezegun import freeze_time -from conftest import LoginType, add_custom_response, add_signin +from conftest import LoginType, add_custom_response, add_logout, add_signin from pyadtpulse.const import ( ADT_DEVICE_URI, ADT_LOGIN_URI, @@ -165,7 +165,13 @@ async def test_login( assert p._pulse_connection_status.get_backoff().backoff_count == 0 assert p._pulse_connection.login_in_progress is False assert p._pulse_connection.login_backoff.backoff_count == 0 - add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) + add_logout(response, read_file, get_mocked_url(ADT_LOGOUT_URI)) + add_custom_response( + response, + read_file, + get_mocked_url(ADT_LOGIN_URI), + file_name=LoginType.SUCCESS.value, + ) await p.async_logout() await asyncio.sleep(1) assert not p._pulse_connection_status.authenticated_flag.is_set() @@ -183,7 +189,7 @@ async def test_login( async def test_login_failures(adt_pulse_instance, get_mocked_url, read_file): p, response = await adt_pulse_instance assert p._pulse_connection.login_backoff.backoff_count == 0, "initial" - add_custom_response(response, read_file, get_mocked_url(ADT_LOGIN_URI)) + add_logout(response, get_mocked_url, read_file) await p.async_logout() assert p._pulse_connection.login_backoff.backoff_count == 0, "post logout" for test_type in ( @@ -192,27 +198,18 @@ async def test_login_failures(adt_pulse_instance, get_mocked_url, read_file): (LoginType.MFA, PulseMFARequiredError), ): assert p._pulse_connection.login_backoff.backoff_count == 0, str(test_type) - redirect = ADT_LOGIN_URI - if test_type[0] == LoginType.MFA: - redirect = ADT_MFA_FAIL_URI - response.post( - get_mocked_url(ADT_LOGIN_URI), - status=302, - headers={"Location": get_mocked_url(redirect)}, - ) add_signin(test_type[0], response, get_mocked_url, read_file) with pytest.raises(test_type[1]): await p.async_login() await asyncio.sleep(1) assert p._timeout_task is None or p._timeout_task.done() - assert p._pulse_connection.login_backoff.backoff_count == 1, str(test_type) + assert p._pulse_connection.login_backoff.backoff_count == 0, str(test_type) if test_type[0] == LoginType.MFA: # pop the post MFA redirect from the responses with pytest.raises(PulseMFARequiredError): await p.async_login() add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) await p.async_login() - await p.async_logout() assert p._pulse_connection.login_backoff.backoff_count == 0 with freeze_time() as frozen_time: @@ -437,7 +434,6 @@ async def test_sync_check_errors(adt_pulse_instance, get_mocked_url, read_file, (LoginType.FAIL, PulseAuthenticationError), (LoginType.NOT_SIGNED_IN, PulseNotLoggedInError), (LoginType.MFA, PulseMFARequiredError), - (LoginType.LOCKED, PulseAccountLockedError), ): redirect = ADT_LOGIN_URI if test_type[0] == LoginType.MFA: diff --git a/tests/test_pulse_connection.py b/tests/test_pulse_connection.py index 71070fc..63e65b5 100644 --- a/tests/test_pulse_connection.py +++ b/tests/test_pulse_connection.py @@ -44,7 +44,7 @@ async def test_login(mocked_server_responses, read_file, mock_sleep, get_mocked_ assert pc._connection_status.authenticated_flag.is_set() # so logout won't fail add_custom_response( - mocked_server_responses, get_mocked_url, read_file, ADT_LOGIN_URI + mocked_server_responses, read_file, get_mocked_url(ADT_LOGIN_URI) ) await pc.async_do_logout_query() assert not pc._connection_status.authenticated_flag.is_set() @@ -165,44 +165,37 @@ async def test_invalid_credentials( add_signin(LoginType.FAIL, mocked_server_responses, get_mocked_url, read_file) with pytest.raises(PulseAuthenticationError): await pc.async_do_login_query() - assert pc._login_backoff.backoff_count == 1 + assert pc._login_backoff.backoff_count == 0 assert mock_sleep.call_count == 0 add_signin(LoginType.FAIL, mocked_server_responses, get_mocked_url, read_file) with pytest.raises(PulseAuthenticationError): await pc.async_do_login_query() - assert pc._login_backoff.backoff_count == 2 - assert mock_sleep.call_count == 1 + assert pc._login_backoff.backoff_count == 0 + assert mock_sleep.call_count == 0 add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) - await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 0 - assert mock_sleep.call_count == 2 + assert mock_sleep.call_count == 0 @pytest.mark.asyncio -async def test_mfa_failure( - mocked_server_responses, mock_sleep, get_mocked_url, read_file -): +async def test_mfa_failure(mocked_server_responses, get_mocked_url, read_file): pc = setup_pulse_connection() add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await pc.async_do_login_query() - assert mock_sleep.call_count == 0 assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 add_signin(LoginType.MFA, mocked_server_responses, get_mocked_url, read_file) with pytest.raises(PulseMFARequiredError): await pc.async_do_login_query() - assert pc._login_backoff.backoff_count == 1 - assert mock_sleep.call_count == 0 + assert pc._login_backoff.backoff_count == 0 add_signin(LoginType.MFA, mocked_server_responses, get_mocked_url, read_file) with pytest.raises(PulseMFARequiredError): await pc.async_do_login_query() - assert pc._login_backoff.backoff_count == 2 - assert mock_sleep.call_count == 1 + assert pc._login_backoff.backoff_count == 0 add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 0 - assert mock_sleep.call_count == 2 @pytest.mark.asyncio diff --git a/tests/test_site_properties.py b/tests/test_site_properties.py index d070bc0..034baa4 100644 --- a/tests/test_site_properties.py +++ b/tests/test_site_properties.py @@ -7,7 +7,12 @@ import pytest from pyadtpulse.alarm_panel import ADTPulseAlarmPanel +from pyadtpulse.const import DEFAULT_API_HOST from pyadtpulse.gateway import ADTPulseGateway +from pyadtpulse.pulse_authentication_properties import PulseAuthenticationProperties +from pyadtpulse.pulse_connection import PulseConnection +from pyadtpulse.pulse_connection_properties import PulseConnectionProperties +from pyadtpulse.pulse_connection_status import PulseConnectionStatus from pyadtpulse.site_properties import ADTPulseSiteProperties from pyadtpulse.zones import ADTPulseFlattendZone, ADTPulseZoneData, ADTPulseZones @@ -180,18 +185,23 @@ async def test_update_site_zone_data_async(self, mocker): assert result == False # Cannot set alarm status from one state to another - def test_cannot_set_alarm_status(self, mocker): - import asyncio - + @pytest.mark.asyncio + async def test_cannot_set_alarm_status(self, mocker): # Arrange site_id = "12345" site_name = "My ADT Pulse Site" site_properties = ADTPulseSiteProperties(site_id, site_name) - mocker.patch.object(site_properties._alarm_panel, "_status", "Armed Away") + cp = PulseConnectionProperties(DEFAULT_API_HOST) + cs = PulseConnectionStatus() + pa = PulseAuthenticationProperties( + "test@example.com", "testpassword", "testfingerprint" + ) + + connection = PulseConnection(cs, cp, pa) # Act - result = asyncio.run( - site_properties._alarm_panel._arm(None, "Armed Home", False) + result = await site_properties._alarm_panel._arm( + connection, "Armed Home", False ) # Assert From 6539b89b9d205ee0c66e9ffdb80b23a208b97704 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 15 Jan 2024 05:32:51 -0500 Subject: [PATCH 189/226] even more tests and fixes --- example-client.py | 6 ++++-- pyadtpulse/__init__.py | 34 ++++++++++++++++------------------ pyadtpulse/pyadtpulse_async.py | 24 ++++++++++++++---------- tests/test_paa_codium.py | 2 +- tests/test_pulse_async.py | 24 +++++++++++++++++++++++- 5 files changed, 58 insertions(+), 32 deletions(-) diff --git a/example-client.py b/example-client.py index cbbeac7..839a255 100755 --- a/example-client.py +++ b/example-client.py @@ -622,8 +622,10 @@ async def async_example( detailed_debug_logging=detailed_debug_logging, ) - if not await adt.async_login(): - print("ADT Pulse login failed") + try: + await adt.async_login() + except Exception as e: + print("ADT Pulse login failed with error: %s", e) return if not adt.is_connected: diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index c8f3bbc..13e7480 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -107,28 +107,26 @@ async def _sync_loop(self) -> None: the `asyncio.sleep` function. This wait allows the logout process to complete before continuing with the synchronization logic. """ - result = False try: - result = await self.async_login() + await self.async_login() except Exception as e: self._login_exception = e self._p_attribute_lock.release() if self._login_exception is not None: return - if result: - if self._timeout_task is not None: - task_list = (self._timeout_task,) - try: - await asyncio.wait(task_list) - except asyncio.CancelledError: - pass - except Exception as e: # pylint: disable=broad-except - LOG.exception( - "Received exception while waiting for ADT Pulse service %s", e - ) - else: - # we should never get here - raise RuntimeError("Background pyadtpulse tasks not created") + if self._timeout_task is not None: + task_list = (self._timeout_task,) + try: + await asyncio.wait(task_list) + except asyncio.CancelledError: + pass + except Exception as e: # pylint: disable=broad-except + LOG.exception( + "Received exception while waiting for ADT Pulse service %s", e + ) + else: + # we should never get here + raise RuntimeError("Background pyadtpulse tasks not created") while self._pulse_connection_status.authenticated_flag.is_set(): # busy wait until logout is done await asyncio.sleep(0.5) @@ -229,11 +227,11 @@ def update(self) -> bool: ), ).result() - async def async_login(self) -> bool: + async def async_login(self) -> None: self._pulse_connection_properties.check_async( "Cannot login asynchronously with a synchronous session" ) - return await super().async_login() + await super().async_login() async def async_logout(self) -> None: self._pulse_connection_properties.check_async( diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 2595257..f820ff9 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -224,8 +224,10 @@ def _set_sync_check_exception(self, e: Exception | None) -> None: < WARN_UPDATE_TASK_THRESHOLD ): return + old_exception = self.sync_check_exception self.sync_check_exception = e - self._pulse_properties.updates_exist.set() + if old_exception != e: + self._pulse_properties.updates_exist.set() async def _keepalive_task(self) -> None: """ @@ -353,7 +355,7 @@ async def _login_looped(self, task_name: str) -> None: log_level = logging.WARNING LOG.log(log_level, "%s performming loop login", task_name) try: - login_successful = await self.async_login() + await self.async_login() except ( PulseClientConnectionError, PulseServerConnectionError, @@ -531,10 +533,10 @@ async def shutdown_task(ex: Exception): LOG.debug("%s cancelled", task_name) return - async def async_login(self) -> bool: + async def async_login(self) -> None: """Login asynchronously to ADT. - Returns: True if login successful + Returns: None Raises: PulseClientConnectionError: if client connection fails @@ -543,10 +545,11 @@ async def async_login(self) -> bool: PulseAuthenticationError: if authentication fails PulseAccountLockedError: if account is locked PulseMFARequiredError: if MFA is required + PulseNotLoggedInError: if login fails """ if self._pulse_connection.login_in_progress: LOG.debug("Login already in progress, returning") - return True + return LOG.debug( "Authenticating to ADT Pulse cloud service as %s", self._authentication_properties.username, @@ -554,24 +557,25 @@ async def async_login(self) -> bool: await self._pulse_connection.async_fetch_version() soup = await self._pulse_connection.async_do_login_query() if soup is None: - return False + await self._pulse_connection.quick_logout() + raise PulseNotLoggedInError() self._set_sync_check_exception(None) # if tasks are started, we've already logged in before # clean up completed tasks first await self._clean_done_tasks() if self._timeout_task is not None: - return True - await self._update_sites(soup) + return + if not self._site: + await self._update_sites(soup) if self._site is None: LOG.error("Could not retrieve any sites, login failed") await self._pulse_connection.quick_logout() - return False + raise PulseNotLoggedInError() self.sync_check_exception = None self._timeout_task = asyncio.create_task( self._keepalive_task(), name=KEEPALIVE_TASK_NAME ) await asyncio.sleep(0) - return True async def async_logout(self) -> None: """Logout of ADT Pulse async.""" diff --git a/tests/test_paa_codium.py b/tests/test_paa_codium.py index ef42980..ce16dd6 100644 --- a/tests/test_paa_codium.py +++ b/tests/test_paa_codium.py @@ -49,7 +49,7 @@ async def test_async_login_success_with_valid_email( add_signin( LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file ) - assert await pulse.async_login() is True + await pulse.async_login() # The class is instantiated without the required parameters (username, password, fingerprint) and raises an exception. @pytest.mark.asyncio diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index 7f68116..0f5099b 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -165,7 +165,7 @@ async def test_login( assert p._pulse_connection_status.get_backoff().backoff_count == 0 assert p._pulse_connection.login_in_progress is False assert p._pulse_connection.login_backoff.backoff_count == 0 - add_logout(response, read_file, get_mocked_url(ADT_LOGOUT_URI)) + add_logout(response, get_mocked_url, read_file) add_custom_response( response, read_file, @@ -455,3 +455,25 @@ async def test_sync_check_errors(adt_pulse_instance, get_mocked_url, read_file, add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) if test_type[0] != LoginType.LOCKED: await p.async_login() + + +@pytest.mark.asyncio +async def test_multiple_login( + adt_pulse_instance, extract_ids_from_data_directory, get_mocked_url, read_file +): + p, response = await adt_pulse_instance + add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) + await p.async_login() + assert p.site.zones_as_dict is not None + assert len(p.site.zones_as_dict) == len(extract_ids_from_data_directory) - 3 + add_logout(response, get_mocked_url, read_file) + await p.async_logout() + assert p.site.zones_as_dict is not None + assert len(p.site.zones_as_dict) == len(extract_ids_from_data_directory) - 3 + add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) + await p.async_login() + assert p.site.zones_as_dict is not None + assert len(p.site.zones_as_dict) == len(extract_ids_from_data_directory) - 3 + add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) + assert p.site.zones_as_dict is not None + assert len(p.site.zones_as_dict) == len(extract_ids_from_data_directory) - 3 From cf15544167cdb764d0fe07a7eb725274289b45e7 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 20 Jan 2024 03:13:02 -0500 Subject: [PATCH 190/226] fix loop_login, change exception handling in wait_for_update --- pyadtpulse/pyadtpulse_async.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index f820ff9..f300dd2 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -347,9 +347,8 @@ async def _login_looped(self, task_name: str) -> None: """ count = 0 log_level = logging.DEBUG - login_successful = False - while not login_successful: + while True: count += 1 if count > 5: log_level = logging.WARNING @@ -372,10 +371,9 @@ async def _login_looped(self, task_name: str) -> None: or self._sync_check_exception != ex ): self._set_sync_check_exception(ex) - login_successful = False continue - if login_successful: - return + # success, return + return async def _sync_check_task(self) -> None: """Asynchronous function that performs a synchronization check task.""" @@ -635,8 +633,10 @@ async def wait_for_update(self) -> None: await self._pulse_properties.updates_exist.wait() self._pulse_properties.updates_exist.clear() - if self.sync_check_exception: - raise self.sync_check_exception + curr_exception = self.sync_check_exception + self.sync_check_exception = None + if curr_exception: + raise curr_exception @property def sites(self) -> list[ADTPulseSite]: From f730b596ade64e0af0f4c6f59288660d59057e38 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 20 Jan 2024 03:52:57 -0500 Subject: [PATCH 191/226] add gateway offline data files --- tests/data_files/orb_gateway_offline.html | 293 ++++++++++ tests/data_files/summary_gateway_offline.html | 533 ++++++++++++++++++ 2 files changed, 826 insertions(+) create mode 100644 tests/data_files/orb_gateway_offline.html create mode 100644 tests/data_files/summary_gateway_offline.html diff --git a/tests/data_files/orb_gateway_offline.html b/tests/data_files/orb_gateway_offline.html new file mode 100644 index 0000000..2083506 --- /dev/null +++ b/tests/data_files/orb_gateway_offline.html @@ -0,0 +1,293 @@ +

+ Security + +

+
+
+
 
+
+
+
+ + + +
+
+
+
+
+
+
+ + Status Unavailable. +   + +
+ + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + +
+ + + + + + 2nd Floor Smoke +  
Zone  18 + +
Unknown  
+
+ + + + + + + +
+ + + + + + Back Door +  
Zone  14 + +
Unknown  
+
+ + + + + + + +
+ + + + + + Basement Door +  
Zone  13 + +
Unknown  
+ + + + + + + +
+ + + + + + Basement Smoke +  
Zone  17 + +
Unknown  
+ + + + + + + +
+ + + + + + Family Glass Break +  
Zone  16 + +
Unknown  
+ + + + + + + +
+ + + + + + Foyer Motion +  
Zone  15 + +
Unknown  
+ + + + + + + +
+ + + + + + Front Door +  
Zone  9 + +
Unknown  
+ + + + + + + +
+ + + + + + Garage Door +  
Zone  10 + +
Unknown  
+ + + + + + + +
+ + + + + + Living Room Door +  
Zone  12 + +
Unknown  
+ + + + + + + +
+ + + + + + Main Gas +  
Zone  23 + +
Unknown  
+ + + + + + + +
+ + + + + + Patio Door +  
Zone  11 + +
Unknown  
+ + + + + + + +
+ + + + + + Radio Station Gas +  
Zone  24 + +
Unknown  
+ + + + + + + +
+ + + + + + Radio Station Smoke +  
Zone  22 + +
Unknown  
+ diff --git a/tests/data_files/summary_gateway_offline.html b/tests/data_files/summary_gateway_offline.html new file mode 100644 index 0000000..266fc06 --- /dev/null +++ b/tests/data_files/summary_gateway_offline.html @@ -0,0 +1,533 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ADT Pulse(TM) Interactive Solutions - Summary - Robert Lippmann + + + + + + + + +  + + +
+ +
+
+
+ + + + + +
+ +
+ +
+ + +
+
+
+
+ + + +
+
+ +
+ +
+ + +
+
+ +
+

ADT Pulse Home

+ + + + + + + +
+ +
+
+
+ + + + + + + + + +

+ + Security + +

+
+
+
+   +
+
+
+ +
+
+
+ +
+
+
+
+ Status Unavailable.  + +
+ + + +
+
+ + + + + + + + + + + + + + + +
2nd Floor Smoke 
Zone 18
Unknown 
Back Door 
Zone 14
Unknown 
Basement Door 
Zone 13
Unknown 
Basement Smoke 
Zone 17
Unknown 
Family Glass Break 
Zone 16
Unknown 
Foyer Motion 
Zone 15
Unknown 
Front Door 
Zone 9
Unknown 
Garage Door 
Zone 10
Unknown 
Living Room Door 
Zone 12
Unknown 
Main Gas 
Zone 23
Unknown 
Patio Door 
Zone 11
Unknown 
Radio Station Gas 
Zone 24
Unknown 
Radio Station Smoke 
Zone 22
Unknown 
+
+
+ +
+ + + + + +
+
+
+ + +
+
+

Other Devices

+
+ + + + + + + + + + + + + + + +
+
+ + + + + +
SwitchUnknown 
+
+
+ + + +
+
+
+ + +
+
+

Notable Events

+
+
+

 Loading...  +
+
+
+
+ + + 		+ +
+
+
+ + + + + + + +
+ +

+ Cameras + +

+
+
+ + + + + + +
+ +
+
+
+
Camera Unknown
+
+
+
+
+
No pictures or clips.
+ +
+ + + +
+ +
+
+
+
+ + +
+
+

Today's Schedule

+
+ + + + + + + + + + +
+ + +
+ +
+ +
+ + +
+
+
+ + +
+
+ +
+ + +
+ +
+
+ + +
+ + + + + + +
+
+ ADT Security Services + | Privacy Policy + | Terms of Use + | Customer Support + | + About +
+ + + + + + + + + + +
Your use of this site signifies that you accept the ADT Pulse Website Terms of Use Agreement.
+ + +
© 2024 ADT Security Services. All rights reserved. ADT, the ADT logo, 800.ADT.ASAP and the product/service names listed in this document are marks and/or registered marks. Unauthorized use is strictly prohibited. Unauthorized use of this site is prohibited and may be subject to civil and criminal prosecution.
+ +
+
+ +
+
+ + + + + + + From 9d355594469e18410012991a8a42c832dfef7f9c Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 20 Jan 2024 05:40:59 -0500 Subject: [PATCH 192/226] add gateway offline handling --- pyadtpulse/alarm_panel.py | 21 +++++++++++++++++++++ pyadtpulse/gateway.py | 2 +- pyadtpulse/pyadtpulse_async.py | 17 +++++++++++------ pyadtpulse/site.py | 27 +++++++++++++++------------ 4 files changed, 48 insertions(+), 19 deletions(-) diff --git a/pyadtpulse/alarm_panel.py b/pyadtpulse/alarm_panel.py index 994f6f3..b0bdcd5 100644 --- a/pyadtpulse/alarm_panel.py +++ b/pyadtpulse/alarm_panel.py @@ -22,6 +22,15 @@ ADT_ALARM_ARMING = "arming" ADT_ALARM_DISARMING = "disarming" +ALARM_STATUSES = ( + ADT_ALARM_AWAY, + ADT_ALARM_HOME, + ADT_ALARM_OFF, + ADT_ALARM_UNKNOWN, + ADT_ALARM_ARMING, + ADT_ALARM_DISARMING, +) + ADT_ARM_DISARM_TIMEOUT: float = 20 @@ -48,6 +57,18 @@ def status(self) -> str: with self._state_lock: return self._status + @status.setter + def status(self, new_status: str) -> None: + """Set alarm status. + + Args: + new_status (str): the new alarm status + """ + with self._state_lock: + if new_status not in ALARM_STATUSES: + raise ValueError(f"Alarm status must be one of {ALARM_STATUSES}") + self._status = new_status + @property def is_away(self) -> bool: """Return wheter the system is armed away. diff --git a/pyadtpulse/gateway.py b/pyadtpulse/gateway.py index 226f266..2ef3045 100644 --- a/pyadtpulse/gateway.py +++ b/pyadtpulse/gateway.py @@ -100,7 +100,7 @@ def is_online(self, status: bool) -> None: @property def poll_interval(self) -> float: - """Get current poll interval.""" + """Get initial poll interval.""" with self._attribute_lock: return self.backoff.initial_backoff_interval diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index f300dd2..aa6be6b 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -224,10 +224,8 @@ def _set_sync_check_exception(self, e: Exception | None) -> None: < WARN_UPDATE_TASK_THRESHOLD ): return - old_exception = self.sync_check_exception self.sync_check_exception = e - if old_exception != e: - self._pulse_properties.updates_exist.set() + self._pulse_properties.updates_exist.set() async def _keepalive_task(self) -> None: """ @@ -437,14 +435,22 @@ async def handle_no_updates_exist() -> bool: if not success: LOG.debug("Pulse data update failed in task %s", task_name) return False - + # no updates with an offline gateway, bump backoff and signal gateway offline self._set_sync_check_exception(None) return True else: + additional_msg = "" + if not self.site.gateway.is_online: + # bump backoff and resignal since offline and nothing updated + self._set_sync_check_exception( + PulseGatewayOfflineError(self.site.gateway.backoff) + ) + additional_msg = ", gateway offline so backoff incremented" if self._detailed_debug_logging: LOG.debug( - "Sync token %s indicates no remote updates to process", + "Sync token %s indicates no remote updates to process %s ", response_text, + additional_msg, ) return False @@ -496,7 +502,6 @@ async def shutdown_task(ex: Exception): LOG.warning("Pulse service %s, ending %s task", status, task_name) await shutdown_task(e) return - self._set_sync_check_exception(None) if not handle_response( code, url, logging.WARNING, "Error querying ADT sync" ): diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 30e448b..0138979 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -311,10 +311,23 @@ def update_zone_from_soup(self, soup: BeautifulSoup) -> None: Raises: PulseGatewayOffline: If the gateway is offline. """ + # parse ADT's convulated html to get sensor status with self._site_lock: - gateway_online = False - for row in soup.find_all("tr", {"class": "p_listRow"}): + orb_status = soup.find("canvas", {"id": "ic_orb"}) + if orb_status: + alarm_status = orb_status.get("orb")[0] + if not alarm_status: + LOG.error("Failed to retrieve alarm status from orb!") + elif alarm_status == "offline": + self.gateway.is_online = False + raise PulseGatewayOfflineError(self.gateway.backoff) + else: + self.gateway.is_online = True + self.gateway.backoff.reset_backoff() + + sensors = soup.find("div", {"id": "orbSensorsList"}) + for row in sensors.find_all("tr", {"class": "p_listRow"}): temp = row.find("div", {"class": "p_grayNormalText"}) # v26 and lower: temp = row.find("span", {"class": "p_grayNormalText"}) if temp is None: @@ -381,8 +394,6 @@ def update_zone_from_soup(self, soup: BeautifulSoup) -> None: if not self._zones: LOG.warning("No zones exist") return None - if state != "Unknown": - gateway_online = True self._zones.update_device_info(zone, state, status, last_update) LOG.debug( "Set zone %d - to %s, status %s with timestamp %s", @@ -391,15 +402,7 @@ def update_zone_from_soup(self, soup: BeautifulSoup) -> None: status, last_update, ) - self._gateway.is_online = gateway_online self._last_updated = int(time()) - if not gateway_online: - LOG.warning("Gateway is offline") - raise PulseGatewayOfflineError( - "Gateway is offline", self._gateway.backoff - ) - else: - self._gateway.backoff.reset_backoff() async def _async_update_zones(self) -> list[ADTPulseFlattendZone] | None: """Update zones asynchronously. From 0f6ec102025bdbf3db7e8eb268456bf1ea6e05db Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 20 Jan 2024 05:49:28 -0500 Subject: [PATCH 193/226] bump version to 1.2.0b1 --- pyadtpulse/const.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 26c7471..492ebb5 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -1,5 +1,5 @@ """Constants for pyadtpulse.""" -__version__ = "1.1.4b4" +__version__ = "1.2.0b1" DEFAULT_API_HOST = "https://portal.adtpulse.com" diff --git a/pyproject.toml b/pyproject.toml index 06fd586..223d045 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "pyadtpulse" -version = "1.1.4b4" +version = "1.2.0b1" description = "Python interface for ADT Pulse security systems" authors = ["Ryan Snodgrass"] maintainers = ["Robert Lippmann"] From ef29bc3eb32762a7ade4ac7a9cd98f607aeba4a3 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 20 Jan 2024 06:40:00 -0500 Subject: [PATCH 194/226] revert bs optimization in update_zone_from_soup --- pyadtpulse/site.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 0138979..bb90774 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -326,8 +326,7 @@ def update_zone_from_soup(self, soup: BeautifulSoup) -> None: self.gateway.is_online = True self.gateway.backoff.reset_backoff() - sensors = soup.find("div", {"id": "orbSensorsList"}) - for row in sensors.find_all("tr", {"class": "p_listRow"}): + for row in soup.find_all("tr", {"class": "p_listRow"}): temp = row.find("div", {"class": "p_grayNormalText"}) # v26 and lower: temp = row.find("span", {"class": "p_grayNormalText"}) if temp is None: From 2bf4da105ee6d97f5701ff62d424d0a682c502f6 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 20 Jan 2024 19:37:25 -0500 Subject: [PATCH 195/226] always update alarm sat --- pyadtpulse/alarm_panel.py | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/pyadtpulse/alarm_panel.py b/pyadtpulse/alarm_panel.py index b0bdcd5..67d88c4 100644 --- a/pyadtpulse/alarm_panel.py +++ b/pyadtpulse/alarm_panel.py @@ -346,22 +346,21 @@ def update_alarm_from_soup(self, summary_html_soup: BeautifulSoup) -> None: return LOG.debug("Alarm status = %s", self._status) - if self._sat == "": - sat_button = summary_html_soup.find( - "input", {"type": "button", "id": sat_location} - ) - if sat_button and sat_button.has_attr("onclick"): - on_click = sat_button["onclick"] - match = re.search(r"sat=([a-z0-9\-]+)", on_click) - if match: - self._sat = match.group(1) - elif len(self._sat) == 0: - LOG.warning("No sat recorded and was unable extract sat.") - - if len(self._sat) > 0: - LOG.debug("Extracted sat = %s", self._sat) - else: - LOG.warning("Unable to extract sat") + sat_button = summary_html_soup.find( + "input", {"type": "button", "id": sat_location} + ) + if sat_button and sat_button.has_attr("onclick"): + on_click = sat_button["onclick"] + match = re.search(r"sat=([a-z0-9\-]+)", on_click) + if match: + self._sat = match.group(1) + elif len(self._sat) == 0: + LOG.warning("No sat recorded and was unable extract sat.") + + if len(self._sat) > 0: + LOG.debug("Extracted sat = %s", self._sat) + else: + LOG.warning("Unable to extract sat") @typechecked def set_alarm_attributes(self, alarm_attributes: dict[str, str]) -> None: From c31fb2764484bfcfc53ac9b1e1ea75111d7575ae Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 20 Jan 2024 23:17:48 -0500 Subject: [PATCH 196/226] remove unused _login_exception in pulse properties --- pyadtpulse/pyadtpulse_properties.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/pyadtpulse/pyadtpulse_properties.py b/pyadtpulse/pyadtpulse_properties.py index a69e7be..5ef2864 100644 --- a/pyadtpulse/pyadtpulse_properties.py +++ b/pyadtpulse/pyadtpulse_properties.py @@ -23,7 +23,6 @@ class PyADTPulseProperties: __slots__ = ( "_updates_exist", "_pp_attribute_lock", - "_login_exception", "_relogin_interval", "_keepalive_interval", "_site", @@ -62,7 +61,6 @@ def __init__( """ # FIXME use thread event/condition, regular condition? # defer initialization to make sure we have an event loop - self._login_exception: BaseException | None = None self._updates_exist = asyncio.locks.Event() From 08d9a6d2a5f512bd10f10854e4da406f011d10ea Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 20 Jan 2024 23:36:51 -0500 Subject: [PATCH 197/226] add passthrough of keepalive and relogin_interval --- pyadtpulse/pyadtpulse_async.py | 60 ++++++++++++++++++++++++++++- pyadtpulse/pyadtpulse_properties.py | 14 +++++-- 2 files changed, 68 insertions(+), 6 deletions(-) diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index aa6be6b..f3fbb04 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -679,18 +679,74 @@ def detailed_debug_logging(self) -> bool: return self._pulse_connection.detailed_debug_logging @detailed_debug_logging.setter + @typechecked def detailed_debug_logging(self, value: bool) -> None: """Set detailed debug logging.""" self._pulse_connection.detailed_debug_logging = value + @property + def keepalive_interval(self) -> int: + """Get the keepalive interval in minutes. + + Returns: + int: the keepalive interval + """ + return self._pulse_properties.keepalive_interval + + @keepalive_interval.setter + @typechecked + def keepalive_interval(self, interval: int | None) -> None: + """Set the keepalive interval in minutes. + + Args: + interval (int|None): The number of minutes between keepalive calls + If set to None, resets to ADT_DEFAULT_KEEPALIVE_INTERVAL + + Raises: + ValueError: if a keepalive interval of greater than ADT_MAX_KEEPALIVE_INTERVAL + minutes is specified + """ + self._pulse_properties.keepalive_interval = interval + + @property + def relogin_interval(self) -> int: + """Get the relogin interval in minutes. + + Returns: + int: the relogin interval + """ + return self._pulse_properties.relogin_interval + + @relogin_interval.setter + @typechecked + def relogin_interval(self, interval: int | None) -> None: + """Set the relogin interval in minutes. + + If set to None, resets to ADT_DEFAULT_RELOGIN_INTERVAL + """ + self._pulse_properties.relogin_interval = interval + @property def sync_check_exception(self) -> Exception | None: - """Return sync check exception.""" + """Return sync check exception. + + This should not be used by external code. + + Returns: + Exception: sync check exception + """ with self._pa_attribute_lock: return self._sync_check_exception @sync_check_exception.setter + @typechecked def sync_check_exception(self, value: Exception | None) -> None: - """Set sync check exception.""" + """Set sync check exception. + + This should not be used by external code. + + Args: + value (Exception): sync check exception + """ with self._pa_attribute_lock: self._sync_check_exception = value diff --git a/pyadtpulse/pyadtpulse_properties.py b/pyadtpulse/pyadtpulse_properties.py index 5ef2864..2d01198 100644 --- a/pyadtpulse/pyadtpulse_properties.py +++ b/pyadtpulse/pyadtpulse_properties.py @@ -89,12 +89,12 @@ def relogin_interval(self, interval: int | None) -> None: """Set re-login interval. Args: - interval (int): The number of minutes between logins. + interval (int|None): The number of minutes between logins. If set to None, resets to ADT_DEFAULT_RELOGIN_INTERVAL Raises: - ValueError: if a relogin interval of less than 10 minutes - is specified + ValueError: if a relogin interval of less than ADT_MIN_RELOGIN_INTERVAL + minutes is specified """ if interval is None: interval = ADT_DEFAULT_RELOGIN_INTERVAL @@ -119,7 +119,13 @@ def keepalive_interval(self) -> int: def keepalive_interval(self, interval: int | None) -> None: """Set the keepalive interval in minutes. - If set to None, resets to ADT_DEFAULT_KEEPALIVE_INTERVAL + Args: + interval (int|None): The number of minutes between keepalive calls + If set to None, resets to ADT_DEFAULT_KEEPALIVE_INTERVAL + + Raises: + ValueError: if a keepalive interval of greater than ADT_MAX_KEEPALIVE_INTERVAL + minutes is specified """ if interval is None: interval = ADT_DEFAULT_KEEPALIVE_INTERVAL From 011dd230dc553894c90539391efbb5ee3449a103 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 20 Jan 2024 23:40:34 -0500 Subject: [PATCH 198/226] bump version to 1.2.0b2 --- pyadtpulse/const.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 492ebb5..7a5ff75 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -1,5 +1,5 @@ """Constants for pyadtpulse.""" -__version__ = "1.2.0b1" +__version__ = "1.2.0b2" DEFAULT_API_HOST = "https://portal.adtpulse.com" diff --git a/pyproject.toml b/pyproject.toml index 223d045..8812bce 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "pyadtpulse" -version = "1.2.0b1" +version = "1.2.0b2" description = "Python interface for ADT Pulse security systems" authors = ["Ryan Snodgrass"] maintainers = ["Robert Lippmann"] From 61eb9ec7b92788859427f1edd1b6d926dcdbd0c5 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 21 Jan 2024 22:37:26 -0500 Subject: [PATCH 199/226] bump aiohttp version to 3.9.1 --- poetry.lock | 283 ++++++++++++++--------------------------------- pyproject.toml | 2 +- requirements.txt | 2 +- 3 files changed, 82 insertions(+), 205 deletions(-) diff --git a/poetry.lock b/poetry.lock index 09352c5..94b6b9e 100644 --- a/poetry.lock +++ b/poetry.lock @@ -2,111 +2,98 @@ [[package]] name = "aiohttp" -version = "3.8.5" +version = "3.9.1" description = "Async http client/server framework (asyncio)" optional = false -python-versions = ">=3.6" +python-versions = ">=3.8" files = [ - {file = "aiohttp-3.8.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a94159871304770da4dd371f4291b20cac04e8c94f11bdea1c3478e557fbe0d8"}, - {file = "aiohttp-3.8.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:13bf85afc99ce6f9ee3567b04501f18f9f8dbbb2ea11ed1a2e079670403a7c84"}, - {file = "aiohttp-3.8.5-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:2ce2ac5708501afc4847221a521f7e4b245abf5178cf5ddae9d5b3856ddb2f3a"}, - {file = "aiohttp-3.8.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:96943e5dcc37a6529d18766597c491798b7eb7a61d48878611298afc1fca946c"}, - {file = "aiohttp-3.8.5-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:2ad5c3c4590bb3cc28b4382f031f3783f25ec223557124c68754a2231d989e2b"}, - {file = "aiohttp-3.8.5-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:0c413c633d0512df4dc7fd2373ec06cc6a815b7b6d6c2f208ada7e9e93a5061d"}, - {file = "aiohttp-3.8.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:df72ac063b97837a80d80dec8d54c241af059cc9bb42c4de68bd5b61ceb37caa"}, - {file = "aiohttp-3.8.5-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c48c5c0271149cfe467c0ff8eb941279fd6e3f65c9a388c984e0e6cf57538e14"}, - {file = "aiohttp-3.8.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:368a42363c4d70ab52c2c6420a57f190ed3dfaca6a1b19afda8165ee16416a82"}, - {file = "aiohttp-3.8.5-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:7607ec3ce4993464368505888af5beb446845a014bc676d349efec0e05085905"}, - {file = "aiohttp-3.8.5-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:0d21c684808288a98914e5aaf2a7c6a3179d4df11d249799c32d1808e79503b5"}, - {file = "aiohttp-3.8.5-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:312fcfbacc7880a8da0ae8b6abc6cc7d752e9caa0051a53d217a650b25e9a691"}, - {file = "aiohttp-3.8.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:ad093e823df03bb3fd37e7dec9d4670c34f9e24aeace76808fc20a507cace825"}, - {file = "aiohttp-3.8.5-cp310-cp310-win32.whl", hash = "sha256:33279701c04351a2914e1100b62b2a7fdb9a25995c4a104259f9a5ead7ed4802"}, - {file = "aiohttp-3.8.5-cp310-cp310-win_amd64.whl", hash = "sha256:6e4a280e4b975a2e7745573e3fc9c9ba0d1194a3738ce1cbaa80626cc9b4f4df"}, - {file = "aiohttp-3.8.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:ae871a964e1987a943d83d6709d20ec6103ca1eaf52f7e0d36ee1b5bebb8b9b9"}, - {file = "aiohttp-3.8.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:461908b2578955045efde733719d62f2b649c404189a09a632d245b445c9c975"}, - {file = "aiohttp-3.8.5-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:72a860c215e26192379f57cae5ab12b168b75db8271f111019509a1196dfc780"}, - {file = "aiohttp-3.8.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cc14be025665dba6202b6a71cfcdb53210cc498e50068bc088076624471f8bb9"}, - {file = "aiohttp-3.8.5-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8af740fc2711ad85f1a5c034a435782fbd5b5f8314c9a3ef071424a8158d7f6b"}, - {file = "aiohttp-3.8.5-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:841cd8233cbd2111a0ef0a522ce016357c5e3aff8a8ce92bcfa14cef890d698f"}, - {file = "aiohttp-3.8.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5ed1c46fb119f1b59304b5ec89f834f07124cd23ae5b74288e364477641060ff"}, - {file = "aiohttp-3.8.5-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:84f8ae3e09a34f35c18fa57f015cc394bd1389bce02503fb30c394d04ee6b938"}, - {file = "aiohttp-3.8.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:62360cb771707cb70a6fd114b9871d20d7dd2163a0feafe43fd115cfe4fe845e"}, - {file = "aiohttp-3.8.5-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:23fb25a9f0a1ca1f24c0a371523546366bb642397c94ab45ad3aedf2941cec6a"}, - {file = "aiohttp-3.8.5-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:b0ba0d15164eae3d878260d4c4df859bbdc6466e9e6689c344a13334f988bb53"}, - {file = "aiohttp-3.8.5-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:5d20003b635fc6ae3f96d7260281dfaf1894fc3aa24d1888a9b2628e97c241e5"}, - {file = "aiohttp-3.8.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:0175d745d9e85c40dcc51c8f88c74bfbaef9e7afeeeb9d03c37977270303064c"}, - {file = "aiohttp-3.8.5-cp311-cp311-win32.whl", hash = "sha256:2e1b1e51b0774408f091d268648e3d57f7260c1682e7d3a63cb00d22d71bb945"}, - {file = "aiohttp-3.8.5-cp311-cp311-win_amd64.whl", hash = "sha256:043d2299f6dfdc92f0ac5e995dfc56668e1587cea7f9aa9d8a78a1b6554e5755"}, - {file = "aiohttp-3.8.5-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:cae533195e8122584ec87531d6df000ad07737eaa3c81209e85c928854d2195c"}, - {file = "aiohttp-3.8.5-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4f21e83f355643c345177a5d1d8079f9f28b5133bcd154193b799d380331d5d3"}, - {file = "aiohttp-3.8.5-cp36-cp36m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a7a75ef35f2df54ad55dbf4b73fe1da96f370e51b10c91f08b19603c64004acc"}, - {file = "aiohttp-3.8.5-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2e2e9839e14dd5308ee773c97115f1e0a1cb1d75cbeeee9f33824fa5144c7634"}, - {file = "aiohttp-3.8.5-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c44e65da1de4403d0576473e2344828ef9c4c6244d65cf4b75549bb46d40b8dd"}, - {file = "aiohttp-3.8.5-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:78d847e4cde6ecc19125ccbc9bfac4a7ab37c234dd88fbb3c5c524e8e14da543"}, - {file = "aiohttp-3.8.5-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:c7a815258e5895d8900aec4454f38dca9aed71085f227537208057853f9d13f2"}, - {file = "aiohttp-3.8.5-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:8b929b9bd7cd7c3939f8bcfffa92fae7480bd1aa425279d51a89327d600c704d"}, - {file = "aiohttp-3.8.5-cp36-cp36m-musllinux_1_1_ppc64le.whl", hash = "sha256:5db3a5b833764280ed7618393832e0853e40f3d3e9aa128ac0ba0f8278d08649"}, - {file = "aiohttp-3.8.5-cp36-cp36m-musllinux_1_1_s390x.whl", hash = "sha256:a0215ce6041d501f3155dc219712bc41252d0ab76474615b9700d63d4d9292af"}, - {file = "aiohttp-3.8.5-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:fd1ed388ea7fbed22c4968dd64bab0198de60750a25fe8c0c9d4bef5abe13824"}, - {file = "aiohttp-3.8.5-cp36-cp36m-win32.whl", hash = "sha256:6e6783bcc45f397fdebc118d772103d751b54cddf5b60fbcc958382d7dd64f3e"}, - {file = "aiohttp-3.8.5-cp36-cp36m-win_amd64.whl", hash = "sha256:b5411d82cddd212644cf9360879eb5080f0d5f7d809d03262c50dad02f01421a"}, - {file = "aiohttp-3.8.5-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:01d4c0c874aa4ddfb8098e85d10b5e875a70adc63db91f1ae65a4b04d3344cda"}, - {file = "aiohttp-3.8.5-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e5980a746d547a6ba173fd5ee85ce9077e72d118758db05d229044b469d9029a"}, - {file = "aiohttp-3.8.5-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:2a482e6da906d5e6e653be079b29bc173a48e381600161c9932d89dfae5942ef"}, - {file = "aiohttp-3.8.5-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:80bd372b8d0715c66c974cf57fe363621a02f359f1ec81cba97366948c7fc873"}, - {file = "aiohttp-3.8.5-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c1161b345c0a444ebcf46bf0a740ba5dcf50612fd3d0528883fdc0eff578006a"}, - {file = "aiohttp-3.8.5-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:cd56db019015b6acfaaf92e1ac40eb8434847d9bf88b4be4efe5bfd260aee692"}, - {file = "aiohttp-3.8.5-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:153c2549f6c004d2754cc60603d4668899c9895b8a89397444a9c4efa282aaf4"}, - {file = "aiohttp-3.8.5-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:4a01951fabc4ce26ab791da5f3f24dca6d9a6f24121746eb19756416ff2d881b"}, - {file = "aiohttp-3.8.5-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:bfb9162dcf01f615462b995a516ba03e769de0789de1cadc0f916265c257e5d8"}, - {file = "aiohttp-3.8.5-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:7dde0009408969a43b04c16cbbe252c4f5ef4574ac226bc8815cd7342d2028b6"}, - {file = "aiohttp-3.8.5-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:4149d34c32f9638f38f544b3977a4c24052042affa895352d3636fa8bffd030a"}, - {file = "aiohttp-3.8.5-cp37-cp37m-win32.whl", hash = "sha256:68c5a82c8779bdfc6367c967a4a1b2aa52cd3595388bf5961a62158ee8a59e22"}, - {file = "aiohttp-3.8.5-cp37-cp37m-win_amd64.whl", hash = "sha256:2cf57fb50be5f52bda004b8893e63b48530ed9f0d6c96c84620dc92fe3cd9b9d"}, - {file = "aiohttp-3.8.5-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:eca4bf3734c541dc4f374ad6010a68ff6c6748f00451707f39857f429ca36ced"}, - {file = "aiohttp-3.8.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1274477e4c71ce8cfe6c1ec2f806d57c015ebf84d83373676036e256bc55d690"}, - {file = "aiohttp-3.8.5-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:28c543e54710d6158fc6f439296c7865b29e0b616629767e685a7185fab4a6b9"}, - {file = "aiohttp-3.8.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:910bec0c49637d213f5d9877105d26e0c4a4de2f8b1b29405ff37e9fc0ad52b8"}, - {file = "aiohttp-3.8.5-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5443910d662db951b2e58eb70b0fbe6b6e2ae613477129a5805d0b66c54b6cb7"}, - {file = "aiohttp-3.8.5-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2e460be6978fc24e3df83193dc0cc4de46c9909ed92dd47d349a452ef49325b7"}, - {file = "aiohttp-3.8.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fb1558def481d84f03b45888473fc5a1f35747b5f334ef4e7a571bc0dfcb11f8"}, - {file = "aiohttp-3.8.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:34dd0c107799dcbbf7d48b53be761a013c0adf5571bf50c4ecad5643fe9cfcd0"}, - {file = "aiohttp-3.8.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:aa1990247f02a54185dc0dff92a6904521172a22664c863a03ff64c42f9b5410"}, - {file = "aiohttp-3.8.5-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:0e584a10f204a617d71d359fe383406305a4b595b333721fa50b867b4a0a1548"}, - {file = "aiohttp-3.8.5-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:a3cf433f127efa43fee6b90ea4c6edf6c4a17109d1d037d1a52abec84d8f2e42"}, - {file = "aiohttp-3.8.5-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:c11f5b099adafb18e65c2c997d57108b5bbeaa9eeee64a84302c0978b1ec948b"}, - {file = "aiohttp-3.8.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:84de26ddf621d7ac4c975dbea4c945860e08cccde492269db4e1538a6a6f3c35"}, - {file = "aiohttp-3.8.5-cp38-cp38-win32.whl", hash = "sha256:ab88bafedc57dd0aab55fa728ea10c1911f7e4d8b43e1d838a1739f33712921c"}, - {file = "aiohttp-3.8.5-cp38-cp38-win_amd64.whl", hash = "sha256:5798a9aad1879f626589f3df0f8b79b3608a92e9beab10e5fda02c8a2c60db2e"}, - {file = "aiohttp-3.8.5-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:a6ce61195c6a19c785df04e71a4537e29eaa2c50fe745b732aa937c0c77169f3"}, - {file = "aiohttp-3.8.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:773dd01706d4db536335fcfae6ea2440a70ceb03dd3e7378f3e815b03c97ab51"}, - {file = "aiohttp-3.8.5-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:f83a552443a526ea38d064588613aca983d0ee0038801bc93c0c916428310c28"}, - {file = "aiohttp-3.8.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1f7372f7341fcc16f57b2caded43e81ddd18df53320b6f9f042acad41f8e049a"}, - {file = "aiohttp-3.8.5-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ea353162f249c8097ea63c2169dd1aa55de1e8fecbe63412a9bc50816e87b761"}, - {file = "aiohttp-3.8.5-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e5d47ae48db0b2dcf70bc8a3bc72b3de86e2a590fc299fdbbb15af320d2659de"}, - {file = "aiohttp-3.8.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d827176898a2b0b09694fbd1088c7a31836d1a505c243811c87ae53a3f6273c1"}, - {file = "aiohttp-3.8.5-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3562b06567c06439d8b447037bb655ef69786c590b1de86c7ab81efe1c9c15d8"}, - {file = "aiohttp-3.8.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:4e874cbf8caf8959d2adf572a78bba17cb0e9d7e51bb83d86a3697b686a0ab4d"}, - {file = "aiohttp-3.8.5-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:6809a00deaf3810e38c628e9a33271892f815b853605a936e2e9e5129762356c"}, - {file = "aiohttp-3.8.5-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:33776e945d89b29251b33a7e7d006ce86447b2cfd66db5e5ded4e5cd0340585c"}, - {file = "aiohttp-3.8.5-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:eaeed7abfb5d64c539e2db173f63631455f1196c37d9d8d873fc316470dfbacd"}, - {file = "aiohttp-3.8.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:e91d635961bec2d8f19dfeb41a539eb94bd073f075ca6dae6c8dc0ee89ad6f91"}, - {file = "aiohttp-3.8.5-cp39-cp39-win32.whl", hash = "sha256:00ad4b6f185ec67f3e6562e8a1d2b69660be43070bd0ef6fcec5211154c7df67"}, - {file = "aiohttp-3.8.5-cp39-cp39-win_amd64.whl", hash = "sha256:c0a9034379a37ae42dea7ac1e048352d96286626251862e448933c0f59cbd79c"}, - {file = "aiohttp-3.8.5.tar.gz", hash = "sha256:b9552ec52cc147dbf1944ac7ac98af7602e51ea2dcd076ed194ca3c0d1c7d0bc"}, + {file = "aiohttp-3.9.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:e1f80197f8b0b846a8d5cf7b7ec6084493950d0882cc5537fb7b96a69e3c8590"}, + {file = "aiohttp-3.9.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:c72444d17777865734aa1a4d167794c34b63e5883abb90356a0364a28904e6c0"}, + {file = "aiohttp-3.9.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9b05d5cbe9dafcdc733262c3a99ccf63d2f7ce02543620d2bd8db4d4f7a22f83"}, + {file = "aiohttp-3.9.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5c4fa235d534b3547184831c624c0b7c1e262cd1de847d95085ec94c16fddcd5"}, + {file = "aiohttp-3.9.1-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:289ba9ae8e88d0ba16062ecf02dd730b34186ea3b1e7489046fc338bdc3361c4"}, + {file = "aiohttp-3.9.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:bff7e2811814fa2271be95ab6e84c9436d027a0e59665de60edf44e529a42c1f"}, + {file = "aiohttp-3.9.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:81b77f868814346662c96ab36b875d7814ebf82340d3284a31681085c051320f"}, + {file = "aiohttp-3.9.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3b9c7426923bb7bd66d409da46c41e3fb40f5caf679da624439b9eba92043fa6"}, + {file = "aiohttp-3.9.1-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:8d44e7bf06b0c0a70a20f9100af9fcfd7f6d9d3913e37754c12d424179b4e48f"}, + {file = "aiohttp-3.9.1-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:22698f01ff5653fe66d16ffb7658f582a0ac084d7da1323e39fd9eab326a1f26"}, + {file = "aiohttp-3.9.1-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:ca7ca5abfbfe8d39e653870fbe8d7710be7a857f8a8386fc9de1aae2e02ce7e4"}, + {file = "aiohttp-3.9.1-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:8d7f98fde213f74561be1d6d3fa353656197f75d4edfbb3d94c9eb9b0fc47f5d"}, + {file = "aiohttp-3.9.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:5216b6082c624b55cfe79af5d538e499cd5f5b976820eac31951fb4325974501"}, + {file = "aiohttp-3.9.1-cp310-cp310-win32.whl", hash = "sha256:0e7ba7ff228c0d9a2cd66194e90f2bca6e0abca810b786901a569c0de082f489"}, + {file = "aiohttp-3.9.1-cp310-cp310-win_amd64.whl", hash = "sha256:c7e939f1ae428a86e4abbb9a7c4732bf4706048818dfd979e5e2839ce0159f23"}, + {file = "aiohttp-3.9.1-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:df9cf74b9bc03d586fc53ba470828d7b77ce51b0582d1d0b5b2fb673c0baa32d"}, + {file = "aiohttp-3.9.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:ecca113f19d5e74048c001934045a2b9368d77b0b17691d905af18bd1c21275e"}, + {file = "aiohttp-3.9.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:8cef8710fb849d97c533f259103f09bac167a008d7131d7b2b0e3a33269185c0"}, + {file = "aiohttp-3.9.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bea94403a21eb94c93386d559bce297381609153e418a3ffc7d6bf772f59cc35"}, + {file = "aiohttp-3.9.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:91c742ca59045dce7ba76cab6e223e41d2c70d79e82c284a96411f8645e2afff"}, + {file = "aiohttp-3.9.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:6c93b7c2e52061f0925c3382d5cb8980e40f91c989563d3d32ca280069fd6a87"}, + {file = "aiohttp-3.9.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ee2527134f95e106cc1653e9ac78846f3a2ec1004cf20ef4e02038035a74544d"}, + {file = "aiohttp-3.9.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:11ff168d752cb41e8492817e10fb4f85828f6a0142b9726a30c27c35a1835f01"}, + {file = "aiohttp-3.9.1-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:b8c3a67eb87394386847d188996920f33b01b32155f0a94f36ca0e0c635bf3e3"}, + {file = "aiohttp-3.9.1-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:c7b5d5d64e2a14e35a9240b33b89389e0035e6de8dbb7ffa50d10d8b65c57449"}, + {file = "aiohttp-3.9.1-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:69985d50a2b6f709412d944ffb2e97d0be154ea90600b7a921f95a87d6f108a2"}, + {file = "aiohttp-3.9.1-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:c9110c06eaaac7e1f5562caf481f18ccf8f6fdf4c3323feab28a93d34cc646bd"}, + {file = "aiohttp-3.9.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:d737e69d193dac7296365a6dcb73bbbf53bb760ab25a3727716bbd42022e8d7a"}, + {file = "aiohttp-3.9.1-cp311-cp311-win32.whl", hash = "sha256:4ee8caa925aebc1e64e98432d78ea8de67b2272252b0a931d2ac3bd876ad5544"}, + {file = "aiohttp-3.9.1-cp311-cp311-win_amd64.whl", hash = "sha256:a34086c5cc285be878622e0a6ab897a986a6e8bf5b67ecb377015f06ed316587"}, + {file = "aiohttp-3.9.1-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:f800164276eec54e0af5c99feb9494c295118fc10a11b997bbb1348ba1a52065"}, + {file = "aiohttp-3.9.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:500f1c59906cd142d452074f3811614be04819a38ae2b3239a48b82649c08821"}, + {file = "aiohttp-3.9.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:0b0a6a36ed7e164c6df1e18ee47afbd1990ce47cb428739d6c99aaabfaf1b3af"}, + {file = "aiohttp-3.9.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69da0f3ed3496808e8cbc5123a866c41c12c15baaaead96d256477edf168eb57"}, + {file = "aiohttp-3.9.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:176df045597e674fa950bf5ae536be85699e04cea68fa3a616cf75e413737eb5"}, + {file = "aiohttp-3.9.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b796b44111f0cab6bbf66214186e44734b5baab949cb5fb56154142a92989aeb"}, + {file = "aiohttp-3.9.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f27fdaadce22f2ef950fc10dcdf8048407c3b42b73779e48a4e76b3c35bca26c"}, + {file = "aiohttp-3.9.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:bcb6532b9814ea7c5a6a3299747c49de30e84472fa72821b07f5a9818bce0f66"}, + {file = "aiohttp-3.9.1-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:54631fb69a6e44b2ba522f7c22a6fb2667a02fd97d636048478db2fd8c4e98fe"}, + {file = "aiohttp-3.9.1-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:4b4c452d0190c5a820d3f5c0f3cd8a28ace48c54053e24da9d6041bf81113183"}, + {file = "aiohttp-3.9.1-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:cae4c0c2ca800c793cae07ef3d40794625471040a87e1ba392039639ad61ab5b"}, + {file = "aiohttp-3.9.1-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:565760d6812b8d78d416c3c7cfdf5362fbe0d0d25b82fed75d0d29e18d7fc30f"}, + {file = "aiohttp-3.9.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:54311eb54f3a0c45efb9ed0d0a8f43d1bc6060d773f6973efd90037a51cd0a3f"}, + {file = "aiohttp-3.9.1-cp312-cp312-win32.whl", hash = "sha256:85c3e3c9cb1d480e0b9a64c658cd66b3cfb8e721636ab8b0e746e2d79a7a9eed"}, + {file = "aiohttp-3.9.1-cp312-cp312-win_amd64.whl", hash = "sha256:11cb254e397a82efb1805d12561e80124928e04e9c4483587ce7390b3866d213"}, + {file = "aiohttp-3.9.1-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:8a22a34bc594d9d24621091d1b91511001a7eea91d6652ea495ce06e27381f70"}, + {file = "aiohttp-3.9.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:598db66eaf2e04aa0c8900a63b0101fdc5e6b8a7ddd805c56d86efb54eb66672"}, + {file = "aiohttp-3.9.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:2c9376e2b09895c8ca8b95362283365eb5c03bdc8428ade80a864160605715f1"}, + {file = "aiohttp-3.9.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:41473de252e1797c2d2293804e389a6d6986ef37cbb4a25208de537ae32141dd"}, + {file = "aiohttp-3.9.1-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9c5857612c9813796960c00767645cb5da815af16dafb32d70c72a8390bbf690"}, + {file = "aiohttp-3.9.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:ffcd828e37dc219a72c9012ec44ad2e7e3066bec6ff3aaa19e7d435dbf4032ca"}, + {file = "aiohttp-3.9.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:219a16763dc0294842188ac8a12262b5671817042b35d45e44fd0a697d8c8361"}, + {file = "aiohttp-3.9.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f694dc8a6a3112059258a725a4ebe9acac5fe62f11c77ac4dcf896edfa78ca28"}, + {file = "aiohttp-3.9.1-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:bcc0ea8d5b74a41b621ad4a13d96c36079c81628ccc0b30cfb1603e3dfa3a014"}, + {file = "aiohttp-3.9.1-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:90ec72d231169b4b8d6085be13023ece8fa9b1bb495e4398d847e25218e0f431"}, + {file = "aiohttp-3.9.1-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:cf2a0ac0615842b849f40c4d7f304986a242f1e68286dbf3bd7a835e4f83acfd"}, + {file = "aiohttp-3.9.1-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:0e49b08eafa4f5707ecfb321ab9592717a319e37938e301d462f79b4e860c32a"}, + {file = "aiohttp-3.9.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:2c59e0076ea31c08553e868cec02d22191c086f00b44610f8ab7363a11a5d9d8"}, + {file = "aiohttp-3.9.1-cp38-cp38-win32.whl", hash = "sha256:4831df72b053b1eed31eb00a2e1aff6896fb4485301d4ccb208cac264b648db4"}, + {file = "aiohttp-3.9.1-cp38-cp38-win_amd64.whl", hash = "sha256:3135713c5562731ee18f58d3ad1bf41e1d8883eb68b363f2ffde5b2ea4b84cc7"}, + {file = "aiohttp-3.9.1-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:cfeadf42840c1e870dc2042a232a8748e75a36b52d78968cda6736de55582766"}, + {file = "aiohttp-3.9.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:70907533db712f7aa791effb38efa96f044ce3d4e850e2d7691abd759f4f0ae0"}, + {file = "aiohttp-3.9.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:cdefe289681507187e375a5064c7599f52c40343a8701761c802c1853a504558"}, + {file = "aiohttp-3.9.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d7481f581251bb5558ba9f635db70908819caa221fc79ee52a7f58392778c636"}, + {file = "aiohttp-3.9.1-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:49f0c1b3c2842556e5de35f122fc0f0b721334ceb6e78c3719693364d4af8499"}, + {file = "aiohttp-3.9.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:0d406b01a9f5a7e232d1b0d161b40c05275ffbcbd772dc18c1d5a570961a1ca4"}, + {file = "aiohttp-3.9.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8d8e4450e7fe24d86e86b23cc209e0023177b6d59502e33807b732d2deb6975f"}, + {file = "aiohttp-3.9.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3c0266cd6f005e99f3f51e583012de2778e65af6b73860038b968a0a8888487a"}, + {file = "aiohttp-3.9.1-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:ab221850108a4a063c5b8a70f00dd7a1975e5a1713f87f4ab26a46e5feac5a0e"}, + {file = "aiohttp-3.9.1-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:c88a15f272a0ad3d7773cf3a37cc7b7d077cbfc8e331675cf1346e849d97a4e5"}, + {file = "aiohttp-3.9.1-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:237533179d9747080bcaad4d02083ce295c0d2eab3e9e8ce103411a4312991a0"}, + {file = "aiohttp-3.9.1-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:02ab6006ec3c3463b528374c4cdce86434e7b89ad355e7bf29e2f16b46c7dd6f"}, + {file = "aiohttp-3.9.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04fa38875e53eb7e354ece1607b1d2fdee2d175ea4e4d745f6ec9f751fe20c7c"}, + {file = "aiohttp-3.9.1-cp39-cp39-win32.whl", hash = "sha256:82eefaf1a996060602f3cc1112d93ba8b201dbf5d8fd9611227de2003dddb3b7"}, + {file = "aiohttp-3.9.1-cp39-cp39-win_amd64.whl", hash = "sha256:9b05d33ff8e6b269e30a7957bd3244ffbce2a7a35a81b81c382629b80af1a8bf"}, + {file = "aiohttp-3.9.1.tar.gz", hash = "sha256:8fc49a87ac269d4529da45871e2ffb6874e87779c3d0e2ccd813c0899221239d"}, ] [package.dependencies] aiosignal = ">=1.1.2" -async-timeout = ">=4.0.0a3,<5.0" attrs = ">=17.3.0" -charset-normalizer = ">=2.0,<4.0" frozenlist = ">=1.1.1" multidict = ">=4.5,<7.0" yarl = ">=1.0,<2.0" [package.extras] -speedups = ["Brotli", "aiodns", "cchardet"] +speedups = ["Brotli", "aiodns", "brotlicffi"] [[package]] name = "aioresponses" @@ -147,17 +134,6 @@ files = [ {file = "astroid-3.0.1.tar.gz", hash = "sha256:86b0bb7d7da0be1a7c4aedb7974e391b32d4ed89e33de6ed6902b4b15c97577e"}, ] -[[package]] -name = "async-timeout" -version = "4.0.3" -description = "Timeout context manager for asyncio programs" -optional = false -python-versions = ">=3.7" -files = [ - {file = "async-timeout-4.0.3.tar.gz", hash = "sha256:4640d96be84d82d02ed59ea2b7105a0f7b33abe8703703cd0ab0bf87c427522f"}, - {file = "async_timeout-4.0.3-py3-none-any.whl", hash = "sha256:7405140ff1230c310e51dc27b3145b9092d659ce68ff733fb0cefe3ee42be028"}, -] - [[package]] name = "attrs" version = "23.1.0" @@ -258,105 +234,6 @@ files = [ {file = "cfgv-3.4.0.tar.gz", hash = "sha256:e52591d4c5f5dead8e0f673fb16db7949d2cfb3f7da4582893288f0ded8fe560"}, ] -[[package]] -name = "charset-normalizer" -version = "3.3.2" -description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet." -optional = false -python-versions = ">=3.7.0" -files = [ - {file = "charset-normalizer-3.3.2.tar.gz", hash = "sha256:f30c3cb33b24454a82faecaf01b19c18562b1e89558fb6c56de4d9118a032fd5"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:25baf083bf6f6b341f4121c2f3c548875ee6f5339300e08be3f2b2ba1721cdd3"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:06435b539f889b1f6f4ac1758871aae42dc3a8c0e24ac9e60c2384973ad73027"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9063e24fdb1e498ab71cb7419e24622516c4a04476b17a2dab57e8baa30d6e03"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6897af51655e3691ff853668779c7bad41579facacf5fd7253b0133308cf000d"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1d3193f4a680c64b4b6a9115943538edb896edc190f0b222e73761716519268e"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cd70574b12bb8a4d2aaa0094515df2463cb429d8536cfb6c7ce983246983e5a6"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8465322196c8b4d7ab6d1e049e4c5cb460d0394da4a27d23cc242fbf0034b6b5"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a9a8e9031d613fd2009c182b69c7b2c1ef8239a0efb1df3f7c8da66d5dd3d537"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:beb58fe5cdb101e3a055192ac291b7a21e3b7ef4f67fa1d74e331a7f2124341c"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:e06ed3eb3218bc64786f7db41917d4e686cc4856944f53d5bdf83a6884432e12"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:2e81c7b9c8979ce92ed306c249d46894776a909505d8f5a4ba55b14206e3222f"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:572c3763a264ba47b3cf708a44ce965d98555f618ca42c926a9c1616d8f34269"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fd1abc0d89e30cc4e02e4064dc67fcc51bd941eb395c502aac3ec19fab46b519"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-win32.whl", hash = "sha256:3d47fa203a7bd9c5b6cee4736ee84ca03b8ef23193c0d1ca99b5089f72645c73"}, - {file = "charset_normalizer-3.3.2-cp310-cp310-win_amd64.whl", hash = "sha256:10955842570876604d404661fbccbc9c7e684caf432c09c715ec38fbae45ae09"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:802fe99cca7457642125a8a88a084cef28ff0cf9407060f7b93dca5aa25480db"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:573f6eac48f4769d667c4442081b1794f52919e7edada77495aaed9236d13a96"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:549a3a73da901d5bc3ce8d24e0600d1fa85524c10287f6004fbab87672bf3e1e"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f27273b60488abe721a075bcca6d7f3964f9f6f067c8c4c605743023d7d3944f"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1ceae2f17a9c33cb48e3263960dc5fc8005351ee19db217e9b1bb15d28c02574"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:65f6f63034100ead094b8744b3b97965785388f308a64cf8d7c34f2f2e5be0c4"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:753f10e867343b4511128c6ed8c82f7bec3bd026875576dfd88483c5c73b2fd8"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4a78b2b446bd7c934f5dcedc588903fb2f5eec172f3d29e52a9096a43722adfc"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:e537484df0d8f426ce2afb2d0f8e1c3d0b114b83f8850e5f2fbea0e797bd82ae"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:eb6904c354526e758fda7167b33005998fb68c46fbc10e013ca97f21ca5c8887"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:deb6be0ac38ece9ba87dea880e438f25ca3eddfac8b002a2ec3d9183a454e8ae"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:4ab2fe47fae9e0f9dee8c04187ce5d09f48eabe611be8259444906793ab7cbce"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:80402cd6ee291dcb72644d6eac93785fe2c8b9cb30893c1af5b8fdd753b9d40f"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-win32.whl", hash = "sha256:7cd13a2e3ddeed6913a65e66e94b51d80a041145a026c27e6bb76c31a853c6ab"}, - {file = "charset_normalizer-3.3.2-cp311-cp311-win_amd64.whl", hash = "sha256:663946639d296df6a2bb2aa51b60a2454ca1cb29835324c640dafb5ff2131a77"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:0b2b64d2bb6d3fb9112bafa732def486049e63de9618b5843bcdd081d8144cd8"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:ddbb2551d7e0102e7252db79ba445cdab71b26640817ab1e3e3648dad515003b"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:55086ee1064215781fff39a1af09518bc9255b50d6333f2e4c74ca09fac6a8f6"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8f4a014bc36d3c57402e2977dada34f9c12300af536839dc38c0beab8878f38a"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a10af20b82360ab00827f916a6058451b723b4e65030c5a18577c8b2de5b3389"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8d756e44e94489e49571086ef83b2bb8ce311e730092d2c34ca8f7d925cb20aa"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:90d558489962fd4918143277a773316e56c72da56ec7aa3dc3dbbe20fdfed15b"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6ac7ffc7ad6d040517be39eb591cac5ff87416c2537df6ba3cba3bae290c0fed"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:7ed9e526742851e8d5cc9e6cf41427dfc6068d4f5a3bb03659444b4cabf6bc26"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:8bdb58ff7ba23002a4c5808d608e4e6c687175724f54a5dade5fa8c67b604e4d"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:6b3251890fff30ee142c44144871185dbe13b11bab478a88887a639655be1068"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:b4a23f61ce87adf89be746c8a8974fe1c823c891d8f86eb218bb957c924bb143"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:efcb3f6676480691518c177e3b465bcddf57cea040302f9f4e6e191af91174d4"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-win32.whl", hash = "sha256:d965bba47ddeec8cd560687584e88cf699fd28f192ceb452d1d7ee807c5597b7"}, - {file = "charset_normalizer-3.3.2-cp312-cp312-win_amd64.whl", hash = "sha256:96b02a3dc4381e5494fad39be677abcb5e6634bf7b4fa83a6dd3112607547001"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:95f2a5796329323b8f0512e09dbb7a1860c46a39da62ecb2324f116fa8fdc85c"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c002b4ffc0be611f0d9da932eb0f704fe2602a9a949d1f738e4c34c75b0863d5"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a981a536974bbc7a512cf44ed14938cf01030a99e9b3a06dd59578882f06f985"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3287761bc4ee9e33561a7e058c72ac0938c4f57fe49a09eae428fd88aafe7bb6"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:42cb296636fcc8b0644486d15c12376cb9fa75443e00fb25de0b8602e64c1714"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0a55554a2fa0d408816b3b5cedf0045f4b8e1a6065aec45849de2d6f3f8e9786"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:c083af607d2515612056a31f0a8d9e0fcb5876b7bfc0abad3ecd275bc4ebc2d5"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:87d1351268731db79e0f8e745d92493ee2841c974128ef629dc518b937d9194c"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:bd8f7df7d12c2db9fab40bdd87a7c09b1530128315d047a086fa3ae3435cb3a8"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:c180f51afb394e165eafe4ac2936a14bee3eb10debc9d9e4db8958fe36afe711"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:8c622a5fe39a48f78944a87d4fb8a53ee07344641b0562c540d840748571b811"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-win32.whl", hash = "sha256:db364eca23f876da6f9e16c9da0df51aa4f104a972735574842618b8c6d999d4"}, - {file = "charset_normalizer-3.3.2-cp37-cp37m-win_amd64.whl", hash = "sha256:86216b5cee4b06df986d214f664305142d9c76df9b6512be2738aa72a2048f99"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:6463effa3186ea09411d50efc7d85360b38d5f09b870c48e4600f63af490e56a"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:6c4caeef8fa63d06bd437cd4bdcf3ffefe6738fb1b25951440d80dc7df8c03ac"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:37e55c8e51c236f95b033f6fb391d7d7970ba5fe7ff453dad675e88cf303377a"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fb69256e180cb6c8a894fee62b3afebae785babc1ee98b81cdf68bbca1987f33"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ae5f4161f18c61806f411a13b0310bea87f987c7d2ecdbdaad0e94eb2e404238"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b2b0a0c0517616b6869869f8c581d4eb2dd83a4d79e0ebcb7d373ef9956aeb0a"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:45485e01ff4d3630ec0d9617310448a8702f70e9c01906b0d0118bdf9d124cf2"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:eb00ed941194665c332bf8e078baf037d6c35d7c4f3102ea2d4f16ca94a26dc8"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:2127566c664442652f024c837091890cb1942c30937add288223dc895793f898"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:a50aebfa173e157099939b17f18600f72f84eed3049e743b68ad15bd69b6bf99"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:4d0d1650369165a14e14e1e47b372cfcb31d6ab44e6e33cb2d4e57265290044d"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:923c0c831b7cfcb071580d3f46c4baf50f174be571576556269530f4bbd79d04"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:06a81e93cd441c56a9b65d8e1d043daeb97a3d0856d177d5c90ba85acb3db087"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-win32.whl", hash = "sha256:6ef1d82a3af9d3eecdba2321dc1b3c238245d890843e040e41e470ffa64c3e25"}, - {file = "charset_normalizer-3.3.2-cp38-cp38-win_amd64.whl", hash = "sha256:eb8821e09e916165e160797a6c17edda0679379a4be5c716c260e836e122f54b"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:c235ebd9baae02f1b77bcea61bce332cb4331dc3617d254df3323aa01ab47bd4"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5b4c145409bef602a690e7cfad0a15a55c13320ff7a3ad7ca59c13bb8ba4d45d"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:68d1f8a9e9e37c1223b656399be5d6b448dea850bed7d0f87a8311f1ff3dabb0"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:22afcb9f253dac0696b5a4be4a1c0f8762f8239e21b99680099abd9b2b1b2269"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e27ad930a842b4c5eb8ac0016b0a54f5aebbe679340c26101df33424142c143c"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1f79682fbe303db92bc2b1136016a38a42e835d932bab5b3b1bfcfbf0640e519"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b261ccdec7821281dade748d088bb6e9b69e6d15b30652b74cbbac25e280b796"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:122c7fa62b130ed55f8f285bfd56d5f4b4a5b503609d181f9ad85e55c89f4185"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d0eccceffcb53201b5bfebb52600a5fb483a20b61da9dbc885f8b103cbe7598c"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:9f96df6923e21816da7e0ad3fd47dd8f94b2a5ce594e00677c0013018b813458"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:7f04c839ed0b6b98b1a7501a002144b76c18fb1c1850c8b98d458ac269e26ed2"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:34d1c8da1e78d2e001f363791c98a272bb734000fcef47a491c1e3b0505657a8"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:ff8fa367d09b717b2a17a052544193ad76cd49979c805768879cb63d9ca50561"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-win32.whl", hash = "sha256:aed38f6e4fb3f5d6bf81bfa990a07806be9d83cf7bacef998ab1a9bd660a581f"}, - {file = "charset_normalizer-3.3.2-cp39-cp39-win_amd64.whl", hash = "sha256:b01b88d45a6fcb69667cd6d2f7a9aeb4bf53760d7fc536bf679ec94fe9f3ff3d"}, - {file = "charset_normalizer-3.3.2-py3-none-any.whl", hash = "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc"}, -] - [[package]] name = "click" version = "8.1.7" @@ -1550,4 +1427,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "9a6b01b3ba80dd1c7bfb1d84b490518c48f0efec47d1575276dacc433b14f666" +content-hash = "5642fa42568aeb347be59e9fa00c8ad151bb7a11dbcd18ecf697aa9912ddaa20" diff --git a/pyproject.toml b/pyproject.toml index 8812bce..c352041 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -16,7 +16,7 @@ classifiers = [ [tool.poetry.dependencies] python = "^3.11" -aiohttp = "<3.8.6" +aiohttp = "3.9.1" beautifulsoup4 = "^4.12.2" uvloop = "^0.19.0" bs4 = "^0.0.1" diff --git a/requirements.txt b/requirements.txt index 3f29659..e256003 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ beautifulsoup4>=4.11.1 -aiohttp>=3.8.1 +aiohttp>=3.9.1 uvloop>=0.17.0 typeguard>=4.1.5 From 3a97cc1b995c06b390331ea361a8764549324575 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 21 Jan 2024 22:54:15 -0500 Subject: [PATCH 200/226] add gateway offline tests --- tests/test_pulse_async.py | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index 0f5099b..2fff8a3 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -22,6 +22,7 @@ from pyadtpulse.exceptions import ( PulseAccountLockedError, PulseAuthenticationError, + PulseGatewayOfflineError, PulseMFARequiredError, PulseNotLoggedInError, ) @@ -477,3 +478,32 @@ async def test_multiple_login( add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) assert p.site.zones_as_dict is not None assert len(p.site.zones_as_dict) == len(extract_ids_from_data_directory) - 3 + + +@pytest.mark.asyncio +async def test_gateway_offline(adt_pulse_instance, get_mocked_url, read_file): + p, response = await adt_pulse_instance + pattern = make_sync_check_pattern(get_mocked_url) + response.get( + get_mocked_url(ADT_ORB_URI), body=read_file("orb_gateway_offline.html") + ) + response.get( + pattern, + body="1-0-0", + content_type="text/html", + ) + response.get( + pattern, + body=DEFAULT_SYNC_CHECK, + content_type="text/html", + ) + response.get( + pattern, + body=DEFAULT_SYNC_CHECK, + content_type="text/html", + ) + shutdown_event = asyncio.Event() + shutdown_event.clear() + task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) + with pytest.raises(PulseGatewayOfflineError): + await task From 89283637ad22740d466f4faaf3422b0abda46427 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 21 Jan 2024 22:54:51 -0500 Subject: [PATCH 201/226] bump aioresponses to 0.7.6 for aiohttp 3.9.1 --- poetry.lock | 8 ++++---- pyproject.toml | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/poetry.lock b/poetry.lock index 94b6b9e..3717558 100644 --- a/poetry.lock +++ b/poetry.lock @@ -97,13 +97,13 @@ speedups = ["Brotli", "aiodns", "brotlicffi"] [[package]] name = "aioresponses" -version = "0.7.5" +version = "0.7.6" description = "Mock out requests made by ClientSession from aiohttp package" optional = false python-versions = "*" files = [ - {file = "aioresponses-0.7.5-py2.py3-none-any.whl", hash = "sha256:0af13b077bde04ae965bc21981a1c6afd7dd17b861150d858de477d1c39c26a6"}, - {file = "aioresponses-0.7.5.tar.gz", hash = "sha256:794b3e04837a683fd2c0c099bdf77f8d7ecdd284bc2c15203003518bf5cb8da8"}, + {file = "aioresponses-0.7.6-py2.py3-none-any.whl", hash = "sha256:d2c26defbb9b440ea2685ec132e90700907fd10bcca3e85ec2f157219f0d26f7"}, + {file = "aioresponses-0.7.6.tar.gz", hash = "sha256:f795d9dbda2d61774840e7e32f5366f45752d1adc1b74c9362afd017296c7ee1"}, ] [package.dependencies] @@ -1427,4 +1427,4 @@ multidict = ">=4.0" [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "5642fa42568aeb347be59e9fa00c8ad151bb7a11dbcd18ecf697aa9912ddaa20" +content-hash = "17c8d7d27a96e7620452e911597d0f74ee4b6ef0ddaf1e6c7c1d2adb1d8ee44b" diff --git a/pyproject.toml b/pyproject.toml index c352041..8b2bc32 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -33,7 +33,7 @@ pytest-asyncio = "^0.21.1" pytest-mock = "^3.12.0" pytest-aiohttp = "^1.0.5" pytest-timeout = "^2.2.0" -aioresponses = "^0.7.4" +aioresponses = "^0.7.6" freezegun = "^1.2.2" pytest-coverage = "^0.0" pytest-xdist = "^3.5.0" From 2339aff0ccb2994f8278fd97b85afce4a1ca59e0 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 23 Jan 2024 06:58:32 -0500 Subject: [PATCH 202/226] gateway offline tests and fixes --- pyadtpulse/alarm_panel.py | 8 +-- pyadtpulse/pyadtpulse_async.py | 78 +++++++++++++------------ pyadtpulse/site.py | 2 +- tests/test_pulse_async.py | 100 +++++++++++++++++++++++++++++++-- 4 files changed, 142 insertions(+), 46 deletions(-) diff --git a/pyadtpulse/alarm_panel.py b/pyadtpulse/alarm_panel.py index 67d88c4..401c6c8 100644 --- a/pyadtpulse/alarm_panel.py +++ b/pyadtpulse/alarm_panel.py @@ -315,24 +315,24 @@ def update_alarm_from_soup(self, summary_html_soup: BeautifulSoup) -> None: sat_location = "security_button_0" with self._state_lock: if value: - text = value.text + text = value.text.lstrip().splitlines()[0] last_updated = int(time()) - if re.match("Disarmed", text): + if text.startswith("Disarmed"): if ( self._status != ADT_ALARM_ARMING or last_updated - self._last_arm_disarm > ADT_ARM_DISARM_TIMEOUT ): self._status = ADT_ALARM_OFF self._last_arm_disarm = last_updated - elif re.match("Armed Away", text): + elif text.startswith("Armed Away"): if ( self._status != ADT_ALARM_DISARMING or last_updated - self._last_arm_disarm > ADT_ARM_DISARM_TIMEOUT ): self._status = ADT_ALARM_AWAY self._last_arm_disarm = last_updated - elif re.match("Armed Stay", text): + elif text.startswith("Armed Stay"): if ( self._status != ADT_ALARM_DISARMING or last_updated - self._last_arm_disarm > ADT_ARM_DISARM_TIMEOUT diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index f3fbb04..3293216 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -41,9 +41,8 @@ LOG = logging.getLogger(__name__) SYNC_CHECK_TASK_NAME = "ADT Pulse Sync Check Task" KEEPALIVE_TASK_NAME = "ADT Pulse Keepalive Task" -RELOGIN_BACKOFF_WARNING_THRESHOLD = 5.0 * 60.0 -# how many transient failures to allow before warninging wait_for_update() -WARN_UPDATE_TASK_THRESHOLD = 4 +# backoff time before warning in wait_for_update() +WARN_TRANSIENT_FAILURE_THRESHOLD = 15 class PyADTPulseAsync: @@ -217,13 +216,7 @@ def _get_sync_task_name(self) -> str: def _get_timeout_task_name(self) -> str: return self._get_task_name(self._timeout_task, KEEPALIVE_TASK_NAME) - def _set_sync_check_exception(self, e: Exception | None) -> None: - if ( - e in (PulseClientConnectionError, PulseServerConnectionError) - and self._pulse_connection_status.get_backoff().backoff_count - < WARN_UPDATE_TASK_THRESHOLD - ): - return + def _set_update_exception(self, e: Exception | None) -> None: self.sync_check_exception = e self._pulse_properties.updates_exist.set() @@ -368,7 +361,7 @@ async def _login_looped(self, task_name: str) -> None: and self._sync_check_exception is None or self._sync_check_exception != ex ): - self._set_sync_check_exception(ex) + self._set_update_exception(ex) continue # success, return return @@ -421,28 +414,28 @@ async def validate_sync_check_response() -> bool: return False return True - async def handle_no_updates_exist() -> bool: + async def handle_no_updates_exist() -> None: if last_sync_check_was_different: try: success = await self.async_update() - except PulseGatewayOfflineError as e: - if self.sync_check_exception != e: - LOG.debug( - "Pulse gateway offline, update failed in task %s", task_name - ) - self._set_sync_check_exception(e) - return False + except ( + PulseClientConnectionError, + PulseServerConnectionError, + PulseGatewayOfflineError, + ) as e: + LOG.debug("Pulse update failed in task %s due to %s", task_name, e) + self._set_update_exception(e) + return if not success: LOG.debug("Pulse data update failed in task %s", task_name) - return False - # no updates with an offline gateway, bump backoff and signal gateway offline - self._set_sync_check_exception(None) - return True + return + self._set_update_exception(None) + return else: additional_msg = "" if not self.site.gateway.is_online: # bump backoff and resignal since offline and nothing updated - self._set_sync_check_exception( + self._set_update_exception( PulseGatewayOfflineError(self.site.gateway.backoff) ) additional_msg = ", gateway offline so backoff incremented" @@ -452,7 +445,6 @@ async def handle_no_updates_exist() -> bool: response_text, additional_msg, ) - return False def handle_updates_exist() -> bool: if response_text != last_sync_text: @@ -463,15 +455,15 @@ def handle_updates_exist() -> bool: async def shutdown_task(ex: Exception): await self._pulse_connection.quick_logout() await self._cancel_task(self._timeout_task) - self._set_sync_check_exception(ex) + self._set_update_exception(ex) - transient_exception_count = 0 while True: try: await self.site.gateway.backoff.wait_for_backoff() pi = ( self.site.gateway.poll_interval if not last_sync_check_was_different + or not self.site.gateway.backoff.will_backoff() else 0.0 ) if self._pulse_connection_status.get_backoff().will_backoff(): @@ -487,9 +479,15 @@ async def shutdown_task(ex: Exception): ) as e: # temporarily unavailble errors should be reported immediately # since the next query will sleep until the retry-after is over - transient_exception_count += 1 - if transient_exception_count > WARN_UPDATE_TASK_THRESHOLD: - self._set_sync_check_exception(e) + msg = "" + if ( + e.backoff.get_current_backoff_interval() + > WARN_TRANSIENT_FAILURE_THRESHOLD + ): + self._set_update_exception(e) + else: + msg = ", ignoring..." + LOG.debug("Pulse sync check query failed due to %s%s", e, msg) continue except ( PulseServiceTemporarilyUnavailableError, @@ -529,9 +527,9 @@ async def shutdown_task(ex: Exception): last_sync_check_was_different = True last_sync_text = response_text continue - if await handle_no_updates_exist(): - last_sync_check_was_different = False - continue + await handle_no_updates_exist() + last_sync_check_was_different = False + continue except asyncio.CancelledError: LOG.debug("%s cancelled", task_name) return @@ -561,8 +559,10 @@ async def async_login(self) -> None: soup = await self._pulse_connection.async_do_login_query() if soup is None: await self._pulse_connection.quick_logout() - raise PulseNotLoggedInError() - self._set_sync_check_exception(None) + ex = PulseNotLoggedInError() + self._set_update_exception(ex) + raise ex + self._set_update_exception(None) # if tasks are started, we've already logged in before # clean up completed tasks first await self._clean_done_tasks() @@ -573,7 +573,9 @@ async def async_login(self) -> None: if self._site is None: LOG.error("Could not retrieve any sites, login failed") await self._pulse_connection.quick_logout() - raise PulseNotLoggedInError() + ex = PulseNotLoggedInError() + self._set_update_exception(ex) + raise ex self.sync_check_exception = None self._timeout_task = asyncio.create_task( self._keepalive_task(), name=KEEPALIVE_TASK_NAME @@ -588,7 +590,7 @@ async def async_logout(self) -> None: LOG.info( "Logging %s out of ADT Pulse", self._authentication_properties.username ) - self._set_sync_check_exception(PulseNotLoggedInError()) + self._set_update_exception(PulseNotLoggedInError()) if asyncio.current_task() not in (self._sync_task, self._timeout_task): await self._cancel_task(self._timeout_task) await self._cancel_task(self._sync_task) @@ -629,6 +631,8 @@ async def wait_for_update(self) -> None: if self.sync_check_exception: raise self.sync_check_exception with self._pa_attribute_lock: + if self._timeout_task is None: + raise PulseNotLoggedInError() if self._sync_task is None: coro = self._sync_check_task() self._sync_task = asyncio.create_task( diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index bb90774..517b49b 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -316,7 +316,7 @@ def update_zone_from_soup(self, soup: BeautifulSoup) -> None: with self._site_lock: orb_status = soup.find("canvas", {"id": "ic_orb"}) if orb_status: - alarm_status = orb_status.get("orb")[0] + alarm_status = orb_status.get("orb") if not alarm_status: LOG.error("Failed to retrieve alarm status from orb!") elif alarm_status == "offline": diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index 2fff8a3..9d95264 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -9,6 +9,7 @@ from conftest import LoginType, add_custom_response, add_logout, add_signin from pyadtpulse.const import ( + ADT_DEFAULT_POLL_INTERVAL, ADT_DEVICE_URI, ADT_LOGIN_URI, ADT_LOGOUT_URI, @@ -22,6 +23,7 @@ from pyadtpulse.exceptions import ( PulseAccountLockedError, PulseAuthenticationError, + PulseConnectionError, PulseGatewayOfflineError, PulseMFARequiredError, PulseNotLoggedInError, @@ -480,13 +482,20 @@ async def test_multiple_login( assert len(p.site.zones_as_dict) == len(extract_ids_from_data_directory) - 3 +@pytest.mark.timeout(180) @pytest.mark.asyncio async def test_gateway_offline(adt_pulse_instance, get_mocked_url, read_file): + p: PyADTPulseAsync p, response = await adt_pulse_instance pattern = make_sync_check_pattern(get_mocked_url) response.get( get_mocked_url(ADT_ORB_URI), body=read_file("orb_gateway_offline.html") ) + response.get( + pattern, + body=DEFAULT_SYNC_CHECK, + content_type="text/html", + ) response.get( pattern, body="1-0-0", @@ -502,8 +511,91 @@ async def test_gateway_offline(adt_pulse_instance, get_mocked_url, read_file): body=DEFAULT_SYNC_CHECK, content_type="text/html", ) - shutdown_event = asyncio.Event() - shutdown_event.clear() - task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) - with pytest.raises(PulseGatewayOfflineError): + num_backoffs = 3 + for i in range(3): + response.get( + pattern, + body=DEFAULT_SYNC_CHECK, + content_type="text/html", + ) + # success case + response.get(get_mocked_url(ADT_ORB_URI), body=read_file("orb.html"), repeat=True) + response.get( + pattern, + body="1-0-0", + content_type="text/html", + ) + response.get( + pattern, body=DEFAULT_SYNC_CHECK, content_type="text/html", repeat=True + ) + add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) + await p.async_login() + assert p.site.gateway.poll_interval == 2.0 + # FIXME: why + 2? + for i in range(num_backoffs + 2): + try: + await p.wait_for_update() + except PulseGatewayOfflineError: + pass + except Exception: + pytest.fail("wait_for_update did not return PulseGatewayOfflineError") + + await p.wait_for_update() + assert p.site.gateway.is_online + assert p.site.gateway.backoff.get_current_backoff_interval() == 0 + + await p.async_logout() + + +@pytest.mark.asyncio +async def test_not_logged_in(mocked_server_responses, get_mocked_url, read_file): + p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") + add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) + add_logout(mocked_server_responses, get_mocked_url, read_file) + with pytest.raises(PulseNotLoggedInError): + await do_wait_for_update(p, asyncio.Event()) + with pytest.raises(PulseNotLoggedInError): + await do_wait_for_update(p, asyncio.Event()) + await p.async_login() + await p.async_logout() + with pytest.raises(PulseNotLoggedInError): + await do_wait_for_update(p, asyncio.Event()) + with pytest.raises(PulseNotLoggedInError): + await do_wait_for_update(p, asyncio.Event()) + add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) + add_logout(mocked_server_responses, get_mocked_url, read_file) + pattern = make_sync_check_pattern(get_mocked_url) + mocked_server_responses.get( + pattern, body=DEFAULT_SYNC_CHECK, content_type="text/html", repeat=True + ) + mocked_server_responses.get( + get_mocked_url(ADT_ORB_URI), body=read_file("orb.html"), repeat=True + ) + await p.async_login() + task = asyncio.create_task(do_wait_for_update(p, asyncio.Event())) + await asyncio.sleep(ADT_DEFAULT_POLL_INTERVAL * 5) + await p.async_logout() + with pytest.raises(PulseNotLoggedInError): await task + with pytest.raises(PulseNotLoggedInError): + await do_wait_for_update(p, asyncio.Event()) + await asyncio.sleep(ADT_DEFAULT_POLL_INTERVAL * 2) + with pytest.raises(PulseNotLoggedInError): + await do_wait_for_update(p, asyncio.Event()) + + +@pytest.mark.asyncio +@pytest.mark.timeout(120) +async def test_connection_fails_wait_for_update( + mocked_server_responses, get_mocked_url, read_file +): + p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") + add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) + add_logout(mocked_server_responses, get_mocked_url, read_file) + mocked_server_responses.get( + get_mocked_url(ADT_ORB_URI), body=read_file("orb.html"), repeat=True + ) + await p.async_login() + with pytest.raises(PulseConnectionError): + await do_wait_for_update(p, asyncio.Event()) + await p.async_logout() From 4ee20e3ff1fa7c3c5695c5d2d819ee7069a37fd6 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 27 Jan 2024 09:06:05 -0500 Subject: [PATCH 203/226] don't use query backoff if we have a connection backoff --- pyadtpulse/pulse_query_manager.py | 21 ++++--- pyadtpulse/pyadtpulse_async.py | 61 +++++++------------- tests/test_pulse_async.py | 95 +++++++++++++++++-------------- 3 files changed, 86 insertions(+), 91 deletions(-) diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index ccdadfc..a31c751 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -44,7 +44,7 @@ HTTPStatus.GATEWAY_TIMEOUT, } -MAX_RETRIES = 3 +MAX_REQUERY_RETRIES = 3 class PulseQueryManager: @@ -257,7 +257,12 @@ async def setup_query(): debug_locks=self._debug_locks, detailed_debug_logging=self._connection_properties.detailed_debug_logging, ) - while retry < MAX_RETRIES: + max_retries = ( + MAX_REQUERY_RETRIES + if not self._connection_status.get_backoff().will_backoff() + else 1 + ) + while retry < max_retries: try: await query_backoff.wait_for_backoff() retry += 1 @@ -302,9 +307,9 @@ async def setup_query(): self._get_http_status_description(return_value[0]), retry, ) - if retry == MAX_RETRIES: + if retry == max_retries: LOG.debug( - "Exceeded max retries of %d, giving up", MAX_RETRIES + "Exceeded max retries of %d, giving up", max_retries ) else: query_backoff.increment_backoff() @@ -329,15 +334,15 @@ async def setup_query(): url, exc_info=True, ) - if retry == MAX_RETRIES: + if retry == max_retries: self._handle_network_errors(ex) query_backoff.increment_backoff() continue except TimeoutError as ex: - if retry == MAX_RETRIES: - LOG.debug("Exceeded max retries of %d, giving up", MAX_RETRIES) + if retry == max_retries: + LOG.debug("Exceeded max retries of %d, giving up", max_retries) raise PulseServerConnectionError( - f"Exceeded max retries of {MAX_RETRIES}, giving up", + f"Exceeded max retries of {max_retries}, giving up", self._connection_status.get_backoff(), ) from ex query_backoff.increment_backoff() diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 3293216..ed57c9f 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -42,7 +42,7 @@ SYNC_CHECK_TASK_NAME = "ADT Pulse Sync Check Task" KEEPALIVE_TASK_NAME = "ADT Pulse Keepalive Task" # backoff time before warning in wait_for_update() -WARN_TRANSIENT_FAILURE_THRESHOLD = 15 +WARN_TRANSIENT_FAILURE_THRESHOLD = 2 class PyADTPulseAsync: @@ -381,15 +381,14 @@ async def perform_sync_check_query(): response_text: str | None = None code: int = 200 - last_sync_text = "0-0-0" - last_sync_check_was_different = False + have_updates = False url: URL | None = None - async def validate_sync_check_response() -> bool: + def check_sync_check_response() -> bool: """ Validates the sync check response received from the ADT Pulse site. Returns: - bool: True if the sync check response is valid, False otherwise. + bool: True if the sync check response indicates updates, False otherwise Raises: PulseAccountLockedError if the account is locked and no retry time is available. @@ -405,17 +404,15 @@ async def validate_sync_check_response() -> bool: LOG.warning( "Unexpected sync check format", ) - try: - self._pulse_connection.check_login_errors( - (code, response_text, url) - ) - except PulseServerConnectionError: - LOG.debug("Server connection issue, continuing") - return False + self._pulse_connection.check_login_errors((code, response_text, url)) + return False + split_text = response_text.split("-") + if int(split_text[0]) > 9 or int(split_text[1]) > 9: + return False return True async def handle_no_updates_exist() -> None: - if last_sync_check_was_different: + if have_updates: try: success = await self.async_update() except ( @@ -430,7 +427,6 @@ async def handle_no_updates_exist() -> None: LOG.debug("Pulse data update failed in task %s", task_name) return self._set_update_exception(None) - return else: additional_msg = "" if not self.site.gateway.is_online: @@ -446,12 +442,6 @@ async def handle_no_updates_exist() -> None: additional_msg, ) - def handle_updates_exist() -> bool: - if response_text != last_sync_text: - LOG.debug("Updates exist: %s, requerying", response_text) - return True - return False - async def shutdown_task(ex: Exception): await self._pulse_connection.quick_logout() await self._cancel_task(self._timeout_task) @@ -462,14 +452,10 @@ async def shutdown_task(ex: Exception): await self.site.gateway.backoff.wait_for_backoff() pi = ( self.site.gateway.poll_interval - if not last_sync_check_was_different - or not self.site.gateway.backoff.will_backoff() + if not have_updates or not self.site.gateway.backoff.will_backoff() else 0.0 ) - if self._pulse_connection_status.get_backoff().will_backoff(): - await self._pulse_connection_status.get_backoff().wait_for_backoff() - elif pi > 0.0: - await asyncio.sleep(pi) + await asyncio.sleep(pi) try: code, response_text, url = await perform_sync_check_query() @@ -480,10 +466,7 @@ async def shutdown_task(ex: Exception): # temporarily unavailble errors should be reported immediately # since the next query will sleep until the retry-after is over msg = "" - if ( - e.backoff.get_current_backoff_interval() - > WARN_TRANSIENT_FAILURE_THRESHOLD - ): + if e.backoff.backoff_count > WARN_TRANSIENT_FAILURE_THRESHOLD: self._set_update_exception(e) else: msg = ", ignoring..." @@ -508,8 +491,7 @@ async def shutdown_task(ex: Exception): LOG.warning("Sync check received no response from ADT Pulse site") continue try: - if not await validate_sync_check_response(): - continue + have_updates = check_sync_check_response() except ( PulseAuthenticationError, PulseMFARequiredError, @@ -523,12 +505,11 @@ async def shutdown_task(ex: Exception): ) await shutdown_task(ex) return - if handle_updates_exist(): - last_sync_check_was_different = True - last_sync_text = response_text + if have_updates: + LOG.debug("Updates exist: %s, requerying", response_text) continue await handle_no_updates_exist() - last_sync_check_was_different = False + have_updates = False continue except asyncio.CancelledError: LOG.debug("%s cancelled", task_name) @@ -560,9 +541,9 @@ async def async_login(self) -> None: if soup is None: await self._pulse_connection.quick_logout() ex = PulseNotLoggedInError() - self._set_update_exception(ex) + self.sync_check_exception = ex raise ex - self._set_update_exception(None) + self.sync_check_exception = None # if tasks are started, we've already logged in before # clean up completed tasks first await self._clean_done_tasks() @@ -574,7 +555,7 @@ async def async_login(self) -> None: LOG.error("Could not retrieve any sites, login failed") await self._pulse_connection.quick_logout() ex = PulseNotLoggedInError() - self._set_update_exception(ex) + self.sync_check_exception = ex raise ex self.sync_check_exception = None self._timeout_task = asyncio.create_task( @@ -587,10 +568,10 @@ async def async_logout(self) -> None: if self._pulse_connection.login_in_progress: LOG.debug("Login in progress, returning") return + self.sync_check_exception = PulseNotLoggedInError() LOG.info( "Logging %s out of ADT Pulse", self._authentication_properties.username ) - self._set_update_exception(PulseNotLoggedInError()) if asyncio.current_task() not in (self._sync_task, self._timeout_task): await self._cancel_task(self._timeout_task) await self._cancel_task(self._sync_task) diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index 9d95264..5681c6d 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -5,7 +5,6 @@ import aiohttp import pytest -from freezegun import freeze_time from conftest import LoginType, add_custom_response, add_logout, add_signin from pyadtpulse.const import ( @@ -21,12 +20,12 @@ DEFAULT_API_HOST, ) from pyadtpulse.exceptions import ( - PulseAccountLockedError, PulseAuthenticationError, PulseConnectionError, PulseGatewayOfflineError, PulseMFARequiredError, PulseNotLoggedInError, + PulseServerConnectionError, ) from pyadtpulse.pyadtpulse_async import PyADTPulseAsync @@ -176,7 +175,6 @@ async def test_login( file_name=LoginType.SUCCESS.value, ) await p.async_logout() - await asyncio.sleep(1) assert not p._pulse_connection_status.authenticated_flag.is_set() assert p._pulse_connection_status.get_backoff().backoff_count == 0 assert p._pulse_connection.login_in_progress is False @@ -188,37 +186,31 @@ async def test_login( @pytest.mark.asyncio -@pytest.mark.timeout(60) -async def test_login_failures(adt_pulse_instance, get_mocked_url, read_file): +@pytest.mark.parametrize( + "test_type", + ( + (LoginType.FAIL, PulseAuthenticationError), + (LoginType.NOT_SIGNED_IN, PulseNotLoggedInError), + (LoginType.MFA, PulseMFARequiredError), + ), +) +async def test_login_failures(adt_pulse_instance, get_mocked_url, read_file, test_type): p, response = await adt_pulse_instance assert p._pulse_connection.login_backoff.backoff_count == 0, "initial" add_logout(response, get_mocked_url, read_file) await p.async_logout() assert p._pulse_connection.login_backoff.backoff_count == 0, "post logout" - for test_type in ( - (LoginType.FAIL, PulseAuthenticationError), - (LoginType.NOT_SIGNED_IN, PulseNotLoggedInError), - (LoginType.MFA, PulseMFARequiredError), - ): - assert p._pulse_connection.login_backoff.backoff_count == 0, str(test_type) - add_signin(test_type[0], response, get_mocked_url, read_file) - with pytest.raises(test_type[1]): - await p.async_login() - await asyncio.sleep(1) - assert p._timeout_task is None or p._timeout_task.done() - assert p._pulse_connection.login_backoff.backoff_count == 0, str(test_type) - if test_type[0] == LoginType.MFA: - # pop the post MFA redirect from the responses - with pytest.raises(PulseMFARequiredError): - await p.async_login() - add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) - await p.async_login() - assert p._pulse_connection.login_backoff.backoff_count == 0 - with freeze_time() as frozen_time: - add_signin(LoginType.LOCKED, response, get_mocked_url, read_file) - with pytest.raises(PulseAccountLockedError): - await p.async_login() + assert p._pulse_connection.login_backoff.backoff_count == 0, str(test_type[0]) + add_signin(test_type[0], response, get_mocked_url, read_file) + with pytest.raises(test_type[1]): + await p.async_login() + await asyncio.sleep(1) + assert p._timeout_task is None or p._timeout_task.done() + assert p._pulse_connection.login_backoff.backoff_count == 0, str(test_type) + add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) + await p.async_login() + assert p._pulse_connection.login_backoff.backoff_count == 0 async def do_wait_for_update(p: PyADTPulseAsync, shutdown_event: asyncio.Event): @@ -234,9 +226,6 @@ async def test_wait_for_update(adt_pulse_instance, get_mocked_url, read_file): p, responses = await adt_pulse_instance shutdown_event = asyncio.Event() task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) - await asyncio.sleep(1) - while task.get_stack is None: - await asyncio.sleep(1) await p.async_logout() assert p._sync_task is None assert p.site.name == "Robert Lippmann" @@ -358,8 +347,6 @@ async def test_sync_check_and_orb(): assert code == 200 assert content == NEXT_SYNC_CHECK - shutdown_event = asyncio.Event() - shutdown_event.clear() setup_sync_check() # do a first run though to make sure aioresponses will work ok await test_sync_check_and_orb() @@ -383,18 +370,12 @@ async def test_sync_check_and_orb(): state = "OK" add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) await p.async_login() - task = asyncio.create_task( - do_wait_for_update(p, shutdown_event), name=f"wait_for_update-{j}-{i}" - ) - await asyncio.sleep(3) - assert p._sync_task is not None - await p.async_logout() - await asyncio.sleep(0) - with pytest.raises(PulseNotLoggedInError): - await task - await asyncio.sleep(0) + await p.wait_for_update() assert len(p.site.zones) == 13 assert p.site.zones_as_dict[zone].state == state + assert p._sync_task is not None + await p.async_logout() + assert p._sync_task is None assert p._timeout_task is None # assert m.call_count == 2 @@ -599,3 +580,31 @@ async def test_connection_fails_wait_for_update( with pytest.raises(PulseConnectionError): await do_wait_for_update(p, asyncio.Event()) await p.async_logout() + + +@pytest.mark.timeout(120) +@pytest.mark.asyncio +async def test_sync_check_disconnect(adt_pulse_instance, read_file, get_mocked_url): + p: PyADTPulseAsync + p, responses = await adt_pulse_instance + add_signin(LoginType.SUCCESS, responses, get_mocked_url, read_file) + add_logout(responses, get_mocked_url, read_file) + await p.async_login() + pattern = make_sync_check_pattern(get_mocked_url) + responses.get(pattern, body=DEFAULT_SYNC_CHECK, content_type="text/html") + responses.get(get_mocked_url(ADT_ORB_URI), body=read_file("orb.html"), repeat=True) + while p._pulse_connection_status.get_backoff().get_current_backoff_interval() < 15: + try: + await p.wait_for_update() + except PulseServerConnectionError: + pass + except Exception: + pytest.fail("wait_for_update did not return PulseServerConnectionError") + + # check recovery + responses.get(pattern, body="1-0-0", content_type="text/html") + responses.get( + pattern, body=DEFAULT_SYNC_CHECK, content_type="text/html", repeat=True + ) + await p.wait_for_update() + await p.async_logout() From 0495f4ffa10be2ac0dbb0f8dc084dcf1698a5bd7 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sat, 27 Jan 2024 09:11:33 -0500 Subject: [PATCH 204/226] MAX_RETRIES -> MAX_REQUERY_RETRIES --- tests/test_pulse_connection.py | 10 +++++----- tests/test_pulse_query_manager.py | 14 ++++++++------ 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/tests/test_pulse_connection.py b/tests/test_pulse_connection.py index 63e65b5..f775123 100644 --- a/tests/test_pulse_connection.py +++ b/tests/test_pulse_connection.py @@ -17,7 +17,7 @@ from pyadtpulse.pulse_connection import PulseConnection from pyadtpulse.pulse_connection_properties import PulseConnectionProperties from pyadtpulse.pulse_connection_status import PulseConnectionStatus -from pyadtpulse.pulse_query_manager import MAX_RETRIES +from pyadtpulse.pulse_query_manager import MAX_REQUERY_RETRIES def setup_pulse_connection() -> PulseConnection: @@ -84,7 +84,7 @@ async def test_multiple_login( # this should fail with pytest.raises(PulseServerConnectionError): await pc.async_do_login_query() - assert mock_sleep.call_count == MAX_RETRIES - 1 + assert mock_sleep.call_count == MAX_REQUERY_RETRIES - 1 assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 assert pc._connection_status.get_backoff().backoff_count == 1 @@ -94,7 +94,7 @@ async def test_multiple_login( await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 0 # 2 retries first time, 3 the second - assert mock_sleep.call_count == MAX_RETRIES - 1 + MAX_RETRIES + assert mock_sleep.call_count == MAX_REQUERY_RETRIES - 1 + MAX_REQUERY_RETRIES assert pc.login_in_progress is False assert pc._connection_status.get_backoff().backoff_count == 2 @@ -103,7 +103,7 @@ async def test_multiple_login( add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await pc.async_do_login_query() # will do a backoff, then query - assert mock_sleep.call_count == MAX_RETRIES - 1 + MAX_RETRIES + 1 + assert mock_sleep.call_count == MAX_REQUERY_RETRIES - 1 + MAX_REQUERY_RETRIES + 1 assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 assert pc._connection_status.authenticated_flag.is_set() @@ -111,7 +111,7 @@ async def test_multiple_login( add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await pc.async_do_login_query() # shouldn't sleep at all - assert mock_sleep.call_count == MAX_RETRIES - 1 + MAX_RETRIES + 1 + assert mock_sleep.call_count == MAX_REQUERY_RETRIES - 1 + MAX_REQUERY_RETRIES + 1 assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 assert pc._connection_status.authenticated_flag.is_set() diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index 1202376..2158276 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -17,7 +17,7 @@ ) from pyadtpulse.pulse_connection_properties import PulseConnectionProperties from pyadtpulse.pulse_connection_status import PulseConnectionStatus -from pyadtpulse.pulse_query_manager import MAX_RETRIES, PulseQueryManager +from pyadtpulse.pulse_query_manager import MAX_REQUERY_RETRIES, PulseQueryManager @pytest.mark.asyncio @@ -280,7 +280,7 @@ async def test_async_query_exceptions( error_type = PulseClientConnectionError else: error_type = PulseServerConnectionError - for _ in range(MAX_RETRIES + 1): + for _ in range(MAX_REQUERY_RETRIES + 1): mocked_server_responses.get( cp.make_url(ADT_ORB_URI), exception=ex, @@ -301,16 +301,18 @@ async def test_async_query_exceptions( message = f"Expected {error_type}, got {actual_error_type}" pytest.fail(message) - # only MAX_RETRIES - 1 sleeps since first call won't sleep + # only MAX_REQUERY_RETRIES - 1 sleeps since first call won't sleep assert ( - mock_sleep.call_count == curr_sleep_count + MAX_RETRIES - 1 + mock_sleep.call_count == curr_sleep_count + MAX_REQUERY_RETRIES - 1 ), f"Failure on exception {type(ex).__name__}" assert mock_sleep.call_args_list[curr_sleep_count][0][0] == query_backoff - for i in range(curr_sleep_count + 2, curr_sleep_count + MAX_RETRIES - 1): + for i in range( + curr_sleep_count + 2, curr_sleep_count + MAX_REQUERY_RETRIES - 1 + ): assert mock_sleep.call_args_list[i][0][0] == query_backoff * 2 ** ( i - curr_sleep_count ), f"Failure on exception sleep count {i} on exception {type(ex).__name__}" - curr_sleep_count += MAX_RETRIES - 1 + curr_sleep_count += MAX_REQUERY_RETRIES - 1 assert ( s.get_backoff().backoff_count == 1 ), f"Failure on exception {type(ex).__name__}" From 493ba0bea374871f039ce0bb81200e7ac80e923f Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 28 Jan 2024 04:37:20 -0500 Subject: [PATCH 205/226] more tests and fixes --- pyadtpulse/pulse_connection.py | 7 +- pyadtpulse/pulse_connection_properties.py | 8 +- pyadtpulse/pyadtpulse_async.py | 23 +- tests/test_pulse_async.py | 182 +++++++++++----- tests/test_pulse_connection.py | 10 +- tests/test_pulse_query_manager.py | 252 +++++++++++----------- 6 files changed, 284 insertions(+), 198 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 5a6b375..1ea6bc6 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -193,7 +193,7 @@ async def async_do_login_query( if self.login_in_progress: return None - self._connection_status.authenticated_flag.clear() + self.quick_logout() # just raise exceptions if we're not going to be able to log in lockout_time = self._login_backoff.expiration_time if lockout_time > time(): @@ -210,7 +210,6 @@ async def async_do_login_query( "fingerprint": self._authentication_properties.fingerprint, } await self._login_backoff.wait_for_backoff() - await self._connection_properties.clear_session() try: response = await self.async_query( ADT_LOGIN_URI, @@ -297,14 +296,14 @@ def login_in_progress(self, value: bool) -> None: with self._pc_attribute_lock: self._login_in_progress = value - async def quick_logout(self) -> None: + def quick_logout(self) -> None: """Quickly logout. This just resets the authenticated flag and clears the ClientSession. """ LOG.debug("Resetting session") self._connection_status.authenticated_flag.clear() - await self._connection_properties.clear_session() + self._connection_properties.clear_session() @property def detailed_debug_logging(self) -> bool: diff --git a/pyadtpulse/pulse_connection_properties.py b/pyadtpulse/pulse_connection_properties.py index f51f3f2..e5cea6e 100644 --- a/pyadtpulse/pulse_connection_properties.py +++ b/pyadtpulse/pulse_connection_properties.py @@ -228,13 +228,7 @@ def make_url(self, uri: str) -> str: with self._pci_attribute_lock: return f"{self._api_host}{API_PREFIX}{self._api_version}{uri}" - async def clear_session(self): + def clear_session(self): """Clear the session.""" with self._pci_attribute_lock: - # remove the old session first to prevent an edge case - # where another coroutine might jump in during the await close() - # and get the old session. - old_session = self._session self._session = None - if old_session is not None and not old_session.closed: - await old_session.close() diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index ed57c9f..3bf363d 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -257,7 +257,7 @@ def should_relogin(relogin_interval: int) -> bool: LOG.debug("%s: Skipping relogin because not connected", task_name) continue elif should_relogin(relogin_interval): - await self._pulse_connection.quick_logout() + self._pulse_connection.quick_logout() try: await self._login_looped(task_name) except (PulseAuthenticationError, PulseMFARequiredError) as ex: @@ -423,6 +423,14 @@ async def handle_no_updates_exist() -> None: LOG.debug("Pulse update failed in task %s due to %s", task_name, e) self._set_update_exception(e) return + except PulseNotLoggedInError: + LOG.info( + "Pulse update failed in task %s due to not logged in, relogging in...", + task_name, + ) + self._pulse_connection.quick_logout() + await self._login_looped(task_name) + return if not success: LOG.debug("Pulse data update failed in task %s", task_name) return @@ -443,7 +451,7 @@ async def handle_no_updates_exist() -> None: ) async def shutdown_task(ex: Exception): - await self._pulse_connection.quick_logout() + self._pulse_connection.quick_logout() await self._cancel_task(self._timeout_task) self._set_update_exception(ex) @@ -492,11 +500,14 @@ async def shutdown_task(ex: Exception): continue try: have_updates = check_sync_check_response() + except PulseNotLoggedInError: + LOG.info("Pulse sync check indicates logged out, re-logging in....") + self._pulse_connection.quick_logout() + await self._login_looped(task_name) except ( PulseAuthenticationError, PulseMFARequiredError, PulseAccountLockedError, - PulseNotLoggedInError, ) as ex: LOG.error( "Task %s exiting due to error: %s", @@ -539,7 +550,7 @@ async def async_login(self) -> None: await self._pulse_connection.async_fetch_version() soup = await self._pulse_connection.async_do_login_query() if soup is None: - await self._pulse_connection.quick_logout() + self._pulse_connection.quick_logout() ex = PulseNotLoggedInError() self.sync_check_exception = ex raise ex @@ -553,7 +564,7 @@ async def async_login(self) -> None: await self._update_sites(soup) if self._site is None: LOG.error("Could not retrieve any sites, login failed") - await self._pulse_connection.quick_logout() + self._pulse_connection.quick_logout() ex = PulseNotLoggedInError() self.sync_check_exception = ex raise ex @@ -568,7 +579,7 @@ async def async_logout(self) -> None: if self._pulse_connection.login_in_progress: LOG.debug("Login in progress, returning") return - self.sync_check_exception = PulseNotLoggedInError() + self._set_update_exception(PulseNotLoggedInError()) LOG.info( "Logging %s out of ADT Pulse", self._authentication_properties.username ) diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index 5681c6d..eb878b9 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -1,10 +1,15 @@ """Test Pulse Query Manager.""" import asyncio import re +from collections.abc import Generator +from http.client import responses +from typing import Any, Callable, Literal from unittest.mock import AsyncMock, patch import aiohttp import pytest +from aioresponses import aioresponses +from pytest_mock import MockerFixture from conftest import LoginType, add_custom_response, add_logout, add_signin from pyadtpulse.const import ( @@ -27,6 +32,7 @@ PulseNotLoggedInError, PulseServerConnectionError, ) +from pyadtpulse.pulse_authentication_properties import PulseAuthenticationProperties from pyadtpulse.pyadtpulse_async import PyADTPulseAsync DEFAULT_SYNC_CHECK = "234532-456432-0" @@ -45,11 +51,11 @@ def set_keepalive(get_mocked_url, mocked_server_responses, repeat: bool = False) @pytest.mark.asyncio async def test_mocked_responses( - read_file, - mocked_server_responses, - get_mocked_mapped_static_responses, - get_mocked_url, - extract_ids_from_data_directory, + read_file: Callable[..., str], + mocked_server_responses: aioresponses, + get_mocked_mapped_static_responses: dict[str, str], + get_mocked_url: Callable[..., str], + extract_ids_from_data_directory: list[str], ): """Fixture to test mocked responses.""" static_responses = get_mocked_mapped_static_responses @@ -136,7 +142,10 @@ def wrap_wait_for_update(): @pytest.fixture @pytest.mark.asyncio async def adt_pulse_instance( - mocked_server_responses, extract_ids_from_data_directory, get_mocked_url, read_file + mocked_server_responses: aioresponses, + extract_ids_from_data_directory: list[str], + get_mocked_url: Callable[..., str], + read_file: Callable[..., str], ): """Create an instance of PyADTPulseAsync and login.""" p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") @@ -158,7 +167,10 @@ async def adt_pulse_instance( @pytest.mark.asyncio async def test_login( - adt_pulse_instance, extract_ids_from_data_directory, get_mocked_url, read_file + adt_pulse_instance: tuple[PyADTPulseAsync, Any], + extract_ids_from_data_directory: list[str], + get_mocked_url: Callable[..., str], + read_file: Callable[..., str], ): """Fixture to test login.""" p, response = await adt_pulse_instance @@ -194,7 +206,12 @@ async def test_login( (LoginType.MFA, PulseMFARequiredError), ), ) -async def test_login_failures(adt_pulse_instance, get_mocked_url, read_file, test_type): +async def test_login_failures( + adt_pulse_instance: tuple[PyADTPulseAsync, Any], + get_mocked_url: Callable[..., str], + read_file: Callable[..., str], + test_type: Literal[LoginType.FAIL, LoginType.NOT_SIGNED_IN, LoginType.MFA], +): p, response = await adt_pulse_instance assert p._pulse_connection.login_backoff.backoff_count == 0, "initial" add_logout(response, get_mocked_url, read_file) @@ -222,7 +239,11 @@ async def do_wait_for_update(p: PyADTPulseAsync, shutdown_event: asyncio.Event): @pytest.mark.asyncio -async def test_wait_for_update(adt_pulse_instance, get_mocked_url, read_file): +async def test_wait_for_update( + adt_pulse_instance: tuple[PyADTPulseAsync, Any], + get_mocked_url: Callable[..., str], + read_file: Callable[..., str], +): p, responses = await adt_pulse_instance shutdown_event = asyncio.Event() task = asyncio.create_task(do_wait_for_update(p, shutdown_event)) @@ -247,8 +268,14 @@ def make_sync_check_pattern(get_mocked_url): @pytest.mark.asyncio +@pytest.mark.parametrize("test_requests", (False, True)) @pytest.mark.timeout(60) -async def test_orb_update(adt_pulse_instance, get_mocked_url, read_file): +async def test_orb_update( + adt_pulse_instance: tuple[PyADTPulseAsync, Any], + get_mocked_url: Callable[..., str], + read_file: Callable[..., str], + test_requests: bool, +): p, response = await adt_pulse_instance pattern = make_sync_check_pattern(get_mocked_url) @@ -347,12 +374,15 @@ async def test_sync_check_and_orb(): assert code == 200 assert content == NEXT_SYNC_CHECK - setup_sync_check() # do a first run though to make sure aioresponses will work ok - await test_sync_check_and_orb() + if not test_requests: + setup_sync_check() + await test_sync_check_and_orb() + await p.async_logout() + assert p._sync_task is None + assert p._timeout_task is None + return await p.async_logout() - assert p._sync_task is None - assert p._timeout_task is None for j in range(2): if j == 0: zone = 11 @@ -371,25 +401,29 @@ async def test_sync_check_and_orb(): add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) await p.async_login() await p.wait_for_update() + await p.async_logout() assert len(p.site.zones) == 13 assert p.site.zones_as_dict[zone].state == state assert p._sync_task is not None - await p.async_logout() - - assert p._sync_task is None - assert p._timeout_task is None - # assert m.call_count == 2 @pytest.mark.asyncio -async def test_keepalive_check(adt_pulse_instance, get_mocked_url, read_file): +async def test_keepalive_check( + adt_pulse_instance: tuple[PyADTPulseAsync, Any], + get_mocked_url: Callable[..., str], + read_file: Callable[..., str], +): p, response = await adt_pulse_instance assert p._timeout_task is not None await asyncio.sleep(0) @pytest.mark.asyncio -async def test_infinite_sync_check(adt_pulse_instance, get_mocked_url, read_file): +async def test_infinite_sync_check( + adt_pulse_instance: tuple[PyADTPulseAsync, Any], + get_mocked_url: Callable[..., str], + read_file: Callable[..., str], +): p, response = await adt_pulse_instance pattern = re.compile(rf"{re.escape(get_mocked_url(ADT_SYNC_CHECK_URI))}/?.*$") response.get( @@ -408,7 +442,12 @@ async def test_infinite_sync_check(adt_pulse_instance, get_mocked_url, read_file @pytest.mark.asyncio -async def test_sync_check_errors(adt_pulse_instance, get_mocked_url, read_file, mocker): +async def test_sync_check_errors( + adt_pulse_instance: tuple[PyADTPulseAsync, Any], + get_mocked_url: Callable[..., str], + read_file: Callable[..., str], + mocker: Callable[..., Generator[MockerFixture, None, None]], +): p, response = await adt_pulse_instance pattern = re.compile(rf"{re.escape(get_mocked_url(ADT_SYNC_CHECK_URI))}/?.*$") @@ -443,7 +482,10 @@ async def test_sync_check_errors(adt_pulse_instance, get_mocked_url, read_file, @pytest.mark.asyncio async def test_multiple_login( - adt_pulse_instance, extract_ids_from_data_directory, get_mocked_url, read_file + adt_pulse_instance: tuple[PyADTPulseAsync, Any], + extract_ids_from_data_directory: list[str], + get_mocked_url: Callable[..., str], + read_file: Callable[..., str], ): p, response = await adt_pulse_instance add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) @@ -465,8 +507,11 @@ async def test_multiple_login( @pytest.mark.timeout(180) @pytest.mark.asyncio -async def test_gateway_offline(adt_pulse_instance, get_mocked_url, read_file): - p: PyADTPulseAsync +async def test_gateway_offline( + get_mocked_url: Callable[..., str], + read_file: Callable[..., str], + adt_pulse_instance: tuple[PyADTPulseAsync, Any], +): p, response = await adt_pulse_instance pattern = make_sync_check_pattern(get_mocked_url) response.get( @@ -509,17 +554,12 @@ async def test_gateway_offline(adt_pulse_instance, get_mocked_url, read_file): response.get( pattern, body=DEFAULT_SYNC_CHECK, content_type="text/html", repeat=True ) - add_signin(LoginType.SUCCESS, response, get_mocked_url, read_file) - await p.async_login() + add_logout(response, get_mocked_url, read_file) assert p.site.gateway.poll_interval == 2.0 # FIXME: why + 2? for i in range(num_backoffs + 2): - try: + with pytest.raises(PulseGatewayOfflineError): await p.wait_for_update() - except PulseGatewayOfflineError: - pass - except Exception: - pytest.fail("wait_for_update did not return PulseGatewayOfflineError") await p.wait_for_update() assert p.site.gateway.is_online @@ -529,20 +569,24 @@ async def test_gateway_offline(adt_pulse_instance, get_mocked_url, read_file): @pytest.mark.asyncio -async def test_not_logged_in(mocked_server_responses, get_mocked_url, read_file): +async def test_not_logged_in( + mocked_server_responses: aioresponses, + get_mocked_url: Callable[..., str], + read_file: Callable[..., str], +): p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) add_logout(mocked_server_responses, get_mocked_url, read_file) with pytest.raises(PulseNotLoggedInError): - await do_wait_for_update(p, asyncio.Event()) + await p.wait_for_update() with pytest.raises(PulseNotLoggedInError): - await do_wait_for_update(p, asyncio.Event()) + await p.wait_for_update() await p.async_login() await p.async_logout() with pytest.raises(PulseNotLoggedInError): - await do_wait_for_update(p, asyncio.Event()) + await p.wait_for_update() with pytest.raises(PulseNotLoggedInError): - await do_wait_for_update(p, asyncio.Event()) + await p.wait_for_update() add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) add_logout(mocked_server_responses, get_mocked_url, read_file) pattern = make_sync_check_pattern(get_mocked_url) @@ -559,16 +603,18 @@ async def test_not_logged_in(mocked_server_responses, get_mocked_url, read_file) with pytest.raises(PulseNotLoggedInError): await task with pytest.raises(PulseNotLoggedInError): - await do_wait_for_update(p, asyncio.Event()) + await p.wait_for_update() await asyncio.sleep(ADT_DEFAULT_POLL_INTERVAL * 2) with pytest.raises(PulseNotLoggedInError): - await do_wait_for_update(p, asyncio.Event()) + await p.wait_for_update() @pytest.mark.asyncio @pytest.mark.timeout(120) async def test_connection_fails_wait_for_update( - mocked_server_responses, get_mocked_url, read_file + mocked_server_responses: aioresponses, + get_mocked_url: Callable[..., str], + read_file: Callable[..., str], ): p = PyADTPulseAsync("testuser@example.com", "testpassword", "testfingerprint") add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) @@ -582,25 +628,21 @@ async def test_connection_fails_wait_for_update( await p.async_logout() -@pytest.mark.timeout(120) +@pytest.mark.timeout(180) @pytest.mark.asyncio -async def test_sync_check_disconnect(adt_pulse_instance, read_file, get_mocked_url): - p: PyADTPulseAsync +async def test_sync_check_disconnect( + adt_pulse_instance: tuple[PyADTPulseAsync, Any], + read_file: Callable[..., str], + get_mocked_url: Callable[..., str], +): p, responses = await adt_pulse_instance - add_signin(LoginType.SUCCESS, responses, get_mocked_url, read_file) add_logout(responses, get_mocked_url, read_file) - await p.async_login() pattern = make_sync_check_pattern(get_mocked_url) responses.get(pattern, body=DEFAULT_SYNC_CHECK, content_type="text/html") responses.get(get_mocked_url(ADT_ORB_URI), body=read_file("orb.html"), repeat=True) while p._pulse_connection_status.get_backoff().get_current_backoff_interval() < 15: - try: + with pytest.raises(PulseServerConnectionError): await p.wait_for_update() - except PulseServerConnectionError: - pass - except Exception: - pytest.fail("wait_for_update did not return PulseServerConnectionError") - # check recovery responses.get(pattern, body="1-0-0", content_type="text/html") responses.get( @@ -608,3 +650,41 @@ async def test_sync_check_disconnect(adt_pulse_instance, read_file, get_mocked_u ) await p.wait_for_update() await p.async_logout() + + +@pytest.mark.asyncio +@pytest.mark.timeout(60) +async def test_sync_check_relogin( + adt_pulse_instance: tuple[PyADTPulseAsync, Any], + get_mocked_url: Callable[..., str], + read_file: Callable[..., str], +): + p, responses = await adt_pulse_instance + pa: PulseAuthenticationProperties = p._authentication_properties + login_time = pa.last_login_time + # fail redirect + add_signin(LoginType.NOT_SIGNED_IN, responses, get_mocked_url, read_file) + # successful login afterward + add_signin(LoginType.SUCCESS, responses, get_mocked_url, read_file) + add_logout(responses, get_mocked_url, read_file) + pattern = make_sync_check_pattern(get_mocked_url) + for _ in range(3): + responses.get(pattern, body=DEFAULT_SYNC_CHECK, content_type="text/html") + responses.get( + pattern, + body="", + content_type="text/html", + status=307, + headers={"Location": get_mocked_url(ADT_LOGIN_URI)}, + ) + # resume normal operation + # signal update to stop wait for update + responses.get(pattern, body="1-0-0", content_type="text/html") + responses.get( + pattern, body=DEFAULT_SYNC_CHECK, content_type="text/html", repeat=True + ) + responses.get(get_mocked_url(ADT_ORB_URI), body=read_file("orb.html"), repeat=True) + + await p.wait_for_update() + assert p._authentication_properties.last_login_time > login_time + await p.async_logout() diff --git a/tests/test_pulse_connection.py b/tests/test_pulse_connection.py index f775123..ce2f5a7 100644 --- a/tests/test_pulse_connection.py +++ b/tests/test_pulse_connection.py @@ -93,8 +93,8 @@ async def test_multiple_login( with pytest.raises(PulseServerConnectionError): await pc.async_do_login_query() assert pc._login_backoff.backoff_count == 0 - # 2 retries first time, 3 the second - assert mock_sleep.call_count == MAX_REQUERY_RETRIES - 1 + MAX_REQUERY_RETRIES + # 2 retries first time, 1 for the connection backoff + assert mock_sleep.call_count == MAX_REQUERY_RETRIES assert pc.login_in_progress is False assert pc._connection_status.get_backoff().backoff_count == 2 @@ -102,8 +102,8 @@ async def test_multiple_login( assert not pc.is_connected add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await pc.async_do_login_query() - # will do a backoff, then query - assert mock_sleep.call_count == MAX_REQUERY_RETRIES - 1 + MAX_REQUERY_RETRIES + 1 + # will just to a connection backoff + assert mock_sleep.call_count == MAX_REQUERY_RETRIES + 1 assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 assert pc._connection_status.authenticated_flag.is_set() @@ -111,7 +111,7 @@ async def test_multiple_login( add_signin(LoginType.SUCCESS, mocked_server_responses, get_mocked_url, read_file) await pc.async_do_login_query() # shouldn't sleep at all - assert mock_sleep.call_count == MAX_REQUERY_RETRIES - 1 + MAX_REQUERY_RETRIES + 1 + assert mock_sleep.call_count == MAX_REQUERY_RETRIES + 1 assert pc.login_in_progress is False assert pc._login_backoff.backoff_count == 0 assert pc._connection_status.authenticated_flag.is_set() diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index 2158276..d7301bc 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -3,15 +3,19 @@ import asyncio import time from datetime import datetime, timedelta +from typing import Any, Callable import pytest from aiohttp import client_exceptions, client_reqrep +from aioresponses import aioresponses from bs4 import BeautifulSoup +from freezegun.api import FrozenDateTimeFactory, StepTickTimeFactory from conftest import MOCKED_API_VERSION from pyadtpulse.const import ADT_ORB_URI, DEFAULT_API_HOST from pyadtpulse.exceptions import ( PulseClientConnectionError, + PulseConnectionError, PulseServerConnectionError, PulseServiceTemporarilyUnavailableError, ) @@ -21,7 +25,7 @@ @pytest.mark.asyncio -async def test_fetch_version(mocked_server_responses): +async def test_fetch_version(mocked_server_responses: aioresponses): """Test fetch version.""" s = PulseConnectionStatus() cp = PulseConnectionProperties(DEFAULT_API_HOST) @@ -31,7 +35,7 @@ async def test_fetch_version(mocked_server_responses): @pytest.mark.asyncio -async def test_fetch_version_fail(mock_server_down): +async def test_fetch_version_fail(mock_server_down: aioresponses): """Test fetch version.""" s = PulseConnectionStatus() cp = PulseConnectionProperties(DEFAULT_API_HOST) @@ -46,7 +50,9 @@ async def test_fetch_version_fail(mock_server_down): @pytest.mark.asyncio -async def test_fetch_version_eventually_succeeds(mock_server_temporarily_down): +async def test_fetch_version_eventually_succeeds( + mock_server_temporarily_down: aioresponses, +): """Test fetch version.""" s = PulseConnectionStatus() cp = PulseConnectionProperties(DEFAULT_API_HOST) @@ -64,7 +70,10 @@ async def test_fetch_version_eventually_succeeds(mock_server_temporarily_down): @pytest.mark.asyncio async def test_query_orb( - mocked_server_responses, read_file, mock_sleep, get_mocked_connection_properties + mocked_server_responses: aioresponses, + read_file: Callable[..., str], + mock_sleep: Any, + get_mocked_connection_properties: PulseConnectionProperties, ): """Test query orb. @@ -104,10 +113,10 @@ async def query_orb_task(): @pytest.mark.asyncio async def test_retry_after( - mocked_server_responses, - freeze_time_to_now, - get_mocked_connection_properties, - mock_sleep, + mocked_server_responses: aioresponses, + freeze_time_to_now: FrozenDateTimeFactory | StepTickTimeFactory, + get_mocked_connection_properties: PulseConnectionProperties, + mock_sleep: Any, ): """Test retry after.""" @@ -199,144 +208,137 @@ async def test_retry_after( await p.async_query(ADT_ORB_URI, requires_authentication=False) -@pytest.mark.asyncio -async def test_async_query_exceptions( - mocked_server_responses, mock_sleep, get_mocked_connection_properties +async def run_query_exception_test( + mocked_server_responses, + mock_sleep, + get_mocked_connection_properties, + aiohttp_exception: client_exceptions.ClientError, + pulse_exception: PulseConnectionError, ): s = PulseConnectionStatus() cp = get_mocked_connection_properties p = PulseQueryManager(s, cp) - # test one exception - mocked_server_responses.get( - cp.make_url(ADT_ORB_URI), - exception=client_exceptions.ClientConnectionError(), - ) + # need to do ClientConnectorError, but it requires initialization + for _ in range(MAX_REQUERY_RETRIES + 1): + mocked_server_responses.get( + cp.make_url(ADT_ORB_URI), + exception=aiohttp_exception, + ) mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=200, ) - await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert mock_sleep.call_count == 1 - curr_sleep_count = mock_sleep.call_count + with pytest.raises(pulse_exception): + await p.async_query( + ADT_ORB_URI, + requires_authentication=False, + ) + + # only MAX_REQUERY_RETRIES - 1 sleeps since first call won't sleep + assert ( + mock_sleep.call_count == MAX_REQUERY_RETRIES - 1 + ), f"Failure on exception {aiohttp_exception.__name__}" + for i in range(MAX_REQUERY_RETRIES - 1): + assert mock_sleep.call_args_list[i][0][0] == 1 * 2 ** ( + i + ), f"Failure on exception sleep count {i} on exception {aiohttp_exception.__name__}" assert ( - mock_sleep.call_args_list[0][0][0] == s.get_backoff().initial_backoff_interval + s.get_backoff().backoff_count == 1 + ), f"Failure on exception {aiohttp_exception.__name__}" + with pytest.raises(pulse_exception): + await p.async_query(ADT_ORB_URI, requires_authentication=False) + # pqm backoff should trigger here + + # MAX_REQUERY_RETRIES - 1 backoff for query, 1 for connection backoff + assert mock_sleep.call_count == MAX_REQUERY_RETRIES + assert ( + mock_sleep.call_args_list[MAX_REQUERY_RETRIES - 1][0][0] + == s.get_backoff().initial_backoff_interval ) - assert s.get_backoff().backoff_count == 0 mocked_server_responses.get( cp.make_url(ADT_ORB_URI), status=200, ) + # this should trigger a sleep await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert mock_sleep.call_count == 1 - assert s.get_backoff().backoff_count == 0 - query_backoff = s.get_backoff().initial_backoff_interval - connector_errors = ( - client_exceptions.ClientConnectorError( - client_reqrep.ConnectionKey( - DEFAULT_API_HOST, - 443, - is_ssl=True, - ssl=True, - proxy=None, - proxy_auth=None, - proxy_headers_hash=None, - ), - os_error=error_type, - ) - for error_type in ( - ConnectionRefusedError, - ConnectionResetError, - TimeoutError, - BrokenPipeError, - ) + assert mock_sleep.call_count == MAX_REQUERY_RETRIES + 1 + assert ( + mock_sleep.call_args_list[MAX_REQUERY_RETRIES][0][0] + == s.get_backoff().initial_backoff_interval * 2 ) + # this shouldn't trigger a sleep + await p.async_query(ADT_ORB_URI, requires_authentication=False) + assert mock_sleep.call_count == MAX_REQUERY_RETRIES + 1 - # need to do ClientConnectorError, but it requires initialization - for ex in ( - client_exceptions.ClientConnectionError(), - client_exceptions.ClientError(), - client_exceptions.ClientOSError(), - client_exceptions.ServerDisconnectedError(), - client_exceptions.ServerTimeoutError(), - client_exceptions.ServerConnectionError(), - asyncio.TimeoutError(), - *connector_errors, - ): - print( - type( - ex, - ) - ) - if type(ex) in ( - client_exceptions.ClientConnectionError, - client_exceptions.ClientError, - client_exceptions.ClientOSError, - ): - error_type = PulseClientConnectionError - elif type(ex) == client_exceptions.ClientConnectorError and ex.os_error in ( - TimeoutError, - BrokenPipeError, - ): - error_type = PulseClientConnectionError - else: - error_type = PulseServerConnectionError - for _ in range(MAX_REQUERY_RETRIES + 1): - mocked_server_responses.get( - cp.make_url(ADT_ORB_URI), - exception=ex, - ) - mocked_server_responses.get( - cp.make_url(ADT_ORB_URI), - status=200, - ) - exc_info = None - try: - with pytest.raises(error_type) as exc_info: - await p.async_query( - ADT_ORB_URI, - requires_authentication=False, - ) - except AssertionError: - actual_error_type = exc_info.type if exc_info else None - message = f"Expected {error_type}, got {actual_error_type}" - pytest.fail(message) - - # only MAX_REQUERY_RETRIES - 1 sleeps since first call won't sleep - assert ( - mock_sleep.call_count == curr_sleep_count + MAX_REQUERY_RETRIES - 1 - ), f"Failure on exception {type(ex).__name__}" - assert mock_sleep.call_args_list[curr_sleep_count][0][0] == query_backoff - for i in range( - curr_sleep_count + 2, curr_sleep_count + MAX_REQUERY_RETRIES - 1 - ): - assert mock_sleep.call_args_list[i][0][0] == query_backoff * 2 ** ( - i - curr_sleep_count - ), f"Failure on exception sleep count {i} on exception {type(ex).__name__}" - curr_sleep_count += MAX_REQUERY_RETRIES - 1 - assert ( - s.get_backoff().backoff_count == 1 - ), f"Failure on exception {type(ex).__name__}" - backoff_sleep = s.get_backoff().get_current_backoff_interval() - await p.async_query(ADT_ORB_URI, requires_authentication=False) - # pqm backoff should trigger here - curr_sleep_count += 2 - # 1 backoff for query, 1 for connection backoff - assert mock_sleep.call_count == curr_sleep_count - assert mock_sleep.call_args_list[curr_sleep_count - 2][0][0] == backoff_sleep - assert mock_sleep.call_args_list[curr_sleep_count - 1][0][0] == backoff_sleep - assert s.get_backoff().backoff_count == 0 - mocked_server_responses.get( - cp.make_url(ADT_ORB_URI), - status=200, - ) - # this shouldn't trigger a sleep - await p.async_query(ADT_ORB_URI, requires_authentication=False) - assert mock_sleep.call_count == curr_sleep_count + +@pytest.mark.asyncio +@pytest.mark.parametrize( + "test_exception", + ( + (client_exceptions.ClientConnectionError, PulseClientConnectionError), + (client_exceptions.ClientError, PulseClientConnectionError), + (client_exceptions.ClientOSError, PulseClientConnectionError), + (client_exceptions.ServerDisconnectedError, PulseServerConnectionError), + (client_exceptions.ServerTimeoutError, PulseServerConnectionError), + (client_exceptions.ServerConnectionError, PulseServerConnectionError), + (asyncio.TimeoutError, PulseServerConnectionError), + ), +) +async def test_async_query_exceptions( + mocked_server_responses: aioresponses, + mock_sleep: Any, + get_mocked_connection_properties: PulseConnectionProperties, + test_exception, +): + await run_query_exception_test( + mocked_server_responses, + mock_sleep, + get_mocked_connection_properties, + *test_exception, + ) @pytest.mark.asyncio +@pytest.mark.parametrize( + "test_exception", + ( + (ConnectionRefusedError, PulseServerConnectionError), + (ConnectionResetError, PulseServerConnectionError), + (TimeoutError, PulseClientConnectionError), + (BrokenPipeError, PulseClientConnectionError), + ), +) +async def test_async_query_connector_errors( + mocked_server_responses: aioresponses, + mock_sleep: Any, + get_mocked_connection_properties: PulseConnectionProperties, + test_exception, +): + aiohttp_exception = client_exceptions.ClientConnectorError( + client_reqrep.ConnectionKey( + DEFAULT_API_HOST, + 443, + is_ssl=True, + ssl=True, + proxy=None, + proxy_auth=None, + proxy_headers_hash=None, + ), + os_error=test_exception[0], + ) + await run_query_exception_test( + mocked_server_responses, + mock_sleep, + get_mocked_connection_properties, + aiohttp_exception, + test_exception[1], + ) + + async def test_wait_for_authentication_flag( - mocked_server_responses, get_mocked_connection_properties, read_file + mocked_server_responses: aioresponses, + get_mocked_connection_properties: PulseConnectionProperties, + read_file: Callable[..., str], ): async def query_orb_task(lock: asyncio.Lock): async with lock: From 170cf88fd5975fc827ef66afb9ef8b79d28d1f61 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 28 Jan 2024 04:48:00 -0500 Subject: [PATCH 206/226] black changes --- conftest.py | 1 + pyadtpulse/pulse_connection_properties.py | 1 + pyadtpulse/pulse_query_manager.py | 1 + pyadtpulse/pyadtpulse_async.py | 1 + tests/test_pulse_async.py | 1 + tests/test_pulse_connection.py | 1 + 6 files changed, 6 insertions(+) diff --git a/conftest.py b/conftest.py index 06f8daa..8c38439 100644 --- a/conftest.py +++ b/conftest.py @@ -1,4 +1,5 @@ """Pulse Test Configuration.""" + import os import re import sys diff --git a/pyadtpulse/pulse_connection_properties.py b/pyadtpulse/pulse_connection_properties.py index e5cea6e..999d159 100644 --- a/pyadtpulse/pulse_connection_properties.py +++ b/pyadtpulse/pulse_connection_properties.py @@ -1,4 +1,5 @@ """Pulse connection info.""" + from asyncio import AbstractEventLoop from re import search diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index a31c751..de7ac5b 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -1,4 +1,5 @@ """Pulse Query Manager.""" + from logging import getLogger from asyncio import TimeoutError, wait_for from datetime import datetime diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 3bf363d..08ed6b3 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -1,4 +1,5 @@ """ADT Pulse Async API.""" + import logging import asyncio import re diff --git a/tests/test_pulse_async.py b/tests/test_pulse_async.py index eb878b9..63aba61 100644 --- a/tests/test_pulse_async.py +++ b/tests/test_pulse_async.py @@ -1,4 +1,5 @@ """Test Pulse Query Manager.""" + import asyncio import re from collections.abc import Generator diff --git a/tests/test_pulse_connection.py b/tests/test_pulse_connection.py index ce2f5a7..1ec6688 100644 --- a/tests/test_pulse_connection.py +++ b/tests/test_pulse_connection.py @@ -1,4 +1,5 @@ """Test Pulse Connection.""" + import asyncio import datetime From 70fc0b403575480849761c409c5dc0284eef99be Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 28 Jan 2024 04:50:20 -0500 Subject: [PATCH 207/226] more black fixes --- pyadtpulse/const.py | 1 + pyadtpulse/exceptions.py | 1 + pyadtpulse/pulse_authentication_properties.py | 1 + pyadtpulse/pulse_backoff.py | 1 + pyadtpulse/pulse_connection_status.py | 1 + pyadtpulse/pyadtpulse_properties.py | 1 + pyadtpulse/site.py | 1 + pyadtpulse/site_properties.py | 1 + pyadtpulse/util.py | 1 + pyadtpulse/zones.py | 1 + 10 files changed, 10 insertions(+) diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 7a5ff75..571f1b9 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -1,4 +1,5 @@ """Constants for pyadtpulse.""" + __version__ = "1.2.0b2" diff --git a/pyadtpulse/exceptions.py b/pyadtpulse/exceptions.py index 1c9a958..aef984d 100644 --- a/pyadtpulse/exceptions.py +++ b/pyadtpulse/exceptions.py @@ -1,4 +1,5 @@ """Pulse exceptions.""" + import datetime from time import time diff --git a/pyadtpulse/pulse_authentication_properties.py b/pyadtpulse/pulse_authentication_properties.py index f3eacf2..5d0f98f 100644 --- a/pyadtpulse/pulse_authentication_properties.py +++ b/pyadtpulse/pulse_authentication_properties.py @@ -1,4 +1,5 @@ """Pulse Authentication Properties.""" + from re import match from typeguard import typechecked diff --git a/pyadtpulse/pulse_backoff.py b/pyadtpulse/pulse_backoff.py index 606565a..9c3278c 100644 --- a/pyadtpulse/pulse_backoff.py +++ b/pyadtpulse/pulse_backoff.py @@ -1,4 +1,5 @@ """Pulse backoff object.""" + import asyncio import datetime from logging import getLogger diff --git a/pyadtpulse/pulse_connection_status.py b/pyadtpulse/pulse_connection_status.py index de57c31..288a8b0 100644 --- a/pyadtpulse/pulse_connection_status.py +++ b/pyadtpulse/pulse_connection_status.py @@ -1,4 +1,5 @@ """Pulse Connection Status.""" + from asyncio import Event from typeguard import typechecked diff --git a/pyadtpulse/pyadtpulse_properties.py b/pyadtpulse/pyadtpulse_properties.py index 2d01198..d4a1a73 100644 --- a/pyadtpulse/pyadtpulse_properties.py +++ b/pyadtpulse/pyadtpulse_properties.py @@ -1,4 +1,5 @@ """PyADTPulse Properties.""" + import logging import asyncio from warnings import warn diff --git a/pyadtpulse/site.py b/pyadtpulse/site.py index 517b49b..f9afe59 100644 --- a/pyadtpulse/site.py +++ b/pyadtpulse/site.py @@ -1,4 +1,5 @@ """Module representing an ADT Pulse Site.""" + import logging import re from asyncio import Task, create_task, gather, get_event_loop, run_coroutine_threadsafe diff --git a/pyadtpulse/site_properties.py b/pyadtpulse/site_properties.py index e747038..4313c84 100644 --- a/pyadtpulse/site_properties.py +++ b/pyadtpulse/site_properties.py @@ -1,4 +1,5 @@ """Pulse Site Properties.""" + from threading import RLock from warnings import warn diff --git a/pyadtpulse/util.py b/pyadtpulse/util.py index e478870..dd1e361 100644 --- a/pyadtpulse/util.py +++ b/pyadtpulse/util.py @@ -1,4 +1,5 @@ """Utility functions for pyadtpulse.""" + import logging import string import sys diff --git a/pyadtpulse/zones.py b/pyadtpulse/zones.py index f875891..f1a9942 100644 --- a/pyadtpulse/zones.py +++ b/pyadtpulse/zones.py @@ -1,4 +1,5 @@ """ADT Pulse zone info.""" + import logging from collections import UserDict from dataclasses import dataclass From 63c117cea99356681556eed7fc17a2457142ffe4 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 28 Jan 2024 04:55:24 -0500 Subject: [PATCH 208/226] more black fixes --- conftest.py | 16 ++++++++++------ tests/test_backoff.py | 1 + tests/test_pulse_query_manager.py | 1 + 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/conftest.py b/conftest.py index 8c38439..da932af 100644 --- a/conftest.py +++ b/conftest.py @@ -367,9 +367,11 @@ def handle_service_unavailable(path: str) -> web.Response | None: return web.Response( text="Service Unavailable", status=self.status_code, - headers={"Retry-After": self.retry_after_header} - if self.retry_after_header - else None, + headers=( + {"Retry-After": self.retry_after_header} + if self.retry_after_header + else None + ), ) return None @@ -382,9 +384,11 @@ def handle_rate_limit_exceeded(path: str) -> web.Response | None: return web.Response( text="Rate Limit Exceeded", status=self.status_code, - headers={"Retry-After": self.retry_after_header} - if self.retry_after_header - else None, + headers=( + {"Retry-After": self.retry_after_header} + if self.retry_after_header + else None + ), ) return None diff --git a/tests/test_backoff.py b/tests/test_backoff.py index e0e048f..29fa88e 100644 --- a/tests/test_backoff.py +++ b/tests/test_backoff.py @@ -1,4 +1,5 @@ """Test for pulse_backoff.""" + from time import time import pytest diff --git a/tests/test_pulse_query_manager.py b/tests/test_pulse_query_manager.py index d7301bc..0441664 100644 --- a/tests/test_pulse_query_manager.py +++ b/tests/test_pulse_query_manager.py @@ -1,4 +1,5 @@ """Test Pulse Query Manager.""" + import logging import asyncio import time From d02b131e06fda28acceed81f11538e3d4d1d4d1d Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Sun, 28 Jan 2024 05:00:28 -0500 Subject: [PATCH 209/226] more black fixes --- tests/test_zones.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/tests/test_zones.py b/tests/test_zones.py index a6a14c8..b7e19db 100644 --- a/tests/test_zones.py +++ b/tests/test_zones.py @@ -1081,9 +1081,7 @@ def test_invalid_zone_data_in_flattening(self): zones[2] = ADTPulseZoneData("Zone 2", "sensor-2") zones[3] = ADTPulseZoneData("Zone 3", "sensor-3") with pytest.raises(TypeCheckError): - zones[ - 3 - ].tags = "Invalid Tags" # Modify one of the zone data to an invalid type + zones[3].tags = "Invalid Tags" # ADTPulseZones skips incomplete zone data when updating zone attributes def test_skips_incomplete_zone_data(self): From 77a86b15f6415fee2b9f6cde78f753704f56a7d0 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 29 Jan 2024 02:08:10 -0500 Subject: [PATCH 210/226] more robust exception handling in example-client --- example-client.py | 89 +++++++++++++++++++++++++++++------------- pyadtpulse/__init__.py | 1 - 2 files changed, 62 insertions(+), 28 deletions(-) diff --git a/example-client.py b/example-client.py index 839a255..5402246 100755 --- a/example-client.py +++ b/example-client.py @@ -7,7 +7,7 @@ import json import sys from pprint import pprint -from time import sleep +from time import sleep, time from pyadtpulse import PyADTPulse from pyadtpulse.const import ( @@ -19,9 +19,12 @@ ) from pyadtpulse.exceptions import ( PulseAuthenticationError, + PulseClientConnectionError, PulseConnectionError, PulseGatewayOfflineError, PulseLoginException, + PulseServerConnectionError, + PulseServiceTemporarilyUnavailableError, ) from pyadtpulse.site import ADTPulseSite @@ -391,23 +394,35 @@ def sync_example( relogin_interval (int): relogin interval in minutes detailed_debug_logging (bool): True to enable detailed debug logging """ - try: - adt = PyADTPulse( - username, - password, - fingerprint, - debug_locks=debug_locks, - keepalive_interval=keepalive_interval, - relogin_interval=relogin_interval, - detailed_debug_logging=detailed_debug_logging, - ) - except PulseLoginException as ex: - print("Error connecting to ADT Pulse site: %s", ex.args[0]) - sys.exit() - except BaseException as e: - print("Received exception logging into ADT Pulse site") - print(str(e)) - sys.exit() + while True: + try: + adt = PyADTPulse( + username, + password, + fingerprint, + debug_locks=debug_locks, + keepalive_interval=keepalive_interval, + relogin_interval=relogin_interval, + detailed_debug_logging=detailed_debug_logging, + ) + break + except PulseLoginException as e: + print(f"ADT Pulse login failed with authentication error: {e}") + return + except (PulseClientConnectionError, PulseServerConnectionError) as e: + backoff_interval = e.backoff.get_current_backoff_interval() + print( + f"ADT Pulse login failed with connection error: {e}, retrying in {backoff_interval} seconds" + ) + sleep(backoff_interval) + continue + except PulseServiceTemporarilyUnavailableError as e: + backoff_interval = e.backoff.expiration_time - time() + print( + f"ADT Pulse login failed with service unavailable error: {e}, retrying in {backoff_interval} seconds" + ) + sleep(backoff_interval) + continue if not adt.is_connected: print("Error: Could not log into ADT Pulse site") @@ -622,11 +637,27 @@ async def async_example( detailed_debug_logging=detailed_debug_logging, ) - try: - await adt.async_login() - except Exception as e: - print("ADT Pulse login failed with error: %s", e) - return + while True: + try: + await adt.async_login() + break + except PulseLoginException as e: + print(f"ADT Pulse login failed with authentication error: {e}") + return + except (PulseClientConnectionError, PulseServerConnectionError) as e: + backoff_interval = e.backoff.get_current_backoff_interval() + print( + f"ADT Pulse login failed with connection error: {e}, retrying in {backoff_interval} seconds" + ) + await asyncio.sleep(backoff_interval) + continue + except PulseServiceTemporarilyUnavailableError as e: + backoff_interval = e.backoff.expiration_time - time() + print( + f"ADT Pulse login failed with service unavailable error: {e}, retrying in {backoff_interval} seconds" + ) + await asyncio.sleep(backoff_interval) + continue if not adt.is_connected: print("Error: could not log into ADT Pulse site") @@ -661,11 +692,15 @@ async def async_example( pprint(adt.site.zones, compact=True) try: await adt.wait_for_update() - except PulseGatewayOfflineError: - print("ADT Pulse gateway is offline, re-polling") + except PulseGatewayOfflineError as ex: + print( + f"ADT Pulse gateway is offline, re-polling in {ex.backoff.get_current_backoff_interval()}" + ) continue - except PulseConnectionError as ex: - print("ADT Pulse connection error: %s, re-polling", ex.args[0]) + except (PulseClientConnectionError, PulseServerConnectionError) as ex: + print( + f"ADT Pulse connection error: {ex.args[0]}, re-polling in {ex.backoff.get_current_backoff_interval()}" + ) continue except PulseAuthenticationError as ex: print("ADT Pulse authentication error: %s, exiting...", ex.args[0]) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 13e7480..6345efe 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -6,7 +6,6 @@ from threading import RLock, Thread import uvloop -from aiohttp import ClientSession from .const import ( ADT_DEFAULT_HTTP_USER_AGENT, From a7c85db75168e545803f6d980fe0759cbd07efe1 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 29 Jan 2024 02:09:34 -0500 Subject: [PATCH 211/226] add deprecation warning to sync api --- pyadtpulse/__init__.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/pyadtpulse/__init__.py b/pyadtpulse/__init__.py index 6345efe..a5e4bb5 100644 --- a/pyadtpulse/__init__.py +++ b/pyadtpulse/__init__.py @@ -4,6 +4,7 @@ import asyncio import time from threading import RLock, Thread +from warnings import warn import uvloop @@ -40,6 +41,11 @@ def __init__( self._p_attribute_lock = set_debug_lock( debug_locks, "pyadtpulse._p_attribute_lockattribute_lock" ) + warn( + "PyADTPulse is deprecated, please use PyADTPulseAsync instead", + DeprecationWarning, + stacklevel=2, + ) super().__init__( username, password, From 3723fda66a01b51d628967bf498a1007d6fca5ca Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 29 Jan 2024 02:39:09 -0500 Subject: [PATCH 212/226] fix have_updates in sync_check --- pyadtpulse/pyadtpulse_async.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 08ed6b3..2c4a184 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -499,8 +499,12 @@ async def shutdown_task(ex: Exception): if response_text is None: LOG.warning("Sync check received no response from ADT Pulse site") continue + no_more_updates = False try: - have_updates = check_sync_check_response() + if have_updates: + no_more_updates = check_sync_check_response() + else: + have_updates = check_sync_check_response() except PulseNotLoggedInError: LOG.info("Pulse sync check indicates logged out, re-logging in....") self._pulse_connection.quick_logout() @@ -517,7 +521,7 @@ async def shutdown_task(ex: Exception): ) await shutdown_task(ex) return - if have_updates: + if have_updates and not no_more_updates: LOG.debug("Updates exist: %s, requerying", response_text) continue await handle_no_updates_exist() From 1fc4c378dbb2c5461c3ce073c0c9f31551be1095 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 29 Jan 2024 03:01:22 -0500 Subject: [PATCH 213/226] don't print info if have exception in example_client --- example-client.py | 42 ++++++++++++++++++++++++++---------------- 1 file changed, 26 insertions(+), 16 deletions(-) diff --git a/example-client.py b/example-client.py index 5402246..9bf917b 100755 --- a/example-client.py +++ b/example-client.py @@ -447,28 +447,33 @@ def sync_example( test_alarm(adt.site, adt) done = False + have_exception = False while not done: try: - print_site(adt.site) - print("----") - if not adt.site.zones: - print("Error, no zones exist, exiting...") - done = True - break + if not have_exception: + print_site(adt.site) + print("----") + if not adt.site.zones: + print("Error, no zones exist, exiting...") + done = True + break have_updates = False try: have_updates = adt.updates_exist + have_exception = False except PulseGatewayOfflineError: print("ADT Pulse gateway is offline, re-polling") + have_exception = True continue except PulseConnectionError as ex: print("ADT Pulse connection error: %s, re-polling", ex.args[0]) + have_exception = True continue except PulseAuthenticationError as ex: print("ADT Pulse authentication error: %s, exiting...", ex.args[0]) done = True break - if have_updates: + if have_updates and not have_exception: print("Updates exist, refreshing") # Don't need to explicitly call update() anymore # Background thread will already have updated @@ -679,28 +684,33 @@ async def async_example( await async_test_alarm(adt) done = False + have_exception = False while not done: try: - print(f"Gateway online: {adt.site.gateway.is_online}") - print_site(adt.site) - print("----") - if not adt.site.zones: - print("No zones exist, exiting...") - done = True - break - print("\nZones:") - pprint(adt.site.zones, compact=True) + if not have_exception: + print(f"Gateway online: {adt.site.gateway.is_online}") + print_site(adt.site) + print("----") + if not adt.site.zones: + print("No zones exist, exiting...") + done = True + break + print("\nZones:") + pprint(adt.site.zones, compact=True) try: await adt.wait_for_update() + have_exception = False except PulseGatewayOfflineError as ex: print( f"ADT Pulse gateway is offline, re-polling in {ex.backoff.get_current_backoff_interval()}" ) + have_exception = True continue except (PulseClientConnectionError, PulseServerConnectionError) as ex: print( f"ADT Pulse connection error: {ex.args[0]}, re-polling in {ex.backoff.get_current_backoff_interval()}" ) + have_exception = True continue except PulseAuthenticationError as ex: print("ADT Pulse authentication error: %s, exiting...", ex.args[0]) From 73c31dff761183e3241cdf73b8a613b3e325c7fc Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 29 Jan 2024 03:12:16 -0500 Subject: [PATCH 214/226] don't do gateway backoff if we have an update --- pyadtpulse/pyadtpulse_async.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 2c4a184..b36c043 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -458,7 +458,9 @@ async def shutdown_task(ex: Exception): while True: try: - await self.site.gateway.backoff.wait_for_backoff() + if not have_updates: + # gateway going back online will trigger a sync check of 1-0-0 + await self.site.gateway.backoff.wait_for_backoff() pi = ( self.site.gateway.poll_interval if not have_updates or not self.site.gateway.backoff.will_backoff() From 366b2cce2986026819610bf9fdf0365fe2e8223e Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 29 Jan 2024 03:26:42 -0500 Subject: [PATCH 215/226] fix sync check requery --- pyadtpulse/pyadtpulse_async.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index b36c043..734b185 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -501,10 +501,10 @@ async def shutdown_task(ex: Exception): if response_text is None: LOG.warning("Sync check received no response from ADT Pulse site") continue - no_more_updates = False + more_updates = True try: if have_updates: - no_more_updates = check_sync_check_response() + more_updates = check_sync_check_response() else: have_updates = check_sync_check_response() except PulseNotLoggedInError: @@ -523,7 +523,7 @@ async def shutdown_task(ex: Exception): ) await shutdown_task(ex) return - if have_updates and not no_more_updates: + if have_updates and more_updates: LOG.debug("Updates exist: %s, requerying", response_text) continue await handle_no_updates_exist() From 9c37b96620460b4a933699a001d186d9d49b59d2 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Mon, 29 Jan 2024 03:59:48 -0500 Subject: [PATCH 216/226] revert clear_session() --- pyadtpulse/pulse_connection.py | 6 +++--- pyadtpulse/pulse_connection_properties.py | 5 ++++- pyadtpulse/pulse_query_manager.py | 2 +- pyadtpulse/pyadtpulse_async.py | 12 ++++++------ 4 files changed, 14 insertions(+), 11 deletions(-) diff --git a/pyadtpulse/pulse_connection.py b/pyadtpulse/pulse_connection.py index 1ea6bc6..7863e50 100644 --- a/pyadtpulse/pulse_connection.py +++ b/pyadtpulse/pulse_connection.py @@ -193,7 +193,7 @@ async def async_do_login_query( if self.login_in_progress: return None - self.quick_logout() + await self.quick_logout() # just raise exceptions if we're not going to be able to log in lockout_time = self._login_backoff.expiration_time if lockout_time > time(): @@ -296,14 +296,14 @@ def login_in_progress(self, value: bool) -> None: with self._pc_attribute_lock: self._login_in_progress = value - def quick_logout(self) -> None: + async def quick_logout(self) -> None: """Quickly logout. This just resets the authenticated flag and clears the ClientSession. """ LOG.debug("Resetting session") self._connection_status.authenticated_flag.clear() - self._connection_properties.clear_session() + await self._connection_properties.clear_session() @property def detailed_debug_logging(self) -> bool: diff --git a/pyadtpulse/pulse_connection_properties.py b/pyadtpulse/pulse_connection_properties.py index 999d159..6342ff0 100644 --- a/pyadtpulse/pulse_connection_properties.py +++ b/pyadtpulse/pulse_connection_properties.py @@ -229,7 +229,10 @@ def make_url(self, uri: str) -> str: with self._pci_attribute_lock: return f"{self._api_host}{API_PREFIX}{self._api_version}{uri}" - def clear_session(self): + async def clear_session(self): """Clear the session.""" with self._pci_attribute_lock: + old_session = self._session self._session = None + if old_session: + await old_session.close() diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index de7ac5b..b05f790 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -1,7 +1,7 @@ """Pulse Query Manager.""" from logging import getLogger -from asyncio import TimeoutError, wait_for +from asyncio import wait_for from datetime import datetime from http import HTTPStatus from time import time diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index 734b185..f0f100e 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -258,7 +258,7 @@ def should_relogin(relogin_interval: int) -> bool: LOG.debug("%s: Skipping relogin because not connected", task_name) continue elif should_relogin(relogin_interval): - self._pulse_connection.quick_logout() + await self._pulse_connection.quick_logout() try: await self._login_looped(task_name) except (PulseAuthenticationError, PulseMFARequiredError) as ex: @@ -429,7 +429,7 @@ async def handle_no_updates_exist() -> None: "Pulse update failed in task %s due to not logged in, relogging in...", task_name, ) - self._pulse_connection.quick_logout() + await self._pulse_connection.quick_logout() await self._login_looped(task_name) return if not success: @@ -452,7 +452,7 @@ async def handle_no_updates_exist() -> None: ) async def shutdown_task(ex: Exception): - self._pulse_connection.quick_logout() + await self._pulse_connection.quick_logout() await self._cancel_task(self._timeout_task) self._set_update_exception(ex) @@ -509,7 +509,7 @@ async def shutdown_task(ex: Exception): have_updates = check_sync_check_response() except PulseNotLoggedInError: LOG.info("Pulse sync check indicates logged out, re-logging in....") - self._pulse_connection.quick_logout() + await self._pulse_connection.quick_logout() await self._login_looped(task_name) except ( PulseAuthenticationError, @@ -557,7 +557,7 @@ async def async_login(self) -> None: await self._pulse_connection.async_fetch_version() soup = await self._pulse_connection.async_do_login_query() if soup is None: - self._pulse_connection.quick_logout() + await self._pulse_connection.quick_logout() ex = PulseNotLoggedInError() self.sync_check_exception = ex raise ex @@ -571,7 +571,7 @@ async def async_login(self) -> None: await self._update_sites(soup) if self._site is None: LOG.error("Could not retrieve any sites, login failed") - self._pulse_connection.quick_logout() + await self._pulse_connection.quick_logout() ex = PulseNotLoggedInError() self.sync_check_exception = ex raise ex From e81d0d72274ab7d8d6953515348de48fbe5f2989 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 30 Jan 2024 04:54:36 -0500 Subject: [PATCH 217/226] fix some logging statements --- pyadtpulse/gateway.py | 9 +++++++-- pyadtpulse/pulse_query_manager.py | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/pyadtpulse/gateway.py b/pyadtpulse/gateway.py index 2ef3045..db22c30 100644 --- a/pyadtpulse/gateway.py +++ b/pyadtpulse/gateway.py @@ -93,9 +93,14 @@ def is_online(self, status: bool) -> None: self._status_text = "OFFLINE" LOG.info( - "ADT Pulse gateway %s, poll interval=%f", + "ADT Pulse gateway %s", self._status_text, - self.backoff.get_current_backoff_interval(), + ) + LOG.debug( + "Gateway poll interval: %d", + self.backoff.initial_backoff_interval + if self._status_text == "ONLINE" + else self.backoff.get_current_backoff_interval(), ) @property diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index b05f790..a2dc17f 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -308,7 +308,7 @@ async def setup_query(): self._get_http_status_description(return_value[0]), retry, ) - if retry == max_retries: + if max_retries > 1 and retry == max_retries: LOG.debug( "Exceeded max retries of %d, giving up", max_retries ) From e5393daa8d095cbf766166e19802f4d980497ce5 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 30 Jan 2024 04:56:08 -0500 Subject: [PATCH 218/226] bump version to 1.2.0b3 --- pyadtpulse/const.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 571f1b9..969fb4f 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -1,6 +1,6 @@ """Constants for pyadtpulse.""" -__version__ = "1.2.0b2" +__version__ = "1.2.0b3" DEFAULT_API_HOST = "https://portal.adtpulse.com" diff --git a/pyproject.toml b/pyproject.toml index 8b2bc32..5df2a12 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "pyadtpulse" -version = "1.2.0b2" +version = "1.2.0b3" description = "Python interface for ADT Pulse security systems" authors = ["Ryan Snodgrass"] maintainers = ["Robert Lippmann"] From d66a9f168dd322f96e4b8ec69b679992e5a04225 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 30 Jan 2024 04:59:06 -0500 Subject: [PATCH 219/226] black fix --- pyadtpulse/gateway.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/pyadtpulse/gateway.py b/pyadtpulse/gateway.py index db22c30..b1df03c 100644 --- a/pyadtpulse/gateway.py +++ b/pyadtpulse/gateway.py @@ -98,9 +98,11 @@ def is_online(self, status: bool) -> None: ) LOG.debug( "Gateway poll interval: %d", - self.backoff.initial_backoff_interval - if self._status_text == "ONLINE" - else self.backoff.get_current_backoff_interval(), + ( + self.backoff.initial_backoff_interval + if self._status_text == "ONLINE" + else self.backoff.get_current_backoff_interval() + ), ) @property From d3f536dbf8eeb945fc261716629560a65556af2e Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Tue, 30 Jan 2024 07:52:07 -0500 Subject: [PATCH 220/226] more log fixes --- pyadtpulse/pulse_query_manager.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyadtpulse/pulse_query_manager.py b/pyadtpulse/pulse_query_manager.py index a2dc17f..abfb3eb 100644 --- a/pyadtpulse/pulse_query_manager.py +++ b/pyadtpulse/pulse_query_manager.py @@ -343,7 +343,7 @@ async def setup_query(): if retry == max_retries: LOG.debug("Exceeded max retries of %d, giving up", max_retries) raise PulseServerConnectionError( - f"Exceeded max retries of {max_retries}, giving up", + "Timeout error", self._connection_status.get_backoff(), ) from ex query_backoff.increment_backoff() From 8adb8fbfdfbe17e2a6ab7f614e11f7b050e006fd Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Wed, 31 Jan 2024 01:09:09 -0500 Subject: [PATCH 221/226] update changelog --- CHANGELOG.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index da6bda8..100df2e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,11 @@ +## 1.2.0 (2024-01-30) + +* add exceptions and exception handling +* make code more robust for error handling +* refactor code into smaller objects +* add testing framework +* add poetry + ## 1.1.3 (2023-10-11) * revert sync check logic to check against last check value. this should hopefully fix the problem of HA alarm status not updating From bd38fcdb6ffc0873feb7c69b8252bfaf7b32d846 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Thu, 1 Feb 2024 01:45:56 -0500 Subject: [PATCH 222/226] have gateway reset its backoff when it goes back online --- pyadtpulse/gateway.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pyadtpulse/gateway.py b/pyadtpulse/gateway.py index b1df03c..cb8c67b 100644 --- a/pyadtpulse/gateway.py +++ b/pyadtpulse/gateway.py @@ -87,7 +87,7 @@ def is_online(self, status: bool) -> None: with self._attribute_lock: if status == self.is_online: return - + old_status = self._status_text self._status_text = "ONLINE" if not status: self._status_text = "OFFLINE" @@ -96,6 +96,8 @@ def is_online(self, status: bool) -> None: "ADT Pulse gateway %s", self._status_text, ) + if old_status == "OFFLINE": + self.backoff.reset_backoff() LOG.debug( "Gateway poll interval: %d", ( From 583fa20664ab4edbd1a914d2ee927975db0cf9bf Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Thu, 1 Feb 2024 01:51:04 -0500 Subject: [PATCH 223/226] fix gateway backoff in sync task --- pyadtpulse/pyadtpulse_async.py | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/pyadtpulse/pyadtpulse_async.py b/pyadtpulse/pyadtpulse_async.py index f0f100e..360087f 100644 --- a/pyadtpulse/pyadtpulse_async.py +++ b/pyadtpulse/pyadtpulse_async.py @@ -458,15 +458,13 @@ async def shutdown_task(ex: Exception): while True: try: - if not have_updates: + if not have_updates and not self.site.gateway.is_online: # gateway going back online will trigger a sync check of 1-0-0 await self.site.gateway.backoff.wait_for_backoff() - pi = ( - self.site.gateway.poll_interval - if not have_updates or not self.site.gateway.backoff.will_backoff() - else 0.0 - ) - await asyncio.sleep(pi) + else: + await asyncio.sleep( + self.site.gateway.poll_interval if not have_updates else 0.0 + ) try: code, response_text, url = await perform_sync_check_query() From 2db7a7fbebcfd3491e9d3ba86fe3f4fe76179a66 Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Thu, 1 Feb 2024 01:51:52 -0500 Subject: [PATCH 224/226] bump version to 1.2.0b4 --- pyadtpulse/const.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 969fb4f..3687137 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -1,6 +1,6 @@ """Constants for pyadtpulse.""" -__version__ = "1.2.0b3" +__version__ = "1.2.0b4" DEFAULT_API_HOST = "https://portal.adtpulse.com" diff --git a/pyproject.toml b/pyproject.toml index 5df2a12..404a7d0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "pyadtpulse" -version = "1.2.0b3" +version = "1.2.0b4" description = "Python interface for ADT Pulse security systems" authors = ["Ryan Snodgrass"] maintainers = ["Robert Lippmann"] From 3387ec501400e86c81422b9fb4369e22b1b3f55d Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 2 Feb 2024 02:31:51 -0500 Subject: [PATCH 225/226] bump version to 1.2.0 --- pyadtpulse/const.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyadtpulse/const.py b/pyadtpulse/const.py index 3687137..338af4c 100644 --- a/pyadtpulse/const.py +++ b/pyadtpulse/const.py @@ -1,6 +1,6 @@ """Constants for pyadtpulse.""" -__version__ = "1.2.0b4" +__version__ = "1.2.0" DEFAULT_API_HOST = "https://portal.adtpulse.com" diff --git a/pyproject.toml b/pyproject.toml index 404a7d0..ce39162 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "pyadtpulse" -version = "1.2.0b4" +version = "1.2.0" description = "Python interface for ADT Pulse security systems" authors = ["Ryan Snodgrass"] maintainers = ["Robert Lippmann"] From 764d981afaac93583c08fe3d79781f8a773e633d Mon Sep 17 00:00:00 2001 From: Robert Lippmann Date: Fri, 2 Feb 2024 03:08:18 -0500 Subject: [PATCH 226/226] add 1.1.4 and 1.1.5 changelog --- CHANGELOG.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 100df2e..79142ab 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,14 @@ * add testing framework * add poetry +## 1.1.5 (2023-12-22) + +* fix more zone html parsing due to changes in Pulse v27 + +## 1.1.4 (2023-12-13) + +* fix zone html parsing due to changes in Pulse v27 + ## 1.1.3 (2023-10-11) * revert sync check logic to check against last check value. this should hopefully fix the problem of HA alarm status not updating