locust-cloud 1.20.7__tar.gz

locust_cloud-1.20.7/.github/workflows/daily-check.yml

@@ -0,0 +1,54 @@
+name: Daily test run (api-dev)
+
+on:
+  schedule: # 00:00, skipping Sunday and Monday
+    - cron: '0 0 * * 2-6'
+  workflow_dispatch:
+
+env:
+  LOCUSTCLOUD_USERNAME: ${{ secrets.LOCUSTCLOUD_USERNAME }}
+  LOCUSTCLOUD_PASSWORD: ${{ secrets.LOCUSTCLOUD_PASSWORD }}
+  LOCUSTCLOUD_DEPLOYER_URL: https://api-dev.eu-north-1.locust.cloud/1
+  LOCUSTCLOUD_REGION: eu-north-1
+  LOCUSTCLOUD_NON_INTERACTIVE: 1
+  LOCUST_LOGLEVEL: DEBUG
+  SLACK_NOTIFICATIONS_WEBHOOK: ${{ secrets.SLACK_NOTIFICATIONS_WEBHOOK }}
+  PYTHONUNBUFFERED: 1 # ensure we see logs output right away
+
+jobs:
+  locust_cloud_full_run:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+      - uses: actions/setup-python@v5
+        with:
+            python-version: '3.11'
+      - uses: astral-sh/setup-uv@v2
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+      - run: uv venv --python 3.11
+      # any local changes would make hatch-vcs set a "local version" (+dev0...), so we ignore any uv.lock updates:
+      - run: git update-index --assume-unchanged uv.lock
+      - run: uv run locust-cloud --help
+      - run: uv run locust-cloud --image-tag master --profile status-checker --mock-server --autostart --autoquit 0 --run-time 1m --loglevel DEBUG --extra-files testdata |& tee output.txt
+      # check ok exit
+      - run: grep -m 1 '(exit code 0)' output.txt
+      # check extra files specified were available
+      - run: "grep -m 1 -- '--extra-files verification: pineapple' output.txt"
+      # check for errors
+      - run: bash -ec "! grep Traceback output.txt"
+      - run: bash -ec "! grep ERROR output.txt"
+      # Disabled the following test for now, because of incorrect warning about:
+      # You can't start a distributed test before at least one worker processes has connected
+      # - run: bash -ec "! grep WARNING output.txt"
+      - name: On failure, notify slack
+        if: failure()
+        run: curl -d "{\"text\":\"Failed run $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID\"}" $SLACK_NOTIFICATIONS_WEBHOOK
+      - name: Make sure to delete (only really needed for mock)
+        if: always()
+        run: uv tool run locust-cloud --delete

locust_cloud-1.20.7/.github/workflows/tests.yml

@@ -0,0 +1,62 @@
+name: Tests
+
+on:
+  push:
+  workflow_dispatch:
+
+permissions:
+  id-token: write
+  contents: read
+
+env:
+  AWS_ACCOUNT_ID: 637423602143
+  AWS_REGION: eu-north-1
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+      - uses: astral-sh/setup-uv@v2
+      - run: uv venv --python 3.10
+      - run: uv run ruff check
+      - run: uv run ruff format --check
+      - run: uv run pyright
+      # This peculiar way of running pytest is to ensure monkey patching is done before pytest starts loading modules.
+      # Otherwise you may get "MonkeyPatchWarning: Monkey-patching ssl after ssl has already been imported" and infinite recursion
+      # https://github.com/pytest-dev/pytest/issues/6210
+      - run: uv run python -m gevent.monkey --module pytest
+        env:
+          LOCUSTCLOUD_USERNAME: ${{ secrets.LOCUSTCLOUD_USERNAME }}
+          LOCUSTCLOUD_PASSWORD: ${{ secrets.LOCUSTCLOUD_PASSWORD }}
+      # any local changes would make hatch-vcs set a "local version" (+dev0...), so we ignore any uv.lock updates:
+      - run: git update-index --assume-unchanged uv.lock
+      - run: uvx --from build pyproject-build --sdist --wheel --installer uv
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist-artifact
+          path: dist/*
+      # Ensure what customers will actually run does not rely on dev-dependencies
+      - run: rm -rf uv.lock .venv
+      - run: uv run --no-default-groups locust-cloud --help
+
+  publish_pypi:
+    name: Publish to PyPI
+    needs: [build]
+    if: github.repository_owner == 'locustcloud' && ( github.ref == 'refs/heads/master' || startsWith(github.event.ref, 'refs/tags') )
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - name: Download Python dist
+        uses: actions/download-artifact@v4
+        with:
+          name: dist-artifact
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1

locust_cloud-1.20.7/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+
+venv
+**/__pycache__
+locust_cloud.egg*
+.eggs
+**_cache

