locust-plugins 4.3.3__tar.gz → 4.4.0__tar.gz

{locust-plugins-4.3.3/locust_plugins.egg-info → locust-plugins-4.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: locust-plugins
-Version: 4.3.3
+Version: 4.4.0
 Summary: Useful plugins/extensions for Locust
 Home-page: https://github.com/SvenskaSpel/locust-plugins
 Author: Lars Holmberg

{locust-plugins-4.3.3 → locust-plugins-4.4.0}/examples/distributor_ex.py

@@ -2,7 +2,6 @@
 # that it is entirely possible to have multiple distributors at the same time
 
 from typing import Dict, List
-from locust_plugins.mongoreader import MongoLRUReader
 from locust_plugins.csvreader import CSVDictReader, CSVReader
 from locust_plugins.distributor import Distributor
 from locust import HttpUser, task, run_single_user, events
@@ -13,18 +12,15 @@ distributors = {}
 
 @events.init.add_listener
 def on_locust_init(environment, **_kwargs):
-    ssn_reader = None
-    product_reader = None
+    ssn_iterator = None
+    product_iterator = None
     if not isinstance(environment.runner, WorkerRunner):
-        product_reader = CSVReader("products.csv")
-        csv = True
-        if csv:
-            ssn_reader = CSVDictReader("ssn.tsv", delimiter="\t")
-        else:
-            ssn_reader = MongoLRUReader({"foo": "bar"}, "last_login")
-        product_reader = CSVReader("products.csv")
-    distributors["customers"] = Distributor(environment, ssn_reader, "customers")
-    distributors["products"] = Distributor(environment, product_reader, "products")
+        product_iterator = CSVReader("products.csv")
+        ssn_iterator = CSVDictReader("ssn.tsv", delimiter="\t")
+        # other readers work equally well
+        # ssn_reader = MongoLRUReader({"foo": "bar"}, "last_login")
+    distributors["products"] = Distributor(environment, product_iterator, "products")
+    distributors["customers"] = Distributor(environment, ssn_iterator, "customers")
 
 
 class MyUser(HttpUser):
@@ -32,9 +28,9 @@ class MyUser(HttpUser):
 
     @task
     def my_task(self) -> None:
-        customer: Dict = next(distributors["customers"])
         product: List[str] = next(distributors["products"])
-        self.client.get(f"/?customer={customer['ssn']}&product={product[0]}")
+        customer: Dict = next(distributors["customers"])
+        self.client.get(f"/?product={product[0]}&customer={customer['ssn']}")
 
 
 if __name__ == "__main__":

locust-plugins-4.4.0/examples/mqtt_custom_client_ex.py

@@ -0,0 +1,33 @@
+import time
+import typing
+
+from locust import task, TaskSet
+from locust_plugins.users.mqtt import MqttUser
+from locust_plugins.users.mqtt import MqttClient
+
+
+# extend the MqttClient class with your own custom implementation
+class MyMqttClient(MqttClient):
+
+    # you can override the event name with your custom implementation
+    def _generate_event_name(self, event_type: str, qos: int, topic: str):
+        return f"mqtt:{event_type}:{qos}"
+
+
+class MyUser(MqttUser):
+    # override the client_cls with your custom MqttClient implementation
+    client_cls: typing.Type[MyMqttClient] = MyMqttClient
+
+    @task
+    class MyTasks(TaskSet):
+        # Sleep for a while to allow the client time to connect.
+        # This is probably not the most "correct" way to do this: a better method
+        # might be to add a gevent.event.Event to the MqttClient's on_connect
+        # callback and wait for that (with a timeout) here.
+        # However, this works well enough for the sake of an example.
+        def on_start(self):
+            time.sleep(5)
+
+        @task
+        def say_hello(self):
+            self.client.publish("hello/locust", b"hello world")

{locust-plugins-4.3.3 → locust-plugins-4.4.0}/examples/playwright_ex.py

@@ -3,7 +3,7 @@
 # Notes:
 # Dont forget to first install the browsers by running: playwright install
 # Browsers are heavy. Dont expect to be able to do as much load as usual with Locust. Optimize your tests by blocking requests for unnecessary resources.
-# Dont run too many users per worker instance (or you'll get the dreaded "CPU usage over 90%" warning). Instead, scale using more Locust workers. 4-5 users/browsers per workers seems ok. If you are using locust-swarm, increase the --processes-per-loadgen parameter.
+# Dont run too many users per worker instance (or you'll get the dreaded "CPU usage over 90%" warning). Instead, scale using more Locust workers. 4-5 users/browsers per workers seems ok.
 # Some things, such as adding request callbacks (Page.route()), will cause intense communication with the browser will overload Python/Playwright so be careful.
 # It is easy to accidentally make Playwright tests stall for a long time, for example if your page does finish loading completely (triggering the "load" event). Experiment with alternative wait strategies (e.g. wait_until="domcontentloaded" or self.page.wait_for_selector(...))
 

{locust-plugins-4.3.3 → locust-plugins-4.4.0}/locust_plugins/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '4.3.3'
-__version_tuple__ = version_tuple = (4, 3, 3)
+__version__ = version = '4.4.0'
+__version_tuple__ = version_tuple = (4, 4, 0)

{locust-plugins-4.3.3 → locust-plugins-4.4.0}/locust_plugins/mongoreader.py

@@ -34,7 +34,7 @@ class MongoLRUReader(Iterator[Dict]):
 
         """
         self.timestamp_field = timestamp_field
-        if not coll:
+        if coll is None:
             self.coll: Collection = MongoClient(env["LOCUST_MONGO"])[env["LOCUST_MONGO_DATABASE"]][
                 env["LOCUST_MONGO_COLLECTION"]
             ]

{locust-plugins-4.3.3 → locust-plugins-4.4.0}/locust_plugins/users/mqtt.py

@@ -117,6 +117,9 @@ class MqttClient(mqtt.Client):
         self._publish_requests: dict[int, PublishedMessageContext] = {}
         self._subscribe_requests: dict[int, SubscribeContext] = {}
 
+    def _generate_event_name(self, event_type: str, qos: int, topic: str):
+        return _generate_mqtt_event_name(event_type, qos, topic)
+
     def _on_publish_cb(
         self,
         client: mqtt.Client,
@@ -143,7 +146,7 @@ class MqttClient(mqtt.Client):
             # fire successful publish event
             self.environment.events.request.fire(
                 request_type=REQUEST_TYPE,
-                name=_generate_mqtt_event_name("publish", request_context.qos, request_context.topic),
+                name=self._generate_event_name("publish", request_context.qos, request_context.topic),
                 response_time=(cb_time - request_context.start_time) * 1000,
                 response_length=request_context.payload_size,
                 exception=None,
@@ -180,7 +183,7 @@ class MqttClient(mqtt.Client):
             if SUBACK_FAILURE in granted_qos:
                 self.environment.events.request.fire(
                     request_type=REQUEST_TYPE,
-                    name=_generate_mqtt_event_name("subscribe", request_context.qos, request_context.topic),
+                    name=self._generate_event_name("subscribe", request_context.qos, request_context.topic),
                     response_time=(cb_time - request_context.start_time) * 1000,
                     response_length=0,
                     exception=AssertionError(f"Broker returned an error response during subscription: {granted_qos}"),
@@ -193,7 +196,7 @@ class MqttClient(mqtt.Client):
                 # fire successful subscribe event
                 self.environment.events.request.fire(
                     request_type=REQUEST_TYPE,
-                    name=_generate_mqtt_event_name("subscribe", request_context.qos, request_context.topic),
+                    name=self._generate_event_name("subscribe", request_context.qos, request_context.topic),
                     response_time=(cb_time - request_context.start_time) * 1000,
                     response_length=0,
                     exception=None,
@@ -287,7 +290,7 @@ class MqttClient(mqtt.Client):
         if publish_info.rc != mqtt.MQTT_ERR_SUCCESS:
             self.environment.events.request.fire(
                 request_type=REQUEST_TYPE,
-                name=_generate_mqtt_event_name("publish", request_context.qos, request_context.topic),
+                name=self._generate_event_name("publish", request_context.qos, request_context.topic),
                 response_time=0,
                 response_length=0,
                 exception=publish_info.rc,
@@ -325,7 +328,7 @@ class MqttClient(mqtt.Client):
         if result != mqtt.MQTT_ERR_SUCCESS:
             self.environment.events.request.fire(
                 request_type=REQUEST_TYPE,
-                name=_generate_mqtt_event_name("subscribe", request_context.qos, request_context.topic),
+                name=self._generate_event_name("subscribe", request_context.qos, request_context.topic),
                 response_time=0,
                 response_length=0,
                 exception=result,

{locust-plugins-4.3.3 → locust-plugins-4.4.0}/locust_plugins/users/socketio.py

@@ -9,7 +9,7 @@ from locust_plugins import missing_extra
 try:
     import websocket
 except ModuleNotFoundError:
-    missing_extra("paho", "mqtt")
+    missing_extra("websocket", "websocket")
 
 
 class SocketIOUser(User):

{locust-plugins-4.3.3 → locust-plugins-4.4.0/locust_plugins.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: locust-plugins
-Version: 4.3.3
+Version: 4.4.0
 Summary: Useful plugins/extensions for Locust
 Home-page: https://github.com/SvenskaSpel/locust-plugins
 Author: Lars Holmberg

{locust-plugins-4.3.3 → locust-plugins-4.4.0}/locust_plugins.egg-info/SOURCES.txt

@@ -26,6 +26,7 @@ examples/embedded_resource_manager_ex.py
 examples/jmeter_listener_example.py
 examples/kafka_ex.py
 examples/mongoreader_ex.py
+examples/mqtt_custom_client_ex.py
 examples/mqtt_ex.py
 examples/playwright-recording.py
 examples/playwright_ex.py