locust 2.23.2.dev26__tar.gz → 2.23.2.dev39__tar.gz

{locust-2.23.2.dev26 → locust-2.23.2.dev39}/.gitignore

@@ -29,3 +29,4 @@ __pycache__
 yarn-error.log
 .venv
 .DS_Store
+.python-version

{locust-2.23.2.dev26/locust.egg-info → locust-2.23.2.dev39}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: locust
-Version: 2.23.2.dev26
+Version: 2.23.2.dev39
 Summary: Developer friendly load testing framework
 License: MIT
-Project-URL: Homepage, https://locust.io/
+Project-URL: Homepage, https://github.com/locustio/locust
 Project-URL: Documentation, https://docs.locust.io/
 Project-URL: Code, https://github.com/locustio/locust
 Project-URL: Help/Questions, https://stackoverflow.com/questions/tagged/locust
@@ -35,6 +35,7 @@ Requires-Dist: msgpack>=1.0.0
 Requires-Dist: pyzmq>=25.0.0
 Requires-Dist: geventhttpclient>=2.0.11
 Requires-Dist: ConfigArgParse>=1.5.5
+Requires-Dist: tomli>=1.1.0; python_version < "3.11"
 Requires-Dist: psutil>=5.9.1
 Requires-Dist: Flask-Login>=0.6.3
 Requires-Dist: Flask-Cors>=3.0.10

{locust-2.23.2.dev26 → locust-2.23.2.dev39}/docs/configuration.rst

@@ -24,7 +24,8 @@ Locust is configured mainly through command line arguments.
 Environment Variables
 =====================
 
-Options can also be set through through environment variables. They are typically the same as the command line argument but capitalized and prefixed with ``LOCUST_``:
+Options can also be set through environment variables. They are typically the same as the command line argument
+but capitalized and prefixed with ``LOCUST_``:
 
 On Linux/macOS:
 
@@ -44,17 +45,23 @@ On Windows:
 Configuration File
 ==================
 
-Options can also be set in a configuration file in the `config file <https://github.com/bw2/ConfigArgParse#config-file-syntax>`_
-format. 
+Options can also be set in a configuration file in the
+`config or TOML file format <https://github.com/bw2/ConfigArgParse#config-file-syntax>`_.
 
-Locust will look for ``~/.locust.conf`` and ``./locust.conf`` by default, and you can specify an 
-additional file using the ``--config`` flag.
+Locust will look for ``~/.locust.conf``, ``./locust.conf`` and ``./pyproject.toml`` by default.
+You can specify an additional file using the ``--config`` flag.
 
-Example:
+.. code-block:: console
 
-.. code-block::
+    $ locust --config custom_config.conf
+
+Here's a quick example of the configuration files supported by Locust:
+
+locust.conf
+--------------
+
+.. code-block:: ini
 
-    # master.conf in current directory
     locustfile = locust_files/my_locust_file.py
     headless = true
     master = true
@@ -63,19 +70,34 @@ Example:
     users = 100
     spawn-rate = 10
     run-time = 10m
-    
+    tags = [Critical, Normal]
 
-.. code-block:: console
+pyproject.toml
+--------------
 
-    $ locust --config master.conf
+When using a TOML file, configuration options should be defined within the ``[tool.locust]`` section.
+
+.. code-block:: toml
+
+    [tool.locust]
+    locustfile = "locust_files/my_locust_file.py"
+    headless = true
+    master = true
+    expect-workers = 5
+    host = "https://target-system"
+    users = 100
+    spawn-rate = 10
+    run-time = "10m"
+    tags = ["Critical", "Normal"]
 
 .. note::
 
-    Configuration values are read (overridden) in the following order:
+    Configuration values are read (and overridden) in the following order:
     
     .. code-block:: console
         
-        ~/locust.conf -> ./locust.conf -> (file specified using --conf) -> env vars -> cmd args
+       ~/.locust.conf -> ./locust.conf -> ./pyproject.toml -> (file specified using --conf) -> env vars -> cmd args
+
 
 All available configuration options
 ===================================

{locust-2.23.2.dev26 → locust-2.23.2.dev39}/docs/index.rst

@@ -2,14 +2,6 @@
 Locust Documentation
 =====================
 
-.. sidebar:: About locust
-
-    Locust is a scalable load testing framework written in Python
-
-    * **Website**: `https://locust.io/ <https://locust.io/>`_
-    * **Source code**: `https://github.com/locustio/locust <https://github.com/locustio/locust>`_
-    * **Twitter**: `@locustio <https://twitter.com/locustio>`_
-
 
 Getting started
 ---------------

{locust-2.23.2.dev26 → locust-2.23.2.dev39}/docs/logging.rst

@@ -18,7 +18,6 @@ so using the root logger in your own test scripts will put the message into the
     import logging
     logging.info("this log message will go wherever the other locust log messages go")
 
-
 It's also possible to control the whole logging configuration in your own test scripts by using the 
 ``--skip-log-setup`` option. You will then have to 
 `configure the logging <https://docs.python.org/3/library/logging.config.html>`_ yourself.

{locust-2.23.2.dev26 → locust-2.23.2.dev39}/docs/running-in-docker.rst

@@ -14,7 +14,6 @@ On Windows, this command will sometimes cause errors. Windows users should try u
 
     docker run -p 8089:8089 --mount type=bind,source=$pwd,target=/mnt/locust locustio/locust -f /mnt/locust/locustfile.py
 
-
 Docker Compose
 ==============
 
@@ -27,7 +26,6 @@ The above compose configuration could be used to start a master node and 4 worke
 
     docker-compose up --scale worker=4
 
-
 Use docker image as a base image
 ================================
 
@@ -37,7 +35,6 @@ official Locust docker image as a base image::
     FROM locustio/locust
     RUN pip3 install some-python-package
 
-
 Running a distributed load test on Kubernetes
 ==============================================
 

{locust-2.23.2.dev26 → locust-2.23.2.dev39}/examples/use_as_lib.py

@@ -36,8 +36,8 @@ gevent.spawn(stats_history, env.runner)
 # start the test
 runner.start(1, spawn_rate=10)
 
-# in 60 seconds stop the runner
-gevent.spawn_later(60, lambda: runner.quit())
+# in 30 seconds stop the runner
+gevent.spawn_later(30, runner.quit)
 
 # wait for the greenlets
 runner.greenlet.join()

{locust-2.23.2.dev26 → locust-2.23.2.dev39}/locust/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.23.2.dev26'
-__version_tuple__ = version_tuple = (2, 23, 2, 'dev26')
+__version__ = version = '2.23.2.dev39'
+__version_tuple__ = version_tuple = (2, 23, 2, 'dev39')

{locust-2.23.2.dev26 → locust-2.23.2.dev39}/locust/argument_parser.py

@@ -12,10 +12,16 @@ import socket
 import sys
 import tempfile
 import textwrap
+from collections import OrderedDict
 from typing import Any, NamedTuple
 from urllib.parse import urlparse
 from uuid import uuid4
 
+if sys.version_info >= (3, 11):
+    import tomllib
+else:
+    import tomli as tomllib
+
 import configargparse
 import gevent
 import requests
@@ -23,7 +29,7 @@ import requests
 version = locust.__version__
 
 
-DEFAULT_CONFIG_FILES = ["~/.locust.conf", "locust.conf"]
+DEFAULT_CONFIG_FILES = ("~/.locust.conf", "locust.conf", "pyproject.toml")
 
 
 class LocustArgumentParser(configargparse.ArgumentParser):
@@ -63,6 +69,31 @@ class LocustArgumentParser(configargparse.ArgumentParser):
         }
 
 
