locust-cloud 1.16.1__py3-none-any.whl → 1.17.0__py3-none-any.whl

locust_cloud/__init__.py

@@ -0,0 +1,18 @@
+from locust import events
+from locust_cloud.args import cloud_parser
+from locust_cloud.cloud import main
+
+__all__ = ["main"]
+
+
+@events.init_command_line_parser.add_listener
+def _(parser):
+    cloud_group = parser.add_argument_group(
+        "Locust Cloud",
+        """Launches a distributed Locust run on locust.cloud infrastructure.
+
+Example: locust --cloud -f my_locustfile.py --users 1000 ...""",
+    )
+
+    for action in cloud_parser._actions:
+        cloud_group._add_action(action)

locust_cloud/args.py

@@ -4,8 +4,14 @@ import gzip
 import io
 import os
 import pathlib
-import tomllib
-from argparse import ArgumentTypeError, Namespace
+import sys
+
+if sys.version_info >= (3, 11):
+    import tomllib
+else:
+    import tomli as tomllib
+
+from argparse import ArgumentTypeError
 from collections import OrderedDict
 from collections.abc import Callable, Generator
 from typing import IO, Any, cast
@@ -103,116 +109,54 @@ class MergeToTransferEncodedZip(argparse.Action):
         setattr(namespace, self.dest, value)
 
 
