[ServiceBus] initial stress test onboarding (Azure#22982)

* initial stress onboarding

* lint + ignore stress tests

* adams comments

Author: swathipil

eng/.docsettings.yml

@@ -76,6 +76,7 @@ known_content_issues:
   - ['sdk/loganalytics/azure-loganalytics/README.md', '#4554']
   - ['sdk/servicebus/azure-servicebus/README.md', '#4554']
   - ['sdk/servicebus/azure-servicebus/tests/perf_tests/README.md', '#4554']
+  - ['sdk/servicebus/azure-servicebus/stress/scripts/README.md', '#4554']
   - ['sdk/servicefabric/azure-servicefabric/README.md', '#4554']
   - ['sdk/storage/azure-storage-blob/swagger/README.md', '#4554']
   - ['cognitivelanguage/azure-ai-language-questionanswering/swagger/README.md', '#4554']

sdk/servicebus/azure-servicebus/conftest.py

@@ -14,7 +14,7 @@
 
 # Only run stress tests on request.
 if not any([arg.startswith('test_stress') or arg.endswith('StressTest') for arg in sys.argv]):
-    collect_ignore.append("tests/stress_tests")
+    collect_ignore.append("stress/scripts")
 
 # Allow us to pass stress_test_duration from the command line.
 def pytest_addoption(parser):

sdk/servicebus/azure-servicebus/stress/Chart.lock

@@ -0,0 +1,6 @@
+dependencies:
+- name: stress-test-addons
+  repository: https://stresstestcharts.blob.core.windows.net/helm/
+  version: 0.1.13
+digest: sha256:007ec9983233e0f8c8ad8aa7f1df5f57b1b4c127d223d59d233b3c5366bd5173
+generated: "2021-12-02T16:05:20.2152434-05:00"

sdk/servicebus/azure-servicebus/stress/Chart.yaml

@@ -0,0 +1,13 @@
+apiVersion: v2
+name: python-servicebus-stress-test
+description: python service bus stress test.
+version: 0.1.2
+appVersion: v0.2
+annotations:
+  stressTest: 'true'
+  namespace: python
+
+dependencies:
+- name: stress-test-addons
+  version: 0.1.13
+  repository: https://stresstestcharts.blob.core.windows.net/helm/

sdk/servicebus/azure-servicebus/stress/Dockerfile

@@ -0,0 +1,10 @@
+# syntax=docker/dockerfile:1
+
+FROM python:3.8-slim-buster
+
+WORKDIR /app
+
+COPY ./scripts /app/stress/scripts
+
+WORKDIR /app/stress/scripts
+RUN pip3 install -r dev_requirements.txt

sdk/servicebus/azure-servicebus/stress/scripts/README.md

@@ -0,0 +1,21 @@
+# ServiceBus Stress Tests
+
+TODO: README is currently a WIP and has minimal information for local testing. Need to update later.
+
+The `stress_runner.py` file is AN EXAMPLE of how to run the tests, not the actual stress test file.
+The actual test files are prefixed with `test_` and `stress_test_`.
+
+## Setup for local stress test runs
+
+```cmd
+(env) ~/azure-servicebus> pip install .
+(env) ~/azure-servicebus/stress/scripts> pip install -r dev_requirements.txt
+```
+
+## Test commands for local testing
+
+Run the chosen test file with the following command:
+
+```cmd
+(env) ~/azure-servicebus/stress/scripts> python test_stress_queues.py
+```

sdk/servicebus/azure-servicebus/tests/stress_tests/app_insights_metric.py renamed to sdk/servicebus/azure-servicebus/stress/scripts/app_insights_metric.py

@@ -88,6 +88,9 @@ def __init__(self, test_name, test_description=None):
         self.mmap = self.stats_recorder.new_measurement_map()
 
     def record_messages_cpu_memory(self, number_of_messages, cpu_usage, memory_usage):
+        if not number_of_messages:
+            # if not batch size, then only single message being sent
+            number_of_messages = 1
         self.mmap.measure_int_put(self.messages_measure, number_of_messages)
         self.mmap.measure_float_put(self.memory_measure, memory_usage)
         self.mmap.measure_float_put(self.cpu_measure, cpu_usage)

sdk/servicebus/azure-servicebus/stress/scripts/conftest.py

@@ -0,0 +1,46 @@
+#-------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+#--------------------------------------------------------------------------
+import pytest
+import os
+import sys
+from azure.servicebus import ServiceBusClient
+from dotenv import load_dotenv
+
+LOGGING_ENABLE = False
+ENV_FILE = os.environ.get('ENV_FILE')
+load_dotenv(dotenv_path=ENV_FILE, override=True)
+
+# Allow us to pass stress_test_duration from the command line. TODO: may not actually be using this.
+def pytest_addoption(parser):
+    parser.addoption('--stress_test_duration_seconds', action="store", default=None)
+
+# Note: This is duplicated between here and the basic conftest, so that it does not throw warnings if you're
+# running locally to this SDK. (Everything works properly, pytest just makes a bit of noise.)
+def pytest_configure(config):
+    # register an additional marker
+    config.addinivalue_line(
+        "markers", "liveTest: mark test to be a live test only"
+    )
+    config.addinivalue_line(
+        "markers", "live_test_only: mark test to be a live test only"
+    )
+    config.addinivalue_line(
+        "markers", "playback_test_only: mark test to be a playback test only"
+    )
+
+# fixture needs to be visible from conftest
+
+@pytest.fixture(scope="session", autouse=True)
+def sb_client():
+    service_bus_connection_str = os.environ['SERVICE_BUS_CONNECTION_STR']
+    client = ServiceBusClient.from_connection_string(
+        service_bus_connection_str, logging_enable=LOGGING_ENABLE)
+    return client
+
+@pytest.fixture()
+def servicebus_queue_name(sb_client):
+    sb_queue_name = os.environ['SERVICE_BUS_QUEUE_NAME']
+    return sb_queue_name

sdk/servicebus/azure-servicebus/tests/stress_tests/dev_requirements.txt renamed to sdk/servicebus/azure-servicebus/stress/scripts/dev_requirements.txt

@@ -1,3 +1,6 @@
 aiohttp>=3.0; python_version >= '3.5'
 opencensus-ext-azure
 psutil
+pytest
+azure-servicebus
+python-dotenv