locust 2.32.2.dev19__py3-none-any.whl → 2.32.2.dev34__py3-none-any.whl

locust/_version.py

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

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/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/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/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/web.py

@@ -15,6 +15,7 @@ from typing import TYPE_CHECKING, Any, TypedDict
 
 import gevent
 from flask import (
+    Blueprint,
     Flask,
     Response,
     jsonify,
@@ -120,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,
@@ -161,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)
@@ -184,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")
@@ -194,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:
@@ -203,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"
@@ -317,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:
@@ -327,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()
@@ -336,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", "")
@@ -382,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()
@@ -390,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
@@ -408,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()
@@ -416,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:
@@ -486,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(
@@ -503,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()
@@ -511,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
@@ -531,15 +534,15 @@ 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)
@@ -549,7 +552,7 @@ class WebUI:
                 auth_args=self.auth_args,
             )
 
-        @app.route("/user", methods=["POST"])
+        @app_blueprint.route("/user", methods=["POST"])
         def update_user():
             assert request.method == "POST"
 
@@ -558,6 +561,8 @@ class WebUI:
 
             return {}, 201
 
+        app.register_blueprint(app_blueprint)
+
     @property
     def login_manager(self):
         if self.web_login:

{locust-2.32.2.dev19.dist-info → locust-2.32.2.dev34.dist-info}/METADATA

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

{locust-2.32.2.dev19.dist-info → locust-2.32.2.dev34.dist-info}/RECORD

@@ -1,7 +1,7 @@
 locust/__init__.py,sha256=Jit8eNUrwuMLqavyFvMZr69e61DILq_KB4yT4MciScw,1681
 locust/__main__.py,sha256=vBQ82334kX06ImDbFlPFgiBRiLIinwNk3z8Khs6hd74,31
-locust/_version.py,sha256=dAoefD2JjRrFZS7zkL9p4T6yjIMEHwk4JeynkD6_F5g,460
-locust/argument_parser.py,sha256=Q_P7Yt0KdtOiNAgTZcEVuxX9eGzJoyibI3mPrf0vzvA,29184
+locust/_version.py,sha256=yJ7AQeYbmnb_G0YVzPTbL51vIUG21tYcikti09oKDv8,460
+locust/argument_parser.py,sha256=QA8A-VHrAp4LAl2zhOpAozHcsw0Act8N_9Q9zsy2Ln4,29424
 locust/clients.py,sha256=XK-xabq2_5GZKMEjebDobvEjeBTtCs8h2EelL7s68Qs,19346
 locust/contrib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 locust/contrib/fasthttp.py,sha256=Fs83qq8zqT4_aTnA8JUQaIWo2IBj-LNi2AKflx8yGtg,28858
@@ -9,18 +9,18 @@ locust/contrib/mongodb.py,sha256=1seUYgJOaNKwybYOP9PUEVhgl8hGy-G33f8lFj3R8W8,124
 locust/contrib/postgres.py,sha256=OuMWnGYN10K65Tq2axVESEW25Y0g5gJb0rK90jkcCJg,1230
 locust/debug.py,sha256=7CCm8bIg44uGH2wqBlo1rXBzV2VzwPicLxLewz8r5CQ,5099
 locust/dispatch.py,sha256=prdwtb9EoN4A9klgiKgWuwQmvFB8hEuFHOK6ot62AJI,16202
-locust/env.py,sha256=e5FNcpoftv8G0D86cR1t1cXatumBmCIDA7DbR1JjOSw,13000
+locust/env.py,sha256=URPRltUBdOdCCO1yb2WmE9JeUlI_SAm9l7cvR9j1c_s,13083
 locust/event.py,sha256=AWoeG2q11Vpupv1eW9Rf2N0EI4dDDAldKe6zY1ajC7I,8717
 locust/exception.py,sha256=jGgJ32ubuf4pWdlaVOkbh2Y0LlG0_DHi-lv3ib8ppOE,1791
 locust/html.py,sha256=TCwCa93t7l-M6SEAxDA2hIw18JztQw46eDkXxgbs254,3614
 locust/input_events.py,sha256=ZIyePyAMuA_YFYWg18g_pE4kwuQV3RbEB250MzXRwjY,3314
 locust/log.py,sha256=Wrkn0Ibugh5Sqjm4hGQ2-jUsy1tNMBdTctp4FyXQI24,3457
