locust 2.32.1.dev39__tar.gz → 2.32.2__tar.gz

{locust-2.32.1.dev39 → locust-2.32.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: locust
-Version: 2.32.1.dev39
+Version: 2.32.2
 Summary: Developer-friendly load testing framework
 Home-page: https://locust.io/
 License: MIT

{locust-2.32.1.dev39 → locust-2.32.2}/locust/_version.py

@@ -14,7 +14,7 @@ __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
 
-__version__ = "2.32.1.dev39"
+__version__ = "2.32.2"
 version = __version__
-__version_tuple__ = (2, 32, 1, "dev39")
+__version_tuple__ = (2, 32, 2)
 version_tuple = __version_tuple__

{locust-2.32.1.dev39 → locust-2.32.2}/locust/argument_parser.py

@@ -612,6 +612,14 @@ Typically ONLY these options (and --locustfile) need to be specified on workers,
         env_var="LOCUST_MASTER_NODE_PORT",
     )
 
+    web_ui_group.add_argument(
+        "--web-base-path",
+        type=str,
+        default="",
+        help="Base path for the web interface (e.g., '/locust'). Default is empty (root path).",
+        env_var="LOCUST_WEB_BASE_PATH",
+    )
+
     tag_group = parser.add_argument_group(
         "Tag options",
         "Locust tasks can be tagged using the @tag decorator. These options let specify which tasks to include or exclude during a test.",

{locust-2.32.1.dev39 → locust-2.32.2}/locust/env.py

@@ -165,6 +165,7 @@ class Environment:
         self,
         host="",
         port=8089,
+        web_base_path: str | None = None,
         web_login: bool = False,
         tls_cert: str | None = None,
         tls_key: str | None = None,
@@ -199,6 +200,7 @@ class Environment:
             delayed_start=delayed_start,
             userclass_picker_is_active=userclass_picker_is_active,
             build_path=build_path,
+            web_base_path=web_base_path,
         )
         return self.web_ui
 

{locust-2.32.1.dev39 → locust-2.32.2}/locust/html.py

@@ -12,7 +12,7 @@ from . import stats as stats_module
 from .runners import STATE_STOPPED, STATE_STOPPING, MasterRunner
 from .stats import sort_stats, update_stats_history
 from .user.inspectuser import get_ratio
-from .util.date import format_utc_timestamp
+from .util.date import format_duration, format_utc_timestamp
 
 PERCENTILES_FOR_HTML_REPORT = [0.50, 0.6, 0.7, 0.8, 0.9, 0.95, 0.99, 1.0]
 DEFAULT_BUILD_PATH = os.path.join(os.path.dirname(os.path.abspath(__file__)), "webui", "dist")
