azure-developer-loadtesting 1.0.0__zip

azure-developer-loadtesting-1.0.0/samples/begin_test_run.py

@@ -0,0 +1,52 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+"""
+FILE: create_or_update_test_run.py
+
+DESCRIPTION:
+    This sample shows how to create or update a test run
+
+USAGE:
+    python create_or_update_test_run.py
+
+    Set the environment variables with your own values before running the sample:
+    1)  AZURE_CLIENT_ID - client id
+    2)  AZURE_CLIENT_SECRET - client secret
+    3)  AZURE_TENANT_ID - tenant id for your Azure
+    4)  LOADTESTSERVICE_ENDPOINT - Data Plane endpoint for Loadtestservice
+"""
+from azure.developer.loadtesting import LoadTestRunClient
+
+# for details refer: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/loadtestservice/azure-developer
+# -loadtesting/README.md
+from azure.identity import DefaultAzureCredential
+
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+LOADTESTSERVICE_ENDPOINT = os.environ["LOADTESTSERVICE_ENDPOINT"]
+
+TEST_RUN_ID = "some-test-run-id"
+TEST_ID = "my-sdk-test-id"
+
+# Build a client through AAD and resource endpoint
+client = LoadTestRunClient(credential=DefaultAzureCredential(), endpoint=LOADTESTSERVICE_ENDPOINT)
+
+testRunPoller = client.begin_test_run(
+    TEST_RUN_ID,
+    {
+        "testId": TEST_ID,
+        "displayName": "My New Load Test Run",
+    }
+)
+
+#waiting for test run status to be completed with timeout = 3600 seconds
+result = testRunPoller.result(3600)
+
+print(result["status"])
+print(result)

azure-developer-loadtesting-1.0.0/samples/create_or_update_app_components.py

@@ -0,0 +1,57 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+"""
+FILE: create_or_update_app_components.py
+
+DESCRIPTION:
+    This sample shows how to create or update app component
+
+USAGE:
+    python create_or_update_app_components.py
+
+    Set the environment variables with your own values before running the sample:
+    1)  AZURE_CLIENT_ID - client id
+    2)  AZURE_CLIENT_SECRET - client secret
+    3)  AZURE_TENANT_ID - tenant id for your Azure
+    4)  RESOURCE_ID - resource id of resource to connect
+    5)  LOADTESTSERVICE_ENDPOINT - Data Plane endpoint for Loadtestservice
+"""
+from azure.developer.loadtesting import LoadTestAdministrationClient
+
+# for details refer: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/loadtestservice/azure-developer
+# -loadtesting/README.md
+from azure.identity import DefaultAzureCredential
+
+import os
+from dotenv import load_dotenv
+
+
+load_dotenv()
+LOADTESTSERVICE_ENDPOINT = os.environ["LOADTESTSERVICE_ENDPOINT"]
+RESOURCE_ID = os.environ["RESOURCE_ID"]
+
+# Build a client through AAD and resource endpoint
+client = LoadTestAdministrationClient(credential=DefaultAzureCredential(), endpoint=LOADTESTSERVICE_ENDPOINT)
+
+TEST_ID = "my-sdk-test-id"
+APP_COMPONENT = "my-new-app-component"
+
+result = client.create_or_update_app_components(
+    TEST_ID,
+    {
+        "components": {
+            RESOURCE_ID: {
+                "resourceId": RESOURCE_ID,
+                "resourceName": "App-Service-Sample-Demo",
+                "resourceType": "Microsoft.Web/sites",
+                "kind": "web",
+            }
+        },
+    },
+)
+
+print(result)

azure-developer-loadtesting-1.0.0/samples/create_or_update_test_function.py

