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 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import pytest
import sys
from azure.core.credentials import AzureNamedKeyCredential
from azure.core.exceptions import ClientAuthenticationError, HttpResponseError
from azure.storage.filedatalake import (
AnalyticsLogging,
CorsRule,
Metrics,
RetentionPolicy,
StaticWebsite)
from azure.storage.filedatalake.aio import (
DataLakeDirectoryClient,
DataLakeFileClient,
DataLakeServiceClient,
FileSystemClient)
from devtools_testutils.aio import recorded_by_proxy_async
from devtools_testutils.storage.aio import AsyncStorageRecordedTestCase
from settings.testcase import DataLakePreparer
if sys.version_info >= (3, 8):
from unittest.mock import AsyncMock
# ------------------------------------------------------------------------------
TEST_FILE_SYSTEM_PREFIX = 'filesystem'
# ------------------------------------------------------------------------------
class TestDatalakeServiceAsync(AsyncStorageRecordedTestCase):
def _setup(self, account_name, account_key):
url = self.account_url(account_name, 'dfs')
self.dsc = DataLakeServiceClient(url, credential=account_key, logging_enable=True)
self.config = self.dsc._config
# --Helpers-----------------------------------------------------------------
def _assert_properties_default(self, prop):
assert prop is not None
self._assert_logging_equal(prop['analytics_logging'], AnalyticsLogging())
self._assert_metrics_equal(prop['hour_metrics'], Metrics())
self._assert_metrics_equal(prop['minute_metrics'], Metrics())
self._assert_cors_equal(prop['cors'], [])
def _assert_logging_equal(self, log1, log2):
if log1 is None or log2 is None:
assert log1 == log2
return
assert log1.version == log2.version
assert log1.read == log2.read
assert log1.write == log2.write
assert log1.delete == log2.delete
self._assert_retention_equal(log1.retention_policy, log2.retention_policy)
def _assert_delete_retention_policy_equal(self, policy1, policy2):
if policy1 is None or policy2 is None:
assert policy1 == policy2
return
assert policy1.enabled == policy2.enabled
assert policy1.days == policy2.days
def _assert_static_website_equal(self, prop1, prop2):
if prop1 is None or prop2 is None:
assert prop1 == prop2
return
assert prop1.enabled == prop2.enabled
assert prop1.index_document == prop2.index_document
assert prop1.error_document404_path == prop2.error_document404_path
assert prop1.default_index_document_path == prop2.default_index_document_path
def _assert_delete_retention_policy_not_equal(self, policy1, policy2):
if policy1 is None or policy2 is None:
assert policy1 != policy2
return
assert not (policy1.enabled == policy2.enabled and policy1.days == policy2.days)
def _assert_metrics_equal(self, metrics1, metrics2):
if metrics1 is None or metrics2 is None:
assert metrics1 == metrics2
return
assert metrics1.version == metrics2.version
assert metrics1.enabled == metrics2.enabled
assert metrics1.include_apis == metrics2.include_apis
self._assert_retention_equal(metrics1.retention_policy, metrics2.retention_policy)
def _assert_cors_equal(self, cors1, cors2):
if cors1 is None or cors2 is None:
assert cors1 == cors2
return
assert len(cors1) == len(cors2)
for i in range(0, len(cors1)):
rule1 = cors1[i]
rule2 = cors2[i]
assert len(rule1.allowed_origins) == len(rule2.allowed_origins)
assert len(rule1.allowed_methods) == len(rule2.allowed_methods)
assert rule1.max_age_in_seconds == rule2.max_age_in_seconds
assert len(rule1.exposed_headers) == len(rule2.exposed_headers)
assert len(rule1.allowed_headers) == len(rule2.allowed_headers)
def _assert_retention_equal(self, ret1, ret2):
assert ret1.enabled == ret2.enabled
assert ret1.days == ret2.days
# --Test cases per service ---------------------------------------
@DataLakePreparer()
@recorded_by_proxy_async
async def test_datalake_service_properties(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
self._setup(datalake_storage_account_name, datalake_storage_account_key)
# Act
await self.dsc.set_service_properties(
analytics_logging=AnalyticsLogging(),
hour_metrics=Metrics(),
minute_metrics=Metrics(),
cors=[],
target_version='2014-02-14'
)
# Assert
props = await self.dsc.get_service_properties()
self._assert_properties_default(props)
assert '2014-02-14' == props['target_version']
@DataLakePreparer()
@recorded_by_proxy_async
async def test_empty_set_service_properties_exception(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
self._setup(datalake_storage_account_name, datalake_storage_account_key)
with pytest.raises(ValueError):
await self.dsc.set_service_properties()
@DataLakePreparer()
@recorded_by_proxy_async
async def test_set_default_service_version(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
self._setup(datalake_storage_account_name, datalake_storage_account_key)
# Act
await self.dsc.set_service_properties(target_version='2014-02-14')
# Assert
received_props = await self.dsc.get_service_properties()
assert received_props['target_version'] == '2014-02-14'
@DataLakePreparer()
@recorded_by_proxy_async
async def test_set_delete_retention_policy(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
self._setup(datalake_storage_account_name, datalake_storage_account_key)
delete_retention_policy = RetentionPolicy(enabled=True, days=2)
# Act
await self.dsc.set_service_properties(delete_retention_policy=delete_retention_policy)
# Assert
received_props = await self.dsc.get_service_properties()
self._assert_delete_retention_policy_equal(received_props['delete_retention_policy'], delete_retention_policy)
@DataLakePreparer()
@recorded_by_proxy_async
async def test_set_delete_retention_policy_edge_cases(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
self._setup(datalake_storage_account_name, datalake_storage_account_key)
delete_retention_policy = RetentionPolicy(enabled=True, days=1)
await self.dsc.set_service_properties(delete_retention_policy=delete_retention_policy)
# Assert
received_props = await self.dsc.get_service_properties()
self._assert_delete_retention_policy_equal(received_props['delete_retention_policy'], delete_retention_policy)
# Should work with maximum settings
delete_retention_policy = RetentionPolicy(enabled=True, days=365)
await self.dsc.set_service_properties(delete_retention_policy=delete_retention_policy)
# Assert
received_props = await self.dsc.get_service_properties()
self._assert_delete_retention_policy_equal(received_props['delete_retention_policy'], delete_retention_policy)
# Should not work with 0 days
delete_retention_policy = RetentionPolicy(enabled=True, days=0)
with pytest.raises(HttpResponseError):
await self.dsc.set_service_properties(delete_retention_policy=delete_retention_policy)
# Assert
received_props = await self.dsc.get_service_properties()
self._assert_delete_retention_policy_not_equal(received_props['delete_retention_policy'], delete_retention_policy)
# Should not work with 366 days
delete_retention_policy = RetentionPolicy(enabled=True, days=366)
with pytest.raises(HttpResponseError):
await self.dsc.set_service_properties(delete_retention_policy=delete_retention_policy)
# Assert
received_props = await self.dsc.get_service_properties()
self._assert_delete_retention_policy_not_equal(received_props['delete_retention_policy'], delete_retention_policy)
@DataLakePreparer()
@recorded_by_proxy_async
async def test_set_static_website_properties(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
self._setup(datalake_storage_account_name, datalake_storage_account_key)
static_website = StaticWebsite(
enabled=True,
index_document="index.html",
error_document404_path="errors/error/404error.html")
# Act
await self.dsc.set_service_properties(static_website=static_website)
# Assert
received_props = await self.dsc.get_service_properties()
self._assert_static_website_equal(received_props['static_website'], static_website)
@DataLakePreparer()
@recorded_by_proxy_async
async def test_disabled_static_website_properties(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
self._setup(datalake_storage_account_name, datalake_storage_account_key)
static_website = StaticWebsite(enabled=False, index_document="index.html",
error_document404_path="errors/error/404error.html")
# Act
await self.dsc.set_service_properties(static_website=static_website)
# Assert
received_props = await self.dsc.get_service_properties()
self._assert_static_website_equal(received_props['static_website'], StaticWebsite(enabled=False))
@DataLakePreparer()
@recorded_by_proxy_async
async def test_set_static_website_props_dont_impact_other_props(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
self._setup(datalake_storage_account_name, datalake_storage_account_key)
cors_rule1 = CorsRule(['www.xyz.com'], ['GET'])
allowed_origins = ['www.xyz.com', "www.ab.com", "www.bc.com"]
allowed_methods = ['GET', 'PUT']
max_age_in_seconds = 500
exposed_headers = ["x-ms-meta-data*", "x-ms-meta-source*", "x-ms-meta-abc", "x-ms-meta-bcd"]
allowed_headers = ["x-ms-meta-data*", "x-ms-meta-target*", "x-ms-meta-xyz", "x-ms-meta-foo"]
cors_rule2 = CorsRule(
allowed_origins,
allowed_methods,
max_age_in_seconds=max_age_in_seconds,
exposed_headers=exposed_headers,
allowed_headers=allowed_headers)
cors = [cors_rule1, cors_rule2]
# Act to set cors
await self.dsc.set_service_properties(cors=cors)
# Assert cors is updated
received_props = await self.dsc.get_service_properties()
self._assert_cors_equal(received_props['cors'], cors)
# Arrange to set static website properties
static_website = StaticWebsite(enabled=True, index_document="index.html",
error_document404_path="errors/error/404error.html")
# Act to set static website
await self.dsc.set_service_properties(static_website=static_website)
# Assert static website was updated was cors was unchanged
received_props = await self.dsc.get_service_properties()
self._assert_static_website_equal(received_props['static_website'], static_website)
self._assert_cors_equal(received_props['cors'], cors)
@DataLakePreparer()
@recorded_by_proxy_async
async def test_set_logging(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
self._setup(datalake_storage_account_name, datalake_storage_account_key)
logging = AnalyticsLogging(read=True, write=True, delete=True, retention_policy=RetentionPolicy(enabled=True, days=5))
# Act
await self.dsc.set_service_properties(analytics_logging=logging)
# Assert
received_props = await self.dsc.get_service_properties()
self._assert_logging_equal(received_props['analytics_logging'], logging)
@DataLakePreparer()
@recorded_by_proxy_async
async def test_set_hour_metrics(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
self._setup(datalake_storage_account_name, datalake_storage_account_key)
hour_metrics = Metrics(
include_apis=False, enabled=True, retention_policy=RetentionPolicy(enabled=True, days=5))
# Act
await self.dsc.set_service_properties(hour_metrics=hour_metrics)
# Assert
received_props = await self.dsc.get_service_properties()
self._assert_metrics_equal(received_props['hour_metrics'], hour_metrics)
@DataLakePreparer()
@recorded_by_proxy_async
async def test_set_minute_metrics(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
self._setup(datalake_storage_account_name, datalake_storage_account_key)
minute_metrics = Metrics(
enabled=True, include_apis=True, retention_policy=RetentionPolicy(enabled=True, days=5))
# Act
await self.dsc.set_service_properties(minute_metrics=minute_metrics)
# Assert
received_props = await self.dsc.get_service_properties()
self._assert_metrics_equal(received_props['minute_metrics'], minute_metrics)
@DataLakePreparer()
@recorded_by_proxy_async
async def test_set_cors(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
self._setup(datalake_storage_account_name, datalake_storage_account_key)
cors_rule1 = CorsRule(['www.xyz.com'], ['GET'])
allowed_origins = ['www.xyz.com', "www.ab.com", "www.bc.com"]
allowed_methods = ['GET', 'PUT']
max_age_in_seconds = 500
exposed_headers = ["x-ms-meta-data*", "x-ms-meta-source*", "x-ms-meta-abc", "x-ms-meta-bcd"]
allowed_headers = ["x-ms-meta-data*", "x-ms-meta-target*", "x-ms-meta-xyz", "x-ms-meta-foo"]
cors_rule2 = CorsRule(
allowed_origins,
allowed_methods,
max_age_in_seconds=max_age_in_seconds,
exposed_headers=exposed_headers,
allowed_headers=allowed_headers)
cors = [cors_rule1, cors_rule2]
# Act
await self.dsc.set_service_properties(cors=cors)
# Assert
received_props = await self.dsc.get_service_properties()
self._assert_cors_equal(received_props['cors'], cors)
@DataLakePreparer()
async def test_connectionstring_without_secondary(self):
test_conn_str = "DefaultEndpointsProtocol=https;AccountName=foo;AccountKey=bar"
client = DataLakeServiceClient.from_connection_string(test_conn_str)
assert client.url == 'https://foo.dfs.core.windows.net/'
assert client.primary_hostname == 'foo.dfs.core.windows.net'
assert not client.secondary_hostname
client = FileSystemClient.from_connection_string(test_conn_str, "fsname")
assert client.url == 'https://foo.dfs.core.windows.net/fsname'
assert client.primary_hostname == 'foo.dfs.core.windows.net'
assert not client.secondary_hostname
client = DataLakeFileClient.from_connection_string(test_conn_str, "fsname", "fpath")
assert client.url == 'https://foo.dfs.core.windows.net/fsname/fpath'
assert client.primary_hostname == 'foo.dfs.core.windows.net'
assert not client.secondary_hostname
client = DataLakeDirectoryClient.from_connection_string(test_conn_str, "fsname", "dname")
assert client.url == 'https://foo.dfs.core.windows.net/fsname/dname'
assert client.primary_hostname == 'foo.dfs.core.windows.net'
assert not client.secondary_hostname
@DataLakePreparer()
@recorded_by_proxy_async
async def test_azure_named_key_credential_access(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
named_key = AzureNamedKeyCredential(datalake_storage_account_name, datalake_storage_account_key)
dsc = DataLakeServiceClient(self.account_url(datalake_storage_account_name, "blob"), named_key)
# Act
props = await dsc.get_service_properties()
# Assert
assert props is not None
@pytest.mark.skipif(sys.version_info < (3, 8), reason="AsyncMock not introduced until 3.8")
@DataLakePreparer()
async def test_datalake_clients_properly_close(self, **kwargs):
account_name = "adlsstorage"
account_key = "adlskey"
self._setup(account_name, account_key)
file_system_client = self.dsc.get_file_system_client(file_system='testfs')
dir_client = self.dsc.get_directory_client(file_system='testfs', directory='testdir')
file_client = dir_client.get_file_client(file='testfile')
# Mocks
self.dsc._blob_service_client.close = AsyncMock()
self.dsc._client.__aexit__ = AsyncMock()
file_system_client._client.__aexit__ = AsyncMock()
file_system_client._datalake_client_for_blob_operation.close = AsyncMock()
dir_client._client.__aexit__ = AsyncMock()
dir_client._datalake_client_for_blob_operation.close = AsyncMock()
file_client._client.__aexit__ = AsyncMock()
file_client._datalake_client_for_blob_operation.close = AsyncMock()
# Act
async with self.dsc as dsc:
pass
async with file_system_client as fsc:
pass
async with dir_client as dc:
pass
async with file_client as fc:
pass
# Assert
self.dsc._blob_service_client.close.assert_called_once()
self.dsc._client.__aexit__.assert_called_once()
file_system_client._client.__aexit__.assert_called_once()
file_system_client._datalake_client_for_blob_operation.close.assert_called_once()
dir_client._client.__aexit__.assert_called_once()
dir_client._datalake_client_for_blob_operation.close.assert_called_once()
file_client._client.__aexit__.assert_called_once()
file_client._datalake_client_for_blob_operation.close.assert_called_once()
@DataLakePreparer()
@recorded_by_proxy_async
async def test_storage_account_audience_service_client(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
self._setup(datalake_storage_account_name, datalake_storage_account_key)
file_system_name = self.get_resource_name('filesystem')
await self.dsc.create_file_system(file_system_name)
# Act
token_credential = self.get_credential(DataLakeServiceClient, is_async=True)
dsc = DataLakeServiceClient(
self.account_url(datalake_storage_account_name, "blob"),
credential=token_credential,
audience=f'https://{datalake_storage_account_name}.blob.core.windows.net/'
)
# Assert
response1 = dsc.list_file_systems()
response2 = dsc.create_file_system(file_system_name + '1')
assert response1 is not None
assert response2 is not None
@DataLakePreparer()
@recorded_by_proxy_async
async def test_bad_audience_service_client(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
self._setup(datalake_storage_account_name, datalake_storage_account_key)
file_system_name = self.get_resource_name('filesystem')
await self.dsc.create_file_system(file_system_name)
# Act
token_credential = self.get_credential(DataLakeServiceClient, is_async=True)
dsc = DataLakeServiceClient(
self.account_url(datalake_storage_account_name, "blob"),
credential=token_credential,
audience=f'https://badaudience.blob.core.windows.net/'
)
# Will not raise ClientAuthenticationError despite bad audience due to Bearer Challenge
dsc.list_file_systems()
await dsc.create_file_system(file_system_name + '1')
|