Merge pull request #37 from cloudblue/contrib_locust

Add contrib package for locust

Author: marcserrat

connect/client/contrib/__init__.py

@@ -0,0 +1,8 @@
+from locust import events
+
+from connect.client.contrib.locust.user import ConnectHttpUser  # noqa
+
+
+@events.init_command_line_parser.add_listener
+def _(parser):
+    parser.add_argument('--connect-api-key', default='', help='Connect Api Key')

connect/client/contrib/locust/__init__.py

@@ -0,0 +1,57 @@
+import time
+
+from locust import HttpUser
+
+from requests import RequestException
+
+from connect.client import ConnectClient
+
+
+class _LocustConnectClient(ConnectClient):
+    def __init__(self, base_url, request_event, user, *args, **kwargs):
+        self.base_url = base_url
+        self.request_event = request_event
+        self.user = user
+
+        super().__init__(
+            kwargs['connect_api_key'],
+            self.base_url,
+            use_specs=False,
+            max_retries=0,
+            timeout=(5, 120),
+        )
+
+    def _execute_http_call(self, method, url, kwargs):
+        start_time = time.perf_counter()
+        exc = None
+        try:
+            super()._execute_http_call(method, url, kwargs)
+        except RequestException as e:
+            exc = e
+
+        response = self.response.history and self.response.history[0] or self.response
+        request_meta = {
+            'request_type': method,
+            'response_time': (time.perf_counter() - start_time) * 1000,
+            'name': response.request.path_url,
+            'context': {},
+            'response': self.response,
+            'exception': exc,
+            'response_length': len(self.response.content or b''),
+        }
+
+        self.request_event.fire(**request_meta)
+
+
+class ConnectHttpUser(HttpUser):
+    abstract = True
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self.client = _LocustConnectClient(
+            self.host,
+            request_event=self.environment.events.request,
+            user=self,
+            connect_api_key=self.environment.parsed_options.connect_api_key,
+        )

connect/client/contrib/locust/user.py

@@ -86,7 +86,8 @@ omit = [
     "*/settings/*",
     "*/manage.py",
     "*/wsgi.py",
-    "*/urls.py"
+    "*/urls.py",
+    "connect/client/contrib/*"
 ]
 
 exclude_lines = [

pyproject.toml

@@ -7,6 +7,6 @@ sonar.language=py
 sonar.sources=connect
 sonar.tests=tests
 sonar.inclusions=connect/**
-sonar.exclusions=tests/**
+sonar.exclusions=connect/client/contrib/**,tests/**
 
 sonar.python.coverage.reportPaths=./coverage.xml

sonar-project.properties

@@ -114,9 +114,9 @@ async def test_execute_validate_with_specs(async_mocker):
     mocked_specs = async_mocker.MagicMock()
     mocked_specs.exists.return_value = False
 
-    async_mocker.patch('connect.client.fluent.OpenAPISpecs', return_value=mocked_specs)
-
-    c = AsyncConnectClient('API_KEY')
+    c = AsyncConnectClient('API_KEY', use_specs=False)
+    c.specs = mocked_specs
+    c._use_specs = True
     with pytest.raises(ClientError) as cv:
         await c.execute('GET', 'resources')
 

tests/async_client/test_fluent.py

@@ -180,9 +180,9 @@ def test_execute_validate_with_specs(mocker):
     mocked_specs = mocker.MagicMock()
     mocked_specs.exists.return_value = False
 
-    mocked_specs = mocker.patch('connect.client.fluent.OpenAPISpecs', return_value=mocked_specs)
-
-    c = ConnectClient('API_KEY')
+    c = ConnectClient('API_KEY', use_specs=False)
+    c.specs = mocked_specs
+    c._use_specs = True
     with pytest.raises(ClientError) as cv:
         c.execute('GET', 'resources')