locust_cloud-1.20.7/.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # pin the same version as in pyproject.toml
+    rev: v0.10.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

locust_cloud-1.20.7/.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "charliermarsh.ruff"
+    ]
+}

locust_cloud-1.20.7/.vscode/launch.json

@@ -0,0 +1,14 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+      {
+        "name": "Run via uv",
+        "type": "debugpy",
+        "request": "launch",
+        "console": "integratedTerminal",
+        "program": "${workspaceFolder}/.venv/bin/locust-cloud",
+        "args": []
+      }
+    ]
+  }
+  

locust_cloud-1.20.7/.vscode/settings.json

@@ -0,0 +1,27 @@
+{
+  "editor.formatOnSave": true,
+  "files.exclude": {
+    "locust_cloud.egg-info/**": true,
+    "dist/**": true,
+    "**/.tox/": true,
+    "**/__pycache__": true,
+    ".mypy_cache/**/*": true,
+    ".ruff_cache/**/*": true,
+    ".venv/": true,
+    "**/.eggs": true,
+    "**_cache": true
+  },
+  "[python]": {
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.fixAll": "explicit",
+      "source.organizeImports": "explicit"
+    },
+    "editor.defaultFormatter": "charliermarsh.ruff"
+  },
+  "python.testing.pytestArgs": [
+    "tests"
+  ],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true
+}

locust_cloud-1.20.7/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.20.7/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: locust-cloud
+Version: 1.20.7
+Summary: Locust Cloud
+Project-URL: homepage, https://locust.cloud
+Project-URL: repository, https://github.com/locustcloud/locust-cloud
+License: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: configargparse>=1.5.5
+Requires-Dist: gevent<25.0.0,>=24.10.1
+Requires-Dist: platformdirs<5.0.0,>=4.3.6
+Requires-Dist: python-socketio[client]==5.13.0
+Requires-Dist: tomli>=1.1.0; python_version < '3.11'
+Description-Content-Type: text/markdown
+
+# Locust Cloud
+
+See https://locust.cloud for general information on Locust Cloud, or https://docs.locust.cloud for usage instructions.

locust_cloud-1.20.7/README.md

@@ -0,0 +1,3 @@
+# Locust Cloud
+
+See https://locust.cloud for general information on Locust Cloud, or https://docs.locust.cloud for usage instructions.

locust_cloud-1.20.7/locust_cloud/__init__.py

@@ -0,0 +1,3 @@
+from locust_cloud.cloud import main
+
+__all__ = ["main"]

locust_cloud-1.20.7/locust_cloud/apisession.py

