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 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
from azure.appconfiguration.provider import (
SettingSelector,
AzureAppConfigurationKeyVaultOptions,
AzureAppConfigurationProvider,
)
from devtools_testutils import recorded_by_proxy
from preparers import app_config_decorator
from testcase import AppConfigTestCase, has_feature_flag
import datetime
from unittest.mock import patch
from test_constants import FEATURE_MANAGEMENT_KEY
from unittest.mock import MagicMock, patch
from azure.appconfiguration.provider._azureappconfigurationproviderbase import (
delay_failure,
)
from azure.appconfiguration.provider._azureappconfigurationprovider import _buildprovider
def sleep(seconds):
assert isinstance(seconds, float)
class TestAppConfigurationProvider(AppConfigTestCase):
# method: provider_creation
@recorded_by_proxy
@app_config_decorator
def test_provider_creation(self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url):
client = self.create_client(
connection_string=appconfiguration_connection_string,
keyvault_secret_url=appconfiguration_keyvault_secret_url,
feature_flag_enabled=True,
)
assert client["message"] == "hi"
assert client["my_json"]["key"] == "value"
assert ".appconfig.featureflag/Alpha" not in client
assert FEATURE_MANAGEMENT_KEY in client
assert has_feature_flag(client, "Alpha")
# method: provider_trim_prefixes
@recorded_by_proxy
@app_config_decorator
def test_provider_trim_prefixes(self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url):
trimmed = {"test."}
client = self.create_client(
connection_string=appconfiguration_connection_string,
trim_prefixes=trimmed,
keyvault_secret_url=appconfiguration_keyvault_secret_url,
feature_flag_enabled=True,
)
assert client["message"] == "hi"
assert client["my_json"]["key"] == "value"
assert client["trimmed"] == "key"
assert "test.trimmed" not in client
assert FEATURE_MANAGEMENT_KEY in client
assert has_feature_flag(client, "Alpha")
# method: provider_selectors
@recorded_by_proxy
@app_config_decorator
def test_provider_selectors(self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url):
selects = {SettingSelector(key_filter="message*", label_filter="dev")}
client = self.create_client(
connection_string=appconfiguration_connection_string,
selects=selects,
keyvault_secret_url=appconfiguration_keyvault_secret_url,
)
assert client["message"] == "test"
assert "test.trimmed" not in client
assert FEATURE_MANAGEMENT_KEY not in client
# method: provider_selectors
@recorded_by_proxy
@app_config_decorator
def test_provider_key_vault_reference(
self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url
):
selects = {SettingSelector(key_filter="*", label_filter="prod")}
client = self.create_client(
connection_string=appconfiguration_connection_string,
selects=selects,
keyvault_secret_url=appconfiguration_keyvault_secret_url,
)
assert client["secret"] == "Very secret value"
# method: provider_selectors
@recorded_by_proxy
@app_config_decorator
def test_provider_secret_resolver(self, appconfiguration_connection_string):
selects = {SettingSelector(key_filter="*", label_filter="prod")}
client = self.create_client(
connection_string=appconfiguration_connection_string, selects=selects, secret_resolver=secret_resolver
)
assert client["secret"] == "Resolver Value"
# method: provider_selectors
@recorded_by_proxy
@app_config_decorator
def test_provider_key_vault_reference_options(
self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url
):
selects = {SettingSelector(key_filter="*", label_filter="prod")}
key_vault_options = AzureAppConfigurationKeyVaultOptions()
client = self.create_client(
connection_string=appconfiguration_connection_string,
selects=selects,
keyvault_secret_url=appconfiguration_keyvault_secret_url,
key_vault_options=key_vault_options,
)
assert client["secret"] == "Very secret value"
# method: provider_selectors
@recorded_by_proxy
@app_config_decorator
def test_provider_secret_resolver_options(self, appconfiguration_connection_string):
selects = {SettingSelector(key_filter="*", label_filter="prod")}
key_vault_options = AzureAppConfigurationKeyVaultOptions(secret_resolver=secret_resolver)
client = self.create_client(
connection_string=appconfiguration_connection_string, selects=selects, key_vault_options=key_vault_options
)
assert client["secret"] == "Resolver Value"
# method: delay_failure
@patch("time.sleep", side_effect=sleep)
def test_delay_failure(self, mock_sleep, **kwargs):
start_time = datetime.datetime.now()
delay_failure(start_time)
assert mock_sleep.call_count == 1
mock_sleep.reset_mock()
start_time = datetime.datetime.now() - datetime.timedelta(seconds=10)
delay_failure(start_time)
mock_sleep.assert_not_called()
def test_process_key_value_content_type(self):
with patch(
"azure.appconfiguration.provider._azureappconfigurationprovider.ConfigurationClientManager"
) as MockClientManager:
# Mock the client manager and its methods
mock_client_manager = MockClientManager.return_value
mock_client_manager.load_configuration_settings.return_value = [
{"key": "test_key", "value": '{"key": "value"}', "content_type": "application/json"}
]
# Create the provider with the mocked client manager
provider = _buildprovider("=mock_connection_string;;", None, None)
provider._replica_client_manager = mock_client_manager
# Call the method to process key-value pairs
processed_value = provider._process_key_value(
MagicMock(content_type="application/json", value='{"key": "value"}')
)
# Assert the processed value is as expected
assert processed_value == {"key": "value"}
assert provider._tracing_context.uses_ai_configuration == False
assert provider._tracing_context.uses_aicc_configuration == False
mock_client_manager.load_configuration_settings.return_value = [
{
"key": "test_key",
"value": '{"key": "value"}',
"content_type": "https://azconfig.io/mime-profiles/ai/",
}
]
processed_value = provider._process_key_value(
MagicMock(
content_type='application/json; profile="https://azconfig.io/mime-profiles/ai/"',
value='{"key": "value"}',
)
)
assert processed_value == {"key": "value"}
assert provider._tracing_context.uses_ai_configuration == True
assert provider._tracing_context.uses_aicc_configuration == False
mock_client_manager.load_configuration_settings.return_value = [
{
"key": "test_key",
"value": '{"key": "value"}',
"content_type": 'application/json; profile="https://azconfig.io/mime-profiles/ai/chat-completion"',
}
]
processed_value = provider._process_key_value(
MagicMock(
content_type='application/json; profile="https://azconfig.io/mime-profiles/ai/chat-completion"',
value='{"key": "value"}',
)
)
assert processed_value == {"key": "value"}
assert provider._tracing_context.uses_ai_configuration == True
assert provider._tracing_context.uses_aicc_configuration == True
@recorded_by_proxy
@app_config_decorator
def test_provider_tag_filters(self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url):
selects = {SettingSelector(key_filter="*", tag_filters=["a=b"])}
client = self.create_client(
connection_string=appconfiguration_connection_string,
selects=selects,
feature_flag_enabled=True,
feature_flag_selectors={SettingSelector(key_filter="*", tag_filters=["a=b"])},
keyvault_secret_url=appconfiguration_keyvault_secret_url,
)
assert "tagged_config" in client
assert "two_tagged" in client
assert "only_second_tag" not in client
assert FEATURE_MANAGEMENT_KEY in client
assert has_feature_flag(client, "TaggedFeatureFlag")
assert "message" not in client
@recorded_by_proxy
@app_config_decorator
def test_provider_two_tag_filters(self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url):
selects = {SettingSelector(key_filter="*", tag_filters=["a=b", "second=tag"])}
client = self.create_client(
connection_string=appconfiguration_connection_string,
selects=selects,
feature_flag_enabled=True,
feature_flag_selectors={SettingSelector(key_filter="*", tag_filters=["a=b"])},
keyvault_secret_url=appconfiguration_keyvault_secret_url,
)
assert "tagged_config" not in client
assert "two_tagged" in client
assert "only_second_tag" not in client
assert FEATURE_MANAGEMENT_KEY in client
assert has_feature_flag(client, "TaggedFeatureFlag")
assert "message" not in client
@recorded_by_proxy
@app_config_decorator
def test_provider_special_chars_tag_filters(
self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url
):
selects = {SettingSelector(key_filter="*", tag_filters=["Special:Tag=Value:With:Colons"])}
client = self.create_client(
connection_string=appconfiguration_connection_string,
selects=selects,
)
assert "tagged_config" not in client
assert "two_tagged" not in client
assert "only_second_tag" not in client
assert "complex_tag" in client
selects = {SettingSelector(key_filter="*", tag_filters=["Tag@With@At=Value@With@At"])}
client = self.create_client(
connection_string=appconfiguration_connection_string,
selects=selects,
)
assert "tagged_config" not in client
assert "two_tagged" not in client
assert "only_second_tag" not in client
assert "complex_tag" in client
# method: load
@recorded_by_proxy
@app_config_decorator
def test_configuration_mapper(self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url):
def test_mapper(setting):
if setting.key == "message":
setting.value = "mapped"
client = self.create_client(
connection_string=appconfiguration_connection_string,
keyvault_secret_url=appconfiguration_keyvault_secret_url,
feature_flag_enabled=True,
configuration_mapper=test_mapper,
)
assert client["message"] == "mapped"
assert client["refresh_message"] == "original value"
# method: load
@recorded_by_proxy
@app_config_decorator
def test_configuration_mapper_with_trimming(
self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url
):
def test_mapper(setting):
if setting.key == "message":
setting.value = "mapped"
client = self.create_client(
connection_string=appconfiguration_connection_string,
keyvault_secret_url=appconfiguration_keyvault_secret_url,
configuration_mapper=test_mapper,
trim_prefixes=["refresh_"],
)
# Because our processing happens after mapping and refresh_message is alphabetically after message the override
# value isn't used, as the mapped value is overridden by the first value.
assert client["message"] == "original value"
assert "refresh_message" not in client
# method: load
@recorded_by_proxy
@app_config_decorator
def test_configuration_mapper_with_feature_flags(
self, appconfiguration_connection_string, appconfiguration_keyvault_secret_url
):
def test_mapper(setting):
if setting.key == ".appconfig.featureflag/Alpha":
setting.content_type = "application/json"
client = self.create_client(
connection_string=appconfiguration_connection_string,
keyvault_secret_url=appconfiguration_keyvault_secret_url,
feature_flag_enabled=True,
configuration_mapper=test_mapper,
trim_prefixes=[".appconfig.featureflag/"],
)
# Feature Flags aren't modified by configuration mappers
assert "Alpha" not in client
assert client["feature_management"]["feature_flags"][0]["id"] == "Alpha"
def secret_resolver(secret_id):
return "Resolver Value"
|