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
|
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
import asyncio
import functools
import json
import logging
from unittest.mock import Mock, patch
import pytest
from azure.core.exceptions import ResourceExistsError, ResourceNotFoundError
from azure.core.pipeline.policies import SansIOHTTPPolicy
from azure.keyvault.secrets.aio import SecretClient
from azure.keyvault.secrets._shared.client_base import DEFAULT_VERSION
from dateutil import parser as date_parse
from devtools_testutils import AzureRecordedTestCase, set_custom_default_matcher
from devtools_testutils.aio import recorded_by_proxy_async
from _async_test_case import AsyncSecretsClientPreparer
from _shared.test_case_async import KeyVaultTestCase
from _test_case import get_decorator
all_api_versions = get_decorator()
only_latest = get_decorator(api_versions=[DEFAULT_VERSION])
list_test_size = 7
# used for logging tests
class MockHandler(logging.Handler):
def __init__(self):
super(MockHandler, self).__init__()
self.messages = []
def emit(self, record):
self.messages.append(record)
class TestKeyVaultSecret(KeyVaultTestCase):
def _assert_secret_attributes_equal(self, s1, s2):
assert s1.name == s2.name
assert s1.vault_url == s2.vault_url
assert s1.content_type == s2.content_type
assert s1.enabled == s2.enabled
assert s1.not_before == s2.not_before
assert s1.expires_on == s2.expires_on
assert s1.created_on == s2.created_on
assert s1.updated_on == s2.updated_on
assert s1.recovery_level == s2.recovery_level
assert s1.key_id == s2.key_id
def _validate_secret_bundle(self, secret_attributes, vault, secret_name, secret_value):
prefix = "/".join(s.strip("/") for s in [vault, "secrets", secret_name])
id = secret_attributes.id
assert id.index(prefix) == 0, f"Id should start with '{prefix}', but value is '{id}'"
assert (
secret_attributes.value == secret_value
), f"value should be '{secret_value}', but is '{secret_attributes.value}'"
assert (
secret_attributes.properties.created_on and secret_attributes.properties.updated_on
), "Missing required date attributes."
async def _validate_secret_list(self, secrets, expected):
async for secret in secrets:
if secret.name in expected.keys():
expected_secret = expected[secret.name]
self._assert_secret_attributes_equal(expected_secret.properties, secret)
del expected[secret.name]
assert len(expected) == 0
@AzureRecordedTestCase.await_prepared_test
@pytest.mark.parametrize("api_version", all_api_versions, ids=all_api_versions)
@AsyncSecretsClientPreparer()
@recorded_by_proxy_async
async def test_secret_crud_operations(self, client, **kwargs):
secret_name = self.get_resource_name("crud-secret")
secret_value = "crud_secret_value"
async with client:
# create secret
created = await client.set_secret(secret_name, secret_value)
self._validate_secret_bundle(created, client.vault_url, secret_name, secret_value)
# set secret with optional arguments
not_before = date_parse.parse("2015-02-02T08:00:00.000Z")
enabled = True
tags = {"foo": "created tag"}
created = await client.set_secret(
secret_name, secret_value, enabled=enabled, not_before=not_before, tags=tags
)
self._validate_secret_bundle(created, client.vault_url, secret_name, secret_value)
assert enabled == created.properties.enabled
assert not_before == created.properties.not_before
assert tags == created.properties.tags
# get secret without version
retrieved_secret = await client.get_secret(created.name, "")
assert created.id == retrieved_secret.id
self._assert_secret_attributes_equal(created.properties, retrieved_secret.properties)
# get secret with version
secret_with_version = await client.get_secret(created.name, created.properties.version)
assert created.id == retrieved_secret.id
self._assert_secret_attributes_equal(created.properties, secret_with_version.properties)
async def _update_secret(secret):
content_type = "text/plain"
expires = date_parse.parse("2050-02-02T08:00:00.000Z")
tags = {"foo": "updated tag"}
enabled = not secret.properties.enabled
updated_secret = await client.update_secret_properties(
secret.name,
version=secret.properties.version,
content_type=content_type,
expires_on=expires,
tags=tags,
enabled=enabled,
)
assert tags == updated_secret.tags
assert secret.id == updated_secret.id
assert content_type == updated_secret.content_type
assert expires == updated_secret.expires_on
assert secret.properties.enabled != updated_secret.enabled
assert secret.properties.updated_on != updated_secret.updated_on
return updated_secret
# update secret with version
if self.is_live:
# wait a second to ensure the secret's update time won't equal its creation time
await asyncio.sleep(1)
updated = await _update_secret(created)
# delete secret
deleted = await client.delete_secret(updated.name)
assert deleted is not None
@AzureRecordedTestCase.await_prepared_test
@pytest.mark.parametrize("api_version", all_api_versions, ids=all_api_versions)
@AsyncSecretsClientPreparer()
@recorded_by_proxy_async
async def test_secret_list(self, client, **kwargs):
set_custom_default_matcher(ignore_query_ordering=True)
max_secrets = list_test_size
expected = {}
# create many secrets
for x in range(0, max_secrets):
secret_name = self.get_resource_name(f"sec{x}")
secret_value = f"secVal{x}"
secret = None
while not secret:
secret = await client.set_secret(secret_name, secret_value)
expected[secret_name] = secret
# list secrets
result = client.list_properties_of_secrets(max_page_size=max_secrets - 1)
await self._validate_secret_list(result, expected)
@AzureRecordedTestCase.await_prepared_test
@pytest.mark.parametrize("api_version", all_api_versions, ids=all_api_versions)
@AsyncSecretsClientPreparer()
@recorded_by_proxy_async
async def test_list_deleted_secrets(self, client, **kwargs):
expected = {}
async with client:
# create secrets
for i in range(list_test_size):
secret_name = self.get_resource_name(f"secret{i}")
secret_value = f"value{i}"
expected[secret_name] = await client.set_secret(secret_name, secret_value)
# delete them
for secret_name in expected.keys():
await client.delete_secret(secret_name)
# validate list deleted secrets with attributes
async for deleted_secret in client.list_deleted_secrets():
assert deleted_secret.deleted_date is not None
assert deleted_secret.scheduled_purge_date is not None
assert deleted_secret.recovery_id is not None
if deleted_secret.name in expected:
expected_secret = expected[deleted_secret.name]
self._assert_secret_attributes_equal(expected_secret.properties, deleted_secret.properties)
@AzureRecordedTestCase.await_prepared_test
@pytest.mark.parametrize("api_version", all_api_versions, ids=all_api_versions)
@AsyncSecretsClientPreparer()
@recorded_by_proxy_async
async def test_list_versions(self, client, **kwargs):
set_custom_default_matcher(ignore_query_ordering=True)
secret_name = self.get_resource_name("sec")
secret_value = "secVal"
max_secrets = list_test_size
expected = {}
async with client:
# create many secret versions
for _ in range(0, max_secrets):
secret = None
while not secret:
secret = await client.set_secret(secret_name, secret_value)
expected[secret.id] = secret
# list secret versions
result = client.list_properties_of_secret_versions(secret_name, max_page_size=max_secrets - 1)
# validate list secret versions with attributes
async for secret in result:
if secret.id in expected.keys():
expected_secret = expected[secret.id]
del expected[secret.id]
self._assert_secret_attributes_equal(expected_secret.properties, secret)
assert len(expected) == 0
@AzureRecordedTestCase.await_prepared_test
@pytest.mark.parametrize("api_version", all_api_versions, ids=all_api_versions)
@AsyncSecretsClientPreparer()
@recorded_by_proxy_async
async def test_backup_restore(self, client, **kwargs):
secret_name = self.get_resource_name("secbak")
secret_value = "secVal"
async with client:
# create secret
created_bundle = await client.set_secret(secret_name, secret_value)
# backup secret
secret_backup = await client.backup_secret(created_bundle.name)
assert secret_backup is not None, "secret_backup"
# delete secret
await client.delete_secret(created_bundle.name)
# purge secret
await client.purge_deleted_secret(created_bundle.name)
# restore secret
restore_function = functools.partial(client.restore_secret_backup, secret_backup)
restored_secret = await self._poll_until_no_exception(
restore_function, expected_exception=ResourceExistsError
)
self._assert_secret_attributes_equal(created_bundle.properties, restored_secret)
@AzureRecordedTestCase.await_prepared_test
@pytest.mark.parametrize("api_version", all_api_versions, ids=all_api_versions)
@AsyncSecretsClientPreparer()
@recorded_by_proxy_async
async def test_recover(self, client, **kwargs):
secrets = {}
async with client:
# create secrets to recover
for i in range(list_test_size):
secret_name = self.get_resource_name(f"secret{i}")
secret_value = f"value{i}"
secrets[secret_name] = await client.set_secret(secret_name, secret_value)
# delete all secrets
for secret_name in secrets.keys():
await client.delete_secret(secret_name)
# validate all our deleted secrets are returned by list_deleted_secrets
async for deleted_secret in client.list_deleted_secrets():
if deleted_secret.name in secrets:
secrets.pop(deleted_secret.name)
assert len(secrets.keys()) == 0
# recover select secrets
for secret_name in secrets.keys():
await client.recover_deleted_secret(secret_name)
# validate the recovered secrets exist
for secret in secrets.keys():
get_function = functools.partial(client.get_secret, secret)
await self._poll_until_no_exception(get_function, expected_exception=ResourceNotFoundError)
@AzureRecordedTestCase.await_prepared_test
@pytest.mark.parametrize("api_version", all_api_versions, ids=all_api_versions)
@AsyncSecretsClientPreparer()
@recorded_by_proxy_async
async def test_purge(self, client, **kwargs):
secrets = {}
async with client:
# create secrets to purge
for i in range(list_test_size):
secret_name = self.get_resource_name(f"secret{i}")
secret_value = f"value{i}"
secrets[secret_name] = await client.set_secret(secret_name, secret_value)
# delete all secrets
for secret_name in secrets.keys():
await client.delete_secret(secret_name)
# validate all our deleted secrets are returned by list_deleted_secrets
async for deleted_secret in client.list_deleted_secrets():
if deleted_secret.name in secrets:
secrets.pop(deleted_secret.name)
assert len(secrets.keys()) == 0
# purge secrets
for secret_name in secrets.keys():
await client.purge_deleted_secret(secret_name)
@AzureRecordedTestCase.await_prepared_test
@pytest.mark.parametrize("api_version", all_api_versions, ids=all_api_versions)
@AsyncSecretsClientPreparer(logging_enable=True)
@recorded_by_proxy_async
async def test_logging_enabled(self, client, **kwargs):
mock_handler = MockHandler()
logger = logging.getLogger("azure")
logger.addHandler(mock_handler)
logger.setLevel(logging.DEBUG)
secret_name = self.get_resource_name("secret-name")
async with client:
await client.set_secret(secret_name, "secret-value")
for message in mock_handler.messages:
if message.levelname == "DEBUG" and message.funcName == "on_request":
# parts of the request are logged on new lines in a single message
if "'/n" in message.message:
request_sections = message.message.split("/n")
else:
request_sections = message.message.split("\n")
for section in request_sections:
try:
# the body of the request should be JSON
body = json.loads(section)
if body["value"] == "secret-value":
mock_handler.close()
return dict()
except (ValueError, KeyError):
# this means the request section is not JSON
pass
mock_handler.close()
assert False, "Expected request body wasn't logged"
@AzureRecordedTestCase.await_prepared_test
@pytest.mark.parametrize("api_version", all_api_versions, ids=all_api_versions)
@AsyncSecretsClientPreparer(logging_enable=False)
@recorded_by_proxy_async
async def test_logging_disabled(self, client, **kwargs):
mock_handler = MockHandler()
logger = logging.getLogger("azure")
logger.addHandler(mock_handler)
logger.setLevel(logging.DEBUG)
secret_name = self.get_resource_name("secret-name")
async with client:
await client.set_secret(secret_name, "secret-value")
for message in mock_handler.messages:
if message.levelname == "DEBUG" and message.funcName == "on_request":
# parts of the request are logged on new lines in a single message
if "'/n" in message.message:
request_sections = message.message.split("/n")
else:
request_sections = message.message.split("\n")
for section in request_sections:
try:
# the body of the request should be JSON
body = json.loads(section)
if body["value"] == "secret-value":
mock_handler.close()
assert False, "Client request body was logged"
except (ValueError, KeyError):
# this means the message is not JSON or has no kty property
pass
mock_handler.close()
@AzureRecordedTestCase.await_prepared_test
@pytest.mark.parametrize("api_version", only_latest)
@AsyncSecretsClientPreparer()
@recorded_by_proxy_async
async def test_40x_handling(self, client, **kwargs):
"""Ensure 404 and 409 responses are raised with azure-core exceptions instead of generated KV ones"""
# Test that 404 is raised correctly by fetching a nonexistent secret
with pytest.raises(ResourceNotFoundError):
await client.get_secret("secret-that-does-not-exist")
# Test that 409 is raised correctly (`set_secret` shouldn't actually trigger this, but for raising behavior)
async def run(*_, **__):
return Mock(http_response=Mock(status_code=409))
with patch.object(client._client._client._pipeline, "run", run):
with pytest.raises(ResourceExistsError):
await client.set_secret("...", "...")
await client.close()
def test_service_headers_allowed_in_logs():
service_headers = {"x-ms-keyvault-network-info", "x-ms-keyvault-region", "x-ms-keyvault-service-version"}
client = SecretClient("...", object())
assert service_headers.issubset(client._client._config.http_logging_policy.allowed_header_names)
def test_custom_hook_policy():
class CustomHookPolicy(SansIOHTTPPolicy):
pass
client = SecretClient("...", object(), custom_hook_policy=CustomHookPolicy())
assert isinstance(client._client._config.custom_hook_policy, CustomHookPolicy)
|