@@ -0,0 +1,84 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+"""
+FILE: create_or_update_test_function.py
+
+DESCRIPTION:
+    This sample shows how to create or update a load test
+
+USAGE:
+    python create_or_update_test_function.py
+
+    Set the environment variables with your own values before running the sample:
+    1)  AZURE_CLIENT_ID - client id
+    2)  AZURE_CLIENT_SECRET - client secret
+    3)  AZURE_TENANT_ID - tenant id for your Azure
+    4)  LOADTESTSERVICE_ENDPOINT - Data Plane endpoint for Loadtestservice
+"""
+from azure.developer.loadtesting import LoadTestAdministrationClient
+
+# for details refer: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/loadtestservice/azure-developer
+# -loadtesting/README.md
+from azure.identity import DefaultAzureCredential
+
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+LOADTESTSERVICE_ENDPOINT = os.environ["LOADTESTSERVICE_ENDPOINT"]
+
+# Build a client through AAD and resource endpoint
+client = LoadTestAdministrationClient(credential=DefaultAzureCredential(), endpoint=LOADTESTSERVICE_ENDPOINT)
+
+# ID to be assigned to test
+TEST_ID = "my-sdk-test-id"
+
+result = client.create_or_update_test(
+    TEST_ID,
+    {
+        "description": "",
+        "displayName": "My New Load Test",
+        "loadTestConfig": {
+            "engineInstances": 1,
+            "splitAllCSVs": False,
+        },
+        "passFailCriteria": {
+            "passFailMetrics": {
+                "condition1": {
+                    "clientmetric": "response_time_ms",
+                    "aggregate": "avg",
+                    "condition": ">",
+                    "value": 300
+                },
+                "condition2": {
+                    "clientmetric": "error",
+                    "aggregate": "percentage",
+                    "condition": ">",
+                    "value": 50
+                },
+                "condition3": {
+                    "clientmetric": "latency",
+                    "aggregate": "avg",
+                    "condition": ">",
+                    "value": 200,
+                    "requestName": "GetCustomerDetails"
+                }
+            }
+        },
+        "secrets": {
+            "secret1": {
+                "value": "https://sdk-testing-keyvault.vault.azure.net/secrets/sdk-secret",
+                "type": "AKV_SECRET_URI"
+            }
+        },
+        "environmentVariables": {
+            "my-varaible": "value"
+        }
+    }
+)
+
+print(result)

azure-developer-loadtesting-1.0.0/samples/delete_load_test_function.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.
+# --------------------------------------------------------------------------
+
+"""
+FILE: delete_load_test_function.py
+
+DESCRIPTION:
+    This sample shows how to delete a load test
+
+USAGE:
+    python delete_load_test_function.py
+
+    Set the environment variables with your own values before running the sample:
+    1)  AZURE_CLIENT_ID - client id
+    2)  AZURE_CLIENT_SECRET - client secret
+    3)  AZURE_TENANT_ID - tenant id for your Azure
+    4)  LOADTESTSERVICE_ENDPOINT - Data Plane endpoint for Loadtestservice
+"""
+# main library import
+from azure.developer.loadtesting import LoadTestAdministrationClient
+
+# for managing authentication and authorization can be installed from pypi, follow:
+# https://pypi.org/project/azure-identity/ using DefaultAzureCredentials, read more at:
+# https://learn.microsoft.com/en-us/python/api/azure-identity/azure.identity.defaultazurecredential?view=azure-python
+from azure.identity import DefaultAzureCredential
+
+# importing os and dotenv for managing and loading environment variables
+import os
+from dotenv import load_dotenv
+
+# Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
+# AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET, SUBSCRIPTION_ID, RESOURCE_GROUP
+
+# loading dotenv file
+load_dotenv()
+LOADTESTSERVICE_ENDPOINT = os.environ["LOADTESTSERVICE_ENDPOINT"]
+
+TEST_ID = "my-sdk-test-id"
+
+# Build a client through AAD and resource endpoint
+client = LoadTestAdministrationClient(credential=DefaultAzureCredential(), endpoint=LOADTESTSERVICE_ENDPOINT)
+
+client.delete_test(TEST_ID)

azure-developer-loadtesting-1.0.0/samples/delete_load_test_run.py

@@ -0,0 +1,39 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+"""
+FILE: delete_load_test_run.py
+
+DESCRIPTION:
+    This sample shows how to delete a load test run
+
+USAGE:
+    python delete_load_test_run.py
+
+    Set the environment variables with your own values before running the sample:
+    1)  AZURE_CLIENT_ID - client id
+    2)  AZURE_CLIENT_SECRET - client secret
+    3)  AZURE_TENANT_ID - tenant id for your Azure
+    4)  LOADTESTSERVICE_ENDPOINT - Data Plane endpoint for Loadtestservice
+"""
+from azure.developer.loadtesting import LoadTestRunClient
+
+# for details refer: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/loadtestservice/azure-developer
+# -loadtesting/README.md
+from azure.identity import DefaultAzureCredential
+
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+LOADTESTSERVICE_ENDPOINT = os.environ["LOADTESTSERVICE_ENDPOINT"]
+
+TEST_RUN_ID = "some-test-run-id"
+
+# Build a client through AAD and resource endpoint
+client = LoadTestRunClient(credential=DefaultAzureCredential(), endpoint=LOADTESTSERVICE_ENDPOINT)
+
+client.delete_test_run(TEST_RUN_ID)

