ongoing

Author: sanderegg

tests/performance/common/base_user.py

@@ -1,11 +1,20 @@
+import json
 import logging
+from typing import Any
 
-from locust import FastHttpUser
+import locust_plugins
+from locust import FastHttpUser, events
+from locust.env import Environment
 
 from .auth_settings import DeploymentAuth, OsparcAuth
 
 _logger = logging.getLogger(__name__)
 
+# NOTE: 'import locust_plugins' is necessary to use --check-fail-ratio
+# this assert is added to avoid that pycln pre-commit hook does not
+# remove the import (the tool assumes the import is not necessary)
+assert locust_plugins  # nosec
+
 
 class OsparcUserBase(FastHttpUser):
     """
@@ -49,6 +58,23 @@ def authenticated_patch(self, url, **kwargs):
         return self.client.patch(url, **kwargs)
 
 
+@events.init_command_line_parser.add_listener
+def _(parser) -> None:
+    parser.add_argument(
+        "--requires-login",
+        action="store_true",
+        default=False,
+        help="Indicates if the user requires login before accessing the endpoint",
+    )
+
+
+@events.init.add_listener
+def _(environment: Environment, **_kwargs: Any) -> None:
+    # Only log the parsed options, as the full environment is not JSON serializable
+    options_dict: dict[str, Any] = vars(environment.parsed_options)
+    _logger.debug("Testing environment options: %s", json.dumps(options_dict, indent=2))
+
+
 class OsparcWebUserBase(OsparcUserBase):
     """
     Base class for web users in Locust that provides common functionality.
@@ -85,10 +111,6 @@ def on_stop(self) -> None:
 
     def _login(self) -> None:
         # Implement login logic here
-        logging.info(
-            "Logging in user with email: %s",
-            self.osparc_auth.OSPARC_USER_NAME,
-        )
         response = self.authenticated_post(
             "/v0/auth/login",
             json={
@@ -97,11 +119,13 @@ def _login(self) -> None:
             },
         )
         response.raise_for_status()
-        logging.info("Logged in user with email: %s", self.osparc_auth.OSPARC_USER_NAME)
+        logging.debug(
+            "Logged in user with email: %s", self.osparc_auth.OSPARC_USER_NAME
+        )
 
     def _logout(self) -> None:
         # Implement logout logic here
         self.authenticated_post("/v0/auth/logout")
-        logging.info(
+        logging.debug(
             "Logged out user with email: %s", self.osparc_auth.OSPARC_USER_NAME
         )

tests/performance/locustfiles/deployment_max_rps_single_endpoint.py

@@ -8,41 +8,21 @@
 # If no endpoint is specified, the root endpoint ("/") will be used by default.
 #
 
-import logging
 
-import locust_plugins
 from common.base_user import OsparcWebUserBase
 from locust import events, task
-
-_logger = logging.getLogger(__name__)
-
-# NOTE: 'import locust_plugins' is necessary to use --check-fail-ratio
-# this assert is added to avoid that pycln pre-commit hook does not
-# remove the import (the tool assumes the import is not necessary)
-assert locust_plugins  # nosec
+from locust.argument_parser import LocustArgumentParser
 
 
 # Register the custom argument with Locust's parser
 @events.init_command_line_parser.add_listener
-def _(parser) -> None:
+def _(parser: LocustArgumentParser) -> None:
     parser.add_argument(
         "--endpoint",
         type=str,
         default="/",
         help="The endpoint to test (e.g., /v0/health)",
     )
-    parser.add_argument(
-        "--requires-login",
-        action="store_true",
-        default=False,
-        help="Indicates if the user requires login before accessing the endpoint",
-    )
-
-
-@events.init.add_listener
-def _(environment, **_kwargs) -> None:
-    _logger.info("Testing endpoint: %s", environment.parsed_options.endpoint)
-    _logger.info("Requires login: %s", environment.parsed_options.requires_login)
 
 
 class WebApiUser(OsparcWebUserBase):

tests/performance/locustfiles/webserver_services.py

@@ -6,24 +6,13 @@
 import urllib
 import urllib.parse
 
-import faker
 import locust
 from common.base_user import OsparcWebUserBase
-from dotenv import load_dotenv
 
 _logger = logging.getLogger(__name__)
 
-fake = faker.Faker()
-
-load_dotenv()  # take environment variables from .env
-
 
 class WebApiUser(OsparcWebUserBase):
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.email = fake.email()
-        self.password = "testtesttest"  # noqa: S105
-
     @locust.task
     def list_latest_services(self):
         base_url = "/v0/catalog/services/-/latest"