-locust/main.py,sha256=HvE5EBnfkEEJWggb4KGxBJQr4ndvCb62-nKwKNpV9_A,29498
+locust/main.py,sha256=LEr4WaPCraEOF8mt0-FY8r1MveF6G9y6lsnRxm66PNc,29933
 locust/py.typed,sha256=gkWLl8yD4mIZnNYYAIRM8g9VarLvWmTAFeUfEbxJLBw,65
 locust/rpc/__init__.py,sha256=nVGoHWFQxZjnhCDWjbgXIbmFbN9sizAjkhvSs9_642c,58
 locust/rpc/protocol.py,sha256=n-rb3GZQcAlldYDj4E4GuFGylYj_26GSS5U29meft5Y,1282
 locust/rpc/zmqrpc.py,sha256=_zl0DKazQLD2YyqxvyuskVApsDCaUnhloHvV8SkJxjw,3157
-locust/runners.py,sha256=YwUFagjLcNEXj4_64g047xWncL5m4Hd99Lg6PzYkGOQ,70366
+locust/runners.py,sha256=vO_2Nv7WHcHnUguIpNCBstSAln4Zg1S4ExfFoHQpo4A,70514
 locust/shape.py,sha256=t-lwBS8LOjWcKXNL7j2U3zroIXJ1b0fazUwpRYQOKXw,1973
 locust/stats.py,sha256=z_s98ClnSfryvRi-VS0c7u5g87B_o4qL8nkunkPuhPI,45989
 locust/user/__init__.py,sha256=S2yvmI_AU9kXirtTIVqiV_Hs7yXzqXvaSgkNo9ig-fk,71
@@ -39,7 +39,7 @@ locust/util/load_locustfile.py,sha256=hn70KcIG8jHmZyuKv2pcEmwgWtOEu24Efeji1KRYNU
 locust/util/rounding.py,sha256=5haxR8mKhATqag6WvPby-MSRRgIw5Ob6thbyvMYZM7o,92
 locust/util/timespan.py,sha256=Y0LtnhUq2Mq19p04u0XtBlYQ_-S2cRvwRdgru8W9WhA,986
 locust/util/url.py,sha256=s_W2PCxvxTWxWX0yUvp-8VBuQm881KwI5X9iifogZG4,321
-locust/web.py,sha256=AZpd8HaQ-VaMiaZz9tTWJL4uLCfHViargrnvdG-LtYk,29363
+locust/web.py,sha256=iV0VM6nIhals1seZSkDoKMOdAQciv8cbz_Uaq2OF2hI,29731
 locust/webui/dist/assets/favicon-dark.png,sha256=6zVkRtiRfU45qQGvEhf1cq2nNauFs_JW5SI79wT0YkM,2437
 locust/webui/dist/assets/favicon-light.png,sha256=VdG2GZyeTCOML7xfievupBP4EhmHoUqlVCw-tXqkvxU,2468
 locust/webui/dist/assets/index-CV_-ndKF.js,sha256=YNaB15qUPWDD41yMWEB-9ZuyQIPVVW2bzACpKmowu-c,1674517
@@ -47,8 +47,8 @@ locust/webui/dist/auth.html,sha256=Na04RsfJNXyscodaY3CjreTxUmeYnXaOONhSxPB-59Y,6
 locust/webui/dist/index.html,sha256=ozpUdS047Z-rFgrKq1J-40FNHZlkR36tbhzipbxkS5o,654
 locust/webui/dist/report.html,sha256=Ok3WzJmly4E0pyBuHmzIVJx7e36zdyqgJ0VwmwVQnuE,1470993
 poetry.lock,sha256=NUOC8hV7YCL5kHXj3GF2Kb16DLRCXoZUjiWXPghYEyg,213450
-locust-2.32.2.dev19.dist-info/LICENSE,sha256=78XGpIn3fHVBfaxlPNUfjVufSN7QsdhpJMRJHv2AFpo,1095
-locust-2.32.2.dev19.dist-info/METADATA,sha256=7bnBB-gNKZyvDB6-qW2pH1BE3PyiVoGtzRJ67LNgE6I,7877
-locust-2.32.2.dev19.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-locust-2.32.2.dev19.dist-info/entry_points.txt,sha256=RhIxlLwU_Ae_WjimS5COUDLagdCh6IOMyLtgaQxNmlM,43
-locust-2.32.2.dev19.dist-info/RECORD,,
+locust-2.32.2.dev34.dist-info/LICENSE,sha256=78XGpIn3fHVBfaxlPNUfjVufSN7QsdhpJMRJHv2AFpo,1095
+locust-2.32.2.dev34.dist-info/METADATA,sha256=xQFxLnO25rHnbPp_y4xWuX2r10IykrzdBe5SG_5pqpk,7877
+locust-2.32.2.dev34.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+locust-2.32.2.dev34.dist-info/entry_points.txt,sha256=RhIxlLwU_Ae_WjimS5COUDLagdCh6IOMyLtgaQxNmlM,43
+locust-2.32.2.dev34.dist-info/RECORD,,