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
|
# 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.
# --------------------------------------------------------------------------
from devtools_testutils import AzureRecordedTestCase
from azure.appconfiguration import AzureAppConfigurationClient, ConfigurationSetting, FeatureFlagConfigurationSetting
from azure.appconfiguration.provider import SettingSelector, load, AzureAppConfigurationKeyVaultOptions
from test_constants import FEATURE_MANAGEMENT_KEY, FEATURE_FLAG_KEY
class AppConfigTestCase(AzureRecordedTestCase):
def create_aad_client(
self,
appconfiguration_endpoint_string,
trim_prefixes=[],
selects={SettingSelector(key_filter="*", label_filter="\0")},
keyvault_secret_url=None,
refresh_on=None,
refresh_interval=30,
secret_resolver=None,
key_vault_options=None,
on_refresh_success=None,
feature_flag_enabled=False,
feature_flag_refresh_enabled=False,
):
cred = self.get_credential(AzureAppConfigurationClient)
client = AzureAppConfigurationClient(appconfiguration_endpoint_string, cred)
setup_configs(client, keyvault_secret_url)
if not secret_resolver and keyvault_secret_url and not key_vault_options:
keyvault_cred = cred
return load(
credential=cred,
endpoint=appconfiguration_endpoint_string,
trim_prefixes=trim_prefixes,
selects=selects,
refresh_on=refresh_on,
refresh_interval=refresh_interval,
user_agent="SDK/Integration",
keyvault_credential=keyvault_cred,
on_refresh_success=on_refresh_success,
feature_flag_enabled=feature_flag_enabled,
feature_flag_refresh_enabled=feature_flag_refresh_enabled,
)
if key_vault_options:
if not key_vault_options.secret_resolver:
key_vault_options = AzureAppConfigurationKeyVaultOptions(credential=cred)
return load(
credential=cred,
endpoint=appconfiguration_endpoint_string,
trim_prefixes=trim_prefixes,
selects=selects,
refresh_on=refresh_on,
refresh_interval=refresh_interval,
user_agent="SDK/Integration",
key_vault_options=key_vault_options,
on_refresh_success=on_refresh_success,
feature_flag_enabled=feature_flag_enabled,
feature_flag_refresh_enabled=feature_flag_refresh_enabled,
)
return load(
credential=cred,
endpoint=appconfiguration_endpoint_string,
trim_prefixes=trim_prefixes,
selects=selects,
refresh_on=refresh_on,
refresh_interval=refresh_interval,
user_agent="SDK/Integration",
secret_resolver=secret_resolver,
on_refresh_success=on_refresh_success,
feature_flag_enabled=feature_flag_enabled,
feature_flag_refresh_enabled=feature_flag_refresh_enabled,
)
def create_client(
self,
appconfiguration_connection_string,
trim_prefixes=[],
selects={SettingSelector(key_filter="*", label_filter="\0")},
keyvault_secret_url=None,
refresh_on=None,
refresh_interval=30,
secret_resolver=None,
key_vault_options=None,
on_refresh_success=None,
feature_flag_enabled=False,
feature_flag_refresh_enabled=False,
):
client = AzureAppConfigurationClient.from_connection_string(appconfiguration_connection_string)
setup_configs(client, keyvault_secret_url)
if not secret_resolver and keyvault_secret_url and not key_vault_options:
return load(
connection_string=appconfiguration_connection_string,
trim_prefixes=trim_prefixes,
selects=selects,
refresh_on=refresh_on,
refresh_interval=refresh_interval,
user_agent="SDK/Integration",
keyvault_credential=self.get_credential(AzureAppConfigurationClient),
on_refresh_success=on_refresh_success,
feature_flag_enabled=feature_flag_enabled,
feature_flag_refresh_enabled=feature_flag_refresh_enabled,
)
if key_vault_options:
if not key_vault_options.secret_resolver:
key_vault_options = AzureAppConfigurationKeyVaultOptions(
credential=self.get_credential(AzureAppConfigurationClient)
)
return load(
connection_string=appconfiguration_connection_string,
trim_prefixes=trim_prefixes,
selects=selects,
refresh_on=refresh_on,
refresh_interval=refresh_interval,
user_agent="SDK/Integration",
key_vault_options=key_vault_options,
on_refresh_success=on_refresh_success,
feature_flag_enabled=feature_flag_enabled,
feature_flag_refresh_enabled=feature_flag_refresh_enabled,
)
return load(
connection_string=appconfiguration_connection_string,
trim_prefixes=trim_prefixes,
selects=selects,
refresh_on=refresh_on,
refresh_interval=refresh_interval,
user_agent="SDK/Integration",
secret_resolver=secret_resolver,
on_refresh_success=on_refresh_success,
feature_flag_enabled=feature_flag_enabled,
feature_flag_refresh_enabled=feature_flag_refresh_enabled,
)
@staticmethod
def create_sdk_client(appconfiguration_connection_string):
return AzureAppConfigurationClient.from_connection_string(
appconfiguration_connection_string, user_agent="SDK/Integration"
)
def create_aad_sdk_client(self, appconfiguration_endpoint_string):
cred = self.get_credential(AzureAppConfigurationClient)
return AzureAppConfigurationClient(appconfiguration_endpoint_string, cred, user_agent="SDK/Integration")
def setup_configs(client, keyvault_secret_url):
for config in get_configs(keyvault_secret_url):
client.set_configuration_setting(config)
def get_configs(keyvault_secret_url):
configs = []
configs.append(create_config_setting("message", "\0", "hi"))
configs.append(create_config_setting("message", "dev", "test"))
configs.append(create_config_setting("my_json", "\0", '{"key": "value"}', "application/json"))
configs.append(create_config_setting("test.trimmed", "\0", "key"))
configs.append(create_config_setting("refresh_message", "\0", "original value"))
configs.append(create_config_setting("non_refreshed_message", "\0", "Static"))
configs.append(
create_config_setting(
".appconfig.featureflag/Alpha",
"\0",
'{ "id": "Alpha", "description": "", "enabled": false, "conditions": { "client_filters": [] }}',
"application/vnd.microsoft.appconfig.ff+json;charset=utf-8",
)
)
if keyvault_secret_url:
configs.append(
create_config_setting(
"secret",
"prod",
'{"uri":"' + keyvault_secret_url + '"}',
"application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8",
)
)
return configs
def create_config_setting(key, label, value, content_type="text/plain"):
return ConfigurationSetting(
key=key,
label=label,
value=value,
content_type=content_type,
)
def create_feature_flag_config_setting(key, label, enabled):
return FeatureFlagConfigurationSetting(
feature_id=key,
label=label,
enabled=enabled,
)
def get_feature_flag(client, feature_id):
for feature_flag in client[FEATURE_MANAGEMENT_KEY][FEATURE_FLAG_KEY]:
if feature_flag["id"] == feature_id:
return feature_flag
return None
def has_feature_flag(client, feature_id, enabled=False):
feature_flag = get_feature_flag(client, feature_id)
if feature_flag:
return feature_flag["enabled"] == enabled
return False
|
