Work towards 1.0. Refactoring of runners/events/web ui. Getting rid of global state.

locust/clients.py

@@ -46,9 +46,10 @@ class HttpSession(requests.Session):
                            response, even if the response code is ok (2xx). The opposite also works, one can use catch_response to catch a request
                            and then mark it as successful even if the response code was not (i.e 500 or 404).
     """
-    def __init__(self, base_url, *args, **kwargs):
+    def __init__(self, environment, base_url, *args, **kwargs):
         super(HttpSession, self).__init__(*args, **kwargs)
-
+
+        self.locust_environment = environment
         self.base_url = base_url
 
         # Check for basic authentication
@@ -127,7 +128,7 @@ def request(self, method, url, name=None, catch_response=False, **kwargs):
 
         if catch_response:
             response.locust_request_meta = request_meta
-            return ResponseContextManager(response)
+            return ResponseContextManager(response, environment=self.locust_environment)
         else:
             if name:
                 # Since we use the Exception message when grouping failures, in order to not get 
@@ -138,15 +139,15 @@ def request(self, method, url, name=None, catch_response=False, **kwargs):
             try:
                 response.raise_for_status()
             except RequestException as e:
-                events.request_failure.fire(
+                self.locust_environment.events.request_failure.fire(
                     request_type=request_meta["method"], 
                     name=request_meta["name"], 
                     response_time=request_meta["response_time"], 
                     response_length=request_meta["content_size"],
                     exception=e, 
                 )
             else:
-                events.request_success.fire(
+                self.locust_environment.events.request_success.fire(
                     request_type=request_meta["method"],
                     name=request_meta["name"],
                     response_time=request_meta["response_time"],
@@ -186,9 +187,10 @@ class ResponseContextManager(LocustResponse):
 
     _is_reported = False
 
-    def __init__(self, response):
+    def __init__(self, response, environment):
         # copy data from response to this object
         self.__dict__ = response.__dict__
+        self.locust_environment = environment
 
     def __enter__(self):
         return self
@@ -223,7 +225,7 @@ def success(self):
                 if response.status_code == 404:
                     response.success()
         """
