locust 2.27.0__tar.gz → 2.27.1.dev10__tar.gz

{locust-2.27.0 → locust-2.27.1.dev10}/CHANGELOG.md

@@ -1,6 +1,31 @@
 # Detailed changelog
 The most important changes can also be found in [the documentation](https://docs.locust.io/en/latest/changelog.html).
 
+## [2.27.0](https://github.com/locustio/locust/tree/2.27.0) (2024-05-06)
+
+[Full Changelog](https://github.com/locustio/locust/compare/2.26.0...2.27.0)
+
+**Fixed bugs:**
+
+- User Classes with Empty Tasks Results in TypeError: 'NoneType' object is not iterable [\#2694](https://github.com/locustio/locust/issues/2694)
+
+**Closed issues:**
+
+- Why defining run\_time on worker node raises an error [\#2683](https://github.com/locustio/locust/issues/2683)
+
+**Merged pull requests:**
+
+- annotate return types of a few functions to enable more mypy check [\#2702](https://github.com/locustio/locust/pull/2702) ([tdadela](https://github.com/tdadela))
+- refactor\(WindowsKeyPoller\): change implementation of captured\_chars  [\#2701](https://github.com/locustio/locust/pull/2701) ([tdadela](https://github.com/tdadela))
+- refactor: replace deprecated utcfromtimestamp function [\#2700](https://github.com/locustio/locust/pull/2700) ([tdadela](https://github.com/tdadela))
+- Use deque for tasks in taskset instead of plain list [\#2698](https://github.com/locustio/locust/pull/2698) ([cyberw](https://github.com/cyberw))
+- fix: Ensure locust does not crash when an User class has no task [\#2696](https://github.com/locustio/locust/pull/2696) ([hangonlyra](https://github.com/hangonlyra))
+- Fix various spelling errors using codespell [\#2687](https://github.com/locustio/locust/pull/2687) ([cyberw](https://github.com/cyberw))
+- Dispatch/user distribution calculation using Kullback-Leibler divergence [\#2686](https://github.com/locustio/locust/pull/2686) ([tdadela](https://github.com/tdadela))
+- Allow worker process to run with --run-time specified, just log a warning about it being ignored [\#2685](https://github.com/locustio/locust/pull/2685) ([Sawiq](https://github.com/Sawiq))
+- Small cleanup: mypy type-ignore and dev deps [\#2684](https://github.com/locustio/locust/pull/2684) ([tdadela](https://github.com/tdadela))
+- Simplify how locustfiles are found \(using -f\). Don’t automatically append .py [\#2655](https://github.com/locustio/locust/pull/2655) ([DennisKrone](https://github.com/DennisKrone))
+
 ## [2.26.0](https://github.com/locustio/locust/tree/2.26.0) (2024-04-18)
 
 [Full Changelog](https://github.com/locustio/locust/compare/2.25.0...2.26.0)
@@ -35,7 +60,6 @@ The most important changes can also be found in [the documentation](https://docs
 - Add an example that displays cache stats using the new UI. [\#2669](https://github.com/locustio/locust/pull/2669) ([obriat](https://github.com/obriat))
 - Update User Classes in Distributed Mode [\#2666](https://github.com/locustio/locust/pull/2666) ([andrewbaldwin44](https://github.com/andrewbaldwin44))
 - fix\(dispatch\): UserClasses weight distribution with gcd [\#2663](https://github.com/locustio/locust/pull/2663) ([llirrikk](https://github.com/llirrikk))
-- chore: fix some comments [\#2659](https://github.com/locustio/locust/pull/2659) ([JohnEndson](https://github.com/JohnEndson))
 - Fix issue with concurrent custom messages and docs [\#2654](https://github.com/locustio/locust/pull/2654) ([cyberw](https://github.com/cyberw))
 - Add functionality to run listener functions for `custom_messages` concurrently [\#2650](https://github.com/locustio/locust/pull/2650) ([samuelspagl](https://github.com/samuelspagl))
 - \[Modern UI\] Escape HTML Entities correctly in Exceptions Table [\#2648](https://github.com/locustio/locust/pull/2648) ([andrewbaldwin44](https://github.com/andrewbaldwin44))

{locust-2.27.0 → locust-2.27.1.dev10}/MANIFEST.in

@@ -1,5 +1,3 @@
 include LICENSE
 include locust/py.typed
-recursive-include locust/static *
-recursive-include locust/templates *
 recursive-include locust/webui/dist *

{locust-2.27.0/locust.egg-info → locust-2.27.1.dev10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: locust
-Version: 2.27.0
+Version: 2.27.1.dev10
 Summary: Developer friendly load testing framework
 License: MIT
 Project-URL: Homepage, https://github.com/locustio/locust

{locust-2.27.0 → locust-2.27.1.dev10}/docs/configuration.rst

@@ -272,7 +272,5 @@ The list of statistics parameters that can be modified is:
 +-------------------------------------------+--------------------------------------------------------------------------------------+
 | PERCENTILES_TO_CHART                      | List of response time percentiles in the screen of chart for UI                      |
 +-------------------------------------------+--------------------------------------------------------------------------------------+
-| MODERN_UI_PERCENTILES_TO_CHART            | List of response time percentiles in the screen of chart for the UI                  |
-+-------------------------------------------+--------------------------------------------------------------------------------------+
 | PERCENTILES_TO_STATISTICS                 | List of response time percentiles in the screen of statistics for UI                 |
 +-------------------------------------------+--------------------------------------------------------------------------------------+

{locust-2.27.0 → locust-2.27.1.dev10}/docs/developing-locust.rst

@@ -90,7 +90,7 @@ Then the documentation should be build and available at ``docs/_build/index.html
 Making changes to Locust's Web UI
 =================================
 
-The modern Web UI is built using React and Typescript
+The Web UI is built using React and Typescript
 
 Setup
 -----

locust-2.27.0/examples/extend_modern_web_ui.py → locust-2.27.1.dev10/examples/extend_web_ui.py

@@ -92,8 +92,6 @@ def locust_init(environment, **kwargs):
             """
             # ensure the template_args are up to date before using them
             environment.web_ui.update_template_args()
-            # set the static paths to use the modern ui
-            environment.web_ui.set_static_modern_ui()
 
             return render_template(
                 "index.html",

{locust-2.27.0 → locust-2.27.1.dev10}/locust/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.27.0'
-__version_tuple__ = version_tuple = (2, 27, 0)
+__version__ = version = '2.27.1.dev10'
+__version_tuple__ = version_tuple = (2, 27, 1, 'dev10')

{locust-2.27.0 → locust-2.27.1.dev10}/locust/argument_parser.py

@@ -32,6 +32,16 @@ version = locust.__version__
 DEFAULT_CONFIG_FILES = ("~/.locust.conf", "locust.conf", "pyproject.toml")
 
 
+# Clean up downloaded locustfile on exit
+def exit_handler(filename) -> None:
+    try:
+        os.remove(filename)
+    except FileNotFoundError:
+        pass  # when multiple workers are running on the same machine, another one may already have deleted it
+    except PermissionError:
+        pass  # this happens occasionally on windows on GH, maybe for the same reason?
+
+
 class LocustArgumentParser(configargparse.ArgumentParser):
     """Drop-in replacement for `configargparse.ArgumentParser` that adds support for
     optionally exclude arguments from the UI.
@@ -170,14 +180,7 @@ def download_locustfile_from_url(url: str) -> str:
     with open(os.path.join(tempfile.gettempdir(), url.rsplit("/", 1)[-1]), "w") as locustfile:
         locustfile.write(response.text)
 
-    # Clean up downloaded files on exit
-    def exit_handler():
-        try:
-            os.remove(locustfile.name)
-        except FileNotFoundError:
-            pass  # this is normal when multiple workers are running on the same machine
-
-    atexit.register(exit_handler)
+    atexit.register(exit_handler, locustfile.name)
     return locustfile.name
 
 
@@ -263,13 +266,7 @@ def download_locustfile_from_master(master_host: str, master_port: int) -> str:
     with open(os.path.join(tempfile.gettempdir(), filename), "w", encoding="utf-8") as locustfile:
         locustfile.write(msg.data["contents"])
 
-    def exit_handler():
-        try:
-            os.remove(locustfile.name)
-        except FileNotFoundError:
-            pass  # this is normal when multiple workers are running on the same machine
-
-    atexit.register(exit_handler)
+    atexit.register(exit_handler, locustfile.name)
 
     tempclient.close()
     return locustfile.name
@@ -500,7 +497,7 @@ def setup_parser_arguments(parser):
         "--legacy-ui",
         default=False,
         action="store_true",
-        help="Use the legacy frontend for the web UI (deprecated, support will be removed soon)",
+        help=configargparse.SUPPRESS,
         env_var="LOCUST_LEGACY_UI",
     )
 

{locust-2.27.0 → locust-2.27.1.dev10}/locust/env.py

@@ -166,7 +166,6 @@ class Environment:
         stats_csv_writer: StatsCSV | None = None,
         delayed_start=False,
         userclass_picker_is_active=False,
-        modern_ui=False,
     ) -> WebUI:
         """
         Creates a :class:`WebUI <locust.web.WebUI>` instance for this Environment and start running the web server
@@ -193,7 +192,6 @@ class Environment:
             stats_csv_writer=stats_csv_writer,
             delayed_start=delayed_start,
             userclass_picker_is_active=userclass_picker_is_active,
-            modern_ui=modern_ui,
         )
         return self.web_ui
 

locust-2.27.1.dev10/locust/html.py

@@ -0,0 +1,111 @@
+import datetime
+import glob
+import os
+import pathlib
+from html import escape
+from itertools import chain
+from json import dumps
+
+from jinja2 import Environment, FileSystemLoader
+
+from . import stats as stats_module
+from .runners import STATE_STOPPED, STATE_STOPPING, MasterRunner
+from .stats import sort_stats
+from .user.inspectuser import get_ratio
+
+PERCENTILES_FOR_HTML_REPORT = [0.50, 0.6, 0.7, 0.8, 0.9, 0.95, 0.99, 1.0]
+ROOT_PATH = os.path.dirname(os.path.abspath(__file__))
+BUILD_PATH = os.path.join(ROOT_PATH, "webui", "dist")
+STATIC_PATH = os.path.join(BUILD_PATH, "assets")
+
+
+def render_template(file, **kwargs):
+    env = Environment(loader=FileSystemLoader(BUILD_PATH), extensions=["jinja2.ext.do"])
+    template = env.get_template(file)
+    return template.render(**kwargs)
+
+
+def get_html_report(
+    environment,
+    show_download_link=True,
+    theme="",
+):
+    stats = environment.runner.stats
+
+    start_ts = stats.start_time
+    start_time = datetime.datetime.fromtimestamp(start_ts, tz=datetime.timezone.utc).strftime("%Y-%m-%d %H:%M:%S")
+
+    if end_ts := stats.last_request_timestamp:
+        end_time = datetime.datetime.fromtimestamp(end_ts, tz=datetime.timezone.utc).strftime("%Y-%m-%d %H:%M:%S")
+    else:
+        end_time = start_time
+
+    host = None
+    if environment.host:
+        host = environment.host
+    elif environment.runner.user_classes:
+        all_hosts = {l.host for l in environment.runner.user_classes}
+        if len(all_hosts) == 1:
+            host = list(all_hosts)[0]
+
+    requests_statistics = list(chain(sort_stats(stats.entries), [stats.total]))
+    failures_statistics = sort_stats(stats.errors)
+    exceptions_statistics = [
+        {**exc, "nodes": ", ".join(exc["nodes"])} for exc in environment.runner.exceptions.values()
+    ]
+
+    history = stats.history
+
+    static_js = []
+    js_files = [os.path.basename(filepath) for filepath in glob.glob(os.path.join(STATIC_PATH, "*.js"))]
+
+    for js_file in js_files:
+        path = os.path.join(STATIC_PATH, js_file)
+        static_js.append("// " + js_file + "\n")
+        with open(path, encoding="utf8") as f:
+            static_js.append(f.read())
+        static_js.extend(["", ""])
+
+    is_distributed = isinstance(environment.runner, MasterRunner)
+    user_spawned = (
+        environment.runner.reported_user_classes_count if is_distributed else environment.runner.user_classes_count
+    )
+
+    if environment.runner.state in [STATE_STOPPED, STATE_STOPPING]:
+        user_spawned = environment.runner.final_user_classes_count
+
+    task_data = {
+        "per_class": get_ratio(environment.user_classes, user_spawned, False),
+        "total": get_ratio(environment.user_classes, user_spawned, True),
+    }
+
+    return render_template(
+        "report.html",
+        template_args={
+            "is_report": True,
+            "requests_statistics": [stat.to_dict(escape_string_values=True) for stat in requests_statistics],
+            "failures_statistics": [stat.to_dict() for stat in failures_statistics],
+            "exceptions_statistics": [stat for stat in exceptions_statistics],
+            "response_time_statistics": [
+                {
+                    "name": escape(stat.name),
+                    "method": escape(stat.method or ""),
+                    **{
+                        str(percentile): stat.get_response_time_percentile(percentile)
+                        for percentile in PERCENTILES_FOR_HTML_REPORT
+                    },
+                }
+                for stat in requests_statistics
+            ],
+            "start_time": start_time,
+            "end_time": end_time,
+            "host": escape(str(host)),
+            "history": history,
+            "show_download_link": show_download_link,
+            "locustfile": escape(str(environment.locustfile)),
+            "tasks": task_data,
+            "percentiles_to_chart": stats_module.PERCENTILES_TO_CHART,
+        },
+        theme=theme,
+        static_js="\n".join(static_js),
+    )

{locust-2.27.0 → locust-2.27.1.dev10}/locust/log.py

@@ -1,8 +1,9 @@
 import logging
 import logging.config
+import re
 import socket
 
-HOSTNAME = socket.gethostname()
+HOSTNAME = re.sub(r"\..*", "", socket.gethostname())
 
 # Global flag that we set to True if any unhandled exception occurs in a greenlet
 # Used by main.py to set the process return code to non-zero

{locust-2.27.0 → locust-2.27.1.dev10}/locust/main.py

@@ -128,12 +128,8 @@ def main():
             available_user_classes[key] = value
             available_user_tasks[key] = value.tasks or {}
 
-    if len(stats.PERCENTILES_TO_CHART) != 2:
-        logging.error("stats.PERCENTILES_TO_CHART parameter should be 2 parameters \n")
-        sys.exit(1)
-
-    if len(stats.MODERN_UI_PERCENTILES_TO_CHART) > 6:
-        logging.error("stats.MODERN_UI_PERCENTILES_TO_CHART parameter should be a maximum of 6 parameters \n")
+    if len(stats.PERCENTILES_TO_CHART) > 6:
+        logging.error("stats.PERCENTILES_TO_CHART parameter should be a maximum of 6 parameters \n")
         sys.exit(1)
 
     def is_valid_percentile(parameter):
@@ -183,7 +179,8 @@ def main():
         options.spawn_rate = options.hatch_rate
 
     if options.legacy_ui:
-        sys.stderr.write("[DEPRECATED] The legacy UI is deprecated and will be removed soon\n")
+        sys.stderr.write("[REMOVED] The legacy UI has been removed. Remove this flag to use the new UI")
+        sys.exit(1)
 
     # setup logging
     if not options.skip_log_setup:
@@ -480,7 +477,6 @@ See https://github.com/locustio/locust/wiki/Installation#increasing-maximum-numb
             stats_csv_writer=stats_csv_writer,
             delayed_start=True,
             userclass_picker_is_active=options.class_picker,
-            modern_ui=not options.legacy_ui,
         )
     else:
         web_ui = None
@@ -654,8 +650,8 @@ See https://github.com/locustio/locust/wiki/Installation#increasing-maximum-numb
         logger.info("Got SIGTERM signal")
         shutdown()
 
-    def save_html_report(use_modern_ui=False):
-        html_report = get_html_report(environment, show_download_link=False, use_modern_ui=use_modern_ui)
+    def save_html_report():
+        html_report = get_html_report(environment, show_download_link=False)
         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)
@@ -671,10 +667,10 @@ See https://github.com/locustio/locust/wiki/Installation#increasing-maximum-numb
 
         main_greenlet.join()
         if options.html_file:
-            save_html_report(not options.legacy_ui)
+            save_html_report()
     except KeyboardInterrupt:
         if options.html_file:
-            save_html_report(not options.legacy_ui)
+            save_html_report()
     except Exception:
         raise
     shutdown()

{locust-2.27.0 → locust-2.27.1.dev10}/locust/stats.py

@@ -126,8 +126,7 @@ CachedResponseTimes = namedtuple("CachedResponseTimes", ["response_times", "num_
 PERCENTILES_TO_REPORT = [0.50, 0.66, 0.75, 0.80, 0.90, 0.95, 0.98, 0.99, 0.999, 0.9999, 1.0]
 
 PERCENTILES_TO_STATISTICS = [0.95, 0.99]
-PERCENTILES_TO_CHART = [0.50, 0.95]
-MODERN_UI_PERCENTILES_TO_CHART = [0.95]
+PERCENTILES_TO_CHART = [0.95]
 
 
 class RequestStatsAdditionError(Exception):
@@ -695,9 +694,7 @@ class StatsEntry:
             "current_rps": self.current_rps,
             "current_fail_per_sec": self.current_fail_per_sec,
             "median_response_time": self.median_response_time,
-            "ninetieth_response_time": self.get_response_time_percentile(0.9),  # for legacy ui
-            "ninety_ninth_response_time": self.get_response_time_percentile(0.99),  # for legacy ui
-            **response_time_percentiles,  # for modern ui
+            **response_time_percentiles,
             "avg_content_length": self.avg_content_length,
         }
 
@@ -920,7 +917,7 @@ def stats_history(runner: Runner) -> None:
             current_response_time_percentiles = {
                 f"response_time_percentile_{percentile}": stats.total.get_current_response_time_percentile(percentile)
                 or 0
-                for percentile in MODERN_UI_PERCENTILES_TO_CHART
+                for percentile in PERCENTILES_TO_CHART
             }
 
             r = {
@@ -928,10 +925,6 @@ def stats_history(runner: Runner) -> None:
                 "time": datetime.datetime.now(tz=datetime.timezone.utc).strftime("%H:%M:%S"),
                 "current_rps": stats.total.current_rps or 0,
                 "current_fail_per_sec": stats.total.current_fail_per_sec or 0,
-                "response_time_percentile_1": stats.total.get_current_response_time_percentile(PERCENTILES_TO_CHART[0])
-                or 0,
-                "response_time_percentile_2": stats.total.get_current_response_time_percentile(PERCENTILES_TO_CHART[1])
-                or 0,
                 "total_avg_response_time": stats.total.avg_response_time,
                 "user_count": runner.user_count or 0,
             }

{locust-2.27.0 → locust-2.27.1.dev10}/locust/test/test_fasthttp.py

@@ -11,6 +11,7 @@ from tempfile import NamedTemporaryFile
 
 import gevent
 from geventhttpclient.client import HTTPClientPool
+from pyquery import PyQuery as pq
 
 from .testcases import LocustTestCase, WebserverTestCase
 from .util import create_tls_cert
@@ -777,7 +778,8 @@ class TestFastHttpSsl(LocustTestCase):
 
     def test_ssl_request_insecure(self):
         s = FastHttpSession(self.environment, "https://127.0.0.1:%i" % self.web_port, insecure=True, user=None)
-        r = s.get("/")
-        self.assertEqual(200, r.status_code)
-        self.assertIn("<title>Locust for None</title>", r.content.decode("utf-8"))
-        self.assertIn("<p>Script: <span>None</span></p>", r.text)
+        response = s.get("/")
+        d = pq(response.content.decode("utf-8"))
+
+        self.assertEqual(200, response.status_code)
+        self.assertIn('"users": null', str(d))

{locust-2.27.0 → locust-2.27.1.dev10}/locust/test/test_main.py

@@ -219,9 +219,8 @@ class StandaloneIntegrationTests(ProcessIntegrationTest):
             content=textwrap.dedent(
                 """
             from locust import User, task, constant, events
-            from locust.stats import PERCENTILES_TO_CHART
-            PERCENTILES_TO_CHART[0] = 0.9
-            PERCENTILES_TO_CHART[1] = 0.4
+            from locust import stats
+            stats.PERCENTILES_TO_CHART = [0.9, 0.4]
             class TestUser(User):
                 wait_time = constant(3)
                 @task
@@ -274,8 +273,8 @@ class StandaloneIntegrationTests(ProcessIntegrationTest):
             content=textwrap.dedent(
                 """
             from locust import User, task, constant, events
-            from locust.stats import PERCENTILES_TO_CHART
-            PERCENTILES_TO_CHART[0] = 1.2
+            from locust import stats
+            stats.PERCENTILES_TO_CHART  = [1.2]
             class TestUser(User):
                 wait_time = constant(3)
                 @task
@@ -728,7 +727,6 @@ class StandaloneIntegrationTests(ProcessIntegrationTest):
                     "locust",
                     "-f",
                     mocked.file_path,
-                    "--legacy-ui",
                     "--web-port",
                     str(port),
                     "--autostart",
@@ -795,7 +793,6 @@ class StandaloneIntegrationTests(ProcessIntegrationTest):
                         "locust",
                         "-f",
                         f"{mocked1.file_path},{mocked2}",
-                        "--legacy-ui",
                         "--web-port",
                         str(port),
                         "--autostart",
@@ -1115,7 +1112,6 @@ class StandaloneIntegrationTests(ProcessIntegrationTest):
                             "locust",
                             "-f",
                             mocked.file_path,
-                            "--legacy-ui",
                             "--host",
                             "https://test.com/",
                             "--run-time",
@@ -1138,16 +1134,11 @@ class StandaloneIntegrationTests(ProcessIntegrationTest):
 
         # make sure title appears in the report
         _, locustfile = os.path.split(mocked.file_path)
-        self.assertIn(f"<title>Test Report for {locustfile}</title>", html_report_content)
-        self.assertIn(f"<p>Script: <span>{locustfile}</span></p>", html_report_content)
+        self.assertIn(locustfile, html_report_content)
 
         # make sure host appears in the report
         self.assertIn("https://test.com/", html_report_content)
-
-        # make sure the charts container appears in the report
-        self.assertIn("charts-container", html_report_content)
-
-        self.assertNotIn("Download the Report", html_report_content, "Download report link found in HTML content")
+        self.assertIn('"show_download_link": false', html_report_content)
 
     def test_run_with_userclass_picker(self):
         with temporary_file(content=MOCK_LOCUSTFILE_CONTENT_A) as file1: