locust 2.39.2.dev7__py3-none-any.whl → 2.39.2.dev11__py3-none-any.whl

locust/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '2.39.2.dev7'
-__version_tuple__ = version_tuple = (2, 39, 2, 'dev7')
+__version__ = version = '2.39.2.dev11'
+__version_tuple__ = version_tuple = (2, 39, 2, 'dev11')
 
 __commit_id__ = commit_id = None

locust/main.py

@@ -30,7 +30,7 @@ from .html import get_html_report, process_html_filename
 from .input_events import input_listener
 from .log import greenlet_exception_logger, setup_logging
 from .user.inspectuser import print_task_ratio, print_task_ratio_json
-from .util.load_locustfile import load_locustfile
+from .util.load_locustfile import load_locustfile, load_locustfile_pytest
 
 # import external plugins if  installed to allow for registering custom arguments etc
 try:
@@ -123,9 +123,7 @@ def merge_locustfiles_content(
     #  Check docs for real supported task attribute signature for User\TaskSet class.
     available_user_tasks: dict[str, list[locust.TaskSet | Callable]] = {}
 
-    for _locustfile in locustfiles:
-        user_classes, shape_classes = load_locustfile(_locustfile)
-
+    def set_available_things(user_classes, shape_classes):
         # Setting Available Shape Classes
         for _shape_class in shape_classes:
             shape_class_name = type(_shape_class).__name__
@@ -152,6 +150,15 @@ def merge_locustfiles_content(
             available_user_classes[class_name] = class_definition
             available_user_tasks[class_name] = class_definition.tasks
 
+    for _locustfile in locustfiles:
+        user_classes, shape_classes = load_locustfile(_locustfile)
+        set_available_things(user_classes, shape_classes)
+
+    if not available_user_classes:  # only load pytest-based locustfiles if no regular ones were found
+        for _locustfile in locustfiles:
+            user_classes = load_locustfile_pytest(_locustfile)
+            set_available_things(user_classes, [])
+
     shape_class = list(available_shape_classes.values())[0] if available_shape_classes else None
 
     return available_user_classes, available_shape_classes, available_user_tasks, shape_class

locust/pytestplugin.py

@@ -0,0 +1,44 @@
+from locust.clients import HttpSession
+from locust.contrib.fasthttp import FastHttpSession
+from locust.event import EventHook
+from locust.user.users import User
+
+import pytest
+
+
+class NoOpEvent(EventHook):
+    pass
+
+
+_config: pytest.Config
+
+
+# capture Config object instead of having to pass it explicitly to fixtures, which would make them more complex to call from Locust
+def pytest_configure(config):
+    global _config
+    _config = config
+
+
+@pytest.fixture
+def session(user: User | None = None):
+    s = HttpSession(
+        base_url=user.host if user else _config.getoption("--host"),
+        request_event=user.environment.events.request if user else NoOpEvent(),
+        user=user,
+    )
+    yield s
+    s.close()
+
+
+@pytest.fixture
+def fastsession(user: User | None = None):
+    s = FastHttpSession(
+        base_url=user.host if user else _config.getoption("--host"),
+        request_event=user.environment.events.request if user else NoOpEvent(),
+        user=user,
+    )
+    yield s
+
+
+def pytest_addoption(parser: pytest.Parser) -> None:
+    parser.addoption("--host", "-H", action="store", default=None)

locust/user/task.py

@@ -211,7 +211,11 @@ def filter_tasks_by_tags(
         checked[task] = passing
 
     task_holder.tasks = new_tasks
-    if not new_tasks and not is_markov_taskset(task_holder):
+    if (
+        not new_tasks
+        and not is_markov_taskset(task_holder)
+        and not getattr(task_holder, "functions", False)  # PytestUser
+    ):
         logging.warning(f"{task_holder.__name__} had no tasks left after filtering, instantiating it will fail!")
 
 

locust/user/users.py

@@ -14,15 +14,24 @@ from locust.user.wait_time import constant
 from locust.util import deprecation
 
 import logging
+import sys
 import time
 import traceback
 from collections.abc import Callable
 from typing import final
 
+import pytest
 from gevent import GreenletExit, greenlet
 from gevent.pool import Group
+from geventhttpclient.useragent import ConnectionError
+from requests.exceptions import RequestException
 from urllib3 import PoolManager
 
+if sys.version_info >= (3, 12):
+    from typing import override
+else:
+    from typing_extensions import override
+
 logger = logging.getLogger(__name__)
 
 
@@ -144,7 +153,7 @@ class User(metaclass=UserMeta):
         self._state = LOCUST_STATE_RUNNING
         self._taskset_instance = DefaultTaskSet(self)
         try:
-            # run the TaskSet on_start method, if it has one
+            # run the User on_start method, if it has one
             try:
                 self.on_start()
             except Exception as e:
@@ -274,3 +283,24 @@ class HttpUser(User):
         The client supports cookies, and therefore keeps the session between HTTP requests.
         """
         self.client.trust_env = False
+
+
+class PytestUser(User):
+    abstract = True
+    functions: list[pytest.Function]
+    fixtures: list
+
+    @override
+    def run(self):  # type: ignore[override] # We actually DO want to change the default User behavior
+        self._state = LOCUST_STATE_RUNNING
+        self.fixtures = [next(f.fixturedef.func(self)) for f in self.functions]  # type: ignore[attr-defined]
+        while True:
+            for i in range(len(self.fixtures)):
+                try:  # try-except is for supporting .raise_for_status() in tests
+                    self.functions[i].obj(self.fixtures[i])
+                except RequestException as e:
+                    if isinstance(e, ValueError):  # things like MissingSchema etc, lets not catch that
+                        raise
+                    logger.debug("%s\n%s", e, traceback.format_exc())
+                except ConnectionError as e:
+                    logger.debug("%s\n%s", e, traceback.format_exc())

locust/util/load_locustfile.py

@@ -6,8 +6,12 @@ import inspect
 import os
 import sys
 
+import pytest
+from _pytest.config import Config
+
 from ..shape import LoadTestShape
 from ..user import User
+from ..user.users import PytestUser
 
 
 def is_user_class(item) -> bool:
@@ -81,5 +85,45 @@ def load_locustfile(path) -> tuple[dict[str, type[User]], list[LoadTestShape]]:
 
     # Find shape class, if any, return it
     shape_classes = [value() for value in vars(imported).values() if is_shape_class(value)]
-
     return user_classes, shape_classes
+
+
+def load_locustfile_pytest(path) -> dict[str, type[User]]:
+    """
+    Create User classes from pytest test functions.
+
+    It relies on some pytest internals to collect test functions and their fixtures,
+    but it should be reasonably stable for simple use cases.
+
+    Fixtures (like `session` and `fastsession`) are defined in `pytestplugin.py`
+
+    See `examples/test_pytest.py` and `locust/test/test_pytest_locustfile.py`
+    """
+    user_classes: dict[str, type[PytestUser]] = {}
+    # collect tests and set up fixture manager
+    config = Config.fromdictargs({}, [path])
+    config._do_configure()
+    session = pytest.Session.from_config(config)
+    config.hook.pytest_sessionstart(session=session)
+    session.perform_collect()
+    config.hook.pytest_collection_modifyitems(session=session, config=config, items=session.items)
+    fm = session._fixturemanager
+
+    for function in session.items:
+        if isinstance(function, pytest.Function):
+            sig = inspect.signature(function.obj)
+            function.kwargs = {}  # type: ignore[attr-defined]
+            for name in sig.parameters:
+                defs = fm.getfixturedefs(name, function)
+                if not defs:
+                    raise ValueError(f"Could not find fixture for parameter {name!r} in {function.name}")
+                if len(defs) > 1:
+                    raise ValueError(f"Multiple fixtures found for parameter {name!r} in {function.name}: {defs}")
+                function.fixturedef = defs[0]  # type: ignore[attr-defined]
+            if not function.name in user_classes:
+                user_classes[function.name] = type(function.name, (PytestUser,), {})
+                user_classes[function.name].functions = []
+            user_classes[function.name].functions.append(function)
+        else:
+            pass  # Skipping non-function item
+    return user_classes  # type: ignore

locust/web.py

@@ -320,7 +320,7 @@ class WebUI:
                     return jsonify({"success": False, "message": err_msg, "host": environment.host})
                 self._swarm_greenlet = gevent.spawn(environment.runner.start, user_count, spawn_rate)
                 self._swarm_greenlet.link_exception(greenlet_exception_handler)
-                response_data = {
+                response_data: dict[str, Any] = {
                     "success": True,
                     "message": "Swarming started",
                     "host": environment.host,

{locust-2.39.2.dev7.dist-info → locust-2.39.2.dev11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: locust
-Version: 2.39.2.dev7
+Version: 2.39.2.dev11
 Summary: Developer-friendly load testing framework
 Project-URL: homepage, https://locust.io/
 Project-URL: repository, https://github.com/locustio/locust
@@ -33,6 +33,7 @@ Requires-Dist: geventhttpclient>=2.3.1
 Requires-Dist: locust-cloud>=1.26.3
 Requires-Dist: msgpack>=1.0.0
 Requires-Dist: psutil>=5.9.1
+Requires-Dist: pytest<9.0.0,>=8.3.3
 Requires-Dist: python-engineio>=4.12.2
 Requires-Dist: python-socketio[client]>=5.13.0
 Requires-Dist: pywin32; sys_platform == 'win32'
@@ -41,7 +42,7 @@ Requires-Dist: requests>=2.26.0; python_version <= '3.11'
 Requires-Dist: requests>=2.32.2; python_version > '3.11'
 Requires-Dist: setuptools>=70.0.0
 Requires-Dist: tomli>=1.1.0; python_version < '3.11'
-Requires-Dist: typing-extensions>=4.6.0; python_version < '3.11'
+Requires-Dist: typing-extensions>=4.6.0; python_version < '3.12'
 Requires-Dist: werkzeug>=2.0.0
 Provides-Extra: milvus
 Requires-Dist: pymilvus>=2.5.0; extra == 'milvus'

{locust-2.39.2.dev7.dist-info → locust-2.39.2.dev11.dist-info}/RECORD

@@ -1,6 +1,6 @@
 locust/__init__.py,sha256=HadpgGidiyCDPSKwkxrk1Qw6eB7dTmftNJVftuJzAiw,1876
 locust/__main__.py,sha256=vBQ82334kX06ImDbFlPFgiBRiLIinwNk3z8Khs6hd74,31
-locust/_version.py,sha256=xCnc6JIZRn3Y_NM7U752CyBH_qVdcn8tDuGucE4g7Us,719
+locust/_version.py,sha256=Sw5XUxorTCx-oNt66pYOhN0i25NizH_aGicKPj8S2P8,721
 locust/argument_parser.py,sha256=t6mAoK9u13DxC9UH-alVqS6fFABFTyNWSJG89yQ4QQQ,33056
 locust/clients.py,sha256=CeyTYgKuASZS6QKc71T4V3bqYPGlJr3Ef_i6qP07gTQ,19498
 locust/debug.py,sha256=7CCm8bIg44uGH2wqBlo1rXBzV2VzwPicLxLewz8r5CQ,5099
@@ -11,12 +11,13 @@ locust/exception.py,sha256=jGgJ32ubuf4pWdlaVOkbh2Y0LlG0_DHi-lv3ib8ppOE,1791
 locust/html.py,sha256=18LlaL-NEQdthXVdS16gRAd4SOpW_bowOJKyuLvWrCY,4043
 locust/input_events.py,sha256=lqLDB2Ax-OQ7-vtYNkGjySjfaWVobBzqf0GxRwjcLcQ,3323
 locust/log.py,sha256=5E2ZUOa3V4sfCqa-470Gle1Ik9L5nxYitsjEB9tRwE0,3455
-locust/main.py,sha256=P9r-CxA3Hr1U3JKU9WsMkc-Mf5PTeW7JfclezXP3nqY,28497
+locust/main.py,sha256=rcUD3MnBnFqeXC41fjGkh4p9POLGWglgPvRAfHKtEnc,28896
 locust/py.typed,sha256=gkWLl8yD4mIZnNYYAIRM8g9VarLvWmTAFeUfEbxJLBw,65
+locust/pytestplugin.py,sha256=fc616tXWQ0FvZ6aa_sBzvaCwjqsBo-tg8uP3-0jxcdU,1116
 locust/runners.py,sha256=niYmGsfOpxMfVmTXGod4MYTefpaZ2wirFlhqxRw5mq4,70617
 locust/shape.py,sha256=t-lwBS8LOjWcKXNL7j2U3zroIXJ1b0fazUwpRYQOKXw,1973
 locust/stats.py,sha256=qyoSKT0i7RunLDj5pMGqizK1Sp8bcqUsXwh2m4_DpR8,47203
-locust/web.py,sha256=HLFN9jUtKG3sMIKu_Xw9wtvTAFxXvzDHdtLtfb_JxUQ,31849
+locust/web.py,sha256=pLYuocmx9gifJ4vsVDgGDYIPkQhQxI7kKjxoXcUajqM,31865
 locust/contrib/__init__.py,sha256=LtZN7MczpIAbZkN7PT2h8W2wgb9nBl6cDXbFCVsV4fo,290
 locust/contrib/fasthttp.py,sha256=c8MznjqbtYTKZPc20OC4GCiaENDCJmmNSNuHqtMhh2Q,29883
 locust/contrib/milvus.py,sha256=YabgLd0lImzWupJFCm0OZAW-Nxeibwn91ldWpZ2irDo,12811
@@ -31,8 +32,8 @@ locust/user/__init__.py,sha256=RgdRCflP2dIDcvwVMdhPQHAMhWVwQarQ9wWjF9HKk0w,151
 locust/user/inspectuser.py,sha256=KgrWHyE5jhK6or58R7soLRf-_st42AaQrR72qbiXw9E,2641
 locust/user/markov_taskset.py,sha256=eESre6OacbP7nTzZFwxUe7TO4X4l7WqOAEETtDzsIfU,11784
 locust/user/sequential_taskset.py,sha256=SbrrGU9HV2nEWe6zQVtjymn8NgPISP7QSNoVdyoXjYg,2687
-locust/user/task.py,sha256=k7g86WYm1I-tuNm2nVI-3TZegGhmo-pIk7pPFILk3yc,17147
-locust/user/users.py,sha256=c3Dtldg5ypA0rAE4eBn1mCzFtJ-Nq9BPblqM67wEjSY,10016
+locust/user/task.py,sha256=QnNDs8lEZGgMqBe8l_O4FKgn4WUL9r5WTRHWw88nO-w,17242
+locust/user/users.py,sha256=n2IE7MwIKj2JUgYU4_7Vv-cNk-NWDRhj62dQbxrGhIk,11204
 locust/user/wait_time.py,sha256=bGRKMVx4lom75sX3POYJUa1CPeME2bEAXG6CEgxSO5U,2675
 locust/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 locust/util/cache.py,sha256=IxbpGawl0-hoWKvCrtksxjSLf2GbBBTVns06F7mFBkM,1062
@@ -40,7 +41,7 @@ locust/util/date.py,sha256=2uZAY-fkJq7llUcVywTDTbe-_2IYumCv18n3Vrc75gw,833
 locust/util/deprecation.py,sha256=4my4IcFpbM6yEKr569GMUKMsS0ywp0N4JPhhwm3J1-w,2026
 locust/util/directory.py,sha256=2EeuVIIFEErm0OpNXdsEgQLx49jAXq-PvMj2uY0Mr8o,326
 locust/util/exception_handler.py,sha256=jTMyBq2a0O07fRjmqGkheyaPj58tUgnbbcjoesKGPws,797
-locust/util/load_locustfile.py,sha256=0ncZh2GQvkiItZB0ePy6JQ_2ayZNP9jXOTfUhdvlQB4,2956
+locust/util/load_locustfile.py,sha256=KzrLXeLDhWo7ia9hxACkuES7xykgaBlIt8yJQkHYs8U,4929
 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
@@ -55,8 +56,8 @@ locust/webui/dist/assets/index-BjqxSg7R.js,sha256=3JyrKWfAg8LlTy2bxAJh73c6njNPhN
 locust/webui/dist/assets/terminal.gif,sha256=iw80LO2u0dnf4wpGfFJZauBeKTcSpw9iUfISXT2nEF4,75302
 locust/webui/dist/assets/testruns-dark.png,sha256=G4p2VZSBuuqF4neqUaPSshIp5OKQJ_Bvb69Luj6XuVs,125231
 locust/webui/dist/assets/testruns-light.png,sha256=JinGDiiBPOkhpfF-XCbmQqhRInqItrjrBTLKt5MlqVI,130301
-locust-2.39.2.dev7.dist-info/METADATA,sha256=0k7x7Fy6OQ-4LIBo3ICcygSBTZ6Uv98CdCpSS-BQfPo,9562
-locust-2.39.2.dev7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-locust-2.39.2.dev7.dist-info/entry_points.txt,sha256=RAdt8Ku-56m7bFjmdj-MBhbF6h4NX7tVODR9QNnOg0E,44
-locust-2.39.2.dev7.dist-info/licenses/LICENSE,sha256=5hnz-Vpj0Z3kSCQl0LzV2hT1TLc4LHcbpBp3Cy-EuyM,1110
-locust-2.39.2.dev7.dist-info/RECORD,,
+locust-2.39.2.dev11.dist-info/METADATA,sha256=aHhLh2Z_lKa_A1cQS-Ct36Y4b5MDZ7Dkktf0oeNe_uk,9599
+locust-2.39.2.dev11.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+locust-2.39.2.dev11.dist-info/entry_points.txt,sha256=k0386Xi0vBR3OVIqeGNYz7cz8QUGJ3iLmQ0WQU91ogw,85
+locust-2.39.2.dev11.dist-info/licenses/LICENSE,sha256=5hnz-Vpj0Z3kSCQl0LzV2hT1TLc4LHcbpBp3Cy-EuyM,1110
+locust-2.39.2.dev11.dist-info/RECORD,,

{locust-2.39.2.dev7.dist-info → locust-2.39.2.dev11.dist-info}/entry_points.txt

@@ -1,2 +1,5 @@
 [console_scripts]
 locust = locust.main:main
+
+[pytest11]
+locust = locust.pytestplugin