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 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
import asyncio
import jwt
import unittest
import uuid
from datetime import datetime, timedelta
from time import sleep
import pytest
from azure.core import MatchConditions
from azure.core.exceptions import ClientAuthenticationError, HttpResponseError, ResourceNotFoundError
from azure.storage.filedatalake import (
AccessPolicy,
AccountSasPermissions,
DirectorySasPermissions,
EncryptionScopeOptions,
FileSystemSasPermissions,
generate_account_sas,
generate_directory_sas,
generate_file_sas,
generate_file_system_sas,
PublicAccess,
ResourceTypes
)
from azure.storage.filedatalake.aio import DataLakeDirectoryClient, DataLakeFileClient, DataLakeServiceClient, FileSystemClient
from azure.storage.filedatalake._models import FileSasPermissions
from devtools_testutils.aio import recorded_by_proxy_async
from devtools_testutils.storage.aio import AsyncStorageRecordedTestCase
from settings.testcase import DataLakePreparer
# ------------------------------------------------------------------------------
TEST_FILE_SYSTEM_PREFIX = 'filesystem'
# ------------------------------------------------------------------------------
class TestFileSystemAsync(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
self.test_file_systems = []
def tearDown(self):
if not self.is_playback():
loop = asyncio.get_event_loop()
try:
for file_system in self.test_file_systems:
loop.run_until_complete(self.dsc.delete_file_system(file_system))
loop.run_until_complete(self.fsc.__aexit__())
except:
pass
# --Helpers-----------------------------------------------------------------
def _get_file_system_reference(self, prefix=TEST_FILE_SYSTEM_PREFIX):
file_system_name = self.get_resource_name(prefix)
self.test_file_systems.append(file_system_name)
return file_system_name
async def _create_file_system(self, file_system_prefix=TEST_FILE_SYSTEM_PREFIX):
return await self.dsc.create_file_system(self._get_file_system_reference(prefix=file_system_prefix))
async def _to_list(self, async_iterator):
result = []
async for item in async_iterator:
result.append(item)
return result
def _is_almost_equal(self, first, second, delta):
if first == second:
return True
diff = abs(first - second)
if delta is not None:
if diff <= delta:
return True
return False
# --Test cases for file system ---------------------------------------------
@DataLakePreparer()
@recorded_by_proxy_async
async def test_create_file_system(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)
# Arrange
file_system_name = self._get_file_system_reference()
# Act
file_system_client = self.dsc.get_file_system_client(file_system_name)
created = await file_system_client.create_file_system()
# Assert
assert created
@DataLakePreparer()
@recorded_by_proxy_async
async def test_create_file_system_async_extra_backslash(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)
# Arrange
file_system_name = self._get_file_system_reference()
# Act
file_system_client = self.dsc.get_file_system_client(file_system_name + '/')
created = await file_system_client.create_file_system()
# Assert
assert created
@DataLakePreparer()
@recorded_by_proxy_async
async def test_create_file_system_encryption_scope(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)
# Arrange
file_system_name = self._get_file_system_reference()
encryption_scope = EncryptionScopeOptions(default_encryption_scope="hnstestscope1")
# Act
file_system_client = self.dsc.get_file_system_client(file_system_name)
await file_system_client.create_file_system(encryption_scope_options=encryption_scope)
props = await file_system_client.get_file_system_properties()
# Assert
assert props
assert props['encryption_scope'] is not None
assert props['encryption_scope'].default_encryption_scope == encryption_scope.default_encryption_scope
@DataLakePreparer()
@recorded_by_proxy_async
async def test_create_file_system_encryption_scope_account_sas(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)
# Arrange
url = self.account_url(datalake_storage_account_name, 'dfs')
token = self.generate_sas(
generate_account_sas,
self.dsc.account_name,
self.dsc.credential.account_key,
ResourceTypes(service=True, file_system=True, object=True),
permission=AccountSasPermissions(write=True, read=True, create=True, delete=True),
expiry=datetime.utcnow() + timedelta(hours=5),
encryption_scope="hnstestscope1")
file_system_name = self._get_file_system_reference()
encryption_scope = EncryptionScopeOptions(default_encryption_scope="hnstestscope1")
# Act
file_system_client = self.dsc.get_file_system_client(file_system_name)
await file_system_client.create_file_system(encryption_scope_options=encryption_scope)
fsc_sas = FileSystemClient(url, file_system_name, token)
await fsc_sas.create_file('file1')
await fsc_sas.create_directory('dir1')
dir_props = await fsc_sas.get_directory_client('dir1').get_directory_properties()
file_props = await fsc_sas.get_file_client('file1').get_file_properties()
# Assert
assert dir_props
assert dir_props.encryption_scope is not None
assert dir_props.encryption_scope == encryption_scope.default_encryption_scope
assert file_props
assert file_props.encryption_scope is not None
assert file_props.encryption_scope == encryption_scope.default_encryption_scope
@DataLakePreparer()
@recorded_by_proxy_async
async def test_create_file_system_encryption_scope_file_system_sas(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)
# Arrange
url = self.account_url(datalake_storage_account_name, 'dfs')
file_system_name = self._get_file_system_reference()
token = self.generate_sas(
generate_file_system_sas,
self.dsc.account_name,
file_system_name,
self.dsc.credential.account_key,
permission=FileSystemSasPermissions(write=True, read=True, delete=True),
expiry=datetime.utcnow() + timedelta(hours=5),
encryption_scope="hnstestscope1")
encryption_scope = EncryptionScopeOptions(default_encryption_scope="hnstestscope1")
# Act
file_system_client = self.dsc.get_file_system_client(file_system_name)
await file_system_client.create_file_system(encryption_scope_options=encryption_scope)
fsc_sas = FileSystemClient(url, file_system_name, token)
await fsc_sas.create_file('file1')
await fsc_sas.create_directory('dir1')
dir_props = await fsc_sas.get_directory_client('dir1').get_directory_properties()
file_props = await fsc_sas.get_file_client('file1').get_file_properties()
# Assert
assert dir_props
assert dir_props.encryption_scope is not None
assert dir_props.encryption_scope == encryption_scope.default_encryption_scope
assert file_props
assert file_props.encryption_scope is not None
assert file_props.encryption_scope == encryption_scope.default_encryption_scope
@DataLakePreparer()
@recorded_by_proxy_async
async def test_create_file_system_encryption_scope_directory_sas(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)
# Arrange
url = self.account_url(datalake_storage_account_name, 'dfs')
file_system_name = self._get_file_system_reference()
token = self.generate_sas(
generate_directory_sas,
self.dsc.account_name,
file_system_name,
'dir1',
self.dsc.credential.account_key,
permission=FileSasPermissions(write=True, read=True, delete=True),
expiry=datetime.utcnow() + timedelta(hours=5),
encryption_scope="hnstestscope1")
encryption_scope = EncryptionScopeOptions(default_encryption_scope="hnstestscope1")
# Act
file_system_client = self.dsc.get_file_system_client(file_system_name)
await file_system_client.create_file_system(encryption_scope_options=encryption_scope)
dir_client = DataLakeDirectoryClient(url, file_system_name, 'dir1', credential=token)
await dir_client.create_directory()
dir_props = await dir_client.get_directory_properties()
# Assert
assert dir_props
assert dir_props.encryption_scope is not None
assert dir_props.encryption_scope == encryption_scope.default_encryption_scope
@DataLakePreparer()
@recorded_by_proxy_async
async def test_create_file_system_encryption_scope_file_sas(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)
# Arrange
url = self.account_url(datalake_storage_account_name, 'dfs')
file_system_name = self._get_file_system_reference()
token = self.generate_sas(
generate_file_sas,
self.dsc.account_name,
file_system_name,
'dir1',
'file1',
self.dsc.credential.account_key,
permission=FileSasPermissions(write=True, read=True, delete=True),
expiry=datetime.utcnow() + timedelta(hours=5),
encryption_scope="hnstestscope1")
encryption_scope = EncryptionScopeOptions(default_encryption_scope="hnstestscope1")
# Act
file_system_client = self.dsc.get_file_system_client(file_system_name)
await file_system_client.create_file_system(encryption_scope_options=encryption_scope)
await file_system_client.create_directory('dir1')
file_client = DataLakeFileClient(url, file_system_name, 'dir1/file1', token)
await file_client.create_file()
file_props = await file_client.get_file_properties()
# Assert
assert file_props
assert file_props.encryption_scope is not None
assert file_props.encryption_scope == encryption_scope.default_encryption_scope
@DataLakePreparer()
@recorded_by_proxy_async
async def test_file_system_exists(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)
# Arrange
file_system_name = self._get_file_system_reference()
# Act
file_system_client1 = self.dsc.get_file_system_client(file_system_name)
file_system_client2 = self.dsc.get_file_system_client("nonexistentfs")
await file_system_client1.create_file_system()
assert await file_system_client1.exists()
assert not await file_system_client2.exists()
@DataLakePreparer()
@recorded_by_proxy_async
async def test_create_file_system_with_metadata_async(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)
# Arrange
metadata = {'hello': 'world', 'number': '42'}
file_system_name = self._get_file_system_reference()
# Act
file_system_client = self.dsc.get_file_system_client(file_system_name)
created = await file_system_client.create_file_system(metadata=metadata)
# Assert
properties = await file_system_client.get_file_system_properties()
assert created
assert properties.metadata == metadata
@DataLakePreparer()
@recorded_by_proxy_async
async def test_list_file_systems(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)
# Arrange
file_system_name = self._get_file_system_reference()
file_system = await self.dsc.create_file_system(file_system_name)
# Act
file_systems = []
async for filesystem in self.dsc.list_file_systems():
file_systems.append(filesystem)
# Assert
assert file_systems is not None
assert len(file_systems) >= 1
assert file_systems[0] is not None
self.assertNamedItemInContainer(file_systems, file_system.file_system_name)
assert file_systems[0].has_immutability_policy is not None
assert file_systems[0].has_legal_hold is not None
@DataLakePreparer()
@recorded_by_proxy_async
async def test_list_file_systems_encryption_scope(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)
# Arrange
file_system_name1 = self._get_file_system_reference(prefix='es')
file_system_name2 = self._get_file_system_reference(prefix='es2')
encryption_scope = EncryptionScopeOptions(default_encryption_scope="hnstestscope1")
await self.dsc.create_file_system(file_system_name1, encryption_scope_options=encryption_scope)
await self.dsc.create_file_system(file_system_name2, encryption_scope_options=encryption_scope)
# Act
file_systems = []
async for filesystem in self.dsc.list_file_systems():
if filesystem['name'] in [file_system_name1, file_system_name2]:
file_systems.append(filesystem)
# Assert
assert file_systems is not None
assert len(file_systems) == 2
assert file_systems[0].encryption_scope.default_encryption_scope == encryption_scope.default_encryption_scope
assert file_systems[1].encryption_scope.default_encryption_scope == encryption_scope.default_encryption_scope
@DataLakePreparer()
@recorded_by_proxy_async
async def test_list_file_systems_account_sas(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)
# Arrange
file_system_name = self._get_file_system_reference()
file_system = await self.dsc.create_file_system(file_system_name)
sas_token = self.generate_sas(
generate_account_sas,
datalake_storage_account_name,
datalake_storage_account_key,
ResourceTypes(service=True),
AccountSasPermissions(list=True),
datetime.utcnow() + timedelta(hours=1),
)
# Act
dsc = DataLakeServiceClient(self.account_url(datalake_storage_account_name, 'dfs'), credential=sas_token)
file_systems = []
async for filesystem in dsc.list_file_systems():
file_systems.append(filesystem)
# Assert
assert file_systems is not None
assert len(file_systems) >= 1
assert file_systems[0] is not None
self.assertNamedItemInContainer(file_systems, file_system.file_system_name)
@DataLakePreparer()
@recorded_by_proxy_async
async def test_delete_file_system_with_existing_file_system_async(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)
# Arrange
file_system = await self._create_file_system()
# Act
deleted = await file_system.delete_file_system()
# Assert
assert deleted is None
@pytest.mark.skip(reason="Feature not yet enabled. Make sure to record this test once enabled.")
@DataLakePreparer()
@recorded_by_proxy_async
async def test_rename_file_system(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)
old_name1 = self._get_file_system_reference(prefix="oldcontainer1")
old_name2 = self._get_file_system_reference(prefix="oldcontainer2")
new_name = self._get_file_system_reference(prefix="newcontainer")
filesystem1 = await self.dsc.create_file_system(old_name1)
await self.dsc.create_file_system(old_name2)
new_filesystem = await self.dsc._rename_file_system(name=old_name1, new_name=new_name)
with pytest.raises(HttpResponseError):
await self.dsc._rename_file_system(name=old_name2, new_name=new_name)
with pytest.raises(HttpResponseError):
await filesystem1.get_file_system_properties()
with pytest.raises(HttpResponseError):
await self.dsc._rename_file_system(name="badfilesystem", new_name="filesystem")
props = await new_filesystem.get_file_system_properties()
assert new_name == props.name
@pytest.mark.skip(reason="Feature not yet enabled. Make sure to record this test once enabled.")
@DataLakePreparer()
@recorded_by_proxy_async
async def test_rename_file_system_with_file_system_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)
old_name1 = self._get_file_system_reference(prefix="oldcontainer1")
old_name2 = self._get_file_system_reference(prefix="oldcontainer2")
new_name = self._get_file_system_reference(prefix="newcontainer")
bad_name = self._get_file_system_reference(prefix="badcontainer")
filesystem1 = await self.dsc.create_file_system(old_name1)
file_system2 = await self.dsc.create_file_system(old_name2)
bad_file_system = self.dsc.get_file_system_client(bad_name)
new_filesystem = await filesystem1._rename_file_system(new_name=new_name)
with pytest.raises(HttpResponseError):
await file_system2._rename_file_system(new_name=new_name)
with pytest.raises(HttpResponseError):
await filesystem1.get_file_system_properties()
with pytest.raises(HttpResponseError):
await bad_file_system._rename_file_system(new_name="filesystem")
new_file_system_props = await new_filesystem.get_file_system_properties()
assert new_name == new_file_system_props.name
@pytest.mark.skip(reason="Feature not yet enabled. Make sure to record this test once enabled.")
@DataLakePreparer()
@recorded_by_proxy_async
async def test_rename_file_system_with_source_lease(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)
old_name = self._get_file_system_reference(prefix="old")
new_name = self._get_file_system_reference(prefix="new")
filesystem = await self.dsc.create_file_system(old_name)
filesystem_lease_id = await filesystem.acquire_lease()
with pytest.raises(HttpResponseError):
await self.dsc._rename_file_system(name=old_name, new_name=new_name)
with pytest.raises(HttpResponseError):
await self.dsc._rename_file_system(name=old_name, new_name=new_name, lease="bad_id")
new_filesystem = await self.dsc._rename_file_system(name=old_name, new_name=new_name, lease=filesystem_lease_id)
props = await new_filesystem.get_file_system_properties()
assert new_name == props.name
@DataLakePreparer()
@recorded_by_proxy_async
async def test_undelete_file_system(self, **kwargs):
datalake_storage_account_name = kwargs.pop("storage_data_lake_soft_delete_account_name")
datalake_storage_account_key = kwargs.pop("storage_data_lake_soft_delete_account_key")
self._setUp(datalake_storage_account_name, datalake_storage_account_key)
name = self._get_file_system_reference(prefix="filesystem2")
filesystem_client = await self.dsc.create_file_system(name)
await filesystem_client.delete_file_system()
if self.is_live:
sleep(30)
# to make sure the filesystem deleted
with pytest.raises(ResourceNotFoundError):
await filesystem_client.get_file_system_properties()
filesystem_list = []
async for fs in self.dsc.list_file_systems(include_deleted=True):
filesystem_list.append(fs)
assert len(filesystem_list) >= 1
for filesystem in filesystem_list:
# find the deleted filesystem and restore it
if filesystem.deleted and filesystem.name == filesystem_client.file_system_name:
restored_fs_client = await self.dsc.undelete_file_system(filesystem.name, filesystem.deleted_version)
# to make sure the deleted filesystem is restored
props = await restored_fs_client.get_file_system_properties()
assert props is not None
@DataLakePreparer()
@recorded_by_proxy_async
async def test_restore_file_system_with_sas(self, **kwargs):
datalake_storage_account_name = kwargs.pop("storage_data_lake_soft_delete_account_name")
datalake_storage_account_key = kwargs.pop("storage_data_lake_soft_delete_account_key")
self._setUp(datalake_storage_account_name, datalake_storage_account_key)
token = self.generate_sas(
generate_account_sas,
self.dsc.account_name,
self.dsc.credential.account_key,
ResourceTypes(service=True, file_system=True),
AccountSasPermissions(read=True, write=True, list=True, delete=True),
datetime.utcnow() + timedelta(hours=1),
)
dsc = DataLakeServiceClient(self.dsc.url, token)
name = self._get_file_system_reference(prefix="filesystem2")
filesystem_client = await dsc.create_file_system(name)
await filesystem_client.delete_file_system()
if self.is_live:
sleep(30)
# to make sure the filesystem is deleted
with pytest.raises(ResourceNotFoundError):
await filesystem_client.get_file_system_properties()
filesystem_list = []
async for fs in self.dsc.list_file_systems(include_deleted=True):
filesystem_list.append(fs)
assert len(filesystem_list) >= 1
for filesystem in filesystem_list:
# find the deleted filesystem and restore it
if filesystem.deleted and filesystem.name == filesystem_client.file_system_name:
restored_fs_client = await dsc.undelete_file_system(filesystem.name, filesystem.deleted_version)
# to make sure the deleted filesystem is restored
props = await restored_fs_client.get_file_system_properties()
assert props is not None
@DataLakePreparer()
@recorded_by_proxy_async
async def test_delete_none_existing_file_system_async(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)
fake_file_system_client = self.dsc.get_file_system_client("fakeclient")
# Act
with pytest.raises(ResourceNotFoundError):
await fake_file_system_client.delete_file_system(match_condition=MatchConditions.IfMissing)
@DataLakePreparer()
@recorded_by_proxy_async
async def test_list_file_systems_with_include_metadata_async(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)
# Arrange
file_system = await self._create_file_system()
metadata = {'hello': 'world', 'number': '42'}
await file_system.set_file_system_metadata(metadata)
# Act
file_systems = []
async for fs in self.dsc.list_file_systems(name_starts_with=file_system.file_system_name,
include_metadata=True):
file_systems.append(fs)
# Assert
assert file_systems is not None
assert len(file_systems) >= 1
assert file_systems[0] is not None
self.assertNamedItemInContainer(file_systems, file_system.file_system_name)
assert file_systems[0].metadata == metadata
@pytest.mark.playback_test_only
@DataLakePreparer()
@recorded_by_proxy_async
async def test_set_file_system_acl(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
variables = kwargs.pop('variables', {})
self._setUp(datalake_storage_account_name, datalake_storage_account_key)
# Act
file_system = await self._create_file_system()
expiry_time = self.get_datetime_variable(variables, 'expiry_time', datetime.utcnow() + timedelta(hours=1))
start_time = self.get_datetime_variable(variables, 'start_time', datetime.utcnow())
access_policy = AccessPolicy(permission=FileSystemSasPermissions(read=True),
expiry=expiry_time,
start=start_time)
signed_identifier1 = {'testid': access_policy}
response = await file_system.set_file_system_access_policy(
signed_identifier1, public_access=PublicAccess.FileSystem)
assert response.get('etag') is not None
assert response.get('last_modified') is not None
acl1 = await file_system.get_file_system_access_policy()
assert acl1['public_access'] is not None
assert len(acl1['signed_identifiers']) == 1
# If set signed identifier without specifying the access policy then it will be default to None
signed_identifier2 = {'testid': access_policy, 'test2': access_policy}
await file_system.set_file_system_access_policy(signed_identifier2)
acl2 = await file_system.get_file_system_access_policy()
assert acl2['public_access'] is None
assert len(acl2['signed_identifiers']) == 2
return variables
@DataLakePreparer()
@recorded_by_proxy_async
async def test_list_file_systems_by_page(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)
# Arrange
for i in range(0, 6):
await self._create_file_system(file_system_prefix="filesystem{}".format(i))
# Act
file_systems = []
async for fs in await self.dsc.list_file_systems(
results_per_page=3,
name_starts_with="file",
include_metadata=True).by_page().__anext__():
file_systems.append(fs)
# Assert
assert file_systems is not None
assert len(file_systems) >= 3
@pytest.mark.playback_test_only
@DataLakePreparer()
@recorded_by_proxy_async
async def test_list_file_systems_with_public_access_async(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)
# Arrange
file_system_name = self._get_file_system_reference()
file_system = self.dsc.get_file_system_client(file_system_name)
await file_system.create_file_system(public_access="blob")
metadata = {'hello': 'world', 'number': '42'}
await file_system.set_file_system_metadata(metadata)
# Act
file_systems = []
async for fs in self.dsc.list_file_systems(name_starts_with=file_system.file_system_name,
include_metadata=True):
file_systems.append(fs)
# Assert
assert file_systems is not None
assert len(file_systems) >= 1
assert file_systems[0] is not None
self.assertNamedItemInContainer(file_systems, file_system.file_system_name)
assert file_systems[0].metadata == metadata
assert file_systems[0].public_access is PublicAccess.File
@DataLakePreparer()
@recorded_by_proxy_async
async def test_get_file_system_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)
# Arrange
metadata = {'hello': 'world', 'number': '42'}
file_system = await self._create_file_system()
await file_system.set_file_system_metadata(metadata)
# Act
props = await file_system.get_file_system_properties()
# Assert
assert props is not None
assert props.metadata == metadata
assert props.has_immutability_policy is not None
assert props.has_legal_hold is not None
@DataLakePreparer()
@recorded_by_proxy_async
async def test_service_client_session_closes_after_filesystem_creation(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)
# Arrange
dsc2 = DataLakeServiceClient(self.dsc.url, credential=datalake_storage_account_key)
async with DataLakeServiceClient(
self.dsc.url, credential=datalake_storage_account_key) as ds_client:
fs1 = await ds_client.create_file_system(self._get_file_system_reference(prefix="fs1"))
await fs1.delete_file_system()
await dsc2.create_file_system(self._get_file_system_reference(prefix="fs2"))
await dsc2.close()
@DataLakePreparer()
@recorded_by_proxy_async
async def test_list_paths(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)
# Arrange
file_system = await self._create_file_system()
for i in range(0, 6):
await file_system.create_directory("dir1{}".format(i))
paths = []
async for path in file_system.get_paths(upn=True):
paths.append(path)
assert len(paths) == 6
@DataLakePreparer()
@recorded_by_proxy_async
async def test_list_paths_create_expiry(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
datalake_storage_account_key = kwargs.pop("datalake_storage_account_key")
variables = kwargs.pop('variables', {})
self._setUp(datalake_storage_account_name, datalake_storage_account_key)
# Arrange
file_system = await self._create_file_system()
file_client = await file_system.create_file('file1')
expiry_time = self.get_datetime_variable(variables, 'expiry_time', datetime.utcnow() + timedelta(days=1))
await file_client.set_file_expiry("Absolute", expires_on=expiry_time)
# Act
paths = []
async for path in file_system.get_paths(upn=True):
paths.append(path)
# Assert
assert 1 == len(paths)
props = await file_client.get_file_properties()
# Properties do not include microseconds so let them vary by 1 second
self._is_almost_equal(props.creation_time, paths[0].creation_time, delta=timedelta(seconds=1))
self._is_almost_equal(props.expiry_time, paths[0].expiry_time, delta=timedelta(seconds=1))
return variables
@DataLakePreparer()
@recorded_by_proxy_async
async def test_list_paths_no_expiry(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)
# Arrange
file_system = await self._create_file_system()
await file_system.create_file('file1')
# Act
paths = []
async for path in file_system.get_paths(upn=True):
paths.append(path)
# Assert
assert 1 == len(paths)
assert paths[0].expiry_time is None
@DataLakePreparer()
@recorded_by_proxy_async
async def test_list_paths_which_are_all_files_async(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)
# Arrange
file_system = await self._create_file_system()
for i in range(0, 6):
await file_system.create_file("file{}".format(i))
paths = []
async for path in file_system.get_paths(upn=True):
paths.append(path)
assert len(paths) == 6
@DataLakePreparer()
@recorded_by_proxy_async
async def test_list_system_filesystems(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)
# Arrange
dsc = DataLakeServiceClient(self.dsc.url, credential=datalake_storage_account_key)
# Act
filesystems = []
async for fs in dsc.list_file_systems(include_system=True):
filesystems.append(fs)
# Assert
found = False
for fs in filesystems:
if fs.name == "$logs":
found = True
assert found == True
@DataLakePreparer()
@recorded_by_proxy_async
async def test_list_paths_with_max_per_page_async(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)
# Arrange
file_system = await self._create_file_system()
for i in range(0, 6):
await file_system.create_directory("dir1{}".format(i))
generator1 = file_system.get_paths(max_results=2, upn=True).by_page()
paths1 = []
async for path in await generator1.__anext__():
paths1.append(path)
generator2 = file_system.get_paths(max_results=4, upn=True) \
.by_page(continuation_token=generator1.continuation_token)
paths2 = []
async for path in await generator2.__anext__():
paths2.append(path)
assert len(paths1) == 2
assert len(paths2) == 4
assert paths2[0].name == "dir12"
@DataLakePreparer()
@recorded_by_proxy_async
async def test_list_paths_under_specific_path_async(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)
# Arrange
file_system = await self._create_file_system()
for i in range(0, 6):
dir = await file_system.create_directory("dir1{}".format(i))
# create a subdirectory under the current directory
subdir = await dir.create_sub_directory("subdir")
await subdir.create_sub_directory("subsub")
# create a file under the current directory
file_client = await subdir.create_file("file")
await file_client.append_data(b"abced", 0, 5) # cspell:disable-line
await file_client.flush_data(5)
generator1 = file_system.get_paths(path="dir10/subdir", max_results=2, upn=True).by_page()
paths = []
async for path in await generator1.__anext__():
paths.append(path)
assert len(paths) == 2
assert paths[0].content_length == 5
@DataLakePreparer()
@recorded_by_proxy_async
async def test_list_paths_recursively(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)
# Arrange
file_system = await self._create_file_system()
for i in range(0, 6):
dir = await file_system.create_directory("dir1{}".format(i))
# create a subdirectory under the current directory
subdir = await dir.create_sub_directory("subdir")
await subdir.create_sub_directory("subsub")
# create a file under the current directory
await subdir.create_file("file")
paths = []
async for path in file_system.get_paths(recursive=True, upn=True):
paths.append(path)
# there are 24 subpaths in total
assert len(paths) == 24
@DataLakePreparer()
@recorded_by_proxy_async
async def test_list_paths_start_from(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)
# Arrange
file_system = await self._create_file_system()
for i in range(0, 6):
dir = await file_system.create_directory(f"dir{i}")
# create a subdirectory under the current directory
subdir = await dir.create_sub_directory("subdir")
await subdir.create_sub_directory("subsub")
# create a file under the current directory
await subdir.create_file("file")
paths = []
async for path in file_system.get_paths(recursive=True, max_results=2, start_from="dir3"):
paths.append(path)
# there are 12 subpaths in total
assert len(paths) == 12
@DataLakePreparer()
@recorded_by_proxy_async
async def test_list_paths_pages_correctly(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)
# Arrange
file_system = await self._create_file_system(file_system_prefix="filesystem1")
for i in range(0, 6):
await file_system.create_directory("dir1{}".format(i))
for i in range(0, 6):
await file_system.create_file("file{}".format(i))
generator = file_system.get_paths(max_results=6, upn=True).by_page()
paths1 = []
async for path in await generator.__anext__():
paths1.append(path)
paths2 = []
async for path in await generator.__anext__():
paths2.append(path)
with pytest.raises(StopAsyncIteration):
paths3 = []
async for path in await generator.__anext__():
paths3.append(path)
assert len(paths1) == 6
assert len(paths2) == 6
@DataLakePreparer()
@recorded_by_proxy_async
async def test_get_deleted_paths(self, **kwargs):
datalake_storage_account_name = kwargs.pop("storage_data_lake_soft_delete_account_name")
datalake_storage_account_key = kwargs.pop("storage_data_lake_soft_delete_account_key")
self._setUp(datalake_storage_account_name, datalake_storage_account_key)
# Arrange
file_system = await self._create_file_system()
file0 = await file_system.create_file("file0")
file1 = await file_system.create_file("file1")
dir1 = await file_system.create_directory("dir1")
dir2 = await file_system.create_directory("dir2")
dir3 = await file_system.create_directory("dir3")
file_in_dir3 = await dir3.create_file("file_in_dir3")
file_in_subdir = await dir3.create_file("subdir/file_in_subdir")
await file0.delete_file()
await file1.delete_file()
await dir1.delete_directory()
await dir2.delete_directory()
await file_in_dir3.delete_file()
await file_in_subdir.delete_file()
deleted_paths = []
async for path in file_system.list_deleted_paths():
deleted_paths.append(path)
dir3_paths = []
async for path in file_system.list_deleted_paths(path_prefix="dir3/"):
dir3_paths.append(path)
# Assert
assert len(deleted_paths) == 6
assert len(dir3_paths) == 2
assert dir3_paths[0].deletion_id is not None
assert dir3_paths[1].deletion_id is not None
assert dir3_paths[0].name == 'dir3/file_in_dir3'
assert dir3_paths[1].name == 'dir3/subdir/file_in_subdir'
paths_generator1 = file_system.list_deleted_paths(results_per_page=2).by_page()
paths1 = []
async for path in await paths_generator1.__anext__():
paths1.append(path)
paths_generator2 = file_system.list_deleted_paths(results_per_page=4) \
.by_page(continuation_token=paths_generator1.continuation_token)
paths2 = []
async for path in await paths_generator2.__anext__():
paths2.append(path)
# Assert
assert len(paths1) == 2
assert len(paths2) == 4
@DataLakePreparer()
@recorded_by_proxy_async
async def test_path_properties_encryption_scope(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)
# Arrange
encryption_scope = EncryptionScopeOptions(default_encryption_scope="hnstestscope1")
file_system_name = self._get_file_system_reference()
# Act
file_system_client = self.dsc.get_file_system_client(file_system_name)
await file_system_client.create_file_system(encryption_scope_options=encryption_scope)
await file_system_client.create_directory('dir1')
await file_system_client.create_file('dir1/file1')
dir_props = await file_system_client.get_directory_client('dir1').get_directory_properties()
file_props = await file_system_client.get_file_client('dir1/file1').get_file_properties()
paths = []
async for path in file_system_client.get_paths(recursive=True, upn=True):
paths.append(path)
# Assert
assert dir_props.encryption_scope == encryption_scope.default_encryption_scope
assert file_props.encryption_scope == encryption_scope.default_encryption_scope
assert paths
assert paths[0].encryption_scope is not None
assert paths[0].encryption_scope == encryption_scope.default_encryption_scope
@DataLakePreparer()
@recorded_by_proxy_async
async def test_create_directory_from_file_system_client_async(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)
# Arrange
file_system = await self._create_file_system()
await file_system.create_directory("dir1/dir2")
paths = []
async for path in file_system.get_paths(recursive=False, upn=True):
paths.append(path)
assert len(paths) == 1
assert paths[0].name == "dir1"
@DataLakePreparer()
@recorded_by_proxy_async
async def test_create_file_from_file_system_client_async(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)
# Arrange
file_system = await self._create_file_system()
await file_system.create_file("dir1/dir2/file")
paths = []
async for path in file_system.get_paths(recursive=True, upn=True):
paths.append(path)
assert len(paths) == 3
assert paths[0].name == "dir1"
assert paths[2].is_directory == False
@DataLakePreparer()
@recorded_by_proxy_async
async def test_get_root_directory_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 = await self._create_file_system()
directory_client = file_system._get_root_directory_client()
acl = 'user::rwx,group::r-x,other::rwx'
await directory_client.set_access_control(acl=acl)
access_control = await directory_client.get_access_control()
assert acl == access_control['acl']
@pytest.mark.live_test_only
@DataLakePreparer()
async def test_get_access_control_using_delegation_sas_async(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)
url = self.account_url(datalake_storage_account_name, 'dfs')
token_credential = self.get_credential(DataLakeServiceClient, is_async=True)
dsc = DataLakeServiceClient(url, token_credential, logging_enable=True)
file_system_name = self._get_file_system_reference()
directory_client_name = '/'
(await dsc.create_file_system(file_system_name)).get_directory_client(directory_client_name)
directory_client = self.dsc.get_directory_client(file_system_name, directory_client_name)
random_guid = uuid.uuid4()
await directory_client.set_access_control(owner=random_guid,
permissions='0777')
acl = await directory_client.get_access_control()
delegation_key = await dsc.get_user_delegation_key(datetime.utcnow(),
datetime.utcnow() + timedelta(hours=1))
token = self.generate_sas(
generate_file_system_sas,
dsc.account_name,
file_system_name,
delegation_key,
permission=FileSystemSasPermissions(
read=True, execute=True, manage_access_control=True, manage_ownership=True),
expiry=datetime.utcnow() + timedelta(hours=1),
agent_object_id=random_guid
)
sas_directory_client = DataLakeDirectoryClient(self.dsc.url, file_system_name, directory_client_name,
credential=token, logging_enable=True)
access_control = await sas_directory_client.get_access_control()
assert access_control is not None
@pytest.mark.live_test_only
@DataLakePreparer()
async def test_list_paths_using_file_sys_delegation_sas_async(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)
url = self.account_url(datalake_storage_account_name, 'dfs')
token_credential = self.get_credential(DataLakeServiceClient, is_async=True)
dsc = DataLakeServiceClient(url, token_credential)
file_system_name = self._get_file_system_reference()
directory_client_name = '/'
directory_client = (await dsc.create_file_system(file_system_name)).get_directory_client(directory_client_name)
random_guid = uuid.uuid4()
await directory_client.set_access_control(owner=random_guid, permissions='0777')
delegation_key = await dsc.get_user_delegation_key(datetime.utcnow(),
datetime.utcnow() + timedelta(hours=1))
token = self.generate_sas(
generate_file_system_sas,
dsc.account_name,
file_system_name,
delegation_key,
permission=DirectorySasPermissions(list=True),
expiry=datetime.utcnow() + timedelta(hours=1),
agent_object_id=random_guid
)
sas_directory_client = FileSystemClient(self.dsc.url, file_system_name,
credential=token)
paths = []
async for path in sas_directory_client.get_paths():
paths.append(path)
assert 0 == 0
@DataLakePreparer()
@recorded_by_proxy_async
async def test_file_system_sessions_closes_properly_async(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)
# Arrange
file_system_client = await self._create_file_system("fs")
async with file_system_client as fs_client:
async with fs_client.get_file_client("file1.txt") as f_client:
await f_client.create_file()
async with fs_client.get_file_client("file2.txt") as f_client:
await f_client.create_file()
async with fs_client.get_directory_client("file1") as f_client:
await f_client.create_directory()
async with fs_client.get_directory_client("file2") as f_client:
await f_client.create_directory()
@DataLakePreparer()
@recorded_by_proxy_async
async def test_undelete_dir_with_version_id(self, **kwargs):
datalake_storage_account_name = kwargs.pop("storage_data_lake_soft_delete_account_name")
datalake_storage_account_key = kwargs.pop("storage_data_lake_soft_delete_account_key")
self._setUp(datalake_storage_account_name, datalake_storage_account_key)
file_system_client = await self._create_file_system("fs2")
dir_path = 'dir10'
dir_client = await file_system_client.create_directory(dir_path)
resp = await dir_client.delete_directory()
with pytest.raises(HttpResponseError):
await file_system_client.get_file_client(dir_path).get_file_properties()
restored_dir_client = await file_system_client._undelete_path(dir_path, resp['deletion_id'])
resp = await restored_dir_client.get_directory_properties()
assert resp is not None
@DataLakePreparer()
@recorded_by_proxy_async
async def test_undelete_file_with_version_id(self, **kwargs):
datalake_storage_account_name = kwargs.pop("storage_data_lake_soft_delete_account_name")
datalake_storage_account_key = kwargs.pop("storage_data_lake_soft_delete_account_key")
self._setUp(datalake_storage_account_name, datalake_storage_account_key)
file_system_client = await self._create_file_system("fs2")
file_path = 'dir10/fileŇ'
dir_client = await file_system_client.create_file(file_path)
resp = await dir_client.delete_file()
with pytest.raises(HttpResponseError):
await file_system_client.get_file_client(file_path).get_file_properties()
restored_file_client = await file_system_client._undelete_path(file_path, resp['deletion_id'])
resp = await restored_file_client.get_file_properties()
assert resp is not None
@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")
# Arrange
self._setUp(datalake_storage_account_name, datalake_storage_account_key)
url = self.account_url(datalake_storage_account_name, 'dfs')
file_system_name = self._get_file_system_reference()
file_system_client = self.dsc.get_file_system_client(file_system_name)
await file_system_client.create_file_system()
await file_system_client.create_directory('testdir1')
# Act
token_credential = self.get_credential(DataLakeServiceClient, is_async=True)
fsc = FileSystemClient(
url, file_system_name,
credential=token_credential,
audience=f'https://{datalake_storage_account_name}.blob.core.windows.net/'
)
# Assert
response1 = await fsc.exists()
response2 = await fsc.create_directory('testdir11')
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")
# Arrange
self._setUp(datalake_storage_account_name, datalake_storage_account_key)
url = self.account_url(datalake_storage_account_name, 'dfs')
file_system_name = self._get_file_system_reference()
file_system_client = self.dsc.get_file_system_client(file_system_name)
await file_system_client.create_file_system()
await file_system_client.create_directory('testdir2')
# Act
token_credential = self.get_credential(DataLakeServiceClient, is_async=True)
fsc = FileSystemClient(
url, file_system_name,
credential=token_credential,
audience=f'https://badaudience.blob.core.windows.net/'
)
# Will not raise ClientAuthenticationError despite bad audience due to Bearer Challenge
await fsc.exists()
await fsc.create_directory('testdir22')
@DataLakePreparer()
@recorded_by_proxy_async
async def test_get_and_set_access_control_oauth(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
# Arrange
token_credential = self.get_credential(DataLakeServiceClient, is_async=True)
dsc = DataLakeServiceClient(
self.account_url(datalake_storage_account_name, 'dfs'),
token_credential
)
file_system = await dsc.create_file_system(self.get_resource_name(TEST_FILE_SYSTEM_PREFIX))
directory_client = file_system._get_root_directory_client()
# Act
acl = 'user::rwx,group::r-x,other::rwx'
await directory_client.set_access_control(acl=acl)
access_control = await directory_client.get_access_control()
# Assert
assert acl == access_control['acl']
@DataLakePreparer()
@recorded_by_proxy_async
async def test_get_user_delegation_sas(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
variables = kwargs.pop("variables", {})
token_credential = self.get_credential(DataLakeServiceClient, is_async=True)
service = DataLakeServiceClient(
self.account_url(datalake_storage_account_name, "dfs"),
credential=token_credential,
)
start = self.get_datetime_variable(variables, 'start_time', datetime.utcnow())
expiry = self.get_datetime_variable(variables, 'expiry_time', datetime.utcnow() + timedelta(hours=1))
user_delegation_key_1 = await service.get_user_delegation_key(key_start_time=start, key_expiry_time=expiry)
user_delegation_key_2 = await service.get_user_delegation_key(key_start_time=start, key_expiry_time=expiry)
# Assert key1 is valid
assert user_delegation_key_1.signed_oid is not None
assert user_delegation_key_1.signed_tid is not None
assert user_delegation_key_1.signed_start is not None
assert user_delegation_key_1.signed_expiry is not None
assert user_delegation_key_1.signed_version is not None
assert user_delegation_key_1.signed_service is not None
assert user_delegation_key_1.value is not None
# Assert key1 and key2 are equal, since they have the exact same start and end times
assert user_delegation_key_1.signed_oid == user_delegation_key_2.signed_oid
assert user_delegation_key_1.signed_tid == user_delegation_key_2.signed_tid
assert user_delegation_key_1.signed_start == user_delegation_key_2.signed_start
assert user_delegation_key_1.signed_expiry == user_delegation_key_2.signed_expiry
assert user_delegation_key_1.signed_version == user_delegation_key_2.signed_version
assert user_delegation_key_1.signed_service == user_delegation_key_2.signed_service
assert user_delegation_key_1.value == user_delegation_key_2.value
return variables
@pytest.mark.live_test_only
@DataLakePreparer()
async def test_datalake_user_delegation_oid(self, **kwargs):
datalake_storage_account_name = kwargs.pop("datalake_storage_account_name")
data = b"abc123"
token_credential = self.get_credential(DataLakeServiceClient, is_async=True)
account_url = self.account_url(datalake_storage_account_name, "dfs")
dsc = DataLakeServiceClient(account_url, credential=token_credential)
file_system_name = self.get_resource_name(TEST_FILE_SYSTEM_PREFIX)
file_system = await dsc.create_file_system(file_system_name)
directory_name = "dir"
directory = await file_system.create_directory(directory_name)
file_name = "file"
file = await directory.create_file(file_name)
await file.upload_data(data, length=len(data), overwrite=True)
start = datetime.utcnow()
expiry = datetime.utcnow() + timedelta(hours=1)
user_delegation_key = await dsc.get_user_delegation_key(key_start_time=start, key_expiry_time=expiry)
token = await token_credential.get_token("https://storage.azure.com/.default")
user_delegation_oid = jwt.decode(token.token, options={"verify_signature": False}).get("oid")
file_system_token = self.generate_sas(
generate_file_system_sas,
dsc.account_name,
file_system_name,
user_delegation_key,
permission=FileSystemSasPermissions(write=True, read=True, delete=True, list=True),
expiry=expiry,
user_delegation_oid=user_delegation_oid,
)
file_system_client = FileSystemClient(
f"{account_url}?{file_system_token}",
file_system_name=file_system_name,
credential=token_credential
)
paths = []
async for path in file_system_client.get_paths() :
paths.append(path)
assert len(paths) == 2
assert paths[0]["name"] == directory.path_name
assert paths[1]["name"] == file.path_name
directory_token = self.generate_sas(
generate_directory_sas,
dsc.account_name,
file_system_name,
directory_name,
user_delegation_key,
permission=FileSasPermissions(write=True, read=True, delete=True),
expiry=expiry,
user_delegation_oid=user_delegation_oid
)
directory_client = DataLakeDirectoryClient(
f"{account_url}?{directory_token}",
file_system_name=file_system_name,
directory_name=directory_name,
credential=token_credential
)
props = await directory_client.get_directory_properties()
assert props is not None
file_token = self.generate_sas(
generate_file_sas,
datalake_storage_account_name,
file_system_name,
directory_name,
file_name,
credential=user_delegation_key,
permission=FileSasPermissions(write=True, read=True, delete=True),
expiry=expiry,
user_delegation_oid=user_delegation_oid
)
file_client = DataLakeFileClient(
f"{account_url}?{file_token}",
file_system_name=file_system_name,
file_path=f"{directory_name}/{file_name}",
credential=token_credential
)
content = await (await file_client.download_file()).readall()
assert content == data
# ------------------------------------------------------------------------------
if __name__ == '__main__':
unittest.main()
|