@@ -0,0 +1,112 @@
+import logging
+import os
+import sys
+import time
+
+import requests
+from locust_cloud.common import VALID_REGIONS, __version__, get_api_url, read_cloud_config, write_cloud_config
+
+logger = logging.getLogger(__name__)
+
+unauthorized_message = "You need to log in again. Please run:\n    locust --cloud --login"
+
+
+class ApiSession(requests.Session):
+    def __init__(self, non_interactive: bool) -> None:
+        super().__init__()
+        self.non_interactive = non_interactive
+
+        if non_interactive:
+            username = os.getenv("LOCUSTCLOUD_USERNAME")
+            password = os.getenv("LOCUSTCLOUD_PASSWORD")
+            region = os.getenv("LOCUSTCLOUD_REGION")
+
+            if not all([username, password, region]):
+                print(
+                    "Running with --non-interactive requires that LOCUSTCLOUD_USERNAME, LOCUSTCLOUD_PASSWORD and LOCUSTCLOUD_REGION environment variables are set."
+                )
+                sys.exit(1)
+
+            if region not in VALID_REGIONS:
+                print("Environment variable LOCUSTCLOUD_REGION needs to be set to one of", ", ".join(VALID_REGIONS))
+                sys.exit(1)
+
+            self.__configure_for_region(region)
+            response = requests.post(
+                self.__login_url,
+                json={"username": username, "password": password},
+                headers={"X-Client-Version": __version__},
+            )
+            if not response.ok:
+                print(f"Authentication failed: {response.text}")
+                sys.exit(1)
+
+            id_token = response.json()["cognito_client_id_token"]
+            user_sub_id = response.json()["user_sub_id"]
+            refresh_token = response.json()["refresh_token"]
+            id_token_expires = response.json()["id_token_expires"]
+        else:
+            config = read_cloud_config()
+
+            if config.refresh_token_expires < time.time() + 24 * 60 * 60:
+                print(unauthorized_message)
+                sys.exit(1)
+
+            assert config.region
+            self.__configure_for_region(config.region)
+            id_token = config.id_token
+            user_sub_id = config.user_sub_id
+            refresh_token = config.refresh_token
+            id_token_expires = config.id_token_expires
+
+        assert id_token
+
+        self.__user_sub_id = user_sub_id
+        self.__refresh_token = refresh_token
+        self.__id_token_expires = id_token_expires - 60  # Refresh 1 minute before expiry
+        self.headers["Authorization"] = f"Bearer {id_token}"
+        self.headers["X-Client-Version"] = __version__
+
+    def __configure_for_region(self, region: str) -> None:
+        self.region = region
+        self.api_url = get_api_url(region)
+        self.__login_url = f"{self.api_url}/auth/login"
+
+        logger.debug(f"Lambda url: {self.api_url}")
+
+    def __ensure_valid_authorization_header(self) -> None:
+        if self.__id_token_expires > time.time():
+            return
+        if not self.__user_sub_id and self.__refresh_token:
+            print(unauthorized_message)
+            sys.exit(1)
+
+        response = requests.post(
+            self.__login_url,
+            json={"user_sub_id": self.__user_sub_id, "refresh_token": self.__refresh_token},
+            headers={"X-Client-Version": __version__},
+        )
+
+        if not response.ok:
+            logger.error(f"Authentication failed: {response.text}")
+            sys.exit(1)
+
+        # TODO: Technically the /login endpoint can return a challenge for you
+        #       to change your password.
+        #       Now that we have a web based login flow we should force them to
+        #       do a locust --cloud --login if we get that.
+
+        id_token = response.json()["cognito_client_id_token"]
+        id_token_expires = response.json()["id_token_expires"]
+        self.__id_token_expires = id_token_expires - 60  # Refresh 1 minute before expiry
+        self.headers["Authorization"] = f"Bearer {id_token}"
+
+        if not self.non_interactive:
+            config = read_cloud_config()
+            config.id_token = id_token
+            config.id_token_expires = id_token_expires
+            write_cloud_config(config)
+
+    def request(self, method, url, *args, **kwargs) -> requests.Response:
+        self.__ensure_valid_authorization_header()
+        return super().request(method, f"{self.api_url}{url}", *args, **kwargs)

locust_cloud-1.20.7/locust_cloud/args.py

