refactor: remove stop-timeout from Locust config and improve logging in webserver services

Author: sanderegg

tests/performance/Makefile

@@ -61,7 +61,6 @@ define create_locust_config
 		echo "spawn-rate = $$spawn_rate" >> $(LOCUST_CONFIG_FILE); \
 		echo "run-time = $$run_time" >> $(LOCUST_CONFIG_FILE); \
 		echo "processes = $$processes" >> $(LOCUST_CONFIG_FILE); \
-		echo "stop-timeout = 10s" >> $(LOCUST_CONFIG_FILE); \
 		echo "loglevel = INFO" >> $(LOCUST_CONFIG_FILE); \
 		echo "" >> $(LOCUST_CONFIG_FILE); \
 		printf "$(GREEN)Locust configuration file created. It won't be asked again.$(NC)\n"; \

tests/performance/README.md

@@ -77,7 +77,6 @@ users = 10
 spawn-rate = 1
 run-time = 5m
 processes = 4
-stop-timeout = 10s
 loglevel = INFO
 EOF
 

tests/performance/common/base_user.py

@@ -4,6 +4,7 @@
 
 import locust_plugins
 from locust import FastHttpUser, events
+from locust.argument_parser import LocustArgumentParser
 from locust.env import Environment
 
 from .auth_settings import DeploymentAuth, OsparcAuth
@@ -59,7 +60,7 @@ def authenticated_patch(self, url, **kwargs):
 
 
 @events.init_command_line_parser.add_listener
-def _(parser) -> None:
+def _(parser: LocustArgumentParser) -> None:
     parser.add_argument(
         "--requires-login",
         action="store_true",
@@ -83,12 +84,20 @@ class OsparcWebUserBase(OsparcUserBase):
     """
 
     abstract = True  # This class is abstract and won't be instantiated by Locust
+    requires_login = False  # Default value, can be overridden by subclasses
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        if self.environment.parsed_options.requires_login:
+        # Determine if login is required once during initialization
+        self._login_required = (
+            getattr(self.__class__, "requires_login", False)
+            or self.environment.parsed_options.requires_login
+        )
+
+        # Initialize auth if login is required
+        if self._login_required:
             self.osparc_auth = OsparcAuth()
-            _logger.debug(
+            _logger.info(
                 "Using OsparcAuth for login with username: %s",
                 self.osparc_auth.OSPARC_USER_NAME,
             )
@@ -98,15 +107,15 @@ def on_start(self) -> None:
         Called when a web user starts. Can be overridden by subclasses
         to implement custom startup behavior, such as logging in.
         """
-        if self.environment.parsed_options.requires_login:
+        if self._login_required:
             self._login()
 
     def on_stop(self) -> None:
         """
         Called when a web user stops. Can be overridden by subclasses
         to implement custom shutdown behavior, such as logging out.
         """
-        if self.environment.parsed_options.requires_login:
+        if self._login_required:
             self._logout()
 
     def _login(self) -> None:
@@ -119,13 +128,13 @@ def _login(self) -> None:
             },
         )
         response.raise_for_status()
-        logging.debug(
+        _logger.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.debug(
+        _logger.debug(
             "Logged out user with email: %s", self.osparc_auth.OSPARC_USER_NAME
         )

tests/performance/locustfiles/webserver_services.py

@@ -2,34 +2,70 @@
 # SEE https://docs.locust.io/en/stable/quickstart.html
 #
 
+import json
 import logging
 import urllib
 import urllib.parse
+from typing import Any
 
 import locust
 from common.base_user import OsparcWebUserBase
+from locust import events
+from locust.env import Environment
 
 _logger = logging.getLogger(__name__)
 
 
+@events.init.add_listener
+def _(environment: Environment, **_kwargs: Any) -> None:
+    """
+    Log the testing environment options when Locust initializes.
+
+    Args:
+        environment: The Locust environment
+        _kwargs: Additional keyword arguments
+    """
+    # Log that this test requires login
+    _logger.info(
+        "This test requires login (requires_login=True class attribute is set)."
+    )
+
+    # Only log the parsed options, as the full environment is not JSON serializable
+    assert (
+        environment.parsed_options is not None
+    ), "Environment parsed options must not be None"
+    options_dict: dict[str, Any] = vars(environment.parsed_options)
+    _logger.info("Testing environment options: %s", json.dumps(options_dict, indent=2))
+
+
 class WebApiUser(OsparcWebUserBase):
+    """Web API user that always requires login regardless of command line flags."""
+
+    # This overrides the class attribute in OsparcWebUserBase
+    requires_login = True
+
     @locust.task
     def list_latest_services(self):
         base_url = "/v0/catalog/services/-/latest"
-        params = {"offset": 20, "limit": 20}
-
+        params = {"offset": 0, "limit": 20}
+        page_num = 0
         while True:
-            response = self.authenticated_get(base_url, params=params)
+            response = self.authenticated_get(
+                base_url, params=params, name=f"{base_url}/{page_num}"
+            )
             response.raise_for_status()
 
             page = response.json()
 
             # Process the current page data here
-            next_link = page["_links"].get("next")
+            next_link = page["data"]["_links"].get("next")
             if not next_link:
                 break
 
             # Update base_url and params for the next request
+            page_num += 1
             parsed_next = urllib.parse.urlparse(next_link)
             base_url = parsed_next.path
             params = dict(urllib.parse.parse_qsl(parsed_next.query))
+
+            _logger.info(params)