-parser = configargparse.ArgumentParser(
-    default_config_files=[
-        "~/.locust.conf",
-        "locust.conf",
-        "pyproject.toml",
-        "~/.cloud.conf",
-        "cloud.conf",
-    ],
-    auto_env_var_prefix="LOCUSTCLOUD_",
-    formatter_class=configargparse.RawTextHelpFormatter,
-    config_file_parser_class=configargparse.CompositeConfigParser(
-        [
-            LocustTomlConfigParser(["tool.locust"]),
-            configargparse.DefaultConfigFileParser,
-        ]
-    ),
-    description="""Launches a distributed Locust runs on locust.cloud infrastructure.
-
-Example: locust-cloud -f my_locustfile.py --users 1000 ...""",
-    epilog="""Any parameters not listed here are forwarded to locust master unmodified, so go ahead and use things like --users, --host, --run-time, ...
-Locust config can also be set using config file (~/.locust.conf, locust.conf, pyproject.toml, ~/.cloud.conf or cloud.conf).
-Parameters specified on command line override env vars, which in turn override config files.""",
-    add_config_file_help=False,
-    add_env_var_help=False,
-    add_help=False,
-)
-parser.add_argument(
-    "-h",
-    "--help",
-    action="help",
-    help=configargparse.SUPPRESS,
-)
-parser.add_argument(
-    "-V",
-    "--version",
+cloud_parser = configargparse.ArgumentParser(add_help=False)
+cloud_parser.add_argument(
+    "--cloud",
     action="store_true",
-    help=configargparse.SUPPRESS,
-)
-parser.add_argument(
-    "-f",
-    "--locustfile",
-    metavar="<filename>",
-    default="locustfile.py",
-    help="The Python file that contains your test. Defaults to 'locustfile.py'.",
-    env_var="LOCUST_LOCUSTFILE",
-    type=transfer_encoded_file,
+    help="Run Locust in cloud mode.",
 )
-parser.add_argument(
-    "-u",
-    "--users",
-    type=int,
-    default=1,
-    help="Number of users to launch. This is the same as the regular Locust argument, but also affects how many workers to launch.",
-    env_var="LOCUST_USERS",
+cloud_parser.add_argument(
+    "--login",
+    action="store_true",
+    help="Launch an interactive session to authenticate your user.\nOnce completed your credentials will be stored and automatically refreshed for quite a long time.\nOnce those expires you will be prompted to perform another login.",
 )
-advanced = parser.add_argument_group("advanced")
-advanced.add_argument(
-    "--loglevel",
-    "-L",
-    type=str.upper,
-    help="Set --loglevel DEBUG for extra info.",
-    choices=["DEBUG", "INFO", "WARNING", "ERROR"],
-    default="INFO",
+cloud_parser.add_argument(
+    "--delete",
+    action="store_true",
+    help="Delete a running cluster. Useful if locust-cloud was killed/disconnected or if there was an error.",
 )
-advanced.add_argument(
+cloud_parser.add_argument(
     "--requirements",
+    metavar="<filename>",
     type=transfer_encoded_file,
     help="Optional requirements.txt file that contains your external libraries.",
 )
-advanced.add_argument(
-    "--login",
-    action="store_true",
-    default=False,
-    help="Launch an interactive session to authenticate your user.\nOnce completed your credentials will be stored and automatically refreshed for quite a long time.\nOnce those expires you will be prompted to perform another login.",
-)
-advanced.add_argument(
+cloud_parser.add_argument(
     "--non-interactive",
     action="store_true",
     default=False,
     help="This can be set when, for example, running in a CI/CD environment to ensure no interactive steps while executing.\nRequires that LOCUSTCLOUD_USERNAME, LOCUSTCLOUD_PASSWORD and LOCUSTCLOUD_REGION environment variables are set.",
 )
-parser.add_argument(
+cloud_parser.add_argument(
     "--workers",
+    metavar="<int>",
     type=int,
     help="Number of workers to use for the deployment. Defaults to number of users divided by 500, but the default may be customized for your account.",
     default=None,
 )
-parser.add_argument(
-    "--delete",
-    action="store_true",
-    help="Delete a running cluster. Useful if locust-cloud was killed/disconnected or if there was an error.",
-)
-parser.add_argument(
+cloud_parser.add_argument(
     "--image-tag",
     type=str,
     default=None,
     help=configargparse.SUPPRESS,  # overrides the locust-cloud docker image tag. for internal use
 )
-parser.add_argument(
+cloud_parser.add_argument(
     "--mock-server",
     action="store_true",
     default=False,
     help="Start a demo mock service and set --host parameter to point Locust towards it",
 )
-parser.add_argument(
-    "--profile",
-    type=str,
-    help="Set a profile to group the testruns together",
-)
-parser.add_argument(
+cloud_parser.add_argument(
     "--extra-files",
     action=MergeToTransferEncodedZip,
     nargs="*",
@@ -220,6 +164,39 @@ parser.add_argument(
     help="A list of extra files or directories to upload. Space-separated, e.g. --extra-files testdata.csv *.py my-directory/",
 )
 
-
-def parse_known_args(args: Any | None = None) -> tuple[Namespace, list[str]]:
-    return parser.parse_known_args(args)
+combined_cloud_parser = configargparse.ArgumentParser(
+    default_config_files=[
+        "~/.cloud.conf",
+        "cloud.conf",
+    ],
+    auto_env_var_prefix="LOCUSTCLOUD_",
+    formatter_class=configargparse.RawTextHelpFormatter,
+    config_file_parser_class=configargparse.CompositeConfigParser(
+        [
+            LocustTomlConfigParser(["tool.locust"]),
+            configargparse.DefaultConfigFileParser,
+        ]
+    ),
+    parents=[cloud_parser],
+)
+combined_cloud_parser.add_argument(
+    "-f",
+    "--locustfile",
+    default="locustfile.py",
+    env_var="LOCUST_LOCUSTFILE",
+    type=transfer_encoded_file,
+)
+combined_cloud_parser.add_argument(
+    "-u",
+    "--users",
+    type=int,
+    default=1,
+    env_var="LOCUST_USERS",
+)
+combined_cloud_parser.add_argument(
+    "--loglevel",
+    "-L",
+    type=str.upper,
+    choices=["DEBUG", "INFO", "WARNING", "ERROR"],
+    default="INFO",
+)

locust_cloud/cloud.py

@@ -1,13 +1,12 @@
 import logging
 import os
-import sys
 import time
 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.args import combined_cloud_parser
 from locust_cloud.common import __version__
 from locust_cloud.input_events import input_listener
 from locust_cloud.web_login import web_login
@@ -28,30 +27,28 @@ def configure_logging(loglevel: str) -> None:
     logging.getLogger("urllib3").setLevel(logging.INFO)
 
 
-def main() -> None:
-    options, locust_options = parse_known_args()
+def main():
+    options, locust_options = combined_cloud_parser.parse_known_args()
+
     configure_logging(options.loglevel)
 
-    if options.version:
-        print(f"locust-cloud version {__version__}")
-        sys.exit(0)
     if not options.locustfile:
         logger.error("A locustfile is required to run a test.")
-        sys.exit(1)
+        return 1
 
     if options.login:
         try:
             web_login()
         except KeyboardInterrupt:
             pass
-        sys.exit()
+        return
 
     session = ApiSession(options.non_interactive)
     websocket = Websocket()
 
     if options.delete:
         delete(session)
-        sys.exit()
+        return
 
     try:
         logger.info(f"Deploying ({session.region}, {__version__})")
@@ -67,12 +64,12 @@ def main() -> None:
                 "LOCUST_SKIP_MONKEY_PATCH",
             ]
         ]
+
         payload = {
             "locust_args": [
                 {"name": "LOCUST_USERS", "value": str(options.users)},
                 {"name": "LOCUST_FLAGS", "value": " ".join(locust_options)},
                 {"name": "LOCUSTCLOUD_DEPLOYER_URL", "value": session.api_url},
-                {"name": "LOCUSTCLOUD_PROFILE", "value": options.profile},
                 *locust_env_variables,
             ],
             "locustfile": options.locustfile,
@@ -107,10 +104,10 @@ def main() -> None:
                 time.sleep(2)
             except requests.exceptions.RequestException as e:
                 logger.error(f"Failed to deploy the load generators: {e}")
-                sys.exit(1)
+                return 1
         else:
-            logger.error("Your Locust instance is still running, run locust-cloud --delete")
-            sys.exit(1)
+            logger.error("Your Locust instance is still running, run locust --cloud --delete")
+            return 1
 
         if response.status_code != 200:
             try:
@@ -119,7 +116,7 @@ def main() -> None:
                 logger.error(
                     f"HTTP {response.status_code}/{response.reason} - Response: {response.text} - URL: {response.request.url}"
                 )
-            sys.exit(1)
+            return 1
 
         log_ws_url = js["log_ws_url"]
         session_id = js["session_id"]
@@ -146,19 +143,19 @@ def main() -> None:
             websocket.wait(timeout=True)
         except (WebsocketTimeout, SessionMismatchError) as e:
             logger.error(str(e))
-            sys.exit(1)
+            return 1
     except WebsocketTimeout as e:
         logger.error(str(e))
         delete(session)
-        sys.exit(1)
+        return 1
     except SessionMismatchError as e:
         # In this case we do not trigger the teardown since the running instance is not ours
         logger.error(str(e))
-        sys.exit(1)
+        return 1
     except Exception as e:
         logger.exception(e)
         delete(session)
-        sys.exit(1)
+        return 1
     else:
         delete(session)
     finally:
@@ -183,7 +180,3 @@ def delete(session):
         pass  # don't show nasty callstack
     except Exception as e:
         logger.error(f"Could not automatically tear down Locust Cloud: {e.__class__.__name__}:{e}")
-
-
-if __name__ == "__main__":
-    main()

{locust_cloud-1.16.1.dist-info → locust_cloud-1.17.0.dist-info}/METADATA

@@ -1,15 +1,18 @@
 Metadata-Version: 2.4
 Name: locust-cloud
-Version: 1.16.1
+Version: 1.17.0
 Summary: Locust Cloud
 Project-URL: Homepage, https://locust.cloud
-Requires-Python: >=3.11
+License-File: LICENSE
+Requires-Python: >=3.10
 Requires-Dist: configargparse==1.7
 Requires-Dist: gevent>=24.11.1
+Requires-Dist: locust>=2.34.0
 Requires-Dist: platformdirs>=4.3.6
 Requires-Dist: pyjwt>=2.0
 Requires-Dist: python-socketio[client]==5.11.4
 Requires-Dist: requests==2.32.3
+Requires-Dist: tomli>=1.1.0; python_version < '3.11'
 Description-Content-Type: text/markdown
 
 # Locust Cloud

locust_cloud-1.17.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+locust_cloud/__init__.py,sha256=NPggKqjx13UKmmgoG6dpoXOyA1liGBAUP8pz6OSpBvI,488
+locust_cloud/apisession.py,sha256=kCr271_l0IeMGw0L563mOecqPJj4OD9h2J3vxCM5zYQ,4015
+locust_cloud/args.py,sha256=oyl6Uv5CV3mTMLos_-3ChVwyHt6ElxLAaanlbQn5SaU,6056
+locust_cloud/cloud.py,sha256=RbW7p4pQWIcvaYe_80BwNiBC8YHmrX-1tE5X8Bi0dH0,5912
+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.17.0.dist-info/METADATA,sha256=HTj3BaXSF4pqcuJB9Y83M0F2rgonl3sXMzCzYm8HmXs,633
+locust_cloud-1.17.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+locust_cloud-1.17.0.dist-info/entry_points.txt,sha256=PGyAb4e3aTsGS3N3VGShDl6VzJaXy7QwsEgsLOC7V00,57
+locust_cloud-1.17.0.dist-info/licenses/LICENSE,sha256=Ow6fY6ta4KIjdlWalmxGvRP8yLmetvkbkl-SdHMjPIs,1093
+locust_cloud-1.17.0.dist-info/RECORD,,

locust_cloud-1.17.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2024-present, Locust Technologies Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

locust_cloud-1.16.1.dist-info/RECORD

@@ -1,11 +0,0 @@
-locust_cloud/apisession.py,sha256=kCr271_l0IeMGw0L563mOecqPJj4OD9h2J3vxCM5zYQ,4015
-locust_cloud/args.py,sha256=4U_bZaEH1UJR8C7_bH_sX1DRB8m6WBcJh-ewhilFQX0,7118
-locust_cloud/cloud.py,sha256=kih2Qtddry0dxmGylxXQdrw4SPTwx6k6YN0ur3u47Qc,6144
-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.16.1.dist-info/METADATA,sha256=4EHCv-Hpo9NR-IThvTMiJR9t5EWfdjARKBt2V2QApBQ,528
-locust_cloud-1.16.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-locust_cloud-1.16.1.dist-info/entry_points.txt,sha256=PGyAb4e3aTsGS3N3VGShDl6VzJaXy7QwsEgsLOC7V00,57
-locust_cloud-1.16.1.dist-info/RECORD,,