azure-developer-loadtesting-1.0.0/samples/get_metrics.py

@@ -0,0 +1,64 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+"""
+FILE: get_metics.py
+
+DESCRIPTION:
+    This sample shows how to get metrics for a test run
+
+USAGE:
+    python get_metrics.py
+
+    Set the environment variables with your own values before running the sample:
+    1)  AZURE_CLIENT_ID - client id
+    2)  AZURE_CLIENT_SECRET - client secret
+    3)  AZURE_TENANT_ID - tenant id for your Azure
+    4)  LOADTESTSERVICE_ENDPOINT - Data Plane endpoint for Loadtestservice
+"""
+from azure.developer.loadtesting import LoadTestRunClient
+
+# for details refer: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/loadtestservice/azure-developer
+# -loadtesting/README.md
+from azure.identity import DefaultAzureCredential
+
+# importing os and dotenv for managing and loading environment variables
+import os
+from dotenv import load_dotenv
+
+# for various
+import time
+
+load_dotenv()
+LOADTESTSERVICE_ENDPOINT = os.environ["LOADTESTSERVICE_ENDPOINT"]
+
+# Build a client through AAD and resource endpoint
+client = LoadTestRunClient(credential=DefaultAzureCredential(), endpoint=LOADTESTSERVICE_ENDPOINT)
+
+TEST_ID = "my-sdk-test-id"
+TEST_RUN_ID = "some-test-run-id"
+
+test_run_response = client.get_test_run(TEST_RUN_ID)
+
+# get a list of metric namespaces for a given test run
+metric_namespaces = client.get_metric_namespaces(TEST_RUN_ID)
+print(metric_namespaces)
+
+# get a list of metric definitions for a given test run and metric namespace
+metric_definitions = client.get_metric_definitions(TEST_RUN_ID, metric_namespace=metric_namespaces["value"][0]["name"])
+print(metric_definitions)
+
+# fetch metrics for a test run using metric definition and namespace
+metrics = client.list_metrics(
+    TEST_RUN_ID,
+    metric_name=metric_definitions["value"][0]["name"],
+    metric_namespace=metric_namespaces["value"][0]["name"],
+    time_interval=test_run_response["startDateTime"]+"/"+test_run_response["endDateTime"]
+)
+
+for page in metrics.by_page():
+    for data in page:
+        print(data)

azure-developer-loadtesting-1.0.0/samples/upload_test_file.py

@@ -0,0 +1,45 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+"""
+FILE: upload_test_file.py
+
+DESCRIPTION:
+    This sample shows how to upload a file to your loadtest
+USAGE:
+    python upload_test_file.py
+
+    Set the environment variables with your own values before running the sample:
+    1)  AZURE_CLIENT_ID - client id
+    2)  AZURE_CLIENT_SECRET - client secret
+    3)  AZURE_TENANT_ID - tenant id for your Azure
+    4)  LOADTESTSERVICE_ENDPOINT - Data Plane endpoint for Loadtestservice
+
+    Please ensure that correct jmx file and path is used
+"""
+from azure.developer.loadtesting import LoadTestAdministrationClient
+
+# for details refer: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/loadtestservice/azure-developer
+# -loadtesting/README.md
+from azure.identity import DefaultAzureCredential
+
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+LOADTESTSERVICE_ENDPOINT = os.environ["LOADTESTSERVICE_ENDPOINT"]
+
+client = LoadTestAdministrationClient(credential=DefaultAzureCredential(), endpoint=LOADTESTSERVICE_ENDPOINT)
+
+TEST_ID = "my-sdk-test-id"
+FILE_NAME = "my-file-id.jmx"
+
+# uploading .jmx file to a test
+resultPoller = client.begin_upload_test_file(TEST_ID, FILE_NAME, open("sample.jmx", "rb"))
+
+# getting result of LRO poller with timeout of 600 secs
+validationResponse = resultPoller.result(600)
+print(validationResponse)

azure-developer-loadtesting-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

azure-developer-loadtesting-1.0.0/setup.py