-        events.request_success.fire(
+        self.locust_environment.events.request_success.fire(
             request_type=self.locust_request_meta["method"],
             name=self.locust_request_meta["name"],
             response_time=self.locust_request_meta["response_time"],
@@ -247,7 +249,7 @@ def failure(self, exc):
         if isinstance(exc, str):
             exc = CatchResponseError(exc)
 
-        events.request_failure.fire(
+        self.locust_environment.events.request_failure.fire(
             request_type=self.locust_request_meta["method"],
             name=self.locust_request_meta["name"],
             response_time=self.locust_request_meta["response_time"],

locust/contrib/fasthttp.py

@@ -64,20 +64,21 @@ class FastHttpLocust(Locust):
     The client support cookies, and therefore keeps the session between HTTP requests.
     """
 
-    def __init__(self):
-        super(FastHttpLocust, self).__init__()
+    def __init__(self, environment):
+        super().__init__(environment)
         if self.host is None:
             raise LocustError("You must specify the base host. Either in the host attribute in the Locust class, or on the command line using the --host option.")
         if not re.match(r"^https?://[^/]+", self.host, re.I):
             raise LocustError("Invalid host (`%s`), must be a valid base URL. E.g. http://example.com" % self.host)
 
-        self.client = FastHttpSession(base_url=self.host)
+        self.client = FastHttpSession(self.environment, base_url=self.host)
 
 
 class FastHttpSession(object):
     auth_header = None
 
-    def __init__(self, base_url, **kwargs):
+    def __init__(self, environment, base_url, **kwargs):
+        self.environment = environment
         self.base_url = base_url
         self.cookiejar = CookieJar()
         self.client = LocustUserAgent(
@@ -183,20 +184,20 @@ def request(self, method, path, name=None, data=None, catch_response=False, stre
 
         if catch_response:
             response.locust_request_meta = request_meta
-            return ResponseContextManager(response)
+            return ResponseContextManager(response, environment=self.environment)
         else:
             try:
                 response.raise_for_status()
             except FAILURE_EXCEPTIONS as e:
-                events.request_failure.fire(
+                self.environment.events.request_failure.fire(
                     request_type=request_meta["method"], 
                     name=request_meta["name"], 
                     response_time=request_meta["response_time"], 
                     response_length=request_meta["content_size"],
                     exception=e, 
                 )
             else:
-                events.request_success.fire(
+                self.environment.events.request_success.fire(
                     request_type=request_meta["method"],
                     name=request_meta["name"],
                     response_time=request_meta["response_time"],
@@ -318,10 +319,12 @@ class ResponseContextManager(FastResponse):
 
     _is_reported = False
 
-    def __init__(self, response):
+    def __init__(self, response, environment):
         # copy data from response to this object
         self.__dict__ = response.__dict__
         self._cached_content = response.content
+        # store reference to locust Environment
+        self.environment = environment
 
     def __enter__(self):
         return self
@@ -356,7 +359,7 @@ def success(self):
                 if response.status_code == 404:
                     response.success()
         """
-        events.request_success.fire(
+        self.environment.events.request_success.fire(
             request_type=self.locust_request_meta["method"],
             name=self.locust_request_meta["name"],
             response_time=self.locust_request_meta["response_time"],
@@ -380,7 +383,7 @@ def failure(self, exc):
         if isinstance(exc, str):
             exc = CatchResponseError(exc)
 
-        events.request_failure.fire(
+        self.environment.events.request_failure.fire(
             request_type=self.locust_request_meta["method"],
             name=self.locust_request_meta["name"],
             response_time=self.locust_request_meta["response_time"],

locust/core.py

@@ -152,18 +152,20 @@ class User(Locust):
     _lock = gevent.lock.Semaphore()  # Lock to make sure setup is only run once
     _state = False
 
-    def __init__(self):
+    def __init__(self, environment):
         super(Locust, self).__init__()
         # check if deprecated wait API is used
         deprecation.check_for_deprecated_wait_api(self)
 
+        self.environment = environment
+
         with self._lock:
             if hasattr(self, "setup") and self._setup_has_run is False:
                 self._set_setup_flag()
                 try:
                     self.setup()
                 except Exception as e:
-                    events.locust_error.fire(locust_instance=self, exception=e, tb=sys.exc_info()[2])
+                    self.environment.events.locust_error.fire(locust_instance=self, exception=e, tb=sys.exc_info()[2])
                     logger.error("%s\n%s", e, traceback.format_exc())
             if hasattr(self, "teardown") and self._teardown_is_set is False:
                 self._set_teardown_flag()
@@ -218,12 +220,12 @@ class HttpLocust(Locust):
     We don't need this feature most of the time, so disable it by default.
     """
 
-    def __init__(self):
-        super(HttpLocust, self).__init__()
+    def __init__(self, *args, **kwargs):
+        super(HttpLocust, self).__init__(*args, **kwargs)
         if self.host is None:
             raise LocustError("You must specify the base host. Either in the host attribute in the Locust class, or on the command line using the --host option.")
 
-        session = HttpSession(base_url=self.host)
+        session = HttpSession(self.environment, base_url=self.host)
         session.trust_env = self.trust_env
         self.client = session
 
@@ -362,7 +364,7 @@ def __init__(self, parent):
                 try:
                     self.setup()
                 except Exception as e:
-                    events.locust_error.fire(locust_instance=self, exception=e, tb=sys.exc_info()[2])
+                    self.locust.environment.events.locust_error.fire(locust_instance=self, exception=e, tb=sys.exc_info()[2])
                     logger.error("%s\n%s", e, traceback.format_exc())
             if hasattr(self, "teardown") and self._teardown_is_set is False:
                 self._set_teardown_flag()
@@ -418,7 +420,7 @@ def run(self, *args, **kwargs):
             except GreenletExit:
                 raise
             except Exception as e:
-                events.locust_error.fire(locust_instance=self, exception=e, tb=sys.exc_info()[2])
+                self.locust.environment.events.locust_error.fire(locust_instance=self, exception=e, tb=sys.exc_info()[2])
                 if self.locust._catch_exceptions:
                     logger.error("%s\n%s", e, traceback.format_exc())
                     self.wait()

locust/env.py

@@ -0,0 +1,47 @@
+from .events import Events
+from .stats import RequestStats
+
+
+class Environment:
+    locust_classes = None
+    """The locust user classes that is to be run"""
+
+    events = None
+    """Event hooks used by Locust internally, as well as """
+
+    stats = None
+    """Instance of RequestStats which holds the request statistics for this Locust test"""
+
+    options = None
+    """Other environment options"""
+
+    runner = None
+    """Reference to the runner instance"""
+
+    web_ui = None
+    """Reference to the WebUI instance"""
+
+    host = None
+    """Base URL of the target system"""
+
+    reset_stats = False
+    """Determines if stats should be reset once all simulated users have been spawned"""
+
+    def  __init__(self, locust_classes=None, options=None, host=None, reset_stats=False):
+        self.events = Events()
+        self.stats = RequestStats()
+        self.locust_classes = locust_classes
+        self.host = host
+        self.reset_stats = reset_stats
+        self.options = options
+
+        # set up event listeners for recording requests
+        def on_request_success(request_type, name, response_time, response_length, **kwargs):
+            self.stats.log_request(request_type, name, response_time, response_length)
+
+        def on_request_failure(request_type, name, response_time, response_length, exception, **kwargs):
+            self.stats.log_request(request_type, name, response_time, response_length)
+            self.stats.log_error(request_type, name, exception)
+
+        self.events.request_success.add_listener(on_request_success)
+        self.events.request_failure.add_listener(on_request_failure)