locust 2.32.11.dev9__py3-none-any.whl → 2.32.11.dev13__py3-none-any.whl

locust/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.32.11.dev9'
-__version_tuple__ = version_tuple = (2, 32, 11, 'dev9')
+__version__ = version = '2.32.11.dev13'
+__version_tuple__ = version_tuple = (2, 32, 11, 'dev13')

locust/argument_parser.py

@@ -208,6 +208,9 @@ Usage: locust [options] [UserClass ...]
 
     locust --headless -u 100 -t 20m --processes 4 MyHttpUser AnotherUser
 
+    locust --headless -u 100 -r 10 -t 50 --print-stats --html "test_report_{u}_{r}_{t}.html" -H https://www.example.com
+    (The above run would generate an html file with the name "test_report_100_10_50.html")
+
 See documentation for more details, including how to set options using a file or environment variables: https://docs.locust.io/en/stable/configuration.html""",
     )
     parser.add_argument(
@@ -754,7 +757,7 @@ Typically ONLY these options (and --locustfile) need to be specified on workers,
         "--html",
         metavar="<filename>",
         dest="html_file",
-        help="Store HTML report to file path specified",
+        help="Store HTML report to file path specified. Able to parse certain tags - {u}, {r}, {t} and convert them to number of users, spawn rate and run time respectively.",
         env_var="LOCUST_HTML",
     )
     stats_group.add_argument(

locust/html.py

@@ -15,6 +15,25 @@ 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")
 
 
+def process_html_filename(options) -> None:
+    num_users = options.num_users
+    spawn_rate = options.spawn_rate
+    run_time = options.run_time
+
+    option_mapping = {
+        "{u}": num_users,
+        "{r}": spawn_rate,
+        "{t}": run_time,
+    }
+
+    html_filename = options.html_file
+
+    for option_term, option_value in option_mapping.items():
+        html_filename = html_filename.replace(option_term, str(int(option_value)))
+
+    options.html_file = html_filename
+
+
 def render_template_from(file, build_path=DEFAULT_BUILD_PATH, **kwargs):
     env = JinjaEnvironment(loader=FileSystemLoader(build_path))
     template = env.get_template(file)

locust/main.py

@@ -20,7 +20,7 @@ import gevent
 from . import log, stats
 from .argument_parser import parse_locustfile_option, parse_options
 from .env import Environment
-from .html import get_html_report
+from .html import get_html_report, process_html_filename
 from .input_events import input_listener
 from .log import greenlet_exception_logger, setup_logging
 from .stats import (
@@ -651,6 +651,7 @@ See https://github.com/locustio/locust/wiki/Installation#increasing-maximum-numb
 
     def save_html_report():
         html_report = get_html_report(environment, show_download_link=False)
+        process_html_filename(options)
         logger.info("writing html report to file: %s", options.html_file)
         with open(options.html_file, "w", encoding="utf-8") as file:
             file.write(html_report)