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
|
# coding=utf-8
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
import os
import pytest
import hashlib
import json
from datetime import datetime
from io import BytesIO
from unittest.mock import MagicMock
from typing import Optional, Iterator, Any, MutableMapping
from azure.containerregistry import (
RepositoryProperties,
ArtifactManifestProperties,
ArtifactManifestOrder,
ArtifactTagProperties,
ArtifactTagOrder,
ArtifactArchitecture,
ArtifactOperatingSystem,
ContainerRegistryClient,
DigestValidationError,
)
from azure.containerregistry._helpers import DOCKER_MANIFEST, OCI_IMAGE_MANIFEST, DEFAULT_CHUNK_SIZE
from azure.core.exceptions import (
ResourceNotFoundError,
ClientAuthenticationError,
HttpResponseError,
ServiceRequestError,
ServiceResponseError,
)
from azure.core.paging import ItemPaged
from azure.core.pipeline import PipelineRequest
from azure.identity import AzureAuthorityHosts
from testcase import ContainerRegistryTestClass, get_authority, get_audience, is_public_endpoint, is_china_endpoint
from constants import HELLO_WORLD, DOES_NOT_EXIST
from preparer import acr_preparer
from devtools_testutils import recorded_by_proxy
class TestContainerRegistryClient(ContainerRegistryTestClass):
@acr_preparer()
@recorded_by_proxy
def test_list_repository_names(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
repositories = client.list_repository_names()
assert isinstance(repositories, ItemPaged)
count = 0
prev = None
for repo in repositories:
count += 1
assert isinstance(repo, str)
assert prev != repo
prev = repo
assert count > 0
@acr_preparer()
@recorded_by_proxy
def test_list_repository_names_by_page(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
results_per_page = 2
total_pages = 0
repository_pages = client.list_repository_names(results_per_page=results_per_page)
prev = None
for page in repository_pages.by_page():
page_count = 0
for repo in page:
assert isinstance(repo, str)
assert prev != repo
prev = repo
page_count += 1
assert page_count <= results_per_page
total_pages += 1
assert total_pages >= 1
@acr_preparer()
@recorded_by_proxy
def test_delete_repository(self, containerregistry_endpoint):
repo = self.get_resource_name("repo")
self.import_image(containerregistry_endpoint, repo, ["test"])
self.sleep(5)
with self.create_registry_client(containerregistry_endpoint) as client:
client.delete_repository(repo)
self.sleep(5)
with pytest.raises(ResourceNotFoundError):
client.get_repository_properties(repo)
@acr_preparer()
@recorded_by_proxy
def test_delete_repository_does_not_exist(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
client.delete_repository(DOES_NOT_EXIST)
@acr_preparer()
@recorded_by_proxy
def test_get_repository_properties(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
properties = client.get_repository_properties(HELLO_WORLD)
assert isinstance(properties, RepositoryProperties)
assert properties.name == HELLO_WORLD
@acr_preparer()
@recorded_by_proxy
def test_update_repository_properties(self, containerregistry_endpoint):
repo = self.get_resource_name("repo")
self.import_image(containerregistry_endpoint, repo, ["test"])
self.sleep(5)
with self.create_registry_client(containerregistry_endpoint) as client:
properties = self.set_all_properties(RepositoryProperties(), False)
received = client.update_repository_properties(repo, properties)
self.assert_all_properties(received, False)
properties = self.set_all_properties(properties, True)
received = client.update_repository_properties(repo, properties)
self.assert_all_properties(received, True)
# Cleanup
client.delete_repository(repo)
@acr_preparer()
@recorded_by_proxy
def test_update_repository_properties_kwargs(self, containerregistry_endpoint):
repo = self.get_resource_name("repo")
self.import_image(containerregistry_endpoint, repo, ["test"])
self.sleep(5)
with self.create_registry_client(containerregistry_endpoint) as client:
received = client.update_repository_properties(
repo, can_delete=False, can_read=False, can_write=False, can_list=False
)
self.assert_all_properties(received, False)
received = client.update_repository_properties(
repo, can_delete=True, can_read=True, can_write=True, can_list=True
)
self.assert_all_properties(received, True)
# Cleanup
client.delete_repository(repo)
@acr_preparer()
@recorded_by_proxy
def test_list_registry_artifacts(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
count = 0
for artifact in client.list_manifest_properties(HELLO_WORLD):
assert isinstance(artifact, ArtifactManifestProperties)
assert isinstance(artifact.created_on, datetime)
assert isinstance(artifact.last_updated_on, datetime)
assert artifact.repository_name == HELLO_WORLD
assert artifact.fully_qualified_reference in self.create_fully_qualified_reference(
containerregistry_endpoint, HELLO_WORLD, artifact.digest
)
count += 1
assert count > 0
@acr_preparer()
@recorded_by_proxy
def test_list_registry_artifacts_by_page(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
results_per_page = 2
pages = client.list_manifest_properties(HELLO_WORLD, results_per_page=results_per_page)
page_count = 0
for page in pages.by_page():
reg_count = 0
for tag in page:
reg_count += 1
assert reg_count <= results_per_page
page_count += 1
assert page_count >= 1
@acr_preparer()
@recorded_by_proxy
def test_list_registry_artifacts_descending(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
prev_last_updated_on = None
count = 0
for artifact in client.list_manifest_properties(
HELLO_WORLD, order_by=ArtifactManifestOrder.LAST_UPDATED_ON_DESCENDING
):
if prev_last_updated_on:
assert artifact.last_updated_on < prev_last_updated_on
prev_last_updated_on = artifact.last_updated_on
count += 1
assert count > 0
@acr_preparer()
@recorded_by_proxy
def test_list_registry_artifacts_ascending(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
prev_last_updated_on = None
count = 0
for artifact in client.list_manifest_properties(
HELLO_WORLD, order_by=ArtifactManifestOrder.LAST_UPDATED_ON_ASCENDING
):
if prev_last_updated_on:
assert artifact.last_updated_on > prev_last_updated_on
prev_last_updated_on = artifact.last_updated_on
count += 1
assert count > 0
@acr_preparer()
@recorded_by_proxy
def test_get_manifest_properties(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
properties = client.get_manifest_properties(HELLO_WORLD, "latest")
assert isinstance(properties, ArtifactManifestProperties)
assert properties.repository_name == HELLO_WORLD
assert properties.fully_qualified_reference in self.create_fully_qualified_reference(
containerregistry_endpoint, HELLO_WORLD, properties.digest
)
@acr_preparer()
@recorded_by_proxy
def test_get_manifest_properties_does_not_exist(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
manifest = client.get_manifest_properties(HELLO_WORLD, "latest")
invalid_digest = manifest.digest[:-10] + "a" * 10
with pytest.raises(ResourceNotFoundError):
client.get_manifest_properties(HELLO_WORLD, invalid_digest)
with pytest.raises(ResourceNotFoundError):
client.get_manifest_properties(DOES_NOT_EXIST, DOES_NOT_EXIST)
@acr_preparer()
@recorded_by_proxy
def test_update_manifest_properties(self, containerregistry_endpoint):
repo = self.get_resource_name("repo")
tag = "test"
self.import_image(containerregistry_endpoint, repo, [tag])
self.sleep(5)
with self.create_registry_client(containerregistry_endpoint) as client:
properties = self.set_all_properties(ArtifactManifestProperties(), False)
received = client.update_manifest_properties(repo, tag, properties)
self.assert_all_properties(received, False)
properties = self.set_all_properties(properties, True)
received = client.update_manifest_properties(repo, tag, properties)
self.assert_all_properties(received, True)
# Cleanup
client.delete_repository(repo)
@acr_preparer()
@recorded_by_proxy
def test_update_manifest_properties_kwargs(self, containerregistry_endpoint):
repo = self.get_resource_name("repo")
tag = "test"
self.import_image(containerregistry_endpoint, repo, [tag])
self.sleep(5)
with self.create_registry_client(containerregistry_endpoint) as client:
received = client.update_manifest_properties(
repo, tag, can_delete=False, can_read=False, can_write=False, can_list=False
)
self.assert_all_properties(received, False)
received = client.update_manifest_properties(
repo, tag, can_delete=True, can_read=True, can_write=True, can_list=True
)
self.assert_all_properties(received, True)
# Cleanup
client.delete_repository(repo)
@acr_preparer()
@recorded_by_proxy
def test_get_tag_properties(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
properties = client.get_tag_properties(HELLO_WORLD, "latest")
assert isinstance(properties, ArtifactTagProperties)
assert properties.name == "latest"
@acr_preparer()
@recorded_by_proxy
def test_get_tag_properties_does_not_exist(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
with pytest.raises(ResourceNotFoundError):
client.get_tag_properties(DOES_NOT_EXIST, DOES_NOT_EXIST)
with pytest.raises(ResourceNotFoundError):
client.get_tag_properties(HELLO_WORLD, DOES_NOT_EXIST)
@acr_preparer()
@recorded_by_proxy
def test_update_tag_properties(self, containerregistry_endpoint):
repo = self.get_resource_name("repo")
tag = "test"
self.import_image(containerregistry_endpoint, repo, [tag])
self.sleep(5)
with self.create_registry_client(containerregistry_endpoint) as client:
properties = self.set_all_properties(ArtifactTagProperties(), False)
received = client.update_tag_properties(repo, tag, properties)
self.assert_all_properties(received, False)
properties = self.set_all_properties(properties, True)
received = client.update_tag_properties(repo, tag, properties)
self.assert_all_properties(received, True)
# Cleanup
client.delete_repository(repo)
@acr_preparer()
@recorded_by_proxy
def test_update_tag_properties_kwargs(self, containerregistry_endpoint):
repo = self.get_resource_name("repo")
tag = "test"
self.import_image(containerregistry_endpoint, repo, [tag])
self.sleep(5)
with self.create_registry_client(containerregistry_endpoint) as client:
received = client.update_tag_properties(
repo, tag, can_delete=False, can_read=False, can_write=False, can_list=False
)
self.assert_all_properties(received, False)
received = client.update_tag_properties(
repo, tag, can_delete=True, can_read=True, can_write=True, can_list=True
)
self.assert_all_properties(received, True)
# Cleanup
client.delete_repository(repo)
@acr_preparer()
@recorded_by_proxy
def test_list_tag_properties(self, containerregistry_endpoint):
tags = ["latest", "v1"]
with self.create_registry_client(containerregistry_endpoint) as client:
count = 0
for tag in client.list_tag_properties(HELLO_WORLD):
assert tag.name in tags
count += 1
assert count == len(tags)
@acr_preparer()
@recorded_by_proxy
def test_list_tag_properties_order_descending(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
prev_last_updated_on = None
count = 0
for tag in client.list_tag_properties(HELLO_WORLD, order_by=ArtifactTagOrder.LAST_UPDATED_ON_DESCENDING):
if prev_last_updated_on:
assert tag.last_updated_on < prev_last_updated_on
prev_last_updated_on = tag.last_updated_on
count += 1
assert count == 2
@acr_preparer()
@recorded_by_proxy
def test_list_tag_properties_order_ascending(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
prev_last_updated_on = None
count = 0
for tag in client.list_tag_properties(HELLO_WORLD, order_by=ArtifactTagOrder.LAST_UPDATED_ON_ASCENDING):
if prev_last_updated_on:
assert tag.last_updated_on > prev_last_updated_on
prev_last_updated_on = tag.last_updated_on
count += 1
assert count == 2
@acr_preparer()
@recorded_by_proxy
def test_delete_tag(self, containerregistry_endpoint):
repo = self.get_resource_name("repo")
tag = "test"
self.import_image(containerregistry_endpoint, repo, [tag])
self.sleep(5)
with self.create_registry_client(containerregistry_endpoint) as client:
client.delete_tag(repo, tag)
self.sleep(10)
with pytest.raises(ResourceNotFoundError):
client.get_tag_properties(repo, tag)
# Cleanup
client.delete_repository(repo)
@acr_preparer()
@recorded_by_proxy
def test_delete_tag_does_not_exist(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
client.delete_tag(DOES_NOT_EXIST, DOES_NOT_EXIST)
client.delete_tag(HELLO_WORLD, DOES_NOT_EXIST)
@acr_preparer()
@recorded_by_proxy
def test_delete_manifest(self, containerregistry_endpoint):
repo = self.get_resource_name("repo")
tag = "test"
self.import_image(containerregistry_endpoint, repo, [tag])
self.sleep(5)
with self.create_registry_client(containerregistry_endpoint) as client:
client.delete_manifest(repo, tag)
self.sleep(10)
with pytest.raises(ResourceNotFoundError):
client.get_manifest_properties(repo, tag)
# Cleanup
client.delete_repository(repo)
@acr_preparer()
@recorded_by_proxy
def test_delete_manifest_does_not_exist(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
manifest = client.get_manifest_properties(HELLO_WORLD, "latest")
invalid_digest = manifest.digest[:-10] + "a" * 10
client.delete_manifest(HELLO_WORLD, invalid_digest)
with pytest.raises(ResourceNotFoundError):
client.delete_manifest(HELLO_WORLD, DOES_NOT_EXIST)
with pytest.raises(ResourceNotFoundError):
client.delete_manifest(DOES_NOT_EXIST, DOES_NOT_EXIST)
@acr_preparer()
@recorded_by_proxy
def test_expiration_time_parsing(self, containerregistry_endpoint):
from azure.containerregistry._authentication_policy import ContainerRegistryChallengePolicy
with self.create_registry_client(containerregistry_endpoint) as client:
for repo in client.list_repository_names():
pass
for policy in client._client._client._pipeline._impl_policies:
if isinstance(policy, ContainerRegistryChallengePolicy):
policy._exchange_client._expiration_time = 0
break
count = 0
for repo in client.list_repository_names():
count += 1
assert count >= 1
# Live only, the fake credential doesn't check auth scope the same way
@pytest.mark.live_test_only
@acr_preparer()
@recorded_by_proxy
def construct_container_registry_client(self, **kwargs):
containerregistry_endpoint = kwargs.pop("containerregistry_endpoint")
authority = get_authority(containerregistry_endpoint)
credential = self.get_credential(authority=authority)
with ContainerRegistryClient(
endpoint=containerregistry_endpoint, credential=credential, audience="https://microsoft.com"
) as client:
with pytest.raises(ClientAuthenticationError):
properties = client.get_repository_properties(HELLO_WORLD)
@acr_preparer()
@recorded_by_proxy
def test_get_misspell_property(self, containerregistry_endpoint):
with self.create_registry_client(containerregistry_endpoint) as client:
properties = client.get_repository_properties(HELLO_WORLD)
with pytest.warns(DeprecationWarning):
last_udpated_on = properties.last_udpated_on
last_updated_on = properties.last_updated_on
assert last_udpated_on == last_updated_on
# Live only, as test proxy now cannot handle spaces correctly
# issue: https://github.com/Azure/azure-sdk-tools/issues/5968
@pytest.mark.live_test_only
@acr_preparer()
def test_set_oci_manifest(self, **kwargs):
containerregistry_endpoint = kwargs.pop("containerregistry_endpoint")
repo = self.get_resource_name("repo")
path = os.path.join(self.get_test_directory(), "data", "oci_artifact", "manifest.json")
with self.create_registry_client(containerregistry_endpoint) as client:
self.upload_oci_manifest_prerequisites(repo, client)
with open(path, "rb") as manifest_stream:
# test set oci manifest in stream format
with pytest.raises(HttpResponseError):
client.set_manifest(repo, manifest_stream, tag="v1", media_type=DOCKER_MANIFEST)
manifest_stream.seek(0)
digest1 = client.set_manifest(repo, manifest_stream, tag="v1")
manifest_stream.seek(0)
# test set oci manifest in JSON format
manifest_json = json.loads(manifest_stream.read().decode())
with pytest.raises(HttpResponseError):
client.set_manifest(repo, manifest_json, tag="v2", media_type=DOCKER_MANIFEST)
digest2 = client.set_manifest(repo, manifest_json, tag="v2")
assert digest1 == digest2
# test get oci manifest by digest
response = client.get_manifest(repo, digest1)
assert response.media_type == OCI_IMAGE_MANIFEST
# test get oci manifest by tag
response = client.get_manifest(repo, "v1")
assert response.media_type == OCI_IMAGE_MANIFEST
response = client.get_manifest(repo, "v2")
assert response.media_type == OCI_IMAGE_MANIFEST
client.delete_manifest(repo, digest1)
client.delete_repository(repo)
# Reading data from a no space file to make this test pass in playback as test proxy cannot handle spaces correctly.
# issue: https://github.com/Azure/azure-sdk-tools/issues/5968
@acr_preparer()
@recorded_by_proxy
def test_set_oci_manifest_without_spaces(self, containerregistry_endpoint):
if not is_public_endpoint(containerregistry_endpoint):
pytest.skip("This test is for testing test_set_docker_manifest in playback.")
repo = self.get_resource_name("repo")
path = os.path.join(self.get_test_directory(), "data", "oci_artifact", "manifest_without_spaces.json")
with self.create_registry_client(containerregistry_endpoint) as client:
self.upload_oci_manifest_prerequisites(repo, client)
with open(path, "rb") as manifest_stream:
# test set oci manifest in stream format
with pytest.raises(HttpResponseError):
client.set_manifest(repo, manifest_stream, tag="v1", media_type=DOCKER_MANIFEST)
manifest_stream.seek(0)
digest = client.set_manifest(repo, manifest_stream, tag="v1")
# test get oci manifest by digest
response = client.get_manifest(repo, digest)
assert response.media_type == OCI_IMAGE_MANIFEST
# test get oci manifest by tag
response = client.get_manifest(repo, "v1")
assert response.media_type == OCI_IMAGE_MANIFEST
client.delete_manifest(repo, digest)
client.delete_repository(repo)
# Live only, as test proxy now cannot handle spaces correctly
# issue: https://github.com/Azure/azure-sdk-tools/issues/5968
@pytest.mark.live_test_only
@acr_preparer()
def test_set_docker_manifest(self, **kwargs):
containerregistry_endpoint = kwargs.pop("containerregistry_endpoint")
repo = self.get_resource_name("repo")
path = os.path.join(self.get_test_directory(), "data", "docker_artifact", "manifest.json")
with self.create_registry_client(containerregistry_endpoint) as client:
self.upload_docker_manifest_prerequisites(repo, client)
with open(path, "rb") as manifest_stream:
# test set Docker manifest in stream format
with pytest.raises(HttpResponseError):
# It fails as the default media type is oci image manifest media type
client.set_manifest(repo, manifest_stream, tag="v1")
manifest_stream.seek(0)
digest1 = client.set_manifest(repo, manifest_stream, tag="v1", media_type=DOCKER_MANIFEST)
manifest_stream.seek(0)
# test set Docker manifest in JSON format
manifest_json = json.loads(manifest_stream.read().decode())
with pytest.raises(HttpResponseError):
# It fails as the default media type is oci image manifest media type
client.set_manifest(repo, manifest_json, tag="v2")
digest2 = client.set_manifest(repo, manifest_json, tag="v2", media_type=DOCKER_MANIFEST)
assert digest1 == digest2
# test get Docker manifest by digest
response = client.get_manifest(repo, digest1)
assert response.media_type == DOCKER_MANIFEST
# test get Docker manifest by tag
response = client.get_manifest(repo, "v1")
assert response.media_type == DOCKER_MANIFEST
response = client.get_manifest(repo, "v2")
assert response.media_type == DOCKER_MANIFEST
client.delete_manifest(repo, digest1)
client.delete_repository(repo)
# Reading data from a no space file to make this test pass in playback as test proxy cannot handle spaces correctly.
# issue: https://github.com/Azure/azure-sdk-tools/issues/5968
@acr_preparer()
@recorded_by_proxy
def test_set_docker_manifest_without_spaces(self, containerregistry_endpoint):
if not is_public_endpoint(containerregistry_endpoint):
pytest.skip("This test is for testing test_set_docker_manifest in playback.")
repo = self.get_resource_name("repo")
path = os.path.join(self.get_test_directory(), "data", "docker_artifact", "manifest_without_spaces.json")
with self.create_registry_client(containerregistry_endpoint) as client:
self.upload_docker_manifest_prerequisites(repo, client)
with open(path, "rb") as manifest_stream:
# test set Docker manifest in stream format
with pytest.raises(HttpResponseError):
# It fails as the default media type is oci image manifest media type
client.set_manifest(repo, manifest_stream, tag="v1")
manifest_stream.seek(0)
digest = client.set_manifest(repo, manifest_stream, tag="v1", media_type=DOCKER_MANIFEST)
# test get Docker manifest by digest
response = client.get_manifest(repo, digest)
assert response.media_type == DOCKER_MANIFEST
# test get Docker manifest by tag
response = client.get_manifest(repo, "v1")
assert response.media_type == DOCKER_MANIFEST
client.delete_manifest(repo, digest)
client.delete_repository(repo)
@acr_preparer()
@recorded_by_proxy
def test_upload_blob(self, containerregistry_endpoint):
repo = self.get_resource_name("repo")
blob = BytesIO(b"hello world")
with self.create_registry_client(containerregistry_endpoint) as client:
# Act
digest, blob_size = client.upload_blob(repo, blob)
# Assert
blob_content = b""
stream = client.download_blob(repo, digest)
for chunk in stream:
blob_content += chunk
assert len(blob_content) == blob_size
client.delete_blob(repo, digest)
client.delete_repository(repo)
@pytest.mark.live_test_only
@acr_preparer()
def upload_large_blob_in_chunk(self, **kwargs):
containerregistry_endpoint = kwargs.pop("containerregistry_endpoint")
if is_china_endpoint(containerregistry_endpoint):
pytest.skip("Running on China cloud usually will fail due to timeout.")
repo = self.get_resource_name("repo")
with self.create_registry_client(containerregistry_endpoint) as client:
# Test blob upload and download in equal size chunks
try:
blob_size = DEFAULT_CHUNK_SIZE * 1024 # 4GB
data = b"\x00" * int(blob_size)
digest, size = client.upload_blob(repo, BytesIO(data))
assert size == blob_size
stream = client.download_blob(repo, digest)
size = 0
with open("text1.txt", "wb") as file:
for chunk in stream:
size += file.write(chunk)
assert size == blob_size
client.delete_blob(repo, digest)
except (ServiceRequestError, ServiceResponseError) as err:
# Service does not support resumable upload when get transient error while uploading
# issue: https://github.com/Azure/azure-sdk-for-python/issues/29738
print(f"Failed to upload blob: {err.message}")
except ResourceNotFoundError as err:
# Service does not support resumable upload when get transient error while uploading
# issue: https://github.com/Azure/azure-sdk-for-python/issues/29738
assert err.status_code == 404
assert err.response.request.method == "PATCH"
assert (
err.response.text()
== '{"errors":[{"code":"BLOB_UPLOAD_INVALID","message":"blob upload invalid"}]}\n'
)
# Test blob upload and download in unequal size chunks
try:
blob_size = DEFAULT_CHUNK_SIZE * 1024 + 20
data = b"\x00" * int(blob_size)
digest, size = client.upload_blob(repo, BytesIO(data))
assert size == blob_size
stream = client.download_blob(repo, digest)
size = 0
with open("text2.txt", "wb") as file:
for chunk in stream:
size += file.write(chunk)
assert size == blob_size
client.delete_blob(repo, digest)
except (ServiceRequestError, ServiceResponseError) as err:
# Service does not support resumable upload when get transient error while uploading
# issue: https://github.com/Azure/azure-sdk-for-python/issues/29738
print(f"Failed to upload blob: {err.message}")
except ResourceNotFoundError as err:
# Service does not support resumable upload when get transient error while uploading
# issue: https://github.com/Azure/azure-sdk-for-python/issues/29738
assert err.status_code == 404
assert err.response.request.method == "PATCH"
assert (
err.response.text()
== '{"errors":[{"code":"BLOB_UPLOAD_INVALID","message":"blob upload invalid"}]}\n'
)
# Cleanup
client.delete_repository(repo)
@acr_preparer()
@recorded_by_proxy
def test_delete_blob_does_not_exist(self, containerregistry_endpoint):
repo = self.get_resource_name("repo")
hash_value = hashlib.sha256(b"test").hexdigest()
digest = f"sha256:{hash_value}"
with self.create_registry_client(containerregistry_endpoint) as client:
client.delete_blob(repo, digest)
@acr_preparer()
@recorded_by_proxy
def test_set_audience(self, containerregistry_endpoint):
authority = get_authority(containerregistry_endpoint)
credential = self.get_credential(authority=authority)
with ContainerRegistryClient(endpoint=containerregistry_endpoint, credential=credential) as client:
for repo in client.list_repository_names():
pass
valid_audience = get_audience(authority)
with ContainerRegistryClient(
endpoint=containerregistry_endpoint, credential=credential, audience=valid_audience
) as client:
for repo in client.list_repository_names():
pass
if valid_audience == get_audience(AzureAuthorityHosts.AZURE_PUBLIC_CLOUD):
invalid_audience = get_audience(AzureAuthorityHosts.AZURE_GOVERNMENT)
with ContainerRegistryClient(
endpoint=containerregistry_endpoint, credential=credential, audience=invalid_audience
) as client:
with pytest.raises(ClientAuthenticationError):
for repo in client.list_repository_names():
pass
@acr_preparer()
@recorded_by_proxy
def test_list_in_empty_repo(self, containerregistry_endpoint):
repo = self.get_resource_name("repo")
self.import_image(containerregistry_endpoint, repo, ["test"])
self.sleep(5)
with self.create_registry_client(containerregistry_endpoint) as client:
# cleanup tags in repo
for tag in client.list_tag_properties(repo):
client.delete_tag(repo, tag.name)
# test list tags in empty repo
response = client.list_tag_properties(repo)
for tag in response:
# cleanup manifests in repo
client.delete_manifest(repo, tag.name)
# test list manifests in empty repo
response = client.list_manifest_properties(repo)
for manifest in response:
pass
client.delete_repository(repo)
class TestContainerRegistryClientUnitTests:
containerregistry_endpoint = "https://fake_url.azurecr.io"
def text(self, encoding: Optional[str] = None) -> str:
return '{"hello": "world"}'
def test_manifest_digest_validation(self):
JSON = MutableMapping[str, Any]
def send_in_set_manifest(request: PipelineRequest, **kwargs) -> MagicMock:
content_digest = hashlib.sha256(b"hello world").hexdigest()
return MagicMock(
status_code=201,
headers={"Docker-Content-Digest": content_digest},
content_type="application/json; charset=utf-8",
text=self.text,
)
def read() -> bytes:
return b'{"hello": "world"}'
def json() -> JSON:
return {"hello": "world"}
def send_in_get_manifest(request: PipelineRequest, **kwargs) -> MagicMock:
content_digest = hashlib.sha256(b"hello world").hexdigest()
content_type = "application/vnd.oci.image.manifest.v1+json"
return MagicMock(
status_code=200,
headers={
"Docker-Content-Digest": content_digest,
"Content-Type": content_type,
"Content-Length": len(b"hello world"),
},
read=read,
json=json,
)
with ContainerRegistryClient(
endpoint=self.containerregistry_endpoint, transport=MagicMock(send=send_in_set_manifest)
) as client:
with pytest.raises(DigestValidationError) as exp:
manifest = {"hello": "world"}
client.set_manifest("test-repo", manifest)
assert str(exp.value) == "The server-computed digest does not match the client-computed digest."
with ContainerRegistryClient(
endpoint=self.containerregistry_endpoint, transport=MagicMock(send=send_in_get_manifest)
) as client:
with pytest.raises(DigestValidationError) as exp:
digest = hashlib.sha256(b"hello world").hexdigest()
client.get_manifest("test-repo", f"sha256:{digest}")
assert str(exp.value) == "The content of retrieved manifest digest does not match the requested digest."
with pytest.raises(DigestValidationError) as exp:
client.get_manifest("test-repo", "test-tag")
assert str(exp.value) == "The server-computed digest does not match the client-computed digest."
def test_blob_digest_validation(self):
def send_in_upload_blob(request: PipelineRequest, **kwargs) -> MagicMock:
if request.method == "PUT":
content_digest = hashlib.sha256(b"hello world").hexdigest()
return MagicMock(
status_code=201,
headers={"Docker-Content-Digest": content_digest},
content_type="application/json; charset=utf-8",
text=self.text,
)
else:
return MagicMock(
status_code=202,
headers={"Location": "/v2/test-repo/blobs/uploads/fake_location"},
content_type="application/json; charset=utf-8",
text=self.text,
)
def iter_bytes() -> Iterator[bytes]:
yield b'{"hello": "world"}'
def send_in_download_blob(request: PipelineRequest, **kwargs) -> MagicMock:
return MagicMock(
status_code=206,
headers={"Content-Range": "bytes 0-27/28", "Content-Length": "28"},
content_type="application/json; charset=utf-8",
text=self.text,
iter_bytes=iter_bytes,
)
with ContainerRegistryClient(
endpoint=self.containerregistry_endpoint, transport=MagicMock(send=send_in_upload_blob)
) as client:
with pytest.raises(DigestValidationError) as exp:
client.upload_blob("test-repo", BytesIO(b'{"hello": "world"}'))
assert str(exp.value) == "The server-computed digest does not match the client-computed digest."
with ContainerRegistryClient(
endpoint=self.containerregistry_endpoint, transport=MagicMock(send=send_in_download_blob)
) as client:
digest = hashlib.sha256(b"hello world").hexdigest()
stream = client.download_blob("test-repo", f"sha256:{digest}")
with pytest.raises(DigestValidationError) as exp:
for chunk in stream:
pass
assert str(exp.value) == "The content of retrieved blob digest does not match the requested digest."
def test_deserialize_manifest(self):
def get_manifest(encoding: Optional[str] = None) -> str:
manifest = {
"manifests": [
{
"mediaType": "application/vnd.docker.distribution.manifest.v2+json",
"imageSize": 2199,
"digest": "sha256:86fed9f0203a09f13cbbb9842132e9000eeff51b3de0d4ff66ee03ab0e860d1f",
"architecture": "amd64",
"os": "linux",
},
{
"mediaType": "application/vnd.docker.distribution.manifest.v2+json",
"imageSize": 566,
"digest": "sha256:b808af65792ab617b9032c20fb12c455dc2bf5efe1af3f0ac81a129560772d35",
"annotations": {
"vnd.docker.reference.digest": "sha256:86fed9f0203a09f13cbbb9842132e9000eeff51b3de0d4ff66ee03ab0e860d1f",
"vnd.docker.reference.type": "attestation-manifest",
},
"architecture": "unknown",
"os": "unknown",
},
]
}
return json.dumps(manifest)
def send(request: PipelineRequest, **kwargs) -> MagicMock:
return MagicMock(
status_code=200,
content_type="application/json; charset=utf-8",
text=get_manifest,
)
with ContainerRegistryClient(
endpoint=self.containerregistry_endpoint, transport=MagicMock(send=send)
) as client:
manifests = client.list_manifest_properties(HELLO_WORLD)
for manifest in manifests:
if manifest.size_in_bytes == 2199:
assert isinstance(manifest.architecture, ArtifactArchitecture)
assert manifest.architecture == "amd64"
assert isinstance(manifest.operating_system, ArtifactOperatingSystem)
assert manifest.operating_system == "linux"
if manifest.size_in_bytes == 566:
assert isinstance(manifest.architecture, str)
assert manifest.architecture == "unknown"
assert isinstance(manifest.operating_system, str)
assert manifest.operating_system == "unknown"
|