1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
|
# pylint: disable=line-too-long,useless-suppression
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
import random
import re
import functools
from typing import Optional
from azure.ai.projects.models import (
Connection,
ConnectionType,
CredentialType,
ApiKeyCredentials,
Deployment,
DeploymentType,
ModelDeployment,
Index,
IndexType,
AzureAISearchIndex,
DatasetVersion,
DatasetType,
DatasetCredential,
)
from devtools_testutils import AzureRecordedTestCase, EnvironmentVariableLoader, is_live_and_not_recording
servicePreparer = functools.partial(
EnvironmentVariableLoader,
"azure_ai_projects_tests",
azure_ai_projects_tests_project_endpoint="https://sanitized.services.ai.azure.com/api/projects/sanitized-project-name",
)
class TestBase(AzureRecordedTestCase):
test_redteams_params = {
# cSpell:disable-next-line
"connection_name": "naposaniwestus3",
"connection_type": ConnectionType.AZURE_OPEN_AI,
"model_deployment_name": "gpt-4o-mini"
}
test_connections_params = {
"connection_name": "connection1",
"connection_type": ConnectionType.AZURE_OPEN_AI,
}
test_deployments_params = {
"model_publisher": "Cohere",
"model_name": "gpt-4o",
"model_deployment_name": "DeepSeek-V3",
}
test_agents_params = {
"model_deployment_name": "gpt-4o",
"agent_name": "agent-for-python-projects-sdk-testing",
}
test_inference_params = {
"connection_name_api_key_auth": "connection1",
"connection_name_entra_id_auth": "connection2",
"model_deployment_name": "gpt-4o",
"aoai_api_version": "2025-04-01-preview",
}
test_indexes_params = {
"index_name": f"test-index-name",
"index_version": "1",
"ai_search_connection_name": "my-ai-search-connection",
"ai_search_index_name": "my-ai-search-index",
}
test_datasets_params = {
"dataset_name_1": f"test-dataset-name-{random.randint(0, 99999):05d}",
"dataset_name_2": f"test-dataset-name-{random.randint(0, 99999):05d}",
"dataset_name_3": f"test-dataset-name-{random.randint(0, 99999):05d}",
"dataset_name_4": f"test-dataset-name-{random.randint(0, 99999):05d}",
"dataset_version": 1,
"connection_name": "balapvbyostoragecanary",
}
# Regular expression describing the pattern of an Application Insights connection string.
REGEX_APPINSIGHTS_CONNECTION_STRING = re.compile(
r"^InstrumentationKey=[0-9a-fA-F-]{36};IngestionEndpoint=https://.+.applicationinsights.azure.com/;LiveEndpoint=https://.+.monitor.azure.com/;ApplicationId=[0-9a-fA-F-]{36}$"
)
@staticmethod
def assert_equal_or_not_none(actual, expected=None):
assert actual is not None
if expected is not None:
assert actual == expected
# Checks that a given dictionary has at least one non-empty (non-whitespace) string key-value pair.
@classmethod
def is_valid_dict(cls, d: dict[str, str]) -> bool:
return bool(d) and all(
isinstance(k, str) and isinstance(v, str) and k.strip() and v.strip() for k, v in d.items()
)
@classmethod
def validate_connection(
cls,
connection: Connection,
include_credentials: bool,
*,
expected_connection_type: Optional[ConnectionType] = None,
expected_connection_name: Optional[str] = None,
expected_authentication_type: Optional[CredentialType] = None,
expected_is_default: Optional[bool] = None,
):
assert connection.id is not None
TestBase.assert_equal_or_not_none(connection.name, expected_connection_name)
TestBase.assert_equal_or_not_none(connection.type, expected_connection_type)
TestBase.assert_equal_or_not_none(connection.credentials.type, expected_authentication_type)
if expected_is_default is not None:
assert connection.is_default == expected_is_default
if include_credentials:
if type(connection.credentials) == ApiKeyCredentials:
assert connection.credentials.type == CredentialType.API_KEY
assert connection.credentials.api_key is not None
@classmethod
def validate_red_team_response(cls, response, expected_attack_strategies: int = -1, expected_risk_categories: int = -1):
"""Assert basic red team scan response properties."""
assert response is not None
assert hasattr(response, 'name')
assert hasattr(response, 'display_name')
assert hasattr(response, 'status')
assert hasattr(response, 'attack_strategies')
assert hasattr(response, 'risk_categories')
assert hasattr(response, 'target')
assert hasattr(response, 'properties')
# Validate attack strategies and risk categories
if expected_attack_strategies != -1:
assert len(response.attack_strategies) == expected_attack_strategies
if expected_risk_categories != -1:
assert len(response.risk_categories) == expected_risk_categories
assert response.status is not None
cls._assert_azure_ml_properties(response)
@classmethod
def _assert_azure_ml_properties(cls, response):
"""Assert Azure ML specific properties are present and valid."""
properties = response.properties
assert properties is not None, "Red team scan properties should not be None"
required_properties = [
'runType',
'redteaming',
'_azureml.evaluation_run',
'_azureml.evaluate_artifacts',
'AiStudioEvaluationUri'
]
for prop in required_properties:
assert prop in properties, f"Missing required property: {prop}"
# Validate specific property values
assert properties['runType'] == 'eval_run'
assert properties['_azureml.evaluation_run'] == 'evaluation.service'
assert 'instance_results.json' in properties['_azureml.evaluate_artifacts']
assert properties['redteaming'] == 'asr'
# Validate AI Studio URI format
ai_studio_uri = properties['AiStudioEvaluationUri']
assert ai_studio_uri.startswith('https://ai.azure.com/resource/build/redteaming/')
assert 'wsid=' in ai_studio_uri
assert 'tid=' in ai_studio_uri
@classmethod
def validate_deployment(
cls,
deployment: Deployment,
*,
expected_model_name: Optional[str] = None,
expected_model_deployment_name: Optional[str] = None,
expected_model_publisher: Optional[str] = None,
):
assert type(deployment) == ModelDeployment
assert deployment.type == DeploymentType.MODEL_DEPLOYMENT
assert deployment.model_version is not None
# Comment out the below, since I see that `Cohere-embed-v3-english` has an empty capabilities dict.
# assert TestBase.is_valid_dict(deployment.capabilities)
assert bool(deployment.sku) # Check none-empty
TestBase.assert_equal_or_not_none(deployment.model_name, expected_model_name)
TestBase.assert_equal_or_not_none(deployment.name, expected_model_deployment_name)
TestBase.assert_equal_or_not_none(deployment.model_publisher, expected_model_publisher)
@classmethod
def validate_index(
cls,
index: Index,
*,
expected_index_type: Optional[IndexType] = None,
expected_index_name: Optional[str] = None,
expected_index_version: Optional[str] = None,
expected_ai_search_connection_name: Optional[str] = None,
expected_ai_search_index_name: Optional[str] = None,
):
TestBase.assert_equal_or_not_none(index.name, expected_index_name)
TestBase.assert_equal_or_not_none(index.version, expected_index_version)
if expected_index_type == IndexType.AZURE_SEARCH:
assert type(index) == AzureAISearchIndex
assert index.type == IndexType.AZURE_SEARCH
TestBase.assert_equal_or_not_none(index.connection_name, expected_ai_search_connection_name)
TestBase.assert_equal_or_not_none(index.index_name, expected_ai_search_index_name)
@classmethod
def validate_dataset(
cls,
dataset: DatasetVersion,
*,
expected_dataset_type: Optional[DatasetType] = None,
expected_dataset_name: Optional[str] = None,
expected_dataset_version: Optional[str] = None,
expected_connection_name: Optional[str] = None,
):
assert dataset.data_uri is not None
if expected_dataset_type:
assert dataset.type == expected_dataset_type
else:
assert dataset.type == DatasetType.URI_FILE or dataset.type == DatasetType.URI_FOLDER
TestBase.assert_equal_or_not_none(dataset.name, expected_dataset_name)
TestBase.assert_equal_or_not_none(dataset.version, expected_dataset_version)
if expected_connection_name:
assert dataset.connection_name == expected_connection_name
@classmethod
def validate_dataset_credential(cls, dataset_credential: DatasetCredential):
assert dataset_credential.blob_reference is not None
assert dataset_credential.blob_reference.blob_uri
assert dataset_credential.blob_reference.storage_account_arm_id
assert dataset_credential.blob_reference.credential is not None
assert (
dataset_credential.blob_reference.credential.type == "SAS"
) # Why is this not of type CredentialType.SAS as defined for Connections?
assert dataset_credential.blob_reference.credential.sas_uri
|