locust-cloud 1.14.5__py3-none-any.whl → 1.15.2__py3-none-any.whl

locust_cloud/cloud.py

@@ -1,11 +1,14 @@
 import logging
 import os
 import sys
+import webbrowser
+from threading import Thread
 
 import requests
 from locust_cloud.apisession import ApiSession
 from locust_cloud.args import parse_known_args
 from locust_cloud.common import __version__
+from locust_cloud.input_events import input_listener
 from locust_cloud.web_login import web_login
 from locust_cloud.websocket import SessionMismatchError, Websocket, WebsocketTimeout
 
@@ -13,11 +16,13 @@ logger = logging.getLogger(__name__)
 
 
 def configure_logging(loglevel: str) -> None:
-    logging.basicConfig(
-        format="[LOCUST-CLOUD] %(levelname)s: %(message)s",
-        level=loglevel,
+    format = (
+        "[%(asctime)s] %(levelname)s: %(message)s"
+        if loglevel == "INFO"
+        else "[%(asctime)s] %(levelname)s/%(module)s: %(message)s"
     )
-    # Restore log level for other libs. Yes, this can be done more nicely
+    logging.basicConfig(format=format, level=loglevel)
+    # Restore log level for other libs. Yes, this can probably be done more nicely
     logging.getLogger("requests").setLevel(logging.INFO)
     logging.getLogger("urllib3").setLevel(logging.INFO)
 
@@ -88,22 +93,30 @@ def main() -> None:
 
         try:
             response = session.post("/deploy", json=payload)
+            js = response.json()
         except requests.exceptions.RequestException as e:
             logger.error(f"Failed to deploy the load generators: {e}")
             sys.exit(1)
 
         if response.status_code != 200:
             try:
-                logger.error(f"{response.json()['Message']} (HTTP {response.status_code}/{response.reason})")
+                logger.error(f"{js['Message']} (HTTP {response.status_code}/{response.reason})")
             except Exception:
                 logger.error(
                     f"HTTP {response.status_code}/{response.reason} - Response: {response.text} - URL: {response.request.url}"
                 )
             sys.exit(1)
 
-        log_ws_url = response.json()["log_ws_url"]
-        session_id = response.json()["session_id"]
-        logger.debug(f"Session ID is {session_id}")
+        log_ws_url = js["log_ws_url"]
+        session_id = js["session_id"]
+        webui_url = log_ws_url.replace("/socket-logs", "")
+
+        def open_ui():
+            webbrowser.open_new_tab(webui_url)
+
+        Thread(target=input_listener({"\r": open_ui, "\n": open_ui}), daemon=True).start()
+
+        # logger.debug(f"Session ID is {session_id}")
 
         logger.info("Waiting for load generators to be ready...")
         websocket.connect(
@@ -147,7 +160,7 @@ def delete(session):
         )
 
         if response.status_code == 200:
-            logger.debug(response.json()["message"])
+            logger.debug(f"Response message from teardown: {response.json()['message']}")
         else:
             logger.info(
                 f"Could not automatically tear down Locust Cloud: HTTP {response.status_code}/{response.reason} - Response: {response.text} - URL: {response.request.url}"

locust_cloud/input_events.py

@@ -0,0 +1,120 @@
+# mostly copied from locust core
+from __future__ import annotations
+
+import collections
+import logging
+import os
+import sys
+from collections.abc import Callable
+
+import gevent
+
+if os.name == "nt":
+    import pywintypes
+    from win32api import STD_INPUT_HANDLE
+    from win32console import (
+        ENABLE_ECHO_INPUT,
+        ENABLE_LINE_INPUT,
+        ENABLE_PROCESSED_INPUT,
+        KEY_EVENT,
+        GetStdHandle,
+    )
+else:
+    import select
+    import termios
+    import tty
+
+
+class InitError(Exception):
+    pass
+
+
+class UnixKeyPoller:
+    def __init__(self):
+        if sys.stdin.isatty():
+            self.stdin = sys.stdin.fileno()
+            self.tattr = termios.tcgetattr(self.stdin)
+            tty.setcbreak(self.stdin, termios.TCSANOW)
+        else:
+            raise InitError("Terminal was not a tty. Keyboard input disabled")
+
+    def cleanup(self):
+        termios.tcsetattr(self.stdin, termios.TCSANOW, self.tattr)
+
+    def poll(_self):
+        dr, dw, de = select.select([sys.stdin], [], [], 0)
+        if not dr == []:
+            return sys.stdin.read(1)
+        return None
+
+
+class WindowsKeyPoller:
+    def __init__(self):
+        if sys.stdin.isatty():
+            try:
+                self.read_handle = GetStdHandle(STD_INPUT_HANDLE)  # type: ignore
+                self.read_handle.SetConsoleMode(ENABLE_LINE_INPUT | ENABLE_ECHO_INPUT | ENABLE_PROCESSED_INPUT)  # type: ignore
+                self.cur_event_length = 0
+                self.cur_keys_length = 0
+                self.captured_chars = collections.deque()
+            except pywintypes.error:  # type: ignore
+                raise InitError("Terminal says its a tty but we couldn't enable line input. Keyboard input disabled.")
+        else:
+            raise InitError("Terminal was not a tty. Keyboard input disabled")
+
+    def cleanup(self):
+        pass
+
+    def poll(self):
+        if self.captured_chars:
+            return self.captured_chars.popleft()
+
+        events_peek = self.read_handle.PeekConsoleInput(10000)
+
+        if not events_peek:
+            return None
+
+        if not len(events_peek) == self.cur_event_length:
+            for cur_event in events_peek[self.cur_event_length :]:
+                if cur_event.EventType == KEY_EVENT:  # type: ignore
+                    if ord(cur_event.Char) and cur_event.KeyDown:
+                        cur_char = str(cur_event.Char)
+                        self.captured_chars.append(cur_char)
+
+            self.cur_event_length = len(events_peek)
+
+        if self.captured_chars:
+            return self.captured_chars.popleft()
+        else:
+            return None
+
+
+def get_poller():
+    if os.name == "nt":
+        return WindowsKeyPoller()
+    else:
+        return UnixKeyPoller()
+
+
+def input_listener(key_to_func_map: dict[str, Callable]):
+    def input_listener_func():
+        try:
+            poller = get_poller()
+        except InitError as e:
+            logging.debug(e)
+            return
+
+        try:
+            while True:
+                if input := poller.poll():
+                    for key in key_to_func_map:
+                        if input == key:
+                            key_to_func_map[key]()
+                else:
+                    gevent.sleep(0.2)
+        except Exception as e:
+            logging.warning(f"Exception in keyboard input poller: {e}")
+        finally:
+            poller.cleanup()
+
+    return input_listener_func

locust_cloud/websocket.py

@@ -64,7 +64,7 @@ class Websocket:
 
         self.__connect_timeout_timer = threading.Timer(timeout, _timeout)
         self.__connect_timeout_timer.daemon = True
-        logger.debug(f"Setting websocket connection timeout to {timeout} seconds")
+        # logger.debug(f"Setting websocket connection timeout to {timeout} seconds")
         self.__connect_timeout_timer.start()
 
     def connect(self, url, *, auth) -> None:
@@ -110,7 +110,8 @@ class Websocket:
         __on_connect_error method), raise it.
         """
         timeout = self.wait_timeout if timeout else None
-        logger.debug(f"Waiting for shutdown for {str(timeout)+'s' if timeout else 'ever'}")
+        if timeout:  # not worth even debug logging if we dont have a timeout
+            logger.debug(f"Waiting for shutdown for {str(timeout) + 's' if timeout else 'ever'}")
         res = self.__shutdown_allowed.wait(timeout)
         if self.exception:
             raise self.exception
@@ -174,6 +175,7 @@ class Websocket:
 
         if shutdown:
             logger.debug("Got shutdown from locust master")
+            self.__connect_timeout_timer.cancel()  # I dont know exactly why/if this is necessary but we had an issue in status-checker once
             if shutdown_message:
                 print(shutdown_message)
 

{locust_cloud-1.14.5.dist-info → locust_cloud-1.15.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: locust-cloud
-Version: 1.14.5
+Version: 1.15.2
 Summary: Locust Cloud
 Project-URL: Homepage, https://locust.cloud
 Requires-Python: >=3.11

locust_cloud-1.15.2.dist-info/RECORD

@@ -0,0 +1,11 @@
+locust_cloud/apisession.py,sha256=AoU0FGQbyH2qbaTmdyoIMBd_lwZimLtihK0gnpAV6c0,4091
+locust_cloud/args.py,sha256=1SaMQ16f_3vaNqnAbjFiBL-6ietp1-qfV2LUjBk6b8k,7100
+locust_cloud/cloud.py,sha256=OaUE0bnlRGgLTKhdDCMnonaT-h2pop_cAfcOFOLcwng,5581
+locust_cloud/common.py,sha256=cFrDVKpi9OEmH6giOuj9HoIUFSBArixNtNHzZIgDvPE,992
+locust_cloud/input_events.py,sha256=MyxccgboHByICuK6VpQCCJhZQqTZAacNmkSpw-gxBEw,3420
+locust_cloud/web_login.py,sha256=1j2AQoEM6XVSDtE1q0Ryrs4jFEx07r9IQfZCoFAQXJg,2400
+locust_cloud/websocket.py,sha256=9Q7nTFuAwVhgW74DlJNcHTZXOQ1drsXi8hX9ciZhWlQ,8998
+locust_cloud-1.15.2.dist-info/METADATA,sha256=a79gziKM22Yf8cyno1E0GHw2PUPhyj6vDYxA7RoJqkE,497
+locust_cloud-1.15.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+locust_cloud-1.15.2.dist-info/entry_points.txt,sha256=PGyAb4e3aTsGS3N3VGShDl6VzJaXy7QwsEgsLOC7V00,57
+locust_cloud-1.15.2.dist-info/RECORD,,

locust_cloud-1.14.5.dist-info/RECORD

@@ -1,10 +0,0 @@
-locust_cloud/apisession.py,sha256=AoU0FGQbyH2qbaTmdyoIMBd_lwZimLtihK0gnpAV6c0,4091
-locust_cloud/args.py,sha256=1SaMQ16f_3vaNqnAbjFiBL-6ietp1-qfV2LUjBk6b8k,7100
-locust_cloud/cloud.py,sha256=Piq6J9pS6Tom1aoYwNmmt4Q9LrLFPKFZC6EqgOen3OE,5107
-locust_cloud/common.py,sha256=cFrDVKpi9OEmH6giOuj9HoIUFSBArixNtNHzZIgDvPE,992
-locust_cloud/web_login.py,sha256=1j2AQoEM6XVSDtE1q0Ryrs4jFEx07r9IQfZCoFAQXJg,2400
-locust_cloud/websocket.py,sha256=lnVRsk0goAHIDNz9cT5xkYAjHSB5aqFyjR_m3X48qRM,8771
-locust_cloud-1.14.5.dist-info/METADATA,sha256=o-6YQ6-rgvRy_3XU2bvM3NVKyhD5jXbzPrzPb30jZZE,497
-locust_cloud-1.14.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-locust_cloud-1.14.5.dist-info/entry_points.txt,sha256=PGyAb4e3aTsGS3N3VGShDl6VzJaXy7QwsEgsLOC7V00,57
-locust_cloud-1.14.5.dist-info/RECORD,,