@@ -0,0 +1,71 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) AutoRest Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
+# coding: utf-8
+
+import os
+import re
+from setuptools import setup, find_packages
+
+
+PACKAGE_NAME = "azure-developer-loadtesting"
+PACKAGE_PPRINT_NAME = "Azure Developer LoadTesting"
+
+# a-b-c => a/b/c
+package_folder_path = PACKAGE_NAME.replace("-", "/")
+
+# Version extraction inspired from 'requests'
+with open(os.path.join(package_folder_path, "_version.py"), "r") as fd:
+    version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1)
+
+if not version:
+    raise RuntimeError("Cannot find version information")
+
+
+setup(
+    name=PACKAGE_NAME,
+    version=version,
+    description="Microsoft Azure Developer LoadTesting Client Library for Python",
+    long_description=open("README.md", "r").read(),
+    long_description_content_type="text/markdown",
+    license="MIT License",
+    author="Microsoft Corporation",
+    author_email="azpysdkhelp@microsoft.com",
+    url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk",
+    keywords="azure, azure sdk",
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3 :: Only",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "License :: OSI Approved :: MIT License",
+    ],
+    zip_safe=False,
+    packages=find_packages(
+        exclude=[
+            "tests",
+            # Exclude packages that will be covered by PEP420 or nspkg
+            "azure",
+            "azure.developer",
+        ]
+    ),
+    include_package_data=True,
+    package_data={
+        "pytyped": ["py.typed"],
+    },
+    install_requires=[
+        "isodate<1.0.0,>=0.6.1",
+        "azure-core<2.0.0,>=1.24.0",
+        "typing-extensions>=4.3.0; python_version<'3.8.0'",
+    ],
+    python_requires=">=3.7",
+)

azure-developer-loadtesting-1.0.0/tests/conftest.py

@@ -0,0 +1,60 @@
+# --------------------------------------------------------------------------
+#
+# Copyright (c) Microsoft Corporation. All rights reserved.
+#
+# The MIT License (MIT)
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the ""Software""), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+#
+# --------------------------------------------------------------------------
+import os
+import platform
+import pytest
+import sys
+
+from dotenv import load_dotenv
+
+from devtools_testutils import test_proxy, add_general_regex_sanitizer, add_body_key_sanitizer, add_header_regex_sanitizer
+
+load_dotenv()
+
+@pytest.fixture(scope="session", autouse=True)
+def add_sanitizers(test_proxy):
+    subscription_id = os.environ.get("LOADTESTING_SUBSCRIPTION_ID", "00000000-0000-0000-0000-000000000000")
+    tenant_id = os.environ.get("LOADTESTING_TENANT_ID", "00000000-0000-0000-0000-000000000000")
+    client_id = os.environ.get("LOADTESTING_CLIENT_ID", "00000000-0000-0000-0000-000000000000")
+    client_secret = os.environ.get("LOADTESTING_CLIENT_SECRET", "00000000-0000-0000-0000-000000000000")
+    test_id = os.environ.get("TEST_ID", "000")
+    file_id = os.environ.get("FILE_ID", "000")
+    test_run_id = os.environ.get("TEST_RUN_ID", "000")
+    resource_id = os.environ.get("RESOURCE_ID", "000")
+    app_component = os.environ.get("APP_COMPONENT", "000")
+    add_general_regex_sanitizer(regex=subscription_id, value="00000000-0000-0000-0000-000000000000")
+    add_general_regex_sanitizer(regex=tenant_id, value="00000000-0000-0000-0000-000000000000")
+    add_general_regex_sanitizer(regex=client_id, value="00000000-0000-0000-0000-000000000000")
+    add_general_regex_sanitizer(regex=client_secret, value="00000000-0000-0000-0000-000000000000")
+    add_general_regex_sanitizer(regex=test_id, value="000")
+    add_general_regex_sanitizer(regex=file_id, value="000")
+    add_general_regex_sanitizer(regex=test_run_id, value="000")
+    add_general_regex_sanitizer(regex=app_component, value="000")
+    add_general_regex_sanitizer(regex=resource_id, value="000")
+    add_header_regex_sanitizer(key="Set-Cookie", value="[set-cookie;]")
+    add_header_regex_sanitizer(key="Cookie", value="cookie;")
+    add_body_key_sanitizer(json_path="$..access_token", value="access_token")
+    add_body_key_sanitizer(json_path="$..url", value="url")