+class LocustTomlConfigParser(configargparse.TomlConfigParser):
+    def parse(self, stream):
+        try:
+            config = tomllib.loads(stream.read())
+        except Exception as e:
+            raise configargparse.ConfigFileParserException(f"Couldn't parse TOML file: {e}")
+
+        # convert to dict and filter based on section names
+        result = 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 None:
+                        pass
+                    else:
+                        result[key] = str(value)
+                break
+
+        return result
+
+
 def _is_package(path):
     """
     Is the given path a Python package?
@@ -186,6 +217,12 @@ def download_locustfile_from_url(url: str) -> str:
 def get_empty_argument_parser(add_help=True, default_config_files=DEFAULT_CONFIG_FILES) -> LocustArgumentParser:
     parser = LocustArgumentParser(
         default_config_files=default_config_files,
+        config_file_parser_class=configargparse.CompositeConfigParser(
+            [
+                LocustTomlConfigParser(["tool.locust"]),
+                configargparse.DefaultConfigFileParser,
+            ]
+        ),
         add_env_var_help=False,
         add_config_file_help=False,
         add_help=add_help,

{locust-2.23.2.dev26 → locust-2.23.2.dev39}/locust/test/test_parser.py

@@ -38,17 +38,50 @@ class TestParser(unittest.TestCase):
         opts = self.parser.parse_args(args)
         self.assertEqual(opts.skip_log_setup, True)
 
-    def test_parameter_parsing(self):
-        with NamedTemporaryFile(mode="w") as file:
-            os.environ["LOCUST_LOCUSTFILE"] = "locustfile_from_env"
-            file.write("host host_from_config\nweb-host webhost_from_config")
+    def test_parse_options_from_conf_file(self):
+        with NamedTemporaryFile(mode="w", suffix=".conf") as file:
+            config_data = """\
+            locustfile = ./test_locustfile.py
+            web-host = 127.0.0.1
+            web-port = 45787
+            headless
+            tags = [Critical, Normal]
+            """
+
+            file.write(config_data)
             file.flush()
             parser = get_parser(default_config_files=[file.name])
-            options = parser.parse_args(["-H", "host_from_args"])
-            del os.environ["LOCUST_LOCUSTFILE"]
-        self.assertEqual(options.web_host, "webhost_from_config")
-        self.assertEqual(options.locustfile, "locustfile_from_env")
-        self.assertEqual(options.host, "host_from_args")  # overridden
+            options = parser.parse_args(["-H", "https://example.com"])
+
+        self.assertEqual("./test_locustfile.py", options.locustfile)
+        self.assertEqual("127.0.0.1", options.web_host)
+        self.assertEqual(45787, options.web_port)
+        self.assertTrue(options.headless)
+        self.assertEqual(["Critical", "Normal"], options.tags)
+        self.assertEqual("https://example.com", options.host)
+
+    def test_parse_options_from_toml_file(self):
+        with NamedTemporaryFile(mode="w", suffix=".toml") as file:
+            config_data = """\
+            [tool.locust]
+            locustfile = "./test_locustfile.py"
+            web-host = "127.0.0.1"
+            web-port = 45787
+            headless = true
+            tags = ["Critical", "Normal"]
+            """
+
+            file.write(config_data)
+            file.flush()
+            parser = get_parser(default_config_files=[file.name])
+            options = parser.parse_args(["-H", "https://example.com"])
+
+        self.assertEqual("./test_locustfile.py", options.locustfile)
+        self.assertEqual("127.0.0.1", options.web_host)
+        self.assertEqual(45787, options.web_port)
+        self.assertTrue(options.headless)
+        self.assertEqual(["Critical", "Normal"], options.tags)
+        self.assertEqual("https://example.com", options.host)
 
 
 class TestArgumentParser(LocustTestCase):

{locust-2.23.2.dev26 → locust-2.23.2.dev39}/locust/webui/auth.html

@@ -2,7 +2,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <link rel="icon" href="/assets/favicon.ico" />
+    <link rel="icon" href="./assets/favicon.ico" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta name="theme-color" content="#000000" />
 

{locust-2.23.2.dev26 → locust-2.23.2.dev39}/locust/webui/dev.html

@@ -3,7 +3,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <link rel="icon" href="/assets/favicon.ico" />
+    <link rel="icon" href="./assets/favicon.ico" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta name="theme-color" content="#000000" />