@@ -0,0 +1,240 @@
+import argparse
+import base64
+import gzip
+import io
+import os
+import pathlib
+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
+from zipfile import ZipFile
+
+import configargparse
+
+CWD = pathlib.Path.cwd()
+
+
+class LocustTomlConfigParser(configargparse.TomlConfigParser):
+    def parse(self, stream: IO[str]) -> OrderedDict[str, Any]:
+        try:
+            config = tomllib.loads(stream.read())
+        except Exception as e:
+            raise configargparse.ConfigFileParserException(f"Couldn't parse TOML file: {e}")
+
+        result: OrderedDict[str, Any] = OrderedDict()
+
+        for section in self.sections:
+            data = configargparse.get_toml_section(config, section)
+            if data:
+                for key, value in data.items():
+                    if isinstance(value, list):
+                        result[key] = value
+                    elif value is not None:
+                        result[key] = str(value)
+                break
+
+        return result
+
+
+def pipe(value: Any, *functions: Callable) -> Any:
+    for function in functions:
+        value = function(value)
+
+    return value
+
+
+def valid_extra_files_path(file_path: str) -> pathlib.Path:
+    p = pathlib.Path(file_path).resolve()
+
+    if not CWD in p.parents:
+        raise ArgumentTypeError(f"Can only reference files under current working directory: {CWD}")
+    if not p.exists():
+        raise ArgumentTypeError(f"File not found: {file_path}")
+    return p
+
+
+def transfer_encode(file_name: str, stream: IO[bytes]) -> dict[str, str]:
+    return {
+        "filename": file_name,
+        "data": pipe(
+            stream.read(),
+            gzip.compress,
+            base64.b64encode,
+            bytes.decode,
+        ),
+    }
+
+
+def transfer_encoded_file(file_path: str) -> dict[str, str]:
+    try:
+        with open(file_path, "rb") as f:
+            return transfer_encode(os.path.basename(file_path), f)
+    except FileNotFoundError:
+        raise ArgumentTypeError(f"File not found: {file_path}")
+
+
+def expanded(paths: list[pathlib.Path]) -> Generator[pathlib.Path, None, None]:
+    for path in paths:
+        if path.is_dir():
+            for root, _, file_names in os.walk(path):
+                for file_name in file_names:
+                    yield pathlib.Path(root) / file_name
+        else:
+            yield path
+
+
+def transfer_encoded_extra_files(paths: list[pathlib.Path]) -> dict[str, str]:
+    buffer = io.BytesIO()
+
+    with ZipFile(buffer, "w") as zf:
+        for path in set(expanded(paths)):
+            zf.write(path.relative_to(CWD))
+
+    buffer.seek(0)
+    return transfer_encode("extra-files.zip", buffer)
+
+
+class MergeToTransferEncodedZip(argparse.Action):
+    def __call__(self, parser, namespace, values, option_string=None):
+        paths = cast(list[pathlib.Path], values)
+        value = transfer_encoded_extra_files(paths)
+        setattr(namespace, self.dest, value)
+
+
+cloud_parser = configargparse.ArgumentParser(add_help=False)
+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 expire you will be prompted to perform another login.",
+)
+cloud_parser.add_argument(
+    "--logout",
+    action="store_true",
+    help="Removes the authentication credentials",
+)
+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.",
+)
+cloud_parser.add_argument(
+    "--requirements",
+    metavar="<filename>",
+    type=transfer_encoded_file,
+    help="Optional requirements.txt file that contains your external libraries.",
+)
+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.",
+)
+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,
+)
+cloud_parser.add_argument(
+    "--image-tag",
+    type=str,
+    default=None,
+    help=configargparse.SUPPRESS,  # overrides the locust-cloud docker image tag. for internal use
+)
+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.",
+)
+cloud_parser.add_argument(
+    "--extra-files",
+    action=MergeToTransferEncodedZip,
+    nargs="*",
+    type=valid_extra_files_path,
+    help="A list of extra files or directories to upload. Space-separated, e.g. `--extra-files testdata.csv *.py my-directory/`.",
+)
+cloud_parser.add_argument(
+    "--testrun-tags",
+    nargs="*",
+    default=None,
+    help="A list of tags that can be used to filter testruns.",
+)
+
+combined_cloud_parser = configargparse.ArgumentParser(
+    parents=[cloud_parser],
+    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,
+        ]
+    ),
+    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,
+)
+combined_cloud_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,
+)
+combined_cloud_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",
+)
+combined_cloud_parser.add_argument(
+    "--loglevel",
+    "-L",
+    type=str.upper,
+    help="Set --loglevel DEBUG for extra info.",
+    choices=["DEBUG", "INFO", "WARNING", "ERROR"],
+    default="INFO",
+)
+
+
+def add_locust_cloud_argparse(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 ...""",
+    )
+
+    # This arguments is defined here because only makes sense when
+    # running from locust core
+    cloud_group.add_argument(
+        "--cloud",
+        action="store_true",
+        help="Run Locust in cloud mode.",
+    )
+
+    for action in cloud_parser._actions:
+        cloud_group._add_action(action)