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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import unittest
from unittest.mock import Mock, patch
from azure.appconfiguration import SecretReferenceConfigurationSetting
from azure.appconfiguration.provider._key_vault._secret_provider import SecretProvider
from azure.keyvault.secrets import SecretClient
from devtools_testutils import recorded_by_proxy
from preparers import app_config_decorator_aad
from testcase import AppConfigTestCase
TEST_SECRET_ID = "https://myvault.vault.azure.net/secrets/my_secret"
TEST_SECRET_ID_VERSION = TEST_SECRET_ID + "/12345"
class TestSecretProvider(AppConfigTestCase, unittest.TestCase):
def test_init_with_defaults(self):
"""Test initialization of SecretProvider with default parameters."""
secret_provider = SecretProvider()
# Verify initialization with defaults
self.assertEqual(len(secret_provider._secret_clients), 0)
self.assertIsNone(secret_provider._keyvault_credential)
self.assertIsNone(secret_provider._secret_resolver)
self.assertEqual(secret_provider._keyvault_client_configs, {})
self.assertFalse(secret_provider.uses_key_vault)
self.assertIsNone(secret_provider.secret_refresh_timer)
self.assertEqual(len(secret_provider._secret_cache), 0)
def test_init_with_keyvault_credential(self):
"""Test initialization with a Key Vault credential."""
mock_credential = Mock()
secret_provider = SecretProvider(keyvault_credential=mock_credential)
# Verify initialization with a Key Vault credential
self.assertEqual(len(secret_provider._secret_clients), 0)
self.assertEqual(secret_provider._keyvault_credential, mock_credential)
self.assertIsNone(secret_provider._secret_resolver)
self.assertEqual(secret_provider._keyvault_client_configs, {})
self.assertTrue(secret_provider.uses_key_vault)
def test_init_with_secret_resolver(self):
"""Test initialization with a secret resolver."""
mock_resolver = Mock()
secret_provider = SecretProvider(secret_resolver=mock_resolver)
# Verify initialization with a secret resolver
self.assertEqual(len(secret_provider._secret_clients), 0)
self.assertIsNone(secret_provider._keyvault_credential)
self.assertEqual(secret_provider._secret_resolver, mock_resolver)
self.assertEqual(secret_provider._keyvault_client_configs, {})
self.assertTrue(secret_provider.uses_key_vault)
def test_init_with_keyvault_client_configs(self):
"""Test initialization with Key Vault client configurations."""
client_configs = {"https://myvault.vault.azure.net/": {"retry_total": 3}}
secret_provider = SecretProvider(keyvault_client_configs=client_configs)
# Verify initialization with Key Vault client configurations
self.assertEqual(len(secret_provider._secret_clients), 0)
self.assertIsNone(secret_provider._keyvault_credential)
self.assertIsNone(secret_provider._secret_resolver)
self.assertEqual(secret_provider._keyvault_client_configs, client_configs)
self.assertTrue(secret_provider.uses_key_vault)
def test_init_with_secret_refresh_interval(self):
"""Test initialization with a secret refresh interval."""
mock_credential = Mock()
refresh_interval = 30
secret_provider = SecretProvider(keyvault_credential=mock_credential, secret_refresh_interval=refresh_interval)
# Verify initialization with a secret refresh interval
self.assertIsNotNone(secret_provider.secret_refresh_timer)
self.assertTrue(secret_provider.uses_key_vault)
def test_resolve_keyvault_reference_with_cached_secret(self):
"""Test resolving a Key Vault reference when the secret is in the cache."""
# Create a mock Key Vault reference
config = SecretReferenceConfigurationSetting(key="test-key", secret_id=TEST_SECRET_ID)
# Create a SecretProvider with a mock credential
secret_provider = SecretProvider(keyvault_credential=Mock())
key_vault_identifier, _ = secret_provider.resolve_keyvault_reference_base(config)
# Add to cache
secret_provider._secret_cache[key_vault_identifier.source_id] = (
key_vault_identifier,
"test-key",
"cached-secret-value",
)
# This should return the cached value without calling SecretClient
result = secret_provider.resolve_keyvault_reference(config)
# Verify the result
self.assertEqual(result, "cached-secret-value")
def test_resolve_keyvault_reference_with_cached_secret_version(self):
"""Test resolving a Key Vault reference when the secret is in the cache."""
# Create a mock Key Vault reference
config = SecretReferenceConfigurationSetting(key="test-key", secret_id=TEST_SECRET_ID_VERSION)
# Create a SecretProvider with a mock credential
secret_provider = SecretProvider(keyvault_credential=Mock())
key_vault_identifier, _ = secret_provider.resolve_keyvault_reference_base(config)
# Add to cache
secret_provider._secret_cache[key_vault_identifier.source_id] = (
key_vault_identifier,
"test-key",
"cached-secret-value",
)
# This should return the cached value without calling SecretClient
result = secret_provider.resolve_keyvault_reference(config)
# Verify the result
self.assertEqual(result, "cached-secret-value")
def test_resolve_keyvault_reference_with_existing_client(self):
"""Test resolving a Key Vault reference with an existing client."""
# Create a mock Key Vault reference
config = SecretReferenceConfigurationSetting(key="test-key", secret_id=TEST_SECRET_ID_VERSION)
# Create a SecretProvider with a mock credential
mock_credential = Mock()
secret_provider = SecretProvider(keyvault_credential=mock_credential)
# Create a mock SecretClient
mock_client = Mock()
mock_secret = Mock()
mock_secret.value = "secret-value"
mock_client.get_secret.return_value = mock_secret
# Add the mock client to the secret_clients dictionary
vault_url = "https://myvault.vault.azure.net/"
secret_provider._secret_clients[vault_url] = mock_client
# Setup key vault identifier mock
with patch("azure.keyvault.secrets.KeyVaultSecretIdentifier") as mock_kv_id:
mock_id_instance = Mock()
mock_id_instance._resource_id = TEST_SECRET_ID_VERSION
mock_id_instance.source_id = TEST_SECRET_ID_VERSION
mock_id_instance.name = "my_secret"
mock_id_instance.version = "12345"
mock_id_instance.vault_url = "https://myvault.vault.azure.net"
mock_kv_id.return_value = mock_id_instance
# Call resolve_keyvault_reference
with patch.object(secret_provider, "resolve_keyvault_reference_base") as mock_base:
mock_base.return_value = (mock_id_instance, vault_url)
result = secret_provider.resolve_keyvault_reference(config)
# Verify the result
self.assertEqual(result, "secret-value")
mock_client.get_secret.assert_called_once_with(mock_id_instance.name, version=mock_id_instance.version)
# Verify the secret was cached
_, _, value = secret_provider._secret_cache[TEST_SECRET_ID_VERSION]
self.assertEqual(value, "secret-value")
def test_resolve_keyvault_reference_with_new_client(self):
"""Test resolving a Key Vault reference by creating a new client."""
# Create a mock Key Vault reference
config = SecretReferenceConfigurationSetting(key="test-key", secret_id=TEST_SECRET_ID_VERSION)
# Create a SecretProvider with a mock credential
mock_credential = Mock()
secret_provider = SecretProvider(keyvault_credential=mock_credential)
# Setup key vault identifier mock
with patch("azure.keyvault.secrets.KeyVaultSecretIdentifier") as mock_kv_id:
mock_id_instance = Mock()
mock_id_instance._resource_id = TEST_SECRET_ID_VERSION
mock_id_instance.source_id = TEST_SECRET_ID_VERSION
mock_id_instance.name = "my_secret"
mock_id_instance.version = "12345"
mock_id_instance.vault_url = "https://myvault.vault.azure.net"
mock_kv_id.return_value = mock_id_instance
# Mock SecretClient creation and get_secret method
with patch("azure.appconfiguration.provider._key_vault._secret_provider.SecretClient") as mock_client_class:
mock_client = Mock()
mock_secret = Mock()
mock_secret.value = "new-secret-value"
mock_client.get_secret.return_value = mock_secret
mock_client_class.return_value = mock_client
# Call resolve_keyvault_reference
with patch.object(secret_provider, "resolve_keyvault_reference_base") as mock_base:
vault_url = "https://myvault.vault.azure.net/"
mock_base.return_value = (mock_id_instance, vault_url)
result = secret_provider.resolve_keyvault_reference(config)
# Verify the result
self.assertEqual(result, "new-secret-value")
mock_client_class.assert_called_once_with(vault_url=vault_url, credential=mock_credential)
mock_client.get_secret.assert_called_once_with(
mock_id_instance.name, version=mock_id_instance.version
)
# Verify the client was cached
self.assertEqual(secret_provider._secret_clients[vault_url], mock_client)
# Verify the secret was cached
_, _, value = secret_provider._secret_cache[TEST_SECRET_ID_VERSION]
self.assertEqual(value, "new-secret-value")
def test_resolve_keyvault_reference_with_secret_resolver(self):
"""Test resolving a Key Vault reference using a secret resolver."""
# Create a mock Key Vault reference
config = SecretReferenceConfigurationSetting(key="test-key", secret_id=TEST_SECRET_ID_VERSION)
# Create a mock secret resolver
mock_resolver = Mock(return_value="resolved-secret-value")
# Create a SecretProvider with the mock resolver
secret_provider = SecretProvider(secret_resolver=mock_resolver)
# Setup key vault identifier mock
with patch("azure.keyvault.secrets.KeyVaultSecretIdentifier") as mock_kv_id:
mock_id_instance = Mock()
mock_id_instance._resource_id = TEST_SECRET_ID_VERSION
mock_id_instance.source_id = TEST_SECRET_ID_VERSION
mock_id_instance.name = "my_secret"
mock_id_instance.version = "12345"
mock_id_instance.vault_url = "https://myvault.vault.azure.net"
mock_kv_id.return_value = mock_id_instance
# Call resolve_keyvault_reference
with patch.object(secret_provider, "resolve_keyvault_reference_base") as mock_base:
vault_url = "https://myvault.vault.azure.net/"
mock_base.return_value = (mock_id_instance, vault_url)
result = secret_provider.resolve_keyvault_reference(config)
# Verify the result
self.assertEqual(result, "resolved-secret-value")
mock_resolver.assert_called_once_with(TEST_SECRET_ID_VERSION)
# Verify the secret was cached
_, _, value = secret_provider._secret_cache[TEST_SECRET_ID_VERSION]
self.assertEqual(value, "resolved-secret-value")
def test_resolve_keyvault_reference_with_client_and_resolver_fallback(self):
"""Test falling back to a secret resolver if the client fails to get the secret."""
# Create a mock Key Vault reference
config = SecretReferenceConfigurationSetting(key="test-key", secret_id=TEST_SECRET_ID_VERSION)
# Create a mock credential and secret resolver
mock_credential = Mock()
mock_resolver = Mock(return_value="fallback-secret-value")
# Create a SecretProvider with both credential and resolver
secret_provider = SecretProvider(keyvault_credential=mock_credential, secret_resolver=mock_resolver)
# Create a mock SecretClient that returns None for get_secret
mock_client = Mock()
mock_client.get_secret.return_value.value = None
# Add the mock client to the secret_clients dictionary
vault_url = "https://myvault.vault.azure.net/"
secret_provider._secret_clients[vault_url] = mock_client
# Setup key vault identifier mock
with patch("azure.keyvault.secrets.KeyVaultSecretIdentifier") as mock_kv_id:
mock_id_instance = Mock()
mock_id_instance._resource_id = TEST_SECRET_ID_VERSION
mock_id_instance.source_id = TEST_SECRET_ID_VERSION
mock_id_instance.name = "my_secret"
mock_id_instance.version = "12345"
mock_id_instance.vault_url = "https://myvault.vault.azure.net"
mock_kv_id.return_value = mock_id_instance
# Call resolve_keyvault_reference
with patch.object(secret_provider, "resolve_keyvault_reference_base") as mock_base:
mock_base.return_value = (mock_id_instance, vault_url)
result = secret_provider.resolve_keyvault_reference(config)
# Verify the result
self.assertEqual(result, "fallback-secret-value")
mock_client.get_secret.assert_called_once_with(mock_id_instance.name, version=mock_id_instance.version)
mock_resolver.assert_called_once_with(TEST_SECRET_ID_VERSION)
# Verify the secret was cached
_, _, value = secret_provider._secret_cache[TEST_SECRET_ID_VERSION]
self.assertEqual(value, "fallback-secret-value")
def test_resolve_keyvault_reference_no_client_no_resolver(self):
"""Test that an error is raised when no client or resolver can resolve the reference."""
# Create a mock Key Vault reference
config = SecretReferenceConfigurationSetting(key="test-key", secret_id=TEST_SECRET_ID_VERSION)
# Create a SecretProvider with a credential but no clients or resolvers
mock_credential = Mock()
secret_provider = SecretProvider(keyvault_credential=mock_credential)
# Setup key vault identifier mock
with patch("azure.keyvault.secrets.KeyVaultSecretIdentifier") as mock_kv_id:
mock_id_instance = Mock()
mock_id_instance._resource_id = TEST_SECRET_ID_VERSION
mock_id_instance.source_id = TEST_SECRET_ID_VERSION
mock_id_instance.name = "my_secret"
mock_id_instance.version = "12345"
mock_id_instance.vault_url = "https://myvault.vault.azure.net"
mock_kv_id.return_value = mock_id_instance
# Call resolve_keyvault_reference
with patch.object(secret_provider, "resolve_keyvault_reference_base") as mock_base:
mock_base.return_value = (mock_id_instance, "https://othervault.vault.azure.net/")
# This should raise an error since we have no client for this vault URL
with self.assertRaises(ValueError):
secret_provider.resolve_keyvault_reference(config)
def test_close(self):
"""Test closing the SecretProvider."""
# Create a SecretProvider with mock clients
secret_provider = SecretProvider()
# Create mock clients
mock_client1 = Mock()
mock_client2 = Mock()
# Add the mock clients to the secret_clients dictionary
secret_provider._secret_clients = {
"https://vault1.vault.azure.net/": mock_client1,
"https://vault2.vault.azure.net/": mock_client2,
}
# Call close
secret_provider.close()
# Verify both clients were closed
mock_client1.close.assert_called_once()
mock_client2.close.assert_called_once()
def test_client_config_specific_credential(self):
"""Test that client configuration can specify a specific credential."""
# Create a mock Key Vault reference
config = SecretReferenceConfigurationSetting(key="test-key", secret_id=TEST_SECRET_ID_VERSION)
# Create mock credentials
mock_default_credential = Mock(name="default_credential")
mock_specific_credential = Mock(name="specific_credential")
# Create client configs with a specific credential
client_configs = {
"https://myvault.vault.azure.net/": {"credential": mock_specific_credential, "retry_total": 3}
}
# Create a SecretProvider with default credential and client configs
secret_provider = SecretProvider(
keyvault_credential=mock_default_credential, keyvault_client_configs=client_configs
)
# Setup key vault identifier mock
with patch("azure.keyvault.secrets.KeyVaultSecretIdentifier") as mock_kv_id:
mock_id_instance = Mock()
mock_id_instance._resource_id = TEST_SECRET_ID_VERSION
mock_id_instance.source_id = TEST_SECRET_ID_VERSION
mock_id_instance.name = "my_secret"
mock_id_instance.version = "12345"
mock_id_instance.vault_url = "https://myvault.vault.azure.net"
mock_kv_id.return_value = mock_id_instance
# Mock SecretClient creation and get_secret method
with patch("azure.appconfiguration.provider._key_vault._secret_provider.SecretClient") as mock_client_class:
mock_client = Mock()
mock_secret = Mock()
mock_secret.value = "secret-value"
mock_client.get_secret.return_value = mock_secret
mock_client_class.return_value = mock_client
# Call resolve_keyvault_reference
with patch.object(secret_provider, "resolve_keyvault_reference_base") as mock_base:
vault_url = "https://myvault.vault.azure.net/"
mock_base.return_value = (mock_id_instance, vault_url)
result = secret_provider.resolve_keyvault_reference(config)
# Verify the specific credential was used instead of the default
mock_client_class.assert_called_once_with(
vault_url=vault_url, credential=mock_specific_credential, retry_total=3
)
# Verify the result
self.assertEqual(result, "secret-value")
@recorded_by_proxy
@app_config_decorator_aad
def test_integration_with_keyvault(self, appconfiguration_endpoint_string, appconfiguration_keyvault_secret_url):
"""Test integration with Key Vault."""
if not appconfiguration_keyvault_secret_url:
self.skipTest("No Key Vault secret URL provided")
# Get a credential
credential = self.get_credential(SecretClient)
# Create a SecretProvider with the credential
secret_provider = SecretProvider(keyvault_credential=credential)
# Create a Key Vault reference
config = SecretReferenceConfigurationSetting(key="test-key", secret_id=appconfiguration_keyvault_secret_url)
# Resolve the reference
secret_value = secret_provider.resolve_keyvault_reference(config)
# Verify a value was returned (we can't know the exact value)
self.assertIsNotNone(secret_value)
self.assertTrue(isinstance(secret_value, str))
# Verify the secret was cached
self.assertIn(appconfiguration_keyvault_secret_url, secret_provider._secret_cache)
if __name__ == "__main__":
unittest.main()
|