@@ -36,6 +36,7 @@ def get_html_report(
     if end_ts := stats.last_request_timestamp:
         end_time = format_utc_timestamp(end_ts)
     else:
+        end_ts = stats.start_time
         end_time = start_time
 
     host = None
@@ -52,7 +53,8 @@ def get_html_report(
         {**exc, "nodes": ", ".join(exc["nodes"])} for exc in environment.runner.exceptions.values()
     ]
 
-    update_stats_history(environment.runner)
+    if stats.history and stats.history[-1]["time"] < end_time:
+        update_stats_history(environment.runner, end_time)
     history = stats.history
 
     is_distributed = isinstance(environment.runner, MasterRunner)
@@ -88,6 +90,7 @@ def get_html_report(
             ],
             "start_time": start_time,
             "end_time": end_time,
+            "duration": format_duration(stats.start_time, end_ts),
             "host": escape(str(host)),
             "history": history,
             "show_download_link": show_download_link,

{locust-2.32.1.dev39 → locust-2.32.2}/locust/main.py

@@ -454,7 +454,9 @@ See https://github.com/locustio/locust/wiki/Installation#increasing-maximum-numb
     elif options.worker:
         try:
             runner = environment.create_worker_runner(options.master_host, options.master_port)
-            logger.debug("Connected to locust master: %s:%s", options.master_host, options.master_port)
+            logger.debug(
+                "Connected to locust master: %s:%s%s", options.master_host, options.master_port, options.web_base_path
+            )
         except OSError as e:
             logger.error("Failed to connect to the Locust master: %s", e)
             sys.exit(-1)
@@ -490,26 +492,32 @@ See https://github.com/locustio/locust/wiki/Installation#increasing-maximum-numb
     if not options.headless and not options.worker:
         protocol = "https" if options.tls_cert and options.tls_key else "http"
 
+        if options.web_base_path and options.web_base_path[0] != "/":
+            logger.error(
+                f"Invalid format for --web-base-path argument ({options.web_base_path}): the url path must start with a slash."
+            )
+            sys.exit(1)
         if options.web_host == "*":
             # special check for "*" so that we're consistent with --master-bind-host
             web_host = ""
         else:
             web_host = options.web_host
         if web_host:
-            logger.info(f"Starting web interface at {protocol}://{web_host}:{options.web_port}")
+            logger.info(f"Starting web interface at {protocol}://{web_host}:{options.web_port}{options.web_base_path}")
         if options.web_host_display_name:
             logger.info(f"Starting web interface at {options.web_host_display_name}")
         else:
             if os.name == "nt":
                 logger.info(
-                    f"Starting web interface at {protocol}://localhost:{options.web_port} (accepting connections from all network interfaces)"
+                    f"Starting web interface at {protocol}://localhost:{options.web_port}{options.web_base_path} (accepting connections from all network interfaces)"
                 )
             else:
-                logger.info(f"Starting web interface at {protocol}://0.0.0.0:{options.web_port}")
+                logger.info(f"Starting web interface at {protocol}://0.0.0.0:{options.web_port}{options.web_base_path}")
 
         web_ui = environment.create_web_ui(
             host=web_host,
             port=options.web_port,
+            web_base_path=options.web_base_path,
             web_login=options.web_login,
             tls_cert=options.tls_cert,
             tls_key=options.tls_key,

{locust-2.32.1.dev39 → locust-2.32.2}/locust/runners.py

@@ -1216,6 +1216,7 @@ class WorkerRunner(DistributedRunner):
         self.client_id = socket.gethostname() + "_" + uuid4().hex
         self.master_host = master_host
         self.master_port = master_port
+        self.web_base_path = environment.parsed_options.web_base_path if environment.parsed_options else ""
         self.logs: list[str] = []
         self.worker_cpu_warning_emitted = False
         self._users_dispatcher: UsersDispatcher | None = None
@@ -1475,11 +1476,11 @@ class WorkerRunner(DistributedRunner):
         if not success:
             if self.retry < 3:
                 logger.debug(
-                    f"Failed to connect to master {self.master_host}:{self.master_port}, retry {self.retry}/{CONNECT_RETRY_COUNT}."
+                    f"Failed to connect to master {self.master_host}:{self.master_port}{self.web_base_path}, retry {self.retry}/{CONNECT_RETRY_COUNT}."
                 )
             else:
                 logger.warning(
-                    f"Failed to connect to master {self.master_host}:{self.master_port}, retry {self.retry}/{CONNECT_RETRY_COUNT}."
+                    f"Failed to connect to master {self.master_host}:{self.master_port}{self.web_base_path}, retry {self.retry}/{CONNECT_RETRY_COUNT}."
                 )
             if self.retry > CONNECT_RETRY_COUNT:
                 raise ConnectionError()

{locust-2.32.1.dev39 → locust-2.32.2}/locust/stats.py

@@ -902,9 +902,9 @@ def sort_stats(stats: dict[Any, S]) -> list[S]:
     return [stats[key] for key in sorted(stats.keys())]
 
 
-def update_stats_history(runner: Runner) -> None:
+def update_stats_history(runner: Runner, timestamp: str | None = None) -> None:
     stats = runner.stats
-    timestamp = format_utc_timestamp(time.time())
+    timestamp = timestamp or format_utc_timestamp(time.time())
     current_response_time_percentiles = {
         f"response_time_percentile_{percentile}": [
             timestamp,
@@ -929,7 +929,8 @@ def stats_history(runner: Runner) -> None:
     while True:
         if not runner.stats.total.use_response_times_cache:
             break
-        if runner.state != "stopped":
+
+        if runner.state != "ready" and runner.state != "stopped":
             update_stats_history(runner)
 
         gevent.sleep(HISTORY_STATS_INTERVAL_SEC)

locust-2.32.2/locust/util/date.py

@@ -0,0 +1,23 @@
+from datetime import datetime, timezone
+
+
+def format_utc_timestamp(unix_timestamp):
+    return datetime.fromtimestamp(int(unix_timestamp), timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
+
+
+def format_safe_timestamp(unix_timestamp):
+    return datetime.fromtimestamp(int(unix_timestamp)).strftime("%Y-%m-%d-%Hh%M")
+
+
+def format_duration(start_time, end_time):
+    seconds = int(end_time) - int(start_time)
+    days = seconds // 86400
+    hours = (seconds % 86400) // 3600
+    minutes = (seconds % 3600) // 60
+    seconds = seconds % 60
+
+    time_parts = [(days, "day"), (hours, "hour"), (minutes, "minute"), (seconds, "second")]
+
+    parts = [f"{value} {label}{'s' if value != 1 else ''}" for value, label in time_parts if value > 0]
+
+    return " and ".join(filter(None, [", ".join(parts[:-1])] + parts[-1:])) if parts else "0 seconds"

{locust-2.32.1.dev39 → locust-2.32.2}/locust/web.py

@@ -11,10 +11,11 @@ from io import StringIO
 from itertools import chain
 from json import dumps
 from time import time
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, TypedDict
 
 import gevent
 from flask import (
+    Blueprint,
     Flask,
     Response,
     jsonify,
@@ -40,7 +41,7 @@ from .runners import STATE_MISSING, STATE_RUNNING, MasterRunner
 from .stats import StatsCSV, StatsCSVFileWriter, StatsErrorDict, sort_stats
 from .user.inspectuser import get_ratio
 from .util.cache import memoize
-from .util.date import format_utc_timestamp
+from .util.date import format_safe_timestamp
 from .util.timespan import parse_timespan
 
 if TYPE_CHECKING:
@@ -53,6 +54,34 @@ greenlet_exception_handler = greenlet_exception_logger(logger)
 DEFAULT_CACHE_TIME = 2.0
 
 
+class InputField(TypedDict, total=False):
+    label: str
+    name: str
+    default_value: bool | None
+    choices: list[str] | None
+    is_secret: bool | None
+
+
+class CustomForm(TypedDict, total=False):
+    inputs: list[InputField] | None
+    callback_url: str
+    submit_button_text: str | None
+
+
+class AuthProvider(TypedDict, total=False):
+    label: str | None
+    callback_url: str
+    icon_url: str | None
+
+
+class AuthArgs(TypedDict, total=False):
+    custom_form: CustomForm
+    auth_providers: list[AuthProvider]
+    username_password_callback: str
+    error: str
+    info: str
+
+
 class WebUI:
     """
     Sets up and runs a Flask web app that can start and stop load tests using the
@@ -84,7 +113,7 @@ class WebUI:
     """Arguments used to render index.html for the web UI. Must be used with custom templates
     extending index.html."""
 
-    auth_args: dict[str, Any]
+    auth_args: AuthArgs
     """Arguments used to render auth.html for the web UI auth page. Must be used when configuring auth"""
 
     def __init__(
@@ -92,6 +121,7 @@ class WebUI:
         environment: Environment,
         host: str,
         port: int,
+        web_base_path: str | None = None,
         web_login: bool = False,
         tls_cert: str | None = None,
         tls_key: str | None = None,
@@ -133,20 +163,21 @@ class WebUI:
         self.auth_args = {}
         self.app.template_folder = build_path or DEFAULT_BUILD_PATH
         self.app.static_url_path = "/assets/"
+
+        app_blueprint = Blueprint("locust", __name__, url_prefix=web_base_path)
         # ensures static js files work on Windows
         mimetypes.add_type("application/javascript", ".js")
-
         if self.web_login:
             self._login_manager = LoginManager()
             self._login_manager.init_app(self.app)
-            self._login_manager.login_view = "login"
+            self._login_manager.login_view = "locust.login"
 
         if environment.runner:
             self.update_template_args()
         if not delayed_start:
             self.start()
 
-        @app.errorhandler(Exception)
+        @app_blueprint.errorhandler(Exception)
         def handle_exception(error):
             error_message = str(error)
             error_code = getattr(error, "code", 500)
@@ -156,7 +187,7 @@ class WebUI:
             )
             return make_response(error_message, error_code)
 
-        @app.route("/assets/<path:path>")
+        @app_blueprint.route("/assets/<path:path>")
         def send_assets(path):
             directory = (
                 os.path.join(self.app.template_folder, "assets")
@@ -166,7 +197,7 @@ class WebUI:
 
             return send_from_directory(directory, path)
 
-        @app.route("/")
+        @app_blueprint.route("/")
         @self.auth_required_if_enabled
         def index() -> str | Response:
             if not environment.runner:
@@ -175,7 +206,7 @@ class WebUI:
 
             return render_template("index.html", template_args=self.template_args)
 
-        @app.route("/swarm", methods=["POST"])
+        @app_blueprint.route("/swarm", methods=["POST"])
         @self.auth_required_if_enabled
         def swarm() -> Response:
             assert request.method == "POST"
@@ -289,7 +320,7 @@ class WebUI:
             else:
                 return jsonify({"success": False, "message": "No runner", "host": environment.host})
 
-        @app.route("/stop")
+        @app_blueprint.route("/stop")
         @self.auth_required_if_enabled
         def stop() -> Response:
             if self._swarm_greenlet is not None:
@@ -299,7 +330,7 @@ class WebUI:
                 environment.runner.stop()
             return jsonify({"success": True, "message": "Test stopped"})
 
-        @app.route("/stats/reset")
+        @app_blueprint.route("/stats/reset")
         @self.auth_required_if_enabled
         def reset_stats() -> str:
             environment.events.reset_stats.fire()
@@ -308,7 +339,7 @@ class WebUI:
                 environment.runner.exceptions = {}
             return "ok"
 
-        @app.route("/stats/report")
+        @app_blueprint.route("/stats/report")
         @self.auth_required_if_enabled
         def stats_report() -> Response:
             theme = request.args.get("theme", "")
@@ -319,17 +350,25 @@ class WebUI:
             )
             if request.args.get("download"):
                 res = app.make_response(res)
-                res.headers["Content-Disposition"] = f"attachment;filename=report_{time()}.html"
+                host = f"_{self.environment.host}" if self.environment.host else ""
+                res.headers["Content-Disposition"] = (
+                    f"attachment;filename=Locust_{format_safe_timestamp(self.environment.stats.start_time)}_"
+                    + f"{self.environment.locustfile}{host}.html"
+                )
             return res
 
         def _download_csv_suggest_file_name(suggest_filename_prefix: str) -> str:
             """Generate csv file download attachment filename suggestion.
 
             Arguments:
-            suggest_filename_prefix: Prefix of the filename to suggest for saving the download. Will be appended with timestamp.
+            suggest_filename_prefix: Prefix of the filename to suggest for saving the download.
+            Will be appended with timestamp.
             """
-
-            return f"{suggest_filename_prefix}_{time()}.csv"
+            host = f"_{self.environment.host}" if self.environment.host else ""
+            return (
+                f"Locust_{format_safe_timestamp(self.environment.stats.start_time)}_"
+                + f"{self.environment.locustfile}{host}_{suggest_filename_prefix}.csv"
+            )
 
         def _download_csv_response(csv_data: str, filename_prefix: str) -> Response:
             """Generate csv file download response with 'csv_data'.
@@ -346,7 +385,7 @@ class WebUI:
             )
             return response
 
-        @app.route("/stats/requests/csv")
+        @app_blueprint.route("/stats/requests/csv")
         @self.auth_required_if_enabled
         def request_stats_csv() -> Response:
             data = StringIO()
@@ -354,7 +393,7 @@ class WebUI:
             self.stats_csv_writer.requests_csv(writer)
             return _download_csv_response(data.getvalue(), "requests")
 
-        @app.route("/stats/requests_full_history/csv")
+        @app_blueprint.route("/stats/requests_full_history/csv")
         @self.auth_required_if_enabled
         def request_stats_full_history_csv() -> Response:
             options = self.environment.parsed_options
@@ -372,7 +411,7 @@ class WebUI:
 
             return make_response("Error: Server was not started with option to generate full history.", 404)
 
-        @app.route("/stats/failures/csv")
+        @app_blueprint.route("/stats/failures/csv")
         @self.auth_required_if_enabled
         def failures_stats_csv() -> Response:
             data = StringIO()
@@ -380,7 +419,7 @@ class WebUI:
             self.stats_csv_writer.failures_csv(writer)
             return _download_csv_response(data.getvalue(), "failures")
 
-        @app.route("/stats/requests")
+        @app_blueprint.route("/stats/requests")
         @self.auth_required_if_enabled
         @memoize(timeout=DEFAULT_CACHE_TIME, dynamic_timeout=True)
         def request_stats() -> Response:
@@ -450,7 +489,7 @@ class WebUI:
 
             return jsonify(report)
 
-        @app.route("/exceptions")
+        @app_blueprint.route("/exceptions")
         @self.auth_required_if_enabled
         def exceptions() -> Response:
             return jsonify(
@@ -467,7 +506,7 @@ class WebUI:
                 }
             )
 
-        @app.route("/exceptions/csv")
+        @app_blueprint.route("/exceptions/csv")
         @self.auth_required_if_enabled
         def exceptions_csv() -> Response:
             data = StringIO()
@@ -475,7 +514,7 @@ class WebUI:
             self.stats_csv_writer.exceptions_csv(writer)
             return _download_csv_response(data.getvalue(), "exceptions")
 
-        @app.route("/tasks")
+        @app_blueprint.route("/tasks")
         @self.auth_required_if_enabled
         def tasks() -> dict[str, dict[str, dict[str, float]]]:
             runner = self.environment.runner
@@ -495,24 +534,25 @@ class WebUI:
             }
             return task_data
 
-        @app.route("/logs")
+        @app_blueprint.route("/logs")
         @self.auth_required_if_enabled
         def logs():
             return jsonify({"master": get_logs(), "workers": self.environment.worker_logs})
 
-        @app.route("/login")
+        @app_blueprint.route("/login")
         def login():
             if not self.web_login:
-                return redirect(url_for("index"))
+                return redirect(url_for("locust.index"))
 
             self.auth_args["error"] = session.get("auth_error", None)
+            self.auth_args["info"] = session.get("auth_info", None)
 
             return render_template_from(
                 "auth.html",
                 auth_args=self.auth_args,
             )
 
-        @app.route("/user", methods=["POST"])
+        @app_blueprint.route("/user", methods=["POST"])
         def update_user():
             assert request.method == "POST"
 
@@ -521,6 +561,8 @@ class WebUI:
 
             return {}, 201
 
+        app.register_blueprint(app_blueprint)
+
     @property
     def login_manager(self):
         if self.web_login:
@@ -577,6 +619,7 @@ class WebUI:
             if self.web_login:
                 try:
                     session["auth_error"] = None
+                    session["auth_info"] = None
                     return login_required(view_func)(*args, **kwargs)
                 except Exception as e:
                     return f"Locust auth exception: {e} See https://docs.locust.io/en/stable/extending-locust.html#adding-authentication-to-the-web-ui for configuring authentication."